2017-03-06 Vladimir Makarov <vmakarov@redhat.com>
[official-gcc.git] / gcc / doc / invoke.texi
blob15eb0e0289ae47182550abe98c46033d29ebedac
1 @c Copyright (C) 1988-2017 Free Software Foundation, Inc.
2 @c This is part of the GCC manual.
3 @c For copying conditions, see the file gcc.texi.
5 @ignore
6 @c man begin INCLUDE
7 @include gcc-vers.texi
8 @c man end
10 @c man begin COPYRIGHT
11 Copyright @copyright{} 1988-2017 Free Software Foundation, Inc.
13 Permission is granted to copy, distribute and/or modify this document
14 under the terms of the GNU Free Documentation License, Version 1.3 or
15 any later version published by the Free Software Foundation; with the
16 Invariant Sections being ``GNU General Public License'' and ``Funding
17 Free Software'', the Front-Cover texts being (a) (see below), and with
18 the Back-Cover Texts being (b) (see below).  A copy of the license is
19 included in the gfdl(7) man page.
21 (a) The FSF's Front-Cover Text is:
23      A GNU Manual
25 (b) The FSF's Back-Cover Text is:
27      You have freedom to copy and modify this GNU Manual, like GNU
28      software.  Copies published by the Free Software Foundation raise
29      funds for GNU development.
30 @c man end
31 @c Set file name and title for the man page.
32 @setfilename gcc
33 @settitle GNU project C and C++ compiler
34 @c man begin SYNOPSIS
35 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
36     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
37     [@option{-W}@var{warn}@dots{}] [@option{-Wpedantic}]
38     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
39     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
40     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
41     [@option{-o} @var{outfile}] [@@@var{file}] @var{infile}@dots{}
43 Only the most useful options are listed here; see below for the
44 remainder.  @command{g++} accepts mostly the same options as @command{gcc}.
45 @c man end
46 @c man begin SEEALSO
47 gpl(7), gfdl(7), fsf-funding(7),
48 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
49 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
50 @file{ld}, @file{binutils} and @file{gdb}.
51 @c man end
52 @c man begin BUGS
53 For instructions on reporting bugs, see
54 @w{@value{BUGURL}}.
55 @c man end
56 @c man begin AUTHOR
57 See the Info entry for @command{gcc}, or
58 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
59 for contributors to GCC@.
60 @c man end
61 @end ignore
63 @node Invoking GCC
64 @chapter GCC Command Options
65 @cindex GCC command options
66 @cindex command options
67 @cindex options, GCC command
69 @c man begin DESCRIPTION
70 When you invoke GCC, it normally does preprocessing, compilation,
71 assembly and linking.  The ``overall options'' allow you to stop this
72 process at an intermediate stage.  For example, the @option{-c} option
73 says not to run the linker.  Then the output consists of object files
74 output by the assembler.
75 @xref{Overall Options,,Options Controlling the Kind of Output}.
77 Other options are passed on to one or more stages of processing.  Some options
78 control the preprocessor and others the compiler itself.  Yet other
79 options control the assembler and linker; most of these are not
80 documented here, since you rarely need to use any of them.
82 @cindex C compilation options
83 Most of the command-line options that you can use with GCC are useful
84 for C programs; when an option is only useful with another language
85 (usually C++), the explanation says so explicitly.  If the description
86 for a particular option does not mention a source language, you can use
87 that option with all supported languages.
89 @cindex cross compiling
90 @cindex specifying machine version
91 @cindex specifying compiler version and target machine
92 @cindex compiler version, specifying
93 @cindex target machine, specifying
94 The usual way to run GCC is to run the executable called @command{gcc}, or
95 @command{@var{machine}-gcc} when cross-compiling, or
96 @command{@var{machine}-gcc-@var{version}} to run a specific version of GCC.
97 When you compile C++ programs, you should invoke GCC as @command{g++} 
98 instead.  @xref{Invoking G++,,Compiling C++ Programs}, 
99 for information about the differences in behavior between @command{gcc} 
100 and @code{g++} when compiling C++ programs.
102 @cindex grouping options
103 @cindex options, grouping
104 The @command{gcc} program accepts options and file names as operands.  Many
105 options have multi-letter names; therefore multiple single-letter options
106 may @emph{not} be grouped: @option{-dv} is very different from @w{@samp{-d
107 -v}}.
109 @cindex order of options
110 @cindex options, order
111 You can mix options and other arguments.  For the most part, the order
112 you use doesn't matter.  Order does matter when you use several
113 options of the same kind; for example, if you specify @option{-L} more
114 than once, the directories are searched in the order specified.  Also,
115 the placement of the @option{-l} option is significant.
117 Many options have long names starting with @samp{-f} or with
118 @samp{-W}---for example,
119 @option{-fmove-loop-invariants}, @option{-Wformat} and so on.  Most of
120 these have both positive and negative forms; the negative form of
121 @option{-ffoo} is @option{-fno-foo}.  This manual documents
122 only one of these two forms, whichever one is not the default.
124 @c man end
126 @xref{Option Index}, for an index to GCC's options.
128 @menu
129 * Option Summary::      Brief list of all options, without explanations.
130 * Overall Options::     Controlling the kind of output:
131                         an executable, object files, assembler files,
132                         or preprocessed source.
133 * Invoking G++::        Compiling C++ programs.
134 * C Dialect Options::   Controlling the variant of C language compiled.
135 * C++ Dialect Options:: Variations on C++.
136 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
137                         and Objective-C++.
138 * Diagnostic Message Formatting Options:: Controlling how diagnostics should
139                         be formatted.
140 * Warning Options::     How picky should the compiler be?
141 * Debugging Options::   Producing debuggable code.
142 * Optimize Options::    How much optimization?
143 * Instrumentation Options:: Enabling profiling and extra run-time error checking.
144 * Preprocessor Options:: Controlling header files and macro definitions.
145                          Also, getting dependency information for Make.
146 * Assembler Options::   Passing options to the assembler.
147 * Link Options::        Specifying libraries and so on.
148 * Directory Options::   Where to find header files and libraries.
149                         Where to find the compiler executable files.
150 * Code Gen Options::    Specifying conventions for function calls, data layout
151                         and register usage.
152 * Developer Options::   Printing GCC configuration info, statistics, and
153                         debugging dumps.
154 * Submodel Options::    Target-specific options, such as compiling for a
155                         specific processor variant.
156 * Spec Files::          How to pass switches to sub-processes.
157 * Environment Variables:: Env vars that affect GCC.
158 * Precompiled Headers:: Compiling a header once, and using it many times.
159 @end menu
161 @c man begin OPTIONS
163 @node Option Summary
164 @section Option Summary
166 Here is a summary of all the options, grouped by type.  Explanations are
167 in the following sections.
169 @table @emph
170 @item Overall Options
171 @xref{Overall Options,,Options Controlling the Kind of Output}.
172 @gccoptlist{-c  -S  -E  -o @var{file}  -x @var{language}  @gol
173 -v  -###  --help@r{[}=@var{class}@r{[},@dots{}@r{]]}  --target-help  --version @gol
174 -pass-exit-codes  -pipe  -specs=@var{file}  -wrapper  @gol
175 @@@var{file}  -fplugin=@var{file}  -fplugin-arg-@var{name}=@var{arg}  @gol
176 -fdump-ada-spec@r{[}-slim@r{]}  -fada-spec-parent=@var{unit}  -fdump-go-spec=@var{file}}
178 @item C Language Options
179 @xref{C Dialect Options,,Options Controlling C Dialect}.
180 @gccoptlist{-ansi  -std=@var{standard}  -fgnu89-inline @gol
181 -fpermitted-flt-eval-methods=@var{standard} @gol
182 -aux-info @var{filename}  -fallow-parameterless-variadic-functions @gol
183 -fno-asm  -fno-builtin  -fno-builtin-@var{function}  -fgimple@gol
184 -fhosted  -ffreestanding  -fopenacc  -fopenmp  -fopenmp-simd @gol
185 -fms-extensions  -fplan9-extensions  -fsso-struct=@var{endianness} @gol
186 -fallow-single-precision  -fcond-mismatch  -flax-vector-conversions @gol
187 -fsigned-bitfields  -fsigned-char @gol
188 -funsigned-bitfields  -funsigned-char}
190 @item C++ Language Options
191 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
192 @gccoptlist{-fabi-version=@var{n}  -fno-access-control @gol
193 -faligned-new=@var{n}  -fargs-in-order=@var{n}  -fcheck-new @gol
194 -fconstexpr-depth=@var{n}  -fconstexpr-loop-limit=@var{n} @gol
195 -ffriend-injection @gol
196 -fno-elide-constructors @gol
197 -fno-enforce-eh-specs @gol
198 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
199 -fno-implicit-templates @gol
200 -fno-implicit-inline-templates @gol
201 -fno-implement-inlines  -fms-extensions @gol
202 -fnew-inheriting-ctors @gol
203 -fnew-ttp-matching @gol
204 -fno-nonansi-builtins  -fnothrow-opt  -fno-operator-names @gol
205 -fno-optional-diags  -fpermissive @gol
206 -fno-pretty-templates @gol
207 -frepo  -fno-rtti  -fsized-deallocation @gol
208 -ftemplate-backtrace-limit=@var{n} @gol
209 -ftemplate-depth=@var{n} @gol
210 -fno-threadsafe-statics  -fuse-cxa-atexit @gol
211 -fno-weak  -nostdinc++ @gol
212 -fvisibility-inlines-hidden @gol
213 -fvisibility-ms-compat @gol
214 -fext-numeric-literals @gol
215 -Wabi=@var{n}  -Wabi-tag  -Wconversion-null  -Wctor-dtor-privacy @gol
216 -Wdelete-non-virtual-dtor  -Wliteral-suffix  -Wmultiple-inheritance @gol
217 -Wnamespaces  -Wnarrowing @gol
218 -Wnoexcept  -Wnoexcept-type  -Wnon-virtual-dtor  -Wreorder  -Wregister @gol
219 -Weffc++  -Wstrict-null-sentinel  -Wtemplates @gol
220 -Wno-non-template-friend  -Wold-style-cast @gol
221 -Woverloaded-virtual  -Wno-pmf-conversions @gol
222 -Wsign-promo  -Wvirtual-inheritance}
224 @item Objective-C and Objective-C++ Language Options
225 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
226 Objective-C and Objective-C++ Dialects}.
227 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
228 -fgnu-runtime  -fnext-runtime @gol
229 -fno-nil-receivers @gol
230 -fobjc-abi-version=@var{n} @gol
231 -fobjc-call-cxx-cdtors @gol
232 -fobjc-direct-dispatch @gol
233 -fobjc-exceptions @gol
234 -fobjc-gc @gol
235 -fobjc-nilcheck @gol
236 -fobjc-std=objc1 @gol
237 -fno-local-ivars @gol
238 -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]} @gol
239 -freplace-objc-classes @gol
240 -fzero-link @gol
241 -gen-decls @gol
242 -Wassign-intercept @gol
243 -Wno-protocol  -Wselector @gol
244 -Wstrict-selector-match @gol
245 -Wundeclared-selector}
247 @item Diagnostic Message Formatting Options
248 @xref{Diagnostic Message Formatting Options,,Options to Control Diagnostic Messages Formatting}.
249 @gccoptlist{-fmessage-length=@var{n}  @gol
250 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
251 -fdiagnostics-color=@r{[}auto@r{|}never@r{|}always@r{]}  @gol
252 -fno-diagnostics-show-option  -fno-diagnostics-show-caret @gol
253 -fdiagnostics-parseable-fixits  -fdiagnostics-generate-patch @gol
254 -fno-show-column}
256 @item Warning Options
257 @xref{Warning Options,,Options to Request or Suppress Warnings}.
258 @gccoptlist{-fsyntax-only  -fmax-errors=@var{n}  -Wpedantic @gol
259 -pedantic-errors @gol
260 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  @gol
261 -Walloc-zero  -Walloc-size-larger-than=@var{n}
262 -Walloca  -Walloca-larger-than=@var{n} @gol
263 -Wno-aggressive-loop-optimizations  -Warray-bounds  -Warray-bounds=@var{n} @gol
264 -Wno-attributes  -Wbool-compare  -Wbool-operation @gol
265 -Wno-builtin-declaration-mismatch @gol
266 -Wno-builtin-macro-redefined  -Wc90-c99-compat  -Wc99-c11-compat @gol
267 -Wc++-compat  -Wc++11-compat  -Wc++14-compat  -Wcast-align  -Wcast-qual  @gol
268 -Wchar-subscripts  -Wclobbered  -Wcomment  -Wconditionally-supported  @gol
269 -Wconversion  -Wcoverage-mismatch  -Wno-cpp  -Wdangling-else  -Wdate-time @gol
270 -Wdelete-incomplete @gol
271 -Wno-deprecated  -Wno-deprecated-declarations  -Wno-designated-init @gol
272 -Wdisabled-optimization @gol
273 -Wno-discarded-qualifiers  -Wno-discarded-array-qualifiers @gol
274 -Wno-div-by-zero  -Wdouble-promotion  -Wduplicated-cond @gol
275 -Wempty-body  -Wenum-compare  -Wno-endif-labels  -Wexpansion-to-defined @gol
276 -Werror  -Werror=*  -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
277 -Wno-format-contains-nul  -Wno-format-extra-args  @gol
278 -Wformat-nonliteral -Wformat-overflow=@var{n} @gol
279 -Wformat-security  -Wformat-signedness  -Wformat-truncation=@var{n} @gol
280 -Wformat-y2k  -Wframe-address @gol
281 -Wframe-larger-than=@var{len}  -Wno-free-nonheap-object  -Wjump-misses-init @gol
282 -Wignored-qualifiers  -Wignored-attributes  -Wincompatible-pointer-types @gol
283 -Wimplicit  -Wimplicit-fallthrough  -Wimplicit-fallthrough=@var{n} @gol
284 -Wimplicit-function-declaration  -Wimplicit-int @gol
285 -Winit-self  -Winline  -Wno-int-conversion  -Wint-in-bool-context @gol
286 -Wno-int-to-pointer-cast  -Winvalid-memory-model  -Wno-invalid-offsetof @gol
287 -Winvalid-pch  -Wlarger-than=@var{len} @gol
288 -Wlogical-op  -Wlogical-not-parentheses  -Wlong-long @gol
289 -Wmain  -Wmaybe-uninitialized  -Wmemset-elt-size  -Wmemset-transposed-args @gol
290 -Wmisleading-indentation  -Wmissing-braces @gol
291 -Wmissing-field-initializers  -Wmissing-include-dirs @gol
292 -Wno-multichar  -Wnonnull  -Wnonnull-compare @gol
293 -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]} @gol
294 -Wnull-dereference  -Wodr  -Wno-overflow  -Wopenmp-simd  @gol
295 -Woverride-init-side-effects  -Woverlength-strings @gol
296 -Wpacked  -Wpacked-bitfield-compat  -Wpadded @gol
297 -Wparentheses  -Wno-pedantic-ms-format @gol
298 -Wplacement-new  -Wplacement-new=@var{n} @gol
299 -Wpointer-arith  -Wpointer-compare  -Wno-pointer-to-int-cast @gol
300 -Wno-pragmas  -Wredundant-decls  -Wrestrict  -Wno-return-local-addr @gol
301 -Wreturn-type  -Wsequence-point  -Wshadow  -Wno-shadow-ivar @gol
302 -Wshadow=global,  -Wshadow=local,  -Wshadow=compatible-local @gol
303 -Wshift-overflow  -Wshift-overflow=@var{n} @gol
304 -Wshift-count-negative  -Wshift-count-overflow  -Wshift-negative-value @gol
305 -Wsign-compare  -Wsign-conversion  -Wfloat-conversion @gol
306 -Wno-scalar-storage-order @gol
307 -Wsizeof-pointer-memaccess  -Wsizeof-array-argument @gol
308 -Wstack-protector  -Wstack-usage=@var{len}  -Wstrict-aliasing @gol
309 -Wstrict-aliasing=n  -Wstrict-overflow  -Wstrict-overflow=@var{n} @gol
310 -Wstringop-overflow=@var{n} @gol
311 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]} @gol
312 -Wsuggest-final-types @gol  -Wsuggest-final-methods  -Wsuggest-override @gol
313 -Wmissing-format-attribute  -Wsubobject-linkage @gol
314 -Wswitch  -Wswitch-bool  -Wswitch-default  -Wswitch-enum @gol
315 -Wswitch-unreachable  -Wsync-nand @gol
316 -Wsystem-headers  -Wtautological-compare  -Wtrampolines  -Wtrigraphs @gol
317 -Wtype-limits  -Wundef @gol
318 -Wuninitialized  -Wunknown-pragmas  -Wunsafe-loop-optimizations @gol
319 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
320 -Wunused-label  -Wunused-local-typedefs  -Wunused-macros @gol
321 -Wunused-parameter  -Wno-unused-result @gol
322 -Wunused-value  -Wunused-variable @gol
323 -Wunused-const-variable  -Wunused-const-variable=@var{n} @gol
324 -Wunused-but-set-parameter  -Wunused-but-set-variable @gol
325 -Wuseless-cast  -Wvariadic-macros  -Wvector-operation-performance @gol
326 -Wvla  -Wvla-larger-than=@var{n}  -Wvolatile-register-var  -Wwrite-strings @gol
327 -Wzero-as-null-pointer-constant  -Whsa}
329 @item C and Objective-C-only Warning Options
330 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
331 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
332 -Wold-style-declaration  -Wold-style-definition @gol
333 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
334 -Wdeclaration-after-statement  -Wpointer-sign}
336 @item Debugging Options
337 @xref{Debugging Options,,Options for Debugging Your Program}.
338 @gccoptlist{-g  -g@var{level}  -gcoff  -gdwarf  -gdwarf-@var{version} @gol
339 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
340 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
341 -gcolumn-info  -gno-column-info @gol
342 -gvms  -gxcoff  -gxcoff+  -gz@r{[}=@var{type}@r{]} @gol
343 -fdebug-prefix-map=@var{old}=@var{new}  -fdebug-types-section @gol
344 -feliminate-dwarf2-dups  -fno-eliminate-unused-debug-types @gol
345 -femit-struct-debug-baseonly  -femit-struct-debug-reduced @gol
346 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
347 -feliminate-unused-debug-symbols  -femit-class-debug-always @gol
348 -fno-merge-debug-strings  -fno-dwarf2-cfi-asm @gol
349 -fvar-tracking  -fvar-tracking-assignments}
351 @item Optimization Options
352 @xref{Optimize Options,,Options that Control Optimization}.
353 @gccoptlist{-faggressive-loop-optimizations  -falign-functions[=@var{n}] @gol
354 -falign-jumps[=@var{n}] @gol
355 -falign-labels[=@var{n}]  -falign-loops[=@var{n}] @gol
356 -fassociative-math  -fauto-profile  -fauto-profile[=@var{path}] @gol
357 -fauto-inc-dec  -fbranch-probabilities @gol
358 -fbranch-target-load-optimize  -fbranch-target-load-optimize2 @gol
359 -fbtr-bb-exclusive  -fcaller-saves @gol
360 -fcombine-stack-adjustments  -fconserve-stack @gol
361 -fcompare-elim  -fcprop-registers  -fcrossjumping @gol
362 -fcse-follow-jumps  -fcse-skip-blocks  -fcx-fortran-rules @gol
363 -fcx-limited-range @gol
364 -fdata-sections  -fdce  -fdelayed-branch @gol
365 -fdelete-null-pointer-checks  -fdevirtualize  -fdevirtualize-speculatively @gol
366 -fdevirtualize-at-ltrans  -fdse @gol
367 -fearly-inlining  -fipa-sra  -fexpensive-optimizations  -ffat-lto-objects @gol
368 -ffast-math  -ffinite-math-only  -ffloat-store  -fexcess-precision=@var{style} @gol
369 -fforward-propagate  -ffp-contract=@var{style}  -ffunction-sections @gol
370 -fgcse  -fgcse-after-reload  -fgcse-las  -fgcse-lm  -fgraphite-identity @gol
371 -fgcse-sm  -fhoist-adjacent-loads  -fif-conversion @gol
372 -fif-conversion2  -findirect-inlining @gol
373 -finline-functions  -finline-functions-called-once  -finline-limit=@var{n} @gol
374 -finline-small-functions  -fipa-cp  -fipa-cp-clone @gol
375 -fipa-bit-cp @gol
376 -fipa-pta  -fipa-profile  -fipa-pure-const  -fipa-reference  -fipa-icf @gol
377 -fira-algorithm=@var{algorithm} @gol
378 -fira-region=@var{region}  -fira-hoist-pressure @gol
379 -fira-loop-pressure  -fno-ira-share-save-slots @gol
380 -fno-ira-share-spill-slots @gol
381 -fisolate-erroneous-paths-dereference  -fisolate-erroneous-paths-attribute @gol
382 -fivopts  -fkeep-inline-functions  -fkeep-static-functions @gol
383 -fkeep-static-consts  -flimit-function-alignment  -flive-range-shrinkage @gol
384 -floop-block  -floop-interchange  -floop-strip-mine @gol
385 -floop-unroll-and-jam  -floop-nest-optimize @gol
386 -floop-parallelize-all  -flra-remat  -flto  -flto-compression-level @gol
387 -flto-partition=@var{alg}  -fmerge-all-constants @gol
388 -fmerge-constants  -fmodulo-sched  -fmodulo-sched-allow-regmoves @gol
389 -fmove-loop-invariants  -fno-branch-count-reg @gol
390 -fno-defer-pop  -fno-fp-int-builtin-inexact  -fno-function-cse @gol
391 -fno-guess-branch-probability  -fno-inline  -fno-math-errno  -fno-peephole @gol
392 -fno-peephole2  -fno-printf-return-value  -fno-sched-interblock @gol
393 -fno-sched-spec  -fno-signed-zeros @gol
394 -fno-toplevel-reorder  -fno-trapping-math  -fno-zero-initialized-in-bss @gol
395 -fomit-frame-pointer  -foptimize-sibling-calls @gol
396 -fpartial-inlining  -fpeel-loops  -fpredictive-commoning @gol
397 -fprefetch-loop-arrays @gol
398 -fprofile-correction @gol
399 -fprofile-use  -fprofile-use=@var{path}  -fprofile-values @gol
400 -fprofile-reorder-functions @gol
401 -freciprocal-math  -free  -frename-registers  -freorder-blocks @gol
402 -freorder-blocks-algorithm=@var{algorithm} @gol
403 -freorder-blocks-and-partition  -freorder-functions @gol
404 -frerun-cse-after-loop  -freschedule-modulo-scheduled-loops @gol
405 -frounding-math  -fsched2-use-superblocks  -fsched-pressure @gol
406 -fsched-spec-load  -fsched-spec-load-dangerous @gol
407 -fsched-stalled-insns-dep[=@var{n}]  -fsched-stalled-insns[=@var{n}] @gol
408 -fsched-group-heuristic  -fsched-critical-path-heuristic @gol
409 -fsched-spec-insn-heuristic  -fsched-rank-heuristic @gol
410 -fsched-last-insn-heuristic  -fsched-dep-count-heuristic @gol
411 -fschedule-fusion @gol
412 -fschedule-insns  -fschedule-insns2  -fsection-anchors @gol
413 -fselective-scheduling  -fselective-scheduling2 @gol
414 -fsel-sched-pipelining  -fsel-sched-pipelining-outer-loops @gol
415 -fsemantic-interposition  -fshrink-wrap  -fshrink-wrap-separate @gol
416 -fsignaling-nans @gol
417 -fsingle-precision-constant  -fsplit-ivs-in-unroller  -fsplit-loops@gol
418 -fsplit-paths @gol
419 -fsplit-wide-types  -fssa-backprop  -fssa-phiopt @gol
420 -fstdarg-opt  -fstore-merging  -fstrict-aliasing @gol
421 -fstrict-overflow  -fthread-jumps  -ftracer  -ftree-bit-ccp @gol
422 -ftree-builtin-call-dce  -ftree-ccp  -ftree-ch @gol
423 -ftree-coalesce-vars  -ftree-copy-prop  -ftree-dce  -ftree-dominator-opts @gol
424 -ftree-dse  -ftree-forwprop  -ftree-fre  -fcode-hoisting @gol
425 -ftree-loop-if-convert  -ftree-loop-im @gol
426 -ftree-phiprop  -ftree-loop-distribution  -ftree-loop-distribute-patterns @gol
427 -ftree-loop-ivcanon  -ftree-loop-linear  -ftree-loop-optimize @gol
428 -ftree-loop-vectorize @gol
429 -ftree-parallelize-loops=@var{n}  -ftree-pre  -ftree-partial-pre  -ftree-pta @gol
430 -ftree-reassoc  -ftree-sink  -ftree-slsr  -ftree-sra @gol
431 -ftree-switch-conversion  -ftree-tail-merge @gol
432 -ftree-ter  -ftree-vectorize  -ftree-vrp  -funconstrained-commons @gol
433 -funit-at-a-time  -funroll-all-loops  -funroll-loops @gol
434 -funsafe-math-optimizations  -funswitch-loops @gol
435 -fipa-ra  -fvariable-expansion-in-unroller  -fvect-cost-model  -fvpt @gol
436 -fweb  -fwhole-program  -fwpa  -fuse-linker-plugin @gol
437 --param @var{name}=@var{value}
438 -O  -O0  -O1  -O2  -O3  -Os  -Ofast  -Og}
440 @item Program Instrumentation Options
441 @xref{Instrumentation Options,,Program Instrumentation Options}.
442 @gccoptlist{-p  -pg  -fprofile-arcs  --coverage  -ftest-coverage @gol
443 -fprofile-dir=@var{path}  -fprofile-generate  -fprofile-generate=@var{path} @gol
444 -fsanitize=@var{style}  -fsanitize-recover  -fsanitize-recover=@var{style} @gol
445 -fasan-shadow-offset=@var{number}  -fsanitize-sections=@var{s1},@var{s2},... @gol
446 -fsanitize-undefined-trap-on-error  -fbounds-check @gol
447 -fcheck-pointer-bounds  -fchkp-check-incomplete-type @gol
448 -fchkp-first-field-has-own-bounds  -fchkp-narrow-bounds @gol
449 -fchkp-narrow-to-innermost-array  -fchkp-optimize @gol
450 -fchkp-use-fast-string-functions  -fchkp-use-nochk-string-functions @gol
451 -fchkp-use-static-bounds  -fchkp-use-static-const-bounds @gol
452 -fchkp-treat-zero-dynamic-size-as-infinite  -fchkp-check-read @gol
453 -fchkp-check-read  -fchkp-check-write  -fchkp-store-bounds @gol
454 -fchkp-instrument-calls  -fchkp-instrument-marked-only @gol
455 -fchkp-use-wrappers  -fchkp-flexible-struct-trailing-arrays@gol
456 -fstack-protector  -fstack-protector-all  -fstack-protector-strong @gol
457 -fstack-protector-explicit  -fstack-check @gol
458 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
459 -fno-stack-limit  -fsplit-stack @gol
460 -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]} @gol
461 -fvtv-counts  -fvtv-debug @gol
462 -finstrument-functions @gol
463 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
464 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}}
466 @item Preprocessor Options
467 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
468 @gccoptlist{-A@var{question}=@var{answer} @gol
469 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
470 -C  -CC  -D@var{macro}@r{[}=@var{defn}@r{]} @gol
471 -dD  -dI  -dM  -dN  -dU @gol
472 -fdebug-cpp  -fdirectives-only  -fdollars-in-identifiers  @gol
473 -fexec-charset=@var{charset}  -fextended-identifiers  @gol
474 -finput-charset=@var{charset}  -fno-canonical-system-headers @gol
475 -fpch-deps  -fpch-preprocess  -fpreprocessed @gol
476 -ftabstop=@var{width}  -ftrack-macro-expansion  @gol
477 -fwide-exec-charset=@var{charset}  -fworking-directory @gol
478 -H  -imacros @var{file}  -include @var{file} @gol
479 -M  -MD  -MF  -MG  -MM  -MMD  -MP  -MQ  -MT @gol
480 -no-integrated-cpp  -P  -pthread  -remap @gol
481 -traditional  -traditional-cpp  -trigraphs @gol
482 -U@var{macro}  -undef  @gol
483 -Wp,@var{option}  -Xpreprocessor @var{option}}
485 @item Assembler Options
486 @xref{Assembler Options,,Passing Options to the Assembler}.
487 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
489 @item Linker Options
490 @xref{Link Options,,Options for Linking}.
491 @gccoptlist{@var{object-file-name}  -fuse-ld=@var{linker}  -l@var{library} @gol
492 -nostartfiles  -nodefaultlibs  -nostdlib  -pie  -pthread  -rdynamic @gol
493 -s  -static  -static-libgcc  -static-libstdc++ @gol
494 -static-libasan  -static-libtsan  -static-liblsan  -static-libubsan @gol
495 -static-libmpx  -static-libmpxwrappers @gol
496 -shared  -shared-libgcc  -symbolic @gol
497 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
498 -u @var{symbol}  -z @var{keyword}}
500 @item Directory Options
501 @xref{Directory Options,,Options for Directory Search}.
502 @gccoptlist{-B@var{prefix}  -I@var{dir}  -I- @gol
503 -idirafter @var{dir} @gol
504 -imacros @var{file}  -imultilib @var{dir} @gol
505 -iplugindir=@var{dir}  -iprefix @var{file} @gol
506 -iquote @var{dir}  -isysroot @var{dir}  -isystem @var{dir} @gol
507 -iwithprefix @var{dir}  -iwithprefixbefore @var{dir}  @gol
508 -L@var{dir}  -no-canonical-prefixes  --no-sysroot-suffix @gol
509 -nostdinc  -nostdinc++  --sysroot=@var{dir}}
511 @item Code Generation Options
512 @xref{Code Gen Options,,Options for Code Generation Conventions}.
513 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
514 -ffixed-@var{reg}  -fexceptions @gol
515 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
516 -fasynchronous-unwind-tables @gol
517 -fno-gnu-unique @gol
518 -finhibit-size-directive  -fno-common  -fno-ident @gol
519 -fpcc-struct-return  -fpic  -fPIC  -fpie  -fPIE  -fno-plt @gol
520 -fno-jump-tables @gol
521 -frecord-gcc-switches @gol
522 -freg-struct-return  -fshort-enums  -fshort-wchar @gol
523 -fverbose-asm  -fpack-struct[=@var{n}]  @gol
524 -fleading-underscore  -ftls-model=@var{model} @gol
525 -fstack-reuse=@var{reuse_level} @gol
526 -ftrampolines  -ftrapv  -fwrapv @gol
527 -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]} @gol
528 -fstrict-volatile-bitfields  -fsync-libcalls}
530 @item Developer Options
531 @xref{Developer Options,,GCC Developer Options}.
532 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
533 -dumpfullversion  -fchecking  -fchecking=@var{n}  -fdbg-cnt-list @gol
534 -fdbg-cnt=@var{counter-value-list} @gol
535 -fdisable-ipa-@var{pass_name} @gol
536 -fdisable-rtl-@var{pass_name} @gol
537 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
538 -fdisable-tree-@var{pass_name} @gol
539 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
540 -fdump-noaddr  -fdump-unnumbered  -fdump-unnumbered-links @gol
541 -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
542 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
543 -fdump-ipa-all  -fdump-ipa-cgraph  -fdump-ipa-inline @gol
544 -fdump-passes @gol
545 -fdump-rtl-@var{pass}  -fdump-rtl-@var{pass}=@var{filename} @gol
546 -fdump-statistics @gol
547 -fdump-final-insns@r{[}=@var{file}@r{]}
548 -fdump-tree-all @gol
549 -fdump-tree-@var{switch} @gol
550 -fdump-tree-@var{switch}-@var{options} @gol
551 -fdump-tree-@var{switch}-@var{options}=@var{filename} @gol
552 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
553 -fenable-@var{kind}-@var{pass} @gol
554 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
555 -fira-verbose=@var{n} @gol
556 -flto-report  -flto-report-wpa  -fmem-report-wpa @gol
557 -fmem-report  -fpre-ipa-mem-report  -fpost-ipa-mem-report @gol
558 -fopt-info  -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
559 -fprofile-report @gol
560 -frandom-seed=@var{string}  -fsched-verbose=@var{n} @gol
561 -fsel-sched-verbose  -fsel-sched-dump-cfg  -fsel-sched-pipelining-verbose @gol
562 -fstats  -fstack-usage  -ftime-report  -ftime-report-details @gol
563 -fvar-tracking-assignments-toggle  -gtoggle @gol
564 -print-file-name=@var{library}  -print-libgcc-file-name @gol
565 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
566 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
567 -print-sysroot  -print-sysroot-headers-suffix @gol
568 -save-temps  -save-temps=cwd  -save-temps=obj  -time@r{[}=@var{file}@r{]}}
570 @item Machine-Dependent Options
571 @xref{Submodel Options,,Machine-Dependent Options}.
572 @c This list is ordered alphanumerically by subsection name.
573 @c Try and put the significant identifier (CPU or system) first,
574 @c so users have a clue at guessing where the ones they want will be.
576 @emph{AArch64 Options}
577 @gccoptlist{-mabi=@var{name}  -mbig-endian  -mlittle-endian @gol
578 -mgeneral-regs-only @gol
579 -mcmodel=tiny  -mcmodel=small  -mcmodel=large @gol
580 -mstrict-align @gol
581 -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
582 -mtls-dialect=desc  -mtls-dialect=traditional @gol
583 -mtls-size=@var{size} @gol
584 -mfix-cortex-a53-835769  -mno-fix-cortex-a53-835769 @gol
585 -mfix-cortex-a53-843419  -mno-fix-cortex-a53-843419 @gol
586 -mlow-precision-recip-sqrt  -mno-low-precision-recip-sqrt@gol
587 -mlow-precision-sqrt  -mno-low-precision-sqrt@gol
588 -mlow-precision-div  -mno-low-precision-div @gol
589 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}}
591 @emph{Adapteva Epiphany Options}
592 @gccoptlist{-mhalf-reg-file  -mprefer-short-insn-regs @gol
593 -mbranch-cost=@var{num}  -mcmove  -mnops=@var{num}  -msoft-cmpsf @gol
594 -msplit-lohi  -mpost-inc  -mpost-modify  -mstack-offset=@var{num} @gol
595 -mround-nearest  -mlong-calls  -mshort-calls  -msmall16 @gol
596 -mfp-mode=@var{mode}  -mvect-double  -max-vect-align=@var{num} @gol
597 -msplit-vecmove-early  -m1reg-@var{reg}}
599 @emph{ARC Options}
600 @gccoptlist{-mbarrel-shifter @gol
601 -mcpu=@var{cpu}  -mA6  -mARC600  -mA7  -mARC700 @gol
602 -mdpfp  -mdpfp-compact  -mdpfp-fast  -mno-dpfp-lrsr @gol
603 -mea  -mno-mpy  -mmul32x16  -mmul64  -matomic @gol
604 -mnorm  -mspfp  -mspfp-compact  -mspfp-fast  -msimd  -msoft-float  -mswap @gol
605 -mcrc  -mdsp-packa  -mdvbf  -mlock  -mmac-d16  -mmac-24  -mrtsc  -mswape @gol
606 -mtelephony  -mxy  -misize  -mannotate-align  -marclinux  -marclinux_prof @gol
607 -mlong-calls  -mmedium-calls  -msdata @gol
608 -mvolatile-cache  -mtp-regno=@var{regno} @gol
609 -malign-call  -mauto-modify-reg  -mbbit-peephole  -mno-brcc @gol
610 -mcase-vector-pcrel  -mcompact-casesi  -mno-cond-exec  -mearly-cbranchsi @gol
611 -mexpand-adddi  -mindexed-loads  -mlra  -mlra-priority-none @gol
612 -mlra-priority-compact mlra-priority-noncompact  -mno-millicode @gol
613 -mmixed-code  -mq-class  -mRcq  -mRcw  -msize-level=@var{level} @gol
614 -mtune=@var{cpu}  -mmultcost=@var{num} @gol
615 -munalign-prob-threshold=@var{probability}  -mmpy-option=@var{multo} @gol
616 -mdiv-rem  -mcode-density  -mll64  -mfpu=@var{fpu}}
618 @emph{ARM Options}
619 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
620 -mabi=@var{name} @gol
621 -mapcs-stack-check  -mno-apcs-stack-check @gol
622 -mapcs-reentrant  -mno-apcs-reentrant @gol
623 -msched-prolog  -mno-sched-prolog @gol
624 -mlittle-endian  -mbig-endian @gol
625 -mfloat-abi=@var{name} @gol
626 -mfp16-format=@var{name}
627 -mthumb-interwork  -mno-thumb-interwork @gol
628 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
629 -mtune=@var{name}  -mprint-tune-info @gol
630 -mstructure-size-boundary=@var{n} @gol
631 -mabort-on-noreturn @gol
632 -mlong-calls  -mno-long-calls @gol
633 -msingle-pic-base  -mno-single-pic-base @gol
634 -mpic-register=@var{reg} @gol
635 -mnop-fun-dllimport @gol
636 -mpoke-function-name @gol
637 -mthumb  -marm @gol
638 -mtpcs-frame  -mtpcs-leaf-frame @gol
639 -mcaller-super-interworking  -mcallee-super-interworking @gol
640 -mtp=@var{name}  -mtls-dialect=@var{dialect} @gol
641 -mword-relocations @gol
642 -mfix-cortex-m3-ldrd @gol
643 -munaligned-access @gol
644 -mneon-for-64bits @gol
645 -mslow-flash-data @gol
646 -masm-syntax-unified @gol
647 -mrestrict-it @gol
648 -mpure-code @gol
649 -mcmse}
651 @emph{AVR Options}
652 @gccoptlist{-mmcu=@var{mcu}  -mabsdata  -maccumulate-args @gol
653 -mbranch-cost=@var{cost} @gol
654 -mcall-prologues  -mint8  -mn_flash=@var{size}  -mno-interrupts @gol
655 -mrelax  -mrmw  -mstrict-X  -mtiny-stack  -mfract-convert-truncate @gol
656 -nodevicelib @gol
657 -Waddr-space-convert  -Wmisspelled-isr}
659 @emph{Blackfin Options}
660 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
661 -msim  -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
662 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
663 -mlow-64k  -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
664 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
665 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
666 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
667 -mfast-fp  -minline-plt  -mmulticore  -mcorea  -mcoreb  -msdram @gol
668 -micplb}
670 @emph{C6X Options}
671 @gccoptlist{-mbig-endian  -mlittle-endian  -march=@var{cpu} @gol
672 -msim  -msdata=@var{sdata-type}}
674 @emph{CRIS Options}
675 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
676 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
677 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
678 -mstack-align  -mdata-align  -mconst-align @gol
679 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
680 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
681 -mmul-bug-workaround  -mno-mul-bug-workaround}
683 @emph{CR16 Options}
684 @gccoptlist{-mmac @gol
685 -mcr16cplus  -mcr16c @gol
686 -msim  -mint32  -mbit-ops
687 -mdata-model=@var{model}}
689 @emph{Darwin Options}
690 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
691 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
692 -client_name  -compatibility_version  -current_version @gol
693 -dead_strip @gol
694 -dependency-file  -dylib_file  -dylinker_install_name @gol
695 -dynamic  -dynamiclib  -exported_symbols_list @gol
696 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
697 -force_flat_namespace  -headerpad_max_install_names @gol
698 -iframework @gol
699 -image_base  -init  -install_name  -keep_private_externs @gol
700 -multi_module  -multiply_defined  -multiply_defined_unused @gol
701 -noall_load   -no_dead_strip_inits_and_terms @gol
702 -nofixprebinding  -nomultidefs  -noprebind  -noseglinkedit @gol
703 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
704 -private_bundle  -read_only_relocs  -sectalign @gol
705 -sectobjectsymbols  -whyload  -seg1addr @gol
706 -sectcreate  -sectobjectsymbols  -sectorder @gol
707 -segaddr  -segs_read_only_addr  -segs_read_write_addr @gol
708 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
709 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
710 -single_module  -static  -sub_library  -sub_umbrella @gol
711 -twolevel_namespace  -umbrella  -undefined @gol
712 -unexported_symbols_list  -weak_reference_mismatches @gol
713 -whatsloaded  -F  -gused  -gfull  -mmacosx-version-min=@var{version} @gol
714 -mkernel  -mone-byte-bool}
716 @emph{DEC Alpha Options}
717 @gccoptlist{-mno-fp-regs  -msoft-float @gol
718 -mieee  -mieee-with-inexact  -mieee-conformant @gol
719 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
720 -mtrap-precision=@var{mode}  -mbuild-constants @gol
721 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
722 -mbwx  -mmax  -mfix  -mcix @gol
723 -mfloat-vax  -mfloat-ieee @gol
724 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
725 -msmall-text  -mlarge-text @gol
726 -mmemory-latency=@var{time}}
728 @emph{FR30 Options}
729 @gccoptlist{-msmall-model  -mno-lsim}
731 @emph{FT32 Options}
732 @gccoptlist{-msim  -mlra  -mnodiv}
734 @emph{FRV Options}
735 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
736 -mhard-float  -msoft-float @gol
737 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
738 -mdouble  -mno-double @gol
739 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
740 -mfdpic  -minline-plt  -mgprel-ro  -multilib-library-pic @gol
741 -mlinked-fp  -mlong-calls  -malign-labels @gol
742 -mlibrary-pic  -macc-4  -macc-8 @gol
743 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
744 -moptimize-membar  -mno-optimize-membar @gol
745 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
746 -mvliw-branch  -mno-vliw-branch @gol
747 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
748 -mno-nested-cond-exec  -mtomcat-stats @gol
749 -mTLS  -mtls @gol
750 -mcpu=@var{cpu}}
752 @emph{GNU/Linux Options}
753 @gccoptlist{-mglibc  -muclibc  -mmusl  -mbionic  -mandroid @gol
754 -tno-android-cc  -tno-android-ld}
756 @emph{H8/300 Options}
757 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr  -mno-exr  -mint32  -malign-300}
759 @emph{HPPA Options}
760 @gccoptlist{-march=@var{architecture-type} @gol
761 -mcaller-copies  -mdisable-fpregs  -mdisable-indexing @gol
762 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
763 -mfixed-range=@var{register-range} @gol
764 -mjump-in-delay  -mlinker-opt  -mlong-calls @gol
765 -mlong-load-store  -mno-disable-fpregs @gol
766 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
767 -mno-jump-in-delay  -mno-long-load-store @gol
768 -mno-portable-runtime  -mno-soft-float @gol
769 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
770 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
771 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
772 -munix=@var{unix-std}  -nolibdld  -static  -threads}
774 @emph{IA-64 Options}
775 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
776 -mvolatile-asm-stop  -mregister-names  -msdata  -mno-sdata @gol
777 -mconstant-gp  -mauto-pic  -mfused-madd @gol
778 -minline-float-divide-min-latency @gol
779 -minline-float-divide-max-throughput @gol
780 -mno-inline-float-divide @gol
781 -minline-int-divide-min-latency @gol
782 -minline-int-divide-max-throughput  @gol
783 -mno-inline-int-divide @gol
784 -minline-sqrt-min-latency  -minline-sqrt-max-throughput @gol
785 -mno-inline-sqrt @gol
786 -mdwarf2-asm  -mearly-stop-bits @gol
787 -mfixed-range=@var{register-range}  -mtls-size=@var{tls-size} @gol
788 -mtune=@var{cpu-type}  -milp32  -mlp64 @gol
789 -msched-br-data-spec  -msched-ar-data-spec  -msched-control-spec @gol
790 -msched-br-in-data-spec  -msched-ar-in-data-spec  -msched-in-control-spec @gol
791 -msched-spec-ldc  -msched-spec-control-ldc @gol
792 -msched-prefer-non-data-spec-insns  -msched-prefer-non-control-spec-insns @gol
793 -msched-stop-bits-after-every-cycle  -msched-count-spec-in-critical-path @gol
794 -msel-sched-dont-check-control-spec  -msched-fp-mem-deps-zero-cost @gol
795 -msched-max-memory-insns-hard-limit  -msched-max-memory-insns=@var{max-insns}}
797 @emph{LM32 Options}
798 @gccoptlist{-mbarrel-shift-enabled  -mdivide-enabled  -mmultiply-enabled @gol
799 -msign-extend-enabled  -muser-enabled}
801 @emph{M32R/D Options}
802 @gccoptlist{-m32r2  -m32rx  -m32r @gol
803 -mdebug @gol
804 -malign-loops  -mno-align-loops @gol
805 -missue-rate=@var{number} @gol
806 -mbranch-cost=@var{number} @gol
807 -mmodel=@var{code-size-model-type} @gol
808 -msdata=@var{sdata-type} @gol
809 -mno-flush-func  -mflush-func=@var{name} @gol
810 -mno-flush-trap  -mflush-trap=@var{number} @gol
811 -G @var{num}}
813 @emph{M32C Options}
814 @gccoptlist{-mcpu=@var{cpu}  -msim  -memregs=@var{number}}
816 @emph{M680x0 Options}
817 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune} @gol
818 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
819 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
820 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
821 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
822 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
823 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
824 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
825 -mxgot  -mno-xgot  -mlong-jump-table-offsets}
827 @emph{MCore Options}
828 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
829 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
830 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
831 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
832 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
834 @emph{MeP Options}
835 @gccoptlist{-mabsdiff  -mall-opts  -maverage  -mbased=@var{n}  -mbitops @gol
836 -mc=@var{n}  -mclip  -mconfig=@var{name}  -mcop  -mcop32  -mcop64  -mivc2 @gol
837 -mdc  -mdiv  -meb  -mel  -mio-volatile  -ml  -mleadz  -mm  -mminmax @gol
838 -mmult  -mno-opts  -mrepeat  -ms  -msatur  -msdram  -msim  -msimnovec  -mtf @gol
839 -mtiny=@var{n}}
841 @emph{MicroBlaze Options}
842 @gccoptlist{-msoft-float  -mhard-float  -msmall-divides  -mcpu=@var{cpu} @gol
843 -mmemcpy  -mxl-soft-mul  -mxl-soft-div  -mxl-barrel-shift @gol
844 -mxl-pattern-compare  -mxl-stack-check  -mxl-gp-opt  -mno-clearbss @gol
845 -mxl-multiply-high  -mxl-float-convert  -mxl-float-sqrt @gol
846 -mbig-endian  -mlittle-endian  -mxl-reorder  -mxl-mode-@var{app-model}}
848 @emph{MIPS Options}
849 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
850 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips32r3  -mips32r5 @gol
851 -mips32r6  -mips64  -mips64r2  -mips64r3  -mips64r5  -mips64r6 @gol
852 -mips16  -mno-mips16  -mflip-mips16 @gol
853 -minterlink-compressed  -mno-interlink-compressed @gol
854 -minterlink-mips16  -mno-interlink-mips16 @gol
855 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
856 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
857 -mgp32  -mgp64  -mfp32  -mfpxx  -mfp64  -mhard-float  -msoft-float @gol
858 -mno-float  -msingle-float  -mdouble-float @gol
859 -modd-spreg  -mno-odd-spreg @gol
860 -mabs=@var{mode}  -mnan=@var{encoding} @gol
861 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
862 -mmcu  -mmno-mcu @gol
863 -meva  -mno-eva @gol
864 -mvirt  -mno-virt @gol
865 -mxpa  -mno-xpa @gol
866 -mmicromips  -mno-micromips @gol
867 -mmsa  -mno-msa @gol
868 -mfpu=@var{fpu-type} @gol
869 -msmartmips  -mno-smartmips @gol
870 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
871 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
872 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
873 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
874 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
875 -membedded-data  -mno-embedded-data @gol
876 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
877 -mcode-readable=@var{setting} @gol
878 -msplit-addresses  -mno-split-addresses @gol
879 -mexplicit-relocs  -mno-explicit-relocs @gol
880 -mcheck-zero-division  -mno-check-zero-division @gol
881 -mdivide-traps  -mdivide-breaks @gol
882 -mload-store-pairs  -mno-load-store-pairs @gol
883 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
884 -mmad  -mno-mad  -mimadd  -mno-imadd  -mfused-madd  -mno-fused-madd  -nocpp @gol
885 -mfix-24k  -mno-fix-24k @gol
886 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
887 -mfix-r10000  -mno-fix-r10000  -mfix-rm7000  -mno-fix-rm7000 @gol
888 -mfix-vr4120  -mno-fix-vr4120 @gol
889 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
890 -mflush-func=@var{func}  -mno-flush-func @gol
891 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
892 -mcompact-branches=@var{policy} @gol
893 -mfp-exceptions  -mno-fp-exceptions @gol
894 -mvr4130-align  -mno-vr4130-align  -msynci  -mno-synci @gol
895 -mlxc1-sxc1 -mno-lxc1-sxc1 -mmadd4 -mno-madd4 @gol
896 -mrelax-pic-calls  -mno-relax-pic-calls  -mmcount-ra-address @gol
897 -mframe-header-opt  -mno-frame-header-opt}
899 @emph{MMIX Options}
900 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
901 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
902 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
903 -mno-base-addresses  -msingle-exit  -mno-single-exit}
905 @emph{MN10300 Options}
906 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
907 -mno-am33  -mam33  -mam33-2  -mam34 @gol
908 -mtune=@var{cpu-type} @gol
909 -mreturn-pointer-on-d0 @gol
910 -mno-crt0  -mrelax  -mliw  -msetlb}
912 @emph{Moxie Options}
913 @gccoptlist{-meb  -mel  -mmul.x  -mno-crt0}
915 @emph{MSP430 Options}
916 @gccoptlist{-msim  -masm-hex  -mmcu=  -mcpu=  -mlarge  -msmall  -mrelax @gol
917 -mwarn-mcu @gol
918 -mcode-region=  -mdata-region= @gol
919 -msilicon-errata=  -msilicon-errata-warn= @gol
920 -mhwmult=  -minrt}
922 @emph{NDS32 Options}
923 @gccoptlist{-mbig-endian  -mlittle-endian @gol
924 -mreduced-regs  -mfull-regs @gol
925 -mcmov  -mno-cmov @gol
926 -mperf-ext  -mno-perf-ext @gol
927 -mv3push  -mno-v3push @gol
928 -m16bit  -mno-16bit @gol
929 -misr-vector-size=@var{num} @gol
930 -mcache-block-size=@var{num} @gol
931 -march=@var{arch} @gol
932 -mcmodel=@var{code-model} @gol
933 -mctor-dtor  -mrelax}
935 @emph{Nios II Options}
936 @gccoptlist{-G @var{num}  -mgpopt=@var{option}  -mgpopt  -mno-gpopt @gol
937 -mel  -meb @gol
938 -mno-bypass-cache  -mbypass-cache @gol
939 -mno-cache-volatile  -mcache-volatile @gol
940 -mno-fast-sw-div  -mfast-sw-div @gol
941 -mhw-mul  -mno-hw-mul  -mhw-mulx  -mno-hw-mulx  -mno-hw-div  -mhw-div @gol
942 -mcustom-@var{insn}=@var{N}  -mno-custom-@var{insn} @gol
943 -mcustom-fpu-cfg=@var{name} @gol
944 -mhal  -msmallc  -msys-crt0=@var{name}  -msys-lib=@var{name} @gol
945 -march=@var{arch}  -mbmx  -mno-bmx  -mcdx  -mno-cdx}
947 @emph{Nvidia PTX Options}
948 @gccoptlist{-m32  -m64  -mmainkernel  -moptimize}
950 @emph{PDP-11 Options}
951 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
952 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
953 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
954 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
955 -mbranch-expensive  -mbranch-cheap @gol
956 -munix-asm  -mdec-asm}
958 @emph{picoChip Options}
959 @gccoptlist{-mae=@var{ae_type}  -mvliw-lookahead=@var{N} @gol
960 -msymbol-as-address  -mno-inefficient-warnings}
962 @emph{PowerPC Options}
963 See RS/6000 and PowerPC Options.
965 @emph{RISC-V Options}
966 @gccoptlist{-mbranch-cost=@var{N-instruction} @gol
967 -mmemcpy  -mno-memcpy @gol
968 -mplt  -mno-plt @gol
969 -mabi=@var{ABI-string} @gol
970 -mfdiv  -mno-fdiv @gol
971 -mdiv  -mno-div @gol
972 -march=@var{ISA-string} @gol
973 -mtune=@var{processor-string} @gol
974 -msmall-data-limit=@var{N-bytes} @gol
975 -msave-restore  -mno-save-restore @gol
976 -mcmodel=@var{code-model} @gol
977 -mexplicit-relocs  -mno-explicit-relocs @gol}
979 @emph{RL78 Options}
980 @gccoptlist{-msim  -mmul=none  -mmul=g13  -mmul=g14  -mallregs @gol
981 -mcpu=g10  -mcpu=g13  -mcpu=g14  -mg10  -mg13  -mg14 @gol
982 -m64bit-doubles  -m32bit-doubles  -msave-mduc-in-interrupts}
984 @emph{RS/6000 and PowerPC Options}
985 @gccoptlist{-mcpu=@var{cpu-type} @gol
986 -mtune=@var{cpu-type} @gol
987 -mcmodel=@var{code-model} @gol
988 -mpowerpc64 @gol
989 -maltivec  -mno-altivec @gol
990 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
991 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
992 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mpopcntd  -mno-popcntd @gol
993 -mfprnd  -mno-fprnd @gol
994 -mcmpb  -mno-cmpb  -mmfpgpr  -mno-mfpgpr  -mhard-dfp  -mno-hard-dfp @gol
995 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
996 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
997 -malign-power  -malign-natural @gol
998 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
999 -msingle-float  -mdouble-float  -msimple-fpu @gol
1000 -mstring  -mno-string  -mupdate  -mno-update @gol
1001 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
1002 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
1003 -mstrict-align  -mno-strict-align  -mrelocatable @gol
1004 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
1005 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
1006 -mdynamic-no-pic  -maltivec  -mswdiv  -msingle-pic-base @gol
1007 -mprioritize-restricted-insns=@var{priority} @gol
1008 -msched-costly-dep=@var{dependence_type} @gol
1009 -minsert-sched-nops=@var{scheme} @gol
1010 -mcall-sysv  -mcall-netbsd @gol
1011 -maix-struct-return  -msvr4-struct-return @gol
1012 -mabi=@var{abi-type}  -msecure-plt  -mbss-plt @gol
1013 -mblock-move-inline-limit=@var{num} @gol
1014 -misel  -mno-isel @gol
1015 -misel=yes  -misel=no @gol
1016 -mspe  -mno-spe @gol
1017 -mspe=yes  -mspe=no @gol
1018 -mpaired @gol
1019 -mgen-cell-microcode  -mwarn-cell-microcode @gol
1020 -mvrsave  -mno-vrsave @gol
1021 -mmulhw  -mno-mulhw @gol
1022 -mdlmzb  -mno-dlmzb @gol
1023 -mfloat-gprs=yes  -mfloat-gprs=no  -mfloat-gprs=single  -mfloat-gprs=double @gol
1024 -mprototype  -mno-prototype @gol
1025 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
1026 -msdata=@var{opt}  -mvxworks  -G @var{num} @gol
1027 -mrecip  -mrecip=@var{opt}  -mno-recip  -mrecip-precision @gol
1028 -mno-recip-precision @gol
1029 -mveclibabi=@var{type}  -mfriz  -mno-friz @gol
1030 -mpointers-to-nested-functions  -mno-pointers-to-nested-functions @gol
1031 -msave-toc-indirect  -mno-save-toc-indirect @gol
1032 -mpower8-fusion  -mno-mpower8-fusion  -mpower8-vector  -mno-power8-vector @gol
1033 -mcrypto  -mno-crypto  -mhtm  -mno-htm  -mdirect-move  -mno-direct-move @gol
1034 -mquad-memory  -mno-quad-memory @gol
1035 -mquad-memory-atomic  -mno-quad-memory-atomic @gol
1036 -mcompat-align-parm  -mno-compat-align-parm @gol
1037 -mupper-regs-df  -mno-upper-regs-df  -mupper-regs-sf  -mno-upper-regs-sf @gol
1038 -mupper-regs-di  -mno-upper-regs-di @gol
1039 -mupper-regs  -mno-upper-regs @gol
1040 -mfloat128  -mno-float128  -mfloat128-hardware  -mno-float128-hardware @gol
1041 -mgnu-attribute  -mno-gnu-attribute @gol
1042 -mstack-protector-guard=@var{guard} -mstack-protector-guard-reg=@var{reg} @gol
1043 -mstack-protector-guard-offset=@var{offset} @gol
1044 -mlra  -mno-lra}
1046 @emph{RX Options}
1047 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
1048 -mcpu=@gol
1049 -mbig-endian-data  -mlittle-endian-data @gol
1050 -msmall-data @gol
1051 -msim  -mno-sim@gol
1052 -mas100-syntax  -mno-as100-syntax@gol
1053 -mrelax@gol
1054 -mmax-constant-size=@gol
1055 -mint-register=@gol
1056 -mpid@gol
1057 -mallow-string-insns  -mno-allow-string-insns@gol
1058 -mjsr@gol
1059 -mno-warn-multiple-fast-interrupts@gol
1060 -msave-acc-in-interrupts}
1062 @emph{S/390 and zSeries Options}
1063 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1064 -mhard-float  -msoft-float  -mhard-dfp  -mno-hard-dfp @gol
1065 -mlong-double-64  -mlong-double-128 @gol
1066 -mbackchain  -mno-backchain  -mpacked-stack  -mno-packed-stack @gol
1067 -msmall-exec  -mno-small-exec  -mmvcle  -mno-mvcle @gol
1068 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
1069 -mhtm  -mvx  -mzvector @gol
1070 -mtpf-trace  -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
1071 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size  -mstack-guard @gol
1072 -mhotpatch=@var{halfwords},@var{halfwords}}
1074 @emph{Score Options}
1075 @gccoptlist{-meb  -mel @gol
1076 -mnhwloop @gol
1077 -muls @gol
1078 -mmac @gol
1079 -mscore5  -mscore5u  -mscore7  -mscore7d}
1081 @emph{SH Options}
1082 @gccoptlist{-m1  -m2  -m2e @gol
1083 -m2a-nofpu  -m2a-single-only  -m2a-single  -m2a @gol
1084 -m3  -m3e @gol
1085 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
1086 -m4a-nofpu  -m4a-single-only  -m4a-single  -m4a  -m4al @gol
1087 -mb  -ml  -mdalign  -mrelax @gol
1088 -mbigtable  -mfmovd  -mrenesas  -mno-renesas  -mnomacsave @gol
1089 -mieee  -mno-ieee  -mbitops  -misize  -minline-ic_invalidate  -mpadstruct @gol
1090 -mprefergot  -musermode  -multcost=@var{number}  -mdiv=@var{strategy} @gol
1091 -mdivsi3_libfunc=@var{name}  -mfixed-range=@var{register-range} @gol
1092 -maccumulate-outgoing-args @gol
1093 -matomic-model=@var{atomic-model} @gol
1094 -mbranch-cost=@var{num}  -mzdcbranch  -mno-zdcbranch @gol
1095 -mcbranch-force-delay-slot @gol
1096 -mfused-madd  -mno-fused-madd  -mfsca  -mno-fsca  -mfsrra  -mno-fsrra @gol
1097 -mpretend-cmove  -mtas}
1099 @emph{Solaris 2 Options}
1100 @gccoptlist{-mclear-hwcap  -mno-clear-hwcap  -mimpure-text  -mno-impure-text @gol
1101 -pthreads}
1103 @emph{SPARC Options}
1104 @gccoptlist{-mcpu=@var{cpu-type} @gol
1105 -mtune=@var{cpu-type} @gol
1106 -mcmodel=@var{code-model} @gol
1107 -mmemory-model=@var{mem-model} @gol
1108 -m32  -m64  -mapp-regs  -mno-app-regs @gol
1109 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
1110 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1111 -mhard-quad-float  -msoft-quad-float @gol
1112 -mstack-bias  -mno-stack-bias @gol
1113 -mstd-struct-return  -mno-std-struct-return @gol
1114 -munaligned-doubles  -mno-unaligned-doubles @gol
1115 -muser-mode  -mno-user-mode @gol
1116 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
1117 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
1118 -mcbcond  -mno-cbcond  -mfmaf  -mno-fmaf  @gol
1119 -mpopc  -mno-popc  -msubxc  -mno-subxc@gol
1120 -mfix-at697f  -mfix-ut699 @gol
1121 -mlra  -mno-lra}
1123 @emph{SPU Options}
1124 @gccoptlist{-mwarn-reloc  -merror-reloc @gol
1125 -msafe-dma  -munsafe-dma @gol
1126 -mbranch-hints @gol
1127 -msmall-mem  -mlarge-mem  -mstdmain @gol
1128 -mfixed-range=@var{register-range} @gol
1129 -mea32  -mea64 @gol
1130 -maddress-space-conversion  -mno-address-space-conversion @gol
1131 -mcache-size=@var{cache-size} @gol
1132 -matomic-updates  -mno-atomic-updates}
1134 @emph{System V Options}
1135 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
1137 @emph{TILE-Gx Options}
1138 @gccoptlist{-mcpu=CPU  -m32  -m64  -mbig-endian  -mlittle-endian @gol
1139 -mcmodel=@var{code-model}}
1141 @emph{TILEPro Options}
1142 @gccoptlist{-mcpu=@var{cpu}  -m32}
1144 @emph{V850 Options}
1145 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
1146 -mprolog-function  -mno-prolog-function  -mspace @gol
1147 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
1148 -mapp-regs  -mno-app-regs @gol
1149 -mdisable-callt  -mno-disable-callt @gol
1150 -mv850e2v3  -mv850e2  -mv850e1  -mv850es @gol
1151 -mv850e  -mv850  -mv850e3v5 @gol
1152 -mloop @gol
1153 -mrelax @gol
1154 -mlong-jumps @gol
1155 -msoft-float @gol
1156 -mhard-float @gol
1157 -mgcc-abi @gol
1158 -mrh850-abi @gol
1159 -mbig-switch}
1161 @emph{VAX Options}
1162 @gccoptlist{-mg  -mgnu  -munix}
1164 @emph{Visium Options}
1165 @gccoptlist{-mdebug  -msim  -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1166 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type}  -msv-mode  -muser-mode}
1168 @emph{VMS Options}
1169 @gccoptlist{-mvms-return-codes  -mdebug-main=@var{prefix}  -mmalloc64 @gol
1170 -mpointer-size=@var{size}}
1172 @emph{VxWorks Options}
1173 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1174 -Xbind-lazy  -Xbind-now}
1176 @emph{x86 Options}
1177 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1178 -mtune-ctrl=@var{feature-list}  -mdump-tune-features  -mno-default @gol
1179 -mfpmath=@var{unit} @gol
1180 -masm=@var{dialect}  -mno-fancy-math-387 @gol
1181 -mno-fp-ret-in-387  -m80387  -mhard-float  -msoft-float @gol
1182 -mno-wide-multiply  -mrtd  -malign-double @gol
1183 -mpreferred-stack-boundary=@var{num} @gol
1184 -mincoming-stack-boundary=@var{num} @gol
1185 -mcld  -mcx16  -msahf  -mmovbe  -mcrc32 @gol
1186 -mrecip  -mrecip=@var{opt} @gol
1187 -mvzeroupper  -mprefer-avx128 @gol
1188 -mmmx  -msse  -msse2  -msse3  -mssse3  -msse4.1  -msse4.2  -msse4  -mavx @gol
1189 -mavx2  -mavx512f  -mavx512pf  -mavx512er  -mavx512cd  -mavx512vl @gol
1190 -mavx512bw  -mavx512dq  -mavx512ifma  -mavx512vbmi  -msha  -maes @gol
1191 -mpclmul  -mfsgsbase  -mrdrnd  -mf16c  -mfma @gol
1192 -mprefetchwt1  -mclflushopt  -mxsavec  -mxsaves @gol
1193 -msse4a  -m3dnow  -m3dnowa  -mpopcnt  -mabm  -mbmi  -mtbm  -mfma4  -mxop @gol
1194 -mlzcnt  -mbmi2  -mfxsr  -mxsave  -mxsaveopt  -mrtm  -mlwp  -mmpx  @gol
1195 -mmwaitx  -mclzero  -mpku  -mthreads @gol
1196 -mms-bitfields  -mno-align-stringops  -minline-all-stringops @gol
1197 -minline-stringops-dynamically  -mstringop-strategy=@var{alg} @gol
1198 -mmemcpy-strategy=@var{strategy}  -mmemset-strategy=@var{strategy} @gol
1199 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
1200 -m96bit-long-double  -mlong-double-64  -mlong-double-80  -mlong-double-128 @gol
1201 -mregparm=@var{num}  -msseregparm @gol
1202 -mveclibabi=@var{type}  -mvect8-ret-in-mem @gol
1203 -mpc32  -mpc64  -mpc80  -mstackrealign @gol
1204 -momit-leaf-frame-pointer  -mno-red-zone  -mno-tls-direct-seg-refs @gol
1205 -mcmodel=@var{code-model}  -mabi=@var{name}  -maddress-mode=@var{mode} @gol
1206 -m32  -m64  -mx32  -m16  -miamcu  -mlarge-data-threshold=@var{num} @gol
1207 -msse2avx  -mfentry  -mrecord-mcount  -mnop-mcount  -m8bit-idiv @gol
1208 -mavx256-split-unaligned-load  -mavx256-split-unaligned-store @gol
1209 -malign-data=@var{type}  -mstack-protector-guard=@var{guard} @gol
1210 -mmitigate-rop  -mgeneral-regs-only}
1212 @emph{x86 Windows Options}
1213 @gccoptlist{-mconsole  -mcygwin  -mno-cygwin  -mdll @gol
1214 -mnop-fun-dllimport  -mthread @gol
1215 -municode  -mwin32  -mwindows  -fno-set-stack-executable}
1217 @emph{Xstormy16 Options}
1218 @gccoptlist{-msim}
1220 @emph{Xtensa Options}
1221 @gccoptlist{-mconst16  -mno-const16 @gol
1222 -mfused-madd  -mno-fused-madd @gol
1223 -mforce-no-pic @gol
1224 -mserialize-volatile  -mno-serialize-volatile @gol
1225 -mtext-section-literals  -mno-text-section-literals @gol
1226 -mauto-litpools  -mno-auto-litpools @gol
1227 -mtarget-align  -mno-target-align @gol
1228 -mlongcalls  -mno-longcalls}
1230 @emph{zSeries Options}
1231 See S/390 and zSeries Options.
1232 @end table
1235 @node Overall Options
1236 @section Options Controlling the Kind of Output
1238 Compilation can involve up to four stages: preprocessing, compilation
1239 proper, assembly and linking, always in that order.  GCC is capable of
1240 preprocessing and compiling several files either into several
1241 assembler input files, or into one assembler input file; then each
1242 assembler input file produces an object file, and linking combines all
1243 the object files (those newly compiled, and those specified as input)
1244 into an executable file.
1246 @cindex file name suffix
1247 For any given input file, the file name suffix determines what kind of
1248 compilation is done:
1250 @table @gcctabopt
1251 @item @var{file}.c
1252 C source code that must be preprocessed.
1254 @item @var{file}.i
1255 C source code that should not be preprocessed.
1257 @item @var{file}.ii
1258 C++ source code that should not be preprocessed.
1260 @item @var{file}.m
1261 Objective-C source code.  Note that you must link with the @file{libobjc}
1262 library to make an Objective-C program work.
1264 @item @var{file}.mi
1265 Objective-C source code that should not be preprocessed.
1267 @item @var{file}.mm
1268 @itemx @var{file}.M
1269 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1270 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1271 to a literal capital M@.
1273 @item @var{file}.mii
1274 Objective-C++ source code that should not be preprocessed.
1276 @item @var{file}.h
1277 C, C++, Objective-C or Objective-C++ header file to be turned into a
1278 precompiled header (default), or C, C++ header file to be turned into an
1279 Ada spec (via the @option{-fdump-ada-spec} switch).
1281 @item @var{file}.cc
1282 @itemx @var{file}.cp
1283 @itemx @var{file}.cxx
1284 @itemx @var{file}.cpp
1285 @itemx @var{file}.CPP
1286 @itemx @var{file}.c++
1287 @itemx @var{file}.C
1288 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1289 the last two letters must both be literally @samp{x}.  Likewise,
1290 @samp{.C} refers to a literal capital C@.
1292 @item @var{file}.mm
1293 @itemx @var{file}.M
1294 Objective-C++ source code that must be preprocessed.
1296 @item @var{file}.mii
1297 Objective-C++ source code that should not be preprocessed.
1299 @item @var{file}.hh
1300 @itemx @var{file}.H
1301 @itemx @var{file}.hp
1302 @itemx @var{file}.hxx
1303 @itemx @var{file}.hpp
1304 @itemx @var{file}.HPP
1305 @itemx @var{file}.h++
1306 @itemx @var{file}.tcc
1307 C++ header file to be turned into a precompiled header or Ada spec.
1309 @item @var{file}.f
1310 @itemx @var{file}.for
1311 @itemx @var{file}.ftn
1312 Fixed form Fortran source code that should not be preprocessed.
1314 @item @var{file}.F
1315 @itemx @var{file}.FOR
1316 @itemx @var{file}.fpp
1317 @itemx @var{file}.FPP
1318 @itemx @var{file}.FTN
1319 Fixed form Fortran source code that must be preprocessed (with the traditional
1320 preprocessor).
1322 @item @var{file}.f90
1323 @itemx @var{file}.f95
1324 @itemx @var{file}.f03
1325 @itemx @var{file}.f08
1326 Free form Fortran source code that should not be preprocessed.
1328 @item @var{file}.F90
1329 @itemx @var{file}.F95
1330 @itemx @var{file}.F03
1331 @itemx @var{file}.F08
1332 Free form Fortran source code that must be preprocessed (with the
1333 traditional preprocessor).
1335 @item @var{file}.go
1336 Go source code.
1338 @item @var{file}.brig
1339 BRIG files (binary representation of HSAIL).
1341 @item @var{file}.ads
1342 Ada source code file that contains a library unit declaration (a
1343 declaration of a package, subprogram, or generic, or a generic
1344 instantiation), or a library unit renaming declaration (a package,
1345 generic, or subprogram renaming declaration).  Such files are also
1346 called @dfn{specs}.
1348 @item @var{file}.adb
1349 Ada source code file containing a library unit body (a subprogram or
1350 package body).  Such files are also called @dfn{bodies}.
1352 @c GCC also knows about some suffixes for languages not yet included:
1353 @c Pascal:
1354 @c @var{file}.p
1355 @c @var{file}.pas
1356 @c Ratfor:
1357 @c @var{file}.r
1359 @item @var{file}.s
1360 Assembler code.
1362 @item @var{file}.S
1363 @itemx @var{file}.sx
1364 Assembler code that must be preprocessed.
1366 @item @var{other}
1367 An object file to be fed straight into linking.
1368 Any file name with no recognized suffix is treated this way.
1369 @end table
1371 @opindex x
1372 You can specify the input language explicitly with the @option{-x} option:
1374 @table @gcctabopt
1375 @item -x @var{language}
1376 Specify explicitly the @var{language} for the following input files
1377 (rather than letting the compiler choose a default based on the file
1378 name suffix).  This option applies to all following input files until
1379 the next @option{-x} option.  Possible values for @var{language} are:
1380 @smallexample
1381 c  c-header  cpp-output
1382 c++  c++-header  c++-cpp-output
1383 objective-c  objective-c-header  objective-c-cpp-output
1384 objective-c++ objective-c++-header objective-c++-cpp-output
1385 assembler  assembler-with-cpp
1387 f77  f77-cpp-input f95  f95-cpp-input
1389 brig
1390 @end smallexample
1392 @item -x none
1393 Turn off any specification of a language, so that subsequent files are
1394 handled according to their file name suffixes (as they are if @option{-x}
1395 has not been used at all).
1396 @end table
1398 If you only want some of the stages of compilation, you can use
1399 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1400 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1401 @command{gcc} is to stop.  Note that some combinations (for example,
1402 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1404 @table @gcctabopt
1405 @item -c
1406 @opindex c
1407 Compile or assemble the source files, but do not link.  The linking
1408 stage simply is not done.  The ultimate output is in the form of an
1409 object file for each source file.
1411 By default, the object file name for a source file is made by replacing
1412 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1414 Unrecognized input files, not requiring compilation or assembly, are
1415 ignored.
1417 @item -S
1418 @opindex S
1419 Stop after the stage of compilation proper; do not assemble.  The output
1420 is in the form of an assembler code file for each non-assembler input
1421 file specified.
1423 By default, the assembler file name for a source file is made by
1424 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1426 Input files that don't require compilation are ignored.
1428 @item -E
1429 @opindex E
1430 Stop after the preprocessing stage; do not run the compiler proper.  The
1431 output is in the form of preprocessed source code, which is sent to the
1432 standard output.
1434 Input files that don't require preprocessing are ignored.
1436 @cindex output file option
1437 @item -o @var{file}
1438 @opindex o
1439 Place output in file @var{file}.  This applies to whatever
1440 sort of output is being produced, whether it be an executable file,
1441 an object file, an assembler file or preprocessed C code.
1443 If @option{-o} is not specified, the default is to put an executable
1444 file in @file{a.out}, the object file for
1445 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1446 assembler file in @file{@var{source}.s}, a precompiled header file in
1447 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1448 standard output.
1450 @item -v
1451 @opindex v
1452 Print (on standard error output) the commands executed to run the stages
1453 of compilation.  Also print the version number of the compiler driver
1454 program and of the preprocessor and the compiler proper.
1456 @item -###
1457 @opindex ###
1458 Like @option{-v} except the commands are not executed and arguments
1459 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1460 This is useful for shell scripts to capture the driver-generated command lines.
1462 @item --help
1463 @opindex help
1464 Print (on the standard output) a description of the command-line options
1465 understood by @command{gcc}.  If the @option{-v} option is also specified
1466 then @option{--help} is also passed on to the various processes
1467 invoked by @command{gcc}, so that they can display the command-line options
1468 they accept.  If the @option{-Wextra} option has also been specified
1469 (prior to the @option{--help} option), then command-line options that
1470 have no documentation associated with them are also displayed.
1472 @item --target-help
1473 @opindex target-help
1474 Print (on the standard output) a description of target-specific command-line
1475 options for each tool.  For some targets extra target-specific
1476 information may also be printed.
1478 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1479 Print (on the standard output) a description of the command-line
1480 options understood by the compiler that fit into all specified classes
1481 and qualifiers.  These are the supported classes:
1483 @table @asis
1484 @item @samp{optimizers}
1485 Display all of the optimization options supported by the
1486 compiler.
1488 @item @samp{warnings}
1489 Display all of the options controlling warning messages
1490 produced by the compiler.
1492 @item @samp{target}
1493 Display target-specific options.  Unlike the
1494 @option{--target-help} option however, target-specific options of the
1495 linker and assembler are not displayed.  This is because those
1496 tools do not currently support the extended @option{--help=} syntax.
1498 @item @samp{params}
1499 Display the values recognized by the @option{--param}
1500 option.
1502 @item @var{language}
1503 Display the options supported for @var{language}, where
1504 @var{language} is the name of one of the languages supported in this
1505 version of GCC@.
1507 @item @samp{common}
1508 Display the options that are common to all languages.
1509 @end table
1511 These are the supported qualifiers:
1513 @table @asis
1514 @item @samp{undocumented}
1515 Display only those options that are undocumented.
1517 @item @samp{joined}
1518 Display options taking an argument that appears after an equal
1519 sign in the same continuous piece of text, such as:
1520 @samp{--help=target}.
1522 @item @samp{separate}
1523 Display options taking an argument that appears as a separate word
1524 following the original option, such as: @samp{-o output-file}.
1525 @end table
1527 Thus for example to display all the undocumented target-specific
1528 switches supported by the compiler, use:
1530 @smallexample
1531 --help=target,undocumented
1532 @end smallexample
1534 The sense of a qualifier can be inverted by prefixing it with the
1535 @samp{^} character, so for example to display all binary warning
1536 options (i.e., ones that are either on or off and that do not take an
1537 argument) that have a description, use:
1539 @smallexample
1540 --help=warnings,^joined,^undocumented
1541 @end smallexample
1543 The argument to @option{--help=} should not consist solely of inverted
1544 qualifiers.
1546 Combining several classes is possible, although this usually
1547 restricts the output so much that there is nothing to display.  One
1548 case where it does work, however, is when one of the classes is
1549 @var{target}.  For example, to display all the target-specific
1550 optimization options, use:
1552 @smallexample
1553 --help=target,optimizers
1554 @end smallexample
1556 The @option{--help=} option can be repeated on the command line.  Each
1557 successive use displays its requested class of options, skipping
1558 those that have already been displayed.
1560 If the @option{-Q} option appears on the command line before the
1561 @option{--help=} option, then the descriptive text displayed by
1562 @option{--help=} is changed.  Instead of describing the displayed
1563 options, an indication is given as to whether the option is enabled,
1564 disabled or set to a specific value (assuming that the compiler
1565 knows this at the point where the @option{--help=} option is used).
1567 Here is a truncated example from the ARM port of @command{gcc}:
1569 @smallexample
1570   % gcc -Q -mabi=2 --help=target -c
1571   The following options are target specific:
1572   -mabi=                                2
1573   -mabort-on-noreturn                   [disabled]
1574   -mapcs                                [disabled]
1575 @end smallexample
1577 The output is sensitive to the effects of previous command-line
1578 options, so for example it is possible to find out which optimizations
1579 are enabled at @option{-O2} by using:
1581 @smallexample
1582 -Q -O2 --help=optimizers
1583 @end smallexample
1585 Alternatively you can discover which binary optimizations are enabled
1586 by @option{-O3} by using:
1588 @smallexample
1589 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1590 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1591 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1592 @end smallexample
1594 @item --version
1595 @opindex version
1596 Display the version number and copyrights of the invoked GCC@.
1598 @item -pass-exit-codes
1599 @opindex pass-exit-codes
1600 Normally the @command{gcc} program exits with the code of 1 if any
1601 phase of the compiler returns a non-success return code.  If you specify
1602 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1603 the numerically highest error produced by any phase returning an error
1604 indication.  The C, C++, and Fortran front ends return 4 if an internal
1605 compiler error is encountered.
1607 @item -pipe
1608 @opindex pipe
1609 Use pipes rather than temporary files for communication between the
1610 various stages of compilation.  This fails to work on some systems where
1611 the assembler is unable to read from a pipe; but the GNU assembler has
1612 no trouble.
1614 @item -specs=@var{file}
1615 @opindex specs
1616 Process @var{file} after the compiler reads in the standard @file{specs}
1617 file, in order to override the defaults which the @command{gcc} driver
1618 program uses when determining what switches to pass to @command{cc1},
1619 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
1620 @option{-specs=@var{file}} can be specified on the command line, and they
1621 are processed in order, from left to right.  @xref{Spec Files}, for
1622 information about the format of the @var{file}.
1624 @item -wrapper
1625 @opindex wrapper
1626 Invoke all subcommands under a wrapper program.  The name of the
1627 wrapper program and its parameters are passed as a comma separated
1628 list.
1630 @smallexample
1631 gcc -c t.c -wrapper gdb,--args
1632 @end smallexample
1634 @noindent
1635 This invokes all subprograms of @command{gcc} under
1636 @samp{gdb --args}, thus the invocation of @command{cc1} is
1637 @samp{gdb --args cc1 @dots{}}.
1639 @item -fplugin=@var{name}.so
1640 @opindex fplugin
1641 Load the plugin code in file @var{name}.so, assumed to be a
1642 shared object to be dlopen'd by the compiler.  The base name of
1643 the shared object file is used to identify the plugin for the
1644 purposes of argument parsing (See
1645 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1646 Each plugin should define the callback functions specified in the
1647 Plugins API.
1649 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1650 @opindex fplugin-arg
1651 Define an argument called @var{key} with a value of @var{value}
1652 for the plugin called @var{name}.
1654 @item -fdump-ada-spec@r{[}-slim@r{]}
1655 @opindex fdump-ada-spec
1656 For C and C++ source and include files, generate corresponding Ada specs.
1657 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1658 GNAT User's Guide}, which provides detailed documentation on this feature.
1660 @item -fada-spec-parent=@var{unit}
1661 @opindex fada-spec-parent
1662 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1663 Ada specs as child units of parent @var{unit}.
1665 @item -fdump-go-spec=@var{file}
1666 @opindex fdump-go-spec
1667 For input files in any language, generate corresponding Go
1668 declarations in @var{file}.  This generates Go @code{const},
1669 @code{type}, @code{var}, and @code{func} declarations which may be a
1670 useful way to start writing a Go interface to code written in some
1671 other language.
1673 @include @value{srcdir}/../libiberty/at-file.texi
1674 @end table
1676 @node Invoking G++
1677 @section Compiling C++ Programs
1679 @cindex suffixes for C++ source
1680 @cindex C++ source file suffixes
1681 C++ source files conventionally use one of the suffixes @samp{.C},
1682 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1683 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1684 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1685 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1686 files with these names and compiles them as C++ programs even if you
1687 call the compiler the same way as for compiling C programs (usually
1688 with the name @command{gcc}).
1690 @findex g++
1691 @findex c++
1692 However, the use of @command{gcc} does not add the C++ library.
1693 @command{g++} is a program that calls GCC and automatically specifies linking
1694 against the C++ library.  It treats @samp{.c},
1695 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1696 files unless @option{-x} is used.  This program is also useful when
1697 precompiling a C header file with a @samp{.h} extension for use in C++
1698 compilations.  On many systems, @command{g++} is also installed with
1699 the name @command{c++}.
1701 @cindex invoking @command{g++}
1702 When you compile C++ programs, you may specify many of the same
1703 command-line options that you use for compiling programs in any
1704 language; or command-line options meaningful for C and related
1705 languages; or options that are meaningful only for C++ programs.
1706 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1707 explanations of options for languages related to C@.
1708 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1709 explanations of options that are meaningful only for C++ programs.
1711 @node C Dialect Options
1712 @section Options Controlling C Dialect
1713 @cindex dialect options
1714 @cindex language dialect options
1715 @cindex options, dialect
1717 The following options control the dialect of C (or languages derived
1718 from C, such as C++, Objective-C and Objective-C++) that the compiler
1719 accepts:
1721 @table @gcctabopt
1722 @cindex ANSI support
1723 @cindex ISO support
1724 @item -ansi
1725 @opindex ansi
1726 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1727 equivalent to @option{-std=c++98}.
1729 This turns off certain features of GCC that are incompatible with ISO
1730 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1731 such as the @code{asm} and @code{typeof} keywords, and
1732 predefined macros such as @code{unix} and @code{vax} that identify the
1733 type of system you are using.  It also enables the undesirable and
1734 rarely used ISO trigraph feature.  For the C compiler,
1735 it disables recognition of C++ style @samp{//} comments as well as
1736 the @code{inline} keyword.
1738 The alternate keywords @code{__asm__}, @code{__extension__},
1739 @code{__inline__} and @code{__typeof__} continue to work despite
1740 @option{-ansi}.  You would not want to use them in an ISO C program, of
1741 course, but it is useful to put them in header files that might be included
1742 in compilations done with @option{-ansi}.  Alternate predefined macros
1743 such as @code{__unix__} and @code{__vax__} are also available, with or
1744 without @option{-ansi}.
1746 The @option{-ansi} option does not cause non-ISO programs to be
1747 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1748 addition to @option{-ansi}.  @xref{Warning Options}.
1750 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1751 option is used.  Some header files may notice this macro and refrain
1752 from declaring certain functions or defining certain macros that the
1753 ISO standard doesn't call for; this is to avoid interfering with any
1754 programs that might use these names for other things.
1756 Functions that are normally built in but do not have semantics
1757 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1758 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1759 built-in functions provided by GCC}, for details of the functions
1760 affected.
1762 @item -std=
1763 @opindex std
1764 Determine the language standard. @xref{Standards,,Language Standards
1765 Supported by GCC}, for details of these standard versions.  This option
1766 is currently only supported when compiling C or C++.
1768 The compiler can accept several base standards, such as @samp{c90} or
1769 @samp{c++98}, and GNU dialects of those standards, such as
1770 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1771 compiler accepts all programs following that standard plus those
1772 using GNU extensions that do not contradict it.  For example,
1773 @option{-std=c90} turns off certain features of GCC that are
1774 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1775 keywords, but not other GNU extensions that do not have a meaning in
1776 ISO C90, such as omitting the middle term of a @code{?:}
1777 expression. On the other hand, when a GNU dialect of a standard is
1778 specified, all features supported by the compiler are enabled, even when
1779 those features change the meaning of the base standard.  As a result, some
1780 strict-conforming programs may be rejected.  The particular standard
1781 is used by @option{-Wpedantic} to identify which features are GNU
1782 extensions given that version of the standard. For example
1783 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1784 comments, while @option{-std=gnu99 -Wpedantic} does not.
1786 A value for this option must be provided; possible values are
1788 @table @samp
1789 @item c90
1790 @itemx c89
1791 @itemx iso9899:1990
1792 Support all ISO C90 programs (certain GNU extensions that conflict
1793 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1795 @item iso9899:199409
1796 ISO C90 as modified in amendment 1.
1798 @item c99
1799 @itemx c9x
1800 @itemx iso9899:1999
1801 @itemx iso9899:199x
1802 ISO C99.  This standard is substantially completely supported, modulo
1803 bugs and floating-point issues
1804 (mainly but not entirely relating to optional C99 features from
1805 Annexes F and G).  See
1806 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1807 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1809 @item c11
1810 @itemx c1x
1811 @itemx iso9899:2011
1812 ISO C11, the 2011 revision of the ISO C standard.  This standard is
1813 substantially completely supported, modulo bugs, floating-point issues
1814 (mainly but not entirely relating to optional C11 features from
1815 Annexes F and G) and the optional Annexes K (Bounds-checking
1816 interfaces) and L (Analyzability).  The name @samp{c1x} is deprecated.
1818 @item gnu90
1819 @itemx gnu89
1820 GNU dialect of ISO C90 (including some C99 features).
1822 @item gnu99
1823 @itemx gnu9x
1824 GNU dialect of ISO C99.  The name @samp{gnu9x} is deprecated.
1826 @item gnu11
1827 @itemx gnu1x
1828 GNU dialect of ISO C11.  This is the default for C code.
1829 The name @samp{gnu1x} is deprecated.
1831 @item c++98
1832 @itemx c++03
1833 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1834 additional defect reports. Same as @option{-ansi} for C++ code.
1836 @item gnu++98
1837 @itemx gnu++03
1838 GNU dialect of @option{-std=c++98}.
1840 @item c++11
1841 @itemx c++0x
1842 The 2011 ISO C++ standard plus amendments.
1843 The name @samp{c++0x} is deprecated.
1845 @item gnu++11
1846 @itemx gnu++0x
1847 GNU dialect of @option{-std=c++11}.
1848 The name @samp{gnu++0x} is deprecated.
1850 @item c++14
1851 @itemx c++1y
1852 The 2014 ISO C++ standard plus amendments.
1853 The name @samp{c++1y} is deprecated.
1855 @item gnu++14
1856 @itemx gnu++1y
1857 GNU dialect of @option{-std=c++14}.
1858 This is the default for C++ code.
1859 The name @samp{gnu++1y} is deprecated.
1861 @item c++1z
1862 The next revision of the ISO C++ standard, tentatively planned for
1863 2017.  Support is highly experimental, and will almost certainly
1864 change in incompatible ways in future releases.
1866 @item gnu++1z
1867 GNU dialect of @option{-std=c++1z}.  Support is highly experimental,
1868 and will almost certainly change in incompatible ways in future
1869 releases.
1870 @end table
1872 @item -fgnu89-inline
1873 @opindex fgnu89-inline
1874 The option @option{-fgnu89-inline} tells GCC to use the traditional
1875 GNU semantics for @code{inline} functions when in C99 mode.
1876 @xref{Inline,,An Inline Function is As Fast As a Macro}.
1877 Using this option is roughly equivalent to adding the
1878 @code{gnu_inline} function attribute to all inline functions
1879 (@pxref{Function Attributes}).
1881 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1882 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1883 specifies the default behavior).
1884 This option is not supported in @option{-std=c90} or
1885 @option{-std=gnu90} mode.
1887 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1888 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1889 in effect for @code{inline} functions.  @xref{Common Predefined
1890 Macros,,,cpp,The C Preprocessor}.
1892 @item -fpermitted-flt-eval-methods=@var{style}
1893 @opindex fpermitted-flt-eval-methods
1894 @opindex fpermitted-flt-eval-methods=c11
1895 @opindex fpermitted-flt-eval-methods=ts-18661-3
1896 ISO/IEC TS 18661-3 defines new permissible values for
1897 @code{FLT_EVAL_METHOD} that indicate that operations and constants with
1898 a semantic type that is an interchange or extended format should be
1899 evaluated to the precision and range of that type.  These new values are
1900 a superset of those permitted under C99/C11, which does not specify the
1901 meaning of other positive values of @code{FLT_EVAL_METHOD}.  As such, code
1902 conforming to C11 may not have been written expecting the possibility of
1903 the new values.
1905 @option{-fpermitted-flt-eval-methods} specifies whether the compiler
1906 should allow only the values of @code{FLT_EVAL_METHOD} specified in C99/C11,
1907 or the extended set of values specified in ISO/IEC TS 18661-3.
1909 @var{style} is either @code{c11} or @code{ts-18661-3} as appropriate.
1911 The default when in a standards compliant mode (@option{-std=c11} or similar)
1912 is @option{-fpermitted-flt-eval-methods=c11}.  The default when in a GNU
1913 dialect (@option{-std=gnu11} or similar) is
1914 @option{-fpermitted-flt-eval-methods=ts-18661-3}.
1916 @item -aux-info @var{filename}
1917 @opindex aux-info
1918 Output to the given filename prototyped declarations for all functions
1919 declared and/or defined in a translation unit, including those in header
1920 files.  This option is silently ignored in any language other than C@.
1922 Besides declarations, the file indicates, in comments, the origin of
1923 each declaration (source file and line), whether the declaration was
1924 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1925 @samp{O} for old, respectively, in the first character after the line
1926 number and the colon), and whether it came from a declaration or a
1927 definition (@samp{C} or @samp{F}, respectively, in the following
1928 character).  In the case of function definitions, a K&R-style list of
1929 arguments followed by their declarations is also provided, inside
1930 comments, after the declaration.
1932 @item -fallow-parameterless-variadic-functions
1933 @opindex fallow-parameterless-variadic-functions
1934 Accept variadic functions without named parameters.
1936 Although it is possible to define such a function, this is not very
1937 useful as it is not possible to read the arguments.  This is only
1938 supported for C as this construct is allowed by C++.
1940 @item -fno-asm
1941 @opindex fno-asm
1942 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1943 keyword, so that code can use these words as identifiers.  You can use
1944 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1945 instead.  @option{-ansi} implies @option{-fno-asm}.
1947 In C++, this switch only affects the @code{typeof} keyword, since
1948 @code{asm} and @code{inline} are standard keywords.  You may want to
1949 use the @option{-fno-gnu-keywords} flag instead, which has the same
1950 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1951 switch only affects the @code{asm} and @code{typeof} keywords, since
1952 @code{inline} is a standard keyword in ISO C99.
1954 @item -fno-builtin
1955 @itemx -fno-builtin-@var{function}
1956 @opindex fno-builtin
1957 @cindex built-in functions
1958 Don't recognize built-in functions that do not begin with
1959 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1960 functions provided by GCC}, for details of the functions affected,
1961 including those which are not built-in functions when @option{-ansi} or
1962 @option{-std} options for strict ISO C conformance are used because they
1963 do not have an ISO standard meaning.
1965 GCC normally generates special code to handle certain built-in functions
1966 more efficiently; for instance, calls to @code{alloca} may become single
1967 instructions which adjust the stack directly, and calls to @code{memcpy}
1968 may become inline copy loops.  The resulting code is often both smaller
1969 and faster, but since the function calls no longer appear as such, you
1970 cannot set a breakpoint on those calls, nor can you change the behavior
1971 of the functions by linking with a different library.  In addition,
1972 when a function is recognized as a built-in function, GCC may use
1973 information about that function to warn about problems with calls to
1974 that function, or to generate more efficient code, even if the
1975 resulting code still contains calls to that function.  For example,
1976 warnings are given with @option{-Wformat} for bad calls to
1977 @code{printf} when @code{printf} is built in and @code{strlen} is
1978 known not to modify global memory.
1980 With the @option{-fno-builtin-@var{function}} option
1981 only the built-in function @var{function} is
1982 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1983 function is named that is not built-in in this version of GCC, this
1984 option is ignored.  There is no corresponding
1985 @option{-fbuiltin-@var{function}} option; if you wish to enable
1986 built-in functions selectively when using @option{-fno-builtin} or
1987 @option{-ffreestanding}, you may define macros such as:
1989 @smallexample
1990 #define abs(n)          __builtin_abs ((n))
1991 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1992 @end smallexample
1994 @item -fgimple
1995 @opindex fgimple
1997 Enable parsing of function definitions marked with @code{__GIMPLE}.
1998 This is an experimental feature that allows unit testing of GIMPLE
1999 passes.
2001 @item -fhosted
2002 @opindex fhosted
2003 @cindex hosted environment
2005 Assert that compilation targets a hosted environment.  This implies
2006 @option{-fbuiltin}.  A hosted environment is one in which the
2007 entire standard library is available, and in which @code{main} has a return
2008 type of @code{int}.  Examples are nearly everything except a kernel.
2009 This is equivalent to @option{-fno-freestanding}.
2011 @item -ffreestanding
2012 @opindex ffreestanding
2013 @cindex hosted environment
2015 Assert that compilation targets a freestanding environment.  This
2016 implies @option{-fno-builtin}.  A freestanding environment
2017 is one in which the standard library may not exist, and program startup may
2018 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
2019 This is equivalent to @option{-fno-hosted}.
2021 @xref{Standards,,Language Standards Supported by GCC}, for details of
2022 freestanding and hosted environments.
2024 @item -fopenacc
2025 @opindex fopenacc
2026 @cindex OpenACC accelerator programming
2027 Enable handling of OpenACC directives @code{#pragma acc} in C/C++ and
2028 @code{!$acc} in Fortran.  When @option{-fopenacc} is specified, the
2029 compiler generates accelerated code according to the OpenACC Application
2030 Programming Interface v2.0 @w{@uref{http://www.openacc.org/}}.  This option
2031 implies @option{-pthread}, and thus is only supported on targets that
2032 have support for @option{-pthread}.
2034 @item -fopenacc-dim=@var{geom}
2035 @opindex fopenacc-dim
2036 @cindex OpenACC accelerator programming
2037 Specify default compute dimensions for parallel offload regions that do
2038 not explicitly specify.  The @var{geom} value is a triple of
2039 ':'-separated sizes, in order 'gang', 'worker' and, 'vector'.  A size
2040 can be omitted, to use a target-specific default value.
2042 @item -fopenmp
2043 @opindex fopenmp
2044 @cindex OpenMP parallel
2045 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
2046 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
2047 compiler generates parallel code according to the OpenMP Application
2048 Program Interface v4.5 @w{@uref{http://www.openmp.org/}}.  This option
2049 implies @option{-pthread}, and thus is only supported on targets that
2050 have support for @option{-pthread}. @option{-fopenmp} implies
2051 @option{-fopenmp-simd}.
2053 @item -fopenmp-simd
2054 @opindex fopenmp-simd
2055 @cindex OpenMP SIMD
2056 @cindex SIMD
2057 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
2058 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
2059 are ignored.
2061 @item -fcilkplus
2062 @opindex fcilkplus
2063 @cindex Enable Cilk Plus
2064 Enable the usage of Cilk Plus language extension features for C/C++.
2065 When the option @option{-fcilkplus} is specified, enable the usage of
2066 the Cilk Plus Language extension features for C/C++.  The present
2067 implementation follows ABI version 1.2.  This is an experimental
2068 feature that is only partially complete, and whose interface may
2069 change in future versions of GCC as the official specification
2070 changes.  Currently, all features but @code{_Cilk_for} have been
2071 implemented.
2073 @item -fgnu-tm
2074 @opindex fgnu-tm
2075 When the option @option{-fgnu-tm} is specified, the compiler
2076 generates code for the Linux variant of Intel's current Transactional
2077 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
2078 an experimental feature whose interface may change in future versions
2079 of GCC, as the official specification changes.  Please note that not
2080 all architectures are supported for this feature.
2082 For more information on GCC's support for transactional memory,
2083 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
2084 Transactional Memory Library}.
2086 Note that the transactional memory feature is not supported with
2087 non-call exceptions (@option{-fnon-call-exceptions}).
2089 @item -fms-extensions
2090 @opindex fms-extensions
2091 Accept some non-standard constructs used in Microsoft header files.
2093 In C++ code, this allows member names in structures to be similar
2094 to previous types declarations.
2096 @smallexample
2097 typedef int UOW;
2098 struct ABC @{
2099   UOW UOW;
2101 @end smallexample
2103 Some cases of unnamed fields in structures and unions are only
2104 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
2105 fields within structs/unions}, for details.
2107 Note that this option is off for all targets but x86 
2108 targets using ms-abi.
2110 @item -fplan9-extensions
2111 @opindex fplan9-extensions
2112 Accept some non-standard constructs used in Plan 9 code.
2114 This enables @option{-fms-extensions}, permits passing pointers to
2115 structures with anonymous fields to functions that expect pointers to
2116 elements of the type of the field, and permits referring to anonymous
2117 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
2118 struct/union fields within structs/unions}, for details.  This is only
2119 supported for C, not C++.
2121 @item -fcond-mismatch
2122 @opindex fcond-mismatch
2123 Allow conditional expressions with mismatched types in the second and
2124 third arguments.  The value of such an expression is void.  This option
2125 is not supported for C++.
2127 @item -flax-vector-conversions
2128 @opindex flax-vector-conversions
2129 Allow implicit conversions between vectors with differing numbers of
2130 elements and/or incompatible element types.  This option should not be
2131 used for new code.
2133 @item -funsigned-char
2134 @opindex funsigned-char
2135 Let the type @code{char} be unsigned, like @code{unsigned char}.
2137 Each kind of machine has a default for what @code{char} should
2138 be.  It is either like @code{unsigned char} by default or like
2139 @code{signed char} by default.
2141 Ideally, a portable program should always use @code{signed char} or
2142 @code{unsigned char} when it depends on the signedness of an object.
2143 But many programs have been written to use plain @code{char} and
2144 expect it to be signed, or expect it to be unsigned, depending on the
2145 machines they were written for.  This option, and its inverse, let you
2146 make such a program work with the opposite default.
2148 The type @code{char} is always a distinct type from each of
2149 @code{signed char} or @code{unsigned char}, even though its behavior
2150 is always just like one of those two.
2152 @item -fsigned-char
2153 @opindex fsigned-char
2154 Let the type @code{char} be signed, like @code{signed char}.
2156 Note that this is equivalent to @option{-fno-unsigned-char}, which is
2157 the negative form of @option{-funsigned-char}.  Likewise, the option
2158 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
2160 @item -fsigned-bitfields
2161 @itemx -funsigned-bitfields
2162 @itemx -fno-signed-bitfields
2163 @itemx -fno-unsigned-bitfields
2164 @opindex fsigned-bitfields
2165 @opindex funsigned-bitfields
2166 @opindex fno-signed-bitfields
2167 @opindex fno-unsigned-bitfields
2168 These options control whether a bit-field is signed or unsigned, when the
2169 declaration does not use either @code{signed} or @code{unsigned}.  By
2170 default, such a bit-field is signed, because this is consistent: the
2171 basic integer types such as @code{int} are signed types.
2173 @item -fsso-struct=@var{endianness}
2174 @opindex fsso-struct
2175 Set the default scalar storage order of structures and unions to the
2176 specified endianness.  The accepted values are @samp{big-endian},
2177 @samp{little-endian} and @samp{native} for the native endianness of
2178 the target (the default).  This option is not supported for C++.
2180 @strong{Warning:} the @option{-fsso-struct} switch causes GCC to generate
2181 code that is not binary compatible with code generated without it if the
2182 specified endianness is not the native endianness of the target.
2183 @end table
2185 @node C++ Dialect Options
2186 @section Options Controlling C++ Dialect
2188 @cindex compiler options, C++
2189 @cindex C++ options, command-line
2190 @cindex options, C++
2191 This section describes the command-line options that are only meaningful
2192 for C++ programs.  You can also use most of the GNU compiler options
2193 regardless of what language your program is in.  For example, you
2194 might compile a file @file{firstClass.C} like this:
2196 @smallexample
2197 g++ -g -fstrict-enums -O -c firstClass.C
2198 @end smallexample
2200 @noindent
2201 In this example, only @option{-fstrict-enums} is an option meant
2202 only for C++ programs; you can use the other options with any
2203 language supported by GCC@.
2205 Some options for compiling C programs, such as @option{-std}, are also
2206 relevant for C++ programs.
2207 @xref{C Dialect Options,,Options Controlling C Dialect}.
2209 Here is a list of options that are @emph{only} for compiling C++ programs:
2211 @table @gcctabopt
2213 @item -fabi-version=@var{n}
2214 @opindex fabi-version
2215 Use version @var{n} of the C++ ABI@.  The default is version 0.
2217 Version 0 refers to the version conforming most closely to
2218 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2219 will change in different versions of G++ as ABI bugs are fixed.
2221 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.
2223 Version 2 is the version of the C++ ABI that first appeared in G++
2224 3.4, and was the default through G++ 4.9.
2226 Version 3 corrects an error in mangling a constant address as a
2227 template argument.
2229 Version 4, which first appeared in G++ 4.5, implements a standard
2230 mangling for vector types.
2232 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2233 attribute const/volatile on function pointer types, decltype of a
2234 plain decl, and use of a function parameter in the declaration of
2235 another parameter.
2237 Version 6, which first appeared in G++ 4.7, corrects the promotion
2238 behavior of C++11 scoped enums and the mangling of template argument
2239 packs, const/static_cast, prefix ++ and --, and a class scope function
2240 used as a template argument.
2242 Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a
2243 builtin type and corrects the mangling of lambdas in default argument
2244 scope.
2246 Version 8, which first appeared in G++ 4.9, corrects the substitution
2247 behavior of function types with function-cv-qualifiers.
2249 Version 9, which first appeared in G++ 5.2, corrects the alignment of
2250 @code{nullptr_t}.
2252 Version 10, which first appeared in G++ 6.1, adds mangling of
2253 attributes that affect type identity, such as ia32 calling convention
2254 attributes (e.g. @samp{stdcall}).
2256 Version 11, which first appeared in G++ 7, corrects the mangling of
2257 sizeof... expressions and operator names.  For multiple entities with
2258 the same name within a function, that are declared in different scopes,
2259 the mangling now changes starting with the twelfth occurrence.  It also
2260 implies @option{-fnew-inheriting-ctors}.
2262 See also @option{-Wabi}.
2264 @item -fabi-compat-version=@var{n}
2265 @opindex fabi-compat-version
2266 On targets that support strong aliases, G++
2267 works around mangling changes by creating an alias with the correct
2268 mangled name when defining a symbol with an incorrect mangled name.
2269 This switch specifies which ABI version to use for the alias.
2271 With @option{-fabi-version=0} (the default), this defaults to 8 (GCC 5
2272 compatibility).  If another ABI version is explicitly selected, this
2273 defaults to 0.  For compatibility with GCC versions 3.2 through 4.9,
2274 use @option{-fabi-compat-version=2}.
2276 If this option is not provided but @option{-Wabi=@var{n}} is, that
2277 version is used for compatibility aliases.  If this option is provided
2278 along with @option{-Wabi} (without the version), the version from this
2279 option is used for the warning.
2281 @item -fno-access-control
2282 @opindex fno-access-control
2283 Turn off all access checking.  This switch is mainly useful for working
2284 around bugs in the access control code.
2286 @item -faligned-new
2287 @opindex faligned-new
2288 Enable support for C++17 @code{new} of types that require more
2289 alignment than @code{void* ::operator new(std::size_t)} provides.  A
2290 numeric argument such as @code{-faligned-new=32} can be used to
2291 specify how much alignment (in bytes) is provided by that function,
2292 but few users will need to override the default of
2293 @code{alignof(std::max_align_t)}.
2295 @item -fcheck-new
2296 @opindex fcheck-new
2297 Check that the pointer returned by @code{operator new} is non-null
2298 before attempting to modify the storage allocated.  This check is
2299 normally unnecessary because the C++ standard specifies that
2300 @code{operator new} only returns @code{0} if it is declared
2301 @code{throw()}, in which case the compiler always checks the
2302 return value even without this option.  In all other cases, when
2303 @code{operator new} has a non-empty exception specification, memory
2304 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2305 @samp{new (nothrow)}.
2307 @item -fconcepts
2308 @opindex fconcepts
2309 Enable support for the C++ Extensions for Concepts Technical
2310 Specification, ISO 19217 (2015), which allows code like
2312 @smallexample
2313 template <class T> concept bool Addable = requires (T t) @{ t + t; @};
2314 template <Addable T> T add (T a, T b) @{ return a + b; @}
2315 @end smallexample
2317 @item -fconstexpr-depth=@var{n}
2318 @opindex fconstexpr-depth
2319 Set the maximum nested evaluation depth for C++11 constexpr functions
2320 to @var{n}.  A limit is needed to detect endless recursion during
2321 constant expression evaluation.  The minimum specified by the standard
2322 is 512.
2324 @item -fconstexpr-loop-limit=@var{n}
2325 @opindex fconstexpr-loop-limit
2326 Set the maximum number of iterations for a loop in C++14 constexpr functions
2327 to @var{n}.  A limit is needed to detect infinite loops during
2328 constant expression evaluation.  The default is 262144 (1<<18).
2330 @item -fdeduce-init-list
2331 @opindex fdeduce-init-list
2332 Enable deduction of a template type parameter as
2333 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2335 @smallexample
2336 template <class T> auto forward(T t) -> decltype (realfn (t))
2338   return realfn (t);
2341 void f()
2343   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2345 @end smallexample
2347 This deduction was implemented as a possible extension to the
2348 originally proposed semantics for the C++11 standard, but was not part
2349 of the final standard, so it is disabled by default.  This option is
2350 deprecated, and may be removed in a future version of G++.
2352 @item -ffriend-injection
2353 @opindex ffriend-injection
2354 Inject friend functions into the enclosing namespace, so that they are
2355 visible outside the scope of the class in which they are declared.
2356 Friend functions were documented to work this way in the old Annotated
2357 C++ Reference Manual.  
2358 However, in ISO C++ a friend function that is not declared
2359 in an enclosing scope can only be found using argument dependent
2360 lookup.  GCC defaults to the standard behavior.
2362 This option is for compatibility, and may be removed in a future
2363 release of G++.
2365 @item -fno-elide-constructors
2366 @opindex fno-elide-constructors
2367 The C++ standard allows an implementation to omit creating a temporary
2368 that is only used to initialize another object of the same type.
2369 Specifying this option disables that optimization, and forces G++ to
2370 call the copy constructor in all cases.  This option also causes G++
2371 to call trivial member functions which otherwise would be expanded inline.
2373 In C++17, the compiler is required to omit these temporaries, but this
2374 option still affects trivial member functions.
2376 @item -fno-enforce-eh-specs
2377 @opindex fno-enforce-eh-specs
2378 Don't generate code to check for violation of exception specifications
2379 at run time.  This option violates the C++ standard, but may be useful
2380 for reducing code size in production builds, much like defining
2381 @code{NDEBUG}.  This does not give user code permission to throw
2382 exceptions in violation of the exception specifications; the compiler
2383 still optimizes based on the specifications, so throwing an
2384 unexpected exception results in undefined behavior at run time.
2386 @item -fextern-tls-init
2387 @itemx -fno-extern-tls-init
2388 @opindex fextern-tls-init
2389 @opindex fno-extern-tls-init
2390 The C++11 and OpenMP standards allow @code{thread_local} and
2391 @code{threadprivate} variables to have dynamic (runtime)
2392 initialization.  To support this, any use of such a variable goes
2393 through a wrapper function that performs any necessary initialization.
2394 When the use and definition of the variable are in the same
2395 translation unit, this overhead can be optimized away, but when the
2396 use is in a different translation unit there is significant overhead
2397 even if the variable doesn't actually need dynamic initialization.  If
2398 the programmer can be sure that no use of the variable in a
2399 non-defining TU needs to trigger dynamic initialization (either
2400 because the variable is statically initialized, or a use of the
2401 variable in the defining TU will be executed before any uses in
2402 another TU), they can avoid this overhead with the
2403 @option{-fno-extern-tls-init} option.
2405 On targets that support symbol aliases, the default is
2406 @option{-fextern-tls-init}.  On targets that do not support symbol
2407 aliases, the default is @option{-fno-extern-tls-init}.
2409 @item -ffor-scope
2410 @itemx -fno-for-scope
2411 @opindex ffor-scope
2412 @opindex fno-for-scope
2413 If @option{-ffor-scope} is specified, the scope of variables declared in
2414 a @i{for-init-statement} is limited to the @code{for} loop itself,
2415 as specified by the C++ standard.
2416 If @option{-fno-for-scope} is specified, the scope of variables declared in
2417 a @i{for-init-statement} extends to the end of the enclosing scope,
2418 as was the case in old versions of G++, and other (traditional)
2419 implementations of C++.
2421 If neither flag is given, the default is to follow the standard,
2422 but to allow and give a warning for old-style code that would
2423 otherwise be invalid, or have different behavior.
2425 @item -fno-gnu-keywords
2426 @opindex fno-gnu-keywords
2427 Do not recognize @code{typeof} as a keyword, so that code can use this
2428 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2429 This option is implied by the strict ISO C++ dialects: @option{-ansi},
2430 @option{-std=c++98}, @option{-std=c++11}, etc.
2432 @item -fno-implicit-templates
2433 @opindex fno-implicit-templates
2434 Never emit code for non-inline templates that are instantiated
2435 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2436 @xref{Template Instantiation}, for more information.
2438 @item -fno-implicit-inline-templates
2439 @opindex fno-implicit-inline-templates
2440 Don't emit code for implicit instantiations of inline templates, either.
2441 The default is to handle inlines differently so that compiles with and
2442 without optimization need the same set of explicit instantiations.
2444 @item -fno-implement-inlines
2445 @opindex fno-implement-inlines
2446 To save space, do not emit out-of-line copies of inline functions
2447 controlled by @code{#pragma implementation}.  This causes linker
2448 errors if these functions are not inlined everywhere they are called.
2450 @item -fms-extensions
2451 @opindex fms-extensions
2452 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2453 int and getting a pointer to member function via non-standard syntax.
2455 @item -fnew-inheriting-ctors
2456 @opindex fnew-inheriting-ctors
2457 Enable the P0136 adjustment to the semantics of C++11 constructor
2458 inheritance.  This is part of C++17 but also considered to be a Defect
2459 Report against C++11 and C++14.  This flag is enabled by default
2460 unless @option{-fabi-version=10} or lower is specified.
2462 @item -fnew-ttp-matching
2463 @opindex fnew-ttp-matching
2464 Enable the P0522 resolution to Core issue 150, template template
2465 parameters and default arguments: this allows a template with default
2466 template arguments as an argument for a template template parameter
2467 with fewer template parameters.  This flag is enabled by default for
2468 @option{-std=c++1z}.
2470 @item -fno-nonansi-builtins
2471 @opindex fno-nonansi-builtins
2472 Disable built-in declarations of functions that are not mandated by
2473 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2474 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2476 @item -fnothrow-opt
2477 @opindex fnothrow-opt
2478 Treat a @code{throw()} exception specification as if it were a
2479 @code{noexcept} specification to reduce or eliminate the text size
2480 overhead relative to a function with no exception specification.  If
2481 the function has local variables of types with non-trivial
2482 destructors, the exception specification actually makes the
2483 function smaller because the EH cleanups for those variables can be
2484 optimized away.  The semantic effect is that an exception thrown out of
2485 a function with such an exception specification results in a call
2486 to @code{terminate} rather than @code{unexpected}.
2488 @item -fno-operator-names
2489 @opindex fno-operator-names
2490 Do not treat the operator name keywords @code{and}, @code{bitand},
2491 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2492 synonyms as keywords.
2494 @item -fno-optional-diags
2495 @opindex fno-optional-diags
2496 Disable diagnostics that the standard says a compiler does not need to
2497 issue.  Currently, the only such diagnostic issued by G++ is the one for
2498 a name having multiple meanings within a class.
2500 @item -fpermissive
2501 @opindex fpermissive
2502 Downgrade some diagnostics about nonconformant code from errors to
2503 warnings.  Thus, using @option{-fpermissive} allows some
2504 nonconforming code to compile.
2506 @item -fno-pretty-templates
2507 @opindex fno-pretty-templates
2508 When an error message refers to a specialization of a function
2509 template, the compiler normally prints the signature of the
2510 template followed by the template arguments and any typedefs or
2511 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2512 rather than @code{void f(int)}) so that it's clear which template is
2513 involved.  When an error message refers to a specialization of a class
2514 template, the compiler omits any template arguments that match
2515 the default template arguments for that template.  If either of these
2516 behaviors make it harder to understand the error message rather than
2517 easier, you can use @option{-fno-pretty-templates} to disable them.
2519 @item -frepo
2520 @opindex frepo
2521 Enable automatic template instantiation at link time.  This option also
2522 implies @option{-fno-implicit-templates}.  @xref{Template
2523 Instantiation}, for more information.
2525 @item -fno-rtti
2526 @opindex fno-rtti
2527 Disable generation of information about every class with virtual
2528 functions for use by the C++ run-time type identification features
2529 (@code{dynamic_cast} and @code{typeid}).  If you don't use those parts
2530 of the language, you can save some space by using this flag.  Note that
2531 exception handling uses the same information, but G++ generates it as
2532 needed. The @code{dynamic_cast} operator can still be used for casts that
2533 do not require run-time type information, i.e.@: casts to @code{void *} or to
2534 unambiguous base classes.
2536 @item -fsized-deallocation
2537 @opindex fsized-deallocation
2538 Enable the built-in global declarations
2539 @smallexample
2540 void operator delete (void *, std::size_t) noexcept;
2541 void operator delete[] (void *, std::size_t) noexcept;
2542 @end smallexample
2543 as introduced in C++14.  This is useful for user-defined replacement
2544 deallocation functions that, for example, use the size of the object
2545 to make deallocation faster.  Enabled by default under
2546 @option{-std=c++14} and above.  The flag @option{-Wsized-deallocation}
2547 warns about places that might want to add a definition.
2549 @item -fstrict-enums
2550 @opindex fstrict-enums
2551 Allow the compiler to optimize using the assumption that a value of
2552 enumerated type can only be one of the values of the enumeration (as
2553 defined in the C++ standard; basically, a value that can be
2554 represented in the minimum number of bits needed to represent all the
2555 enumerators).  This assumption may not be valid if the program uses a
2556 cast to convert an arbitrary integer value to the enumerated type.
2558 @item -fstrong-eval-order
2559 @opindex fstrong-eval-order
2560 Evaluate member access, array subscripting, and shift expressions in
2561 left-to-right order, and evaluate assignment in right-to-left order,
2562 as adopted for C++17.  Enabled by default with @option{-std=c++1z}.
2563 @option{-fstrong-eval-order=some} enables just the ordering of member
2564 access and shift expressions, and is the default without
2565 @option{-std=c++1z}.
2567 @item -ftemplate-backtrace-limit=@var{n}
2568 @opindex ftemplate-backtrace-limit
2569 Set the maximum number of template instantiation notes for a single
2570 warning or error to @var{n}.  The default value is 10.
2572 @item -ftemplate-depth=@var{n}
2573 @opindex ftemplate-depth
2574 Set the maximum instantiation depth for template classes to @var{n}.
2575 A limit on the template instantiation depth is needed to detect
2576 endless recursions during template class instantiation.  ANSI/ISO C++
2577 conforming programs must not rely on a maximum depth greater than 17
2578 (changed to 1024 in C++11).  The default value is 900, as the compiler
2579 can run out of stack space before hitting 1024 in some situations.
2581 @item -fno-threadsafe-statics
2582 @opindex fno-threadsafe-statics
2583 Do not emit the extra code to use the routines specified in the C++
2584 ABI for thread-safe initialization of local statics.  You can use this
2585 option to reduce code size slightly in code that doesn't need to be
2586 thread-safe.
2588 @item -fuse-cxa-atexit
2589 @opindex fuse-cxa-atexit
2590 Register destructors for objects with static storage duration with the
2591 @code{__cxa_atexit} function rather than the @code{atexit} function.
2592 This option is required for fully standards-compliant handling of static
2593 destructors, but only works if your C library supports
2594 @code{__cxa_atexit}.
2596 @item -fno-use-cxa-get-exception-ptr
2597 @opindex fno-use-cxa-get-exception-ptr
2598 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2599 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2600 if the runtime routine is not available.
2602 @item -fvisibility-inlines-hidden
2603 @opindex fvisibility-inlines-hidden
2604 This switch declares that the user does not attempt to compare
2605 pointers to inline functions or methods where the addresses of the two functions
2606 are taken in different shared objects.
2608 The effect of this is that GCC may, effectively, mark inline methods with
2609 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2610 appear in the export table of a DSO and do not require a PLT indirection
2611 when used within the DSO@.  Enabling this option can have a dramatic effect
2612 on load and link times of a DSO as it massively reduces the size of the
2613 dynamic export table when the library makes heavy use of templates.
2615 The behavior of this switch is not quite the same as marking the
2616 methods as hidden directly, because it does not affect static variables
2617 local to the function or cause the compiler to deduce that
2618 the function is defined in only one shared object.
2620 You may mark a method as having a visibility explicitly to negate the
2621 effect of the switch for that method.  For example, if you do want to
2622 compare pointers to a particular inline method, you might mark it as
2623 having default visibility.  Marking the enclosing class with explicit
2624 visibility has no effect.
2626 Explicitly instantiated inline methods are unaffected by this option
2627 as their linkage might otherwise cross a shared library boundary.
2628 @xref{Template Instantiation}.
2630 @item -fvisibility-ms-compat
2631 @opindex fvisibility-ms-compat
2632 This flag attempts to use visibility settings to make GCC's C++
2633 linkage model compatible with that of Microsoft Visual Studio.
2635 The flag makes these changes to GCC's linkage model:
2637 @enumerate
2638 @item
2639 It sets the default visibility to @code{hidden}, like
2640 @option{-fvisibility=hidden}.
2642 @item
2643 Types, but not their members, are not hidden by default.
2645 @item
2646 The One Definition Rule is relaxed for types without explicit
2647 visibility specifications that are defined in more than one
2648 shared object: those declarations are permitted if they are
2649 permitted when this option is not used.
2650 @end enumerate
2652 In new code it is better to use @option{-fvisibility=hidden} and
2653 export those classes that are intended to be externally visible.
2654 Unfortunately it is possible for code to rely, perhaps accidentally,
2655 on the Visual Studio behavior.
2657 Among the consequences of these changes are that static data members
2658 of the same type with the same name but defined in different shared
2659 objects are different, so changing one does not change the other;
2660 and that pointers to function members defined in different shared
2661 objects may not compare equal.  When this flag is given, it is a
2662 violation of the ODR to define types with the same name differently.
2664 @item -fno-weak
2665 @opindex fno-weak
2666 Do not use weak symbol support, even if it is provided by the linker.
2667 By default, G++ uses weak symbols if they are available.  This
2668 option exists only for testing, and should not be used by end-users;
2669 it results in inferior code and has no benefits.  This option may
2670 be removed in a future release of G++.
2672 @item -nostdinc++
2673 @opindex nostdinc++
2674 Do not search for header files in the standard directories specific to
2675 C++, but do still search the other standard directories.  (This option
2676 is used when building the C++ library.)
2677 @end table
2679 In addition, these optimization, warning, and code generation options
2680 have meanings only for C++ programs:
2682 @table @gcctabopt
2683 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2684 @opindex Wabi
2685 @opindex Wno-abi
2686 Warn when G++ it generates code that is probably not compatible with
2687 the vendor-neutral C++ ABI@.  Since G++ now defaults to updating the
2688 ABI with each major release, normally @option{-Wabi} will warn only if
2689 there is a check added later in a release series for an ABI issue
2690 discovered since the initial release.  @option{-Wabi} will warn about
2691 more things if an older ABI version is selected (with
2692 @option{-fabi-version=@var{n}}).
2694 @option{-Wabi} can also be used with an explicit version number to
2695 warn about compatibility with a particular @option{-fabi-version}
2696 level, e.g. @option{-Wabi=2} to warn about changes relative to
2697 @option{-fabi-version=2}.
2699 If an explicit version number is provided and
2700 @option{-fabi-compat-version} is not specified, the version number
2701 from this option is used for compatibility aliases.  If no explicit
2702 version number is provided with this option, but
2703 @option{-fabi-compat-version} is specified, that version number is
2704 used for ABI warnings.
2706 Although an effort has been made to warn about
2707 all such cases, there are probably some cases that are not warned about,
2708 even though G++ is generating incompatible code.  There may also be
2709 cases where warnings are emitted even though the code that is generated
2710 is compatible.
2712 You should rewrite your code to avoid these warnings if you are
2713 concerned about the fact that code generated by G++ may not be binary
2714 compatible with code generated by other compilers.
2716 Known incompatibilities in @option{-fabi-version=2} (which was the
2717 default from GCC 3.4 to 4.9) include:
2719 @itemize @bullet
2721 @item
2722 A template with a non-type template parameter of reference type was
2723 mangled incorrectly:
2724 @smallexample
2725 extern int N;
2726 template <int &> struct S @{@};
2727 void n (S<N>) @{2@}
2728 @end smallexample
2730 This was fixed in @option{-fabi-version=3}.
2732 @item
2733 SIMD vector types declared using @code{__attribute ((vector_size))} were
2734 mangled in a non-standard way that does not allow for overloading of
2735 functions taking vectors of different sizes.
2737 The mangling was changed in @option{-fabi-version=4}.
2739 @item
2740 @code{__attribute ((const))} and @code{noreturn} were mangled as type
2741 qualifiers, and @code{decltype} of a plain declaration was folded away.
2743 These mangling issues were fixed in @option{-fabi-version=5}.
2745 @item
2746 Scoped enumerators passed as arguments to a variadic function are
2747 promoted like unscoped enumerators, causing @code{va_arg} to complain.
2748 On most targets this does not actually affect the parameter passing
2749 ABI, as there is no way to pass an argument smaller than @code{int}.
2751 Also, the ABI changed the mangling of template argument packs,
2752 @code{const_cast}, @code{static_cast}, prefix increment/decrement, and
2753 a class scope function used as a template argument.
2755 These issues were corrected in @option{-fabi-version=6}.
2757 @item
2758 Lambdas in default argument scope were mangled incorrectly, and the
2759 ABI changed the mangling of @code{nullptr_t}.
2761 These issues were corrected in @option{-fabi-version=7}.
2763 @item
2764 When mangling a function type with function-cv-qualifiers, the
2765 un-qualified function type was incorrectly treated as a substitution
2766 candidate.
2768 This was fixed in @option{-fabi-version=8}, the default for GCC 5.1.
2770 @item
2771 @code{decltype(nullptr)} incorrectly had an alignment of 1, leading to
2772 unaligned accesses.  Note that this did not affect the ABI of a
2773 function with a @code{nullptr_t} parameter, as parameters have a
2774 minimum alignment.
2776 This was fixed in @option{-fabi-version=9}, the default for GCC 5.2.
2778 @item
2779 Target-specific attributes that affect the identity of a type, such as
2780 ia32 calling conventions on a function type (stdcall, regparm, etc.),
2781 did not affect the mangled name, leading to name collisions when
2782 function pointers were used as template arguments.
2784 This was fixed in @option{-fabi-version=10}, the default for GCC 6.1.
2786 @end itemize
2788 It also warns about psABI-related changes.  The known psABI changes at this
2789 point include:
2791 @itemize @bullet
2793 @item
2794 For SysV/x86-64, unions with @code{long double} members are 
2795 passed in memory as specified in psABI.  For example:
2797 @smallexample
2798 union U @{
2799   long double ld;
2800   int i;
2802 @end smallexample
2804 @noindent
2805 @code{union U} is always passed in memory.
2807 @end itemize
2809 @item -Wabi-tag @r{(C++ and Objective-C++ only)}
2810 @opindex Wabi-tag
2811 @opindex -Wabi-tag
2812 Warn when a type with an ABI tag is used in a context that does not
2813 have that ABI tag.  See @ref{C++ Attributes} for more information
2814 about ABI tags.
2816 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2817 @opindex Wctor-dtor-privacy
2818 @opindex Wno-ctor-dtor-privacy
2819 Warn when a class seems unusable because all the constructors or
2820 destructors in that class are private, and it has neither friends nor
2821 public static member functions.  Also warn if there are no non-private
2822 methods, and there's at least one private member function that isn't
2823 a constructor or destructor.
2825 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2826 @opindex Wdelete-non-virtual-dtor
2827 @opindex Wno-delete-non-virtual-dtor
2828 Warn when @code{delete} is used to destroy an instance of a class that
2829 has virtual functions and non-virtual destructor. It is unsafe to delete
2830 an instance of a derived class through a pointer to a base class if the
2831 base class does not have a virtual destructor.  This warning is enabled
2832 by @option{-Wall}.
2834 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2835 @opindex Wliteral-suffix
2836 @opindex Wno-literal-suffix
2837 Warn when a string or character literal is followed by a ud-suffix which does
2838 not begin with an underscore.  As a conforming extension, GCC treats such
2839 suffixes as separate preprocessing tokens in order to maintain backwards
2840 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2841 For example:
2843 @smallexample
2844 #define __STDC_FORMAT_MACROS
2845 #include <inttypes.h>
2846 #include <stdio.h>
2848 int main() @{
2849   int64_t i64 = 123;
2850   printf("My int64: %" PRId64"\n", i64);
2852 @end smallexample
2854 In this case, @code{PRId64} is treated as a separate preprocessing token.
2856 Additionally, warn when a user-defined literal operator is declared with
2857 a literal suffix identifier that doesn't begin with an underscore. Literal
2858 suffix identifiers that don't begin with an underscore are reserved for
2859 future standardization.
2861 This warning is enabled by default.
2863 @item -Wlto-type-mismatch
2864 @opindex Wlto-type-mismatch
2865 @opindex Wno-lto-type-mismatch
2867 During the link-time optimization warn about type mismatches in
2868 global declarations from different compilation units.
2869 Requires @option{-flto} to be enabled.  Enabled by default.
2871 @item -Wnarrowing @r{(C++ and Objective-C++ only)}
2872 @opindex Wnarrowing
2873 @opindex Wno-narrowing
2874 With @option{-std=gnu++98} or @option{-std=c++98}, warn when a narrowing
2875 conversion prohibited by C++11 occurs within
2876 @samp{@{ @}}, e.g.
2878 @smallexample
2879 int i = @{ 2.2 @}; // error: narrowing from double to int
2880 @end smallexample
2882 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2884 When a later standard is in effect, e.g. when using @option{-std=c++11},
2885 narrowing conversions are diagnosed by default, as required by the standard.
2886 A narrowing conversion from a constant produces an error,
2887 and a narrowing conversion from a non-constant produces a warning,
2888 but @option{-Wno-narrowing} suppresses the diagnostic.
2889 Note that this does not affect the meaning of well-formed code;
2890 narrowing conversions are still considered ill-formed in SFINAE contexts.
2892 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2893 @opindex Wnoexcept
2894 @opindex Wno-noexcept
2895 Warn when a noexcept-expression evaluates to false because of a call
2896 to a function that does not have a non-throwing exception
2897 specification (i.e. @code{throw()} or @code{noexcept}) but is known by
2898 the compiler to never throw an exception.
2900 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2901 @opindex Wnoexcept-type
2902 @opindex Wno-noexcept-type
2903 Warn if the C++1z feature making @code{noexcept} part of a function
2904 type changes the mangled name of a symbol relative to C++14.  Enabled
2905 by @option{-Wabi} and @option{-Wc++1z-compat}.
2907 @smallexample
2908 template <class T> void f(T t) @{ t(); @};
2909 void g() noexcept;
2910 void h() @{ f(g); @} // in C++14 calls f<void(*)()>, in C++1z calls f<void(*)()noexcept>
2911 @end smallexample
2914 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2915 @opindex Wnon-virtual-dtor
2916 @opindex Wno-non-virtual-dtor
2917 Warn when a class has virtual functions and an accessible non-virtual
2918 destructor itself or in an accessible polymorphic base class, in which
2919 case it is possible but unsafe to delete an instance of a derived
2920 class through a pointer to the class itself or base class.  This
2921 warning is automatically enabled if @option{-Weffc++} is specified.
2923 @item -Wregister @r{(C++ and Objective-C++ only)}
2924 @opindex Wregister
2925 @opindex Wno-register
2926 Warn on uses of the @code{register} storage class specifier, except
2927 when it is part of the GNU @ref{Explicit Register Variables} extension.
2928 The use of the @code{register} keyword as storage class specifier has
2929 been deprecated in C++11 and removed in C++17.
2930 Enabled by default with @option{-std=c++1z}.
2932 @item -Wreorder @r{(C++ and Objective-C++ only)}
2933 @opindex Wreorder
2934 @opindex Wno-reorder
2935 @cindex reordering, warning
2936 @cindex warning for reordering of member initializers
2937 Warn when the order of member initializers given in the code does not
2938 match the order in which they must be executed.  For instance:
2940 @smallexample
2941 struct A @{
2942   int i;
2943   int j;
2944   A(): j (0), i (1) @{ @}
2946 @end smallexample
2948 @noindent
2949 The compiler rearranges the member initializers for @code{i}
2950 and @code{j} to match the declaration order of the members, emitting
2951 a warning to that effect.  This warning is enabled by @option{-Wall}.
2953 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
2954 @opindex fext-numeric-literals
2955 @opindex fno-ext-numeric-literals
2956 Accept imaginary, fixed-point, or machine-defined
2957 literal number suffixes as GNU extensions.
2958 When this option is turned off these suffixes are treated
2959 as C++11 user-defined literal numeric suffixes.
2960 This is on by default for all pre-C++11 dialects and all GNU dialects:
2961 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
2962 @option{-std=gnu++14}.
2963 This option is off by default
2964 for ISO C++11 onwards (@option{-std=c++11}, ...).
2965 @end table
2967 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2969 @table @gcctabopt
2970 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2971 @opindex Weffc++
2972 @opindex Wno-effc++
2973 Warn about violations of the following style guidelines from Scott Meyers'
2974 @cite{Effective C++} series of books:
2976 @itemize @bullet
2977 @item
2978 Define a copy constructor and an assignment operator for classes
2979 with dynamically-allocated memory.
2981 @item
2982 Prefer initialization to assignment in constructors.
2984 @item
2985 Have @code{operator=} return a reference to @code{*this}.
2987 @item
2988 Don't try to return a reference when you must return an object.
2990 @item
2991 Distinguish between prefix and postfix forms of increment and
2992 decrement operators.
2994 @item
2995 Never overload @code{&&}, @code{||}, or @code{,}.
2997 @end itemize
2999 This option also enables @option{-Wnon-virtual-dtor}, which is also
3000 one of the effective C++ recommendations.  However, the check is
3001 extended to warn about the lack of virtual destructor in accessible
3002 non-polymorphic bases classes too.
3004 When selecting this option, be aware that the standard library
3005 headers do not obey all of these guidelines; use @samp{grep -v}
3006 to filter out those warnings.
3008 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
3009 @opindex Wstrict-null-sentinel
3010 @opindex Wno-strict-null-sentinel
3011 Warn about the use of an uncasted @code{NULL} as sentinel.  When
3012 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
3013 to @code{__null}.  Although it is a null pointer constant rather than a
3014 null pointer, it is guaranteed to be of the same size as a pointer.
3015 But this use is not portable across different compilers.
3017 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
3018 @opindex Wno-non-template-friend
3019 @opindex Wnon-template-friend
3020 Disable warnings when non-template friend functions are declared
3021 within a template.  In very old versions of GCC that predate implementation
3022 of the ISO standard, declarations such as 
3023 @samp{friend int foo(int)}, where the name of the friend is an unqualified-id,
3024 could be interpreted as a particular specialization of a template
3025 function; the warning exists to diagnose compatibility problems, 
3026 and is enabled by default.
3028 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
3029 @opindex Wold-style-cast
3030 @opindex Wno-old-style-cast
3031 Warn if an old-style (C-style) cast to a non-void type is used within
3032 a C++ program.  The new-style casts (@code{dynamic_cast},
3033 @code{static_cast}, @code{reinterpret_cast}, and @code{const_cast}) are
3034 less vulnerable to unintended effects and much easier to search for.
3036 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
3037 @opindex Woverloaded-virtual
3038 @opindex Wno-overloaded-virtual
3039 @cindex overloaded virtual function, warning
3040 @cindex warning for overloaded virtual function
3041 Warn when a function declaration hides virtual functions from a
3042 base class.  For example, in:
3044 @smallexample
3045 struct A @{
3046   virtual void f();
3049 struct B: public A @{
3050   void f(int);
3052 @end smallexample
3054 the @code{A} class version of @code{f} is hidden in @code{B}, and code
3055 like:
3057 @smallexample
3058 B* b;
3059 b->f();
3060 @end smallexample
3062 @noindent
3063 fails to compile.
3065 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
3066 @opindex Wno-pmf-conversions
3067 @opindex Wpmf-conversions
3068 Disable the diagnostic for converting a bound pointer to member function
3069 to a plain pointer.
3071 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
3072 @opindex Wsign-promo
3073 @opindex Wno-sign-promo
3074 Warn when overload resolution chooses a promotion from unsigned or
3075 enumerated type to a signed type, over a conversion to an unsigned type of
3076 the same size.  Previous versions of G++ tried to preserve
3077 unsignedness, but the standard mandates the current behavior.
3079 @item -Wtemplates @r{(C++ and Objective-C++ only)}
3080 @opindex Wtemplates
3081 Warn when a primary template declaration is encountered.  Some coding
3082 rules disallow templates, and this may be used to enforce that rule.
3083 The warning is inactive inside a system header file, such as the STL, so
3084 one can still use the STL.  One may also instantiate or specialize
3085 templates.
3087 @item -Wmultiple-inheritance @r{(C++ and Objective-C++ only)}
3088 @opindex Wmultiple-inheritance
3089 Warn when a class is defined with multiple direct base classes.  Some
3090 coding rules disallow multiple inheritance, and this may be used to
3091 enforce that rule.  The warning is inactive inside a system header file,
3092 such as the STL, so one can still use the STL.  One may also define
3093 classes that indirectly use multiple inheritance.
3095 @item -Wvirtual-inheritance
3096 @opindex Wvirtual-inheritance
3097 Warn when a class is defined with a virtual direct base class.  Some
3098 coding rules disallow multiple inheritance, and this may be used to
3099 enforce that rule.  The warning is inactive inside a system header file,
3100 such as the STL, so one can still use the STL.  One may also define
3101 classes that indirectly use virtual inheritance.
3103 @item -Wnamespaces
3104 @opindex Wnamespaces
3105 Warn when a namespace definition is opened.  Some coding rules disallow
3106 namespaces, and this may be used to enforce that rule.  The warning is
3107 inactive inside a system header file, such as the STL, so one can still
3108 use the STL.  One may also use using directives and qualified names.
3110 @item -Wno-terminate @r{(C++ and Objective-C++ only)}
3111 @opindex Wterminate
3112 @opindex Wno-terminate
3113 Disable the warning about a throw-expression that will immediately
3114 result in a call to @code{terminate}.
3115 @end table
3117 @node Objective-C and Objective-C++ Dialect Options
3118 @section Options Controlling Objective-C and Objective-C++ Dialects
3120 @cindex compiler options, Objective-C and Objective-C++
3121 @cindex Objective-C and Objective-C++ options, command-line
3122 @cindex options, Objective-C and Objective-C++
3123 (NOTE: This manual does not describe the Objective-C and Objective-C++
3124 languages themselves.  @xref{Standards,,Language Standards
3125 Supported by GCC}, for references.)
3127 This section describes the command-line options that are only meaningful
3128 for Objective-C and Objective-C++ programs.  You can also use most of
3129 the language-independent GNU compiler options.
3130 For example, you might compile a file @file{some_class.m} like this:
3132 @smallexample
3133 gcc -g -fgnu-runtime -O -c some_class.m
3134 @end smallexample
3136 @noindent
3137 In this example, @option{-fgnu-runtime} is an option meant only for
3138 Objective-C and Objective-C++ programs; you can use the other options with
3139 any language supported by GCC@.
3141 Note that since Objective-C is an extension of the C language, Objective-C
3142 compilations may also use options specific to the C front-end (e.g.,
3143 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
3144 C++-specific options (e.g., @option{-Wabi}).
3146 Here is a list of options that are @emph{only} for compiling Objective-C
3147 and Objective-C++ programs:
3149 @table @gcctabopt
3150 @item -fconstant-string-class=@var{class-name}
3151 @opindex fconstant-string-class
3152 Use @var{class-name} as the name of the class to instantiate for each
3153 literal string specified with the syntax @code{@@"@dots{}"}.  The default
3154 class name is @code{NXConstantString} if the GNU runtime is being used, and
3155 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
3156 @option{-fconstant-cfstrings} option, if also present, overrides the
3157 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
3158 to be laid out as constant CoreFoundation strings.
3160 @item -fgnu-runtime
3161 @opindex fgnu-runtime
3162 Generate object code compatible with the standard GNU Objective-C
3163 runtime.  This is the default for most types of systems.
3165 @item -fnext-runtime
3166 @opindex fnext-runtime
3167 Generate output compatible with the NeXT runtime.  This is the default
3168 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
3169 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
3170 used.
3172 @item -fno-nil-receivers
3173 @opindex fno-nil-receivers
3174 Assume that all Objective-C message dispatches (@code{[receiver
3175 message:arg]}) in this translation unit ensure that the receiver is
3176 not @code{nil}.  This allows for more efficient entry points in the
3177 runtime to be used.  This option is only available in conjunction with
3178 the NeXT runtime and ABI version 0 or 1.
3180 @item -fobjc-abi-version=@var{n}
3181 @opindex fobjc-abi-version
3182 Use version @var{n} of the Objective-C ABI for the selected runtime.
3183 This option is currently supported only for the NeXT runtime.  In that
3184 case, Version 0 is the traditional (32-bit) ABI without support for
3185 properties and other Objective-C 2.0 additions.  Version 1 is the
3186 traditional (32-bit) ABI with support for properties and other
3187 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
3188 nothing is specified, the default is Version 0 on 32-bit target
3189 machines, and Version 2 on 64-bit target machines.
3191 @item -fobjc-call-cxx-cdtors
3192 @opindex fobjc-call-cxx-cdtors
3193 For each Objective-C class, check if any of its instance variables is a
3194 C++ object with a non-trivial default constructor.  If so, synthesize a
3195 special @code{- (id) .cxx_construct} instance method which runs
3196 non-trivial default constructors on any such instance variables, in order,
3197 and then return @code{self}.  Similarly, check if any instance variable
3198 is a C++ object with a non-trivial destructor, and if so, synthesize a
3199 special @code{- (void) .cxx_destruct} method which runs
3200 all such default destructors, in reverse order.
3202 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
3203 methods thusly generated only operate on instance variables
3204 declared in the current Objective-C class, and not those inherited
3205 from superclasses.  It is the responsibility of the Objective-C
3206 runtime to invoke all such methods in an object's inheritance
3207 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
3208 by the runtime immediately after a new object instance is allocated;
3209 the @code{- (void) .cxx_destruct} methods are invoked immediately
3210 before the runtime deallocates an object instance.
3212 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
3213 support for invoking the @code{- (id) .cxx_construct} and
3214 @code{- (void) .cxx_destruct} methods.
3216 @item -fobjc-direct-dispatch
3217 @opindex fobjc-direct-dispatch
3218 Allow fast jumps to the message dispatcher.  On Darwin this is
3219 accomplished via the comm page.
3221 @item -fobjc-exceptions
3222 @opindex fobjc-exceptions
3223 Enable syntactic support for structured exception handling in
3224 Objective-C, similar to what is offered by C++.  This option
3225 is required to use the Objective-C keywords @code{@@try},
3226 @code{@@throw}, @code{@@catch}, @code{@@finally} and
3227 @code{@@synchronized}.  This option is available with both the GNU
3228 runtime and the NeXT runtime (but not available in conjunction with
3229 the NeXT runtime on Mac OS X 10.2 and earlier).
3231 @item -fobjc-gc
3232 @opindex fobjc-gc
3233 Enable garbage collection (GC) in Objective-C and Objective-C++
3234 programs.  This option is only available with the NeXT runtime; the
3235 GNU runtime has a different garbage collection implementation that
3236 does not require special compiler flags.
3238 @item -fobjc-nilcheck
3239 @opindex fobjc-nilcheck
3240 For the NeXT runtime with version 2 of the ABI, check for a nil
3241 receiver in method invocations before doing the actual method call.
3242 This is the default and can be disabled using
3243 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
3244 checked for nil in this way no matter what this flag is set to.
3245 Currently this flag does nothing when the GNU runtime, or an older
3246 version of the NeXT runtime ABI, is used.
3248 @item -fobjc-std=objc1
3249 @opindex fobjc-std
3250 Conform to the language syntax of Objective-C 1.0, the language
3251 recognized by GCC 4.0.  This only affects the Objective-C additions to
3252 the C/C++ language; it does not affect conformance to C/C++ standards,
3253 which is controlled by the separate C/C++ dialect option flags.  When
3254 this option is used with the Objective-C or Objective-C++ compiler,
3255 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
3256 This is useful if you need to make sure that your Objective-C code can
3257 be compiled with older versions of GCC@.
3259 @item -freplace-objc-classes
3260 @opindex freplace-objc-classes
3261 Emit a special marker instructing @command{ld(1)} not to statically link in
3262 the resulting object file, and allow @command{dyld(1)} to load it in at
3263 run time instead.  This is used in conjunction with the Fix-and-Continue
3264 debugging mode, where the object file in question may be recompiled and
3265 dynamically reloaded in the course of program execution, without the need
3266 to restart the program itself.  Currently, Fix-and-Continue functionality
3267 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
3268 and later.
3270 @item -fzero-link
3271 @opindex fzero-link
3272 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
3273 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
3274 compile time) with static class references that get initialized at load time,
3275 which improves run-time performance.  Specifying the @option{-fzero-link} flag
3276 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
3277 to be retained.  This is useful in Zero-Link debugging mode, since it allows
3278 for individual class implementations to be modified during program execution.
3279 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
3280 regardless of command-line options.
3282 @item -fno-local-ivars
3283 @opindex fno-local-ivars
3284 @opindex flocal-ivars
3285 By default instance variables in Objective-C can be accessed as if
3286 they were local variables from within the methods of the class they're
3287 declared in.  This can lead to shadowing between instance variables
3288 and other variables declared either locally inside a class method or
3289 globally with the same name.  Specifying the @option{-fno-local-ivars}
3290 flag disables this behavior thus avoiding variable shadowing issues.
3292 @item -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]}
3293 @opindex fivar-visibility
3294 Set the default instance variable visibility to the specified option
3295 so that instance variables declared outside the scope of any access
3296 modifier directives default to the specified visibility.
3298 @item -gen-decls
3299 @opindex gen-decls
3300 Dump interface declarations for all classes seen in the source file to a
3301 file named @file{@var{sourcename}.decl}.
3303 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
3304 @opindex Wassign-intercept
3305 @opindex Wno-assign-intercept
3306 Warn whenever an Objective-C assignment is being intercepted by the
3307 garbage collector.
3309 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
3310 @opindex Wno-protocol
3311 @opindex Wprotocol
3312 If a class is declared to implement a protocol, a warning is issued for
3313 every method in the protocol that is not implemented by the class.  The
3314 default behavior is to issue a warning for every method not explicitly
3315 implemented in the class, even if a method implementation is inherited
3316 from the superclass.  If you use the @option{-Wno-protocol} option, then
3317 methods inherited from the superclass are considered to be implemented,
3318 and no warning is issued for them.
3320 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3321 @opindex Wselector
3322 @opindex Wno-selector
3323 Warn if multiple methods of different types for the same selector are
3324 found during compilation.  The check is performed on the list of methods
3325 in the final stage of compilation.  Additionally, a check is performed
3326 for each selector appearing in a @code{@@selector(@dots{})}
3327 expression, and a corresponding method for that selector has been found
3328 during compilation.  Because these checks scan the method table only at
3329 the end of compilation, these warnings are not produced if the final
3330 stage of compilation is not reached, for example because an error is
3331 found during compilation, or because the @option{-fsyntax-only} option is
3332 being used.
3334 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3335 @opindex Wstrict-selector-match
3336 @opindex Wno-strict-selector-match
3337 Warn if multiple methods with differing argument and/or return types are
3338 found for a given selector when attempting to send a message using this
3339 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3340 is off (which is the default behavior), the compiler omits such warnings
3341 if any differences found are confined to types that share the same size
3342 and alignment.
3344 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3345 @opindex Wundeclared-selector
3346 @opindex Wno-undeclared-selector
3347 Warn if a @code{@@selector(@dots{})} expression referring to an
3348 undeclared selector is found.  A selector is considered undeclared if no
3349 method with that name has been declared before the
3350 @code{@@selector(@dots{})} expression, either explicitly in an
3351 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3352 an @code{@@implementation} section.  This option always performs its
3353 checks as soon as a @code{@@selector(@dots{})} expression is found,
3354 while @option{-Wselector} only performs its checks in the final stage of
3355 compilation.  This also enforces the coding style convention
3356 that methods and selectors must be declared before being used.
3358 @item -print-objc-runtime-info
3359 @opindex print-objc-runtime-info
3360 Generate C header describing the largest structure that is passed by
3361 value, if any.
3363 @end table
3365 @node Diagnostic Message Formatting Options
3366 @section Options to Control Diagnostic Messages Formatting
3367 @cindex options to control diagnostics formatting
3368 @cindex diagnostic messages
3369 @cindex message formatting
3371 Traditionally, diagnostic messages have been formatted irrespective of
3372 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3373 options described below
3374 to control the formatting algorithm for diagnostic messages, 
3375 e.g.@: how many characters per line, how often source location
3376 information should be reported.  Note that some language front ends may not
3377 honor these options.
3379 @table @gcctabopt
3380 @item -fmessage-length=@var{n}
3381 @opindex fmessage-length
3382 Try to format error messages so that they fit on lines of about
3383 @var{n} characters.  If @var{n} is zero, then no line-wrapping is
3384 done; each error message appears on a single line.  This is the
3385 default for all front ends.
3387 @item -fdiagnostics-show-location=once
3388 @opindex fdiagnostics-show-location
3389 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3390 reporter to emit source location information @emph{once}; that is, in
3391 case the message is too long to fit on a single physical line and has to
3392 be wrapped, the source location won't be emitted (as prefix) again,
3393 over and over, in subsequent continuation lines.  This is the default
3394 behavior.
3396 @item -fdiagnostics-show-location=every-line
3397 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3398 messages reporter to emit the same source location information (as
3399 prefix) for physical lines that result from the process of breaking
3400 a message which is too long to fit on a single line.
3402 @item -fdiagnostics-color[=@var{WHEN}]
3403 @itemx -fno-diagnostics-color
3404 @opindex fdiagnostics-color
3405 @cindex highlight, color
3406 @vindex GCC_COLORS @r{environment variable}
3407 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3408 or @samp{auto}.  The default depends on how the compiler has been configured,
3409 it can be any of the above @var{WHEN} options or also @samp{never}
3410 if @env{GCC_COLORS} environment variable isn't present in the environment,
3411 and @samp{auto} otherwise.
3412 @samp{auto} means to use color only when the standard error is a terminal.
3413 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3414 aliases for @option{-fdiagnostics-color=always} and
3415 @option{-fdiagnostics-color=never}, respectively.
3417 The colors are defined by the environment variable @env{GCC_COLORS}.
3418 Its value is a colon-separated list of capabilities and Select Graphic
3419 Rendition (SGR) substrings. SGR commands are interpreted by the
3420 terminal or terminal emulator.  (See the section in the documentation
3421 of your text terminal for permitted values and their meanings as
3422 character attributes.)  These substring values are integers in decimal
3423 representation and can be concatenated with semicolons.
3424 Common values to concatenate include
3425 @samp{1} for bold,
3426 @samp{4} for underline,
3427 @samp{5} for blink,
3428 @samp{7} for inverse,
3429 @samp{39} for default foreground color,
3430 @samp{30} to @samp{37} for foreground colors,
3431 @samp{90} to @samp{97} for 16-color mode foreground colors,
3432 @samp{38;5;0} to @samp{38;5;255}
3433 for 88-color and 256-color modes foreground colors,
3434 @samp{49} for default background color,
3435 @samp{40} to @samp{47} for background colors,
3436 @samp{100} to @samp{107} for 16-color mode background colors,
3437 and @samp{48;5;0} to @samp{48;5;255}
3438 for 88-color and 256-color modes background colors.
3440 The default @env{GCC_COLORS} is
3441 @smallexample
3442 error=01;31:warning=01;35:note=01;36:range1=32:range2=34:locus=01:\
3443 quote=01:fixit-insert=32:fixit-delete=31:\
3444 diff-filename=01:diff-hunk=32:diff-delete=31:diff-insert=32
3445 @end smallexample
3446 @noindent
3447 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3448 @samp{01;36} is bold cyan, @samp{32} is green, @samp{34} is blue,
3449 @samp{01} is bold, and @samp{31} is red.
3450 Setting @env{GCC_COLORS} to the empty string disables colors.
3451 Supported capabilities are as follows.
3453 @table @code
3454 @item error=
3455 @vindex error GCC_COLORS @r{capability}
3456 SGR substring for error: markers.
3458 @item warning=
3459 @vindex warning GCC_COLORS @r{capability}
3460 SGR substring for warning: markers.
3462 @item note=
3463 @vindex note GCC_COLORS @r{capability}
3464 SGR substring for note: markers.
3466 @item range1=
3467 @vindex range1 GCC_COLORS @r{capability}
3468 SGR substring for first additional range.
3470 @item range2=
3471 @vindex range2 GCC_COLORS @r{capability}
3472 SGR substring for second additional range.
3474 @item locus=
3475 @vindex locus GCC_COLORS @r{capability}
3476 SGR substring for location information, @samp{file:line} or
3477 @samp{file:line:column} etc.
3479 @item quote=
3480 @vindex quote GCC_COLORS @r{capability}
3481 SGR substring for information printed within quotes.
3483 @item fixit-insert=
3484 @vindex fixit-insert GCC_COLORS @r{capability}
3485 SGR substring for fix-it hints suggesting text to
3486 be inserted or replaced.
3488 @item fixit-delete=
3489 @vindex fixit-delete GCC_COLORS @r{capability}
3490 SGR substring for fix-it hints suggesting text to
3491 be deleted.
3493 @item diff-filename=
3494 @vindex diff-filename GCC_COLORS @r{capability}
3495 SGR substring for filename headers within generated patches.
3497 @item diff-hunk=
3498 @vindex diff-hunk GCC_COLORS @r{capability}
3499 SGR substring for the starts of hunks within generated patches.
3501 @item diff-delete=
3502 @vindex diff-delete GCC_COLORS @r{capability}
3503 SGR substring for deleted lines within generated patches.
3505 @item diff-insert=
3506 @vindex diff-insert GCC_COLORS @r{capability}
3507 SGR substring for inserted lines within generated patches.
3508 @end table
3510 @item -fno-diagnostics-show-option
3511 @opindex fno-diagnostics-show-option
3512 @opindex fdiagnostics-show-option
3513 By default, each diagnostic emitted includes text indicating the
3514 command-line option that directly controls the diagnostic (if such an
3515 option is known to the diagnostic machinery).  Specifying the
3516 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3518 @item -fno-diagnostics-show-caret
3519 @opindex fno-diagnostics-show-caret
3520 @opindex fdiagnostics-show-caret
3521 By default, each diagnostic emitted includes the original source line
3522 and a caret @samp{^} indicating the column.  This option suppresses this
3523 information.  The source line is truncated to @var{n} characters, if
3524 the @option{-fmessage-length=n} option is given.  When the output is done
3525 to the terminal, the width is limited to the width given by the
3526 @env{COLUMNS} environment variable or, if not set, to the terminal width.
3528 @item -fdiagnostics-parseable-fixits
3529 @opindex fdiagnostics-parseable-fixits
3530 Emit fix-it hints in a machine-parseable format, suitable for consumption
3531 by IDEs.  For each fix-it, a line will be printed after the relevant
3532 diagnostic, starting with the string ``fix-it:''.  For example:
3534 @smallexample
3535 fix-it:"test.c":@{45:3-45:21@}:"gtk_widget_show_all"
3536 @end smallexample
3538 The location is expressed as a half-open range, expressed as a count of
3539 bytes, starting at byte 1 for the initial column.  In the above example,
3540 bytes 3 through 20 of line 45 of ``test.c'' are to be replaced with the
3541 given string:
3543 @smallexample
3544 00000000011111111112222222222
3545 12345678901234567890123456789
3546   gtk_widget_showall (dlg);
3547   ^^^^^^^^^^^^^^^^^^
3548   gtk_widget_show_all
3549 @end smallexample
3551 The filename and replacement string escape backslash as ``\\", tab as ``\t'',
3552 newline as ``\n'', double quotes as ``\"'', non-printable characters as octal
3553 (e.g. vertical tab as ``\013'').
3555 An empty replacement string indicates that the given range is to be removed.
3556 An empty range (e.g. ``45:3-45:3'') indicates that the string is to
3557 be inserted at the given position.
3559 @item -fdiagnostics-generate-patch
3560 @opindex fdiagnostics-generate-patch
3561 Print fix-it hints to stderr in unified diff format, after any diagnostics
3562 are printed.  For example:
3564 @smallexample
3565 --- test.c
3566 +++ test.c
3567 @@ -42,5 +42,5 @@
3569  void show_cb(GtkDialog *dlg)
3570  @{
3571 -  gtk_widget_showall(dlg);
3572 +  gtk_widget_show_all(dlg);
3573  @}
3575 @end smallexample
3577 The diff may or may not be colorized, following the same rules
3578 as for diagnostics (see @option{-fdiagnostics-color}).
3580 @item -fno-show-column
3581 @opindex fno-show-column
3582 Do not print column numbers in diagnostics.  This may be necessary if
3583 diagnostics are being scanned by a program that does not understand the
3584 column numbers, such as @command{dejagnu}.
3586 @end table
3588 @node Warning Options
3589 @section Options to Request or Suppress Warnings
3590 @cindex options to control warnings
3591 @cindex warning messages
3592 @cindex messages, warning
3593 @cindex suppressing warnings
3595 Warnings are diagnostic messages that report constructions that
3596 are not inherently erroneous but that are risky or suggest there
3597 may have been an error.
3599 The following language-independent options do not enable specific
3600 warnings but control the kinds of diagnostics produced by GCC@.
3602 @table @gcctabopt
3603 @cindex syntax checking
3604 @item -fsyntax-only
3605 @opindex fsyntax-only
3606 Check the code for syntax errors, but don't do anything beyond that.
3608 @item -fmax-errors=@var{n}
3609 @opindex fmax-errors
3610 Limits the maximum number of error messages to @var{n}, at which point
3611 GCC bails out rather than attempting to continue processing the source
3612 code.  If @var{n} is 0 (the default), there is no limit on the number
3613 of error messages produced.  If @option{-Wfatal-errors} is also
3614 specified, then @option{-Wfatal-errors} takes precedence over this
3615 option.
3617 @item -w
3618 @opindex w
3619 Inhibit all warning messages.
3621 @item -Werror
3622 @opindex Werror
3623 @opindex Wno-error
3624 Make all warnings into errors.
3626 @item -Werror=
3627 @opindex Werror=
3628 @opindex Wno-error=
3629 Make the specified warning into an error.  The specifier for a warning
3630 is appended; for example @option{-Werror=switch} turns the warnings
3631 controlled by @option{-Wswitch} into errors.  This switch takes a
3632 negative form, to be used to negate @option{-Werror} for specific
3633 warnings; for example @option{-Wno-error=switch} makes
3634 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3635 is in effect.
3637 The warning message for each controllable warning includes the
3638 option that controls the warning.  That option can then be used with
3639 @option{-Werror=} and @option{-Wno-error=} as described above.
3640 (Printing of the option in the warning message can be disabled using the
3641 @option{-fno-diagnostics-show-option} flag.)
3643 Note that specifying @option{-Werror=}@var{foo} automatically implies
3644 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3645 imply anything.
3647 @item -Wfatal-errors
3648 @opindex Wfatal-errors
3649 @opindex Wno-fatal-errors
3650 This option causes the compiler to abort compilation on the first error
3651 occurred rather than trying to keep going and printing further error
3652 messages.
3654 @end table
3656 You can request many specific warnings with options beginning with
3657 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3658 implicit declarations.  Each of these specific warning options also
3659 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3660 example, @option{-Wno-implicit}.  This manual lists only one of the
3661 two forms, whichever is not the default.  For further
3662 language-specific options also refer to @ref{C++ Dialect Options} and
3663 @ref{Objective-C and Objective-C++ Dialect Options}.
3665 Some options, such as @option{-Wall} and @option{-Wextra}, turn on other
3666 options, such as @option{-Wunused}, which may turn on further options,
3667 such as @option{-Wunused-value}. The combined effect of positive and
3668 negative forms is that more specific options have priority over less
3669 specific ones, independently of their position in the command-line. For
3670 options of the same specificity, the last one takes effect. Options
3671 enabled or disabled via pragmas (@pxref{Diagnostic Pragmas}) take effect
3672 as if they appeared at the end of the command-line.
3674 When an unrecognized warning option is requested (e.g.,
3675 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3676 that the option is not recognized.  However, if the @option{-Wno-} form
3677 is used, the behavior is slightly different: no diagnostic is
3678 produced for @option{-Wno-unknown-warning} unless other diagnostics
3679 are being produced.  This allows the use of new @option{-Wno-} options
3680 with old compilers, but if something goes wrong, the compiler
3681 warns that an unrecognized option is present.
3683 @table @gcctabopt
3684 @item -Wpedantic
3685 @itemx -pedantic
3686 @opindex pedantic
3687 @opindex Wpedantic
3688 Issue all the warnings demanded by strict ISO C and ISO C++;
3689 reject all programs that use forbidden extensions, and some other
3690 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3691 version of the ISO C standard specified by any @option{-std} option used.
3693 Valid ISO C and ISO C++ programs should compile properly with or without
3694 this option (though a rare few require @option{-ansi} or a
3695 @option{-std} option specifying the required version of ISO C)@.  However,
3696 without this option, certain GNU extensions and traditional C and C++
3697 features are supported as well.  With this option, they are rejected.
3699 @option{-Wpedantic} does not cause warning messages for use of the
3700 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3701 warnings are also disabled in the expression that follows
3702 @code{__extension__}.  However, only system header files should use
3703 these escape routes; application programs should avoid them.
3704 @xref{Alternate Keywords}.
3706 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3707 C conformance.  They soon find that it does not do quite what they want:
3708 it finds some non-ISO practices, but not all---only those for which
3709 ISO C @emph{requires} a diagnostic, and some others for which
3710 diagnostics have been added.
3712 A feature to report any failure to conform to ISO C might be useful in
3713 some instances, but would require considerable additional work and would
3714 be quite different from @option{-Wpedantic}.  We don't have plans to
3715 support such a feature in the near future.
3717 Where the standard specified with @option{-std} represents a GNU
3718 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3719 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3720 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3721 where they are required by the base standard.  (It does not make sense
3722 for such warnings to be given only for features not in the specified GNU
3723 C dialect, since by definition the GNU dialects of C include all
3724 features the compiler supports with the given option, and there would be
3725 nothing to warn about.)
3727 @item -pedantic-errors
3728 @opindex pedantic-errors
3729 Give an error whenever the @dfn{base standard} (see @option{-Wpedantic})
3730 requires a diagnostic, in some cases where there is undefined behavior
3731 at compile-time and in some other cases that do not prevent compilation
3732 of programs that are valid according to the standard. This is not
3733 equivalent to @option{-Werror=pedantic}, since there are errors enabled
3734 by this option and not enabled by the latter and vice versa.
3736 @item -Wall
3737 @opindex Wall
3738 @opindex Wno-all
3739 This enables all the warnings about constructions that some users
3740 consider questionable, and that are easy to avoid (or modify to
3741 prevent the warning), even in conjunction with macros.  This also
3742 enables some language-specific warnings described in @ref{C++ Dialect
3743 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3745 @option{-Wall} turns on the following warning flags:
3747 @gccoptlist{-Waddress   @gol
3748 -Warray-bounds=1 @r{(only with} @option{-O2}@r{)}  @gol
3749 -Wbool-compare  @gol
3750 -Wbool-operation  @gol
3751 -Wc++11-compat  -Wc++14-compat  @gol
3752 -Wchar-subscripts  @gol
3753 -Wcomment  @gol
3754 -Wduplicate-decl-specifier @r{(C and Objective-C only)} @gol
3755 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3756 -Wformat   @gol
3757 -Wint-in-bool-context  @gol
3758 -Wimplicit @r{(C and Objective-C only)} @gol
3759 -Wimplicit-int @r{(C and Objective-C only)} @gol
3760 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3761 -Winit-self @r{(only for C++)} @gol
3762 -Wlogical-not-parentheses @gol
3763 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3764 -Wmaybe-uninitialized @gol
3765 -Wmemset-elt-size @gol
3766 -Wmemset-transposed-args @gol
3767 -Wmisleading-indentation @r{(only for C/C++)} @gol
3768 -Wmissing-braces @r{(only for C/ObjC)} @gol
3769 -Wnarrowing @r{(only for C++)}  @gol
3770 -Wnonnull  @gol
3771 -Wnonnull-compare  @gol
3772 -Wopenmp-simd @gol
3773 -Wparentheses  @gol
3774 -Wpointer-sign  @gol
3775 -Wreorder   @gol
3776 -Wreturn-type  @gol
3777 -Wsequence-point  @gol
3778 -Wsign-compare @r{(only in C++)}  @gol
3779 -Wsizeof-pointer-memaccess @gol
3780 -Wstrict-aliasing  @gol
3781 -Wstrict-overflow=1  @gol
3782 -Wswitch  @gol
3783 -Wtautological-compare  @gol
3784 -Wtrigraphs  @gol
3785 -Wuninitialized  @gol
3786 -Wunknown-pragmas  @gol
3787 -Wunused-function  @gol
3788 -Wunused-label     @gol
3789 -Wunused-value     @gol
3790 -Wunused-variable  @gol
3791 -Wvolatile-register-var @gol
3794 Note that some warning flags are not implied by @option{-Wall}.  Some of
3795 them warn about constructions that users generally do not consider
3796 questionable, but which occasionally you might wish to check for;
3797 others warn about constructions that are necessary or hard to avoid in
3798 some cases, and there is no simple way to modify the code to suppress
3799 the warning. Some of them are enabled by @option{-Wextra} but many of
3800 them must be enabled individually.
3802 @item -Wextra
3803 @opindex W
3804 @opindex Wextra
3805 @opindex Wno-extra
3806 This enables some extra warning flags that are not enabled by
3807 @option{-Wall}. (This option used to be called @option{-W}.  The older
3808 name is still supported, but the newer name is more descriptive.)
3810 @gccoptlist{-Wclobbered  @gol
3811 -Wempty-body  @gol
3812 -Wignored-qualifiers @gol
3813 -Wimplicit-fallthrough=3 @gol
3814 -Wmissing-field-initializers  @gol
3815 -Wmissing-parameter-type @r{(C only)}  @gol
3816 -Wold-style-declaration @r{(C only)}  @gol
3817 -Woverride-init  @gol
3818 -Wsign-compare @r{(C only)} @gol
3819 -Wtype-limits  @gol
3820 -Wuninitialized  @gol
3821 -Wshift-negative-value @r{(in C++03 and in C99 and newer)}  @gol
3822 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3823 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3826 The option @option{-Wextra} also prints warning messages for the
3827 following cases:
3829 @itemize @bullet
3831 @item
3832 A pointer is compared against integer zero with @code{<}, @code{<=},
3833 @code{>}, or @code{>=}.
3835 @item
3836 (C++ only) An enumerator and a non-enumerator both appear in a
3837 conditional expression.
3839 @item
3840 (C++ only) Ambiguous virtual bases.
3842 @item
3843 (C++ only) Subscripting an array that has been declared @code{register}.
3845 @item
3846 (C++ only) Taking the address of a variable that has been declared
3847 @code{register}.
3849 @item
3850 (C++ only) A base class is not initialized in the copy constructor
3851 of a derived class.
3853 @end itemize
3855 @item -Wchar-subscripts
3856 @opindex Wchar-subscripts
3857 @opindex Wno-char-subscripts
3858 Warn if an array subscript has type @code{char}.  This is a common cause
3859 of error, as programmers often forget that this type is signed on some
3860 machines.
3861 This warning is enabled by @option{-Wall}.
3863 @item -Wno-coverage-mismatch
3864 @opindex Wno-coverage-mismatch
3865 Warn if feedback profiles do not match when using the
3866 @option{-fprofile-use} option.
3867 If a source file is changed between compiling with @option{-fprofile-gen} and
3868 with @option{-fprofile-use}, the files with the profile feedback can fail
3869 to match the source file and GCC cannot use the profile feedback
3870 information.  By default, this warning is enabled and is treated as an
3871 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3872 warning or @option{-Wno-error=coverage-mismatch} can be used to
3873 disable the error.  Disabling the error for this warning can result in
3874 poorly optimized code and is useful only in the
3875 case of very minor changes such as bug fixes to an existing code-base.
3876 Completely disabling the warning is not recommended.
3878 @item -Wno-cpp
3879 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3881 Suppress warning messages emitted by @code{#warning} directives.
3883 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3884 @opindex Wdouble-promotion
3885 @opindex Wno-double-promotion
3886 Give a warning when a value of type @code{float} is implicitly
3887 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
3888 floating-point unit implement @code{float} in hardware, but emulate
3889 @code{double} in software.  On such a machine, doing computations
3890 using @code{double} values is much more expensive because of the
3891 overhead required for software emulation.
3893 It is easy to accidentally do computations with @code{double} because
3894 floating-point literals are implicitly of type @code{double}.  For
3895 example, in:
3896 @smallexample
3897 @group
3898 float area(float radius)
3900    return 3.14159 * radius * radius;
3902 @end group
3903 @end smallexample
3904 the compiler performs the entire computation with @code{double}
3905 because the floating-point literal is a @code{double}.
3907 @item -Wduplicate-decl-specifier @r{(C and Objective-C only)}
3908 @opindex Wduplicate-decl-specifier
3909 @opindex Wno-duplicate-decl-specifier
3910 Warn if a declaration has duplicate @code{const}, @code{volatile},
3911 @code{restrict} or @code{_Atomic} specifier.  This warning is enabled by
3912 @option{-Wall}.
3914 @item -Wformat
3915 @itemx -Wformat=@var{n}
3916 @opindex Wformat
3917 @opindex Wno-format
3918 @opindex ffreestanding
3919 @opindex fno-builtin
3920 @opindex Wformat=
3921 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
3922 the arguments supplied have types appropriate to the format string
3923 specified, and that the conversions specified in the format string make
3924 sense.  This includes standard functions, and others specified by format
3925 attributes (@pxref{Function Attributes}), in the @code{printf},
3926 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
3927 not in the C standard) families (or other target-specific families).
3928 Which functions are checked without format attributes having been
3929 specified depends on the standard version selected, and such checks of
3930 functions without the attribute specified are disabled by
3931 @option{-ffreestanding} or @option{-fno-builtin}.
3933 The formats are checked against the format features supported by GNU
3934 libc version 2.2.  These include all ISO C90 and C99 features, as well
3935 as features from the Single Unix Specification and some BSD and GNU
3936 extensions.  Other library implementations may not support all these
3937 features; GCC does not support warning about features that go beyond a
3938 particular library's limitations.  However, if @option{-Wpedantic} is used
3939 with @option{-Wformat}, warnings are given about format features not
3940 in the selected standard version (but not for @code{strfmon} formats,
3941 since those are not in any version of the C standard).  @xref{C Dialect
3942 Options,,Options Controlling C Dialect}.
3944 @table @gcctabopt
3945 @item -Wformat=1
3946 @itemx -Wformat
3947 @opindex Wformat
3948 @opindex Wformat=1
3949 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
3950 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
3951 @option{-Wformat} also checks for null format arguments for several
3952 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
3953 aspects of this level of format checking can be disabled by the
3954 options: @option{-Wno-format-contains-nul},
3955 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
3956 @option{-Wformat} is enabled by @option{-Wall}.
3958 @item -Wno-format-contains-nul
3959 @opindex Wno-format-contains-nul
3960 @opindex Wformat-contains-nul
3961 If @option{-Wformat} is specified, do not warn about format strings that
3962 contain NUL bytes.
3964 @item -Wno-format-extra-args
3965 @opindex Wno-format-extra-args
3966 @opindex Wformat-extra-args
3967 If @option{-Wformat} is specified, do not warn about excess arguments to a
3968 @code{printf} or @code{scanf} format function.  The C standard specifies
3969 that such arguments are ignored.
3971 Where the unused arguments lie between used arguments that are
3972 specified with @samp{$} operand number specifications, normally
3973 warnings are still given, since the implementation could not know what
3974 type to pass to @code{va_arg} to skip the unused arguments.  However,
3975 in the case of @code{scanf} formats, this option suppresses the
3976 warning if the unused arguments are all pointers, since the Single
3977 Unix Specification says that such unused arguments are allowed.
3979 @item -Wformat-overflow
3980 @itemx -Wformat-overflow=@var{level}
3981 @opindex Wformat-overflow
3982 @opindex Wno-format-overflow
3983 Warn about calls to formatted input/output functions such as @code{sprintf}
3984 and @code{vsprintf} that might overflow the destination buffer.  When the
3985 exact number of bytes written by a format directive cannot be determined
3986 at compile-time it is estimated based on heuristics that depend on the
3987 @var{level} argument and on optimization.  While enabling optimization
3988 will in most cases improve the accuracy of the warning, it may also
3989 result in false positives.
3991 @table @gcctabopt
3992 @item -Wformat-overflow
3993 @item -Wformat-overflow=1
3994 @opindex Wformat-overflow
3995 @opindex Wno-format-overflow
3996 Level @var{1} of @option{-Wformat-overflow} enabled by @option{-Wformat}
3997 employs a conservative approach that warns only about calls that most
3998 likely overflow the buffer.  At this level, numeric arguments to format
3999 directives with unknown values are assumed to have the value of one, and
4000 strings of unknown length to be empty.  Numeric arguments that are known
4001 to be bounded to a subrange of their type, or string arguments whose output
4002 is bounded either by their directive's precision or by a finite set of
4003 string literals, are assumed to take on the value within the range that
4004 results in the most bytes on output.  For example, the call to @code{sprintf}
4005 below is diagnosed because even with both @var{a} and @var{b} equal to zero,
4006 the terminating NUL character (@code{'\0'}) appended by the function
4007 to the destination buffer will be written past its end.  Increasing
4008 the size of the buffer by a single byte is sufficient to avoid the
4009 warning, though it may not be sufficient to avoid the overflow.
4011 @smallexample
4012 void f (int a, int b)
4014   char buf [12];
4015   sprintf (buf, "a = %i, b = %i\n", a, b);
4017 @end smallexample
4019 @item -Wformat-overflow=2
4020 Level @var{2} warns also about calls that might overflow the destination
4021 buffer given an argument of sufficient length or magnitude.  At level
4022 @var{2}, unknown numeric arguments are assumed to have the minimum
4023 representable value for signed types with a precision greater than 1, and
4024 the maximum representable value otherwise.  Unknown string arguments whose
4025 length cannot be assumed to be bounded either by the directive's precision,
4026 or by a finite set of string literals they may evaluate to, or the character
4027 array they may point to, are assumed to be 1 character long.
4029 At level @var{2}, the call in the example above is again diagnosed, but
4030 this time because with @var{a} equal to a 32-bit @code{INT_MIN} the first
4031 @code{%i} directive will write some of its digits beyond the end of
4032 the destination buffer.  To make the call safe regardless of the values
4033 of the two variables, the size of the destination buffer must be increased
4034 to at least 34 bytes.  GCC includes the minimum size of the buffer in
4035 an informational note following the warning.
4037 An alternative to increasing the size of the destination buffer is to
4038 constrain the range of formatted values.  The maximum length of string
4039 arguments can be bounded by specifying the precision in the format
4040 directive.  When numeric arguments of format directives can be assumed
4041 to be bounded by less than the precision of their type, choosing
4042 an appropriate length modifier to the format specifier will reduce
4043 the required buffer size.  For example, if @var{a} and @var{b} in the
4044 example above can be assumed to be within the precision of
4045 the @code{short int} type then using either the @code{%hi} format
4046 directive or casting the argument to @code{short} reduces the maximum
4047 required size of the buffer to 24 bytes.
4049 @smallexample
4050 void f (int a, int b)
4052   char buf [23];
4053   sprintf (buf, "a = %hi, b = %i\n", a, (short)b);
4055 @end smallexample
4056 @end table
4058 @item -Wno-format-zero-length
4059 @opindex Wno-format-zero-length
4060 @opindex Wformat-zero-length
4061 If @option{-Wformat} is specified, do not warn about zero-length formats.
4062 The C standard specifies that zero-length formats are allowed.
4065 @item -Wformat=2
4066 @opindex Wformat=2
4067 Enable @option{-Wformat} plus additional format checks.  Currently
4068 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
4069 -Wformat-y2k}.
4071 @item -Wformat-nonliteral
4072 @opindex Wformat-nonliteral
4073 @opindex Wno-format-nonliteral
4074 If @option{-Wformat} is specified, also warn if the format string is not a
4075 string literal and so cannot be checked, unless the format function
4076 takes its format arguments as a @code{va_list}.
4078 @item -Wformat-security
4079 @opindex Wformat-security
4080 @opindex Wno-format-security
4081 If @option{-Wformat} is specified, also warn about uses of format
4082 functions that represent possible security problems.  At present, this
4083 warns about calls to @code{printf} and @code{scanf} functions where the
4084 format string is not a string literal and there are no format arguments,
4085 as in @code{printf (foo);}.  This may be a security hole if the format
4086 string came from untrusted input and contains @samp{%n}.  (This is
4087 currently a subset of what @option{-Wformat-nonliteral} warns about, but
4088 in future warnings may be added to @option{-Wformat-security} that are not
4089 included in @option{-Wformat-nonliteral}.)
4091 @item -Wformat-signedness
4092 @opindex Wformat-signedness
4093 @opindex Wno-format-signedness
4094 If @option{-Wformat} is specified, also warn if the format string
4095 requires an unsigned argument and the argument is signed and vice versa.
4097 @item -Wformat-truncation
4098 @itemx -Wformat-truncation=@var{level}
4099 @opindex Wformat-truncation
4100 @opindex Wno-format-truncation
4101 Warn about calls to formatted input/output functions such as @code{snprintf}
4102 and @code{vsnprintf} that might result in output truncation.  When the exact
4103 number of bytes written by a format directive cannot be determined at
4104 compile-time it is estimated based on heuristics that depend on
4105 the @var{level} argument and on optimization.  While enabling optimization
4106 will in most cases improve the accuracy of the warning, it may also result
4107 in false positives.  Except as noted otherwise, the option uses the same
4108 logic @option{-Wformat-overflow}.
4110 @table @gcctabopt
4111 @item -Wformat-truncation
4112 @item -Wformat-truncation=1
4113 @opindex Wformat-truncation
4114 @opindex Wno-format-overflow
4115 Level @var{1} of @option{-Wformat-truncation} enabled by @option{-Wformat}
4116 employs a conservative approach that warns only about calls to bounded
4117 functions whose return value is unused and that will most likely result
4118 in output truncation.
4120 @item -Wformat-truncation=2
4121 Level @var{2} warns also about calls to bounded functions whose return
4122 value is used and that might result in truncation given an argument of
4123 sufficient length or magnitude.
4124 @end table
4126 @item -Wformat-y2k
4127 @opindex Wformat-y2k
4128 @opindex Wno-format-y2k
4129 If @option{-Wformat} is specified, also warn about @code{strftime}
4130 formats that may yield only a two-digit year.
4131 @end table
4133 @item -Wnonnull
4134 @opindex Wnonnull
4135 @opindex Wno-nonnull
4136 Warn about passing a null pointer for arguments marked as
4137 requiring a non-null value by the @code{nonnull} function attribute.
4139 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
4140 can be disabled with the @option{-Wno-nonnull} option.
4142 @item -Wnonnull-compare
4143 @opindex Wnonnull-compare
4144 @opindex Wno-nonnull-compare
4145 Warn when comparing an argument marked with the @code{nonnull}
4146 function attribute against null inside the function.
4148 @option{-Wnonnull-compare} is included in @option{-Wall}.  It
4149 can be disabled with the @option{-Wno-nonnull-compare} option.
4151 @item -Wnull-dereference
4152 @opindex Wnull-dereference
4153 @opindex Wno-null-dereference
4154 Warn if the compiler detects paths that trigger erroneous or
4155 undefined behavior due to dereferencing a null pointer.  This option
4156 is only active when @option{-fdelete-null-pointer-checks} is active,
4157 which is enabled by optimizations in most targets.  The precision of
4158 the warnings depends on the optimization options used.
4160 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
4161 @opindex Winit-self
4162 @opindex Wno-init-self
4163 Warn about uninitialized variables that are initialized with themselves.
4164 Note this option can only be used with the @option{-Wuninitialized} option.
4166 For example, GCC warns about @code{i} being uninitialized in the
4167 following snippet only when @option{-Winit-self} has been specified:
4168 @smallexample
4169 @group
4170 int f()
4172   int i = i;
4173   return i;
4175 @end group
4176 @end smallexample
4178 This warning is enabled by @option{-Wall} in C++.
4180 @item -Wimplicit-int @r{(C and Objective-C only)}
4181 @opindex Wimplicit-int
4182 @opindex Wno-implicit-int
4183 Warn when a declaration does not specify a type.
4184 This warning is enabled by @option{-Wall}.
4186 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
4187 @opindex Wimplicit-function-declaration
4188 @opindex Wno-implicit-function-declaration
4189 Give a warning whenever a function is used before being declared. In
4190 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
4191 enabled by default and it is made into an error by
4192 @option{-pedantic-errors}. This warning is also enabled by
4193 @option{-Wall}.
4195 @item -Wimplicit @r{(C and Objective-C only)}
4196 @opindex Wimplicit
4197 @opindex Wno-implicit
4198 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
4199 This warning is enabled by @option{-Wall}.
4201 @item -Wimplicit-fallthrough
4202 @opindex Wimplicit-fallthrough
4203 @opindex Wno-implicit-fallthrough
4204 @option{-Wimplicit-fallthrough} is the same as @option{-Wimplicit-fallthrough=3}
4205 and @option{-Wno-implicit-fallthrough} is the same as
4206 @option{-Wimplicit-fallthrough=0}.
4208 @item -Wimplicit-fallthrough=@var{n}
4209 @opindex Wimplicit-fallthrough=
4210 Warn when a switch case falls through.  For example:
4212 @smallexample
4213 @group
4214 switch (cond)
4215   @{
4216   case 1:
4217     a = 1;
4218     break;
4219   case 2:
4220     a = 2;
4221   case 3:
4222     a = 3;
4223     break;
4224   @}
4225 @end group
4226 @end smallexample
4228 This warning does not warn when the last statement of a case cannot
4229 fall through, e.g. when there is a return statement or a call to function
4230 declared with the noreturn attribute.  @option{-Wimplicit-fallthrough=}
4231 also takes into account control flow statements, such as ifs, and only
4232 warns when appropriate.  E.g.@:
4234 @smallexample
4235 @group
4236 switch (cond)
4237   @{
4238   case 1:
4239     if (i > 3) @{
4240       bar (5);
4241       break;
4242     @} else if (i < 1) @{
4243       bar (0);
4244     @} else
4245       return;
4246   default:
4247     @dots{}
4248   @}
4249 @end group
4250 @end smallexample
4252 Since there are occasions where a switch case fall through is desirable,
4253 GCC provides an attribute, @code{__attribute__ ((fallthrough))}, that is
4254 to be used along with a null statement to suppress this warning that
4255 would normally occur:
4257 @smallexample
4258 @group
4259 switch (cond)
4260   @{
4261   case 1:
4262     bar (0);
4263     __attribute__ ((fallthrough));
4264   default:
4265     @dots{}
4266   @}
4267 @end group
4268 @end smallexample
4270 C++17 provides a standard way to suppress the @option{-Wimplicit-fallthrough}
4271 warning using @code{[[fallthrough]];} instead of the GNU attribute.  In C++11
4272 or C++14 users can use @code{[[gnu::fallthrough]];}, which is a GNU extension.
4273 Instead of the these attributes, it is also possible to add a fallthrough
4274 comment to silence the warning.  The whole body of the C or C++ style comment
4275 should match the given regular expressions listed below.  The option argument
4276 @var{n} specifies what kind of comments are accepted:
4278 @itemize @bullet
4280 @item @option{-Wimplicit-fallthrough=0} disables the warning altogether.
4282 @item @option{-Wimplicit-fallthrough=1} matches @code{.*} regular
4283 expression, any comment is used as fallthrough comment.
4285 @item @option{-Wimplicit-fallthrough=2} case insensitively matches
4286 @code{.*falls?[ \t-]*thr(ough|u).*} regular expression.
4288 @item @option{-Wimplicit-fallthrough=3} case sensitively matches one of the
4289 following regular expressions:
4291 @itemize @bullet
4293 @item @code{-fallthrough}
4295 @item @code{@@fallthrough@@}
4297 @item @code{lint -fallthrough[ \t]*}
4299 @item @code{[ \t.!]*(ELSE,? |INTENTIONAL(LY)? )?@*FALL(S | |-)?THR(OUGH|U)[ \t.!]*(-[^\n\r]*)?}
4301 @item @code{[ \t.!]*(Else,? |Intentional(ly)? )?@*Fall((s | |-)[Tt]|t)hr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4303 @item @code{[ \t.!]*([Ee]lse,? |[Ii]ntentional(ly)? )?@*fall(s | |-)?thr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4305 @end itemize
4307 @item @option{-Wimplicit-fallthrough=4} case sensitively matches one of the
4308 following regular expressions:
4310 @itemize @bullet
4312 @item @code{-fallthrough}
4314 @item @code{@@fallthrough@@}
4316 @item @code{lint -fallthrough[ \t]*}
4318 @item @code{[ \t]*FALLTHR(OUGH|U)[ \t]*}
4320 @end itemize
4322 @item @option{-Wimplicit-fallthrough=5} doesn't recognize any comments as
4323 fallthrough comments, only attributes disable the warning.
4325 @end itemize
4327 The comment needs to be followed after optional whitespace and other comments
4328 by @code{case} or @code{default} keywords or by a user label that precedes some
4329 @code{case} or @code{default} label.
4331 @smallexample
4332 @group
4333 switch (cond)
4334   @{
4335   case 1:
4336     bar (0);
4337     /* FALLTHRU */
4338   default:
4339     @dots{}
4340   @}
4341 @end group
4342 @end smallexample
4344 The @option{-Wimplicit-fallthrough=3} warning is enabled by @option{-Wextra}.
4346 @item -Wignored-qualifiers @r{(C and C++ only)}
4347 @opindex Wignored-qualifiers
4348 @opindex Wno-ignored-qualifiers
4349 Warn if the return type of a function has a type qualifier
4350 such as @code{const}.  For ISO C such a type qualifier has no effect,
4351 since the value returned by a function is not an lvalue.
4352 For C++, the warning is only emitted for scalar types or @code{void}.
4353 ISO C prohibits qualified @code{void} return types on function
4354 definitions, so such return types always receive a warning
4355 even without this option.
4357 This warning is also enabled by @option{-Wextra}.
4359 @item -Wignored-attributes @r{(C and C++ only)}
4360 @opindex Wignored-attributes
4361 @opindex Wno-ignored-attributes
4362 Warn when an attribute is ignored.  This is different from the
4363 @option{-Wattributes} option in that it warns whenever the compiler decides
4364 to drop an attribute, not that the attribute is either unknown, used in a
4365 wrong place, etc.  This warning is enabled by default.
4367 @item -Wmain
4368 @opindex Wmain
4369 @opindex Wno-main
4370 Warn if the type of @code{main} is suspicious.  @code{main} should be
4371 a function with external linkage, returning int, taking either zero
4372 arguments, two, or three arguments of appropriate types.  This warning
4373 is enabled by default in C++ and is enabled by either @option{-Wall}
4374 or @option{-Wpedantic}.
4376 @item -Wmisleading-indentation @r{(C and C++ only)}
4377 @opindex Wmisleading-indentation
4378 @opindex Wno-misleading-indentation
4379 Warn when the indentation of the code does not reflect the block structure.
4380 Specifically, a warning is issued for @code{if}, @code{else}, @code{while}, and
4381 @code{for} clauses with a guarded statement that does not use braces,
4382 followed by an unguarded statement with the same indentation.
4384 In the following example, the call to ``bar'' is misleadingly indented as
4385 if it were guarded by the ``if'' conditional.
4387 @smallexample
4388   if (some_condition ())
4389     foo ();
4390     bar ();  /* Gotcha: this is not guarded by the "if".  */
4391 @end smallexample
4393 In the case of mixed tabs and spaces, the warning uses the
4394 @option{-ftabstop=} option to determine if the statements line up
4395 (defaulting to 8).
4397 The warning is not issued for code involving multiline preprocessor logic
4398 such as the following example.
4400 @smallexample
4401   if (flagA)
4402     foo (0);
4403 #if SOME_CONDITION_THAT_DOES_NOT_HOLD
4404   if (flagB)
4405 #endif
4406     foo (1);
4407 @end smallexample
4409 The warning is not issued after a @code{#line} directive, since this
4410 typically indicates autogenerated code, and no assumptions can be made
4411 about the layout of the file that the directive references.
4413 This warning is enabled by @option{-Wall} in C and C++.
4415 @item -Wmissing-braces
4416 @opindex Wmissing-braces
4417 @opindex Wno-missing-braces
4418 Warn if an aggregate or union initializer is not fully bracketed.  In
4419 the following example, the initializer for @code{a} is not fully
4420 bracketed, but that for @code{b} is fully bracketed.  This warning is
4421 enabled by @option{-Wall} in C.
4423 @smallexample
4424 int a[2][2] = @{ 0, 1, 2, 3 @};
4425 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
4426 @end smallexample
4428 This warning is enabled by @option{-Wall}.
4430 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
4431 @opindex Wmissing-include-dirs
4432 @opindex Wno-missing-include-dirs
4433 Warn if a user-supplied include directory does not exist.
4435 @item -Wparentheses
4436 @opindex Wparentheses
4437 @opindex Wno-parentheses
4438 Warn if parentheses are omitted in certain contexts, such
4439 as when there is an assignment in a context where a truth value
4440 is expected, or when operators are nested whose precedence people
4441 often get confused about.
4443 Also warn if a comparison like @code{x<=y<=z} appears; this is
4444 equivalent to @code{(x<=y ? 1 : 0) <= z}, which is a different
4445 interpretation from that of ordinary mathematical notation.
4447 Also warn for dangerous uses of the GNU extension to
4448 @code{?:} with omitted middle operand. When the condition
4449 in the @code{?}: operator is a boolean expression, the omitted value is
4450 always 1.  Often programmers expect it to be a value computed
4451 inside the conditional expression instead.
4453 This warning is enabled by @option{-Wall}.
4455 @item -Wsequence-point
4456 @opindex Wsequence-point
4457 @opindex Wno-sequence-point
4458 Warn about code that may have undefined semantics because of violations
4459 of sequence point rules in the C and C++ standards.
4461 The C and C++ standards define the order in which expressions in a C/C++
4462 program are evaluated in terms of @dfn{sequence points}, which represent
4463 a partial ordering between the execution of parts of the program: those
4464 executed before the sequence point, and those executed after it.  These
4465 occur after the evaluation of a full expression (one which is not part
4466 of a larger expression), after the evaluation of the first operand of a
4467 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
4468 function is called (but after the evaluation of its arguments and the
4469 expression denoting the called function), and in certain other places.
4470 Other than as expressed by the sequence point rules, the order of
4471 evaluation of subexpressions of an expression is not specified.  All
4472 these rules describe only a partial order rather than a total order,
4473 since, for example, if two functions are called within one expression
4474 with no sequence point between them, the order in which the functions
4475 are called is not specified.  However, the standards committee have
4476 ruled that function calls do not overlap.
4478 It is not specified when between sequence points modifications to the
4479 values of objects take effect.  Programs whose behavior depends on this
4480 have undefined behavior; the C and C++ standards specify that ``Between
4481 the previous and next sequence point an object shall have its stored
4482 value modified at most once by the evaluation of an expression.
4483 Furthermore, the prior value shall be read only to determine the value
4484 to be stored.''.  If a program breaks these rules, the results on any
4485 particular implementation are entirely unpredictable.
4487 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
4488 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
4489 diagnosed by this option, and it may give an occasional false positive
4490 result, but in general it has been found fairly effective at detecting
4491 this sort of problem in programs.
4493 The C++17 standard will define the order of evaluation of operands in
4494 more cases: in particular it requires that the right-hand side of an
4495 assignment be evaluated before the left-hand side, so the above
4496 examples are no longer undefined.  But this warning will still warn
4497 about them, to help people avoid writing code that is undefined in C
4498 and earlier revisions of C++.
4500 The standard is worded confusingly, therefore there is some debate
4501 over the precise meaning of the sequence point rules in subtle cases.
4502 Links to discussions of the problem, including proposed formal
4503 definitions, may be found on the GCC readings page, at
4504 @uref{http://gcc.gnu.org/@/readings.html}.
4506 This warning is enabled by @option{-Wall} for C and C++.
4508 @item -Wno-return-local-addr
4509 @opindex Wno-return-local-addr
4510 @opindex Wreturn-local-addr
4511 Do not warn about returning a pointer (or in C++, a reference) to a
4512 variable that goes out of scope after the function returns.
4514 @item -Wreturn-type
4515 @opindex Wreturn-type
4516 @opindex Wno-return-type
4517 Warn whenever a function is defined with a return type that defaults
4518 to @code{int}.  Also warn about any @code{return} statement with no
4519 return value in a function whose return type is not @code{void}
4520 (falling off the end of the function body is considered returning
4521 without a value).
4523 For C only, warn about a @code{return} statement with an expression in a
4524 function whose return type is @code{void}, unless the expression type is
4525 also @code{void}.  As a GNU extension, the latter case is accepted
4526 without a warning unless @option{-Wpedantic} is used.
4528 For C++, a function without return type always produces a diagnostic
4529 message, even when @option{-Wno-return-type} is specified.  The only
4530 exceptions are @code{main} and functions defined in system headers.
4532 This warning is enabled by @option{-Wall}.
4534 @item -Wshift-count-negative
4535 @opindex Wshift-count-negative
4536 @opindex Wno-shift-count-negative
4537 Warn if shift count is negative. This warning is enabled by default.
4539 @item -Wshift-count-overflow
4540 @opindex Wshift-count-overflow
4541 @opindex Wno-shift-count-overflow
4542 Warn if shift count >= width of type. This warning is enabled by default.
4544 @item -Wshift-negative-value
4545 @opindex Wshift-negative-value
4546 @opindex Wno-shift-negative-value
4547 Warn if left shifting a negative value.  This warning is enabled by
4548 @option{-Wextra} in C99 and C++11 modes (and newer).
4550 @item -Wshift-overflow
4551 @itemx -Wshift-overflow=@var{n}
4552 @opindex Wshift-overflow
4553 @opindex Wno-shift-overflow
4554 Warn about left shift overflows.  This warning is enabled by
4555 default in C99 and C++11 modes (and newer).
4557 @table @gcctabopt
4558 @item -Wshift-overflow=1
4559 This is the warning level of @option{-Wshift-overflow} and is enabled
4560 by default in C99 and C++11 modes (and newer).  This warning level does
4561 not warn about left-shifting 1 into the sign bit.  (However, in C, such
4562 an overflow is still rejected in contexts where an integer constant expression
4563 is required.)
4565 @item -Wshift-overflow=2
4566 This warning level also warns about left-shifting 1 into the sign bit,
4567 unless C++14 mode is active.
4568 @end table
4570 @item -Wswitch
4571 @opindex Wswitch
4572 @opindex Wno-switch
4573 Warn whenever a @code{switch} statement has an index of enumerated type
4574 and lacks a @code{case} for one or more of the named codes of that
4575 enumeration.  (The presence of a @code{default} label prevents this
4576 warning.)  @code{case} labels outside the enumeration range also
4577 provoke warnings when this option is used (even if there is a
4578 @code{default} label).
4579 This warning is enabled by @option{-Wall}.
4581 @item -Wswitch-default
4582 @opindex Wswitch-default
4583 @opindex Wno-switch-default
4584 Warn whenever a @code{switch} statement does not have a @code{default}
4585 case.
4587 @item -Wswitch-enum
4588 @opindex Wswitch-enum
4589 @opindex Wno-switch-enum
4590 Warn whenever a @code{switch} statement has an index of enumerated type
4591 and lacks a @code{case} for one or more of the named codes of that
4592 enumeration.  @code{case} labels outside the enumeration range also
4593 provoke warnings when this option is used.  The only difference
4594 between @option{-Wswitch} and this option is that this option gives a
4595 warning about an omitted enumeration code even if there is a
4596 @code{default} label.
4598 @item -Wswitch-bool
4599 @opindex Wswitch-bool
4600 @opindex Wno-switch-bool
4601 Warn whenever a @code{switch} statement has an index of boolean type
4602 and the case values are outside the range of a boolean type.
4603 It is possible to suppress this warning by casting the controlling
4604 expression to a type other than @code{bool}.  For example:
4605 @smallexample
4606 @group
4607 switch ((int) (a == 4))
4608   @{
4609   @dots{}
4610   @}
4611 @end group
4612 @end smallexample
4613 This warning is enabled by default for C and C++ programs.
4615 @item -Wswitch-unreachable
4616 @opindex Wswitch-unreachable
4617 @opindex Wno-switch-unreachable
4618 Warn whenever a @code{switch} statement contains statements between the
4619 controlling expression and the first case label, which will never be
4620 executed.  For example:
4621 @smallexample
4622 @group
4623 switch (cond)
4624   @{
4625    i = 15;
4626   @dots{}
4627    case 5:
4628   @dots{}
4629   @}
4630 @end group
4631 @end smallexample
4632 @option{-Wswitch-unreachable} does not warn if the statement between the
4633 controlling expression and the first case label is just a declaration:
4634 @smallexample
4635 @group
4636 switch (cond)
4637   @{
4638    int i;
4639   @dots{}
4640    case 5:
4641    i = 5;
4642   @dots{}
4643   @}
4644 @end group
4645 @end smallexample
4646 This warning is enabled by default for C and C++ programs.
4648 @item -Wsync-nand @r{(C and C++ only)}
4649 @opindex Wsync-nand
4650 @opindex Wno-sync-nand
4651 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
4652 built-in functions are used.  These functions changed semantics in GCC 4.4.
4654 @item -Wunused-but-set-parameter
4655 @opindex Wunused-but-set-parameter
4656 @opindex Wno-unused-but-set-parameter
4657 Warn whenever a function parameter is assigned to, but otherwise unused
4658 (aside from its declaration).
4660 To suppress this warning use the @code{unused} attribute
4661 (@pxref{Variable Attributes}).
4663 This warning is also enabled by @option{-Wunused} together with
4664 @option{-Wextra}.
4666 @item -Wunused-but-set-variable
4667 @opindex Wunused-but-set-variable
4668 @opindex Wno-unused-but-set-variable
4669 Warn whenever a local variable is assigned to, but otherwise unused
4670 (aside from its declaration).
4671 This warning is enabled by @option{-Wall}.
4673 To suppress this warning use the @code{unused} attribute
4674 (@pxref{Variable Attributes}).
4676 This warning is also enabled by @option{-Wunused}, which is enabled
4677 by @option{-Wall}.
4679 @item -Wunused-function
4680 @opindex Wunused-function
4681 @opindex Wno-unused-function
4682 Warn whenever a static function is declared but not defined or a
4683 non-inline static function is unused.
4684 This warning is enabled by @option{-Wall}.
4686 @item -Wunused-label
4687 @opindex Wunused-label
4688 @opindex Wno-unused-label
4689 Warn whenever a label is declared but not used.
4690 This warning is enabled by @option{-Wall}.
4692 To suppress this warning use the @code{unused} attribute
4693 (@pxref{Variable Attributes}).
4695 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
4696 @opindex Wunused-local-typedefs
4697 Warn when a typedef locally defined in a function is not used.
4698 This warning is enabled by @option{-Wall}.
4700 @item -Wunused-parameter
4701 @opindex Wunused-parameter
4702 @opindex Wno-unused-parameter
4703 Warn whenever a function parameter is unused aside from its declaration.
4705 To suppress this warning use the @code{unused} attribute
4706 (@pxref{Variable Attributes}).
4708 @item -Wno-unused-result
4709 @opindex Wunused-result
4710 @opindex Wno-unused-result
4711 Do not warn if a caller of a function marked with attribute
4712 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
4713 its return value. The default is @option{-Wunused-result}.
4715 @item -Wunused-variable
4716 @opindex Wunused-variable
4717 @opindex Wno-unused-variable
4718 Warn whenever a local or static variable is unused aside from its
4719 declaration. This option implies @option{-Wunused-const-variable=1} for C,
4720 but not for C++. This warning is enabled by @option{-Wall}.
4722 To suppress this warning use the @code{unused} attribute
4723 (@pxref{Variable Attributes}).
4725 @item -Wunused-const-variable
4726 @itemx -Wunused-const-variable=@var{n}
4727 @opindex Wunused-const-variable
4728 @opindex Wno-unused-const-variable
4729 Warn whenever a constant static variable is unused aside from its declaration.
4730 @option{-Wunused-const-variable=1} is enabled by @option{-Wunused-variable}
4731 for C, but not for C++. In C this declares variable storage, but in C++ this
4732 is not an error since const variables take the place of @code{#define}s.
4734 To suppress this warning use the @code{unused} attribute
4735 (@pxref{Variable Attributes}).
4737 @table @gcctabopt
4738 @item -Wunused-const-variable=1
4739 This is the warning level that is enabled by @option{-Wunused-variable} for
4740 C.  It warns only about unused static const variables defined in the main
4741 compilation unit, but not about static const variables declared in any
4742 header included.
4744 @item -Wunused-const-variable=2
4745 This warning level also warns for unused constant static variables in
4746 headers (excluding system headers).  This is the warning level of
4747 @option{-Wunused-const-variable} and must be explicitly requested since
4748 in C++ this isn't an error and in C it might be harder to clean up all
4749 headers included.
4750 @end table
4752 @item -Wunused-value
4753 @opindex Wunused-value
4754 @opindex Wno-unused-value
4755 Warn whenever a statement computes a result that is explicitly not
4756 used. To suppress this warning cast the unused expression to
4757 @code{void}. This includes an expression-statement or the left-hand
4758 side of a comma expression that contains no side effects. For example,
4759 an expression such as @code{x[i,j]} causes a warning, while
4760 @code{x[(void)i,j]} does not.
4762 This warning is enabled by @option{-Wall}.
4764 @item -Wunused
4765 @opindex Wunused
4766 @opindex Wno-unused
4767 All the above @option{-Wunused} options combined.
4769 In order to get a warning about an unused function parameter, you must
4770 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
4771 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
4773 @item -Wuninitialized
4774 @opindex Wuninitialized
4775 @opindex Wno-uninitialized
4776 Warn if an automatic variable is used without first being initialized
4777 or if a variable may be clobbered by a @code{setjmp} call. In C++,
4778 warn if a non-static reference or non-static @code{const} member
4779 appears in a class without constructors.
4781 If you want to warn about code that uses the uninitialized value of the
4782 variable in its own initializer, use the @option{-Winit-self} option.
4784 These warnings occur for individual uninitialized or clobbered
4785 elements of structure, union or array variables as well as for
4786 variables that are uninitialized or clobbered as a whole.  They do
4787 not occur for variables or elements declared @code{volatile}.  Because
4788 these warnings depend on optimization, the exact variables or elements
4789 for which there are warnings depends on the precise optimization
4790 options and version of GCC used.
4792 Note that there may be no warning about a variable that is used only
4793 to compute a value that itself is never used, because such
4794 computations may be deleted by data flow analysis before the warnings
4795 are printed.
4797 @item -Winvalid-memory-model
4798 @opindex Winvalid-memory-model
4799 @opindex Wno-invalid-memory-model
4800 Warn for invocations of @ref{__atomic Builtins}, @ref{__sync Builtins},
4801 and the C11 atomic generic functions with a memory consistency argument
4802 that is either invalid for the operation or outside the range of values
4803 of the @code{memory_order} enumeration.  For example, since the
4804 @code{__atomic_store} and @code{__atomic_store_n} built-ins are only
4805 defined for the relaxed, release, and sequentially consistent memory
4806 orders the following code is diagnosed:
4808 @smallexample
4809 void store (int *i)
4811   __atomic_store_n (i, 0, memory_order_consume);
4813 @end smallexample
4815 @option{-Winvalid-memory-model} is enabled by default.
4817 @item -Wmaybe-uninitialized
4818 @opindex Wmaybe-uninitialized
4819 @opindex Wno-maybe-uninitialized
4820 For an automatic variable, if there exists a path from the function
4821 entry to a use of the variable that is initialized, but there exist
4822 some other paths for which the variable is not initialized, the compiler
4823 emits a warning if it cannot prove the uninitialized paths are not
4824 executed at run time. These warnings are made optional because GCC is
4825 not smart enough to see all the reasons why the code might be correct
4826 in spite of appearing to have an error.  Here is one example of how
4827 this can happen:
4829 @smallexample
4830 @group
4832   int x;
4833   switch (y)
4834     @{
4835     case 1: x = 1;
4836       break;
4837     case 2: x = 4;
4838       break;
4839     case 3: x = 5;
4840     @}
4841   foo (x);
4843 @end group
4844 @end smallexample
4846 @noindent
4847 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
4848 always initialized, but GCC doesn't know this. To suppress the
4849 warning, you need to provide a default case with assert(0) or
4850 similar code.
4852 @cindex @code{longjmp} warnings
4853 This option also warns when a non-volatile automatic variable might be
4854 changed by a call to @code{longjmp}.  These warnings as well are possible
4855 only in optimizing compilation.
4857 The compiler sees only the calls to @code{setjmp}.  It cannot know
4858 where @code{longjmp} will be called; in fact, a signal handler could
4859 call it at any point in the code.  As a result, you may get a warning
4860 even when there is in fact no problem because @code{longjmp} cannot
4861 in fact be called at the place that would cause a problem.
4863 Some spurious warnings can be avoided if you declare all the functions
4864 you use that never return as @code{noreturn}.  @xref{Function
4865 Attributes}.
4867 This warning is enabled by @option{-Wall} or @option{-Wextra}.
4869 @item -Wunknown-pragmas
4870 @opindex Wunknown-pragmas
4871 @opindex Wno-unknown-pragmas
4872 @cindex warning for unknown pragmas
4873 @cindex unknown pragmas, warning
4874 @cindex pragmas, warning of unknown
4875 Warn when a @code{#pragma} directive is encountered that is not understood by 
4876 GCC@.  If this command-line option is used, warnings are even issued
4877 for unknown pragmas in system header files.  This is not the case if
4878 the warnings are only enabled by the @option{-Wall} command-line option.
4880 @item -Wno-pragmas
4881 @opindex Wno-pragmas
4882 @opindex Wpragmas
4883 Do not warn about misuses of pragmas, such as incorrect parameters,
4884 invalid syntax, or conflicts between pragmas.  See also
4885 @option{-Wunknown-pragmas}.
4887 @item -Wstrict-aliasing
4888 @opindex Wstrict-aliasing
4889 @opindex Wno-strict-aliasing
4890 This option is only active when @option{-fstrict-aliasing} is active.
4891 It warns about code that might break the strict aliasing rules that the
4892 compiler is using for optimization.  The warning does not catch all
4893 cases, but does attempt to catch the more common pitfalls.  It is
4894 included in @option{-Wall}.
4895 It is equivalent to @option{-Wstrict-aliasing=3}
4897 @item -Wstrict-aliasing=n
4898 @opindex Wstrict-aliasing=n
4899 This option is only active when @option{-fstrict-aliasing} is active.
4900 It warns about code that might break the strict aliasing rules that the
4901 compiler is using for optimization.
4902 Higher levels correspond to higher accuracy (fewer false positives).
4903 Higher levels also correspond to more effort, similar to the way @option{-O} 
4904 works.
4905 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
4907 Level 1: Most aggressive, quick, least accurate.
4908 Possibly useful when higher levels
4909 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
4910 false negatives.  However, it has many false positives.
4911 Warns for all pointer conversions between possibly incompatible types,
4912 even if never dereferenced.  Runs in the front end only.
4914 Level 2: Aggressive, quick, not too precise.
4915 May still have many false positives (not as many as level 1 though),
4916 and few false negatives (but possibly more than level 1).
4917 Unlike level 1, it only warns when an address is taken.  Warns about
4918 incomplete types.  Runs in the front end only.
4920 Level 3 (default for @option{-Wstrict-aliasing}):
4921 Should have very few false positives and few false
4922 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
4923 Takes care of the common pun+dereference pattern in the front end:
4924 @code{*(int*)&some_float}.
4925 If optimization is enabled, it also runs in the back end, where it deals
4926 with multiple statement cases using flow-sensitive points-to information.
4927 Only warns when the converted pointer is dereferenced.
4928 Does not warn about incomplete types.
4930 @item -Wstrict-overflow
4931 @itemx -Wstrict-overflow=@var{n}
4932 @opindex Wstrict-overflow
4933 @opindex Wno-strict-overflow
4934 This option is only active when @option{-fstrict-overflow} is active.
4935 It warns about cases where the compiler optimizes based on the
4936 assumption that signed overflow does not occur.  Note that it does not
4937 warn about all cases where the code might overflow: it only warns
4938 about cases where the compiler implements some optimization.  Thus
4939 this warning depends on the optimization level.
4941 An optimization that assumes that signed overflow does not occur is
4942 perfectly safe if the values of the variables involved are such that
4943 overflow never does, in fact, occur.  Therefore this warning can
4944 easily give a false positive: a warning about code that is not
4945 actually a problem.  To help focus on important issues, several
4946 warning levels are defined.  No warnings are issued for the use of
4947 undefined signed overflow when estimating how many iterations a loop
4948 requires, in particular when determining whether a loop will be
4949 executed at all.
4951 @table @gcctabopt
4952 @item -Wstrict-overflow=1
4953 Warn about cases that are both questionable and easy to avoid.  For
4954 example,  with @option{-fstrict-overflow}, the compiler simplifies
4955 @code{x + 1 > x} to @code{1}.  This level of
4956 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
4957 are not, and must be explicitly requested.
4959 @item -Wstrict-overflow=2
4960 Also warn about other cases where a comparison is simplified to a
4961 constant.  For example: @code{abs (x) >= 0}.  This can only be
4962 simplified when @option{-fstrict-overflow} is in effect, because
4963 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
4964 zero.  @option{-Wstrict-overflow} (with no level) is the same as
4965 @option{-Wstrict-overflow=2}.
4967 @item -Wstrict-overflow=3
4968 Also warn about other cases where a comparison is simplified.  For
4969 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
4971 @item -Wstrict-overflow=4
4972 Also warn about other simplifications not covered by the above cases.
4973 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
4975 @item -Wstrict-overflow=5
4976 Also warn about cases where the compiler reduces the magnitude of a
4977 constant involved in a comparison.  For example: @code{x + 2 > y} is
4978 simplified to @code{x + 1 >= y}.  This is reported only at the
4979 highest warning level because this simplification applies to many
4980 comparisons, so this warning level gives a very large number of
4981 false positives.
4982 @end table
4984 @item -Wstringop-overflow
4985 @itemx -Wstringop-overflow=@var{type}
4986 @opindex Wstringop-overflow
4987 @opindex Wno-stringop-overflow
4988 Warn for calls to string manipulation functions such as @code{memcpy} and
4989 @code{strcpy} that are determined to overflow the destination buffer.  The
4990 optional argument is one greater than the type of Object Size Checking to
4991 perform to determine the size of the destination.  @xref{Object Size Checking}.
4992 The argument is meaningful only for functions that operate on character arrays
4993 but not for raw memory functions like @code{memcpy} which always make use
4994 of Object Size type-0.  The option also warns for calls that specify a size
4995 in excess of the largest possible object or at most @code{SIZE_MAX / 2} bytes.
4996 The option produces the best results with optimization enabled but can detect
4997 a small subset of simple buffer overflows even without optimization in
4998 calls to the GCC built-in functions like @code{__builtin_memcpy} that
4999 correspond to the standard functions.  In any case, the option warns about
5000 just a subset of buffer overflows detected by the corresponding overflow
5001 checking built-ins.  For example, the option will issue a warning for
5002 the @code{strcpy} call below because it copies at least 5 characters
5003 (the string @code{"blue"} including the terminating NUL) into the buffer
5004 of size 4.
5006 @smallexample
5007 enum Color @{ blue, purple, yellow @};
5008 const char* f (enum Color clr)
5010   static char buf [4];
5011   const char *str;
5012   switch (clr)
5013     @{
5014       case blue: str = "blue"; break;
5015       case purple: str = "purple"; break;
5016       case yellow: str = "yellow"; break;
5017     @}
5019   return strcpy (buf, str);   // warning here
5021 @end smallexample
5023 Option @option{-Wstringop-overflow=2} is enabled by default.
5025 @table @gcctabopt
5026 @item -Wstringop-overflow
5027 @item -Wstringop-overflow=1
5028 @opindex Wstringop-overflow
5029 @opindex Wno-stringop-overflow
5030 The @option{-Wstringop-overflow=1} option uses type-zero Object Size Checking
5031 to determine the sizes of destination objects.  This is the default setting
5032 of the option.  At this setting the option will not warn for writes past
5033 the end of subobjects of larger objects accessed by pointers unless the
5034 size of the largest surrounding object is known.  When the destination may
5035 be one of several objects it is assumed to be the largest one of them.  On
5036 Linux systems, when optimization is enabled at this setting the option warns
5037 for the same code as when the @code{_FORTIFY_SOURCE} macro is defined to
5038 a non-zero value.
5040 @item -Wstringop-overflow=2
5041 The @option{-Wstringop-overflow=2} option uses type-one Object Size Checking
5042 to determine the sizes of destination objects.  At this setting the option
5043 will warn about overflows when writing to members of the largest complete
5044 objects whose exact size is known.  It will, however, not warn for excessive
5045 writes to the same members of unknown objects referenced by pointers since
5046 they may point to arrays containing unknown numbers of elements.
5048 @item -Wstringop-overflow=3
5049 The @option{-Wstringop-overflow=3} option uses type-two Object Size Checking
5050 to determine the sizes of destination objects.  At this setting the option
5051 warns about overflowing the smallest object or data member.  This is the
5052 most restrictive setting of the option that may result in warnings for safe
5053 code.
5055 @item -Wstringop-overflow=4
5056 The @option{-Wstringop-overflow=4} option uses type-three Object Size Checking
5057 to determine the sizes of destination objects.  At this setting the option
5058 will warn about overflowing any data members, and when the destination is
5059 one of several objects it uses the size of the largest of them to decide
5060 whether to issue a warning.  Similarly to @option{-Wstringop-overflow=3} this
5061 setting of the option may result in warnings for benign code.
5062 @end table
5064 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]}
5065 @opindex Wsuggest-attribute=
5066 @opindex Wno-suggest-attribute=
5067 Warn for cases where adding an attribute may be beneficial. The
5068 attributes currently supported are listed below.
5070 @table @gcctabopt
5071 @item -Wsuggest-attribute=pure
5072 @itemx -Wsuggest-attribute=const
5073 @itemx -Wsuggest-attribute=noreturn
5074 @opindex Wsuggest-attribute=pure
5075 @opindex Wno-suggest-attribute=pure
5076 @opindex Wsuggest-attribute=const
5077 @opindex Wno-suggest-attribute=const
5078 @opindex Wsuggest-attribute=noreturn
5079 @opindex Wno-suggest-attribute=noreturn
5081 Warn about functions that might be candidates for attributes
5082 @code{pure}, @code{const} or @code{noreturn}.  The compiler only warns for
5083 functions visible in other compilation units or (in the case of @code{pure} and
5084 @code{const}) if it cannot prove that the function returns normally. A function
5085 returns normally if it doesn't contain an infinite loop or return abnormally
5086 by throwing, calling @code{abort} or trapping.  This analysis requires option
5087 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
5088 higher.  Higher optimization levels improve the accuracy of the analysis.
5090 @item -Wsuggest-attribute=format
5091 @itemx -Wmissing-format-attribute
5092 @opindex Wsuggest-attribute=format
5093 @opindex Wmissing-format-attribute
5094 @opindex Wno-suggest-attribute=format
5095 @opindex Wno-missing-format-attribute
5096 @opindex Wformat
5097 @opindex Wno-format
5099 Warn about function pointers that might be candidates for @code{format}
5100 attributes.  Note these are only possible candidates, not absolute ones.
5101 GCC guesses that function pointers with @code{format} attributes that
5102 are used in assignment, initialization, parameter passing or return
5103 statements should have a corresponding @code{format} attribute in the
5104 resulting type.  I.e.@: the left-hand side of the assignment or
5105 initialization, the type of the parameter variable, or the return type
5106 of the containing function respectively should also have a @code{format}
5107 attribute to avoid the warning.
5109 GCC also warns about function definitions that might be
5110 candidates for @code{format} attributes.  Again, these are only
5111 possible candidates.  GCC guesses that @code{format} attributes
5112 might be appropriate for any function that calls a function like
5113 @code{vprintf} or @code{vscanf}, but this might not always be the
5114 case, and some functions for which @code{format} attributes are
5115 appropriate may not be detected.
5116 @end table
5118 @item -Wsuggest-final-types
5119 @opindex Wno-suggest-final-types
5120 @opindex Wsuggest-final-types
5121 Warn about types with virtual methods where code quality would be improved
5122 if the type were declared with the C++11 @code{final} specifier, 
5123 or, if possible,
5124 declared in an anonymous namespace. This allows GCC to more aggressively
5125 devirtualize the polymorphic calls. This warning is more effective with link
5126 time optimization, where the information about the class hierarchy graph is
5127 more complete.
5129 @item -Wsuggest-final-methods
5130 @opindex Wno-suggest-final-methods
5131 @opindex Wsuggest-final-methods
5132 Warn about virtual methods where code quality would be improved if the method
5133 were declared with the C++11 @code{final} specifier, 
5134 or, if possible, its type were
5135 declared in an anonymous namespace or with the @code{final} specifier.
5136 This warning is
5137 more effective with link time optimization, where the information about the
5138 class hierarchy graph is more complete. It is recommended to first consider
5139 suggestions of @option{-Wsuggest-final-types} and then rebuild with new
5140 annotations.
5142 @item -Wsuggest-override
5143 Warn about overriding virtual functions that are not marked with the override
5144 keyword.
5146 @item -Walloc-zero
5147 @opindex Wno-alloc-zero
5148 @opindex Walloc-zero
5149 Warn about calls to allocation functions decorated with attribute
5150 @code{alloc_size} that specify zero bytes, including those to the built-in
5151 forms of the functions @code{aligned_alloc}, @code{alloca}, @code{calloc},
5152 @code{malloc}, and @code{realloc}.  Because the behavior of these functions
5153 when called with a zero size differs among implementations (and in the case
5154 of @code{realloc} has been deprecated) relying on it may result in subtle
5155 portability bugs and should be avoided.
5157 @item -Walloc-size-larger-than=@var{n}
5158 Warn about calls to functions decorated with attribute @code{alloc_size}
5159 that attempt to allocate objects larger than the specified number of bytes,
5160 or where the result of the size computation in an integer type with infinite
5161 precision would exceed @code{SIZE_MAX / 2}.  The option argument @var{n}
5162 may end in one of the standard suffixes designating a multiple of bytes
5163 such as @code{kB} and @code{KiB} for kilobyte and kibibyte, respectively,
5164 @code{MB} and @code{MiB} for megabyte and mebibyte, and so on.
5165 @xref{Function Attributes}.
5167 @item -Walloca
5168 @opindex Wno-alloca
5169 @opindex Walloca
5170 This option warns on all uses of @code{alloca} in the source.
5172 @item -Walloca-larger-than=@var{n}
5173 This option warns on calls to @code{alloca} that are not bounded by a
5174 controlling predicate limiting its argument of integer type to at most
5175 @var{n} bytes, or calls to @code{alloca} where the bound is unknown.
5176 Arguments of non-integer types are considered unbounded even if they
5177 appear to be constrained to the expected range.
5179 For example, a bounded case of @code{alloca} could be:
5181 @smallexample
5182 void func (size_t n)
5184   void *p;
5185   if (n <= 1000)
5186     p = alloca (n);
5187   else
5188     p = malloc (n);
5189   f (p);
5191 @end smallexample
5193 In the above example, passing @code{-Walloca-larger-than=1000} would not
5194 issue a warning because the call to @code{alloca} is known to be at most
5195 1000 bytes.  However, if @code{-Walloca-larger-than=500} were passed,
5196 the compiler would emit a warning.
5198 Unbounded uses, on the other hand, are uses of @code{alloca} with no
5199 controlling predicate constraining its integer argument.  For example:
5201 @smallexample
5202 void func ()
5204   void *p = alloca (n);
5205   f (p);
5207 @end smallexample
5209 If @code{-Walloca-larger-than=500} were passed, the above would trigger
5210 a warning, but this time because of the lack of bounds checking.
5212 Note, that even seemingly correct code involving signed integers could
5213 cause a warning:
5215 @smallexample
5216 void func (signed int n)
5218   if (n < 500)
5219     @{
5220       p = alloca (n);
5221       f (p);
5222     @}
5224 @end smallexample
5226 In the above example, @var{n} could be negative, causing a larger than
5227 expected argument to be implicitly cast into the @code{alloca} call.
5229 This option also warns when @code{alloca} is used in a loop.
5231 This warning is not enabled by @option{-Wall}, and is only active when
5232 @option{-ftree-vrp} is active (default for @option{-O2} and above).
5234 See also @option{-Wvla-larger-than=@var{n}}.
5236 @item -Warray-bounds
5237 @itemx -Warray-bounds=@var{n}
5238 @opindex Wno-array-bounds
5239 @opindex Warray-bounds
5240 This option is only active when @option{-ftree-vrp} is active
5241 (default for @option{-O2} and above). It warns about subscripts to arrays
5242 that are always out of bounds. This warning is enabled by @option{-Wall}.
5244 @table @gcctabopt
5245 @item -Warray-bounds=1
5246 This is the warning level of @option{-Warray-bounds} and is enabled
5247 by @option{-Wall}; higher levels are not, and must be explicitly requested.
5249 @item -Warray-bounds=2
5250 This warning level also warns about out of bounds access for
5251 arrays at the end of a struct and for arrays accessed through
5252 pointers. This warning level may give a larger number of
5253 false positives and is deactivated by default.
5254 @end table
5256 @item -Wbool-compare
5257 @opindex Wno-bool-compare
5258 @opindex Wbool-compare
5259 Warn about boolean expression compared with an integer value different from
5260 @code{true}/@code{false}.  For instance, the following comparison is
5261 always false:
5262 @smallexample
5263 int n = 5;
5264 @dots{}
5265 if ((n > 1) == 2) @{ @dots{} @}
5266 @end smallexample
5267 This warning is enabled by @option{-Wall}.
5269 @item -Wbool-operation
5270 @opindex Wno-bool-operation
5271 @opindex Wbool-operation
5272 Warn about suspicious operations on expressions of a boolean type.  For
5273 instance, bitwise negation of a boolean is very likely a bug in the program.
5274 For C, this warning also warns about incrementing or decrementing a boolean,
5275 which rarely makes sense.  (In C++, decrementing a boolean is always invalid.
5276 Incrementing a boolean is invalid in C++1z, and deprecated otherwise.)
5278 This warning is enabled by @option{-Wall}.
5280 @item -Wduplicated-branches
5281 @opindex Wno-duplicated-branches
5282 @opindex Wduplicated-branches
5283 Warn when an if-else has identical branches.  This warning detects cases like
5284 @smallexample
5285 if (p != NULL)
5286   return 0;
5287 else
5288   return 0;
5289 @end smallexample
5290 It doesn't warn when both branches contain just a null statement.  This warning
5291 also warn for conditional operators:
5292 @smallexample
5293   int i = x ? *p : *p;
5294 @end smallexample
5296 @item -Wduplicated-cond
5297 @opindex Wno-duplicated-cond
5298 @opindex Wduplicated-cond
5299 Warn about duplicated conditions in an if-else-if chain.  For instance,
5300 warn for the following code:
5301 @smallexample
5302 if (p->q != NULL) @{ @dots{} @}
5303 else if (p->q != NULL) @{ @dots{} @}
5304 @end smallexample
5306 @item -Wframe-address
5307 @opindex Wno-frame-address
5308 @opindex Wframe-address
5309 Warn when the @samp{__builtin_frame_address} or @samp{__builtin_return_address}
5310 is called with an argument greater than 0.  Such calls may return indeterminate
5311 values or crash the program.  The warning is included in @option{-Wall}.
5313 @item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
5314 @opindex Wno-discarded-qualifiers
5315 @opindex Wdiscarded-qualifiers
5316 Do not warn if type qualifiers on pointers are being discarded.
5317 Typically, the compiler warns if a @code{const char *} variable is
5318 passed to a function that takes a @code{char *} parameter.  This option
5319 can be used to suppress such a warning.
5321 @item -Wno-discarded-array-qualifiers @r{(C and Objective-C only)}
5322 @opindex Wno-discarded-array-qualifiers
5323 @opindex Wdiscarded-array-qualifiers
5324 Do not warn if type qualifiers on arrays which are pointer targets
5325 are being discarded. Typically, the compiler warns if a
5326 @code{const int (*)[]} variable is passed to a function that
5327 takes a @code{int (*)[]} parameter.  This option can be used to
5328 suppress such a warning.
5330 @item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
5331 @opindex Wno-incompatible-pointer-types
5332 @opindex Wincompatible-pointer-types
5333 Do not warn when there is a conversion between pointers that have incompatible
5334 types.  This warning is for cases not covered by @option{-Wno-pointer-sign},
5335 which warns for pointer argument passing or assignment with different
5336 signedness.
5338 @item -Wno-int-conversion @r{(C and Objective-C only)}
5339 @opindex Wno-int-conversion
5340 @opindex Wint-conversion
5341 Do not warn about incompatible integer to pointer and pointer to integer
5342 conversions.  This warning is about implicit conversions; for explicit
5343 conversions the warnings @option{-Wno-int-to-pointer-cast} and
5344 @option{-Wno-pointer-to-int-cast} may be used.
5346 @item -Wno-div-by-zero
5347 @opindex Wno-div-by-zero
5348 @opindex Wdiv-by-zero
5349 Do not warn about compile-time integer division by zero.  Floating-point
5350 division by zero is not warned about, as it can be a legitimate way of
5351 obtaining infinities and NaNs.
5353 @item -Wsystem-headers
5354 @opindex Wsystem-headers
5355 @opindex Wno-system-headers
5356 @cindex warnings from system headers
5357 @cindex system headers, warnings from
5358 Print warning messages for constructs found in system header files.
5359 Warnings from system headers are normally suppressed, on the assumption
5360 that they usually do not indicate real problems and would only make the
5361 compiler output harder to read.  Using this command-line option tells
5362 GCC to emit warnings from system headers as if they occurred in user
5363 code.  However, note that using @option{-Wall} in conjunction with this
5364 option does @emph{not} warn about unknown pragmas in system
5365 headers---for that, @option{-Wunknown-pragmas} must also be used.
5367 @item -Wtautological-compare
5368 @opindex Wtautological-compare
5369 @opindex Wno-tautological-compare
5370 Warn if a self-comparison always evaluates to true or false.  This
5371 warning detects various mistakes such as:
5372 @smallexample
5373 int i = 1;
5374 @dots{}
5375 if (i > i) @{ @dots{} @}
5376 @end smallexample
5377 This warning is enabled by @option{-Wall}.
5379 @item -Wtrampolines
5380 @opindex Wtrampolines
5381 @opindex Wno-trampolines
5382 Warn about trampolines generated for pointers to nested functions.
5383 A trampoline is a small piece of data or code that is created at run
5384 time on the stack when the address of a nested function is taken, and is
5385 used to call the nested function indirectly.  For some targets, it is
5386 made up of data only and thus requires no special treatment.  But, for
5387 most targets, it is made up of code and thus requires the stack to be
5388 made executable in order for the program to work properly.
5390 @item -Wfloat-equal
5391 @opindex Wfloat-equal
5392 @opindex Wno-float-equal
5393 Warn if floating-point values are used in equality comparisons.
5395 The idea behind this is that sometimes it is convenient (for the
5396 programmer) to consider floating-point values as approximations to
5397 infinitely precise real numbers.  If you are doing this, then you need
5398 to compute (by analyzing the code, or in some other way) the maximum or
5399 likely maximum error that the computation introduces, and allow for it
5400 when performing comparisons (and when producing output, but that's a
5401 different problem).  In particular, instead of testing for equality, you
5402 should check to see whether the two values have ranges that overlap; and
5403 this is done with the relational operators, so equality comparisons are
5404 probably mistaken.
5406 @item -Wtraditional @r{(C and Objective-C only)}
5407 @opindex Wtraditional
5408 @opindex Wno-traditional
5409 Warn about certain constructs that behave differently in traditional and
5410 ISO C@.  Also warn about ISO C constructs that have no traditional C
5411 equivalent, and/or problematic constructs that should be avoided.
5413 @itemize @bullet
5414 @item
5415 Macro parameters that appear within string literals in the macro body.
5416 In traditional C macro replacement takes place within string literals,
5417 but in ISO C it does not.
5419 @item
5420 In traditional C, some preprocessor directives did not exist.
5421 Traditional preprocessors only considered a line to be a directive
5422 if the @samp{#} appeared in column 1 on the line.  Therefore
5423 @option{-Wtraditional} warns about directives that traditional C
5424 understands but ignores because the @samp{#} does not appear as the
5425 first character on the line.  It also suggests you hide directives like
5426 @code{#pragma} not understood by traditional C by indenting them.  Some
5427 traditional implementations do not recognize @code{#elif}, so this option
5428 suggests avoiding it altogether.
5430 @item
5431 A function-like macro that appears without arguments.
5433 @item
5434 The unary plus operator.
5436 @item
5437 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
5438 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
5439 constants.)  Note, these suffixes appear in macros defined in the system
5440 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
5441 Use of these macros in user code might normally lead to spurious
5442 warnings, however GCC's integrated preprocessor has enough context to
5443 avoid warning in these cases.
5445 @item
5446 A function declared external in one block and then used after the end of
5447 the block.
5449 @item
5450 A @code{switch} statement has an operand of type @code{long}.
5452 @item
5453 A non-@code{static} function declaration follows a @code{static} one.
5454 This construct is not accepted by some traditional C compilers.
5456 @item
5457 The ISO type of an integer constant has a different width or
5458 signedness from its traditional type.  This warning is only issued if
5459 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
5460 typically represent bit patterns, are not warned about.
5462 @item
5463 Usage of ISO string concatenation is detected.
5465 @item
5466 Initialization of automatic aggregates.
5468 @item
5469 Identifier conflicts with labels.  Traditional C lacks a separate
5470 namespace for labels.
5472 @item
5473 Initialization of unions.  If the initializer is zero, the warning is
5474 omitted.  This is done under the assumption that the zero initializer in
5475 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
5476 initializer warnings and relies on default initialization to zero in the
5477 traditional C case.
5479 @item
5480 Conversions by prototypes between fixed/floating-point values and vice
5481 versa.  The absence of these prototypes when compiling with traditional
5482 C causes serious problems.  This is a subset of the possible
5483 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
5485 @item
5486 Use of ISO C style function definitions.  This warning intentionally is
5487 @emph{not} issued for prototype declarations or variadic functions
5488 because these ISO C features appear in your code when using
5489 libiberty's traditional C compatibility macros, @code{PARAMS} and
5490 @code{VPARAMS}.  This warning is also bypassed for nested functions
5491 because that feature is already a GCC extension and thus not relevant to
5492 traditional C compatibility.
5493 @end itemize
5495 @item -Wtraditional-conversion @r{(C and Objective-C only)}
5496 @opindex Wtraditional-conversion
5497 @opindex Wno-traditional-conversion
5498 Warn if a prototype causes a type conversion that is different from what
5499 would happen to the same argument in the absence of a prototype.  This
5500 includes conversions of fixed point to floating and vice versa, and
5501 conversions changing the width or signedness of a fixed-point argument
5502 except when the same as the default promotion.
5504 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
5505 @opindex Wdeclaration-after-statement
5506 @opindex Wno-declaration-after-statement
5507 Warn when a declaration is found after a statement in a block.  This
5508 construct, known from C++, was introduced with ISO C99 and is by default
5509 allowed in GCC@.  It is not supported by ISO C90.  @xref{Mixed Declarations}.
5511 @item -Wshadow
5512 @opindex Wshadow
5513 @opindex Wno-shadow
5514 Warn whenever a local variable or type declaration shadows another
5515 variable, parameter, type, class member (in C++), or instance variable
5516 (in Objective-C) or whenever a built-in function is shadowed. Note
5517 that in C++, the compiler warns if a local variable shadows an
5518 explicit typedef, but not if it shadows a struct/class/enum.
5519 Same as @option{-Wshadow=global}.
5521 @item -Wno-shadow-ivar @r{(Objective-C only)}
5522 @opindex Wno-shadow-ivar
5523 @opindex Wshadow-ivar
5524 Do not warn whenever a local variable shadows an instance variable in an
5525 Objective-C method.
5527 @item -Wshadow=global
5528 @opindex Wshadow=local
5529 The default for @option{-Wshadow}. Warns for any (global) shadowing.
5531 @item -Wshadow=local
5532 @opindex Wshadow=local
5533 Warn when a local variable shadows another local variable or parameter.
5534 This warning is enabled by @option{-Wshadow=global}.
5536 @item -Wshadow=compatible-local
5537 @opindex Wshadow=compatible-local
5538 Warn when a local variable shadows another local variable or parameter
5539 whose type is compatible with that of the shadowing variable. In C++,
5540 type compatibility here means the type of the shadowing variable can be
5541 converted to that of the shadowed variable. The creation of this flag
5542 (in addition to @option{-Wshadow=local}) is based on the idea that when
5543 a local variable shadows another one of incompatible type, it is most
5544 likely intentional, not a bug or typo, as shown in the following example:
5546 @smallexample
5547 @group
5548 for (SomeIterator i = SomeObj.begin(); i != SomeObj.end(); ++i)
5550   for (int i = 0; i < N; ++i)
5551   @{
5552     ...
5553   @}
5554   ...
5556 @end group
5557 @end smallexample
5559 Since the two variable @code{i} in the example above have incompatible types,
5560 enabling only @option{-Wshadow=compatible-local} will not emit a warning.
5561 Because their types are incompatible, if a programmer accidentally uses one
5562 in place of the other, type checking will catch that and emit an error or
5563 warning. So not warning (about shadowing) in this case will not lead to
5564 undetected bugs. Use of this flag instead of @option{-Wshadow=local} can
5565 possibly reduce the number of warnings triggered by intentional shadowing.
5567 This warning is enabled by @option{-Wshadow=local}.
5569 @item -Wlarger-than=@var{len}
5570 @opindex Wlarger-than=@var{len}
5571 @opindex Wlarger-than-@var{len}
5572 Warn whenever an object of larger than @var{len} bytes is defined.
5574 @item -Wframe-larger-than=@var{len}
5575 @opindex Wframe-larger-than
5576 Warn if the size of a function frame is larger than @var{len} bytes.
5577 The computation done to determine the stack frame size is approximate
5578 and not conservative.
5579 The actual requirements may be somewhat greater than @var{len}
5580 even if you do not get a warning.  In addition, any space allocated
5581 via @code{alloca}, variable-length arrays, or related constructs
5582 is not included by the compiler when determining
5583 whether or not to issue a warning.
5585 @item -Wno-free-nonheap-object
5586 @opindex Wno-free-nonheap-object
5587 @opindex Wfree-nonheap-object
5588 Do not warn when attempting to free an object that was not allocated
5589 on the heap.
5591 @item -Wstack-usage=@var{len}
5592 @opindex Wstack-usage
5593 Warn if the stack usage of a function might be larger than @var{len} bytes.
5594 The computation done to determine the stack usage is conservative.
5595 Any space allocated via @code{alloca}, variable-length arrays, or related
5596 constructs is included by the compiler when determining whether or not to
5597 issue a warning.
5599 The message is in keeping with the output of @option{-fstack-usage}.
5601 @itemize
5602 @item
5603 If the stack usage is fully static but exceeds the specified amount, it's:
5605 @smallexample
5606   warning: stack usage is 1120 bytes
5607 @end smallexample
5608 @item
5609 If the stack usage is (partly) dynamic but bounded, it's:
5611 @smallexample
5612   warning: stack usage might be 1648 bytes
5613 @end smallexample
5614 @item
5615 If the stack usage is (partly) dynamic and not bounded, it's:
5617 @smallexample
5618   warning: stack usage might be unbounded
5619 @end smallexample
5620 @end itemize
5622 @item -Wunsafe-loop-optimizations
5623 @opindex Wunsafe-loop-optimizations
5624 @opindex Wno-unsafe-loop-optimizations
5625 Warn if the loop cannot be optimized because the compiler cannot
5626 assume anything on the bounds of the loop indices.  With
5627 @option{-funsafe-loop-optimizations} warn if the compiler makes
5628 such assumptions.
5630 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
5631 @opindex Wno-pedantic-ms-format
5632 @opindex Wpedantic-ms-format
5633 When used in combination with @option{-Wformat}
5634 and @option{-pedantic} without GNU extensions, this option
5635 disables the warnings about non-ISO @code{printf} / @code{scanf} format
5636 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
5637 which depend on the MS runtime.
5639 @item -Waligned-new
5640 @opindex Waligned-new
5641 @opindex Wno-aligned-new
5642 Warn about a new-expression of a type that requires greater alignment
5643 than the @code{alignof(std::max_align_t)} but uses an allocation
5644 function without an explicit alignment parameter. This option is
5645 enabled by @option{-Wall}.
5647 Normally this only warns about global allocation functions, but
5648 @option{-Waligned-new=all} also warns about class member allocation
5649 functions.
5651 @item -Wplacement-new
5652 @itemx -Wplacement-new=@var{n}
5653 @opindex Wplacement-new
5654 @opindex Wno-placement-new
5655 Warn about placement new expressions with undefined behavior, such as
5656 constructing an object in a buffer that is smaller than the type of
5657 the object.  For example, the placement new expression below is diagnosed
5658 because it attempts to construct an array of 64 integers in a buffer only
5659 64 bytes large.
5660 @smallexample
5661 char buf [64];
5662 new (buf) int[64];
5663 @end smallexample
5664 This warning is enabled by default.
5666 @table @gcctabopt
5667 @item -Wplacement-new=1
5668 This is the default warning level of @option{-Wplacement-new}.  At this
5669 level the warning is not issued for some strictly undefined constructs that
5670 GCC allows as extensions for compatibility with legacy code.  For example,
5671 the following @code{new} expression is not diagnosed at this level even
5672 though it has undefined behavior according to the C++ standard because
5673 it writes past the end of the one-element array.
5674 @smallexample
5675 struct S @{ int n, a[1]; @};
5676 S *s = (S *)malloc (sizeof *s + 31 * sizeof s->a[0]);
5677 new (s->a)int [32]();
5678 @end smallexample
5680 @item -Wplacement-new=2
5681 At this level, in addition to diagnosing all the same constructs as at level
5682 1, a diagnostic is also issued for placement new expressions that construct
5683 an object in the last member of structure whose type is an array of a single
5684 element and whose size is less than the size of the object being constructed.
5685 While the previous example would be diagnosed, the following construct makes
5686 use of the flexible member array extension to avoid the warning at level 2.
5687 @smallexample
5688 struct S @{ int n, a[]; @};
5689 S *s = (S *)malloc (sizeof *s + 32 * sizeof s->a[0]);
5690 new (s->a)int [32]();
5691 @end smallexample
5693 @end table
5695 @item -Wpointer-arith
5696 @opindex Wpointer-arith
5697 @opindex Wno-pointer-arith
5698 Warn about anything that depends on the ``size of'' a function type or
5699 of @code{void}.  GNU C assigns these types a size of 1, for
5700 convenience in calculations with @code{void *} pointers and pointers
5701 to functions.  In C++, warn also when an arithmetic operation involves
5702 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
5704 @item -Wpointer-compare
5705 @opindex Wpointer-compare
5706 @opindex Wno-pointer-compare
5707 Warn if a pointer is compared with a zero character constant.  This usually
5708 means that the pointer was meant to be dereferenced.  For example:
5710 @smallexample
5711 const char *p = foo ();
5712 if (p == '\0')
5713   return 42;
5714 @end smallexample
5716 Note that the code above is invalid in C++11.
5718 This warning is enabled by default.
5720 @item -Wtype-limits
5721 @opindex Wtype-limits
5722 @opindex Wno-type-limits
5723 Warn if a comparison is always true or always false due to the limited
5724 range of the data type, but do not warn for constant expressions.  For
5725 example, warn if an unsigned variable is compared against zero with
5726 @code{<} or @code{>=}.  This warning is also enabled by
5727 @option{-Wextra}.
5729 @include cppwarnopts.texi
5731 @item -Wbad-function-cast @r{(C and Objective-C only)}
5732 @opindex Wbad-function-cast
5733 @opindex Wno-bad-function-cast
5734 Warn when a function call is cast to a non-matching type.
5735 For example, warn if a call to a function returning an integer type 
5736 is cast to a pointer type.
5738 @item -Wc90-c99-compat @r{(C and Objective-C only)}
5739 @opindex Wc90-c99-compat
5740 @opindex Wno-c90-c99-compat
5741 Warn about features not present in ISO C90, but present in ISO C99.
5742 For instance, warn about use of variable length arrays, @code{long long}
5743 type, @code{bool} type, compound literals, designated initializers, and so
5744 on.  This option is independent of the standards mode.  Warnings are disabled
5745 in the expression that follows @code{__extension__}.
5747 @item -Wc99-c11-compat @r{(C and Objective-C only)}
5748 @opindex Wc99-c11-compat
5749 @opindex Wno-c99-c11-compat
5750 Warn about features not present in ISO C99, but present in ISO C11.
5751 For instance, warn about use of anonymous structures and unions,
5752 @code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier,
5753 @code{_Alignas} specifier, @code{Alignof} operator, @code{_Generic} keyword,
5754 and so on.  This option is independent of the standards mode.  Warnings are
5755 disabled in the expression that follows @code{__extension__}.
5757 @item -Wc++-compat @r{(C and Objective-C only)}
5758 @opindex Wc++-compat
5759 Warn about ISO C constructs that are outside of the common subset of
5760 ISO C and ISO C++, e.g.@: request for implicit conversion from
5761 @code{void *} to a pointer to non-@code{void} type.
5763 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
5764 @opindex Wc++11-compat
5765 Warn about C++ constructs whose meaning differs between ISO C++ 1998
5766 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
5767 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
5768 enabled by @option{-Wall}.
5770 @item -Wc++14-compat @r{(C++ and Objective-C++ only)}
5771 @opindex Wc++14-compat
5772 Warn about C++ constructs whose meaning differs between ISO C++ 2011
5773 and ISO C++ 2014.  This warning is enabled by @option{-Wall}.
5775 @item -Wc++1z-compat @r{(C++ and Objective-C++ only)}
5776 @opindex Wc++1z-compat
5777 Warn about C++ constructs whose meaning differs between ISO C++ 2014
5778 and the forthoming ISO C++ 2017(?).  This warning is enabled by @option{-Wall}.
5780 @item -Wcast-qual
5781 @opindex Wcast-qual
5782 @opindex Wno-cast-qual
5783 Warn whenever a pointer is cast so as to remove a type qualifier from
5784 the target type.  For example, warn if a @code{const char *} is cast
5785 to an ordinary @code{char *}.
5787 Also warn when making a cast that introduces a type qualifier in an
5788 unsafe way.  For example, casting @code{char **} to @code{const char **}
5789 is unsafe, as in this example:
5791 @smallexample
5792   /* p is char ** value.  */
5793   const char **q = (const char **) p;
5794   /* Assignment of readonly string to const char * is OK.  */
5795   *q = "string";
5796   /* Now char** pointer points to read-only memory.  */
5797   **p = 'b';
5798 @end smallexample
5800 @item -Wcast-align
5801 @opindex Wcast-align
5802 @opindex Wno-cast-align
5803 Warn whenever a pointer is cast such that the required alignment of the
5804 target is increased.  For example, warn if a @code{char *} is cast to
5805 an @code{int *} on machines where integers can only be accessed at
5806 two- or four-byte boundaries.
5808 @item -Wwrite-strings
5809 @opindex Wwrite-strings
5810 @opindex Wno-write-strings
5811 When compiling C, give string constants the type @code{const
5812 char[@var{length}]} so that copying the address of one into a
5813 non-@code{const} @code{char *} pointer produces a warning.  These
5814 warnings help you find at compile time code that can try to write
5815 into a string constant, but only if you have been very careful about
5816 using @code{const} in declarations and prototypes.  Otherwise, it is
5817 just a nuisance. This is why we did not make @option{-Wall} request
5818 these warnings.
5820 When compiling C++, warn about the deprecated conversion from string
5821 literals to @code{char *}.  This warning is enabled by default for C++
5822 programs.
5824 @item -Wclobbered
5825 @opindex Wclobbered
5826 @opindex Wno-clobbered
5827 Warn for variables that might be changed by @code{longjmp} or
5828 @code{vfork}.  This warning is also enabled by @option{-Wextra}.
5830 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
5831 @opindex Wconditionally-supported
5832 @opindex Wno-conditionally-supported
5833 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
5835 @item -Wconversion
5836 @opindex Wconversion
5837 @opindex Wno-conversion
5838 Warn for implicit conversions that may alter a value. This includes
5839 conversions between real and integer, like @code{abs (x)} when
5840 @code{x} is @code{double}; conversions between signed and unsigned,
5841 like @code{unsigned ui = -1}; and conversions to smaller types, like
5842 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
5843 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
5844 changed by the conversion like in @code{abs (2.0)}.  Warnings about
5845 conversions between signed and unsigned integers can be disabled by
5846 using @option{-Wno-sign-conversion}.
5848 For C++, also warn for confusing overload resolution for user-defined
5849 conversions; and conversions that never use a type conversion
5850 operator: conversions to @code{void}, the same type, a base class or a
5851 reference to them. Warnings about conversions between signed and
5852 unsigned integers are disabled by default in C++ unless
5853 @option{-Wsign-conversion} is explicitly enabled.
5855 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
5856 @opindex Wconversion-null
5857 @opindex Wno-conversion-null
5858 Do not warn for conversions between @code{NULL} and non-pointer
5859 types. @option{-Wconversion-null} is enabled by default.
5861 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
5862 @opindex Wzero-as-null-pointer-constant
5863 @opindex Wno-zero-as-null-pointer-constant
5864 Warn when a literal @samp{0} is used as null pointer constant.  This can
5865 be useful to facilitate the conversion to @code{nullptr} in C++11.
5867 @item -Wsubobject-linkage @r{(C++ and Objective-C++ only)}
5868 @opindex Wsubobject-linkage
5869 @opindex Wno-subobject-linkage
5870 Warn if a class type has a base or a field whose type uses the anonymous
5871 namespace or depends on a type with no linkage.  If a type A depends on
5872 a type B with no or internal linkage, defining it in multiple
5873 translation units would be an ODR violation because the meaning of B
5874 is different in each translation unit.  If A only appears in a single
5875 translation unit, the best way to silence the warning is to give it
5876 internal linkage by putting it in an anonymous namespace as well.  The
5877 compiler doesn't give this warning for types defined in the main .C
5878 file, as those are unlikely to have multiple definitions.
5879 @option{-Wsubobject-linkage} is enabled by default.
5881 @item -Wdangling-else
5882 @opindex Wdangling-else
5883 @opindex Wno-dangling-else
5884 Warn about constructions where there may be confusion to which
5885 @code{if} statement an @code{else} branch belongs.  Here is an example of
5886 such a case:
5888 @smallexample
5889 @group
5891   if (a)
5892     if (b)
5893       foo ();
5894   else
5895     bar ();
5897 @end group
5898 @end smallexample
5900 In C/C++, every @code{else} branch belongs to the innermost possible
5901 @code{if} statement, which in this example is @code{if (b)}.  This is
5902 often not what the programmer expected, as illustrated in the above
5903 example by indentation the programmer chose.  When there is the
5904 potential for this confusion, GCC issues a warning when this flag
5905 is specified.  To eliminate the warning, add explicit braces around
5906 the innermost @code{if} statement so there is no way the @code{else}
5907 can belong to the enclosing @code{if}.  The resulting code
5908 looks like this:
5910 @smallexample
5911 @group
5913   if (a)
5914     @{
5915       if (b)
5916         foo ();
5917       else
5918         bar ();
5919     @}
5921 @end group
5922 @end smallexample
5924 This warning is enabled by @option{-Wparentheses}.
5926 @item -Wdate-time
5927 @opindex Wdate-time
5928 @opindex Wno-date-time
5929 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
5930 are encountered as they might prevent bit-wise-identical reproducible
5931 compilations.
5933 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
5934 @opindex Wdelete-incomplete
5935 @opindex Wno-delete-incomplete
5936 Warn when deleting a pointer to incomplete type, which may cause
5937 undefined behavior at runtime.  This warning is enabled by default.
5939 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
5940 @opindex Wuseless-cast
5941 @opindex Wno-useless-cast
5942 Warn when an expression is casted to its own type.
5944 @item -Wempty-body
5945 @opindex Wempty-body
5946 @opindex Wno-empty-body
5947 Warn if an empty body occurs in an @code{if}, @code{else} or @code{do
5948 while} statement.  This warning is also enabled by @option{-Wextra}.
5950 @item -Wenum-compare
5951 @opindex Wenum-compare
5952 @opindex Wno-enum-compare
5953 Warn about a comparison between values of different enumerated types.
5954 In C++ enumerated type mismatches in conditional expressions are also
5955 diagnosed and the warning is enabled by default.  In C this warning is 
5956 enabled by @option{-Wall}.
5958 @item -Wjump-misses-init @r{(C, Objective-C only)}
5959 @opindex Wjump-misses-init
5960 @opindex Wno-jump-misses-init
5961 Warn if a @code{goto} statement or a @code{switch} statement jumps
5962 forward across the initialization of a variable, or jumps backward to a
5963 label after the variable has been initialized.  This only warns about
5964 variables that are initialized when they are declared.  This warning is
5965 only supported for C and Objective-C; in C++ this sort of branch is an
5966 error in any case.
5968 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
5969 can be disabled with the @option{-Wno-jump-misses-init} option.
5971 @item -Wsign-compare
5972 @opindex Wsign-compare
5973 @opindex Wno-sign-compare
5974 @cindex warning for comparison of signed and unsigned values
5975 @cindex comparison of signed and unsigned values, warning
5976 @cindex signed and unsigned values, comparison warning
5977 Warn when a comparison between signed and unsigned values could produce
5978 an incorrect result when the signed value is converted to unsigned.
5979 In C++, this warning is also enabled by @option{-Wall}.  In C, it is
5980 also enabled by @option{-Wextra}.
5982 @item -Wsign-conversion
5983 @opindex Wsign-conversion
5984 @opindex Wno-sign-conversion
5985 Warn for implicit conversions that may change the sign of an integer
5986 value, like assigning a signed integer expression to an unsigned
5987 integer variable. An explicit cast silences the warning. In C, this
5988 option is enabled also by @option{-Wconversion}.
5990 @item -Wfloat-conversion
5991 @opindex Wfloat-conversion
5992 @opindex Wno-float-conversion
5993 Warn for implicit conversions that reduce the precision of a real value.
5994 This includes conversions from real to integer, and from higher precision
5995 real to lower precision real values.  This option is also enabled by
5996 @option{-Wconversion}.
5998 @item -Wno-scalar-storage-order
5999 @opindex -Wno-scalar-storage-order
6000 @opindex -Wscalar-storage-order
6001 Do not warn on suspicious constructs involving reverse scalar storage order.
6003 @item -Wsized-deallocation @r{(C++ and Objective-C++ only)}
6004 @opindex Wsized-deallocation
6005 @opindex Wno-sized-deallocation
6006 Warn about a definition of an unsized deallocation function
6007 @smallexample
6008 void operator delete (void *) noexcept;
6009 void operator delete[] (void *) noexcept;
6010 @end smallexample
6011 without a definition of the corresponding sized deallocation function
6012 @smallexample
6013 void operator delete (void *, std::size_t) noexcept;
6014 void operator delete[] (void *, std::size_t) noexcept;
6015 @end smallexample
6016 or vice versa.  Enabled by @option{-Wextra} along with
6017 @option{-fsized-deallocation}.
6019 @item -Wsizeof-pointer-memaccess
6020 @opindex Wsizeof-pointer-memaccess
6021 @opindex Wno-sizeof-pointer-memaccess
6022 Warn for suspicious length parameters to certain string and memory built-in
6023 functions if the argument uses @code{sizeof}.  This warning warns e.g.@:
6024 about @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not an array,
6025 but a pointer, and suggests a possible fix, or about
6026 @code{memcpy (&foo, ptr, sizeof (&foo));}.  This warning is enabled by
6027 @option{-Wall}.
6029 @item -Wsizeof-array-argument
6030 @opindex Wsizeof-array-argument
6031 @opindex Wno-sizeof-array-argument
6032 Warn when the @code{sizeof} operator is applied to a parameter that is
6033 declared as an array in a function definition.  This warning is enabled by
6034 default for C and C++ programs.
6036 @item -Wmemset-elt-size
6037 @opindex Wmemset-elt-size
6038 @opindex Wno-memset-elt-size
6039 Warn for suspicious calls to the @code{memset} built-in function, if the
6040 first argument references an array, and the third argument is a number
6041 equal to the number of elements, but not equal to the size of the array
6042 in memory.  This indicates that the user has omitted a multiplication by
6043 the element size.  This warning is enabled by @option{-Wall}.
6045 @item -Wmemset-transposed-args
6046 @opindex Wmemset-transposed-args
6047 @opindex Wno-memset-transposed-args
6048 Warn for suspicious calls to the @code{memset} built-in function, if the
6049 second argument is not zero and the third argument is zero.  This warns e.g.@
6050 about @code{memset (buf, sizeof buf, 0)} where most probably
6051 @code{memset (buf, 0, sizeof buf)} was meant instead.  The diagnostics
6052 is only emitted if the third argument is literal zero.  If it is some
6053 expression that is folded to zero, a cast of zero to some type, etc., 
6054 it is far less likely that the user has mistakenly exchanged the arguments 
6055 and no warning is emitted.  This warning is enabled by @option{-Wall}.
6057 @item -Waddress
6058 @opindex Waddress
6059 @opindex Wno-address
6060 Warn about suspicious uses of memory addresses. These include using
6061 the address of a function in a conditional expression, such as
6062 @code{void func(void); if (func)}, and comparisons against the memory
6063 address of a string literal, such as @code{if (x == "abc")}.  Such
6064 uses typically indicate a programmer error: the address of a function
6065 always evaluates to true, so their use in a conditional usually
6066 indicate that the programmer forgot the parentheses in a function
6067 call; and comparisons against string literals result in unspecified
6068 behavior and are not portable in C, so they usually indicate that the
6069 programmer intended to use @code{strcmp}.  This warning is enabled by
6070 @option{-Wall}.
6072 @item -Wlogical-op
6073 @opindex Wlogical-op
6074 @opindex Wno-logical-op
6075 Warn about suspicious uses of logical operators in expressions.
6076 This includes using logical operators in contexts where a
6077 bit-wise operator is likely to be expected.  Also warns when
6078 the operands of a logical operator are the same:
6079 @smallexample
6080 extern int a;
6081 if (a < 0 && a < 0) @{ @dots{} @}
6082 @end smallexample
6084 @item -Wlogical-not-parentheses
6085 @opindex Wlogical-not-parentheses
6086 @opindex Wno-logical-not-parentheses
6087 Warn about logical not used on the left hand side operand of a comparison.
6088 This option does not warn if the right operand is considered to be a boolean
6089 expression.  Its purpose is to detect suspicious code like the following:
6090 @smallexample
6091 int a;
6092 @dots{}
6093 if (!a > 1) @{ @dots{} @}
6094 @end smallexample
6096 It is possible to suppress the warning by wrapping the LHS into
6097 parentheses:
6098 @smallexample
6099 if ((!a) > 1) @{ @dots{} @}
6100 @end smallexample
6102 This warning is enabled by @option{-Wall}.
6104 @item -Waggregate-return
6105 @opindex Waggregate-return
6106 @opindex Wno-aggregate-return
6107 Warn if any functions that return structures or unions are defined or
6108 called.  (In languages where you can return an array, this also elicits
6109 a warning.)
6111 @item -Wno-aggressive-loop-optimizations
6112 @opindex Wno-aggressive-loop-optimizations
6113 @opindex Waggressive-loop-optimizations
6114 Warn if in a loop with constant number of iterations the compiler detects
6115 undefined behavior in some statement during one or more of the iterations.
6117 @item -Wno-attributes
6118 @opindex Wno-attributes
6119 @opindex Wattributes
6120 Do not warn if an unexpected @code{__attribute__} is used, such as
6121 unrecognized attributes, function attributes applied to variables,
6122 etc.  This does not stop errors for incorrect use of supported
6123 attributes.
6125 @item -Wno-builtin-declaration-mismatch
6126 @opindex Wno-builtin-declaration-mismatch
6127 @opindex Wbuiltin-declaration-mismatch
6128 Warn if a built-in function is declared with the wrong signature.
6129 This warning is enabled by default.
6131 @item -Wno-builtin-macro-redefined
6132 @opindex Wno-builtin-macro-redefined
6133 @opindex Wbuiltin-macro-redefined
6134 Do not warn if certain built-in macros are redefined.  This suppresses
6135 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
6136 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
6138 @item -Wstrict-prototypes @r{(C and Objective-C only)}
6139 @opindex Wstrict-prototypes
6140 @opindex Wno-strict-prototypes
6141 Warn if a function is declared or defined without specifying the
6142 argument types.  (An old-style function definition is permitted without
6143 a warning if preceded by a declaration that specifies the argument
6144 types.)
6146 @item -Wold-style-declaration @r{(C and Objective-C only)}
6147 @opindex Wold-style-declaration
6148 @opindex Wno-old-style-declaration
6149 Warn for obsolescent usages, according to the C Standard, in a
6150 declaration. For example, warn if storage-class specifiers like
6151 @code{static} are not the first things in a declaration.  This warning
6152 is also enabled by @option{-Wextra}.
6154 @item -Wold-style-definition @r{(C and Objective-C only)}
6155 @opindex Wold-style-definition
6156 @opindex Wno-old-style-definition
6157 Warn if an old-style function definition is used.  A warning is given
6158 even if there is a previous prototype.
6160 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
6161 @opindex Wmissing-parameter-type
6162 @opindex Wno-missing-parameter-type
6163 A function parameter is declared without a type specifier in K&R-style
6164 functions:
6166 @smallexample
6167 void foo(bar) @{ @}
6168 @end smallexample
6170 This warning is also enabled by @option{-Wextra}.
6172 @item -Wmissing-prototypes @r{(C and Objective-C only)}
6173 @opindex Wmissing-prototypes
6174 @opindex Wno-missing-prototypes
6175 Warn if a global function is defined without a previous prototype
6176 declaration.  This warning is issued even if the definition itself
6177 provides a prototype.  Use this option to detect global functions
6178 that do not have a matching prototype declaration in a header file.
6179 This option is not valid for C++ because all function declarations
6180 provide prototypes and a non-matching declaration declares an
6181 overload rather than conflict with an earlier declaration.
6182 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
6184 @item -Wmissing-declarations
6185 @opindex Wmissing-declarations
6186 @opindex Wno-missing-declarations
6187 Warn if a global function is defined without a previous declaration.
6188 Do so even if the definition itself provides a prototype.
6189 Use this option to detect global functions that are not declared in
6190 header files.  In C, no warnings are issued for functions with previous
6191 non-prototype declarations; use @option{-Wmissing-prototypes} to detect
6192 missing prototypes.  In C++, no warnings are issued for function templates,
6193 or for inline functions, or for functions in anonymous namespaces.
6195 @item -Wmissing-field-initializers
6196 @opindex Wmissing-field-initializers
6197 @opindex Wno-missing-field-initializers
6198 @opindex W
6199 @opindex Wextra
6200 @opindex Wno-extra
6201 Warn if a structure's initializer has some fields missing.  For
6202 example, the following code causes such a warning, because
6203 @code{x.h} is implicitly zero:
6205 @smallexample
6206 struct s @{ int f, g, h; @};
6207 struct s x = @{ 3, 4 @};
6208 @end smallexample
6210 This option does not warn about designated initializers, so the following
6211 modification does not trigger a warning:
6213 @smallexample
6214 struct s @{ int f, g, h; @};
6215 struct s x = @{ .f = 3, .g = 4 @};
6216 @end smallexample
6218 In C++ this option does not warn either about the empty @{ @}
6219 initializer, for example:
6221 @smallexample
6222 struct s @{ int f, g, h; @};
6223 s x = @{ @};
6224 @end smallexample
6226 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
6227 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
6229 @item -Wno-multichar
6230 @opindex Wno-multichar
6231 @opindex Wmultichar
6232 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
6233 Usually they indicate a typo in the user's code, as they have
6234 implementation-defined values, and should not be used in portable code.
6236 @item -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]}
6237 @opindex Wnormalized=
6238 @opindex Wnormalized
6239 @opindex Wno-normalized
6240 @cindex NFC
6241 @cindex NFKC
6242 @cindex character set, input normalization
6243 In ISO C and ISO C++, two identifiers are different if they are
6244 different sequences of characters.  However, sometimes when characters
6245 outside the basic ASCII character set are used, you can have two
6246 different character sequences that look the same.  To avoid confusion,
6247 the ISO 10646 standard sets out some @dfn{normalization rules} which
6248 when applied ensure that two sequences that look the same are turned into
6249 the same sequence.  GCC can warn you if you are using identifiers that
6250 have not been normalized; this option controls that warning.
6252 There are four levels of warning supported by GCC@.  The default is
6253 @option{-Wnormalized=nfc}, which warns about any identifier that is
6254 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
6255 recommended form for most uses.  It is equivalent to
6256 @option{-Wnormalized}.
6258 Unfortunately, there are some characters allowed in identifiers by
6259 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
6260 identifiers.  That is, there's no way to use these symbols in portable
6261 ISO C or C++ and have all your identifiers in NFC@.
6262 @option{-Wnormalized=id} suppresses the warning for these characters.
6263 It is hoped that future versions of the standards involved will correct
6264 this, which is why this option is not the default.
6266 You can switch the warning off for all characters by writing
6267 @option{-Wnormalized=none} or @option{-Wno-normalized}.  You should
6268 only do this if you are using some other normalization scheme (like
6269 ``D''), because otherwise you can easily create bugs that are
6270 literally impossible to see.
6272 Some characters in ISO 10646 have distinct meanings but look identical
6273 in some fonts or display methodologies, especially once formatting has
6274 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
6275 LETTER N'', displays just like a regular @code{n} that has been
6276 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
6277 normalization scheme to convert all these into a standard form as
6278 well, and GCC warns if your code is not in NFKC if you use
6279 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
6280 about every identifier that contains the letter O because it might be
6281 confused with the digit 0, and so is not the default, but may be
6282 useful as a local coding convention if the programming environment 
6283 cannot be fixed to display these characters distinctly.
6285 @item -Wno-deprecated
6286 @opindex Wno-deprecated
6287 @opindex Wdeprecated
6288 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
6290 @item -Wno-deprecated-declarations
6291 @opindex Wno-deprecated-declarations
6292 @opindex Wdeprecated-declarations
6293 Do not warn about uses of functions (@pxref{Function Attributes}),
6294 variables (@pxref{Variable Attributes}), and types (@pxref{Type
6295 Attributes}) marked as deprecated by using the @code{deprecated}
6296 attribute.
6298 @item -Wno-overflow
6299 @opindex Wno-overflow
6300 @opindex Woverflow
6301 Do not warn about compile-time overflow in constant expressions.
6303 @item -Wno-odr
6304 @opindex Wno-odr
6305 @opindex Wodr
6306 Warn about One Definition Rule violations during link-time optimization.
6307 Requires @option{-flto-odr-type-merging} to be enabled.  Enabled by default.
6309 @item -Wopenmp-simd
6310 @opindex Wopenm-simd
6311 Warn if the vectorizer cost model overrides the OpenMP or the Cilk Plus
6312 simd directive set by user.  The @option{-fsimd-cost-model=unlimited}
6313 option can be used to relax the cost model.
6315 @item -Woverride-init @r{(C and Objective-C only)}
6316 @opindex Woverride-init
6317 @opindex Wno-override-init
6318 @opindex W
6319 @opindex Wextra
6320 @opindex Wno-extra
6321 Warn if an initialized field without side effects is overridden when
6322 using designated initializers (@pxref{Designated Inits, , Designated
6323 Initializers}).
6325 This warning is included in @option{-Wextra}.  To get other
6326 @option{-Wextra} warnings without this one, use @option{-Wextra
6327 -Wno-override-init}.
6329 @item -Woverride-init-side-effects @r{(C and Objective-C only)}
6330 @opindex Woverride-init-side-effects
6331 @opindex Wno-override-init-side-effects
6332 Warn if an initialized field with side effects is overridden when
6333 using designated initializers (@pxref{Designated Inits, , Designated
6334 Initializers}).  This warning is enabled by default.
6336 @item -Wpacked
6337 @opindex Wpacked
6338 @opindex Wno-packed
6339 Warn if a structure is given the packed attribute, but the packed
6340 attribute has no effect on the layout or size of the structure.
6341 Such structures may be mis-aligned for little benefit.  For
6342 instance, in this code, the variable @code{f.x} in @code{struct bar}
6343 is misaligned even though @code{struct bar} does not itself
6344 have the packed attribute:
6346 @smallexample
6347 @group
6348 struct foo @{
6349   int x;
6350   char a, b, c, d;
6351 @} __attribute__((packed));
6352 struct bar @{
6353   char z;
6354   struct foo f;
6356 @end group
6357 @end smallexample
6359 @item -Wpacked-bitfield-compat
6360 @opindex Wpacked-bitfield-compat
6361 @opindex Wno-packed-bitfield-compat
6362 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
6363 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
6364 the change can lead to differences in the structure layout.  GCC
6365 informs you when the offset of such a field has changed in GCC 4.4.
6366 For example there is no longer a 4-bit padding between field @code{a}
6367 and @code{b} in this structure:
6369 @smallexample
6370 struct foo
6372   char a:4;
6373   char b:8;
6374 @} __attribute__ ((packed));
6375 @end smallexample
6377 This warning is enabled by default.  Use
6378 @option{-Wno-packed-bitfield-compat} to disable this warning.
6380 @item -Wpadded
6381 @opindex Wpadded
6382 @opindex Wno-padded
6383 Warn if padding is included in a structure, either to align an element
6384 of the structure or to align the whole structure.  Sometimes when this
6385 happens it is possible to rearrange the fields of the structure to
6386 reduce the padding and so make the structure smaller.
6388 @item -Wredundant-decls
6389 @opindex Wredundant-decls
6390 @opindex Wno-redundant-decls
6391 Warn if anything is declared more than once in the same scope, even in
6392 cases where multiple declaration is valid and changes nothing.
6394 @item -Wrestrict
6395 @opindex Wrestrict
6396 @opindex Wno-restrict
6397 Warn when an argument passed to a restrict-qualified parameter
6398 aliases with another argument.
6400 @item -Wnested-externs @r{(C and Objective-C only)}
6401 @opindex Wnested-externs
6402 @opindex Wno-nested-externs
6403 Warn if an @code{extern} declaration is encountered within a function.
6405 @item -Wno-inherited-variadic-ctor
6406 @opindex Winherited-variadic-ctor
6407 @opindex Wno-inherited-variadic-ctor
6408 Suppress warnings about use of C++11 inheriting constructors when the
6409 base class inherited from has a C variadic constructor; the warning is
6410 on by default because the ellipsis is not inherited.
6412 @item -Winline
6413 @opindex Winline
6414 @opindex Wno-inline
6415 Warn if a function that is declared as inline cannot be inlined.
6416 Even with this option, the compiler does not warn about failures to
6417 inline functions declared in system headers.
6419 The compiler uses a variety of heuristics to determine whether or not
6420 to inline a function.  For example, the compiler takes into account
6421 the size of the function being inlined and the amount of inlining
6422 that has already been done in the current function.  Therefore,
6423 seemingly insignificant changes in the source program can cause the
6424 warnings produced by @option{-Winline} to appear or disappear.
6426 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
6427 @opindex Wno-invalid-offsetof
6428 @opindex Winvalid-offsetof
6429 Suppress warnings from applying the @code{offsetof} macro to a non-POD
6430 type.  According to the 2014 ISO C++ standard, applying @code{offsetof}
6431 to a non-standard-layout type is undefined.  In existing C++ implementations,
6432 however, @code{offsetof} typically gives meaningful results.
6433 This flag is for users who are aware that they are
6434 writing nonportable code and who have deliberately chosen to ignore the
6435 warning about it.
6437 The restrictions on @code{offsetof} may be relaxed in a future version
6438 of the C++ standard.
6440 @item -Wint-in-bool-context
6441 @opindex Wint-in-bool-context
6442 @opindex Wno-int-in-bool-context
6443 Warn for suspicious use of integer values where boolean values are expected,
6444 such as conditional expressions (?:) using non-boolean integer constants in
6445 boolean context, like @code{if (a <= b ? 2 : 3)}.  Or left shifting of signed
6446 integers in boolean context, like @code{for (a = 0; 1 << a; a++);}.  Likewise
6447 for all kinds of multiplications regardless of the data type.
6448 This warning is enabled by @option{-Wall}.
6450 @item -Wno-int-to-pointer-cast
6451 @opindex Wno-int-to-pointer-cast
6452 @opindex Wint-to-pointer-cast
6453 Suppress warnings from casts to pointer type of an integer of a
6454 different size. In C++, casting to a pointer type of smaller size is
6455 an error. @option{Wint-to-pointer-cast} is enabled by default.
6458 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
6459 @opindex Wno-pointer-to-int-cast
6460 @opindex Wpointer-to-int-cast
6461 Suppress warnings from casts from a pointer to an integer type of a
6462 different size.
6464 @item -Winvalid-pch
6465 @opindex Winvalid-pch
6466 @opindex Wno-invalid-pch
6467 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
6468 the search path but can't be used.
6470 @item -Wlong-long
6471 @opindex Wlong-long
6472 @opindex Wno-long-long
6473 Warn if @code{long long} type is used.  This is enabled by either
6474 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
6475 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
6477 @item -Wvariadic-macros
6478 @opindex Wvariadic-macros
6479 @opindex Wno-variadic-macros
6480 Warn if variadic macros are used in ISO C90 mode, or if the GNU
6481 alternate syntax is used in ISO C99 mode.  This is enabled by either
6482 @option{-Wpedantic} or @option{-Wtraditional}.  To inhibit the warning
6483 messages, use @option{-Wno-variadic-macros}.
6485 @item -Wvarargs
6486 @opindex Wvarargs
6487 @opindex Wno-varargs
6488 Warn upon questionable usage of the macros used to handle variable
6489 arguments like @code{va_start}.  This is default.  To inhibit the
6490 warning messages, use @option{-Wno-varargs}.
6492 @item -Wvector-operation-performance
6493 @opindex Wvector-operation-performance
6494 @opindex Wno-vector-operation-performance
6495 Warn if vector operation is not implemented via SIMD capabilities of the
6496 architecture.  Mainly useful for the performance tuning.
6497 Vector operation can be implemented @code{piecewise}, which means that the
6498 scalar operation is performed on every vector element; 
6499 @code{in parallel}, which means that the vector operation is implemented
6500 using scalars of wider type, which normally is more performance efficient;
6501 and @code{as a single scalar}, which means that vector fits into a
6502 scalar type.
6504 @item -Wno-virtual-move-assign
6505 @opindex Wvirtual-move-assign
6506 @opindex Wno-virtual-move-assign
6507 Suppress warnings about inheriting from a virtual base with a
6508 non-trivial C++11 move assignment operator.  This is dangerous because
6509 if the virtual base is reachable along more than one path, it is
6510 moved multiple times, which can mean both objects end up in the
6511 moved-from state.  If the move assignment operator is written to avoid
6512 moving from a moved-from object, this warning can be disabled.
6514 @item -Wvla
6515 @opindex Wvla
6516 @opindex Wno-vla
6517 Warn if a variable-length array is used in the code.
6518 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
6519 the variable-length array.
6521 @item -Wvla-larger-than=@var{n}
6522 If this option is used, the compiler will warn on uses of
6523 variable-length arrays where the size is either unbounded, or bounded
6524 by an argument that can be larger than @var{n} bytes.  This is similar
6525 to how @option{-Walloca-larger-than=@var{n}} works, but with
6526 variable-length arrays.
6528 Note that GCC may optimize small variable-length arrays of a known
6529 value into plain arrays, so this warning may not get triggered for
6530 such arrays.
6532 This warning is not enabled by @option{-Wall}, and is only active when
6533 @option{-ftree-vrp} is active (default for @option{-O2} and above).
6535 See also @option{-Walloca-larger-than=@var{n}}.
6537 @item -Wvolatile-register-var
6538 @opindex Wvolatile-register-var
6539 @opindex Wno-volatile-register-var
6540 Warn if a register variable is declared volatile.  The volatile
6541 modifier does not inhibit all optimizations that may eliminate reads
6542 and/or writes to register variables.  This warning is enabled by
6543 @option{-Wall}.
6545 @item -Wdisabled-optimization
6546 @opindex Wdisabled-optimization
6547 @opindex Wno-disabled-optimization
6548 Warn if a requested optimization pass is disabled.  This warning does
6549 not generally indicate that there is anything wrong with your code; it
6550 merely indicates that GCC's optimizers are unable to handle the code
6551 effectively.  Often, the problem is that your code is too big or too
6552 complex; GCC refuses to optimize programs when the optimization
6553 itself is likely to take inordinate amounts of time.
6555 @item -Wpointer-sign @r{(C and Objective-C only)}
6556 @opindex Wpointer-sign
6557 @opindex Wno-pointer-sign
6558 Warn for pointer argument passing or assignment with different signedness.
6559 This option is only supported for C and Objective-C@.  It is implied by
6560 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
6561 @option{-Wno-pointer-sign}.
6563 @item -Wstack-protector
6564 @opindex Wstack-protector
6565 @opindex Wno-stack-protector
6566 This option is only active when @option{-fstack-protector} is active.  It
6567 warns about functions that are not protected against stack smashing.
6569 @item -Woverlength-strings
6570 @opindex Woverlength-strings
6571 @opindex Wno-overlength-strings
6572 Warn about string constants that are longer than the ``minimum
6573 maximum'' length specified in the C standard.  Modern compilers
6574 generally allow string constants that are much longer than the
6575 standard's minimum limit, but very portable programs should avoid
6576 using longer strings.
6578 The limit applies @emph{after} string constant concatenation, and does
6579 not count the trailing NUL@.  In C90, the limit was 509 characters; in
6580 C99, it was raised to 4095.  C++98 does not specify a normative
6581 minimum maximum, so we do not diagnose overlength strings in C++@.
6583 This option is implied by @option{-Wpedantic}, and can be disabled with
6584 @option{-Wno-overlength-strings}.
6586 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
6587 @opindex Wunsuffixed-float-constants
6589 Issue a warning for any floating constant that does not have
6590 a suffix.  When used together with @option{-Wsystem-headers} it
6591 warns about such constants in system header files.  This can be useful
6592 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
6593 from the decimal floating-point extension to C99.
6595 @item -Wno-designated-init @r{(C and Objective-C only)}
6596 Suppress warnings when a positional initializer is used to initialize
6597 a structure that has been marked with the @code{designated_init}
6598 attribute.
6600 @item -Whsa
6601 Issue a warning when HSAIL cannot be emitted for the compiled function or
6602 OpenMP construct.
6604 @end table
6606 @node Debugging Options
6607 @section Options for Debugging Your Program
6608 @cindex options, debugging
6609 @cindex debugging information options
6611 To tell GCC to emit extra information for use by a debugger, in almost 
6612 all cases you need only to add @option{-g} to your other options.
6614 GCC allows you to use @option{-g} with
6615 @option{-O}.  The shortcuts taken by optimized code may occasionally
6616 be surprising: some variables you declared may not exist
6617 at all; flow of control may briefly move where you did not expect it;
6618 some statements may not be executed because they compute constant
6619 results or their values are already at hand; some statements may
6620 execute in different places because they have been moved out of loops.
6621 Nevertheless it is possible to debug optimized output.  This makes
6622 it reasonable to use the optimizer for programs that might have bugs.
6624 If you are not using some other optimization option, consider
6625 using @option{-Og} (@pxref{Optimize Options}) with @option{-g}.  
6626 With no @option{-O} option at all, some compiler passes that collect
6627 information useful for debugging do not run at all, so that
6628 @option{-Og} may result in a better debugging experience.
6630 @table @gcctabopt
6631 @item -g
6632 @opindex g
6633 Produce debugging information in the operating system's native format
6634 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
6635 information.
6637 On most systems that use stabs format, @option{-g} enables use of extra
6638 debugging information that only GDB can use; this extra information
6639 makes debugging work better in GDB but probably makes other debuggers
6640 crash or
6641 refuse to read the program.  If you want to control for certain whether
6642 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
6643 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
6645 @item -ggdb
6646 @opindex ggdb
6647 Produce debugging information for use by GDB@.  This means to use the
6648 most expressive format available (DWARF, stabs, or the native format
6649 if neither of those are supported), including GDB extensions if at all
6650 possible.
6652 @item -gdwarf
6653 @itemx -gdwarf-@var{version}
6654 @opindex gdwarf
6655 Produce debugging information in DWARF format (if that is supported).
6656 The value of @var{version} may be either 2, 3, 4 or 5; the default version
6657 for most targets is 4.  DWARF Version 5 is only experimental.
6659 Note that with DWARF Version 2, some ports require and always
6660 use some non-conflicting DWARF 3 extensions in the unwind tables.
6662 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
6663 for maximum benefit.
6665 GCC no longer supports DWARF Version 1, which is substantially
6666 different than Version 2 and later.  For historical reasons, some
6667 other DWARF-related options (including @option{-feliminate-dwarf2-dups} 
6668 and @option{-fno-dwarf2-cfi-asm}) retain a reference to DWARF Version 2
6669 in their names, but apply to all currently-supported versions of DWARF.
6671 @item -gstabs
6672 @opindex gstabs
6673 Produce debugging information in stabs format (if that is supported),
6674 without GDB extensions.  This is the format used by DBX on most BSD
6675 systems.  On MIPS, Alpha and System V Release 4 systems this option
6676 produces stabs debugging output that is not understood by DBX or SDB@.
6677 On System V Release 4 systems this option requires the GNU assembler.
6679 @item -gstabs+
6680 @opindex gstabs+
6681 Produce debugging information in stabs format (if that is supported),
6682 using GNU extensions understood only by the GNU debugger (GDB)@.  The
6683 use of these extensions is likely to make other debuggers crash or
6684 refuse to read the program.
6686 @item -gcoff
6687 @opindex gcoff
6688 Produce debugging information in COFF format (if that is supported).
6689 This is the format used by SDB on most System V systems prior to
6690 System V Release 4.
6692 @item -gxcoff
6693 @opindex gxcoff
6694 Produce debugging information in XCOFF format (if that is supported).
6695 This is the format used by the DBX debugger on IBM RS/6000 systems.
6697 @item -gxcoff+
6698 @opindex gxcoff+
6699 Produce debugging information in XCOFF format (if that is supported),
6700 using GNU extensions understood only by the GNU debugger (GDB)@.  The
6701 use of these extensions is likely to make other debuggers crash or
6702 refuse to read the program, and may cause assemblers other than the GNU
6703 assembler (GAS) to fail with an error.
6705 @item -gvms
6706 @opindex gvms
6707 Produce debugging information in Alpha/VMS debug format (if that is
6708 supported).  This is the format used by DEBUG on Alpha/VMS systems.
6710 @item -g@var{level}
6711 @itemx -ggdb@var{level}
6712 @itemx -gstabs@var{level}
6713 @itemx -gcoff@var{level}
6714 @itemx -gxcoff@var{level}
6715 @itemx -gvms@var{level}
6716 Request debugging information and also use @var{level} to specify how
6717 much information.  The default level is 2.
6719 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
6720 @option{-g}.
6722 Level 1 produces minimal information, enough for making backtraces in
6723 parts of the program that you don't plan to debug.  This includes
6724 descriptions of functions and external variables, and line number
6725 tables, but no information about local variables.
6727 Level 3 includes extra information, such as all the macro definitions
6728 present in the program.  Some debuggers support macro expansion when
6729 you use @option{-g3}.
6731 @option{-gdwarf} does not accept a concatenated debug level, to avoid
6732 confusion with @option{-gdwarf-@var{level}}.
6733 Instead use an additional @option{-g@var{level}} option to change the
6734 debug level for DWARF.
6736 @item -feliminate-unused-debug-symbols
6737 @opindex feliminate-unused-debug-symbols
6738 Produce debugging information in stabs format (if that is supported),
6739 for only symbols that are actually used.
6741 @item -femit-class-debug-always
6742 @opindex femit-class-debug-always
6743 Instead of emitting debugging information for a C++ class in only one
6744 object file, emit it in all object files using the class.  This option
6745 should be used only with debuggers that are unable to handle the way GCC
6746 normally emits debugging information for classes because using this
6747 option increases the size of debugging information by as much as a
6748 factor of two.
6750 @item -fno-merge-debug-strings
6751 @opindex fmerge-debug-strings
6752 @opindex fno-merge-debug-strings
6753 Direct the linker to not merge together strings in the debugging
6754 information that are identical in different object files.  Merging is
6755 not supported by all assemblers or linkers.  Merging decreases the size
6756 of the debug information in the output file at the cost of increasing
6757 link processing time.  Merging is enabled by default.
6759 @item -fdebug-prefix-map=@var{old}=@var{new}
6760 @opindex fdebug-prefix-map
6761 When compiling files in directory @file{@var{old}}, record debugging
6762 information describing them as in @file{@var{new}} instead.
6764 @item -fvar-tracking
6765 @opindex fvar-tracking
6766 Run variable tracking pass.  It computes where variables are stored at each
6767 position in code.  Better debugging information is then generated
6768 (if the debugging information format supports this information).
6770 It is enabled by default when compiling with optimization (@option{-Os},
6771 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
6772 the debug info format supports it.
6774 @item -fvar-tracking-assignments
6775 @opindex fvar-tracking-assignments
6776 @opindex fno-var-tracking-assignments
6777 Annotate assignments to user variables early in the compilation and
6778 attempt to carry the annotations over throughout the compilation all the
6779 way to the end, in an attempt to improve debug information while
6780 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
6782 It can be enabled even if var-tracking is disabled, in which case
6783 annotations are created and maintained, but discarded at the end.
6784 By default, this flag is enabled together with @option{-fvar-tracking},
6785 except when selective scheduling is enabled.
6787 @item -gsplit-dwarf
6788 @opindex gsplit-dwarf
6789 Separate as much DWARF debugging information as possible into a
6790 separate output file with the extension @file{.dwo}.  This option allows
6791 the build system to avoid linking files with debug information.  To
6792 be useful, this option requires a debugger capable of reading @file{.dwo}
6793 files.
6795 @item -gpubnames
6796 @opindex gpubnames
6797 Generate DWARF @code{.debug_pubnames} and @code{.debug_pubtypes} sections.
6799 @item -ggnu-pubnames
6800 @opindex ggnu-pubnames
6801 Generate @code{.debug_pubnames} and @code{.debug_pubtypes} sections in a format
6802 suitable for conversion into a GDB@ index.  This option is only useful
6803 with a linker that can produce GDB@ index version 7.
6805 @item -fdebug-types-section
6806 @opindex fdebug-types-section
6807 @opindex fno-debug-types-section
6808 When using DWARF Version 4 or higher, type DIEs can be put into
6809 their own @code{.debug_types} section instead of making them part of the
6810 @code{.debug_info} section.  It is more efficient to put them in a separate
6811 comdat sections since the linker can then remove duplicates.
6812 But not all DWARF consumers support @code{.debug_types} sections yet
6813 and on some objects @code{.debug_types} produces larger instead of smaller
6814 debugging information.
6816 @item -grecord-gcc-switches
6817 @item -gno-record-gcc-switches
6818 @opindex grecord-gcc-switches
6819 @opindex gno-record-gcc-switches
6820 This switch causes the command-line options used to invoke the
6821 compiler that may affect code generation to be appended to the
6822 DW_AT_producer attribute in DWARF debugging information.  The options
6823 are concatenated with spaces separating them from each other and from
6824 the compiler version.  
6825 It is enabled by default.
6826 See also @option{-frecord-gcc-switches} for another
6827 way of storing compiler options into the object file.  
6829 @item -gstrict-dwarf
6830 @opindex gstrict-dwarf
6831 Disallow using extensions of later DWARF standard version than selected
6832 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
6833 DWARF extensions from later standard versions is allowed.
6835 @item -gno-strict-dwarf
6836 @opindex gno-strict-dwarf
6837 Allow using extensions of later DWARF standard version than selected with
6838 @option{-gdwarf-@var{version}}.
6840 @item -gcolumn-info
6841 @item -gno-column-info
6842 @opindex gcolumn-info
6843 @opindex gno-column-info
6844 Emit location column information into DWARF debugging information, rather
6845 than just file and line.
6846 This option is disabled by default.
6848 @item -gz@r{[}=@var{type}@r{]}
6849 @opindex gz
6850 Produce compressed debug sections in DWARF format, if that is supported.
6851 If @var{type} is not given, the default type depends on the capabilities
6852 of the assembler and linker used.  @var{type} may be one of
6853 @samp{none} (don't compress debug sections), @samp{zlib} (use zlib
6854 compression in ELF gABI format), or @samp{zlib-gnu} (use zlib
6855 compression in traditional GNU format).  If the linker doesn't support
6856 writing compressed debug sections, the option is rejected.  Otherwise,
6857 if the assembler does not support them, @option{-gz} is silently ignored
6858 when producing object files.
6860 @item -feliminate-dwarf2-dups
6861 @opindex feliminate-dwarf2-dups
6862 Compress DWARF debugging information by eliminating duplicated
6863 information about each symbol.  This option only makes sense when
6864 generating DWARF debugging information.
6866 @item -femit-struct-debug-baseonly
6867 @opindex femit-struct-debug-baseonly
6868 Emit debug information for struct-like types
6869 only when the base name of the compilation source file
6870 matches the base name of file in which the struct is defined.
6872 This option substantially reduces the size of debugging information,
6873 but at significant potential loss in type information to the debugger.
6874 See @option{-femit-struct-debug-reduced} for a less aggressive option.
6875 See @option{-femit-struct-debug-detailed} for more detailed control.
6877 This option works only with DWARF debug output.
6879 @item -femit-struct-debug-reduced
6880 @opindex femit-struct-debug-reduced
6881 Emit debug information for struct-like types
6882 only when the base name of the compilation source file
6883 matches the base name of file in which the type is defined,
6884 unless the struct is a template or defined in a system header.
6886 This option significantly reduces the size of debugging information,
6887 with some potential loss in type information to the debugger.
6888 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
6889 See @option{-femit-struct-debug-detailed} for more detailed control.
6891 This option works only with DWARF debug output.
6893 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
6894 @opindex femit-struct-debug-detailed
6895 Specify the struct-like types
6896 for which the compiler generates debug information.
6897 The intent is to reduce duplicate struct debug information
6898 between different object files within the same program.
6900 This option is a detailed version of
6901 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
6902 which serves for most needs.
6904 A specification has the syntax@*
6905 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
6907 The optional first word limits the specification to
6908 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
6909 A struct type is used directly when it is the type of a variable, member.
6910 Indirect uses arise through pointers to structs.
6911 That is, when use of an incomplete struct is valid, the use is indirect.
6912 An example is
6913 @samp{struct one direct; struct two * indirect;}.
6915 The optional second word limits the specification to
6916 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
6917 Generic structs are a bit complicated to explain.
6918 For C++, these are non-explicit specializations of template classes,
6919 or non-template classes within the above.
6920 Other programming languages have generics,
6921 but @option{-femit-struct-debug-detailed} does not yet implement them.
6923 The third word specifies the source files for those
6924 structs for which the compiler should emit debug information.
6925 The values @samp{none} and @samp{any} have the normal meaning.
6926 The value @samp{base} means that
6927 the base of name of the file in which the type declaration appears
6928 must match the base of the name of the main compilation file.
6929 In practice, this means that when compiling @file{foo.c}, debug information
6930 is generated for types declared in that file and @file{foo.h},
6931 but not other header files.
6932 The value @samp{sys} means those types satisfying @samp{base}
6933 or declared in system or compiler headers.
6935 You may need to experiment to determine the best settings for your application.
6937 The default is @option{-femit-struct-debug-detailed=all}.
6939 This option works only with DWARF debug output.
6941 @item -fno-dwarf2-cfi-asm
6942 @opindex fdwarf2-cfi-asm
6943 @opindex fno-dwarf2-cfi-asm
6944 Emit DWARF unwind info as compiler generated @code{.eh_frame} section
6945 instead of using GAS @code{.cfi_*} directives.
6947 @item -fno-eliminate-unused-debug-types
6948 @opindex feliminate-unused-debug-types
6949 @opindex fno-eliminate-unused-debug-types
6950 Normally, when producing DWARF output, GCC avoids producing debug symbol 
6951 output for types that are nowhere used in the source file being compiled.
6952 Sometimes it is useful to have GCC emit debugging
6953 information for all types declared in a compilation
6954 unit, regardless of whether or not they are actually used
6955 in that compilation unit, for example 
6956 if, in the debugger, you want to cast a value to a type that is
6957 not actually used in your program (but is declared).  More often,
6958 however, this results in a significant amount of wasted space.
6959 @end table
6961 @node Optimize Options
6962 @section Options That Control Optimization
6963 @cindex optimize options
6964 @cindex options, optimization
6966 These options control various sorts of optimizations.
6968 Without any optimization option, the compiler's goal is to reduce the
6969 cost of compilation and to make debugging produce the expected
6970 results.  Statements are independent: if you stop the program with a
6971 breakpoint between statements, you can then assign a new value to any
6972 variable or change the program counter to any other statement in the
6973 function and get exactly the results you expect from the source
6974 code.
6976 Turning on optimization flags makes the compiler attempt to improve
6977 the performance and/or code size at the expense of compilation time
6978 and possibly the ability to debug the program.
6980 The compiler performs optimization based on the knowledge it has of the
6981 program.  Compiling multiple files at once to a single output file mode allows
6982 the compiler to use information gained from all of the files when compiling
6983 each of them.
6985 Not all optimizations are controlled directly by a flag.  Only
6986 optimizations that have a flag are listed in this section.
6988 Most optimizations are only enabled if an @option{-O} level is set on
6989 the command line.  Otherwise they are disabled, even if individual
6990 optimization flags are specified.
6992 Depending on the target and how GCC was configured, a slightly different
6993 set of optimizations may be enabled at each @option{-O} level than
6994 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
6995 to find out the exact set of optimizations that are enabled at each level.
6996 @xref{Overall Options}, for examples.
6998 @table @gcctabopt
6999 @item -O
7000 @itemx -O1
7001 @opindex O
7002 @opindex O1
7003 Optimize.  Optimizing compilation takes somewhat more time, and a lot
7004 more memory for a large function.
7006 With @option{-O}, the compiler tries to reduce code size and execution
7007 time, without performing any optimizations that take a great deal of
7008 compilation time.
7010 @option{-O} turns on the following optimization flags:
7011 @gccoptlist{
7012 -fauto-inc-dec @gol
7013 -fbranch-count-reg @gol
7014 -fcombine-stack-adjustments @gol
7015 -fcompare-elim @gol
7016 -fcprop-registers @gol
7017 -fdce @gol
7018 -fdefer-pop @gol
7019 -fdelayed-branch @gol
7020 -fdse @gol
7021 -fforward-propagate @gol
7022 -fguess-branch-probability @gol
7023 -fif-conversion2 @gol
7024 -fif-conversion @gol
7025 -finline-functions-called-once @gol
7026 -fipa-pure-const @gol
7027 -fipa-profile @gol
7028 -fipa-reference @gol
7029 -fmerge-constants @gol
7030 -fmove-loop-invariants @gol
7031 -freorder-blocks @gol
7032 -fshrink-wrap @gol
7033 -fshrink-wrap-separate @gol
7034 -fsplit-wide-types @gol
7035 -fssa-backprop @gol
7036 -fssa-phiopt @gol
7037 -ftree-bit-ccp @gol
7038 -ftree-ccp @gol
7039 -ftree-ch @gol
7040 -ftree-coalesce-vars @gol
7041 -ftree-copy-prop @gol
7042 -ftree-dce @gol
7043 -ftree-dominator-opts @gol
7044 -ftree-dse @gol
7045 -ftree-forwprop @gol
7046 -ftree-fre @gol
7047 -ftree-phiprop @gol
7048 -ftree-sink @gol
7049 -ftree-slsr @gol
7050 -ftree-sra @gol
7051 -ftree-pta @gol
7052 -ftree-ter @gol
7053 -funit-at-a-time}
7055 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
7056 where doing so does not interfere with debugging.
7058 @item -O2
7059 @opindex O2
7060 Optimize even more.  GCC performs nearly all supported optimizations
7061 that do not involve a space-speed tradeoff.
7062 As compared to @option{-O}, this option increases both compilation time
7063 and the performance of the generated code.
7065 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
7066 also turns on the following optimization flags:
7067 @gccoptlist{-fthread-jumps @gol
7068 -falign-functions  -falign-jumps @gol
7069 -falign-loops  -falign-labels @gol
7070 -fcaller-saves @gol
7071 -fcrossjumping @gol
7072 -fcse-follow-jumps  -fcse-skip-blocks @gol
7073 -fdelete-null-pointer-checks @gol
7074 -fdevirtualize -fdevirtualize-speculatively @gol
7075 -fexpensive-optimizations @gol
7076 -fgcse  -fgcse-lm  @gol
7077 -fhoist-adjacent-loads @gol
7078 -finline-small-functions @gol
7079 -findirect-inlining @gol
7080 -fipa-cp @gol
7081 -fipa-bit-cp @gol
7082 -fipa-sra @gol
7083 -fipa-icf @gol
7084 -fisolate-erroneous-paths-dereference @gol
7085 -flra-remat @gol
7086 -foptimize-sibling-calls @gol
7087 -foptimize-strlen @gol
7088 -fpartial-inlining @gol
7089 -fpeephole2 @gol
7090 -freorder-blocks-algorithm=stc @gol
7091 -freorder-blocks-and-partition -freorder-functions @gol
7092 -frerun-cse-after-loop  @gol
7093 -fsched-interblock  -fsched-spec @gol
7094 -fschedule-insns  -fschedule-insns2 @gol
7095 -fstore-merging @gol
7096 -fstrict-aliasing -fstrict-overflow @gol
7097 -ftree-builtin-call-dce @gol
7098 -ftree-switch-conversion -ftree-tail-merge @gol
7099 -fcode-hoisting @gol
7100 -ftree-pre @gol
7101 -ftree-vrp @gol
7102 -fipa-ra}
7104 Please note the warning under @option{-fgcse} about
7105 invoking @option{-O2} on programs that use computed gotos.
7107 @item -O3
7108 @opindex O3
7109 Optimize yet more.  @option{-O3} turns on all optimizations specified
7110 by @option{-O2} and also turns on the @option{-finline-functions},
7111 @option{-funswitch-loops}, @option{-fpredictive-commoning},
7112 @option{-fgcse-after-reload}, @option{-ftree-loop-vectorize},
7113 @option{-ftree-loop-distribute-patterns}, @option{-fsplit-paths}
7114 @option{-ftree-slp-vectorize}, @option{-fvect-cost-model},
7115 @option{-ftree-partial-pre}, @option{-fpeel-loops}
7116 and @option{-fipa-cp-clone} options.
7118 @item -O0
7119 @opindex O0
7120 Reduce compilation time and make debugging produce the expected
7121 results.  This is the default.
7123 @item -Os
7124 @opindex Os
7125 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
7126 do not typically increase code size.  It also performs further
7127 optimizations designed to reduce code size.
7129 @option{-Os} disables the following optimization flags:
7130 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
7131 -falign-labels  -freorder-blocks  -freorder-blocks-algorithm=stc @gol
7132 -freorder-blocks-and-partition  -fprefetch-loop-arrays}
7134 @item -Ofast
7135 @opindex Ofast
7136 Disregard strict standards compliance.  @option{-Ofast} enables all
7137 @option{-O3} optimizations.  It also enables optimizations that are not
7138 valid for all standard-compliant programs.
7139 It turns on @option{-ffast-math} and the Fortran-specific
7140 @option{-fno-protect-parens} and @option{-fstack-arrays}.
7142 @item -Og
7143 @opindex Og
7144 Optimize debugging experience.  @option{-Og} enables optimizations
7145 that do not interfere with debugging. It should be the optimization
7146 level of choice for the standard edit-compile-debug cycle, offering
7147 a reasonable level of optimization while maintaining fast compilation
7148 and a good debugging experience.
7149 @end table
7151 If you use multiple @option{-O} options, with or without level numbers,
7152 the last such option is the one that is effective.
7154 Options of the form @option{-f@var{flag}} specify machine-independent
7155 flags.  Most flags have both positive and negative forms; the negative
7156 form of @option{-ffoo} is @option{-fno-foo}.  In the table
7157 below, only one of the forms is listed---the one you typically 
7158 use.  You can figure out the other form by either removing @samp{no-}
7159 or adding it.
7161 The following options control specific optimizations.  They are either
7162 activated by @option{-O} options or are related to ones that are.  You
7163 can use the following flags in the rare cases when ``fine-tuning'' of
7164 optimizations to be performed is desired.
7166 @table @gcctabopt
7167 @item -fno-defer-pop
7168 @opindex fno-defer-pop
7169 Always pop the arguments to each function call as soon as that function
7170 returns.  For machines that must pop arguments after a function call,
7171 the compiler normally lets arguments accumulate on the stack for several
7172 function calls and pops them all at once.
7174 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7176 @item -fforward-propagate
7177 @opindex fforward-propagate
7178 Perform a forward propagation pass on RTL@.  The pass tries to combine two
7179 instructions and checks if the result can be simplified.  If loop unrolling
7180 is active, two passes are performed and the second is scheduled after
7181 loop unrolling.
7183 This option is enabled by default at optimization levels @option{-O},
7184 @option{-O2}, @option{-O3}, @option{-Os}.
7186 @item -ffp-contract=@var{style}
7187 @opindex ffp-contract
7188 @option{-ffp-contract=off} disables floating-point expression contraction.
7189 @option{-ffp-contract=fast} enables floating-point expression contraction
7190 such as forming of fused multiply-add operations if the target has
7191 native support for them.
7192 @option{-ffp-contract=on} enables floating-point expression contraction
7193 if allowed by the language standard.  This is currently not implemented
7194 and treated equal to @option{-ffp-contract=off}.
7196 The default is @option{-ffp-contract=fast}.
7198 @item -fomit-frame-pointer
7199 @opindex fomit-frame-pointer
7200 Don't keep the frame pointer in a register for functions that
7201 don't need one.  This avoids the instructions to save, set up and
7202 restore frame pointers; it also makes an extra register available
7203 in many functions.  @strong{It also makes debugging impossible on
7204 some machines.}
7206 On some machines, such as the VAX, this flag has no effect, because
7207 the standard calling sequence automatically handles the frame pointer
7208 and nothing is saved by pretending it doesn't exist.  The
7209 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
7210 whether a target machine supports this flag.  @xref{Registers,,Register
7211 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
7213 The default setting (when not optimizing for
7214 size) for 32-bit GNU/Linux x86 and 32-bit Darwin x86 targets is
7215 @option{-fomit-frame-pointer}.  You can configure GCC with the
7216 @option{--enable-frame-pointer} configure option to change the default.
7218 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7220 @item -foptimize-sibling-calls
7221 @opindex foptimize-sibling-calls
7222 Optimize sibling and tail recursive calls.
7224 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7226 @item -foptimize-strlen
7227 @opindex foptimize-strlen
7228 Optimize various standard C string functions (e.g. @code{strlen},
7229 @code{strchr} or @code{strcpy}) and
7230 their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
7232 Enabled at levels @option{-O2}, @option{-O3}.
7234 @item -fno-inline
7235 @opindex fno-inline
7236 Do not expand any functions inline apart from those marked with
7237 the @code{always_inline} attribute.  This is the default when not
7238 optimizing.
7240 Single functions can be exempted from inlining by marking them
7241 with the @code{noinline} attribute.
7243 @item -finline-small-functions
7244 @opindex finline-small-functions
7245 Integrate functions into their callers when their body is smaller than expected
7246 function call code (so overall size of program gets smaller).  The compiler
7247 heuristically decides which functions are simple enough to be worth integrating
7248 in this way.  This inlining applies to all functions, even those not declared
7249 inline.
7251 Enabled at level @option{-O2}.
7253 @item -findirect-inlining
7254 @opindex findirect-inlining
7255 Inline also indirect calls that are discovered to be known at compile
7256 time thanks to previous inlining.  This option has any effect only
7257 when inlining itself is turned on by the @option{-finline-functions}
7258 or @option{-finline-small-functions} options.
7260 Enabled at level @option{-O2}.
7262 @item -finline-functions
7263 @opindex finline-functions
7264 Consider all functions for inlining, even if they are not declared inline.
7265 The compiler heuristically decides which functions are worth integrating
7266 in this way.
7268 If all calls to a given function are integrated, and the function is
7269 declared @code{static}, then the function is normally not output as
7270 assembler code in its own right.
7272 Enabled at level @option{-O3}.
7274 @item -finline-functions-called-once
7275 @opindex finline-functions-called-once
7276 Consider all @code{static} functions called once for inlining into their
7277 caller even if they are not marked @code{inline}.  If a call to a given
7278 function is integrated, then the function is not output as assembler code
7279 in its own right.
7281 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
7283 @item -fearly-inlining
7284 @opindex fearly-inlining
7285 Inline functions marked by @code{always_inline} and functions whose body seems
7286 smaller than the function call overhead early before doing
7287 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
7288 makes profiling significantly cheaper and usually inlining faster on programs
7289 having large chains of nested wrapper functions.
7291 Enabled by default.
7293 @item -fipa-sra
7294 @opindex fipa-sra
7295 Perform interprocedural scalar replacement of aggregates, removal of
7296 unused parameters and replacement of parameters passed by reference
7297 by parameters passed by value.
7299 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
7301 @item -finline-limit=@var{n}
7302 @opindex finline-limit
7303 By default, GCC limits the size of functions that can be inlined.  This flag
7304 allows coarse control of this limit.  @var{n} is the size of functions that
7305 can be inlined in number of pseudo instructions.
7307 Inlining is actually controlled by a number of parameters, which may be
7308 specified individually by using @option{--param @var{name}=@var{value}}.
7309 The @option{-finline-limit=@var{n}} option sets some of these parameters
7310 as follows:
7312 @table @gcctabopt
7313 @item max-inline-insns-single
7314 is set to @var{n}/2.
7315 @item max-inline-insns-auto
7316 is set to @var{n}/2.
7317 @end table
7319 See below for a documentation of the individual
7320 parameters controlling inlining and for the defaults of these parameters.
7322 @emph{Note:} there may be no value to @option{-finline-limit} that results
7323 in default behavior.
7325 @emph{Note:} pseudo instruction represents, in this particular context, an
7326 abstract measurement of function's size.  In no way does it represent a count
7327 of assembly instructions and as such its exact meaning might change from one
7328 release to an another.
7330 @item -fno-keep-inline-dllexport
7331 @opindex fno-keep-inline-dllexport
7332 This is a more fine-grained version of @option{-fkeep-inline-functions},
7333 which applies only to functions that are declared using the @code{dllexport}
7334 attribute or declspec.  @xref{Function Attributes,,Declaring Attributes of
7335 Functions}.
7337 @item -fkeep-inline-functions
7338 @opindex fkeep-inline-functions
7339 In C, emit @code{static} functions that are declared @code{inline}
7340 into the object file, even if the function has been inlined into all
7341 of its callers.  This switch does not affect functions using the
7342 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
7343 inline functions into the object file.
7345 @item -fkeep-static-functions
7346 @opindex fkeep-static-functions
7347 Emit @code{static} functions into the object file, even if the function
7348 is never used.
7350 @item -fkeep-static-consts
7351 @opindex fkeep-static-consts
7352 Emit variables declared @code{static const} when optimization isn't turned
7353 on, even if the variables aren't referenced.
7355 GCC enables this option by default.  If you want to force the compiler to
7356 check if a variable is referenced, regardless of whether or not
7357 optimization is turned on, use the @option{-fno-keep-static-consts} option.
7359 @item -fmerge-constants
7360 @opindex fmerge-constants
7361 Attempt to merge identical constants (string constants and floating-point
7362 constants) across compilation units.
7364 This option is the default for optimized compilation if the assembler and
7365 linker support it.  Use @option{-fno-merge-constants} to inhibit this
7366 behavior.
7368 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7370 @item -fmerge-all-constants
7371 @opindex fmerge-all-constants
7372 Attempt to merge identical constants and identical variables.
7374 This option implies @option{-fmerge-constants}.  In addition to
7375 @option{-fmerge-constants} this considers e.g.@: even constant initialized
7376 arrays or initialized constant variables with integral or floating-point
7377 types.  Languages like C or C++ require each variable, including multiple
7378 instances of the same variable in recursive calls, to have distinct locations,
7379 so using this option results in non-conforming
7380 behavior.
7382 @item -fmodulo-sched
7383 @opindex fmodulo-sched
7384 Perform swing modulo scheduling immediately before the first scheduling
7385 pass.  This pass looks at innermost loops and reorders their
7386 instructions by overlapping different iterations.
7388 @item -fmodulo-sched-allow-regmoves
7389 @opindex fmodulo-sched-allow-regmoves
7390 Perform more aggressive SMS-based modulo scheduling with register moves
7391 allowed.  By setting this flag certain anti-dependences edges are
7392 deleted, which triggers the generation of reg-moves based on the
7393 life-range analysis.  This option is effective only with
7394 @option{-fmodulo-sched} enabled.
7396 @item -fno-branch-count-reg
7397 @opindex fno-branch-count-reg
7398 Avoid running a pass scanning for opportunities to use ``decrement and
7399 branch'' instructions on a count register instead of generating sequences
7400 of instructions that decrement a register, compare it against zero, and
7401 then branch based upon the result.  This option is only meaningful on
7402 architectures that support such instructions, which include x86, PowerPC,
7403 IA-64 and S/390.  Note that the @option{-fno-branch-count-reg} option
7404 doesn't remove the decrement and branch instructions from the generated
7405 instruction stream introduced by other optimization passes.
7407 Enabled by default at @option{-O1} and higher.
7409 The default is @option{-fbranch-count-reg}.
7411 @item -fno-function-cse
7412 @opindex fno-function-cse
7413 Do not put function addresses in registers; make each instruction that
7414 calls a constant function contain the function's address explicitly.
7416 This option results in less efficient code, but some strange hacks
7417 that alter the assembler output may be confused by the optimizations
7418 performed when this option is not used.
7420 The default is @option{-ffunction-cse}
7422 @item -fno-zero-initialized-in-bss
7423 @opindex fno-zero-initialized-in-bss
7424 If the target supports a BSS section, GCC by default puts variables that
7425 are initialized to zero into BSS@.  This can save space in the resulting
7426 code.
7428 This option turns off this behavior because some programs explicitly
7429 rely on variables going to the data section---e.g., so that the
7430 resulting executable can find the beginning of that section and/or make
7431 assumptions based on that.
7433 The default is @option{-fzero-initialized-in-bss}.
7435 @item -fthread-jumps
7436 @opindex fthread-jumps
7437 Perform optimizations that check to see if a jump branches to a
7438 location where another comparison subsumed by the first is found.  If
7439 so, the first branch is redirected to either the destination of the
7440 second branch or a point immediately following it, depending on whether
7441 the condition is known to be true or false.
7443 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7445 @item -fsplit-wide-types
7446 @opindex fsplit-wide-types
7447 When using a type that occupies multiple registers, such as @code{long
7448 long} on a 32-bit system, split the registers apart and allocate them
7449 independently.  This normally generates better code for those types,
7450 but may make debugging more difficult.
7452 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
7453 @option{-Os}.
7455 @item -fcse-follow-jumps
7456 @opindex fcse-follow-jumps
7457 In common subexpression elimination (CSE), scan through jump instructions
7458 when the target of the jump is not reached by any other path.  For
7459 example, when CSE encounters an @code{if} statement with an
7460 @code{else} clause, CSE follows the jump when the condition
7461 tested is false.
7463 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7465 @item -fcse-skip-blocks
7466 @opindex fcse-skip-blocks
7467 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
7468 follow jumps that conditionally skip over blocks.  When CSE
7469 encounters a simple @code{if} statement with no else clause,
7470 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
7471 body of the @code{if}.
7473 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7475 @item -frerun-cse-after-loop
7476 @opindex frerun-cse-after-loop
7477 Re-run common subexpression elimination after loop optimizations are
7478 performed.
7480 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7482 @item -fgcse
7483 @opindex fgcse
7484 Perform a global common subexpression elimination pass.
7485 This pass also performs global constant and copy propagation.
7487 @emph{Note:} When compiling a program using computed gotos, a GCC
7488 extension, you may get better run-time performance if you disable
7489 the global common subexpression elimination pass by adding
7490 @option{-fno-gcse} to the command line.
7492 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7494 @item -fgcse-lm
7495 @opindex fgcse-lm
7496 When @option{-fgcse-lm} is enabled, global common subexpression elimination
7497 attempts to move loads that are only killed by stores into themselves.  This
7498 allows a loop containing a load/store sequence to be changed to a load outside
7499 the loop, and a copy/store within the loop.
7501 Enabled by default when @option{-fgcse} is enabled.
7503 @item -fgcse-sm
7504 @opindex fgcse-sm
7505 When @option{-fgcse-sm} is enabled, a store motion pass is run after
7506 global common subexpression elimination.  This pass attempts to move
7507 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
7508 loops containing a load/store sequence can be changed to a load before
7509 the loop and a store after the loop.
7511 Not enabled at any optimization level.
7513 @item -fgcse-las
7514 @opindex fgcse-las
7515 When @option{-fgcse-las} is enabled, the global common subexpression
7516 elimination pass eliminates redundant loads that come after stores to the
7517 same memory location (both partial and full redundancies).
7519 Not enabled at any optimization level.
7521 @item -fgcse-after-reload
7522 @opindex fgcse-after-reload
7523 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
7524 pass is performed after reload.  The purpose of this pass is to clean up
7525 redundant spilling.
7527 @item -faggressive-loop-optimizations
7528 @opindex faggressive-loop-optimizations
7529 This option tells the loop optimizer to use language constraints to
7530 derive bounds for the number of iterations of a loop.  This assumes that
7531 loop code does not invoke undefined behavior by for example causing signed
7532 integer overflows or out-of-bound array accesses.  The bounds for the
7533 number of iterations of a loop are used to guide loop unrolling and peeling
7534 and loop exit test optimizations.
7535 This option is enabled by default.
7537 @item -funconstrained-commons
7538 @opindex funconstrained-commons
7539 This option tells the compiler that variables declared in common blocks
7540 (e.g. Fortran) may later be overridden with longer trailing arrays. This
7541 prevents certain optimizations that depend on knowing the array bounds.
7543 @item -fcrossjumping
7544 @opindex fcrossjumping
7545 Perform cross-jumping transformation.
7546 This transformation unifies equivalent code and saves code size.  The
7547 resulting code may or may not perform better than without cross-jumping.
7549 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7551 @item -fauto-inc-dec
7552 @opindex fauto-inc-dec
7553 Combine increments or decrements of addresses with memory accesses.
7554 This pass is always skipped on architectures that do not have
7555 instructions to support this.  Enabled by default at @option{-O} and
7556 higher on architectures that support this.
7558 @item -fdce
7559 @opindex fdce
7560 Perform dead code elimination (DCE) on RTL@.
7561 Enabled by default at @option{-O} and higher.
7563 @item -fdse
7564 @opindex fdse
7565 Perform dead store elimination (DSE) on RTL@.
7566 Enabled by default at @option{-O} and higher.
7568 @item -fif-conversion
7569 @opindex fif-conversion
7570 Attempt to transform conditional jumps into branch-less equivalents.  This
7571 includes use of conditional moves, min, max, set flags and abs instructions, and
7572 some tricks doable by standard arithmetics.  The use of conditional execution
7573 on chips where it is available is controlled by @option{-fif-conversion2}.
7575 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7577 @item -fif-conversion2
7578 @opindex fif-conversion2
7579 Use conditional execution (where available) to transform conditional jumps into
7580 branch-less equivalents.
7582 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7584 @item -fdeclone-ctor-dtor
7585 @opindex fdeclone-ctor-dtor
7586 The C++ ABI requires multiple entry points for constructors and
7587 destructors: one for a base subobject, one for a complete object, and
7588 one for a virtual destructor that calls operator delete afterwards.
7589 For a hierarchy with virtual bases, the base and complete variants are
7590 clones, which means two copies of the function.  With this option, the
7591 base and complete variants are changed to be thunks that call a common
7592 implementation.
7594 Enabled by @option{-Os}.
7596 @item -fdelete-null-pointer-checks
7597 @opindex fdelete-null-pointer-checks
7598 Assume that programs cannot safely dereference null pointers, and that
7599 no code or data element resides at address zero.
7600 This option enables simple constant
7601 folding optimizations at all optimization levels.  In addition, other
7602 optimization passes in GCC use this flag to control global dataflow
7603 analyses that eliminate useless checks for null pointers; these assume
7604 that a memory access to address zero always results in a trap, so
7605 that if a pointer is checked after it has already been dereferenced,
7606 it cannot be null.
7608 Note however that in some environments this assumption is not true.
7609 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
7610 for programs that depend on that behavior.
7612 This option is enabled by default on most targets.  On Nios II ELF, it
7613 defaults to off.  On AVR and CR16, this option is completely disabled.  
7615 Passes that use the dataflow information
7616 are enabled independently at different optimization levels.
7618 @item -fdevirtualize
7619 @opindex fdevirtualize
7620 Attempt to convert calls to virtual functions to direct calls.  This
7621 is done both within a procedure and interprocedurally as part of
7622 indirect inlining (@option{-findirect-inlining}) and interprocedural constant
7623 propagation (@option{-fipa-cp}).
7624 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7626 @item -fdevirtualize-speculatively
7627 @opindex fdevirtualize-speculatively
7628 Attempt to convert calls to virtual functions to speculative direct calls.
7629 Based on the analysis of the type inheritance graph, determine for a given call
7630 the set of likely targets. If the set is small, preferably of size 1, change
7631 the call into a conditional deciding between direct and indirect calls.  The
7632 speculative calls enable more optimizations, such as inlining.  When they seem
7633 useless after further optimization, they are converted back into original form.
7635 @item -fdevirtualize-at-ltrans
7636 @opindex fdevirtualize-at-ltrans
7637 Stream extra information needed for aggressive devirtualization when running
7638 the link-time optimizer in local transformation mode.  
7639 This option enables more devirtualization but
7640 significantly increases the size of streamed data. For this reason it is
7641 disabled by default.
7643 @item -fexpensive-optimizations
7644 @opindex fexpensive-optimizations
7645 Perform a number of minor optimizations that are relatively expensive.
7647 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7649 @item -free
7650 @opindex free
7651 Attempt to remove redundant extension instructions.  This is especially
7652 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
7653 registers after writing to their lower 32-bit half.
7655 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
7656 @option{-O3}, @option{-Os}.
7658 @item -fno-lifetime-dse
7659 @opindex fno-lifetime-dse
7660 In C++ the value of an object is only affected by changes within its
7661 lifetime: when the constructor begins, the object has an indeterminate
7662 value, and any changes during the lifetime of the object are dead when
7663 the object is destroyed.  Normally dead store elimination will take
7664 advantage of this; if your code relies on the value of the object
7665 storage persisting beyond the lifetime of the object, you can use this
7666 flag to disable this optimization.  To preserve stores before the
7667 constructor starts (e.g. because your operator new clears the object
7668 storage) but still treat the object as dead after the destructor you,
7669 can use @option{-flifetime-dse=1}.  The default behavior can be
7670 explicitly selected with @option{-flifetime-dse=2}.
7671 @option{-flifetime-dse=0} is equivalent to @option{-fno-lifetime-dse}.
7673 @item -flive-range-shrinkage
7674 @opindex flive-range-shrinkage
7675 Attempt to decrease register pressure through register live range
7676 shrinkage.  This is helpful for fast processors with small or moderate
7677 size register sets.
7679 @item -fira-algorithm=@var{algorithm}
7680 @opindex fira-algorithm
7681 Use the specified coloring algorithm for the integrated register
7682 allocator.  The @var{algorithm} argument can be @samp{priority}, which
7683 specifies Chow's priority coloring, or @samp{CB}, which specifies
7684 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
7685 for all architectures, but for those targets that do support it, it is
7686 the default because it generates better code.
7688 @item -fira-region=@var{region}
7689 @opindex fira-region
7690 Use specified regions for the integrated register allocator.  The
7691 @var{region} argument should be one of the following:
7693 @table @samp
7695 @item all
7696 Use all loops as register allocation regions.
7697 This can give the best results for machines with a small and/or
7698 irregular register set.
7700 @item mixed
7701 Use all loops except for loops with small register pressure 
7702 as the regions.  This value usually gives
7703 the best results in most cases and for most architectures,
7704 and is enabled by default when compiling with optimization for speed
7705 (@option{-O}, @option{-O2}, @dots{}).
7707 @item one
7708 Use all functions as a single region.  
7709 This typically results in the smallest code size, and is enabled by default for
7710 @option{-Os} or @option{-O0}.
7712 @end table
7714 @item -fira-hoist-pressure
7715 @opindex fira-hoist-pressure
7716 Use IRA to evaluate register pressure in the code hoisting pass for
7717 decisions to hoist expressions.  This option usually results in smaller
7718 code, but it can slow the compiler down.
7720 This option is enabled at level @option{-Os} for all targets.
7722 @item -fira-loop-pressure
7723 @opindex fira-loop-pressure
7724 Use IRA to evaluate register pressure in loops for decisions to move
7725 loop invariants.  This option usually results in generation
7726 of faster and smaller code on machines with large register files (>= 32
7727 registers), but it can slow the compiler down.
7729 This option is enabled at level @option{-O3} for some targets.
7731 @item -fno-ira-share-save-slots
7732 @opindex fno-ira-share-save-slots
7733 Disable sharing of stack slots used for saving call-used hard
7734 registers living through a call.  Each hard register gets a
7735 separate stack slot, and as a result function stack frames are
7736 larger.
7738 @item -fno-ira-share-spill-slots
7739 @opindex fno-ira-share-spill-slots
7740 Disable sharing of stack slots allocated for pseudo-registers.  Each
7741 pseudo-register that does not get a hard register gets a separate
7742 stack slot, and as a result function stack frames are larger.
7744 @item -flra-remat
7745 @opindex flra-remat
7746 Enable CFG-sensitive rematerialization in LRA.  Instead of loading
7747 values of spilled pseudos, LRA tries to rematerialize (recalculate)
7748 values if it is profitable.
7750 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7752 @item -fdelayed-branch
7753 @opindex fdelayed-branch
7754 If supported for the target machine, attempt to reorder instructions
7755 to exploit instruction slots available after delayed branch
7756 instructions.
7758 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7760 @item -fschedule-insns
7761 @opindex fschedule-insns
7762 If supported for the target machine, attempt to reorder instructions to
7763 eliminate execution stalls due to required data being unavailable.  This
7764 helps machines that have slow floating point or memory load instructions
7765 by allowing other instructions to be issued until the result of the load
7766 or floating-point instruction is required.
7768 Enabled at levels @option{-O2}, @option{-O3}.
7770 @item -fschedule-insns2
7771 @opindex fschedule-insns2
7772 Similar to @option{-fschedule-insns}, but requests an additional pass of
7773 instruction scheduling after register allocation has been done.  This is
7774 especially useful on machines with a relatively small number of
7775 registers and where memory load instructions take more than one cycle.
7777 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7779 @item -fno-sched-interblock
7780 @opindex fno-sched-interblock
7781 Don't schedule instructions across basic blocks.  This is normally
7782 enabled by default when scheduling before register allocation, i.e.@:
7783 with @option{-fschedule-insns} or at @option{-O2} or higher.
7785 @item -fno-sched-spec
7786 @opindex fno-sched-spec
7787 Don't allow speculative motion of non-load instructions.  This is normally
7788 enabled by default when scheduling before register allocation, i.e.@:
7789 with @option{-fschedule-insns} or at @option{-O2} or higher.
7791 @item -fsched-pressure
7792 @opindex fsched-pressure
7793 Enable register pressure sensitive insn scheduling before register
7794 allocation.  This only makes sense when scheduling before register
7795 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
7796 @option{-O2} or higher.  Usage of this option can improve the
7797 generated code and decrease its size by preventing register pressure
7798 increase above the number of available hard registers and subsequent
7799 spills in register allocation.
7801 @item -fsched-spec-load
7802 @opindex fsched-spec-load
7803 Allow speculative motion of some load instructions.  This only makes
7804 sense when scheduling before register allocation, i.e.@: with
7805 @option{-fschedule-insns} or at @option{-O2} or higher.
7807 @item -fsched-spec-load-dangerous
7808 @opindex fsched-spec-load-dangerous
7809 Allow speculative motion of more load instructions.  This only makes
7810 sense when scheduling before register allocation, i.e.@: with
7811 @option{-fschedule-insns} or at @option{-O2} or higher.
7813 @item -fsched-stalled-insns
7814 @itemx -fsched-stalled-insns=@var{n}
7815 @opindex fsched-stalled-insns
7816 Define how many insns (if any) can be moved prematurely from the queue
7817 of stalled insns into the ready list during the second scheduling pass.
7818 @option{-fno-sched-stalled-insns} means that no insns are moved
7819 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
7820 on how many queued insns can be moved prematurely.
7821 @option{-fsched-stalled-insns} without a value is equivalent to
7822 @option{-fsched-stalled-insns=1}.
7824 @item -fsched-stalled-insns-dep
7825 @itemx -fsched-stalled-insns-dep=@var{n}
7826 @opindex fsched-stalled-insns-dep
7827 Define how many insn groups (cycles) are examined for a dependency
7828 on a stalled insn that is a candidate for premature removal from the queue
7829 of stalled insns.  This has an effect only during the second scheduling pass,
7830 and only if @option{-fsched-stalled-insns} is used.
7831 @option{-fno-sched-stalled-insns-dep} is equivalent to
7832 @option{-fsched-stalled-insns-dep=0}.
7833 @option{-fsched-stalled-insns-dep} without a value is equivalent to
7834 @option{-fsched-stalled-insns-dep=1}.
7836 @item -fsched2-use-superblocks
7837 @opindex fsched2-use-superblocks
7838 When scheduling after register allocation, use superblock scheduling.
7839 This allows motion across basic block boundaries,
7840 resulting in faster schedules.  This option is experimental, as not all machine
7841 descriptions used by GCC model the CPU closely enough to avoid unreliable
7842 results from the algorithm.
7844 This only makes sense when scheduling after register allocation, i.e.@: with
7845 @option{-fschedule-insns2} or at @option{-O2} or higher.
7847 @item -fsched-group-heuristic
7848 @opindex fsched-group-heuristic
7849 Enable the group heuristic in the scheduler.  This heuristic favors
7850 the instruction that belongs to a schedule group.  This is enabled
7851 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7852 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7854 @item -fsched-critical-path-heuristic
7855 @opindex fsched-critical-path-heuristic
7856 Enable the critical-path heuristic in the scheduler.  This heuristic favors
7857 instructions on the critical path.  This is enabled by default when
7858 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7859 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7861 @item -fsched-spec-insn-heuristic
7862 @opindex fsched-spec-insn-heuristic
7863 Enable the speculative instruction heuristic in the scheduler.  This
7864 heuristic favors speculative instructions with greater dependency weakness.
7865 This is enabled by default when scheduling is enabled, i.e.@:
7866 with @option{-fschedule-insns} or @option{-fschedule-insns2}
7867 or at @option{-O2} or higher.
7869 @item -fsched-rank-heuristic
7870 @opindex fsched-rank-heuristic
7871 Enable the rank heuristic in the scheduler.  This heuristic favors
7872 the instruction belonging to a basic block with greater size or frequency.
7873 This is enabled by default when scheduling is enabled, i.e.@:
7874 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7875 at @option{-O2} or higher.
7877 @item -fsched-last-insn-heuristic
7878 @opindex fsched-last-insn-heuristic
7879 Enable the last-instruction heuristic in the scheduler.  This heuristic
7880 favors the instruction that is less dependent on the last instruction
7881 scheduled.  This is enabled by default when scheduling is enabled,
7882 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7883 at @option{-O2} or higher.
7885 @item -fsched-dep-count-heuristic
7886 @opindex fsched-dep-count-heuristic
7887 Enable the dependent-count heuristic in the scheduler.  This heuristic
7888 favors the instruction that has more instructions depending on it.
7889 This is enabled by default when scheduling is enabled, i.e.@:
7890 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7891 at @option{-O2} or higher.
7893 @item -freschedule-modulo-scheduled-loops
7894 @opindex freschedule-modulo-scheduled-loops
7895 Modulo scheduling is performed before traditional scheduling.  If a loop
7896 is modulo scheduled, later scheduling passes may change its schedule.  
7897 Use this option to control that behavior.
7899 @item -fselective-scheduling
7900 @opindex fselective-scheduling
7901 Schedule instructions using selective scheduling algorithm.  Selective
7902 scheduling runs instead of the first scheduler pass.
7904 @item -fselective-scheduling2
7905 @opindex fselective-scheduling2
7906 Schedule instructions using selective scheduling algorithm.  Selective
7907 scheduling runs instead of the second scheduler pass.
7909 @item -fsel-sched-pipelining
7910 @opindex fsel-sched-pipelining
7911 Enable software pipelining of innermost loops during selective scheduling.
7912 This option has no effect unless one of @option{-fselective-scheduling} or
7913 @option{-fselective-scheduling2} is turned on.
7915 @item -fsel-sched-pipelining-outer-loops
7916 @opindex fsel-sched-pipelining-outer-loops
7917 When pipelining loops during selective scheduling, also pipeline outer loops.
7918 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
7920 @item -fsemantic-interposition
7921 @opindex fsemantic-interposition
7922 Some object formats, like ELF, allow interposing of symbols by the 
7923 dynamic linker.
7924 This means that for symbols exported from the DSO, the compiler cannot perform
7925 interprocedural propagation, inlining and other optimizations in anticipation
7926 that the function or variable in question may change. While this feature is
7927 useful, for example, to rewrite memory allocation functions by a debugging
7928 implementation, it is expensive in the terms of code quality.
7929 With @option{-fno-semantic-interposition} the compiler assumes that 
7930 if interposition happens for functions the overwriting function will have 
7931 precisely the same semantics (and side effects). 
7932 Similarly if interposition happens
7933 for variables, the constructor of the variable will be the same. The flag
7934 has no effect for functions explicitly declared inline 
7935 (where it is never allowed for interposition to change semantics) 
7936 and for symbols explicitly declared weak.
7938 @item -fshrink-wrap
7939 @opindex fshrink-wrap
7940 Emit function prologues only before parts of the function that need it,
7941 rather than at the top of the function.  This flag is enabled by default at
7942 @option{-O} and higher.
7944 @item -fshrink-wrap-separate
7945 @opindex fshrink-wrap-separate
7946 Shrink-wrap separate parts of the prologue and epilogue separately, so that
7947 those parts are only executed when needed.
7948 This option is on by default, but has no effect unless @option{-fshrink-wrap}
7949 is also turned on and the target supports this.
7951 @item -fcaller-saves
7952 @opindex fcaller-saves
7953 Enable allocation of values to registers that are clobbered by
7954 function calls, by emitting extra instructions to save and restore the
7955 registers around such calls.  Such allocation is done only when it
7956 seems to result in better code.
7958 This option is always enabled by default on certain machines, usually
7959 those which have no call-preserved registers to use instead.
7961 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7963 @item -fcombine-stack-adjustments
7964 @opindex fcombine-stack-adjustments
7965 Tracks stack adjustments (pushes and pops) and stack memory references
7966 and then tries to find ways to combine them.
7968 Enabled by default at @option{-O1} and higher.
7970 @item -fipa-ra
7971 @opindex fipa-ra
7972 Use caller save registers for allocation if those registers are not used by
7973 any called function.  In that case it is not necessary to save and restore
7974 them around calls.  This is only possible if called functions are part of
7975 same compilation unit as current function and they are compiled before it.
7977 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}, however the option
7978 is disabled if generated code will be instrumented for profiling
7979 (@option{-p}, or @option{-pg}) or if callee's register usage cannot be known
7980 exactly (this happens on targets that do not expose prologues
7981 and epilogues in RTL).
7983 @item -fconserve-stack
7984 @opindex fconserve-stack
7985 Attempt to minimize stack usage.  The compiler attempts to use less
7986 stack space, even if that makes the program slower.  This option
7987 implies setting the @option{large-stack-frame} parameter to 100
7988 and the @option{large-stack-frame-growth} parameter to 400.
7990 @item -ftree-reassoc
7991 @opindex ftree-reassoc
7992 Perform reassociation on trees.  This flag is enabled by default
7993 at @option{-O} and higher.
7995 @item -fcode-hoisting
7996 @opindex fcode-hoisting
7997 Perform code hoisting.  Code hoisting tries to move the
7998 evaluation of expressions executed on all paths to the function exit
7999 as early as possible.  This is especially useful as a code size
8000 optimization, but it often helps for code speed as well.
8001 This flag is enabled by default at @option{-O2} and higher.
8003 @item -ftree-pre
8004 @opindex ftree-pre
8005 Perform partial redundancy elimination (PRE) on trees.  This flag is
8006 enabled by default at @option{-O2} and @option{-O3}.
8008 @item -ftree-partial-pre
8009 @opindex ftree-partial-pre
8010 Make partial redundancy elimination (PRE) more aggressive.  This flag is
8011 enabled by default at @option{-O3}.
8013 @item -ftree-forwprop
8014 @opindex ftree-forwprop
8015 Perform forward propagation on trees.  This flag is enabled by default
8016 at @option{-O} and higher.
8018 @item -ftree-fre
8019 @opindex ftree-fre
8020 Perform full redundancy elimination (FRE) on trees.  The difference
8021 between FRE and PRE is that FRE only considers expressions
8022 that are computed on all paths leading to the redundant computation.
8023 This analysis is faster than PRE, though it exposes fewer redundancies.
8024 This flag is enabled by default at @option{-O} and higher.
8026 @item -ftree-phiprop
8027 @opindex ftree-phiprop
8028 Perform hoisting of loads from conditional pointers on trees.  This
8029 pass is enabled by default at @option{-O} and higher.
8031 @item -fhoist-adjacent-loads
8032 @opindex fhoist-adjacent-loads
8033 Speculatively hoist loads from both branches of an if-then-else if the
8034 loads are from adjacent locations in the same structure and the target
8035 architecture has a conditional move instruction.  This flag is enabled
8036 by default at @option{-O2} and higher.
8038 @item -ftree-copy-prop
8039 @opindex ftree-copy-prop
8040 Perform copy propagation on trees.  This pass eliminates unnecessary
8041 copy operations.  This flag is enabled by default at @option{-O} and
8042 higher.
8044 @item -fipa-pure-const
8045 @opindex fipa-pure-const
8046 Discover which functions are pure or constant.
8047 Enabled by default at @option{-O} and higher.
8049 @item -fipa-reference
8050 @opindex fipa-reference
8051 Discover which static variables do not escape the
8052 compilation unit.
8053 Enabled by default at @option{-O} and higher.
8055 @item -fipa-pta
8056 @opindex fipa-pta
8057 Perform interprocedural pointer analysis and interprocedural modification
8058 and reference analysis.  This option can cause excessive memory and
8059 compile-time usage on large compilation units.  It is not enabled by
8060 default at any optimization level.
8062 @item -fipa-profile
8063 @opindex fipa-profile
8064 Perform interprocedural profile propagation.  The functions called only from
8065 cold functions are marked as cold. Also functions executed once (such as
8066 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
8067 functions and loop less parts of functions executed once are then optimized for
8068 size.
8069 Enabled by default at @option{-O} and higher.
8071 @item -fipa-cp
8072 @opindex fipa-cp
8073 Perform interprocedural constant propagation.
8074 This optimization analyzes the program to determine when values passed
8075 to functions are constants and then optimizes accordingly.
8076 This optimization can substantially increase performance
8077 if the application has constants passed to functions.
8078 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
8080 @item -fipa-cp-clone
8081 @opindex fipa-cp-clone
8082 Perform function cloning to make interprocedural constant propagation stronger.
8083 When enabled, interprocedural constant propagation performs function cloning
8084 when externally visible function can be called with constant arguments.
8085 Because this optimization can create multiple copies of functions,
8086 it may significantly increase code size
8087 (see @option{--param ipcp-unit-growth=@var{value}}).
8088 This flag is enabled by default at @option{-O3}.
8090 @item -fipa-bit-cp
8091 @opindex -fipa-bit-cp
8092 When enabled, perform ipa bitwise constant propagation. This flag is
8093 enabled by default at @option{-O2}. It requires that @option{-fipa-cp}
8094 is enabled.
8096 @item -fipa-icf
8097 @opindex fipa-icf
8098 Perform Identical Code Folding for functions and read-only variables.
8099 The optimization reduces code size and may disturb unwind stacks by replacing
8100 a function by equivalent one with a different name. The optimization works
8101 more effectively with link time optimization enabled.
8103 Nevertheless the behavior is similar to Gold Linker ICF optimization, GCC ICF
8104 works on different levels and thus the optimizations are not same - there are
8105 equivalences that are found only by GCC and equivalences found only by Gold.
8107 This flag is enabled by default at @option{-O2} and @option{-Os}.
8109 @item -fisolate-erroneous-paths-dereference
8110 @opindex fisolate-erroneous-paths-dereference
8111 Detect paths that trigger erroneous or undefined behavior due to
8112 dereferencing a null pointer.  Isolate those paths from the main control
8113 flow and turn the statement with erroneous or undefined behavior into a trap.
8114 This flag is enabled by default at @option{-O2} and higher and depends on
8115 @option{-fdelete-null-pointer-checks} also being enabled.
8117 @item -fisolate-erroneous-paths-attribute
8118 @opindex fisolate-erroneous-paths-attribute
8119 Detect paths that trigger erroneous or undefined behavior due a null value
8120 being used in a way forbidden by a @code{returns_nonnull} or @code{nonnull}
8121 attribute.  Isolate those paths from the main control flow and turn the
8122 statement with erroneous or undefined behavior into a trap.  This is not
8123 currently enabled, but may be enabled by @option{-O2} in the future.
8125 @item -ftree-sink
8126 @opindex ftree-sink
8127 Perform forward store motion on trees.  This flag is
8128 enabled by default at @option{-O} and higher.
8130 @item -ftree-bit-ccp
8131 @opindex ftree-bit-ccp
8132 Perform sparse conditional bit constant propagation on trees and propagate
8133 pointer alignment information.
8134 This pass only operates on local scalar variables and is enabled by default
8135 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
8137 @item -ftree-ccp
8138 @opindex ftree-ccp
8139 Perform sparse conditional constant propagation (CCP) on trees.  This
8140 pass only operates on local scalar variables and is enabled by default
8141 at @option{-O} and higher.
8143 @item -fssa-backprop
8144 @opindex fssa-backprop
8145 Propagate information about uses of a value up the definition chain
8146 in order to simplify the definitions.  For example, this pass strips
8147 sign operations if the sign of a value never matters.  The flag is
8148 enabled by default at @option{-O} and higher.
8150 @item -fssa-phiopt
8151 @opindex fssa-phiopt
8152 Perform pattern matching on SSA PHI nodes to optimize conditional
8153 code.  This pass is enabled by default at @option{-O} and higher.
8155 @item -ftree-switch-conversion
8156 @opindex ftree-switch-conversion
8157 Perform conversion of simple initializations in a switch to
8158 initializations from a scalar array.  This flag is enabled by default
8159 at @option{-O2} and higher.
8161 @item -ftree-tail-merge
8162 @opindex ftree-tail-merge
8163 Look for identical code sequences.  When found, replace one with a jump to the
8164 other.  This optimization is known as tail merging or cross jumping.  This flag
8165 is enabled by default at @option{-O2} and higher.  The compilation time
8166 in this pass can
8167 be limited using @option{max-tail-merge-comparisons} parameter and
8168 @option{max-tail-merge-iterations} parameter.
8170 @item -ftree-dce
8171 @opindex ftree-dce
8172 Perform dead code elimination (DCE) on trees.  This flag is enabled by
8173 default at @option{-O} and higher.
8175 @item -ftree-builtin-call-dce
8176 @opindex ftree-builtin-call-dce
8177 Perform conditional dead code elimination (DCE) for calls to built-in functions
8178 that may set @code{errno} but are otherwise side-effect free.  This flag is
8179 enabled by default at @option{-O2} and higher if @option{-Os} is not also
8180 specified.
8182 @item -ftree-dominator-opts
8183 @opindex ftree-dominator-opts
8184 Perform a variety of simple scalar cleanups (constant/copy
8185 propagation, redundancy elimination, range propagation and expression
8186 simplification) based on a dominator tree traversal.  This also
8187 performs jump threading (to reduce jumps to jumps). This flag is
8188 enabled by default at @option{-O} and higher.
8190 @item -ftree-dse
8191 @opindex ftree-dse
8192 Perform dead store elimination (DSE) on trees.  A dead store is a store into
8193 a memory location that is later overwritten by another store without
8194 any intervening loads.  In this case the earlier store can be deleted.  This
8195 flag is enabled by default at @option{-O} and higher.
8197 @item -ftree-ch
8198 @opindex ftree-ch
8199 Perform loop header copying on trees.  This is beneficial since it increases
8200 effectiveness of code motion optimizations.  It also saves one jump.  This flag
8201 is enabled by default at @option{-O} and higher.  It is not enabled
8202 for @option{-Os}, since it usually increases code size.
8204 @item -ftree-loop-optimize
8205 @opindex ftree-loop-optimize
8206 Perform loop optimizations on trees.  This flag is enabled by default
8207 at @option{-O} and higher.
8209 @item -ftree-loop-linear
8210 @itemx -floop-interchange
8211 @itemx -floop-strip-mine
8212 @itemx -floop-block
8213 @itemx -floop-unroll-and-jam
8214 @opindex ftree-loop-linear
8215 @opindex floop-interchange
8216 @opindex floop-strip-mine
8217 @opindex floop-block
8218 @opindex floop-unroll-and-jam
8219 Perform loop nest optimizations.  Same as
8220 @option{-floop-nest-optimize}.  To use this code transformation, GCC has
8221 to be configured with @option{--with-isl} to enable the Graphite loop
8222 transformation infrastructure.
8224 @item -fgraphite-identity
8225 @opindex fgraphite-identity
8226 Enable the identity transformation for graphite.  For every SCoP we generate
8227 the polyhedral representation and transform it back to gimple.  Using
8228 @option{-fgraphite-identity} we can check the costs or benefits of the
8229 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
8230 are also performed by the code generator isl, like index splitting and
8231 dead code elimination in loops.
8233 @item -floop-nest-optimize
8234 @opindex floop-nest-optimize
8235 Enable the isl based loop nest optimizer.  This is a generic loop nest
8236 optimizer based on the Pluto optimization algorithms.  It calculates a loop
8237 structure optimized for data-locality and parallelism.  This option
8238 is experimental.
8240 @item -floop-parallelize-all
8241 @opindex floop-parallelize-all
8242 Use the Graphite data dependence analysis to identify loops that can
8243 be parallelized.  Parallelize all the loops that can be analyzed to
8244 not contain loop carried dependences without checking that it is
8245 profitable to parallelize the loops.
8247 @item -ftree-coalesce-vars
8248 @opindex ftree-coalesce-vars
8249 While transforming the program out of the SSA representation, attempt to
8250 reduce copying by coalescing versions of different user-defined
8251 variables, instead of just compiler temporaries.  This may severely
8252 limit the ability to debug an optimized program compiled with
8253 @option{-fno-var-tracking-assignments}.  In the negated form, this flag
8254 prevents SSA coalescing of user variables.  This option is enabled by
8255 default if optimization is enabled, and it does very little otherwise.
8257 @item -ftree-loop-if-convert
8258 @opindex ftree-loop-if-convert
8259 Attempt to transform conditional jumps in the innermost loops to
8260 branch-less equivalents.  The intent is to remove control-flow from
8261 the innermost loops in order to improve the ability of the
8262 vectorization pass to handle these loops.  This is enabled by default
8263 if vectorization is enabled.
8265 @item -ftree-loop-distribution
8266 @opindex ftree-loop-distribution
8267 Perform loop distribution.  This flag can improve cache performance on
8268 big loop bodies and allow further loop optimizations, like
8269 parallelization or vectorization, to take place.  For example, the loop
8270 @smallexample
8271 DO I = 1, N
8272   A(I) = B(I) + C
8273   D(I) = E(I) * F
8274 ENDDO
8275 @end smallexample
8276 is transformed to
8277 @smallexample
8278 DO I = 1, N
8279    A(I) = B(I) + C
8280 ENDDO
8281 DO I = 1, N
8282    D(I) = E(I) * F
8283 ENDDO
8284 @end smallexample
8286 @item -ftree-loop-distribute-patterns
8287 @opindex ftree-loop-distribute-patterns
8288 Perform loop distribution of patterns that can be code generated with
8289 calls to a library.  This flag is enabled by default at @option{-O3}.
8291 This pass distributes the initialization loops and generates a call to
8292 memset zero.  For example, the loop
8293 @smallexample
8294 DO I = 1, N
8295   A(I) = 0
8296   B(I) = A(I) + I
8297 ENDDO
8298 @end smallexample
8299 is transformed to
8300 @smallexample
8301 DO I = 1, N
8302    A(I) = 0
8303 ENDDO
8304 DO I = 1, N
8305    B(I) = A(I) + I
8306 ENDDO
8307 @end smallexample
8308 and the initialization loop is transformed into a call to memset zero.
8310 @item -ftree-loop-im
8311 @opindex ftree-loop-im
8312 Perform loop invariant motion on trees.  This pass moves only invariants that
8313 are hard to handle at RTL level (function calls, operations that expand to
8314 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
8315 operands of conditions that are invariant out of the loop, so that we can use
8316 just trivial invariantness analysis in loop unswitching.  The pass also includes
8317 store motion.
8319 @item -ftree-loop-ivcanon
8320 @opindex ftree-loop-ivcanon
8321 Create a canonical counter for number of iterations in loops for which
8322 determining number of iterations requires complicated analysis.  Later
8323 optimizations then may determine the number easily.  Useful especially
8324 in connection with unrolling.
8326 @item -fivopts
8327 @opindex fivopts
8328 Perform induction variable optimizations (strength reduction, induction
8329 variable merging and induction variable elimination) on trees.
8331 @item -ftree-parallelize-loops=n
8332 @opindex ftree-parallelize-loops
8333 Parallelize loops, i.e., split their iteration space to run in n threads.
8334 This is only possible for loops whose iterations are independent
8335 and can be arbitrarily reordered.  The optimization is only
8336 profitable on multiprocessor machines, for loops that are CPU-intensive,
8337 rather than constrained e.g.@: by memory bandwidth.  This option
8338 implies @option{-pthread}, and thus is only supported on targets
8339 that have support for @option{-pthread}.
8341 @item -ftree-pta
8342 @opindex ftree-pta
8343 Perform function-local points-to analysis on trees.  This flag is
8344 enabled by default at @option{-O} and higher.
8346 @item -ftree-sra
8347 @opindex ftree-sra
8348 Perform scalar replacement of aggregates.  This pass replaces structure
8349 references with scalars to prevent committing structures to memory too
8350 early.  This flag is enabled by default at @option{-O} and higher.
8352 @item -fstore-merging
8353 @opindex fstore-merging
8354 Perform merging of narrow stores to consecutive memory addresses.  This pass
8355 merges contiguous stores of immediate values narrower than a word into fewer
8356 wider stores to reduce the number of instructions.  This is enabled by default
8357 at @option{-O2} and higher as well as @option{-Os}.
8359 @item -ftree-ter
8360 @opindex ftree-ter
8361 Perform temporary expression replacement during the SSA->normal phase.  Single
8362 use/single def temporaries are replaced at their use location with their
8363 defining expression.  This results in non-GIMPLE code, but gives the expanders
8364 much more complex trees to work on resulting in better RTL generation.  This is
8365 enabled by default at @option{-O} and higher.
8367 @item -ftree-slsr
8368 @opindex ftree-slsr
8369 Perform straight-line strength reduction on trees.  This recognizes related
8370 expressions involving multiplications and replaces them by less expensive
8371 calculations when possible.  This is enabled by default at @option{-O} and
8372 higher.
8374 @item -ftree-vectorize
8375 @opindex ftree-vectorize
8376 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
8377 and @option{-ftree-slp-vectorize} if not explicitly specified.
8379 @item -ftree-loop-vectorize
8380 @opindex ftree-loop-vectorize
8381 Perform loop vectorization on trees. This flag is enabled by default at
8382 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8384 @item -ftree-slp-vectorize
8385 @opindex ftree-slp-vectorize
8386 Perform basic block vectorization on trees. This flag is enabled by default at
8387 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8389 @item -fvect-cost-model=@var{model}
8390 @opindex fvect-cost-model
8391 Alter the cost model used for vectorization.  The @var{model} argument
8392 should be one of @samp{unlimited}, @samp{dynamic} or @samp{cheap}.
8393 With the @samp{unlimited} model the vectorized code-path is assumed
8394 to be profitable while with the @samp{dynamic} model a runtime check
8395 guards the vectorized code-path to enable it only for iteration
8396 counts that will likely execute faster than when executing the original
8397 scalar loop.  The @samp{cheap} model disables vectorization of
8398 loops where doing so would be cost prohibitive for example due to
8399 required runtime checks for data dependence or alignment but otherwise
8400 is equal to the @samp{dynamic} model.
8401 The default cost model depends on other optimization flags and is
8402 either @samp{dynamic} or @samp{cheap}.
8404 @item -fsimd-cost-model=@var{model}
8405 @opindex fsimd-cost-model
8406 Alter the cost model used for vectorization of loops marked with the OpenMP
8407 or Cilk Plus simd directive.  The @var{model} argument should be one of
8408 @samp{unlimited}, @samp{dynamic}, @samp{cheap}.  All values of @var{model}
8409 have the same meaning as described in @option{-fvect-cost-model} and by
8410 default a cost model defined with @option{-fvect-cost-model} is used.
8412 @item -ftree-vrp
8413 @opindex ftree-vrp
8414 Perform Value Range Propagation on trees.  This is similar to the
8415 constant propagation pass, but instead of values, ranges of values are
8416 propagated.  This allows the optimizers to remove unnecessary range
8417 checks like array bound checks and null pointer checks.  This is
8418 enabled by default at @option{-O2} and higher.  Null pointer check
8419 elimination is only done if @option{-fdelete-null-pointer-checks} is
8420 enabled.
8422 @item -fsplit-paths
8423 @opindex fsplit-paths
8424 Split paths leading to loop backedges.  This can improve dead code
8425 elimination and common subexpression elimination.  This is enabled by
8426 default at @option{-O2} and above.
8428 @item -fsplit-ivs-in-unroller
8429 @opindex fsplit-ivs-in-unroller
8430 Enables expression of values of induction variables in later iterations
8431 of the unrolled loop using the value in the first iteration.  This breaks
8432 long dependency chains, thus improving efficiency of the scheduling passes.
8434 A combination of @option{-fweb} and CSE is often sufficient to obtain the
8435 same effect.  However, that is not reliable in cases where the loop body
8436 is more complicated than a single basic block.  It also does not work at all
8437 on some architectures due to restrictions in the CSE pass.
8439 This optimization is enabled by default.
8441 @item -fvariable-expansion-in-unroller
8442 @opindex fvariable-expansion-in-unroller
8443 With this option, the compiler creates multiple copies of some
8444 local variables when unrolling a loop, which can result in superior code.
8446 @item -fpartial-inlining
8447 @opindex fpartial-inlining
8448 Inline parts of functions.  This option has any effect only
8449 when inlining itself is turned on by the @option{-finline-functions}
8450 or @option{-finline-small-functions} options.
8452 Enabled at level @option{-O2}.
8454 @item -fpredictive-commoning
8455 @opindex fpredictive-commoning
8456 Perform predictive commoning optimization, i.e., reusing computations
8457 (especially memory loads and stores) performed in previous
8458 iterations of loops.
8460 This option is enabled at level @option{-O3}.
8462 @item -fprefetch-loop-arrays
8463 @opindex fprefetch-loop-arrays
8464 If supported by the target machine, generate instructions to prefetch
8465 memory to improve the performance of loops that access large arrays.
8467 This option may generate better or worse code; results are highly
8468 dependent on the structure of loops within the source code.
8470 Disabled at level @option{-Os}.
8472 @item -fno-printf-return-value
8473 @opindex fno-printf-return-value
8474 Do not substitute constants for known return value of formatted output
8475 functions such as @code{sprintf}, @code{snprintf}, @code{vsprintf}, and
8476 @code{vsnprintf} (but not @code{printf} of @code{fprintf}).  This
8477 transformation allows GCC to optimize or even eliminate branches based
8478 on the known return value of these functions called with arguments that
8479 are either constant, or whose values are known to be in a range that
8480 makes determining the exact return value possible.  For example, when
8481 @option{-fprintf-return-value} is in effect, both the branch and the
8482 body of the @code{if} statement (but not the call to @code{snprint})
8483 can be optimized away when @code{i} is a 32-bit or smaller integer
8484 because the return value is guaranteed to be at most 8.
8486 @smallexample
8487 char buf[9];
8488 if (snprintf (buf, "%08x", i) >= sizeof buf)
8489   @dots{}
8490 @end smallexample
8492 The @option{-fprintf-return-value} option relies on other optimizations
8493 and yields best results with @option{-O2}.  It works in tandem with the
8494 @option{-Wformat-overflow} and @option{-Wformat-truncation} options.
8495 The @option{-fprintf-return-value} option is enabled by default.
8497 @item -fno-peephole
8498 @itemx -fno-peephole2
8499 @opindex fno-peephole
8500 @opindex fno-peephole2
8501 Disable any machine-specific peephole optimizations.  The difference
8502 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
8503 are implemented in the compiler; some targets use one, some use the
8504 other, a few use both.
8506 @option{-fpeephole} is enabled by default.
8507 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8509 @item -fno-guess-branch-probability
8510 @opindex fno-guess-branch-probability
8511 Do not guess branch probabilities using heuristics.
8513 GCC uses heuristics to guess branch probabilities if they are
8514 not provided by profiling feedback (@option{-fprofile-arcs}).  These
8515 heuristics are based on the control flow graph.  If some branch probabilities
8516 are specified by @code{__builtin_expect}, then the heuristics are
8517 used to guess branch probabilities for the rest of the control flow graph,
8518 taking the @code{__builtin_expect} info into account.  The interactions
8519 between the heuristics and @code{__builtin_expect} can be complex, and in
8520 some cases, it may be useful to disable the heuristics so that the effects
8521 of @code{__builtin_expect} are easier to understand.
8523 The default is @option{-fguess-branch-probability} at levels
8524 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8526 @item -freorder-blocks
8527 @opindex freorder-blocks
8528 Reorder basic blocks in the compiled function in order to reduce number of
8529 taken branches and improve code locality.
8531 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8533 @item -freorder-blocks-algorithm=@var{algorithm}
8534 @opindex freorder-blocks-algorithm
8535 Use the specified algorithm for basic block reordering.  The
8536 @var{algorithm} argument can be @samp{simple}, which does not increase
8537 code size (except sometimes due to secondary effects like alignment),
8538 or @samp{stc}, the ``software trace cache'' algorithm, which tries to
8539 put all often executed code together, minimizing the number of branches
8540 executed by making extra copies of code.
8542 The default is @samp{simple} at levels @option{-O}, @option{-Os}, and
8543 @samp{stc} at levels @option{-O2}, @option{-O3}.
8545 @item -freorder-blocks-and-partition
8546 @opindex freorder-blocks-and-partition
8547 In addition to reordering basic blocks in the compiled function, in order
8548 to reduce number of taken branches, partitions hot and cold basic blocks
8549 into separate sections of the assembly and @file{.o} files, to improve
8550 paging and cache locality performance.
8552 This optimization is automatically turned off in the presence of
8553 exception handling, for linkonce sections, for functions with a user-defined
8554 section attribute and on any architecture that does not support named
8555 sections.
8557 Enabled for x86 at levels @option{-O2}, @option{-O3}.
8559 @item -freorder-functions
8560 @opindex freorder-functions
8561 Reorder functions in the object file in order to
8562 improve code locality.  This is implemented by using special
8563 subsections @code{.text.hot} for most frequently executed functions and
8564 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
8565 the linker so object file format must support named sections and linker must
8566 place them in a reasonable way.
8568 Also profile feedback must be available to make this option effective.  See
8569 @option{-fprofile-arcs} for details.
8571 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8573 @item -fstrict-aliasing
8574 @opindex fstrict-aliasing
8575 Allow the compiler to assume the strictest aliasing rules applicable to
8576 the language being compiled.  For C (and C++), this activates
8577 optimizations based on the type of expressions.  In particular, an
8578 object of one type is assumed never to reside at the same address as an
8579 object of a different type, unless the types are almost the same.  For
8580 example, an @code{unsigned int} can alias an @code{int}, but not a
8581 @code{void*} or a @code{double}.  A character type may alias any other
8582 type.
8584 @anchor{Type-punning}Pay special attention to code like this:
8585 @smallexample
8586 union a_union @{
8587   int i;
8588   double d;
8591 int f() @{
8592   union a_union t;
8593   t.d = 3.0;
8594   return t.i;
8596 @end smallexample
8597 The practice of reading from a different union member than the one most
8598 recently written to (called ``type-punning'') is common.  Even with
8599 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
8600 is accessed through the union type.  So, the code above works as
8601 expected.  @xref{Structures unions enumerations and bit-fields
8602 implementation}.  However, this code might not:
8603 @smallexample
8604 int f() @{
8605   union a_union t;
8606   int* ip;
8607   t.d = 3.0;
8608   ip = &t.i;
8609   return *ip;
8611 @end smallexample
8613 Similarly, access by taking the address, casting the resulting pointer
8614 and dereferencing the result has undefined behavior, even if the cast
8615 uses a union type, e.g.:
8616 @smallexample
8617 int f() @{
8618   double d = 3.0;
8619   return ((union a_union *) &d)->i;
8621 @end smallexample
8623 The @option{-fstrict-aliasing} option is enabled at levels
8624 @option{-O2}, @option{-O3}, @option{-Os}.
8626 @item -fstrict-overflow
8627 @opindex fstrict-overflow
8628 Allow the compiler to assume strict signed overflow rules, depending
8629 on the language being compiled.  For C (and C++) this means that
8630 overflow when doing arithmetic with signed numbers is undefined, which
8631 means that the compiler may assume that it does not happen.  This
8632 permits various optimizations.  For example, the compiler assumes
8633 that an expression like @code{i + 10 > i} is always true for
8634 signed @code{i}.  This assumption is only valid if signed overflow is
8635 undefined, as the expression is false if @code{i + 10} overflows when
8636 using twos complement arithmetic.  When this option is in effect any
8637 attempt to determine whether an operation on signed numbers 
8638 overflows must be written carefully to not actually involve overflow.
8640 This option also allows the compiler to assume strict pointer
8641 semantics: given a pointer to an object, if adding an offset to that
8642 pointer does not produce a pointer to the same object, the addition is
8643 undefined.  This permits the compiler to conclude that @code{p + u >
8644 p} is always true for a pointer @code{p} and unsigned integer
8645 @code{u}.  This assumption is only valid because pointer wraparound is
8646 undefined, as the expression is false if @code{p + u} overflows using
8647 twos complement arithmetic.
8649 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
8650 that integer signed overflow is fully defined: it wraps.  When
8651 @option{-fwrapv} is used, there is no difference between
8652 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
8653 integers.  With @option{-fwrapv} certain types of overflow are
8654 permitted.  For example, if the compiler gets an overflow when doing
8655 arithmetic on constants, the overflowed value can still be used with
8656 @option{-fwrapv}, but not otherwise.
8658 The @option{-fstrict-overflow} option is enabled at levels
8659 @option{-O2}, @option{-O3}, @option{-Os}.
8661 @item -falign-functions
8662 @itemx -falign-functions=@var{n}
8663 @opindex falign-functions
8664 Align the start of functions to the next power-of-two greater than
8665 @var{n}, skipping up to @var{n} bytes.  For instance,
8666 @option{-falign-functions=32} aligns functions to the next 32-byte
8667 boundary, but @option{-falign-functions=24} aligns to the next
8668 32-byte boundary only if this can be done by skipping 23 bytes or less.
8670 @option{-fno-align-functions} and @option{-falign-functions=1} are
8671 equivalent and mean that functions are not aligned.
8673 Some assemblers only support this flag when @var{n} is a power of two;
8674 in that case, it is rounded up.
8676 If @var{n} is not specified or is zero, use a machine-dependent default.
8678 Enabled at levels @option{-O2}, @option{-O3}.
8680 @item -flimit-function-alignment
8681 If this option is enabled, the compiler tries to avoid unnecessarily
8682 overaligning functions. It attempts to instruct the assembler to align
8683 by the amount specified by @option{-falign-functions}, but not to
8684 skip more bytes than the size of the function.
8686 @item -falign-labels
8687 @itemx -falign-labels=@var{n}
8688 @opindex falign-labels
8689 Align all branch targets to a power-of-two boundary, skipping up to
8690 @var{n} bytes like @option{-falign-functions}.  This option can easily
8691 make code slower, because it must insert dummy operations for when the
8692 branch target is reached in the usual flow of the code.
8694 @option{-fno-align-labels} and @option{-falign-labels=1} are
8695 equivalent and mean that labels are not aligned.
8697 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
8698 are greater than this value, then their values are used instead.
8700 If @var{n} is not specified or is zero, use a machine-dependent default
8701 which is very likely to be @samp{1}, meaning no alignment.
8703 Enabled at levels @option{-O2}, @option{-O3}.
8705 @item -falign-loops
8706 @itemx -falign-loops=@var{n}
8707 @opindex falign-loops
8708 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
8709 like @option{-falign-functions}.  If the loops are
8710 executed many times, this makes up for any execution of the dummy
8711 operations.
8713 @option{-fno-align-loops} and @option{-falign-loops=1} are
8714 equivalent and mean that loops are not aligned.
8716 If @var{n} is not specified or is zero, use a machine-dependent default.
8718 Enabled at levels @option{-O2}, @option{-O3}.
8720 @item -falign-jumps
8721 @itemx -falign-jumps=@var{n}
8722 @opindex falign-jumps
8723 Align branch targets to a power-of-two boundary, for branch targets
8724 where the targets can only be reached by jumping, skipping up to @var{n}
8725 bytes like @option{-falign-functions}.  In this case, no dummy operations
8726 need be executed.
8728 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
8729 equivalent and mean that loops are not aligned.
8731 If @var{n} is not specified or is zero, use a machine-dependent default.
8733 Enabled at levels @option{-O2}, @option{-O3}.
8735 @item -funit-at-a-time
8736 @opindex funit-at-a-time
8737 This option is left for compatibility reasons. @option{-funit-at-a-time}
8738 has no effect, while @option{-fno-unit-at-a-time} implies
8739 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
8741 Enabled by default.
8743 @item -fno-toplevel-reorder
8744 @opindex fno-toplevel-reorder
8745 Do not reorder top-level functions, variables, and @code{asm}
8746 statements.  Output them in the same order that they appear in the
8747 input file.  When this option is used, unreferenced static variables
8748 are not removed.  This option is intended to support existing code
8749 that relies on a particular ordering.  For new code, it is better to
8750 use attributes when possible.
8752 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
8753 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
8754 targets.
8756 @item -fweb
8757 @opindex fweb
8758 Constructs webs as commonly used for register allocation purposes and assign
8759 each web individual pseudo register.  This allows the register allocation pass
8760 to operate on pseudos directly, but also strengthens several other optimization
8761 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
8762 however, make debugging impossible, since variables no longer stay in a
8763 ``home register''.
8765 Enabled by default with @option{-funroll-loops}.
8767 @item -fwhole-program
8768 @opindex fwhole-program
8769 Assume that the current compilation unit represents the whole program being
8770 compiled.  All public functions and variables with the exception of @code{main}
8771 and those merged by attribute @code{externally_visible} become static functions
8772 and in effect are optimized more aggressively by interprocedural optimizers.
8774 This option should not be used in combination with @option{-flto}.
8775 Instead relying on a linker plugin should provide safer and more precise
8776 information.
8778 @item -flto[=@var{n}]
8779 @opindex flto
8780 This option runs the standard link-time optimizer.  When invoked
8781 with source code, it generates GIMPLE (one of GCC's internal
8782 representations) and writes it to special ELF sections in the object
8783 file.  When the object files are linked together, all the function
8784 bodies are read from these ELF sections and instantiated as if they
8785 had been part of the same translation unit.
8787 To use the link-time optimizer, @option{-flto} and optimization
8788 options should be specified at compile time and during the final link.
8789 It is recommended that you compile all the files participating in the
8790 same link with the same options and also specify those options at
8791 link time.  
8792 For example:
8794 @smallexample
8795 gcc -c -O2 -flto foo.c
8796 gcc -c -O2 -flto bar.c
8797 gcc -o myprog -flto -O2 foo.o bar.o
8798 @end smallexample
8800 The first two invocations to GCC save a bytecode representation
8801 of GIMPLE into special ELF sections inside @file{foo.o} and
8802 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
8803 @file{foo.o} and @file{bar.o}, merges the two files into a single
8804 internal image, and compiles the result as usual.  Since both
8805 @file{foo.o} and @file{bar.o} are merged into a single image, this
8806 causes all the interprocedural analyses and optimizations in GCC to
8807 work across the two files as if they were a single one.  This means,
8808 for example, that the inliner is able to inline functions in
8809 @file{bar.o} into functions in @file{foo.o} and vice-versa.
8811 Another (simpler) way to enable link-time optimization is:
8813 @smallexample
8814 gcc -o myprog -flto -O2 foo.c bar.c
8815 @end smallexample
8817 The above generates bytecode for @file{foo.c} and @file{bar.c},
8818 merges them together into a single GIMPLE representation and optimizes
8819 them as usual to produce @file{myprog}.
8821 The only important thing to keep in mind is that to enable link-time
8822 optimizations you need to use the GCC driver to perform the link step.
8823 GCC then automatically performs link-time optimization if any of the
8824 objects involved were compiled with the @option{-flto} command-line option.  
8825 You generally
8826 should specify the optimization options to be used for link-time
8827 optimization though GCC tries to be clever at guessing an
8828 optimization level to use from the options used at compile time
8829 if you fail to specify one at link time.  You can always override
8830 the automatic decision to do link-time optimization at link time
8831 by passing @option{-fno-lto} to the link command.
8833 To make whole program optimization effective, it is necessary to make
8834 certain whole program assumptions.  The compiler needs to know
8835 what functions and variables can be accessed by libraries and runtime
8836 outside of the link-time optimized unit.  When supported by the linker,
8837 the linker plugin (see @option{-fuse-linker-plugin}) passes information
8838 to the compiler about used and externally visible symbols.  When
8839 the linker plugin is not available, @option{-fwhole-program} should be
8840 used to allow the compiler to make these assumptions, which leads
8841 to more aggressive optimization decisions.
8843 When @option{-fuse-linker-plugin} is not enabled, when a file is
8844 compiled with @option{-flto}, the generated object file is larger than
8845 a regular object file because it contains GIMPLE bytecodes and the usual
8846 final code (see @option{-ffat-lto-objects}.  This means that
8847 object files with LTO information can be linked as normal object
8848 files; if @option{-fno-lto} is passed to the linker, no
8849 interprocedural optimizations are applied.  Note that when
8850 @option{-fno-fat-lto-objects} is enabled the compile stage is faster
8851 but you cannot perform a regular, non-LTO link on them.
8853 Additionally, the optimization flags used to compile individual files
8854 are not necessarily related to those used at link time.  For instance,
8856 @smallexample
8857 gcc -c -O0 -ffat-lto-objects -flto foo.c
8858 gcc -c -O0 -ffat-lto-objects -flto bar.c
8859 gcc -o myprog -O3 foo.o bar.o
8860 @end smallexample
8862 This produces individual object files with unoptimized assembler
8863 code, but the resulting binary @file{myprog} is optimized at
8864 @option{-O3}.  If, instead, the final binary is generated with
8865 @option{-fno-lto}, then @file{myprog} is not optimized.
8867 When producing the final binary, GCC only
8868 applies link-time optimizations to those files that contain bytecode.
8869 Therefore, you can mix and match object files and libraries with
8870 GIMPLE bytecodes and final object code.  GCC automatically selects
8871 which files to optimize in LTO mode and which files to link without
8872 further processing.
8874 There are some code generation flags preserved by GCC when
8875 generating bytecodes, as they need to be used during the final link
8876 stage.  Generally options specified at link time override those
8877 specified at compile time.
8879 If you do not specify an optimization level option @option{-O} at
8880 link time, then GCC uses the highest optimization level 
8881 used when compiling the object files.
8883 Currently, the following options and their settings are taken from
8884 the first object file that explicitly specifies them: 
8885 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
8886 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
8887 and all the @option{-m} target flags.
8889 Certain ABI-changing flags are required to match in all compilation units,
8890 and trying to override this at link time with a conflicting value
8891 is ignored.  This includes options such as @option{-freg-struct-return}
8892 and @option{-fpcc-struct-return}. 
8894 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
8895 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
8896 are passed through to the link stage and merged conservatively for
8897 conflicting translation units.  Specifically
8898 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
8899 precedence; and for example @option{-ffp-contract=off} takes precedence
8900 over @option{-ffp-contract=fast}.  You can override them at link time.
8902 If LTO encounters objects with C linkage declared with incompatible
8903 types in separate translation units to be linked together (undefined
8904 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
8905 issued.  The behavior is still undefined at run time.  Similar
8906 diagnostics may be raised for other languages.
8908 Another feature of LTO is that it is possible to apply interprocedural
8909 optimizations on files written in different languages:
8911 @smallexample
8912 gcc -c -flto foo.c
8913 g++ -c -flto bar.cc
8914 gfortran -c -flto baz.f90
8915 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
8916 @end smallexample
8918 Notice that the final link is done with @command{g++} to get the C++
8919 runtime libraries and @option{-lgfortran} is added to get the Fortran
8920 runtime libraries.  In general, when mixing languages in LTO mode, you
8921 should use the same link command options as when mixing languages in a
8922 regular (non-LTO) compilation.
8924 If object files containing GIMPLE bytecode are stored in a library archive, say
8925 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
8926 are using a linker with plugin support.  To create static libraries suitable
8927 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
8928 and @command{ranlib}; 
8929 to show the symbols of object files with GIMPLE bytecode, use
8930 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
8931 and @command{nm} have been compiled with plugin support.  At link time, use the the
8932 flag @option{-fuse-linker-plugin} to ensure that the library participates in
8933 the LTO optimization process:
8935 @smallexample
8936 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
8937 @end smallexample
8939 With the linker plugin enabled, the linker extracts the needed
8940 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
8941 to make them part of the aggregated GIMPLE image to be optimized.
8943 If you are not using a linker with plugin support and/or do not
8944 enable the linker plugin, then the objects inside @file{libfoo.a}
8945 are extracted and linked as usual, but they do not participate
8946 in the LTO optimization process.  In order to make a static library suitable
8947 for both LTO optimization and usual linkage, compile its object files with
8948 @option{-flto} @option{-ffat-lto-objects}.
8950 Link-time optimizations do not require the presence of the whole program to
8951 operate.  If the program does not require any symbols to be exported, it is
8952 possible to combine @option{-flto} and @option{-fwhole-program} to allow
8953 the interprocedural optimizers to use more aggressive assumptions which may
8954 lead to improved optimization opportunities.
8955 Use of @option{-fwhole-program} is not needed when linker plugin is
8956 active (see @option{-fuse-linker-plugin}).
8958 The current implementation of LTO makes no
8959 attempt to generate bytecode that is portable between different
8960 types of hosts.  The bytecode files are versioned and there is a
8961 strict version check, so bytecode files generated in one version of
8962 GCC do not work with an older or newer version of GCC.
8964 Link-time optimization does not work well with generation of debugging
8965 information.  Combining @option{-flto} with
8966 @option{-g} is currently experimental and expected to produce unexpected
8967 results.
8969 If you specify the optional @var{n}, the optimization and code
8970 generation done at link time is executed in parallel using @var{n}
8971 parallel jobs by utilizing an installed @command{make} program.  The
8972 environment variable @env{MAKE} may be used to override the program
8973 used.  The default value for @var{n} is 1.
8975 You can also specify @option{-flto=jobserver} to use GNU make's
8976 job server mode to determine the number of parallel jobs. This
8977 is useful when the Makefile calling GCC is already executing in parallel.
8978 You must prepend a @samp{+} to the command recipe in the parent Makefile
8979 for this to work.  This option likely only works if @env{MAKE} is
8980 GNU make.
8982 @item -flto-partition=@var{alg}
8983 @opindex flto-partition
8984 Specify the partitioning algorithm used by the link-time optimizer.
8985 The value is either @samp{1to1} to specify a partitioning mirroring
8986 the original source files or @samp{balanced} to specify partitioning
8987 into equally sized chunks (whenever possible) or @samp{max} to create
8988 new partition for every symbol where possible.  Specifying @samp{none}
8989 as an algorithm disables partitioning and streaming completely. 
8990 The default value is @samp{balanced}. While @samp{1to1} can be used
8991 as an workaround for various code ordering issues, the @samp{max}
8992 partitioning is intended for internal testing only.
8993 The value @samp{one} specifies that exactly one partition should be
8994 used while the value @samp{none} bypasses partitioning and executes
8995 the link-time optimization step directly from the WPA phase.
8997 @item -flto-odr-type-merging
8998 @opindex flto-odr-type-merging
8999 Enable streaming of mangled types names of C++ types and their unification
9000 at link time.  This increases size of LTO object files, but enables
9001 diagnostics about One Definition Rule violations.
9003 @item -flto-compression-level=@var{n}
9004 @opindex flto-compression-level
9005 This option specifies the level of compression used for intermediate
9006 language written to LTO object files, and is only meaningful in
9007 conjunction with LTO mode (@option{-flto}).  Valid
9008 values are 0 (no compression) to 9 (maximum compression).  Values
9009 outside this range are clamped to either 0 or 9.  If the option is not
9010 given, a default balanced compression setting is used.
9012 @item -fuse-linker-plugin
9013 @opindex fuse-linker-plugin
9014 Enables the use of a linker plugin during link-time optimization.  This
9015 option relies on plugin support in the linker, which is available in gold
9016 or in GNU ld 2.21 or newer.
9018 This option enables the extraction of object files with GIMPLE bytecode out
9019 of library archives. This improves the quality of optimization by exposing
9020 more code to the link-time optimizer.  This information specifies what
9021 symbols can be accessed externally (by non-LTO object or during dynamic
9022 linking).  Resulting code quality improvements on binaries (and shared
9023 libraries that use hidden visibility) are similar to @option{-fwhole-program}.
9024 See @option{-flto} for a description of the effect of this flag and how to
9025 use it.
9027 This option is enabled by default when LTO support in GCC is enabled
9028 and GCC was configured for use with
9029 a linker supporting plugins (GNU ld 2.21 or newer or gold).
9031 @item -ffat-lto-objects
9032 @opindex ffat-lto-objects
9033 Fat LTO objects are object files that contain both the intermediate language
9034 and the object code. This makes them usable for both LTO linking and normal
9035 linking. This option is effective only when compiling with @option{-flto}
9036 and is ignored at link time.
9038 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
9039 requires the complete toolchain to be aware of LTO. It requires a linker with
9040 linker plugin support for basic functionality.  Additionally,
9041 @command{nm}, @command{ar} and @command{ranlib}
9042 need to support linker plugins to allow a full-featured build environment
9043 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
9044 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
9045 to these tools. With non fat LTO makefiles need to be modified to use them.
9047 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
9048 support.
9050 @item -fcompare-elim
9051 @opindex fcompare-elim
9052 After register allocation and post-register allocation instruction splitting,
9053 identify arithmetic instructions that compute processor flags similar to a
9054 comparison operation based on that arithmetic.  If possible, eliminate the
9055 explicit comparison operation.
9057 This pass only applies to certain targets that cannot explicitly represent
9058 the comparison operation before register allocation is complete.
9060 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9062 @item -fcprop-registers
9063 @opindex fcprop-registers
9064 After register allocation and post-register allocation instruction splitting,
9065 perform a copy-propagation pass to try to reduce scheduling dependencies
9066 and occasionally eliminate the copy.
9068 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9070 @item -fprofile-correction
9071 @opindex fprofile-correction
9072 Profiles collected using an instrumented binary for multi-threaded programs may
9073 be inconsistent due to missed counter updates. When this option is specified,
9074 GCC uses heuristics to correct or smooth out such inconsistencies. By
9075 default, GCC emits an error message when an inconsistent profile is detected.
9077 @item -fprofile-use
9078 @itemx -fprofile-use=@var{path}
9079 @opindex fprofile-use
9080 Enable profile feedback-directed optimizations, 
9081 and the following optimizations
9082 which are generally profitable only with profile feedback available:
9083 @option{-fbranch-probabilities}, @option{-fvpt},
9084 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9085 @option{-ftree-vectorize}, and @option{ftree-loop-distribute-patterns}.
9087 Before you can use this option, you must first generate profiling information.
9088 @xref{Instrumentation Options}, for information about the
9089 @option{-fprofile-generate} option.
9091 By default, GCC emits an error message if the feedback profiles do not
9092 match the source code.  This error can be turned into a warning by using
9093 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
9094 code.
9096 If @var{path} is specified, GCC looks at the @var{path} to find
9097 the profile feedback data files. See @option{-fprofile-dir}.
9099 @item -fauto-profile
9100 @itemx -fauto-profile=@var{path}
9101 @opindex fauto-profile
9102 Enable sampling-based feedback-directed optimizations, 
9103 and the following optimizations
9104 which are generally profitable only with profile feedback available:
9105 @option{-fbranch-probabilities}, @option{-fvpt},
9106 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9107 @option{-ftree-vectorize},
9108 @option{-finline-functions}, @option{-fipa-cp}, @option{-fipa-cp-clone},
9109 @option{-fpredictive-commoning}, @option{-funswitch-loops},
9110 @option{-fgcse-after-reload}, and @option{-ftree-loop-distribute-patterns}.
9112 @var{path} is the name of a file containing AutoFDO profile information.
9113 If omitted, it defaults to @file{fbdata.afdo} in the current directory.
9115 Producing an AutoFDO profile data file requires running your program
9116 with the @command{perf} utility on a supported GNU/Linux target system.
9117 For more information, see @uref{https://perf.wiki.kernel.org/}.
9119 E.g.
9120 @smallexample
9121 perf record -e br_inst_retired:near_taken -b -o perf.data \
9122     -- your_program
9123 @end smallexample
9125 Then use the @command{create_gcov} tool to convert the raw profile data
9126 to a format that can be used by GCC.@  You must also supply the 
9127 unstripped binary for your program to this tool.  
9128 See @uref{https://github.com/google/autofdo}.
9130 E.g.
9131 @smallexample
9132 create_gcov --binary=your_program.unstripped --profile=perf.data \
9133     --gcov=profile.afdo
9134 @end smallexample
9135 @end table
9137 The following options control compiler behavior regarding floating-point 
9138 arithmetic.  These options trade off between speed and
9139 correctness.  All must be specifically enabled.
9141 @table @gcctabopt
9142 @item -ffloat-store
9143 @opindex ffloat-store
9144 Do not store floating-point variables in registers, and inhibit other
9145 options that might change whether a floating-point value is taken from a
9146 register or memory.
9148 @cindex floating-point precision
9149 This option prevents undesirable excess precision on machines such as
9150 the 68000 where the floating registers (of the 68881) keep more
9151 precision than a @code{double} is supposed to have.  Similarly for the
9152 x86 architecture.  For most programs, the excess precision does only
9153 good, but a few programs rely on the precise definition of IEEE floating
9154 point.  Use @option{-ffloat-store} for such programs, after modifying
9155 them to store all pertinent intermediate computations into variables.
9157 @item -fexcess-precision=@var{style}
9158 @opindex fexcess-precision
9159 This option allows further control over excess precision on machines
9160 where floating-point operations occur in a format with more precision or
9161 range than the IEEE standard and interchange floating-point types.  By
9162 default, @option{-fexcess-precision=fast} is in effect; this means that
9163 operations may be carried out in a wider precision than the types specified
9164 in the source if that would result in faster code, and it is unpredictable
9165 when rounding to the types specified in the source code takes place.
9166 When compiling C, if @option{-fexcess-precision=standard} is specified then
9167 excess precision follows the rules specified in ISO C99; in particular,
9168 both casts and assignments cause values to be rounded to their
9169 semantic types (whereas @option{-ffloat-store} only affects
9170 assignments).  This option is enabled by default for C if a strict
9171 conformance option such as @option{-std=c99} is used.
9172 @option{-ffast-math} enables @option{-fexcess-precision=fast} by default
9173 regardless of whether a strict conformance option is used.
9175 @opindex mfpmath
9176 @option{-fexcess-precision=standard} is not implemented for languages
9177 other than C.  On the x86, it has no effect if @option{-mfpmath=sse}
9178 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
9179 semantics apply without excess precision, and in the latter, rounding
9180 is unpredictable.
9182 @item -ffast-math
9183 @opindex ffast-math
9184 Sets the options @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
9185 @option{-ffinite-math-only}, @option{-fno-rounding-math},
9186 @option{-fno-signaling-nans}, @option{-fcx-limited-range} and
9187 @option{-fexcess-precision=fast}.
9189 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
9191 This option is not turned on by any @option{-O} option besides
9192 @option{-Ofast} since it can result in incorrect output for programs
9193 that depend on an exact implementation of IEEE or ISO rules/specifications
9194 for math functions. It may, however, yield faster code for programs
9195 that do not require the guarantees of these specifications.
9197 @item -fno-math-errno
9198 @opindex fno-math-errno
9199 Do not set @code{errno} after calling math functions that are executed
9200 with a single instruction, e.g., @code{sqrt}.  A program that relies on
9201 IEEE exceptions for math error handling may want to use this flag
9202 for speed while maintaining IEEE arithmetic compatibility.
9204 This option is not turned on by any @option{-O} option since
9205 it can result in incorrect output for programs that depend on
9206 an exact implementation of IEEE or ISO rules/specifications for
9207 math functions. It may, however, yield faster code for programs
9208 that do not require the guarantees of these specifications.
9210 The default is @option{-fmath-errno}.
9212 On Darwin systems, the math library never sets @code{errno}.  There is
9213 therefore no reason for the compiler to consider the possibility that
9214 it might, and @option{-fno-math-errno} is the default.
9216 @item -funsafe-math-optimizations
9217 @opindex funsafe-math-optimizations
9219 Allow optimizations for floating-point arithmetic that (a) assume
9220 that arguments and results are valid and (b) may violate IEEE or
9221 ANSI standards.  When used at link time, it may include libraries
9222 or startup files that change the default FPU control word or other
9223 similar optimizations.
9225 This option is not turned on by any @option{-O} option since
9226 it can result in incorrect output for programs that depend on
9227 an exact implementation of IEEE or ISO rules/specifications for
9228 math functions. It may, however, yield faster code for programs
9229 that do not require the guarantees of these specifications.
9230 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
9231 @option{-fassociative-math} and @option{-freciprocal-math}.
9233 The default is @option{-fno-unsafe-math-optimizations}.
9235 @item -fassociative-math
9236 @opindex fassociative-math
9238 Allow re-association of operands in series of floating-point operations.
9239 This violates the ISO C and C++ language standard by possibly changing
9240 computation result.  NOTE: re-ordering may change the sign of zero as
9241 well as ignore NaNs and inhibit or create underflow or overflow (and
9242 thus cannot be used on code that relies on rounding behavior like
9243 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
9244 and thus may not be used when ordered comparisons are required.
9245 This option requires that both @option{-fno-signed-zeros} and
9246 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
9247 much sense with @option{-frounding-math}. For Fortran the option
9248 is automatically enabled when both @option{-fno-signed-zeros} and
9249 @option{-fno-trapping-math} are in effect.
9251 The default is @option{-fno-associative-math}.
9253 @item -freciprocal-math
9254 @opindex freciprocal-math
9256 Allow the reciprocal of a value to be used instead of dividing by
9257 the value if this enables optimizations.  For example @code{x / y}
9258 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
9259 is subject to common subexpression elimination.  Note that this loses
9260 precision and increases the number of flops operating on the value.
9262 The default is @option{-fno-reciprocal-math}.
9264 @item -ffinite-math-only
9265 @opindex ffinite-math-only
9266 Allow optimizations for floating-point arithmetic that assume
9267 that arguments and results are not NaNs or +-Infs.
9269 This option is not turned on by any @option{-O} option since
9270 it can result in incorrect output for programs that depend on
9271 an exact implementation of IEEE or ISO rules/specifications for
9272 math functions. It may, however, yield faster code for programs
9273 that do not require the guarantees of these specifications.
9275 The default is @option{-fno-finite-math-only}.
9277 @item -fno-signed-zeros
9278 @opindex fno-signed-zeros
9279 Allow optimizations for floating-point arithmetic that ignore the
9280 signedness of zero.  IEEE arithmetic specifies the behavior of
9281 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
9282 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
9283 This option implies that the sign of a zero result isn't significant.
9285 The default is @option{-fsigned-zeros}.
9287 @item -fno-trapping-math
9288 @opindex fno-trapping-math
9289 Compile code assuming that floating-point operations cannot generate
9290 user-visible traps.  These traps include division by zero, overflow,
9291 underflow, inexact result and invalid operation.  This option requires
9292 that @option{-fno-signaling-nans} be in effect.  Setting this option may
9293 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
9295 This option should never be turned on by any @option{-O} option since
9296 it can result in incorrect output for programs that depend on
9297 an exact implementation of IEEE or ISO rules/specifications for
9298 math functions.
9300 The default is @option{-ftrapping-math}.
9302 @item -frounding-math
9303 @opindex frounding-math
9304 Disable transformations and optimizations that assume default floating-point
9305 rounding behavior.  This is round-to-zero for all floating point
9306 to integer conversions, and round-to-nearest for all other arithmetic
9307 truncations.  This option should be specified for programs that change
9308 the FP rounding mode dynamically, or that may be executed with a
9309 non-default rounding mode.  This option disables constant folding of
9310 floating-point expressions at compile time (which may be affected by
9311 rounding mode) and arithmetic transformations that are unsafe in the
9312 presence of sign-dependent rounding modes.
9314 The default is @option{-fno-rounding-math}.
9316 This option is experimental and does not currently guarantee to
9317 disable all GCC optimizations that are affected by rounding mode.
9318 Future versions of GCC may provide finer control of this setting
9319 using C99's @code{FENV_ACCESS} pragma.  This command-line option
9320 will be used to specify the default state for @code{FENV_ACCESS}.
9322 @item -fsignaling-nans
9323 @opindex fsignaling-nans
9324 Compile code assuming that IEEE signaling NaNs may generate user-visible
9325 traps during floating-point operations.  Setting this option disables
9326 optimizations that may change the number of exceptions visible with
9327 signaling NaNs.  This option implies @option{-ftrapping-math}.
9329 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
9330 be defined.
9332 The default is @option{-fno-signaling-nans}.
9334 This option is experimental and does not currently guarantee to
9335 disable all GCC optimizations that affect signaling NaN behavior.
9337 @item -fno-fp-int-builtin-inexact
9338 @opindex fno-fp-int-builtin-inexact
9339 Do not allow the built-in functions @code{ceil}, @code{floor},
9340 @code{round} and @code{trunc}, and their @code{float} and @code{long
9341 double} variants, to generate code that raises the ``inexact''
9342 floating-point exception for noninteger arguments.  ISO C99 and C11
9343 allow these functions to raise the ``inexact'' exception, but ISO/IEC
9344 TS 18661-1:2014, the C bindings to IEEE 754-2008, does not allow these
9345 functions to do so.
9347 The default is @option{-ffp-int-builtin-inexact}, allowing the
9348 exception to be raised.  This option does nothing unless
9349 @option{-ftrapping-math} is in effect.
9351 Even if @option{-fno-fp-int-builtin-inexact} is used, if the functions
9352 generate a call to a library function then the ``inexact'' exception
9353 may be raised if the library implementation does not follow TS 18661.
9355 @item -fsingle-precision-constant
9356 @opindex fsingle-precision-constant
9357 Treat floating-point constants as single precision instead of
9358 implicitly converting them to double-precision constants.
9360 @item -fcx-limited-range
9361 @opindex fcx-limited-range
9362 When enabled, this option states that a range reduction step is not
9363 needed when performing complex division.  Also, there is no checking
9364 whether the result of a complex multiplication or division is @code{NaN
9365 + I*NaN}, with an attempt to rescue the situation in that case.  The
9366 default is @option{-fno-cx-limited-range}, but is enabled by
9367 @option{-ffast-math}.
9369 This option controls the default setting of the ISO C99
9370 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
9371 all languages.
9373 @item -fcx-fortran-rules
9374 @opindex fcx-fortran-rules
9375 Complex multiplication and division follow Fortran rules.  Range
9376 reduction is done as part of complex division, but there is no checking
9377 whether the result of a complex multiplication or division is @code{NaN
9378 + I*NaN}, with an attempt to rescue the situation in that case.
9380 The default is @option{-fno-cx-fortran-rules}.
9382 @end table
9384 The following options control optimizations that may improve
9385 performance, but are not enabled by any @option{-O} options.  This
9386 section includes experimental options that may produce broken code.
9388 @table @gcctabopt
9389 @item -fbranch-probabilities
9390 @opindex fbranch-probabilities
9391 After running a program compiled with @option{-fprofile-arcs}
9392 (@pxref{Instrumentation Options}),
9393 you can compile it a second time using
9394 @option{-fbranch-probabilities}, to improve optimizations based on
9395 the number of times each branch was taken.  When a program
9396 compiled with @option{-fprofile-arcs} exits, it saves arc execution
9397 counts to a file called @file{@var{sourcename}.gcda} for each source
9398 file.  The information in this data file is very dependent on the
9399 structure of the generated code, so you must use the same source code
9400 and the same optimization options for both compilations.
9402 With @option{-fbranch-probabilities}, GCC puts a
9403 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
9404 These can be used to improve optimization.  Currently, they are only
9405 used in one place: in @file{reorg.c}, instead of guessing which path a
9406 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
9407 exactly determine which path is taken more often.
9409 @item -fprofile-values
9410 @opindex fprofile-values
9411 If combined with @option{-fprofile-arcs}, it adds code so that some
9412 data about values of expressions in the program is gathered.
9414 With @option{-fbranch-probabilities}, it reads back the data gathered
9415 from profiling values of expressions for usage in optimizations.
9417 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
9419 @item -fprofile-reorder-functions
9420 @opindex fprofile-reorder-functions
9421 Function reordering based on profile instrumentation collects
9422 first time of execution of a function and orders these functions
9423 in ascending order.
9425 Enabled with @option{-fprofile-use}.
9427 @item -fvpt
9428 @opindex fvpt
9429 If combined with @option{-fprofile-arcs}, this option instructs the compiler
9430 to add code to gather information about values of expressions.
9432 With @option{-fbranch-probabilities}, it reads back the data gathered
9433 and actually performs the optimizations based on them.
9434 Currently the optimizations include specialization of division operations
9435 using the knowledge about the value of the denominator.
9437 @item -frename-registers
9438 @opindex frename-registers
9439 Attempt to avoid false dependencies in scheduled code by making use
9440 of registers left over after register allocation.  This optimization
9441 most benefits processors with lots of registers.  Depending on the
9442 debug information format adopted by the target, however, it can
9443 make debugging impossible, since variables no longer stay in
9444 a ``home register''.
9446 Enabled by default with @option{-funroll-loops}.
9448 @item -fschedule-fusion
9449 @opindex fschedule-fusion
9450 Performs a target dependent pass over the instruction stream to schedule
9451 instructions of same type together because target machine can execute them
9452 more efficiently if they are adjacent to each other in the instruction flow.
9454 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9456 @item -ftracer
9457 @opindex ftracer
9458 Perform tail duplication to enlarge superblock size.  This transformation
9459 simplifies the control flow of the function allowing other optimizations to do
9460 a better job.
9462 Enabled with @option{-fprofile-use}.
9464 @item -funroll-loops
9465 @opindex funroll-loops
9466 Unroll loops whose number of iterations can be determined at compile time or
9467 upon entry to the loop.  @option{-funroll-loops} implies
9468 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
9469 It also turns on complete loop peeling (i.e.@: complete removal of loops with
9470 a small constant number of iterations).  This option makes code larger, and may
9471 or may not make it run faster.
9473 Enabled with @option{-fprofile-use}.
9475 @item -funroll-all-loops
9476 @opindex funroll-all-loops
9477 Unroll all loops, even if their number of iterations is uncertain when
9478 the loop is entered.  This usually makes programs run more slowly.
9479 @option{-funroll-all-loops} implies the same options as
9480 @option{-funroll-loops}.
9482 @item -fpeel-loops
9483 @opindex fpeel-loops
9484 Peels loops for which there is enough information that they do not
9485 roll much (from profile feedback or static analysis).  It also turns on
9486 complete loop peeling (i.e.@: complete removal of loops with small constant
9487 number of iterations).
9489 Enabled with @option{-O3} and/or @option{-fprofile-use}.
9491 @item -fmove-loop-invariants
9492 @opindex fmove-loop-invariants
9493 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
9494 at level @option{-O1}
9496 @item -fsplit-loops
9497 @opindex fsplit-loops
9498 Split a loop into two if it contains a condition that's always true
9499 for one side of the iteration space and false for the other.
9501 @item -funswitch-loops
9502 @opindex funswitch-loops
9503 Move branches with loop invariant conditions out of the loop, with duplicates
9504 of the loop on both branches (modified according to result of the condition).
9506 @item -ffunction-sections
9507 @itemx -fdata-sections
9508 @opindex ffunction-sections
9509 @opindex fdata-sections
9510 Place each function or data item into its own section in the output
9511 file if the target supports arbitrary sections.  The name of the
9512 function or the name of the data item determines the section's name
9513 in the output file.
9515 Use these options on systems where the linker can perform optimizations
9516 to improve locality of reference in the instruction space.  Most systems
9517 using the ELF object format and SPARC processors running Solaris 2 have
9518 linkers with such optimizations.  AIX may have these optimizations in
9519 the future.
9521 Only use these options when there are significant benefits from doing
9522 so.  When you specify these options, the assembler and linker
9523 create larger object and executable files and are also slower.
9524 You cannot use @command{gprof} on all systems if you
9525 specify this option, and you may have problems with debugging if
9526 you specify both this option and @option{-g}.
9528 @item -fbranch-target-load-optimize
9529 @opindex fbranch-target-load-optimize
9530 Perform branch target register load optimization before prologue / epilogue
9531 threading.
9532 The use of target registers can typically be exposed only during reload,
9533 thus hoisting loads out of loops and doing inter-block scheduling needs
9534 a separate optimization pass.
9536 @item -fbranch-target-load-optimize2
9537 @opindex fbranch-target-load-optimize2
9538 Perform branch target register load optimization after prologue / epilogue
9539 threading.
9541 @item -fbtr-bb-exclusive
9542 @opindex fbtr-bb-exclusive
9543 When performing branch target register load optimization, don't reuse
9544 branch target registers within any basic block.
9546 @item -fstdarg-opt
9547 @opindex fstdarg-opt
9548 Optimize the prologue of variadic argument functions with respect to usage of
9549 those arguments.
9551 @item -fsection-anchors
9552 @opindex fsection-anchors
9553 Try to reduce the number of symbolic address calculations by using
9554 shared ``anchor'' symbols to address nearby objects.  This transformation
9555 can help to reduce the number of GOT entries and GOT accesses on some
9556 targets.
9558 For example, the implementation of the following function @code{foo}:
9560 @smallexample
9561 static int a, b, c;
9562 int foo (void) @{ return a + b + c; @}
9563 @end smallexample
9565 @noindent
9566 usually calculates the addresses of all three variables, but if you
9567 compile it with @option{-fsection-anchors}, it accesses the variables
9568 from a common anchor point instead.  The effect is similar to the
9569 following pseudocode (which isn't valid C):
9571 @smallexample
9572 int foo (void)
9574   register int *xr = &x;
9575   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
9577 @end smallexample
9579 Not all targets support this option.
9581 @item --param @var{name}=@var{value}
9582 @opindex param
9583 In some places, GCC uses various constants to control the amount of
9584 optimization that is done.  For example, GCC does not inline functions
9585 that contain more than a certain number of instructions.  You can
9586 control some of these constants on the command line using the
9587 @option{--param} option.
9589 The names of specific parameters, and the meaning of the values, are
9590 tied to the internals of the compiler, and are subject to change
9591 without notice in future releases.
9593 In each case, the @var{value} is an integer.  The allowable choices for
9594 @var{name} are:
9596 @table @gcctabopt
9597 @item predictable-branch-outcome
9598 When branch is predicted to be taken with probability lower than this threshold
9599 (in percent), then it is considered well predictable. The default is 10.
9601 @item max-rtl-if-conversion-insns
9602 RTL if-conversion tries to remove conditional branches around a block and
9603 replace them with conditionally executed instructions.  This parameter
9604 gives the maximum number of instructions in a block which should be
9605 considered for if-conversion.  The default is 10, though the compiler will
9606 also use other heuristics to decide whether if-conversion is likely to be
9607 profitable.
9609 @item max-rtl-if-conversion-predictable-cost
9610 @item max-rtl-if-conversion-unpredictable-cost
9611 RTL if-conversion will try to remove conditional branches around a block
9612 and replace them with conditionally executed instructions.  These parameters
9613 give the maximum permissible cost for the sequence that would be generated
9614 by if-conversion depending on whether the branch is statically determined
9615 to be predictable or not.  The units for this parameter are the same as
9616 those for the GCC internal seq_cost metric.  The compiler will try to
9617 provide a reasonable default for this parameter using the BRANCH_COST
9618 target macro.
9620 @item max-crossjump-edges
9621 The maximum number of incoming edges to consider for cross-jumping.
9622 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
9623 the number of edges incoming to each block.  Increasing values mean
9624 more aggressive optimization, making the compilation time increase with
9625 probably small improvement in executable size.
9627 @item min-crossjump-insns
9628 The minimum number of instructions that must be matched at the end
9629 of two blocks before cross-jumping is performed on them.  This
9630 value is ignored in the case where all instructions in the block being
9631 cross-jumped from are matched.  The default value is 5.
9633 @item max-grow-copy-bb-insns
9634 The maximum code size expansion factor when copying basic blocks
9635 instead of jumping.  The expansion is relative to a jump instruction.
9636 The default value is 8.
9638 @item max-goto-duplication-insns
9639 The maximum number of instructions to duplicate to a block that jumps
9640 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
9641 passes, GCC factors computed gotos early in the compilation process,
9642 and unfactors them as late as possible.  Only computed jumps at the
9643 end of a basic blocks with no more than max-goto-duplication-insns are
9644 unfactored.  The default value is 8.
9646 @item max-delay-slot-insn-search
9647 The maximum number of instructions to consider when looking for an
9648 instruction to fill a delay slot.  If more than this arbitrary number of
9649 instructions are searched, the time savings from filling the delay slot
9650 are minimal, so stop searching.  Increasing values mean more
9651 aggressive optimization, making the compilation time increase with probably
9652 small improvement in execution time.
9654 @item max-delay-slot-live-search
9655 When trying to fill delay slots, the maximum number of instructions to
9656 consider when searching for a block with valid live register
9657 information.  Increasing this arbitrarily chosen value means more
9658 aggressive optimization, increasing the compilation time.  This parameter
9659 should be removed when the delay slot code is rewritten to maintain the
9660 control-flow graph.
9662 @item max-gcse-memory
9663 The approximate maximum amount of memory that can be allocated in
9664 order to perform the global common subexpression elimination
9665 optimization.  If more memory than specified is required, the
9666 optimization is not done.
9668 @item max-gcse-insertion-ratio
9669 If the ratio of expression insertions to deletions is larger than this value
9670 for any expression, then RTL PRE inserts or removes the expression and thus
9671 leaves partially redundant computations in the instruction stream.  The default value is 20.
9673 @item max-pending-list-length
9674 The maximum number of pending dependencies scheduling allows
9675 before flushing the current state and starting over.  Large functions
9676 with few branches or calls can create excessively large lists which
9677 needlessly consume memory and resources.
9679 @item max-modulo-backtrack-attempts
9680 The maximum number of backtrack attempts the scheduler should make
9681 when modulo scheduling a loop.  Larger values can exponentially increase
9682 compilation time.
9684 @item max-inline-insns-single
9685 Several parameters control the tree inliner used in GCC@.
9686 This number sets the maximum number of instructions (counted in GCC's
9687 internal representation) in a single function that the tree inliner
9688 considers for inlining.  This only affects functions declared
9689 inline and methods implemented in a class declaration (C++).
9690 The default value is 400.
9692 @item max-inline-insns-auto
9693 When you use @option{-finline-functions} (included in @option{-O3}),
9694 a lot of functions that would otherwise not be considered for inlining
9695 by the compiler are investigated.  To those functions, a different
9696 (more restrictive) limit compared to functions declared inline can
9697 be applied.
9698 The default value is 40.
9700 @item inline-min-speedup
9701 When estimated performance improvement of caller + callee runtime exceeds this
9702 threshold (in percent), the function can be inlined regardless of the limit on
9703 @option{--param max-inline-insns-single} and @option{--param
9704 max-inline-insns-auto}.
9706 @item large-function-insns
9707 The limit specifying really large functions.  For functions larger than this
9708 limit after inlining, inlining is constrained by
9709 @option{--param large-function-growth}.  This parameter is useful primarily
9710 to avoid extreme compilation time caused by non-linear algorithms used by the
9711 back end.
9712 The default value is 2700.
9714 @item large-function-growth
9715 Specifies maximal growth of large function caused by inlining in percents.
9716 The default value is 100 which limits large function growth to 2.0 times
9717 the original size.
9719 @item large-unit-insns
9720 The limit specifying large translation unit.  Growth caused by inlining of
9721 units larger than this limit is limited by @option{--param inline-unit-growth}.
9722 For small units this might be too tight.
9723 For example, consider a unit consisting of function A
9724 that is inline and B that just calls A three times.  If B is small relative to
9725 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
9726 large units consisting of small inlineable functions, however, the overall unit
9727 growth limit is needed to avoid exponential explosion of code size.  Thus for
9728 smaller units, the size is increased to @option{--param large-unit-insns}
9729 before applying @option{--param inline-unit-growth}.  The default is 10000.
9731 @item inline-unit-growth
9732 Specifies maximal overall growth of the compilation unit caused by inlining.
9733 The default value is 20 which limits unit growth to 1.2 times the original
9734 size. Cold functions (either marked cold via an attribute or by profile
9735 feedback) are not accounted into the unit size.
9737 @item ipcp-unit-growth
9738 Specifies maximal overall growth of the compilation unit caused by
9739 interprocedural constant propagation.  The default value is 10 which limits
9740 unit growth to 1.1 times the original size.
9742 @item large-stack-frame
9743 The limit specifying large stack frames.  While inlining the algorithm is trying
9744 to not grow past this limit too much.  The default value is 256 bytes.
9746 @item large-stack-frame-growth
9747 Specifies maximal growth of large stack frames caused by inlining in percents.
9748 The default value is 1000 which limits large stack frame growth to 11 times
9749 the original size.
9751 @item max-inline-insns-recursive
9752 @itemx max-inline-insns-recursive-auto
9753 Specifies the maximum number of instructions an out-of-line copy of a
9754 self-recursive inline
9755 function can grow into by performing recursive inlining.
9757 @option{--param max-inline-insns-recursive} applies to functions
9758 declared inline.
9759 For functions not declared inline, recursive inlining
9760 happens only when @option{-finline-functions} (included in @option{-O3}) is
9761 enabled; @option{--param max-inline-insns-recursive-auto} applies instead.  The
9762 default value is 450.
9764 @item max-inline-recursive-depth
9765 @itemx max-inline-recursive-depth-auto
9766 Specifies the maximum recursion depth used for recursive inlining.
9768 @option{--param max-inline-recursive-depth} applies to functions
9769 declared inline.  For functions not declared inline, recursive inlining
9770 happens only when @option{-finline-functions} (included in @option{-O3}) is
9771 enabled; @option{--param max-inline-recursive-depth-auto} applies instead.  The
9772 default value is 8.
9774 @item min-inline-recursive-probability
9775 Recursive inlining is profitable only for function having deep recursion
9776 in average and can hurt for function having little recursion depth by
9777 increasing the prologue size or complexity of function body to other
9778 optimizers.
9780 When profile feedback is available (see @option{-fprofile-generate}) the actual
9781 recursion depth can be guessed from the probability that function recurses
9782 via a given call expression.  This parameter limits inlining only to call
9783 expressions whose probability exceeds the given threshold (in percents).
9784 The default value is 10.
9786 @item early-inlining-insns
9787 Specify growth that the early inliner can make.  In effect it increases
9788 the amount of inlining for code having a large abstraction penalty.
9789 The default value is 14.
9791 @item max-early-inliner-iterations
9792 Limit of iterations of the early inliner.  This basically bounds
9793 the number of nested indirect calls the early inliner can resolve.
9794 Deeper chains are still handled by late inlining.
9796 @item comdat-sharing-probability
9797 Probability (in percent) that C++ inline function with comdat visibility
9798 are shared across multiple compilation units.  The default value is 20.
9800 @item profile-func-internal-id
9801 A parameter to control whether to use function internal id in profile
9802 database lookup. If the value is 0, the compiler uses an id that
9803 is based on function assembler name and filename, which makes old profile
9804 data more tolerant to source changes such as function reordering etc.
9805 The default value is 0.
9807 @item min-vect-loop-bound
9808 The minimum number of iterations under which loops are not vectorized
9809 when @option{-ftree-vectorize} is used.  The number of iterations after
9810 vectorization needs to be greater than the value specified by this option
9811 to allow vectorization.  The default value is 0.
9813 @item gcse-cost-distance-ratio
9814 Scaling factor in calculation of maximum distance an expression
9815 can be moved by GCSE optimizations.  This is currently supported only in the
9816 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
9817 is with simple expressions, i.e., the expressions that have cost
9818 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
9819 hoisting of simple expressions.  The default value is 10.
9821 @item gcse-unrestricted-cost
9822 Cost, roughly measured as the cost of a single typical machine
9823 instruction, at which GCSE optimizations do not constrain
9824 the distance an expression can travel.  This is currently
9825 supported only in the code hoisting pass.  The lesser the cost,
9826 the more aggressive code hoisting is.  Specifying 0 
9827 allows all expressions to travel unrestricted distances.
9828 The default value is 3.
9830 @item max-hoist-depth
9831 The depth of search in the dominator tree for expressions to hoist.
9832 This is used to avoid quadratic behavior in hoisting algorithm.
9833 The value of 0 does not limit on the search, but may slow down compilation
9834 of huge functions.  The default value is 30.
9836 @item max-tail-merge-comparisons
9837 The maximum amount of similar bbs to compare a bb with.  This is used to
9838 avoid quadratic behavior in tree tail merging.  The default value is 10.
9840 @item max-tail-merge-iterations
9841 The maximum amount of iterations of the pass over the function.  This is used to
9842 limit compilation time in tree tail merging.  The default value is 2.
9844 @item store-merging-allow-unaligned
9845 Allow the store merging pass to introduce unaligned stores if it is legal to
9846 do so.  The default value is 1.
9848 @item max-stores-to-merge
9849 The maximum number of stores to attempt to merge into wider stores in the store
9850 merging pass.  The minimum value is 2 and the default is 64.
9852 @item max-unrolled-insns
9853 The maximum number of instructions that a loop may have to be unrolled.
9854 If a loop is unrolled, this parameter also determines how many times
9855 the loop code is unrolled.
9857 @item max-average-unrolled-insns
9858 The maximum number of instructions biased by probabilities of their execution
9859 that a loop may have to be unrolled.  If a loop is unrolled,
9860 this parameter also determines how many times the loop code is unrolled.
9862 @item max-unroll-times
9863 The maximum number of unrollings of a single loop.
9865 @item max-peeled-insns
9866 The maximum number of instructions that a loop may have to be peeled.
9867 If a loop is peeled, this parameter also determines how many times
9868 the loop code is peeled.
9870 @item max-peel-times
9871 The maximum number of peelings of a single loop.
9873 @item max-peel-branches
9874 The maximum number of branches on the hot path through the peeled sequence.
9876 @item max-completely-peeled-insns
9877 The maximum number of insns of a completely peeled loop.
9879 @item max-completely-peel-times
9880 The maximum number of iterations of a loop to be suitable for complete peeling.
9882 @item max-completely-peel-loop-nest-depth
9883 The maximum depth of a loop nest suitable for complete peeling.
9885 @item max-unswitch-insns
9886 The maximum number of insns of an unswitched loop.
9888 @item max-unswitch-level
9889 The maximum number of branches unswitched in a single loop.
9891 @item max-loop-headers-insns
9892 The maximum number of insns in loop header duplicated by he copy loop headers
9893 pass.
9895 @item lim-expensive
9896 The minimum cost of an expensive expression in the loop invariant motion.
9898 @item iv-consider-all-candidates-bound
9899 Bound on number of candidates for induction variables, below which
9900 all candidates are considered for each use in induction variable
9901 optimizations.  If there are more candidates than this,
9902 only the most relevant ones are considered to avoid quadratic time complexity.
9904 @item iv-max-considered-uses
9905 The induction variable optimizations give up on loops that contain more
9906 induction variable uses.
9908 @item iv-always-prune-cand-set-bound
9909 If the number of candidates in the set is smaller than this value,
9910 always try to remove unnecessary ivs from the set
9911 when adding a new one.
9913 @item avg-loop-niter
9914 Average number of iterations of a loop.
9916 @item dse-max-object-size
9917 Maximum size (in bytes) of objects tracked bytewise by dead store elimination.
9918 Larger values may result in larger compilation times.
9920 @item scev-max-expr-size
9921 Bound on size of expressions used in the scalar evolutions analyzer.
9922 Large expressions slow the analyzer.
9924 @item scev-max-expr-complexity
9925 Bound on the complexity of the expressions in the scalar evolutions analyzer.
9926 Complex expressions slow the analyzer.
9928 @item max-tree-if-conversion-phi-args
9929 Maximum number of arguments in a PHI supported by TREE if conversion
9930 unless the loop is marked with simd pragma.
9932 @item vect-max-version-for-alignment-checks
9933 The maximum number of run-time checks that can be performed when
9934 doing loop versioning for alignment in the vectorizer.
9936 @item vect-max-version-for-alias-checks
9937 The maximum number of run-time checks that can be performed when
9938 doing loop versioning for alias in the vectorizer.
9940 @item vect-max-peeling-for-alignment
9941 The maximum number of loop peels to enhance access alignment
9942 for vectorizer. Value -1 means no limit.
9944 @item max-iterations-to-track
9945 The maximum number of iterations of a loop the brute-force algorithm
9946 for analysis of the number of iterations of the loop tries to evaluate.
9948 @item hot-bb-count-ws-permille
9949 A basic block profile count is considered hot if it contributes to 
9950 the given permillage (i.e. 0...1000) of the entire profiled execution.
9952 @item hot-bb-frequency-fraction
9953 Select fraction of the entry block frequency of executions of basic block in
9954 function given basic block needs to have to be considered hot.
9956 @item max-predicted-iterations
9957 The maximum number of loop iterations we predict statically.  This is useful
9958 in cases where a function contains a single loop with known bound and
9959 another loop with unknown bound.
9960 The known number of iterations is predicted correctly, while
9961 the unknown number of iterations average to roughly 10.  This means that the
9962 loop without bounds appears artificially cold relative to the other one.
9964 @item builtin-expect-probability
9965 Control the probability of the expression having the specified value. This
9966 parameter takes a percentage (i.e. 0 ... 100) as input.
9967 The default probability of 90 is obtained empirically.
9969 @item align-threshold
9971 Select fraction of the maximal frequency of executions of a basic block in
9972 a function to align the basic block.
9974 @item align-loop-iterations
9976 A loop expected to iterate at least the selected number of iterations is
9977 aligned.
9979 @item tracer-dynamic-coverage
9980 @itemx tracer-dynamic-coverage-feedback
9982 This value is used to limit superblock formation once the given percentage of
9983 executed instructions is covered.  This limits unnecessary code size
9984 expansion.
9986 The @option{tracer-dynamic-coverage-feedback} parameter
9987 is used only when profile
9988 feedback is available.  The real profiles (as opposed to statically estimated
9989 ones) are much less balanced allowing the threshold to be larger value.
9991 @item tracer-max-code-growth
9992 Stop tail duplication once code growth has reached given percentage.  This is
9993 a rather artificial limit, as most of the duplicates are eliminated later in
9994 cross jumping, so it may be set to much higher values than is the desired code
9995 growth.
9997 @item tracer-min-branch-ratio
9999 Stop reverse growth when the reverse probability of best edge is less than this
10000 threshold (in percent).
10002 @item tracer-min-branch-probability
10003 @itemx tracer-min-branch-probability-feedback
10005 Stop forward growth if the best edge has probability lower than this
10006 threshold.
10008 Similarly to @option{tracer-dynamic-coverage} two parameters are
10009 provided.  @option{tracer-min-branch-probability-feedback} is used for
10010 compilation with profile feedback and @option{tracer-min-branch-probability}
10011 compilation without.  The value for compilation with profile feedback
10012 needs to be more conservative (higher) in order to make tracer
10013 effective.
10015 @item max-cse-path-length
10017 The maximum number of basic blocks on path that CSE considers.
10018 The default is 10.
10020 @item max-cse-insns
10021 The maximum number of instructions CSE processes before flushing.
10022 The default is 1000.
10024 @item ggc-min-expand
10026 GCC uses a garbage collector to manage its own memory allocation.  This
10027 parameter specifies the minimum percentage by which the garbage
10028 collector's heap should be allowed to expand between collections.
10029 Tuning this may improve compilation speed; it has no effect on code
10030 generation.
10032 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
10033 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
10034 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
10035 GCC is not able to calculate RAM on a particular platform, the lower
10036 bound of 30% is used.  Setting this parameter and
10037 @option{ggc-min-heapsize} to zero causes a full collection to occur at
10038 every opportunity.  This is extremely slow, but can be useful for
10039 debugging.
10041 @item ggc-min-heapsize
10043 Minimum size of the garbage collector's heap before it begins bothering
10044 to collect garbage.  The first collection occurs after the heap expands
10045 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
10046 tuning this may improve compilation speed, and has no effect on code
10047 generation.
10049 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
10050 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
10051 with a lower bound of 4096 (four megabytes) and an upper bound of
10052 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
10053 particular platform, the lower bound is used.  Setting this parameter
10054 very large effectively disables garbage collection.  Setting this
10055 parameter and @option{ggc-min-expand} to zero causes a full collection
10056 to occur at every opportunity.
10058 @item max-reload-search-insns
10059 The maximum number of instruction reload should look backward for equivalent
10060 register.  Increasing values mean more aggressive optimization, making the
10061 compilation time increase with probably slightly better performance.
10062 The default value is 100.
10064 @item max-cselib-memory-locations
10065 The maximum number of memory locations cselib should take into account.
10066 Increasing values mean more aggressive optimization, making the compilation time
10067 increase with probably slightly better performance.  The default value is 500.
10069 @item max-sched-ready-insns
10070 The maximum number of instructions ready to be issued the scheduler should
10071 consider at any given time during the first scheduling pass.  Increasing
10072 values mean more thorough searches, making the compilation time increase
10073 with probably little benefit.  The default value is 100.
10075 @item max-sched-region-blocks
10076 The maximum number of blocks in a region to be considered for
10077 interblock scheduling.  The default value is 10.
10079 @item max-pipeline-region-blocks
10080 The maximum number of blocks in a region to be considered for
10081 pipelining in the selective scheduler.  The default value is 15.
10083 @item max-sched-region-insns
10084 The maximum number of insns in a region to be considered for
10085 interblock scheduling.  The default value is 100.
10087 @item max-pipeline-region-insns
10088 The maximum number of insns in a region to be considered for
10089 pipelining in the selective scheduler.  The default value is 200.
10091 @item min-spec-prob
10092 The minimum probability (in percents) of reaching a source block
10093 for interblock speculative scheduling.  The default value is 40.
10095 @item max-sched-extend-regions-iters
10096 The maximum number of iterations through CFG to extend regions.
10097 A value of 0 (the default) disables region extensions.
10099 @item max-sched-insn-conflict-delay
10100 The maximum conflict delay for an insn to be considered for speculative motion.
10101 The default value is 3.
10103 @item sched-spec-prob-cutoff
10104 The minimal probability of speculation success (in percents), so that
10105 speculative insns are scheduled.
10106 The default value is 40.
10108 @item sched-state-edge-prob-cutoff
10109 The minimum probability an edge must have for the scheduler to save its
10110 state across it.
10111 The default value is 10.
10113 @item sched-mem-true-dep-cost
10114 Minimal distance (in CPU cycles) between store and load targeting same
10115 memory locations.  The default value is 1.
10117 @item selsched-max-lookahead
10118 The maximum size of the lookahead window of selective scheduling.  It is a
10119 depth of search for available instructions.
10120 The default value is 50.
10122 @item selsched-max-sched-times
10123 The maximum number of times that an instruction is scheduled during
10124 selective scheduling.  This is the limit on the number of iterations
10125 through which the instruction may be pipelined.  The default value is 2.
10127 @item selsched-insns-to-rename
10128 The maximum number of best instructions in the ready list that are considered
10129 for renaming in the selective scheduler.  The default value is 2.
10131 @item sms-min-sc
10132 The minimum value of stage count that swing modulo scheduler
10133 generates.  The default value is 2.
10135 @item max-last-value-rtl
10136 The maximum size measured as number of RTLs that can be recorded in an expression
10137 in combiner for a pseudo register as last known value of that register.  The default
10138 is 10000.
10140 @item max-combine-insns
10141 The maximum number of instructions the RTL combiner tries to combine.
10142 The default value is 2 at @option{-Og} and 4 otherwise.
10144 @item integer-share-limit
10145 Small integer constants can use a shared data structure, reducing the
10146 compiler's memory usage and increasing its speed.  This sets the maximum
10147 value of a shared integer constant.  The default value is 256.
10149 @item ssp-buffer-size
10150 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
10151 protection when @option{-fstack-protection} is used.
10153 @item min-size-for-stack-sharing
10154 The minimum size of variables taking part in stack slot sharing when not
10155 optimizing. The default value is 32.
10157 @item max-jump-thread-duplication-stmts
10158 Maximum number of statements allowed in a block that needs to be
10159 duplicated when threading jumps.
10161 @item max-fields-for-field-sensitive
10162 Maximum number of fields in a structure treated in
10163 a field sensitive manner during pointer analysis.  The default is zero
10164 for @option{-O0} and @option{-O1},
10165 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
10167 @item prefetch-latency
10168 Estimate on average number of instructions that are executed before
10169 prefetch finishes.  The distance prefetched ahead is proportional
10170 to this constant.  Increasing this number may also lead to less
10171 streams being prefetched (see @option{simultaneous-prefetches}).
10173 @item simultaneous-prefetches
10174 Maximum number of prefetches that can run at the same time.
10176 @item l1-cache-line-size
10177 The size of cache line in L1 cache, in bytes.
10179 @item l1-cache-size
10180 The size of L1 cache, in kilobytes.
10182 @item l2-cache-size
10183 The size of L2 cache, in kilobytes.
10185 @item min-insn-to-prefetch-ratio
10186 The minimum ratio between the number of instructions and the
10187 number of prefetches to enable prefetching in a loop.
10189 @item prefetch-min-insn-to-mem-ratio
10190 The minimum ratio between the number of instructions and the
10191 number of memory references to enable prefetching in a loop.
10193 @item use-canonical-types
10194 Whether the compiler should use the ``canonical'' type system.  By
10195 default, this should always be 1, which uses a more efficient internal
10196 mechanism for comparing types in C++ and Objective-C++.  However, if
10197 bugs in the canonical type system are causing compilation failures,
10198 set this value to 0 to disable canonical types.
10200 @item switch-conversion-max-branch-ratio
10201 Switch initialization conversion refuses to create arrays that are
10202 bigger than @option{switch-conversion-max-branch-ratio} times the number of
10203 branches in the switch.
10205 @item max-partial-antic-length
10206 Maximum length of the partial antic set computed during the tree
10207 partial redundancy elimination optimization (@option{-ftree-pre}) when
10208 optimizing at @option{-O3} and above.  For some sorts of source code
10209 the enhanced partial redundancy elimination optimization can run away,
10210 consuming all of the memory available on the host machine.  This
10211 parameter sets a limit on the length of the sets that are computed,
10212 which prevents the runaway behavior.  Setting a value of 0 for
10213 this parameter allows an unlimited set length.
10215 @item sccvn-max-scc-size
10216 Maximum size of a strongly connected component (SCC) during SCCVN
10217 processing.  If this limit is hit, SCCVN processing for the whole
10218 function is not done and optimizations depending on it are
10219 disabled.  The default maximum SCC size is 10000.
10221 @item sccvn-max-alias-queries-per-access
10222 Maximum number of alias-oracle queries we perform when looking for
10223 redundancies for loads and stores.  If this limit is hit the search
10224 is aborted and the load or store is not considered redundant.  The
10225 number of queries is algorithmically limited to the number of
10226 stores on all paths from the load to the function entry.
10227 The default maximum number of queries is 1000.
10229 @item ira-max-loops-num
10230 IRA uses regional register allocation by default.  If a function
10231 contains more loops than the number given by this parameter, only at most
10232 the given number of the most frequently-executed loops form regions
10233 for regional register allocation.  The default value of the
10234 parameter is 100.
10236 @item ira-max-conflict-table-size 
10237 Although IRA uses a sophisticated algorithm to compress the conflict
10238 table, the table can still require excessive amounts of memory for
10239 huge functions.  If the conflict table for a function could be more
10240 than the size in MB given by this parameter, the register allocator
10241 instead uses a faster, simpler, and lower-quality
10242 algorithm that does not require building a pseudo-register conflict table.  
10243 The default value of the parameter is 2000.
10245 @item ira-loop-reserved-regs
10246 IRA can be used to evaluate more accurate register pressure in loops
10247 for decisions to move loop invariants (see @option{-O3}).  The number
10248 of available registers reserved for some other purposes is given
10249 by this parameter.  The default value of the parameter is 2, which is
10250 the minimal number of registers needed by typical instructions.
10251 This value is the best found from numerous experiments.
10253 @item lra-inheritance-ebb-probability-cutoff
10254 LRA tries to reuse values reloaded in registers in subsequent insns.
10255 This optimization is called inheritance.  EBB is used as a region to
10256 do this optimization.  The parameter defines a minimal fall-through
10257 edge probability in percentage used to add BB to inheritance EBB in
10258 LRA.  The default value of the parameter is 40.  The value was chosen
10259 from numerous runs of SPEC2000 on x86-64.
10261 @item loop-invariant-max-bbs-in-loop
10262 Loop invariant motion can be very expensive, both in compilation time and
10263 in amount of needed compile-time memory, with very large loops.  Loops
10264 with more basic blocks than this parameter won't have loop invariant
10265 motion optimization performed on them.  The default value of the
10266 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
10268 @item loop-max-datarefs-for-datadeps
10269 Building data dependencies is expensive for very large loops.  This
10270 parameter limits the number of data references in loops that are
10271 considered for data dependence analysis.  These large loops are no
10272 handled by the optimizations using loop data dependencies.
10273 The default value is 1000.
10275 @item max-vartrack-size
10276 Sets a maximum number of hash table slots to use during variable
10277 tracking dataflow analysis of any function.  If this limit is exceeded
10278 with variable tracking at assignments enabled, analysis for that
10279 function is retried without it, after removing all debug insns from
10280 the function.  If the limit is exceeded even without debug insns, var
10281 tracking analysis is completely disabled for the function.  Setting
10282 the parameter to zero makes it unlimited.
10284 @item max-vartrack-expr-depth
10285 Sets a maximum number of recursion levels when attempting to map
10286 variable names or debug temporaries to value expressions.  This trades
10287 compilation time for more complete debug information.  If this is set too
10288 low, value expressions that are available and could be represented in
10289 debug information may end up not being used; setting this higher may
10290 enable the compiler to find more complex debug expressions, but compile
10291 time and memory use may grow.  The default is 12.
10293 @item min-nondebug-insn-uid
10294 Use uids starting at this parameter for nondebug insns.  The range below
10295 the parameter is reserved exclusively for debug insns created by
10296 @option{-fvar-tracking-assignments}, but debug insns may get
10297 (non-overlapping) uids above it if the reserved range is exhausted.
10299 @item ipa-sra-ptr-growth-factor
10300 IPA-SRA replaces a pointer to an aggregate with one or more new
10301 parameters only when their cumulative size is less or equal to
10302 @option{ipa-sra-ptr-growth-factor} times the size of the original
10303 pointer parameter.
10305 @item sra-max-scalarization-size-Ospeed
10306 @item sra-max-scalarization-size-Osize
10307 The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to
10308 replace scalar parts of aggregates with uses of independent scalar
10309 variables.  These parameters control the maximum size, in storage units,
10310 of aggregate which is considered for replacement when compiling for
10311 speed
10312 (@option{sra-max-scalarization-size-Ospeed}) or size
10313 (@option{sra-max-scalarization-size-Osize}) respectively.
10315 @item tm-max-aggregate-size
10316 When making copies of thread-local variables in a transaction, this
10317 parameter specifies the size in bytes after which variables are
10318 saved with the logging functions as opposed to save/restore code
10319 sequence pairs.  This option only applies when using
10320 @option{-fgnu-tm}.
10322 @item graphite-max-nb-scop-params
10323 To avoid exponential effects in the Graphite loop transforms, the
10324 number of parameters in a Static Control Part (SCoP) is bounded.  The
10325 default value is 10 parameters.  A variable whose value is unknown at
10326 compilation time and defined outside a SCoP is a parameter of the SCoP.
10328 @item graphite-max-bbs-per-function
10329 To avoid exponential effects in the detection of SCoPs, the size of
10330 the functions analyzed by Graphite is bounded.  The default value is
10331 100 basic blocks.
10333 @item loop-block-tile-size
10334 Loop blocking or strip mining transforms, enabled with
10335 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
10336 loop in the loop nest by a given number of iterations.  The strip
10337 length can be changed using the @option{loop-block-tile-size}
10338 parameter.  The default value is 51 iterations.
10340 @item loop-unroll-jam-size
10341 Specify the unroll factor for the @option{-floop-unroll-and-jam} option.  The 
10342 default value is 4.
10344 @item loop-unroll-jam-depth
10345 Specify the dimension to be unrolled (counting from the most inner loop)
10346 for the  @option{-floop-unroll-and-jam}.  The default value is 2.
10348 @item ipa-cp-value-list-size
10349 IPA-CP attempts to track all possible values and types passed to a function's
10350 parameter in order to propagate them and perform devirtualization.
10351 @option{ipa-cp-value-list-size} is the maximum number of values and types it
10352 stores per one formal parameter of a function.
10354 @item ipa-cp-eval-threshold
10355 IPA-CP calculates its own score of cloning profitability heuristics
10356 and performs those cloning opportunities with scores that exceed
10357 @option{ipa-cp-eval-threshold}.
10359 @item ipa-cp-recursion-penalty
10360 Percentage penalty the recursive functions will receive when they
10361 are evaluated for cloning.
10363 @item ipa-cp-single-call-penalty
10364 Percentage penalty functions containing a single call to another
10365 function will receive when they are evaluated for cloning.
10368 @item ipa-max-agg-items
10369 IPA-CP is also capable to propagate a number of scalar values passed
10370 in an aggregate. @option{ipa-max-agg-items} controls the maximum
10371 number of such values per one parameter.
10373 @item ipa-cp-loop-hint-bonus
10374 When IPA-CP determines that a cloning candidate would make the number
10375 of iterations of a loop known, it adds a bonus of
10376 @option{ipa-cp-loop-hint-bonus} to the profitability score of
10377 the candidate.
10379 @item ipa-cp-array-index-hint-bonus
10380 When IPA-CP determines that a cloning candidate would make the index of
10381 an array access known, it adds a bonus of
10382 @option{ipa-cp-array-index-hint-bonus} to the profitability
10383 score of the candidate.
10385 @item ipa-max-aa-steps
10386 During its analysis of function bodies, IPA-CP employs alias analysis
10387 in order to track values pointed to by function parameters.  In order
10388 not spend too much time analyzing huge functions, it gives up and
10389 consider all memory clobbered after examining
10390 @option{ipa-max-aa-steps} statements modifying memory.
10392 @item lto-partitions
10393 Specify desired number of partitions produced during WHOPR compilation.
10394 The number of partitions should exceed the number of CPUs used for compilation.
10395 The default value is 32.
10397 @item lto-min-partition
10398 Size of minimal partition for WHOPR (in estimated instructions).
10399 This prevents expenses of splitting very small programs into too many
10400 partitions.
10402 @item lto-max-partition
10403 Size of max partition for WHOPR (in estimated instructions).
10404 to provide an upper bound for individual size of partition.
10405 Meant to be used only with balanced partitioning.
10407 @item cxx-max-namespaces-for-diagnostic-help
10408 The maximum number of namespaces to consult for suggestions when C++
10409 name lookup fails for an identifier.  The default is 1000.
10411 @item sink-frequency-threshold
10412 The maximum relative execution frequency (in percents) of the target block
10413 relative to a statement's original block to allow statement sinking of a
10414 statement.  Larger numbers result in more aggressive statement sinking.
10415 The default value is 75.  A small positive adjustment is applied for
10416 statements with memory operands as those are even more profitable so sink.
10418 @item max-stores-to-sink
10419 The maximum number of conditional store pairs that can be sunk.  Set to 0
10420 if either vectorization (@option{-ftree-vectorize}) or if-conversion
10421 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
10423 @item allow-store-data-races
10424 Allow optimizers to introduce new data races on stores.
10425 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10426 at optimization level @option{-Ofast}.
10428 @item case-values-threshold
10429 The smallest number of different values for which it is best to use a
10430 jump-table instead of a tree of conditional branches.  If the value is
10431 0, use the default for the machine.  The default is 0.
10433 @item tree-reassoc-width
10434 Set the maximum number of instructions executed in parallel in
10435 reassociated tree. This parameter overrides target dependent
10436 heuristics used by default if has non zero value.
10438 @item sched-pressure-algorithm
10439 Choose between the two available implementations of
10440 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
10441 and is the more likely to prevent instructions from being reordered.
10442 Algorithm 2 was designed to be a compromise between the relatively
10443 conservative approach taken by algorithm 1 and the rather aggressive
10444 approach taken by the default scheduler.  It relies more heavily on
10445 having a regular register file and accurate register pressure classes.
10446 See @file{haifa-sched.c} in the GCC sources for more details.
10448 The default choice depends on the target.
10450 @item max-slsr-cand-scan
10451 Set the maximum number of existing candidates that are considered when
10452 seeking a basis for a new straight-line strength reduction candidate.
10454 @item asan-globals
10455 Enable buffer overflow detection for global objects.  This kind
10456 of protection is enabled by default if you are using
10457 @option{-fsanitize=address} option.
10458 To disable global objects protection use @option{--param asan-globals=0}.
10460 @item asan-stack
10461 Enable buffer overflow detection for stack objects.  This kind of
10462 protection is enabled by default when using @option{-fsanitize=address}.
10463 To disable stack protection use @option{--param asan-stack=0} option.
10465 @item asan-instrument-reads
10466 Enable buffer overflow detection for memory reads.  This kind of
10467 protection is enabled by default when using @option{-fsanitize=address}.
10468 To disable memory reads protection use
10469 @option{--param asan-instrument-reads=0}.
10471 @item asan-instrument-writes
10472 Enable buffer overflow detection for memory writes.  This kind of
10473 protection is enabled by default when using @option{-fsanitize=address}.
10474 To disable memory writes protection use
10475 @option{--param asan-instrument-writes=0} option.
10477 @item asan-memintrin
10478 Enable detection for built-in functions.  This kind of protection
10479 is enabled by default when using @option{-fsanitize=address}.
10480 To disable built-in functions protection use
10481 @option{--param asan-memintrin=0}.
10483 @item asan-use-after-return
10484 Enable detection of use-after-return.  This kind of protection
10485 is enabled by default when using the @option{-fsanitize=address} option.
10486 To disable it use @option{--param asan-use-after-return=0}.
10488 Note: By default the check is disabled at run time.  To enable it,
10489 add @code{detect_stack_use_after_return=1} to the environment variable
10490 @env{ASAN_OPTIONS}.
10492 @item asan-instrumentation-with-call-threshold
10493 If number of memory accesses in function being instrumented
10494 is greater or equal to this number, use callbacks instead of inline checks.
10495 E.g. to disable inline code use
10496 @option{--param asan-instrumentation-with-call-threshold=0}.
10498 @item use-after-scope-direct-emission-threshold
10499 If the size of a local variable in bytes is smaller or equal to this
10500 number, directly poison (or unpoison) shadow memory instead of using
10501 run-time callbacks.  The default value is 256.
10503 @item chkp-max-ctor-size
10504 Static constructors generated by Pointer Bounds Checker may become very
10505 large and significantly increase compile time at optimization level
10506 @option{-O1} and higher.  This parameter is a maximum number of statements
10507 in a single generated constructor.  Default value is 5000.
10509 @item max-fsm-thread-path-insns
10510 Maximum number of instructions to copy when duplicating blocks on a
10511 finite state automaton jump thread path.  The default is 100.
10513 @item max-fsm-thread-length
10514 Maximum number of basic blocks on a finite state automaton jump thread
10515 path.  The default is 10.
10517 @item max-fsm-thread-paths
10518 Maximum number of new jump thread paths to create for a finite state
10519 automaton.  The default is 50.
10521 @item parloops-chunk-size
10522 Chunk size of omp schedule for loops parallelized by parloops.  The default
10523 is 0.
10525 @item parloops-schedule
10526 Schedule type of omp schedule for loops parallelized by parloops (static,
10527 dynamic, guided, auto, runtime).  The default is static.
10529 @item max-ssa-name-query-depth
10530 Maximum depth of recursion when querying properties of SSA names in things
10531 like fold routines.  One level of recursion corresponds to following a
10532 use-def chain.
10534 @item hsa-gen-debug-stores
10535 Enable emission of special debug stores within HSA kernels which are
10536 then read and reported by libgomp plugin.  Generation of these stores
10537 is disabled by default, use @option{--param hsa-gen-debug-stores=1} to
10538 enable it.
10540 @item max-speculative-devirt-maydefs
10541 The maximum number of may-defs we analyze when looking for a must-def
10542 specifying the dynamic type of an object that invokes a virtual call
10543 we may be able to devirtualize speculatively.
10545 @item max-vrp-switch-assertions
10546 The maximum number of assertions to add along the default edge of a switch
10547 statement during VRP.  The default is 10.
10548 @end table
10549 @end table
10551 @node Instrumentation Options
10552 @section Program Instrumentation Options
10553 @cindex instrumentation options
10554 @cindex program instrumentation options
10555 @cindex run-time error checking options
10556 @cindex profiling options
10557 @cindex options, program instrumentation
10558 @cindex options, run-time error checking
10559 @cindex options, profiling
10561 GCC supports a number of command-line options that control adding
10562 run-time instrumentation to the code it normally generates.  
10563 For example, one purpose of instrumentation is collect profiling
10564 statistics for use in finding program hot spots, code coverage
10565 analysis, or profile-guided optimizations.
10566 Another class of program instrumentation is adding run-time checking 
10567 to detect programming errors like invalid pointer
10568 dereferences or out-of-bounds array accesses, as well as deliberately
10569 hostile attacks such as stack smashing or C++ vtable hijacking.
10570 There is also a general hook which can be used to implement other
10571 forms of tracing or function-level instrumentation for debug or
10572 program analysis purposes.
10574 @table @gcctabopt
10575 @cindex @command{prof}
10576 @item -p
10577 @opindex p
10578 Generate extra code to write profile information suitable for the
10579 analysis program @command{prof}.  You must use this option when compiling
10580 the source files you want data about, and you must also use it when
10581 linking.
10583 @cindex @command{gprof}
10584 @item -pg
10585 @opindex pg
10586 Generate extra code to write profile information suitable for the
10587 analysis program @command{gprof}.  You must use this option when compiling
10588 the source files you want data about, and you must also use it when
10589 linking.
10591 @item -fprofile-arcs
10592 @opindex fprofile-arcs
10593 Add code so that program flow @dfn{arcs} are instrumented.  During
10594 execution the program records how many times each branch and call is
10595 executed and how many times it is taken or returns.  On targets that support
10596 constructors with priority support, profiling properly handles constructors,
10597 destructors and C++ constructors (and destructors) of classes which are used
10598 as a type of a global variable.
10600 When the compiled
10601 program exits it saves this data to a file called
10602 @file{@var{auxname}.gcda} for each source file.  The data may be used for
10603 profile-directed optimizations (@option{-fbranch-probabilities}), or for
10604 test coverage analysis (@option{-ftest-coverage}).  Each object file's
10605 @var{auxname} is generated from the name of the output file, if
10606 explicitly specified and it is not the final executable, otherwise it is
10607 the basename of the source file.  In both cases any suffix is removed
10608 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
10609 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
10610 @xref{Cross-profiling}.
10612 @cindex @command{gcov}
10613 @item --coverage
10614 @opindex coverage
10616 This option is used to compile and link code instrumented for coverage
10617 analysis.  The option is a synonym for @option{-fprofile-arcs}
10618 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
10619 linking).  See the documentation for those options for more details.
10621 @itemize
10623 @item
10624 Compile the source files with @option{-fprofile-arcs} plus optimization
10625 and code generation options.  For test coverage analysis, use the
10626 additional @option{-ftest-coverage} option.  You do not need to profile
10627 every source file in a program.
10629 @item
10630 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
10631 (the latter implies the former).
10633 @item
10634 Run the program on a representative workload to generate the arc profile
10635 information.  This may be repeated any number of times.  You can run
10636 concurrent instances of your program, and provided that the file system
10637 supports locking, the data files will be correctly updated.  Also
10638 @code{fork} calls are detected and correctly handled (double counting
10639 will not happen).
10641 @item
10642 For profile-directed optimizations, compile the source files again with
10643 the same optimization and code generation options plus
10644 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
10645 Control Optimization}).
10647 @item
10648 For test coverage analysis, use @command{gcov} to produce human readable
10649 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
10650 @command{gcov} documentation for further information.
10652 @end itemize
10654 With @option{-fprofile-arcs}, for each function of your program GCC
10655 creates a program flow graph, then finds a spanning tree for the graph.
10656 Only arcs that are not on the spanning tree have to be instrumented: the
10657 compiler adds code to count the number of times that these arcs are
10658 executed.  When an arc is the only exit or only entrance to a block, the
10659 instrumentation code can be added to the block; otherwise, a new basic
10660 block must be created to hold the instrumentation code.
10662 @need 2000
10663 @item -ftest-coverage
10664 @opindex ftest-coverage
10665 Produce a notes file that the @command{gcov} code-coverage utility
10666 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
10667 show program coverage.  Each source file's note file is called
10668 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
10669 above for a description of @var{auxname} and instructions on how to
10670 generate test coverage data.  Coverage data matches the source files
10671 more closely if you do not optimize.
10673 @item -fprofile-dir=@var{path}
10674 @opindex fprofile-dir
10676 Set the directory to search for the profile data files in to @var{path}.
10677 This option affects only the profile data generated by
10678 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
10679 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
10680 and its related options.  Both absolute and relative paths can be used.
10681 By default, GCC uses the current directory as @var{path}, thus the
10682 profile data file appears in the same directory as the object file.
10684 @item -fprofile-generate
10685 @itemx -fprofile-generate=@var{path}
10686 @opindex fprofile-generate
10688 Enable options usually used for instrumenting application to produce
10689 profile useful for later recompilation with profile feedback based
10690 optimization.  You must use @option{-fprofile-generate} both when
10691 compiling and when linking your program.
10693 The following options are enabled: @option{-fprofile-arcs}, @option{-fprofile-values}, @option{-fvpt}.
10695 If @var{path} is specified, GCC looks at the @var{path} to find
10696 the profile feedback data files. See @option{-fprofile-dir}.
10698 To optimize the program based on the collected profile information, use
10699 @option{-fprofile-use}.  @xref{Optimize Options}, for more information.
10701 @item -fprofile-update=@var{method}
10702 @opindex fprofile-update
10704 Alter the update method for an application instrumented for profile
10705 feedback based optimization.  The @var{method} argument should be one of
10706 @samp{single}, @samp{atomic} or @samp{prefer-atomic}.
10707 The first one is useful for single-threaded applications,
10708 while the second one prevents profile corruption by emitting thread-safe code.
10710 @strong{Warning:} When an application does not properly join all threads
10711 (or creates an detached thread), a profile file can be still corrupted.
10713 Using @samp{prefer-atomic} would be transformed either to @samp{atomic},
10714 when supported by a target, or to @samp{single} otherwise.  The GCC driver
10715 automatically selects @samp{prefer-atomic} when @option{-pthread}
10716 is present in the command line.
10718 @item -fsanitize=address
10719 @opindex fsanitize=address
10720 Enable AddressSanitizer, a fast memory error detector.
10721 Memory access instructions are instrumented to detect
10722 out-of-bounds and use-after-free bugs.
10723 The option enables @option{-fsanitize-address-use-after-scope}.
10724 See @uref{https://github.com/google/sanitizers/wiki/AddressSanitizer} for
10725 more details.  The run-time behavior can be influenced using the
10726 @env{ASAN_OPTIONS} environment variable.  When set to @code{help=1},
10727 the available options are shown at startup of the instrumented program.  See
10728 @url{https://github.com/google/sanitizers/wiki/AddressSanitizerFlags#run-time-flags}
10729 for a list of supported options.
10730 The option can't be combined with @option{-fsanitize=thread}.
10732 @item -fsanitize=kernel-address
10733 @opindex fsanitize=kernel-address
10734 Enable AddressSanitizer for Linux kernel.
10735 See @uref{https://github.com/google/kasan/wiki} for more details.
10737 @item -fsanitize=thread
10738 @opindex fsanitize=thread
10739 Enable ThreadSanitizer, a fast data race detector.
10740 Memory access instructions are instrumented to detect
10741 data race bugs.  See @uref{https://github.com/google/sanitizers/wiki#threadsanitizer} for more
10742 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
10743 environment variable; see
10744 @url{https://github.com/google/sanitizers/wiki/ThreadSanitizerFlags} for a list of
10745 supported options.
10746 The option can't be combined with @option{-fsanitize=address}
10747 and/or @option{-fsanitize=leak}.
10749 @item -fsanitize=leak
10750 @opindex fsanitize=leak
10751 Enable LeakSanitizer, a memory leak detector.
10752 This option only matters for linking of executables and
10753 the executable is linked against a library that overrides @code{malloc}
10754 and other allocator functions.  See
10755 @uref{https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer} for more
10756 details.  The run-time behavior can be influenced using the
10757 @env{LSAN_OPTIONS} environment variable.
10758 The option can't be combined with @option{-fsanitize=thread}.
10760 @item -fsanitize=undefined
10761 @opindex fsanitize=undefined
10762 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
10763 Various computations are instrumented to detect undefined behavior
10764 at runtime.  Current suboptions are:
10766 @table @gcctabopt
10768 @item -fsanitize=shift
10769 @opindex fsanitize=shift
10770 This option enables checking that the result of a shift operation is
10771 not undefined.  Note that what exactly is considered undefined differs
10772 slightly between C and C++, as well as between ISO C90 and C99, etc.
10773 This option has two suboptions, @option{-fsanitize=shift-base} and
10774 @option{-fsanitize=shift-exponent}.
10776 @item -fsanitize=shift-exponent
10777 @opindex fsanitize=shift-exponent
10778 This option enables checking that the second argument of a shift operation
10779 is not negative and is smaller than the precision of the promoted first
10780 argument.
10782 @item -fsanitize=shift-base
10783 @opindex fsanitize=shift-base
10784 If the second argument of a shift operation is within range, check that the
10785 result of a shift operation is not undefined.  Note that what exactly is
10786 considered undefined differs slightly between C and C++, as well as between
10787 ISO C90 and C99, etc.
10789 @item -fsanitize=integer-divide-by-zero
10790 @opindex fsanitize=integer-divide-by-zero
10791 Detect integer division by zero as well as @code{INT_MIN / -1} division.
10793 @item -fsanitize=unreachable
10794 @opindex fsanitize=unreachable
10795 With this option, the compiler turns the @code{__builtin_unreachable}
10796 call into a diagnostics message call instead.  When reaching the
10797 @code{__builtin_unreachable} call, the behavior is undefined.
10799 @item -fsanitize=vla-bound
10800 @opindex fsanitize=vla-bound
10801 This option instructs the compiler to check that the size of a variable
10802 length array is positive.
10804 @item -fsanitize=null
10805 @opindex fsanitize=null
10806 This option enables pointer checking.  Particularly, the application
10807 built with this option turned on will issue an error message when it
10808 tries to dereference a NULL pointer, or if a reference (possibly an
10809 rvalue reference) is bound to a NULL pointer, or if a method is invoked
10810 on an object pointed by a NULL pointer.
10812 @item -fsanitize=return
10813 @opindex fsanitize=return
10814 This option enables return statement checking.  Programs
10815 built with this option turned on will issue an error message
10816 when the end of a non-void function is reached without actually
10817 returning a value.  This option works in C++ only.
10819 @item -fsanitize=signed-integer-overflow
10820 @opindex fsanitize=signed-integer-overflow
10821 This option enables signed integer overflow checking.  We check that
10822 the result of @code{+}, @code{*}, and both unary and binary @code{-}
10823 does not overflow in the signed arithmetics.  Note, integer promotion
10824 rules must be taken into account.  That is, the following is not an
10825 overflow:
10826 @smallexample
10827 signed char a = SCHAR_MAX;
10828 a++;
10829 @end smallexample
10831 @item -fsanitize=bounds
10832 @opindex fsanitize=bounds
10833 This option enables instrumentation of array bounds.  Various out of bounds
10834 accesses are detected.  Flexible array members, flexible array member-like
10835 arrays, and initializers of variables with static storage are not instrumented.
10837 @item -fsanitize=bounds-strict
10838 @opindex fsanitize=bounds-strict
10839 This option enables strict instrumentation of array bounds.  Most out of bounds
10840 accesses are detected, including flexible array members and flexible array
10841 member-like arrays.  Initializers of variables with static storage are not
10842 instrumented.
10844 @item -fsanitize=alignment
10845 @opindex fsanitize=alignment
10847 This option enables checking of alignment of pointers when they are
10848 dereferenced, or when a reference is bound to insufficiently aligned target,
10849 or when a method or constructor is invoked on insufficiently aligned object.
10851 @item -fsanitize=object-size
10852 @opindex fsanitize=object-size
10853 This option enables instrumentation of memory references using the
10854 @code{__builtin_object_size} function.  Various out of bounds pointer
10855 accesses are detected.
10857 @item -fsanitize=float-divide-by-zero
10858 @opindex fsanitize=float-divide-by-zero
10859 Detect floating-point division by zero.  Unlike other similar options,
10860 @option{-fsanitize=float-divide-by-zero} is not enabled by
10861 @option{-fsanitize=undefined}, since floating-point division by zero can
10862 be a legitimate way of obtaining infinities and NaNs.
10864 @item -fsanitize=float-cast-overflow
10865 @opindex fsanitize=float-cast-overflow
10866 This option enables floating-point type to integer conversion checking.
10867 We check that the result of the conversion does not overflow.
10868 Unlike other similar options, @option{-fsanitize=float-cast-overflow} is
10869 not enabled by @option{-fsanitize=undefined}.
10870 This option does not work well with @code{FE_INVALID} exceptions enabled.
10872 @item -fsanitize=nonnull-attribute
10873 @opindex fsanitize=nonnull-attribute
10875 This option enables instrumentation of calls, checking whether null values
10876 are not passed to arguments marked as requiring a non-null value by the
10877 @code{nonnull} function attribute.
10879 @item -fsanitize=returns-nonnull-attribute
10880 @opindex fsanitize=returns-nonnull-attribute
10882 This option enables instrumentation of return statements in functions
10883 marked with @code{returns_nonnull} function attribute, to detect returning
10884 of null values from such functions.
10886 @item -fsanitize=bool
10887 @opindex fsanitize=bool
10889 This option enables instrumentation of loads from bool.  If a value other
10890 than 0/1 is loaded, a run-time error is issued.
10892 @item -fsanitize=enum
10893 @opindex fsanitize=enum
10895 This option enables instrumentation of loads from an enum type.  If
10896 a value outside the range of values for the enum type is loaded,
10897 a run-time error is issued.
10899 @item -fsanitize=vptr
10900 @opindex fsanitize=vptr
10902 This option enables instrumentation of C++ member function calls, member
10903 accesses and some conversions between pointers to base and derived classes,
10904 to verify the referenced object has the correct dynamic type.
10906 @end table
10908 While @option{-ftrapv} causes traps for signed overflows to be emitted,
10909 @option{-fsanitize=undefined} gives a diagnostic message.
10910 This currently works only for the C family of languages.
10912 @item -fno-sanitize=all
10913 @opindex fno-sanitize=all
10915 This option disables all previously enabled sanitizers.
10916 @option{-fsanitize=all} is not allowed, as some sanitizers cannot be used
10917 together.
10919 @item -fasan-shadow-offset=@var{number}
10920 @opindex fasan-shadow-offset
10921 This option forces GCC to use custom shadow offset in AddressSanitizer checks.
10922 It is useful for experimenting with different shadow memory layouts in
10923 Kernel AddressSanitizer.
10925 @item -fsanitize-sections=@var{s1},@var{s2},...
10926 @opindex fsanitize-sections
10927 Sanitize global variables in selected user-defined sections.  @var{si} may
10928 contain wildcards.
10930 @item -fsanitize-recover@r{[}=@var{opts}@r{]}
10931 @opindex fsanitize-recover
10932 @opindex fno-sanitize-recover
10933 @option{-fsanitize-recover=} controls error recovery mode for sanitizers
10934 mentioned in comma-separated list of @var{opts}.  Enabling this option
10935 for a sanitizer component causes it to attempt to continue
10936 running the program as if no error happened.  This means multiple
10937 runtime errors can be reported in a single program run, and the exit
10938 code of the program may indicate success even when errors
10939 have been reported.  The @option{-fno-sanitize-recover=} option
10940 can be used to alter
10941 this behavior: only the first detected error is reported
10942 and program then exits with a non-zero exit code.
10944 Currently this feature only works for @option{-fsanitize=undefined} (and its suboptions
10945 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return}),
10946 @option{-fsanitize=float-cast-overflow}, @option{-fsanitize=float-divide-by-zero},
10947 @option{-fsanitize=bounds-strict},
10948 @option{-fsanitize=kernel-address} and @option{-fsanitize=address}.
10949 For these sanitizers error recovery is turned on by default,
10950 except @option{-fsanitize=address}, for which this feature is experimental.
10951 @option{-fsanitize-recover=all} and @option{-fno-sanitize-recover=all} is also
10952 accepted, the former enables recovery for all sanitizers that support it,
10953 the latter disables recovery for all sanitizers that support it.
10955 Even if a recovery mode is turned on the compiler side, it needs to be also
10956 enabled on the runtime library side, otherwise the failures are still fatal.
10957 The runtime library defaults to @code{halt_on_error=0} for
10958 ThreadSanitizer and UndefinedBehaviorSanitizer, while default value for
10959 AddressSanitizer is @code{halt_on_error=1}. This can be overridden through
10960 setting the @code{halt_on_error} flag in the corresponding environment variable.
10962 Syntax without an explicit @var{opts} parameter is deprecated.  It is
10963 equivalent to specifying an @var{opts} list of:
10965 @smallexample
10966 undefined,float-cast-overflow,float-divide-by-zero,bounds-strict
10967 @end smallexample
10969 @item -fsanitize-address-use-after-scope
10970 @opindex fsanitize-address-use-after-scope
10971 Enable sanitization of local variables to detect use-after-scope bugs.
10972 The option sets @option{-fstack-reuse} to @samp{none}.
10974 @item -fsanitize-undefined-trap-on-error
10975 @opindex fsanitize-undefined-trap-on-error
10976 The @option{-fsanitize-undefined-trap-on-error} option instructs the compiler to
10977 report undefined behavior using @code{__builtin_trap} rather than
10978 a @code{libubsan} library routine.  The advantage of this is that the
10979 @code{libubsan} library is not needed and is not linked in, so this
10980 is usable even in freestanding environments.
10982 @item -fsanitize-coverage=trace-pc
10983 @opindex fsanitize-coverage=trace-pc
10984 Enable coverage-guided fuzzing code instrumentation.
10985 Inserts a call to @code{__sanitizer_cov_trace_pc} into every basic block.
10987 @item -fbounds-check
10988 @opindex fbounds-check
10989 For front ends that support it, generate additional code to check that
10990 indices used to access arrays are within the declared range.  This is
10991 currently only supported by the Fortran front end, where this option
10992 defaults to false.
10994 @item -fcheck-pointer-bounds
10995 @opindex fcheck-pointer-bounds
10996 @opindex fno-check-pointer-bounds
10997 @cindex Pointer Bounds Checker options
10998 Enable Pointer Bounds Checker instrumentation.  Each memory reference
10999 is instrumented with checks of the pointer used for memory access against
11000 bounds associated with that pointer.  
11002 Currently there
11003 is only an implementation for Intel MPX available, thus x86 GNU/Linux target
11004 and @option{-mmpx} are required to enable this feature.  
11005 MPX-based instrumentation requires
11006 a runtime library to enable MPX in hardware and handle bounds
11007 violation signals.  By default when @option{-fcheck-pointer-bounds}
11008 and @option{-mmpx} options are used to link a program, the GCC driver
11009 links against the @file{libmpx} and @file{libmpxwrappers} libraries.
11010 Bounds checking on calls to dynamic libraries requires a linker
11011 with @option{-z bndplt} support; if GCC was configured with a linker
11012 without support for this option (including the Gold linker and older
11013 versions of ld), a warning is given if you link with @option{-mmpx}
11014 without also specifying @option{-static}, since the overall effectiveness
11015 of the bounds checking protection is reduced.
11016 See also @option{-static-libmpxwrappers}.
11018 MPX-based instrumentation
11019 may be used for debugging and also may be included in production code
11020 to increase program security.  Depending on usage, you may
11021 have different requirements for the runtime library.  The current version
11022 of the MPX runtime library is more oriented for use as a debugging
11023 tool.  MPX runtime library usage implies @option{-lpthread}.  See
11024 also @option{-static-libmpx}.  The runtime library  behavior can be
11025 influenced using various @env{CHKP_RT_*} environment variables.  See
11026 @uref{https://gcc.gnu.org/wiki/Intel%20MPX%20support%20in%20the%20GCC%20compiler}
11027 for more details.
11029 Generated instrumentation may be controlled by various
11030 @option{-fchkp-*} options and by the @code{bnd_variable_size}
11031 structure field attribute (@pxref{Type Attributes}) and
11032 @code{bnd_legacy}, and @code{bnd_instrument} function attributes
11033 (@pxref{Function Attributes}).  GCC also provides a number of built-in
11034 functions for controlling the Pointer Bounds Checker.  @xref{Pointer
11035 Bounds Checker builtins}, for more information.
11037 @item -fchkp-check-incomplete-type
11038 @opindex fchkp-check-incomplete-type
11039 @opindex fno-chkp-check-incomplete-type
11040 Generate pointer bounds checks for variables with incomplete type.
11041 Enabled by default.
11043 @item -fchkp-narrow-bounds
11044 @opindex fchkp-narrow-bounds
11045 @opindex fno-chkp-narrow-bounds
11046 Controls bounds used by Pointer Bounds Checker for pointers to object
11047 fields.  If narrowing is enabled then field bounds are used.  Otherwise
11048 object bounds are used.  See also @option{-fchkp-narrow-to-innermost-array}
11049 and @option{-fchkp-first-field-has-own-bounds}.  Enabled by default.
11051 @item -fchkp-first-field-has-own-bounds
11052 @opindex fchkp-first-field-has-own-bounds
11053 @opindex fno-chkp-first-field-has-own-bounds
11054 Forces Pointer Bounds Checker to use narrowed bounds for the address of the
11055 first field in the structure.  By default a pointer to the first field has
11056 the same bounds as a pointer to the whole structure.
11058 @item -fchkp-flexible-struct-trailing-arrays
11059 @opindex fchkp-flexible-struct-trailing-arrays
11060 @opindex fno-chkp-flexible-struct-trailing-arrays
11061 Forces Pointer Bounds Checker to treat all trailing arrays in structures as
11062 possibly flexible.  By default only array fields with zero length or that are
11063 marked with attribute bnd_variable_size are treated as flexible.
11065 @item -fchkp-narrow-to-innermost-array
11066 @opindex fchkp-narrow-to-innermost-array
11067 @opindex fno-chkp-narrow-to-innermost-array
11068 Forces Pointer Bounds Checker to use bounds of the innermost arrays in
11069 case of nested static array access.  By default this option is disabled and
11070 bounds of the outermost array are used.
11072 @item -fchkp-optimize
11073 @opindex fchkp-optimize
11074 @opindex fno-chkp-optimize
11075 Enables Pointer Bounds Checker optimizations.  Enabled by default at
11076 optimization levels @option{-O}, @option{-O2}, @option{-O3}.
11078 @item -fchkp-use-fast-string-functions
11079 @opindex fchkp-use-fast-string-functions
11080 @opindex fno-chkp-use-fast-string-functions
11081 Enables use of @code{*_nobnd} versions of string functions (not copying bounds)
11082 by Pointer Bounds Checker.  Disabled by default.
11084 @item -fchkp-use-nochk-string-functions
11085 @opindex fchkp-use-nochk-string-functions
11086 @opindex fno-chkp-use-nochk-string-functions
11087 Enables use of @code{*_nochk} versions of string functions (not checking bounds)
11088 by Pointer Bounds Checker.  Disabled by default.
11090 @item -fchkp-use-static-bounds
11091 @opindex fchkp-use-static-bounds
11092 @opindex fno-chkp-use-static-bounds
11093 Allow Pointer Bounds Checker to generate static bounds holding
11094 bounds of static variables.  Enabled by default.
11096 @item -fchkp-use-static-const-bounds
11097 @opindex fchkp-use-static-const-bounds
11098 @opindex fno-chkp-use-static-const-bounds
11099 Use statically-initialized bounds for constant bounds instead of
11100 generating them each time they are required.  By default enabled when
11101 @option{-fchkp-use-static-bounds} is enabled.
11103 @item -fchkp-treat-zero-dynamic-size-as-infinite
11104 @opindex fchkp-treat-zero-dynamic-size-as-infinite
11105 @opindex fno-chkp-treat-zero-dynamic-size-as-infinite
11106 With this option, objects with incomplete type whose
11107 dynamically-obtained size is zero are treated as having infinite size
11108 instead by Pointer Bounds
11109 Checker.  This option may be helpful if a program is linked with a library
11110 missing size information for some symbols.  Disabled by default.
11112 @item -fchkp-check-read
11113 @opindex fchkp-check-read
11114 @opindex fno-chkp-check-read
11115 Instructs Pointer Bounds Checker to generate checks for all read
11116 accesses to memory.  Enabled by default.
11118 @item -fchkp-check-write
11119 @opindex fchkp-check-write
11120 @opindex fno-chkp-check-write
11121 Instructs Pointer Bounds Checker to generate checks for all write
11122 accesses to memory.  Enabled by default.
11124 @item -fchkp-store-bounds
11125 @opindex fchkp-store-bounds
11126 @opindex fno-chkp-store-bounds
11127 Instructs Pointer Bounds Checker to generate bounds stores for
11128 pointer writes.  Enabled by default.
11130 @item -fchkp-instrument-calls
11131 @opindex fchkp-instrument-calls
11132 @opindex fno-chkp-instrument-calls
11133 Instructs Pointer Bounds Checker to pass pointer bounds to calls.
11134 Enabled by default.
11136 @item -fchkp-instrument-marked-only
11137 @opindex fchkp-instrument-marked-only
11138 @opindex fno-chkp-instrument-marked-only
11139 Instructs Pointer Bounds Checker to instrument only functions
11140 marked with the @code{bnd_instrument} attribute
11141 (@pxref{Function Attributes}).  Disabled by default.
11143 @item -fchkp-use-wrappers
11144 @opindex fchkp-use-wrappers
11145 @opindex fno-chkp-use-wrappers
11146 Allows Pointer Bounds Checker to replace calls to built-in functions
11147 with calls to wrapper functions.  When @option{-fchkp-use-wrappers}
11148 is used to link a program, the GCC driver automatically links
11149 against @file{libmpxwrappers}.  See also @option{-static-libmpxwrappers}.
11150 Enabled by default.
11152 @item -fstack-protector
11153 @opindex fstack-protector
11154 Emit extra code to check for buffer overflows, such as stack smashing
11155 attacks.  This is done by adding a guard variable to functions with
11156 vulnerable objects.  This includes functions that call @code{alloca}, and
11157 functions with buffers larger than 8 bytes.  The guards are initialized
11158 when a function is entered and then checked when the function exits.
11159 If a guard check fails, an error message is printed and the program exits.
11161 @item -fstack-protector-all
11162 @opindex fstack-protector-all
11163 Like @option{-fstack-protector} except that all functions are protected.
11165 @item -fstack-protector-strong
11166 @opindex fstack-protector-strong
11167 Like @option{-fstack-protector} but includes additional functions to
11168 be protected --- those that have local array definitions, or have
11169 references to local frame addresses.
11171 @item -fstack-protector-explicit
11172 @opindex fstack-protector-explicit
11173 Like @option{-fstack-protector} but only protects those functions which
11174 have the @code{stack_protect} attribute.
11176 @item -fstack-check
11177 @opindex fstack-check
11178 Generate code to verify that you do not go beyond the boundary of the
11179 stack.  You should specify this flag if you are running in an
11180 environment with multiple threads, but you only rarely need to specify it in
11181 a single-threaded environment since stack overflow is automatically
11182 detected on nearly all systems if there is only one stack.
11184 Note that this switch does not actually cause checking to be done; the
11185 operating system or the language runtime must do that.  The switch causes
11186 generation of code to ensure that they see the stack being extended.
11188 You can additionally specify a string parameter: @samp{no} means no
11189 checking, @samp{generic} means force the use of old-style checking,
11190 @samp{specific} means use the best checking method and is equivalent
11191 to bare @option{-fstack-check}.
11193 Old-style checking is a generic mechanism that requires no specific
11194 target support in the compiler but comes with the following drawbacks:
11196 @enumerate
11197 @item
11198 Modified allocation strategy for large objects: they are always
11199 allocated dynamically if their size exceeds a fixed threshold.
11201 @item
11202 Fixed limit on the size of the static frame of functions: when it is
11203 topped by a particular function, stack checking is not reliable and
11204 a warning is issued by the compiler.
11206 @item
11207 Inefficiency: because of both the modified allocation strategy and the
11208 generic implementation, code performance is hampered.
11209 @end enumerate
11211 Note that old-style stack checking is also the fallback method for
11212 @samp{specific} if no target support has been added in the compiler.
11214 @item -fstack-limit-register=@var{reg}
11215 @itemx -fstack-limit-symbol=@var{sym}
11216 @itemx -fno-stack-limit
11217 @opindex fstack-limit-register
11218 @opindex fstack-limit-symbol
11219 @opindex fno-stack-limit
11220 Generate code to ensure that the stack does not grow beyond a certain value,
11221 either the value of a register or the address of a symbol.  If a larger
11222 stack is required, a signal is raised at run time.  For most targets,
11223 the signal is raised before the stack overruns the boundary, so
11224 it is possible to catch the signal without taking special precautions.
11226 For instance, if the stack starts at absolute address @samp{0x80000000}
11227 and grows downwards, you can use the flags
11228 @option{-fstack-limit-symbol=__stack_limit} and
11229 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11230 of 128KB@.  Note that this may only work with the GNU linker.
11232 You can locally override stack limit checking by using the
11233 @code{no_stack_limit} function attribute (@pxref{Function Attributes}).
11235 @item -fsplit-stack
11236 @opindex fsplit-stack
11237 Generate code to automatically split the stack before it overflows.
11238 The resulting program has a discontiguous stack which can only
11239 overflow if the program is unable to allocate any more memory.  This
11240 is most useful when running threaded programs, as it is no longer
11241 necessary to calculate a good stack size to use for each thread.  This
11242 is currently only implemented for the x86 targets running
11243 GNU/Linux.
11245 When code compiled with @option{-fsplit-stack} calls code compiled
11246 without @option{-fsplit-stack}, there may not be much stack space
11247 available for the latter code to run.  If compiling all code,
11248 including library code, with @option{-fsplit-stack} is not an option,
11249 then the linker can fix up these calls so that the code compiled
11250 without @option{-fsplit-stack} always has a large stack.  Support for
11251 this is implemented in the gold linker in GNU binutils release 2.21
11252 and later.
11254 @item -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]}
11255 @opindex fvtable-verify
11256 This option is only available when compiling C++ code.
11257 It turns on (or off, if using @option{-fvtable-verify=none}) the security
11258 feature that verifies at run time, for every virtual call, that
11259 the vtable pointer through which the call is made is valid for the type of
11260 the object, and has not been corrupted or overwritten.  If an invalid vtable
11261 pointer is detected at run time, an error is reported and execution of the
11262 program is immediately halted.
11264 This option causes run-time data structures to be built at program startup,
11265 which are used for verifying the vtable pointers.  
11266 The options @samp{std} and @samp{preinit}
11267 control the timing of when these data structures are built.  In both cases the
11268 data structures are built before execution reaches @code{main}.  Using
11269 @option{-fvtable-verify=std} causes the data structures to be built after
11270 shared libraries have been loaded and initialized.
11271 @option{-fvtable-verify=preinit} causes them to be built before shared
11272 libraries have been loaded and initialized.
11274 If this option appears multiple times in the command line with different
11275 values specified, @samp{none} takes highest priority over both @samp{std} and
11276 @samp{preinit}; @samp{preinit} takes priority over @samp{std}.
11278 @item -fvtv-debug
11279 @opindex fvtv-debug
11280 When used in conjunction with @option{-fvtable-verify=std} or 
11281 @option{-fvtable-verify=preinit}, causes debug versions of the 
11282 runtime functions for the vtable verification feature to be called.  
11283 This flag also causes the compiler to log information about which 
11284 vtable pointers it finds for each class.
11285 This information is written to a file named @file{vtv_set_ptr_data.log} 
11286 in the directory named by the environment variable @env{VTV_LOGS_DIR} 
11287 if that is defined or the current working directory otherwise.
11289 Note:  This feature @emph{appends} data to the log file. If you want a fresh log
11290 file, be sure to delete any existing one.
11292 @item -fvtv-counts
11293 @opindex fvtv-counts
11294 This is a debugging flag.  When used in conjunction with
11295 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
11296 causes the compiler to keep track of the total number of virtual calls
11297 it encounters and the number of verifications it inserts.  It also
11298 counts the number of calls to certain run-time library functions
11299 that it inserts and logs this information for each compilation unit.
11300 The compiler writes this information to a file named
11301 @file{vtv_count_data.log} in the directory named by the environment
11302 variable @env{VTV_LOGS_DIR} if that is defined or the current working
11303 directory otherwise.  It also counts the size of the vtable pointer sets
11304 for each class, and writes this information to @file{vtv_class_set_sizes.log}
11305 in the same directory.
11307 Note:  This feature @emph{appends} data to the log files.  To get fresh log
11308 files, be sure to delete any existing ones.
11310 @item -finstrument-functions
11311 @opindex finstrument-functions
11312 Generate instrumentation calls for entry and exit to functions.  Just
11313 after function entry and just before function exit, the following
11314 profiling functions are called with the address of the current
11315 function and its call site.  (On some platforms,
11316 @code{__builtin_return_address} does not work beyond the current
11317 function, so the call site information may not be available to the
11318 profiling functions otherwise.)
11320 @smallexample
11321 void __cyg_profile_func_enter (void *this_fn,
11322                                void *call_site);
11323 void __cyg_profile_func_exit  (void *this_fn,
11324                                void *call_site);
11325 @end smallexample
11327 The first argument is the address of the start of the current function,
11328 which may be looked up exactly in the symbol table.
11330 This instrumentation is also done for functions expanded inline in other
11331 functions.  The profiling calls indicate where, conceptually, the
11332 inline function is entered and exited.  This means that addressable
11333 versions of such functions must be available.  If all your uses of a
11334 function are expanded inline, this may mean an additional expansion of
11335 code size.  If you use @code{extern inline} in your C code, an
11336 addressable version of such functions must be provided.  (This is
11337 normally the case anyway, but if you get lucky and the optimizer always
11338 expands the functions inline, you might have gotten away without
11339 providing static copies.)
11341 A function may be given the attribute @code{no_instrument_function}, in
11342 which case this instrumentation is not done.  This can be used, for
11343 example, for the profiling functions listed above, high-priority
11344 interrupt routines, and any functions from which the profiling functions
11345 cannot safely be called (perhaps signal handlers, if the profiling
11346 routines generate output or allocate memory).
11348 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
11349 @opindex finstrument-functions-exclude-file-list
11351 Set the list of functions that are excluded from instrumentation (see
11352 the description of @option{-finstrument-functions}).  If the file that
11353 contains a function definition matches with one of @var{file}, then
11354 that function is not instrumented.  The match is done on substrings:
11355 if the @var{file} parameter is a substring of the file name, it is
11356 considered to be a match.
11358 For example:
11360 @smallexample
11361 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
11362 @end smallexample
11364 @noindent
11365 excludes any inline function defined in files whose pathnames
11366 contain @file{/bits/stl} or @file{include/sys}.
11368 If, for some reason, you want to include letter @samp{,} in one of
11369 @var{sym}, write @samp{\,}. For example,
11370 @option{-finstrument-functions-exclude-file-list='\,\,tmp'}
11371 (note the single quote surrounding the option).
11373 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
11374 @opindex finstrument-functions-exclude-function-list
11376 This is similar to @option{-finstrument-functions-exclude-file-list},
11377 but this option sets the list of function names to be excluded from
11378 instrumentation.  The function name to be matched is its user-visible
11379 name, such as @code{vector<int> blah(const vector<int> &)}, not the
11380 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
11381 match is done on substrings: if the @var{sym} parameter is a substring
11382 of the function name, it is considered to be a match.  For C99 and C++
11383 extended identifiers, the function name must be given in UTF-8, not
11384 using universal character names.
11386 @end table
11389 @node Preprocessor Options
11390 @section Options Controlling the Preprocessor
11391 @cindex preprocessor options
11392 @cindex options, preprocessor
11394 These options control the C preprocessor, which is run on each C source
11395 file before actual compilation.
11397 If you use the @option{-E} option, nothing is done except preprocessing.
11398 Some of these options make sense only together with @option{-E} because
11399 they cause the preprocessor output to be unsuitable for actual
11400 compilation.
11402 In addition to the options listed here, there are a number of options 
11403 to control search paths for include files documented in 
11404 @ref{Directory Options}.  
11405 Options to control preprocessor diagnostics are listed in 
11406 @ref{Warning Options}.
11408 @table @gcctabopt
11409 @include cppopts.texi
11411 @item -Wp,@var{option}
11412 @opindex Wp
11413 You can use @option{-Wp,@var{option}} to bypass the compiler driver
11414 and pass @var{option} directly through to the preprocessor.  If
11415 @var{option} contains commas, it is split into multiple options at the
11416 commas.  However, many options are modified, translated or interpreted
11417 by the compiler driver before being passed to the preprocessor, and
11418 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
11419 interface is undocumented and subject to change, so whenever possible
11420 you should avoid using @option{-Wp} and let the driver handle the
11421 options instead.
11423 @item -Xpreprocessor @var{option}
11424 @opindex Xpreprocessor
11425 Pass @var{option} as an option to the preprocessor.  You can use this to
11426 supply system-specific preprocessor options that GCC does not 
11427 recognize.
11429 If you want to pass an option that takes an argument, you must use
11430 @option{-Xpreprocessor} twice, once for the option and once for the argument.
11432 @item -no-integrated-cpp
11433 @opindex no-integrated-cpp
11434 Perform preprocessing as a separate pass before compilation.
11435 By default, GCC performs preprocessing as an integrated part of
11436 input tokenization and parsing.
11437 If this option is provided, the appropriate language front end
11438 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
11439 and Objective-C, respectively) is instead invoked twice,
11440 once for preprocessing only and once for actual compilation
11441 of the preprocessed input.
11442 This option may be useful in conjunction with the @option{-B} or
11443 @option{-wrapper} options to specify an alternate preprocessor or
11444 perform additional processing of the program source between
11445 normal preprocessing and compilation.
11447 @end table
11449 @node Assembler Options
11450 @section Passing Options to the Assembler
11452 @c prevent bad page break with this line
11453 You can pass options to the assembler.
11455 @table @gcctabopt
11456 @item -Wa,@var{option}
11457 @opindex Wa
11458 Pass @var{option} as an option to the assembler.  If @var{option}
11459 contains commas, it is split into multiple options at the commas.
11461 @item -Xassembler @var{option}
11462 @opindex Xassembler
11463 Pass @var{option} as an option to the assembler.  You can use this to
11464 supply system-specific assembler options that GCC does not
11465 recognize.
11467 If you want to pass an option that takes an argument, you must use
11468 @option{-Xassembler} twice, once for the option and once for the argument.
11470 @end table
11472 @node Link Options
11473 @section Options for Linking
11474 @cindex link options
11475 @cindex options, linking
11477 These options come into play when the compiler links object files into
11478 an executable output file.  They are meaningless if the compiler is
11479 not doing a link step.
11481 @table @gcctabopt
11482 @cindex file names
11483 @item @var{object-file-name}
11484 A file name that does not end in a special recognized suffix is
11485 considered to name an object file or library.  (Object files are
11486 distinguished from libraries by the linker according to the file
11487 contents.)  If linking is done, these object files are used as input
11488 to the linker.
11490 @item -c
11491 @itemx -S
11492 @itemx -E
11493 @opindex c
11494 @opindex S
11495 @opindex E
11496 If any of these options is used, then the linker is not run, and
11497 object file names should not be used as arguments.  @xref{Overall
11498 Options}.
11500 @item -fuse-ld=bfd
11501 @opindex fuse-ld=bfd
11502 Use the @command{bfd} linker instead of the default linker.
11504 @item -fuse-ld=gold
11505 @opindex fuse-ld=gold
11506 Use the @command{gold} linker instead of the default linker.
11508 @cindex Libraries
11509 @item -l@var{library}
11510 @itemx -l @var{library}
11511 @opindex l
11512 Search the library named @var{library} when linking.  (The second
11513 alternative with the library as a separate argument is only for
11514 POSIX compliance and is not recommended.)
11516 It makes a difference where in the command you write this option; the
11517 linker searches and processes libraries and object files in the order they
11518 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
11519 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
11520 to functions in @samp{z}, those functions may not be loaded.
11522 The linker searches a standard list of directories for the library,
11523 which is actually a file named @file{lib@var{library}.a}.  The linker
11524 then uses this file as if it had been specified precisely by name.
11526 The directories searched include several standard system directories
11527 plus any that you specify with @option{-L}.
11529 Normally the files found this way are library files---archive files
11530 whose members are object files.  The linker handles an archive file by
11531 scanning through it for members which define symbols that have so far
11532 been referenced but not defined.  But if the file that is found is an
11533 ordinary object file, it is linked in the usual fashion.  The only
11534 difference between using an @option{-l} option and specifying a file name
11535 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
11536 and searches several directories.
11538 @item -lobjc
11539 @opindex lobjc
11540 You need this special case of the @option{-l} option in order to
11541 link an Objective-C or Objective-C++ program.
11543 @item -nostartfiles
11544 @opindex nostartfiles
11545 Do not use the standard system startup files when linking.
11546 The standard system libraries are used normally, unless @option{-nostdlib}
11547 or @option{-nodefaultlibs} is used.
11549 @item -nodefaultlibs
11550 @opindex nodefaultlibs
11551 Do not use the standard system libraries when linking.
11552 Only the libraries you specify are passed to the linker, and options
11553 specifying linkage of the system libraries, such as @option{-static-libgcc}
11554 or @option{-shared-libgcc}, are ignored.  
11555 The standard startup files are used normally, unless @option{-nostartfiles}
11556 is used.  
11558 The compiler may generate calls to @code{memcmp},
11559 @code{memset}, @code{memcpy} and @code{memmove}.
11560 These entries are usually resolved by entries in
11561 libc.  These entry points should be supplied through some other
11562 mechanism when this option is specified.
11564 @item -nostdlib
11565 @opindex nostdlib
11566 Do not use the standard system startup files or libraries when linking.
11567 No startup files and only the libraries you specify are passed to
11568 the linker, and options specifying linkage of the system libraries, such as
11569 @option{-static-libgcc} or @option{-shared-libgcc}, are ignored.
11571 The compiler may generate calls to @code{memcmp}, @code{memset},
11572 @code{memcpy} and @code{memmove}.
11573 These entries are usually resolved by entries in
11574 libc.  These entry points should be supplied through some other
11575 mechanism when this option is specified.
11577 @cindex @option{-lgcc}, use with @option{-nostdlib}
11578 @cindex @option{-nostdlib} and unresolved references
11579 @cindex unresolved references and @option{-nostdlib}
11580 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
11581 @cindex @option{-nodefaultlibs} and unresolved references
11582 @cindex unresolved references and @option{-nodefaultlibs}
11583 One of the standard libraries bypassed by @option{-nostdlib} and
11584 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
11585 which GCC uses to overcome shortcomings of particular machines, or special
11586 needs for some languages.
11587 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
11588 Collection (GCC) Internals},
11589 for more discussion of @file{libgcc.a}.)
11590 In most cases, you need @file{libgcc.a} even when you want to avoid
11591 other standard libraries.  In other words, when you specify @option{-nostdlib}
11592 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
11593 This ensures that you have no unresolved references to internal GCC
11594 library subroutines.
11595 (An example of such an internal subroutine is @code{__main}, used to ensure C++
11596 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
11597 GNU Compiler Collection (GCC) Internals}.)
11599 @item -pie
11600 @opindex pie
11601 Produce a position independent executable on targets that support it.
11602 For predictable results, you must also specify the same set of options
11603 used for compilation (@option{-fpie}, @option{-fPIE},
11604 or model suboptions) when you specify this linker option.
11606 @item -no-pie
11607 @opindex no-pie
11608 Don't produce a position independent executable.
11610 @item -pthread
11611 @opindex pthread
11612 Link with the POSIX threads library.  This option is supported on 
11613 GNU/Linux targets, most other Unix derivatives, and also on 
11614 x86 Cygwin and MinGW targets.  On some targets this option also sets 
11615 flags for the preprocessor, so it should be used consistently for both
11616 compilation and linking.
11618 @item -rdynamic
11619 @opindex rdynamic
11620 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
11621 that support it. This instructs the linker to add all symbols, not
11622 only used ones, to the dynamic symbol table. This option is needed
11623 for some uses of @code{dlopen} or to allow obtaining backtraces
11624 from within a program.
11626 @item -s
11627 @opindex s
11628 Remove all symbol table and relocation information from the executable.
11630 @item -static
11631 @opindex static
11632 On systems that support dynamic linking, this prevents linking with the shared
11633 libraries.  On other systems, this option has no effect.
11635 @item -shared
11636 @opindex shared
11637 Produce a shared object which can then be linked with other objects to
11638 form an executable.  Not all systems support this option.  For predictable
11639 results, you must also specify the same set of options used for compilation
11640 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
11641 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
11642 needs to build supplementary stub code for constructors to work.  On
11643 multi-libbed systems, @samp{gcc -shared} must select the correct support
11644 libraries to link against.  Failing to supply the correct flags may lead
11645 to subtle defects.  Supplying them in cases where they are not necessary
11646 is innocuous.}
11648 @item -shared-libgcc
11649 @itemx -static-libgcc
11650 @opindex shared-libgcc
11651 @opindex static-libgcc
11652 On systems that provide @file{libgcc} as a shared library, these options
11653 force the use of either the shared or static version, respectively.
11654 If no shared version of @file{libgcc} was built when the compiler was
11655 configured, these options have no effect.
11657 There are several situations in which an application should use the
11658 shared @file{libgcc} instead of the static version.  The most common
11659 of these is when the application wishes to throw and catch exceptions
11660 across different shared libraries.  In that case, each of the libraries
11661 as well as the application itself should use the shared @file{libgcc}.
11663 Therefore, the G++ and driver automatically adds @option{-shared-libgcc}
11664  whenever you build a shared library or a main executable, because C++
11665  programs typically use exceptions, so this is the right thing to do.
11667 If, instead, you use the GCC driver to create shared libraries, you may
11668 find that they are not always linked with the shared @file{libgcc}.
11669 If GCC finds, at its configuration time, that you have a non-GNU linker
11670 or a GNU linker that does not support option @option{--eh-frame-hdr},
11671 it links the shared version of @file{libgcc} into shared libraries
11672 by default.  Otherwise, it takes advantage of the linker and optimizes
11673 away the linking with the shared version of @file{libgcc}, linking with
11674 the static version of libgcc by default.  This allows exceptions to
11675 propagate through such shared libraries, without incurring relocation
11676 costs at library load time.
11678 However, if a library or main executable is supposed to throw or catch
11679 exceptions, you must link it using the G++ driver, as appropriate
11680 for the languages used in the program, or using the option
11681 @option{-shared-libgcc}, such that it is linked with the shared
11682 @file{libgcc}.
11684 @item -static-libasan
11685 @opindex static-libasan
11686 When the @option{-fsanitize=address} option is used to link a program,
11687 the GCC driver automatically links against @option{libasan}.  If
11688 @file{libasan} is available as a shared library, and the @option{-static}
11689 option is not used, then this links against the shared version of
11690 @file{libasan}.  The @option{-static-libasan} option directs the GCC
11691 driver to link @file{libasan} statically, without necessarily linking
11692 other libraries statically.
11694 @item -static-libtsan
11695 @opindex static-libtsan
11696 When the @option{-fsanitize=thread} option is used to link a program,
11697 the GCC driver automatically links against @option{libtsan}.  If
11698 @file{libtsan} is available as a shared library, and the @option{-static}
11699 option is not used, then this links against the shared version of
11700 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
11701 driver to link @file{libtsan} statically, without necessarily linking
11702 other libraries statically.
11704 @item -static-liblsan
11705 @opindex static-liblsan
11706 When the @option{-fsanitize=leak} option is used to link a program,
11707 the GCC driver automatically links against @option{liblsan}.  If
11708 @file{liblsan} is available as a shared library, and the @option{-static}
11709 option is not used, then this links against the shared version of
11710 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
11711 driver to link @file{liblsan} statically, without necessarily linking
11712 other libraries statically.
11714 @item -static-libubsan
11715 @opindex static-libubsan
11716 When the @option{-fsanitize=undefined} option is used to link a program,
11717 the GCC driver automatically links against @option{libubsan}.  If
11718 @file{libubsan} is available as a shared library, and the @option{-static}
11719 option is not used, then this links against the shared version of
11720 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
11721 driver to link @file{libubsan} statically, without necessarily linking
11722 other libraries statically.
11724 @item -static-libmpx
11725 @opindex static-libmpx
11726 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are
11727 used to link a program, the GCC driver automatically links against
11728 @file{libmpx}.  If @file{libmpx} is available as a shared library,
11729 and the @option{-static} option is not used, then this links against
11730 the shared version of @file{libmpx}.  The @option{-static-libmpx}
11731 option directs the GCC driver to link @file{libmpx} statically,
11732 without necessarily linking other libraries statically.
11734 @item -static-libmpxwrappers
11735 @opindex static-libmpxwrappers
11736 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are used
11737 to link a program without also using @option{-fno-chkp-use-wrappers}, the
11738 GCC driver automatically links against @file{libmpxwrappers}.  If
11739 @file{libmpxwrappers} is available as a shared library, and the
11740 @option{-static} option is not used, then this links against the shared
11741 version of @file{libmpxwrappers}.  The @option{-static-libmpxwrappers}
11742 option directs the GCC driver to link @file{libmpxwrappers} statically,
11743 without necessarily linking other libraries statically.
11745 @item -static-libstdc++
11746 @opindex static-libstdc++
11747 When the @command{g++} program is used to link a C++ program, it
11748 normally automatically links against @option{libstdc++}.  If
11749 @file{libstdc++} is available as a shared library, and the
11750 @option{-static} option is not used, then this links against the
11751 shared version of @file{libstdc++}.  That is normally fine.  However, it
11752 is sometimes useful to freeze the version of @file{libstdc++} used by
11753 the program without going all the way to a fully static link.  The
11754 @option{-static-libstdc++} option directs the @command{g++} driver to
11755 link @file{libstdc++} statically, without necessarily linking other
11756 libraries statically.
11758 @item -symbolic
11759 @opindex symbolic
11760 Bind references to global symbols when building a shared object.  Warn
11761 about any unresolved references (unless overridden by the link editor
11762 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
11763 this option.
11765 @item -T @var{script}
11766 @opindex T
11767 @cindex linker script
11768 Use @var{script} as the linker script.  This option is supported by most
11769 systems using the GNU linker.  On some targets, such as bare-board
11770 targets without an operating system, the @option{-T} option may be required
11771 when linking to avoid references to undefined symbols.
11773 @item -Xlinker @var{option}
11774 @opindex Xlinker
11775 Pass @var{option} as an option to the linker.  You can use this to
11776 supply system-specific linker options that GCC does not recognize.
11778 If you want to pass an option that takes a separate argument, you must use
11779 @option{-Xlinker} twice, once for the option and once for the argument.
11780 For example, to pass @option{-assert definitions}, you must write
11781 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
11782 @option{-Xlinker "-assert definitions"}, because this passes the entire
11783 string as a single argument, which is not what the linker expects.
11785 When using the GNU linker, it is usually more convenient to pass
11786 arguments to linker options using the @option{@var{option}=@var{value}}
11787 syntax than as separate arguments.  For example, you can specify
11788 @option{-Xlinker -Map=output.map} rather than
11789 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
11790 this syntax for command-line options.
11792 @item -Wl,@var{option}
11793 @opindex Wl
11794 Pass @var{option} as an option to the linker.  If @var{option} contains
11795 commas, it is split into multiple options at the commas.  You can use this
11796 syntax to pass an argument to the option.
11797 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
11798 linker.  When using the GNU linker, you can also get the same effect with
11799 @option{-Wl,-Map=output.map}.
11801 @item -u @var{symbol}
11802 @opindex u
11803 Pretend the symbol @var{symbol} is undefined, to force linking of
11804 library modules to define it.  You can use @option{-u} multiple times with
11805 different symbols to force loading of additional library modules.
11807 @item -z @var{keyword}
11808 @opindex z
11809 @option{-z} is passed directly on to the linker along with the keyword
11810 @var{keyword}. See the section in the documentation of your linker for
11811 permitted values and their meanings.
11812 @end table
11814 @node Directory Options
11815 @section Options for Directory Search
11816 @cindex directory options
11817 @cindex options, directory search
11818 @cindex search path
11820 These options specify directories to search for header files, for
11821 libraries and for parts of the compiler:
11823 @table @gcctabopt
11824 @include cppdiropts.texi
11826 @item -iplugindir=@var{dir}
11827 @opindex iplugindir=
11828 Set the directory to search for plugins that are passed
11829 by @option{-fplugin=@var{name}} instead of
11830 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
11831 to be used by the user, but only passed by the driver.
11833 @item -L@var{dir}
11834 @opindex L
11835 Add directory @var{dir} to the list of directories to be searched
11836 for @option{-l}.
11838 @item -B@var{prefix}
11839 @opindex B
11840 This option specifies where to find the executables, libraries,
11841 include files, and data files of the compiler itself.
11843 The compiler driver program runs one or more of the subprograms
11844 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
11845 @var{prefix} as a prefix for each program it tries to run, both with and
11846 without @samp{@var{machine}/@var{version}/} for the corresponding target
11847 machine and compiler version.
11849 For each subprogram to be run, the compiler driver first tries the
11850 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
11851 is not specified, the driver tries two standard prefixes, 
11852 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
11853 those results in a file name that is found, the unmodified program
11854 name is searched for using the directories specified in your
11855 @env{PATH} environment variable.
11857 The compiler checks to see if the path provided by @option{-B}
11858 refers to a directory, and if necessary it adds a directory
11859 separator character at the end of the path.
11861 @option{-B} prefixes that effectively specify directory names also apply
11862 to libraries in the linker, because the compiler translates these
11863 options into @option{-L} options for the linker.  They also apply to
11864 include files in the preprocessor, because the compiler translates these
11865 options into @option{-isystem} options for the preprocessor.  In this case,
11866 the compiler appends @samp{include} to the prefix.
11868 The runtime support file @file{libgcc.a} can also be searched for using
11869 the @option{-B} prefix, if needed.  If it is not found there, the two
11870 standard prefixes above are tried, and that is all.  The file is left
11871 out of the link if it is not found by those means.
11873 Another way to specify a prefix much like the @option{-B} prefix is to use
11874 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
11875 Variables}.
11877 As a special kludge, if the path provided by @option{-B} is
11878 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
11879 9, then it is replaced by @file{[dir/]include}.  This is to help
11880 with boot-strapping the compiler.
11882 @item -no-canonical-prefixes
11883 @opindex no-canonical-prefixes
11884 Do not expand any symbolic links, resolve references to @samp{/../}
11885 or @samp{/./}, or make the path absolute when generating a relative
11886 prefix.
11888 @item --sysroot=@var{dir}
11889 @opindex sysroot
11890 Use @var{dir} as the logical root directory for headers and libraries.
11891 For example, if the compiler normally searches for headers in
11892 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
11893 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
11895 If you use both this option and the @option{-isysroot} option, then
11896 the @option{--sysroot} option applies to libraries, but the
11897 @option{-isysroot} option applies to header files.
11899 The GNU linker (beginning with version 2.16) has the necessary support
11900 for this option.  If your linker does not support this option, the
11901 header file aspect of @option{--sysroot} still works, but the
11902 library aspect does not.
11904 @item --no-sysroot-suffix
11905 @opindex no-sysroot-suffix
11906 For some targets, a suffix is added to the root directory specified
11907 with @option{--sysroot}, depending on the other options used, so that
11908 headers may for example be found in
11909 @file{@var{dir}/@var{suffix}/usr/include} instead of
11910 @file{@var{dir}/usr/include}.  This option disables the addition of
11911 such a suffix.
11913 @end table
11915 @node Code Gen Options
11916 @section Options for Code Generation Conventions
11917 @cindex code generation conventions
11918 @cindex options, code generation
11919 @cindex run-time options
11921 These machine-independent options control the interface conventions
11922 used in code generation.
11924 Most of them have both positive and negative forms; the negative form
11925 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
11926 one of the forms is listed---the one that is not the default.  You
11927 can figure out the other form by either removing @samp{no-} or adding
11930 @table @gcctabopt
11931 @item -fstack-reuse=@var{reuse-level}
11932 @opindex fstack_reuse
11933 This option controls stack space reuse for user declared local/auto variables
11934 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
11935 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
11936 local variables and temporaries, @samp{named_vars} enables the reuse only for
11937 user defined local variables with names, and @samp{none} disables stack reuse
11938 completely. The default value is @samp{all}. The option is needed when the
11939 program extends the lifetime of a scoped local variable or a compiler generated
11940 temporary beyond the end point defined by the language.  When a lifetime of
11941 a variable ends, and if the variable lives in memory, the optimizing compiler
11942 has the freedom to reuse its stack space with other temporaries or scoped
11943 local variables whose live range does not overlap with it. Legacy code extending
11944 local lifetime is likely to break with the stack reuse optimization.
11946 For example,
11948 @smallexample
11949    int *p;
11950    @{
11951      int local1;
11953      p = &local1;
11954      local1 = 10;
11955      ....
11956    @}
11957    @{
11958       int local2;
11959       local2 = 20;
11960       ...
11961    @}
11963    if (*p == 10)  // out of scope use of local1
11964      @{
11966      @}
11967 @end smallexample
11969 Another example:
11970 @smallexample
11972    struct A
11973    @{
11974        A(int k) : i(k), j(k) @{ @}
11975        int i;
11976        int j;
11977    @};
11979    A *ap;
11981    void foo(const A& ar)
11982    @{
11983       ap = &ar;
11984    @}
11986    void bar()
11987    @{
11988       foo(A(10)); // temp object's lifetime ends when foo returns
11990       @{
11991         A a(20);
11992         ....
11993       @}
11994       ap->i+= 10;  // ap references out of scope temp whose space
11995                    // is reused with a. What is the value of ap->i?
11996    @}
11998 @end smallexample
12000 The lifetime of a compiler generated temporary is well defined by the C++
12001 standard. When a lifetime of a temporary ends, and if the temporary lives
12002 in memory, the optimizing compiler has the freedom to reuse its stack
12003 space with other temporaries or scoped local variables whose live range
12004 does not overlap with it. However some of the legacy code relies on
12005 the behavior of older compilers in which temporaries' stack space is
12006 not reused, the aggressive stack reuse can lead to runtime errors. This
12007 option is used to control the temporary stack reuse optimization.
12009 @item -ftrapv
12010 @opindex ftrapv
12011 This option generates traps for signed overflow on addition, subtraction,
12012 multiplication operations.
12013 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12014 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12015 @option{-fwrapv} being effective.  Note that only active options override, so
12016 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12017 results in @option{-ftrapv} being effective.
12019 @item -fwrapv
12020 @opindex fwrapv
12021 This option instructs the compiler to assume that signed arithmetic
12022 overflow of addition, subtraction and multiplication wraps around
12023 using twos-complement representation.  This flag enables some optimizations
12024 and disables others.
12025 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12026 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12027 @option{-fwrapv} being effective.  Note that only active options override, so
12028 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12029 results in @option{-ftrapv} being effective.
12031 @item -fexceptions
12032 @opindex fexceptions
12033 Enable exception handling.  Generates extra code needed to propagate
12034 exceptions.  For some targets, this implies GCC generates frame
12035 unwind information for all functions, which can produce significant data
12036 size overhead, although it does not affect execution.  If you do not
12037 specify this option, GCC enables it by default for languages like
12038 C++ that normally require exception handling, and disables it for
12039 languages like C that do not normally require it.  However, you may need
12040 to enable this option when compiling C code that needs to interoperate
12041 properly with exception handlers written in C++.  You may also wish to
12042 disable this option if you are compiling older C++ programs that don't
12043 use exception handling.
12045 @item -fnon-call-exceptions
12046 @opindex fnon-call-exceptions
12047 Generate code that allows trapping instructions to throw exceptions.
12048 Note that this requires platform-specific runtime support that does
12049 not exist everywhere.  Moreover, it only allows @emph{trapping}
12050 instructions to throw exceptions, i.e.@: memory references or floating-point
12051 instructions.  It does not allow exceptions to be thrown from
12052 arbitrary signal handlers such as @code{SIGALRM}.
12054 @item -fdelete-dead-exceptions
12055 @opindex fdelete-dead-exceptions
12056 Consider that instructions that may throw exceptions but don't otherwise
12057 contribute to the execution of the program can be optimized away.
12058 This option is enabled by default for the Ada front end, as permitted by
12059 the Ada language specification.
12060 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
12062 @item -funwind-tables
12063 @opindex funwind-tables
12064 Similar to @option{-fexceptions}, except that it just generates any needed
12065 static data, but does not affect the generated code in any other way.
12066 You normally do not need to enable this option; instead, a language processor
12067 that needs this handling enables it on your behalf.
12069 @item -fasynchronous-unwind-tables
12070 @opindex fasynchronous-unwind-tables
12071 Generate unwind table in DWARF format, if supported by target machine.  The
12072 table is exact at each instruction boundary, so it can be used for stack
12073 unwinding from asynchronous events (such as debugger or garbage collector).
12075 @item -fno-gnu-unique
12076 @opindex fno-gnu-unique
12077 On systems with recent GNU assembler and C library, the C++ compiler
12078 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
12079 of template static data members and static local variables in inline
12080 functions are unique even in the presence of @code{RTLD_LOCAL}; this
12081 is necessary to avoid problems with a library used by two different
12082 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
12083 therefore disagreeing with the other one about the binding of the
12084 symbol.  But this causes @code{dlclose} to be ignored for affected
12085 DSOs; if your program relies on reinitialization of a DSO via
12086 @code{dlclose} and @code{dlopen}, you can use
12087 @option{-fno-gnu-unique}.
12089 @item -fpcc-struct-return
12090 @opindex fpcc-struct-return
12091 Return ``short'' @code{struct} and @code{union} values in memory like
12092 longer ones, rather than in registers.  This convention is less
12093 efficient, but it has the advantage of allowing intercallability between
12094 GCC-compiled files and files compiled with other compilers, particularly
12095 the Portable C Compiler (pcc).
12097 The precise convention for returning structures in memory depends
12098 on the target configuration macros.
12100 Short structures and unions are those whose size and alignment match
12101 that of some integer type.
12103 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12104 switch is not binary compatible with code compiled with the
12105 @option{-freg-struct-return} switch.
12106 Use it to conform to a non-default application binary interface.
12108 @item -freg-struct-return
12109 @opindex freg-struct-return
12110 Return @code{struct} and @code{union} values in registers when possible.
12111 This is more efficient for small structures than
12112 @option{-fpcc-struct-return}.
12114 If you specify neither @option{-fpcc-struct-return} nor
12115 @option{-freg-struct-return}, GCC defaults to whichever convention is
12116 standard for the target.  If there is no standard convention, GCC
12117 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12118 the principal compiler.  In those cases, we can choose the standard, and
12119 we chose the more efficient register return alternative.
12121 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12122 switch is not binary compatible with code compiled with the
12123 @option{-fpcc-struct-return} switch.
12124 Use it to conform to a non-default application binary interface.
12126 @item -fshort-enums
12127 @opindex fshort-enums
12128 Allocate to an @code{enum} type only as many bytes as it needs for the
12129 declared range of possible values.  Specifically, the @code{enum} type
12130 is equivalent to the smallest integer type that has enough room.
12132 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12133 code that is not binary compatible with code generated without that switch.
12134 Use it to conform to a non-default application binary interface.
12136 @item -fshort-wchar
12137 @opindex fshort-wchar
12138 Override the underlying type for @code{wchar_t} to be @code{short
12139 unsigned int} instead of the default for the target.  This option is
12140 useful for building programs to run under WINE@.
12142 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12143 code that is not binary compatible with code generated without that switch.
12144 Use it to conform to a non-default application binary interface.
12146 @item -fno-common
12147 @opindex fno-common
12148 @cindex tentative definitions
12149 In C code, this option controls the placement of global variables 
12150 defined without an initializer, known as @dfn{tentative definitions} 
12151 in the C standard.  Tentative definitions are distinct from declarations 
12152 of a variable with the @code{extern} keyword, which do not allocate storage.
12154 Unix C compilers have traditionally allocated storage for
12155 uninitialized global variables in a common block.  This allows the
12156 linker to resolve all tentative definitions of the same variable
12157 in different compilation units to the same object, or to a non-tentative
12158 definition.  
12159 This is the behavior specified by @option{-fcommon}, and is the default for 
12160 GCC on most targets.  
12161 On the other hand, this behavior is not required by ISO
12162 C, and on some targets may carry a speed or code size penalty on
12163 variable references.
12165 The @option{-fno-common} option specifies that the compiler should instead
12166 place uninitialized global variables in the data section of the object file.
12167 This inhibits the merging of tentative definitions by the linker so
12168 you get a multiple-definition error if the same 
12169 variable is defined in more than one compilation unit.
12170 Compiling with @option{-fno-common} is useful on targets for which
12171 it provides better performance, or if you wish to verify that the
12172 program will work on other systems that always treat uninitialized
12173 variable definitions this way.
12175 @item -fno-ident
12176 @opindex fno-ident
12177 Ignore the @code{#ident} directive.
12179 @item -finhibit-size-directive
12180 @opindex finhibit-size-directive
12181 Don't output a @code{.size} assembler directive, or anything else that
12182 would cause trouble if the function is split in the middle, and the
12183 two halves are placed at locations far apart in memory.  This option is
12184 used when compiling @file{crtstuff.c}; you should not need to use it
12185 for anything else.
12187 @item -fverbose-asm
12188 @opindex fverbose-asm
12189 Put extra commentary information in the generated assembly code to
12190 make it more readable.  This option is generally only of use to those
12191 who actually need to read the generated assembly code (perhaps while
12192 debugging the compiler itself).
12194 @option{-fno-verbose-asm}, the default, causes the
12195 extra information to be omitted and is useful when comparing two assembler
12196 files.
12198 The added comments include:
12200 @itemize @bullet
12202 @item
12203 information on the compiler version and command-line options,
12205 @item
12206 the source code lines associated with the assembly instructions,
12207 in the form FILENAME:LINENUMBER:CONTENT OF LINE,
12209 @item
12210 hints on which high-level expressions correspond to
12211 the various assembly instruction operands.
12213 @end itemize
12215 For example, given this C source file:
12217 @smallexample
12218 int test (int n)
12220   int i;
12221   int total = 0;
12223   for (i = 0; i < n; i++)
12224     total += i * i;
12226   return total;
12228 @end smallexample
12230 compiling to (x86_64) assembly via @option{-S} and emitting the result
12231 direct to stdout via @option{-o} @option{-}
12233 @smallexample
12234 gcc -S test.c -fverbose-asm -Os -o -
12235 @end smallexample
12237 gives output similar to this:
12239 @smallexample
12240         .file   "test.c"
12241 # GNU C11 (GCC) version 7.0.0 20160809 (experimental) (x86_64-pc-linux-gnu)
12242   [...snip...]
12243 # options passed:
12244   [...snip...]
12246         .text
12247         .globl  test
12248         .type   test, @@function
12249 test:
12250 .LFB0:
12251         .cfi_startproc
12252 # test.c:4:   int total = 0;
12253         xorl    %eax, %eax      # <retval>
12254 # test.c:6:   for (i = 0; i < n; i++)
12255         xorl    %edx, %edx      # i
12256 .L2:
12257 # test.c:6:   for (i = 0; i < n; i++)
12258         cmpl    %edi, %edx      # n, i
12259         jge     .L5     #,
12260 # test.c:7:     total += i * i;
12261         movl    %edx, %ecx      # i, tmp92
12262         imull   %edx, %ecx      # i, tmp92
12263 # test.c:6:   for (i = 0; i < n; i++)
12264         incl    %edx    # i
12265 # test.c:7:     total += i * i;
12266         addl    %ecx, %eax      # tmp92, <retval>
12267         jmp     .L2     #
12268 .L5:
12269 # test.c:10: @}
12270         ret
12271         .cfi_endproc
12272 .LFE0:
12273         .size   test, .-test
12274         .ident  "GCC: (GNU) 7.0.0 20160809 (experimental)"
12275         .section        .note.GNU-stack,"",@@progbits
12276 @end smallexample
12278 The comments are intended for humans rather than machines and hence the
12279 precise format of the comments is subject to change.
12281 @item -frecord-gcc-switches
12282 @opindex frecord-gcc-switches
12283 This switch causes the command line used to invoke the
12284 compiler to be recorded into the object file that is being created.
12285 This switch is only implemented on some targets and the exact format
12286 of the recording is target and binary file format dependent, but it
12287 usually takes the form of a section containing ASCII text.  This
12288 switch is related to the @option{-fverbose-asm} switch, but that
12289 switch only records information in the assembler output file as
12290 comments, so it never reaches the object file.
12291 See also @option{-grecord-gcc-switches} for another
12292 way of storing compiler options into the object file.
12294 @item -fpic
12295 @opindex fpic
12296 @cindex global offset table
12297 @cindex PIC
12298 Generate position-independent code (PIC) suitable for use in a shared
12299 library, if supported for the target machine.  Such code accesses all
12300 constant addresses through a global offset table (GOT)@.  The dynamic
12301 loader resolves the GOT entries when the program starts (the dynamic
12302 loader is not part of GCC; it is part of the operating system).  If
12303 the GOT size for the linked executable exceeds a machine-specific
12304 maximum size, you get an error message from the linker indicating that
12305 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
12306 instead.  (These maximums are 8k on the SPARC, 28k on AArch64 and 32k
12307 on the m68k and RS/6000.  The x86 has no such limit.)
12309 Position-independent code requires special support, and therefore works
12310 only on certain machines.  For the x86, GCC supports PIC for System V
12311 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
12312 position-independent.
12314 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12315 are defined to 1.
12317 @item -fPIC
12318 @opindex fPIC
12319 If supported for the target machine, emit position-independent code,
12320 suitable for dynamic linking and avoiding any limit on the size of the
12321 global offset table.  This option makes a difference on AArch64, m68k,
12322 PowerPC and SPARC@.
12324 Position-independent code requires special support, and therefore works
12325 only on certain machines.
12327 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12328 are defined to 2.
12330 @item -fpie
12331 @itemx -fPIE
12332 @opindex fpie
12333 @opindex fPIE
12334 These options are similar to @option{-fpic} and @option{-fPIC}, but
12335 generated position independent code can be only linked into executables.
12336 Usually these options are used when @option{-pie} GCC option is
12337 used during linking.
12339 @option{-fpie} and @option{-fPIE} both define the macros
12340 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
12341 for @option{-fpie} and 2 for @option{-fPIE}.
12343 @item -fno-plt
12344 @opindex fno-plt
12345 Do not use the PLT for external function calls in position-independent code.
12346 Instead, load the callee address at call sites from the GOT and branch to it.
12347 This leads to more efficient code by eliminating PLT stubs and exposing
12348 GOT loads to optimizations.  On architectures such as 32-bit x86 where
12349 PLT stubs expect the GOT pointer in a specific register, this gives more
12350 register allocation freedom to the compiler.
12351 Lazy binding requires use of the PLT; 
12352 with @option{-fno-plt} all external symbols are resolved at load time.
12354 Alternatively, the function attribute @code{noplt} can be used to avoid calls
12355 through the PLT for specific external functions.
12357 In position-dependent code, a few targets also convert calls to
12358 functions that are marked to not use the PLT to use the GOT instead.
12360 @item -fno-jump-tables
12361 @opindex fno-jump-tables
12362 Do not use jump tables for switch statements even where it would be
12363 more efficient than other code generation strategies.  This option is
12364 of use in conjunction with @option{-fpic} or @option{-fPIC} for
12365 building code that forms part of a dynamic linker and cannot
12366 reference the address of a jump table.  On some targets, jump tables
12367 do not require a GOT and this option is not needed.
12369 @item -ffixed-@var{reg}
12370 @opindex ffixed
12371 Treat the register named @var{reg} as a fixed register; generated code
12372 should never refer to it (except perhaps as a stack pointer, frame
12373 pointer or in some other fixed role).
12375 @var{reg} must be the name of a register.  The register names accepted
12376 are machine-specific and are defined in the @code{REGISTER_NAMES}
12377 macro in the machine description macro file.
12379 This flag does not have a negative form, because it specifies a
12380 three-way choice.
12382 @item -fcall-used-@var{reg}
12383 @opindex fcall-used
12384 Treat the register named @var{reg} as an allocable register that is
12385 clobbered by function calls.  It may be allocated for temporaries or
12386 variables that do not live across a call.  Functions compiled this way
12387 do not save and restore the register @var{reg}.
12389 It is an error to use this flag with the frame pointer or stack pointer.
12390 Use of this flag for other registers that have fixed pervasive roles in
12391 the machine's execution model produces disastrous results.
12393 This flag does not have a negative form, because it specifies a
12394 three-way choice.
12396 @item -fcall-saved-@var{reg}
12397 @opindex fcall-saved
12398 Treat the register named @var{reg} as an allocable register saved by
12399 functions.  It may be allocated even for temporaries or variables that
12400 live across a call.  Functions compiled this way save and restore
12401 the register @var{reg} if they use it.
12403 It is an error to use this flag with the frame pointer or stack pointer.
12404 Use of this flag for other registers that have fixed pervasive roles in
12405 the machine's execution model produces disastrous results.
12407 A different sort of disaster results from the use of this flag for
12408 a register in which function values may be returned.
12410 This flag does not have a negative form, because it specifies a
12411 three-way choice.
12413 @item -fpack-struct[=@var{n}]
12414 @opindex fpack-struct
12415 Without a value specified, pack all structure members together without
12416 holes.  When a value is specified (which must be a small power of two), pack
12417 structure members according to this value, representing the maximum
12418 alignment (that is, objects with default alignment requirements larger than
12419 this are output potentially unaligned at the next fitting location.
12421 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
12422 code that is not binary compatible with code generated without that switch.
12423 Additionally, it makes the code suboptimal.
12424 Use it to conform to a non-default application binary interface.
12426 @item -fleading-underscore
12427 @opindex fleading-underscore
12428 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
12429 change the way C symbols are represented in the object file.  One use
12430 is to help link with legacy assembly code.
12432 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
12433 generate code that is not binary compatible with code generated without that
12434 switch.  Use it to conform to a non-default application binary interface.
12435 Not all targets provide complete support for this switch.
12437 @item -ftls-model=@var{model}
12438 @opindex ftls-model
12439 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
12440 The @var{model} argument should be one of @samp{global-dynamic},
12441 @samp{local-dynamic}, @samp{initial-exec} or @samp{local-exec}.
12442 Note that the choice is subject to optimization: the compiler may use
12443 a more efficient model for symbols not visible outside of the translation
12444 unit, or if @option{-fpic} is not given on the command line.
12446 The default without @option{-fpic} is @samp{initial-exec}; with
12447 @option{-fpic} the default is @samp{global-dynamic}.
12449 @item -ftrampolines
12450 @opindex ftrampolines
12451 For targets that normally need trampolines for nested functions, always
12452 generate them instead of using descriptors.  Otherwise, for targets that
12453 do not need them, like for example HP-PA or IA-64, do nothing.
12455 A trampoline is a small piece of code that is created at run time on the
12456 stack when the address of a nested function is taken, and is used to call
12457 the nested function indirectly.  Therefore, it requires the stack to be
12458 made executable in order for the program to work properly.
12460 @option{-fno-trampolines} is enabled by default on a language by language
12461 basis to let the compiler avoid generating them, if it computes that this
12462 is safe, and replace them with descriptors.  Descriptors are made up of data
12463 only, but the generated code must be prepared to deal with them.  As of this
12464 writing, @option{-fno-trampolines} is enabled by default only for Ada.
12466 Moreover, code compiled with @option{-ftrampolines} and code compiled with
12467 @option{-fno-trampolines} are not binary compatible if nested functions are
12468 present.  This option must therefore be used on a program-wide basis and be
12469 manipulated with extreme care.
12471 @item -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]}
12472 @opindex fvisibility
12473 Set the default ELF image symbol visibility to the specified option---all
12474 symbols are marked with this unless overridden within the code.
12475 Using this feature can very substantially improve linking and
12476 load times of shared object libraries, produce more optimized
12477 code, provide near-perfect API export and prevent symbol clashes.
12478 It is @strong{strongly} recommended that you use this in any shared objects
12479 you distribute.
12481 Despite the nomenclature, @samp{default} always means public; i.e.,
12482 available to be linked against from outside the shared object.
12483 @samp{protected} and @samp{internal} are pretty useless in real-world
12484 usage so the only other commonly used option is @samp{hidden}.
12485 The default if @option{-fvisibility} isn't specified is
12486 @samp{default}, i.e., make every symbol public.
12488 A good explanation of the benefits offered by ensuring ELF
12489 symbols have the correct visibility is given by ``How To Write
12490 Shared Libraries'' by Ulrich Drepper (which can be found at
12491 @w{@uref{https://www.akkadia.org/drepper/}})---however a superior
12492 solution made possible by this option to marking things hidden when
12493 the default is public is to make the default hidden and mark things
12494 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
12495 and @code{__attribute__ ((visibility("default")))} instead of
12496 @code{__declspec(dllexport)} you get almost identical semantics with
12497 identical syntax.  This is a great boon to those working with
12498 cross-platform projects.
12500 For those adding visibility support to existing code, you may find
12501 @code{#pragma GCC visibility} of use.  This works by you enclosing
12502 the declarations you wish to set visibility for with (for example)
12503 @code{#pragma GCC visibility push(hidden)} and
12504 @code{#pragma GCC visibility pop}.
12505 Bear in mind that symbol visibility should be viewed @strong{as
12506 part of the API interface contract} and thus all new code should
12507 always specify visibility when it is not the default; i.e., declarations
12508 only for use within the local DSO should @strong{always} be marked explicitly
12509 as hidden as so to avoid PLT indirection overheads---making this
12510 abundantly clear also aids readability and self-documentation of the code.
12511 Note that due to ISO C++ specification requirements, @code{operator new} and
12512 @code{operator delete} must always be of default visibility.
12514 Be aware that headers from outside your project, in particular system
12515 headers and headers from any other library you use, may not be
12516 expecting to be compiled with visibility other than the default.  You
12517 may need to explicitly say @code{#pragma GCC visibility push(default)}
12518 before including any such headers.
12520 @code{extern} declarations are not affected by @option{-fvisibility}, so
12521 a lot of code can be recompiled with @option{-fvisibility=hidden} with
12522 no modifications.  However, this means that calls to @code{extern}
12523 functions with no explicit visibility use the PLT, so it is more
12524 effective to use @code{__attribute ((visibility))} and/or
12525 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
12526 declarations should be treated as hidden.
12528 Note that @option{-fvisibility} does affect C++ vague linkage
12529 entities. This means that, for instance, an exception class that is
12530 be thrown between DSOs must be explicitly marked with default
12531 visibility so that the @samp{type_info} nodes are unified between
12532 the DSOs.
12534 An overview of these techniques, their benefits and how to use them
12535 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
12537 @item -fstrict-volatile-bitfields
12538 @opindex fstrict-volatile-bitfields
12539 This option should be used if accesses to volatile bit-fields (or other
12540 structure fields, although the compiler usually honors those types
12541 anyway) should use a single access of the width of the
12542 field's type, aligned to a natural alignment if possible.  For
12543 example, targets with memory-mapped peripheral registers might require
12544 all such accesses to be 16 bits wide; with this flag you can
12545 declare all peripheral bit-fields as @code{unsigned short} (assuming short
12546 is 16 bits on these targets) to force GCC to use 16-bit accesses
12547 instead of, perhaps, a more efficient 32-bit access.
12549 If this option is disabled, the compiler uses the most efficient
12550 instruction.  In the previous example, that might be a 32-bit load
12551 instruction, even though that accesses bytes that do not contain
12552 any portion of the bit-field, or memory-mapped registers unrelated to
12553 the one being updated.
12555 In some cases, such as when the @code{packed} attribute is applied to a 
12556 structure field, it may not be possible to access the field with a single
12557 read or write that is correctly aligned for the target machine.  In this
12558 case GCC falls back to generating multiple accesses rather than code that 
12559 will fault or truncate the result at run time.
12561 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
12562 not allowed to touch non bit-field members.  It is therefore recommended
12563 to define all bits of the field's type as bit-field members.
12565 The default value of this option is determined by the application binary
12566 interface for the target processor.
12568 @item -fsync-libcalls
12569 @opindex fsync-libcalls
12570 This option controls whether any out-of-line instance of the @code{__sync}
12571 family of functions may be used to implement the C++11 @code{__atomic}
12572 family of functions.
12574 The default value of this option is enabled, thus the only useful form
12575 of the option is @option{-fno-sync-libcalls}.  This option is used in
12576 the implementation of the @file{libatomic} runtime library.
12578 @end table
12580 @node Developer Options
12581 @section GCC Developer Options
12582 @cindex developer options
12583 @cindex debugging GCC
12584 @cindex debug dump options
12585 @cindex dump options
12586 @cindex compilation statistics
12588 This section describes command-line options that are primarily of
12589 interest to GCC developers, including options to support compiler
12590 testing and investigation of compiler bugs and compile-time
12591 performance problems.  This includes options that produce debug dumps
12592 at various points in the compilation; that print statistics such as
12593 memory use and execution time; and that print information about GCC's
12594 configuration, such as where it searches for libraries.  You should
12595 rarely need to use any of these options for ordinary compilation and
12596 linking tasks.
12598 @table @gcctabopt
12600 @item -d@var{letters}
12601 @itemx -fdump-rtl-@var{pass}
12602 @itemx -fdump-rtl-@var{pass}=@var{filename}
12603 @opindex d
12604 @opindex fdump-rtl-@var{pass}
12605 Says to make debugging dumps during compilation at times specified by
12606 @var{letters}.  This is used for debugging the RTL-based passes of the
12607 compiler.  The file names for most of the dumps are made by appending
12608 a pass number and a word to the @var{dumpname}, and the files are
12609 created in the directory of the output file.  In case of
12610 @option{=@var{filename}} option, the dump is output on the given file
12611 instead of the pass numbered dump files.  Note that the pass number is
12612 assigned as passes are registered into the pass manager.  Most passes
12613 are registered in the order that they will execute and for these passes
12614 the number corresponds to the pass execution order.  However, passes
12615 registered by plugins, passes specific to compilation targets, or
12616 passes that are otherwise registered after all the other passes are
12617 numbered higher than a pass named "final", even if they are executed
12618 earlier.  @var{dumpname} is generated from the name of the output
12619 file if explicitly specified and not an executable, otherwise it is
12620 the basename of the source file.  
12622 Some @option{-d@var{letters}} switches have different meaning when
12623 @option{-E} is used for preprocessing.  @xref{Preprocessor Options},
12624 for information about preprocessor-specific dump options.
12626 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
12627 @option{-d} option @var{letters}.  Here are the possible
12628 letters for use in @var{pass} and @var{letters}, and their meanings:
12630 @table @gcctabopt
12632 @item -fdump-rtl-alignments
12633 @opindex fdump-rtl-alignments
12634 Dump after branch alignments have been computed.
12636 @item -fdump-rtl-asmcons
12637 @opindex fdump-rtl-asmcons
12638 Dump after fixing rtl statements that have unsatisfied in/out constraints.
12640 @item -fdump-rtl-auto_inc_dec
12641 @opindex fdump-rtl-auto_inc_dec
12642 Dump after auto-inc-dec discovery.  This pass is only run on
12643 architectures that have auto inc or auto dec instructions.
12645 @item -fdump-rtl-barriers
12646 @opindex fdump-rtl-barriers
12647 Dump after cleaning up the barrier instructions.
12649 @item -fdump-rtl-bbpart
12650 @opindex fdump-rtl-bbpart
12651 Dump after partitioning hot and cold basic blocks.
12653 @item -fdump-rtl-bbro
12654 @opindex fdump-rtl-bbro
12655 Dump after block reordering.
12657 @item -fdump-rtl-btl1
12658 @itemx -fdump-rtl-btl2
12659 @opindex fdump-rtl-btl2
12660 @opindex fdump-rtl-btl2
12661 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
12662 after the two branch
12663 target load optimization passes.
12665 @item -fdump-rtl-bypass
12666 @opindex fdump-rtl-bypass
12667 Dump after jump bypassing and control flow optimizations.
12669 @item -fdump-rtl-combine
12670 @opindex fdump-rtl-combine
12671 Dump after the RTL instruction combination pass.
12673 @item -fdump-rtl-compgotos
12674 @opindex fdump-rtl-compgotos
12675 Dump after duplicating the computed gotos.
12677 @item -fdump-rtl-ce1
12678 @itemx -fdump-rtl-ce2
12679 @itemx -fdump-rtl-ce3
12680 @opindex fdump-rtl-ce1
12681 @opindex fdump-rtl-ce2
12682 @opindex fdump-rtl-ce3
12683 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
12684 @option{-fdump-rtl-ce3} enable dumping after the three
12685 if conversion passes.
12687 @item -fdump-rtl-cprop_hardreg
12688 @opindex fdump-rtl-cprop_hardreg
12689 Dump after hard register copy propagation.
12691 @item -fdump-rtl-csa
12692 @opindex fdump-rtl-csa
12693 Dump after combining stack adjustments.
12695 @item -fdump-rtl-cse1
12696 @itemx -fdump-rtl-cse2
12697 @opindex fdump-rtl-cse1
12698 @opindex fdump-rtl-cse2
12699 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
12700 the two common subexpression elimination passes.
12702 @item -fdump-rtl-dce
12703 @opindex fdump-rtl-dce
12704 Dump after the standalone dead code elimination passes.
12706 @item -fdump-rtl-dbr
12707 @opindex fdump-rtl-dbr
12708 Dump after delayed branch scheduling.
12710 @item -fdump-rtl-dce1
12711 @itemx -fdump-rtl-dce2
12712 @opindex fdump-rtl-dce1
12713 @opindex fdump-rtl-dce2
12714 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
12715 the two dead store elimination passes.
12717 @item -fdump-rtl-eh
12718 @opindex fdump-rtl-eh
12719 Dump after finalization of EH handling code.
12721 @item -fdump-rtl-eh_ranges
12722 @opindex fdump-rtl-eh_ranges
12723 Dump after conversion of EH handling range regions.
12725 @item -fdump-rtl-expand
12726 @opindex fdump-rtl-expand
12727 Dump after RTL generation.
12729 @item -fdump-rtl-fwprop1
12730 @itemx -fdump-rtl-fwprop2
12731 @opindex fdump-rtl-fwprop1
12732 @opindex fdump-rtl-fwprop2
12733 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
12734 dumping after the two forward propagation passes.
12736 @item -fdump-rtl-gcse1
12737 @itemx -fdump-rtl-gcse2
12738 @opindex fdump-rtl-gcse1
12739 @opindex fdump-rtl-gcse2
12740 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
12741 after global common subexpression elimination.
12743 @item -fdump-rtl-init-regs
12744 @opindex fdump-rtl-init-regs
12745 Dump after the initialization of the registers.
12747 @item -fdump-rtl-initvals
12748 @opindex fdump-rtl-initvals
12749 Dump after the computation of the initial value sets.
12751 @item -fdump-rtl-into_cfglayout
12752 @opindex fdump-rtl-into_cfglayout
12753 Dump after converting to cfglayout mode.
12755 @item -fdump-rtl-ira
12756 @opindex fdump-rtl-ira
12757 Dump after iterated register allocation.
12759 @item -fdump-rtl-jump
12760 @opindex fdump-rtl-jump
12761 Dump after the second jump optimization.
12763 @item -fdump-rtl-loop2
12764 @opindex fdump-rtl-loop2
12765 @option{-fdump-rtl-loop2} enables dumping after the rtl
12766 loop optimization passes.
12768 @item -fdump-rtl-mach
12769 @opindex fdump-rtl-mach
12770 Dump after performing the machine dependent reorganization pass, if that
12771 pass exists.
12773 @item -fdump-rtl-mode_sw
12774 @opindex fdump-rtl-mode_sw
12775 Dump after removing redundant mode switches.
12777 @item -fdump-rtl-rnreg
12778 @opindex fdump-rtl-rnreg
12779 Dump after register renumbering.
12781 @item -fdump-rtl-outof_cfglayout
12782 @opindex fdump-rtl-outof_cfglayout
12783 Dump after converting from cfglayout mode.
12785 @item -fdump-rtl-peephole2
12786 @opindex fdump-rtl-peephole2
12787 Dump after the peephole pass.
12789 @item -fdump-rtl-postreload
12790 @opindex fdump-rtl-postreload
12791 Dump after post-reload optimizations.
12793 @item -fdump-rtl-pro_and_epilogue
12794 @opindex fdump-rtl-pro_and_epilogue
12795 Dump after generating the function prologues and epilogues.
12797 @item -fdump-rtl-sched1
12798 @itemx -fdump-rtl-sched2
12799 @opindex fdump-rtl-sched1
12800 @opindex fdump-rtl-sched2
12801 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
12802 after the basic block scheduling passes.
12804 @item -fdump-rtl-ree
12805 @opindex fdump-rtl-ree
12806 Dump after sign/zero extension elimination.
12808 @item -fdump-rtl-seqabstr
12809 @opindex fdump-rtl-seqabstr
12810 Dump after common sequence discovery.
12812 @item -fdump-rtl-shorten
12813 @opindex fdump-rtl-shorten
12814 Dump after shortening branches.
12816 @item -fdump-rtl-sibling
12817 @opindex fdump-rtl-sibling
12818 Dump after sibling call optimizations.
12820 @item -fdump-rtl-split1
12821 @itemx -fdump-rtl-split2
12822 @itemx -fdump-rtl-split3
12823 @itemx -fdump-rtl-split4
12824 @itemx -fdump-rtl-split5
12825 @opindex fdump-rtl-split1
12826 @opindex fdump-rtl-split2
12827 @opindex fdump-rtl-split3
12828 @opindex fdump-rtl-split4
12829 @opindex fdump-rtl-split5
12830 These options enable dumping after five rounds of
12831 instruction splitting.
12833 @item -fdump-rtl-sms
12834 @opindex fdump-rtl-sms
12835 Dump after modulo scheduling.  This pass is only run on some
12836 architectures.
12838 @item -fdump-rtl-stack
12839 @opindex fdump-rtl-stack
12840 Dump after conversion from GCC's ``flat register file'' registers to the
12841 x87's stack-like registers.  This pass is only run on x86 variants.
12843 @item -fdump-rtl-subreg1
12844 @itemx -fdump-rtl-subreg2
12845 @opindex fdump-rtl-subreg1
12846 @opindex fdump-rtl-subreg2
12847 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
12848 the two subreg expansion passes.
12850 @item -fdump-rtl-unshare
12851 @opindex fdump-rtl-unshare
12852 Dump after all rtl has been unshared.
12854 @item -fdump-rtl-vartrack
12855 @opindex fdump-rtl-vartrack
12856 Dump after variable tracking.
12858 @item -fdump-rtl-vregs
12859 @opindex fdump-rtl-vregs
12860 Dump after converting virtual registers to hard registers.
12862 @item -fdump-rtl-web
12863 @opindex fdump-rtl-web
12864 Dump after live range splitting.
12866 @item -fdump-rtl-regclass
12867 @itemx -fdump-rtl-subregs_of_mode_init
12868 @itemx -fdump-rtl-subregs_of_mode_finish
12869 @itemx -fdump-rtl-dfinit
12870 @itemx -fdump-rtl-dfinish
12871 @opindex fdump-rtl-regclass
12872 @opindex fdump-rtl-subregs_of_mode_init
12873 @opindex fdump-rtl-subregs_of_mode_finish
12874 @opindex fdump-rtl-dfinit
12875 @opindex fdump-rtl-dfinish
12876 These dumps are defined but always produce empty files.
12878 @item -da
12879 @itemx -fdump-rtl-all
12880 @opindex da
12881 @opindex fdump-rtl-all
12882 Produce all the dumps listed above.
12884 @item -dA
12885 @opindex dA
12886 Annotate the assembler output with miscellaneous debugging information.
12888 @item -dD
12889 @opindex dD
12890 Dump all macro definitions, at the end of preprocessing, in addition to
12891 normal output.
12893 @item -dH
12894 @opindex dH
12895 Produce a core dump whenever an error occurs.
12897 @item -dp
12898 @opindex dp
12899 Annotate the assembler output with a comment indicating which
12900 pattern and alternative is used.  The length of each instruction is
12901 also printed.
12903 @item -dP
12904 @opindex dP
12905 Dump the RTL in the assembler output as a comment before each instruction.
12906 Also turns on @option{-dp} annotation.
12908 @item -dx
12909 @opindex dx
12910 Just generate RTL for a function instead of compiling it.  Usually used
12911 with @option{-fdump-rtl-expand}.
12912 @end table
12914 @item -fdump-noaddr
12915 @opindex fdump-noaddr
12916 When doing debugging dumps, suppress address output.  This makes it more
12917 feasible to use diff on debugging dumps for compiler invocations with
12918 different compiler binaries and/or different
12919 text / bss / data / heap / stack / dso start locations.
12921 @item -freport-bug
12922 @opindex freport-bug
12923 Collect and dump debug information into a temporary file if an
12924 internal compiler error (ICE) occurs.
12926 @item -fdump-unnumbered
12927 @opindex fdump-unnumbered
12928 When doing debugging dumps, suppress instruction numbers and address output.
12929 This makes it more feasible to use diff on debugging dumps for compiler
12930 invocations with different options, in particular with and without
12931 @option{-g}.
12933 @item -fdump-unnumbered-links
12934 @opindex fdump-unnumbered-links
12935 When doing debugging dumps (see @option{-d} option above), suppress
12936 instruction numbers for the links to the previous and next instructions
12937 in a sequence.
12939 @item -fdump-translation-unit @r{(C++ only)}
12940 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
12941 @opindex fdump-translation-unit
12942 Dump a representation of the tree structure for the entire translation
12943 unit to a file.  The file name is made by appending @file{.tu} to the
12944 source file name, and the file is created in the same directory as the
12945 output file.  If the @samp{-@var{options}} form is used, @var{options}
12946 controls the details of the dump as described for the
12947 @option{-fdump-tree} options.
12949 @item -fdump-class-hierarchy @r{(C++ only)}
12950 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
12951 @opindex fdump-class-hierarchy
12952 Dump a representation of each class's hierarchy and virtual function
12953 table layout to a file.  The file name is made by appending
12954 @file{.class} to the source file name, and the file is created in the
12955 same directory as the output file.  If the @samp{-@var{options}} form
12956 is used, @var{options} controls the details of the dump as described
12957 for the @option{-fdump-tree} options.
12959 @item -fdump-ipa-@var{switch}
12960 @opindex fdump-ipa
12961 Control the dumping at various stages of inter-procedural analysis
12962 language tree to a file.  The file name is generated by appending a
12963 switch specific suffix to the source file name, and the file is created
12964 in the same directory as the output file.  The following dumps are
12965 possible:
12967 @table @samp
12968 @item all
12969 Enables all inter-procedural analysis dumps.
12971 @item cgraph
12972 Dumps information about call-graph optimization, unused function removal,
12973 and inlining decisions.
12975 @item inline
12976 Dump after function inlining.
12978 @end table
12980 @item -fdump-passes
12981 @opindex fdump-passes
12982 Print on @file{stderr} the list of optimization passes that are turned
12983 on and off by the current command-line options.
12985 @item -fdump-statistics-@var{option}
12986 @opindex fdump-statistics
12987 Enable and control dumping of pass statistics in a separate file.  The
12988 file name is generated by appending a suffix ending in
12989 @samp{.statistics} to the source file name, and the file is created in
12990 the same directory as the output file.  If the @samp{-@var{option}}
12991 form is used, @samp{-stats} causes counters to be summed over the
12992 whole compilation unit while @samp{-details} dumps every event as
12993 the passes generate them.  The default with no option is to sum
12994 counters for each function compiled.
12996 @item -fdump-tree-all
12997 @itemx -fdump-tree-@var{switch}
12998 @itemx -fdump-tree-@var{switch}-@var{options}
12999 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
13000 @opindex fdump-tree-all
13001 @opindex fdump-tree
13002 Control the dumping at various stages of processing the intermediate
13003 language tree to a file.  The file name is generated by appending a
13004 switch-specific suffix to the source file name, and the file is
13005 created in the same directory as the output file. In case of
13006 @option{=@var{filename}} option, the dump is output on the given file
13007 instead of the auto named dump files.  If the @samp{-@var{options}}
13008 form is used, @var{options} is a list of @samp{-} separated options
13009 which control the details of the dump.  Not all options are applicable
13010 to all dumps; those that are not meaningful are ignored.  The
13011 following options are available
13013 @table @samp
13014 @item address
13015 Print the address of each node.  Usually this is not meaningful as it
13016 changes according to the environment and source file.  Its primary use
13017 is for tying up a dump file with a debug environment.
13018 @item asmname
13019 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
13020 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
13021 use working backward from mangled names in the assembly file.
13022 @item slim
13023 When dumping front-end intermediate representations, inhibit dumping
13024 of members of a scope or body of a function merely because that scope
13025 has been reached.  Only dump such items when they are directly reachable
13026 by some other path.
13028 When dumping pretty-printed trees, this option inhibits dumping the
13029 bodies of control structures.
13031 When dumping RTL, print the RTL in slim (condensed) form instead of
13032 the default LISP-like representation.
13033 @item raw
13034 Print a raw representation of the tree.  By default, trees are
13035 pretty-printed into a C-like representation.
13036 @item details
13037 Enable more detailed dumps (not honored by every dump option). Also
13038 include information from the optimization passes.
13039 @item stats
13040 Enable dumping various statistics about the pass (not honored by every dump
13041 option).
13042 @item blocks
13043 Enable showing basic block boundaries (disabled in raw dumps).
13044 @item graph
13045 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
13046 dump a representation of the control flow graph suitable for viewing with
13047 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
13048 the file is pretty-printed as a subgraph, so that GraphViz can render them
13049 all in a single plot.
13051 This option currently only works for RTL dumps, and the RTL is always
13052 dumped in slim form.
13053 @item vops
13054 Enable showing virtual operands for every statement.
13055 @item lineno
13056 Enable showing line numbers for statements.
13057 @item uid
13058 Enable showing the unique ID (@code{DECL_UID}) for each variable.
13059 @item verbose
13060 Enable showing the tree dump for each statement.
13061 @item eh
13062 Enable showing the EH region number holding each statement.
13063 @item scev
13064 Enable showing scalar evolution analysis details.
13065 @item optimized
13066 Enable showing optimization information (only available in certain
13067 passes).
13068 @item missed
13069 Enable showing missed optimization information (only available in certain
13070 passes).
13071 @item note
13072 Enable other detailed optimization information (only available in
13073 certain passes).
13074 @item =@var{filename}
13075 Instead of an auto named dump file, output into the given file
13076 name. The file names @file{stdout} and @file{stderr} are treated
13077 specially and are considered already open standard streams. For
13078 example,
13080 @smallexample
13081 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
13082      -fdump-tree-pre=/dev/stderr file.c
13083 @end smallexample
13085 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
13086 output on to @file{stderr}. If two conflicting dump filenames are
13087 given for the same pass, then the latter option overrides the earlier
13088 one.
13090 @item all
13091 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
13092 and @option{lineno}.
13094 @item optall
13095 Turn on all optimization options, i.e., @option{optimized},
13096 @option{missed}, and @option{note}.
13097 @end table
13099 To determine what tree dumps are available or find the dump for a pass
13100 of interest follow the steps below.
13102 @enumerate
13103 @item
13104 Invoke GCC with @option{-fdump-passes} and in the @file{stderr} output
13105 look for a code that corresponds to the pass you are interested in.
13106 For example, the codes @code{tree-evrp}, @code{tree-vrp1}, and
13107 @code{tree-vrp2} correspond to the three Value Range Propagation passes.
13108 The number at the end distinguishes distinct invocations of the same pass.
13109 @item
13110 To enable the creation of the dump file, append the pass code to
13111 the @option{-fdump-} option prefix and invoke GCC with it.  For example,
13112 to enable the dump from the Early Value Range Propagation pass, invoke
13113 GCC with the @option{-fdump-tree-evrp} option.  Optionally, you may
13114 specify the name of the dump file.  If you don't specify one, GCC
13115 creates as described below.
13116 @item
13117 Find the pass dump in a file whose name is composed of three components
13118 separated by a period: the name of the source file GCC was invoked to
13119 compile, a numeric suffix indicating the pass number followed by the
13120 letter @samp{t} for tree passes (and the letter @samp{r} for RTL passes),
13121 and finally the pass code.  For example, the Early VRP pass dump might
13122 be in a file named @file{myfile.c.038t.evrp} in the current working
13123 directory.  Note that the numeric codes are not stable and may change
13124 from one version of GCC to another.
13125 @end enumerate
13127 @item -fopt-info
13128 @itemx -fopt-info-@var{options}
13129 @itemx -fopt-info-@var{options}=@var{filename}
13130 @opindex fopt-info
13131 Controls optimization dumps from various optimization passes. If the
13132 @samp{-@var{options}} form is used, @var{options} is a list of
13133 @samp{-} separated option keywords to select the dump details and
13134 optimizations.  
13136 The @var{options} can be divided into two groups: options describing the
13137 verbosity of the dump, and options describing which optimizations
13138 should be included. The options from both the groups can be freely
13139 mixed as they are non-overlapping. However, in case of any conflicts,
13140 the later options override the earlier options on the command
13141 line. 
13143 The following options control the dump verbosity:
13145 @table @samp
13146 @item optimized
13147 Print information when an optimization is successfully applied. It is
13148 up to a pass to decide which information is relevant. For example, the
13149 vectorizer passes print the source location of loops which are
13150 successfully vectorized.
13151 @item missed
13152 Print information about missed optimizations. Individual passes
13153 control which information to include in the output. 
13154 @item note
13155 Print verbose information about optimizations, such as certain
13156 transformations, more detailed messages about decisions etc.
13157 @item all
13158 Print detailed optimization information. This includes
13159 @samp{optimized}, @samp{missed}, and @samp{note}.
13160 @end table
13162 One or more of the following option keywords can be used to describe a
13163 group of optimizations:
13165 @table @samp
13166 @item ipa
13167 Enable dumps from all interprocedural optimizations.
13168 @item loop
13169 Enable dumps from all loop optimizations.
13170 @item inline
13171 Enable dumps from all inlining optimizations.
13172 @item omp
13173 Enable dumps from all OMP (Offloading and Multi Processing) optimizations.
13174 @item vec
13175 Enable dumps from all vectorization optimizations.
13176 @item optall
13177 Enable dumps from all optimizations. This is a superset of
13178 the optimization groups listed above.
13179 @end table
13181 If @var{options} is
13182 omitted, it defaults to @samp{optimized-optall}, which means to dump all
13183 info about successful optimizations from all the passes.  
13185 If the @var{filename} is provided, then the dumps from all the
13186 applicable optimizations are concatenated into the @var{filename}.
13187 Otherwise the dump is output onto @file{stderr}. Though multiple
13188 @option{-fopt-info} options are accepted, only one of them can include
13189 a @var{filename}. If other filenames are provided then all but the
13190 first such option are ignored.
13192 Note that the output @var{filename} is overwritten
13193 in case of multiple translation units. If a combined output from
13194 multiple translation units is desired, @file{stderr} should be used
13195 instead.
13197 In the following example, the optimization info is output to
13198 @file{stderr}:
13200 @smallexample
13201 gcc -O3 -fopt-info
13202 @end smallexample
13204 This example:
13205 @smallexample
13206 gcc -O3 -fopt-info-missed=missed.all
13207 @end smallexample
13209 @noindent
13210 outputs missed optimization report from all the passes into
13211 @file{missed.all}, and this one:
13213 @smallexample
13214 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
13215 @end smallexample
13217 @noindent
13218 prints information about missed optimization opportunities from
13219 vectorization passes on @file{stderr}.  
13220 Note that @option{-fopt-info-vec-missed} is equivalent to 
13221 @option{-fopt-info-missed-vec}.
13223 As another example,
13224 @smallexample
13225 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
13226 @end smallexample
13228 @noindent
13229 outputs information about missed optimizations as well as
13230 optimized locations from all the inlining passes into
13231 @file{inline.txt}.
13233 Finally, consider:
13235 @smallexample
13236 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
13237 @end smallexample
13239 @noindent
13240 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
13241 in conflict since only one output file is allowed. In this case, only
13242 the first option takes effect and the subsequent options are
13243 ignored. Thus only @file{vec.miss} is produced which contains
13244 dumps from the vectorizer about missed opportunities.
13246 @item -fsched-verbose=@var{n}
13247 @opindex fsched-verbose
13248 On targets that use instruction scheduling, this option controls the
13249 amount of debugging output the scheduler prints to the dump files.
13251 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
13252 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
13253 For @var{n} greater than one, it also output basic block probabilities,
13254 detailed ready list information and unit/insn info.  For @var{n} greater
13255 than two, it includes RTL at abort point, control-flow and regions info.
13256 And for @var{n} over four, @option{-fsched-verbose} also includes
13257 dependence info.
13261 @item -fenable-@var{kind}-@var{pass}
13262 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
13263 @opindex fdisable-
13264 @opindex fenable-
13266 This is a set of options that are used to explicitly disable/enable
13267 optimization passes.  These options are intended for use for debugging GCC.
13268 Compiler users should use regular options for enabling/disabling
13269 passes instead.
13271 @table @gcctabopt
13273 @item -fdisable-ipa-@var{pass}
13274 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
13275 statically invoked in the compiler multiple times, the pass name should be
13276 appended with a sequential number starting from 1.
13278 @item -fdisable-rtl-@var{pass}
13279 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
13280 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
13281 statically invoked in the compiler multiple times, the pass name should be
13282 appended with a sequential number starting from 1.  @var{range-list} is a 
13283 comma-separated list of function ranges or assembler names.  Each range is a number
13284 pair separated by a colon.  The range is inclusive in both ends.  If the range
13285 is trivial, the number pair can be simplified as a single number.  If the
13286 function's call graph node's @var{uid} falls within one of the specified ranges,
13287 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
13288 function header of a dump file, and the pass names can be dumped by using
13289 option @option{-fdump-passes}.
13291 @item -fdisable-tree-@var{pass}
13292 @itemx -fdisable-tree-@var{pass}=@var{range-list}
13293 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
13294 option arguments.
13296 @item -fenable-ipa-@var{pass}
13297 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
13298 statically invoked in the compiler multiple times, the pass name should be
13299 appended with a sequential number starting from 1.
13301 @item -fenable-rtl-@var{pass}
13302 @itemx -fenable-rtl-@var{pass}=@var{range-list}
13303 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
13304 description and examples.
13306 @item -fenable-tree-@var{pass}
13307 @itemx -fenable-tree-@var{pass}=@var{range-list}
13308 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
13309 of option arguments.
13311 @end table
13313 Here are some examples showing uses of these options.
13315 @smallexample
13317 # disable ccp1 for all functions
13318    -fdisable-tree-ccp1
13319 # disable complete unroll for function whose cgraph node uid is 1
13320    -fenable-tree-cunroll=1
13321 # disable gcse2 for functions at the following ranges [1,1],
13322 # [300,400], and [400,1000]
13323 # disable gcse2 for functions foo and foo2
13324    -fdisable-rtl-gcse2=foo,foo2
13325 # disable early inlining
13326    -fdisable-tree-einline
13327 # disable ipa inlining
13328    -fdisable-ipa-inline
13329 # enable tree full unroll
13330    -fenable-tree-unroll
13332 @end smallexample
13334 @item -fchecking
13335 @itemx -fchecking=@var{n}
13336 @opindex fchecking
13337 @opindex fno-checking
13338 Enable internal consistency checking.  The default depends on
13339 the compiler configuration.  @option{-fchecking=2} enables further
13340 internal consistency checking that might affect code generation.
13342 @item -frandom-seed=@var{string}
13343 @opindex frandom-seed
13344 This option provides a seed that GCC uses in place of
13345 random numbers in generating certain symbol names
13346 that have to be different in every compiled file.  It is also used to
13347 place unique stamps in coverage data files and the object files that
13348 produce them.  You can use the @option{-frandom-seed} option to produce
13349 reproducibly identical object files.
13351 The @var{string} can either be a number (decimal, octal or hex) or an
13352 arbitrary string (in which case it's converted to a number by
13353 computing CRC32).
13355 The @var{string} should be different for every file you compile.
13357 @item -save-temps
13358 @itemx -save-temps=cwd
13359 @opindex save-temps
13360 Store the usual ``temporary'' intermediate files permanently; place them
13361 in the current directory and name them based on the source file.  Thus,
13362 compiling @file{foo.c} with @option{-c -save-temps} produces files
13363 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
13364 preprocessed @file{foo.i} output file even though the compiler now
13365 normally uses an integrated preprocessor.
13367 When used in combination with the @option{-x} command-line option,
13368 @option{-save-temps} is sensible enough to avoid over writing an
13369 input source file with the same extension as an intermediate file.
13370 The corresponding intermediate file may be obtained by renaming the
13371 source file before using @option{-save-temps}.
13373 If you invoke GCC in parallel, compiling several different source
13374 files that share a common base name in different subdirectories or the
13375 same source file compiled for multiple output destinations, it is
13376 likely that the different parallel compilers will interfere with each
13377 other, and overwrite the temporary files.  For instance:
13379 @smallexample
13380 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
13381 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
13382 @end smallexample
13384 may result in @file{foo.i} and @file{foo.o} being written to
13385 simultaneously by both compilers.
13387 @item -save-temps=obj
13388 @opindex save-temps=obj
13389 Store the usual ``temporary'' intermediate files permanently.  If the
13390 @option{-o} option is used, the temporary files are based on the
13391 object file.  If the @option{-o} option is not used, the
13392 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
13394 For example:
13396 @smallexample
13397 gcc -save-temps=obj -c foo.c
13398 gcc -save-temps=obj -c bar.c -o dir/xbar.o
13399 gcc -save-temps=obj foobar.c -o dir2/yfoobar
13400 @end smallexample
13402 @noindent
13403 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
13404 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
13405 @file{dir2/yfoobar.o}.
13407 @item -time@r{[}=@var{file}@r{]}
13408 @opindex time
13409 Report the CPU time taken by each subprocess in the compilation
13410 sequence.  For C source files, this is the compiler proper and assembler
13411 (plus the linker if linking is done).
13413 Without the specification of an output file, the output looks like this:
13415 @smallexample
13416 # cc1 0.12 0.01
13417 # as 0.00 0.01
13418 @end smallexample
13420 The first number on each line is the ``user time'', that is time spent
13421 executing the program itself.  The second number is ``system time'',
13422 time spent executing operating system routines on behalf of the program.
13423 Both numbers are in seconds.
13425 With the specification of an output file, the output is appended to the
13426 named file, and it looks like this:
13428 @smallexample
13429 0.12 0.01 cc1 @var{options}
13430 0.00 0.01 as @var{options}
13431 @end smallexample
13433 The ``user time'' and the ``system time'' are moved before the program
13434 name, and the options passed to the program are displayed, so that one
13435 can later tell what file was being compiled, and with which options.
13437 @item -fdump-final-insns@r{[}=@var{file}@r{]}
13438 @opindex fdump-final-insns
13439 Dump the final internal representation (RTL) to @var{file}.  If the
13440 optional argument is omitted (or if @var{file} is @code{.}), the name
13441 of the dump file is determined by appending @code{.gkd} to the
13442 compilation output file name.
13444 @item -fcompare-debug@r{[}=@var{opts}@r{]}
13445 @opindex fcompare-debug
13446 @opindex fno-compare-debug
13447 If no error occurs during compilation, run the compiler a second time,
13448 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
13449 passed to the second compilation.  Dump the final internal
13450 representation in both compilations, and print an error if they differ.
13452 If the equal sign is omitted, the default @option{-gtoggle} is used.
13454 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
13455 and nonzero, implicitly enables @option{-fcompare-debug}.  If
13456 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
13457 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
13458 is used.
13460 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
13461 is equivalent to @option{-fno-compare-debug}, which disables the dumping
13462 of the final representation and the second compilation, preventing even
13463 @env{GCC_COMPARE_DEBUG} from taking effect.
13465 To verify full coverage during @option{-fcompare-debug} testing, set
13466 @env{GCC_COMPARE_DEBUG} to say @option{-fcompare-debug-not-overridden},
13467 which GCC rejects as an invalid option in any actual compilation
13468 (rather than preprocessing, assembly or linking).  To get just a
13469 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
13470 not overridden} will do.
13472 @item -fcompare-debug-second
13473 @opindex fcompare-debug-second
13474 This option is implicitly passed to the compiler for the second
13475 compilation requested by @option{-fcompare-debug}, along with options to
13476 silence warnings, and omitting other options that would cause
13477 side-effect compiler outputs to files or to the standard output.  Dump
13478 files and preserved temporary files are renamed so as to contain the
13479 @code{.gk} additional extension during the second compilation, to avoid
13480 overwriting those generated by the first.
13482 When this option is passed to the compiler driver, it causes the
13483 @emph{first} compilation to be skipped, which makes it useful for little
13484 other than debugging the compiler proper.
13486 @item -gtoggle
13487 @opindex gtoggle
13488 Turn off generation of debug info, if leaving out this option
13489 generates it, or turn it on at level 2 otherwise.  The position of this
13490 argument in the command line does not matter; it takes effect after all
13491 other options are processed, and it does so only once, no matter how
13492 many times it is given.  This is mainly intended to be used with
13493 @option{-fcompare-debug}.
13495 @item -fvar-tracking-assignments-toggle
13496 @opindex fvar-tracking-assignments-toggle
13497 @opindex fno-var-tracking-assignments-toggle
13498 Toggle @option{-fvar-tracking-assignments}, in the same way that
13499 @option{-gtoggle} toggles @option{-g}.
13501 @item -Q
13502 @opindex Q
13503 Makes the compiler print out each function name as it is compiled, and
13504 print some statistics about each pass when it finishes.
13506 @item -ftime-report
13507 @opindex ftime-report
13508 Makes the compiler print some statistics about the time consumed by each
13509 pass when it finishes.
13511 @item -ftime-report-details
13512 @opindex ftime-report-details
13513 Record the time consumed by infrastructure parts separately for each pass.
13515 @item -fira-verbose=@var{n}
13516 @opindex fira-verbose
13517 Control the verbosity of the dump file for the integrated register allocator.
13518 The default value is 5.  If the value @var{n} is greater or equal to 10,
13519 the dump output is sent to stderr using the same format as @var{n} minus 10.
13521 @item -flto-report
13522 @opindex flto-report
13523 Prints a report with internal details on the workings of the link-time
13524 optimizer.  The contents of this report vary from version to version.
13525 It is meant to be useful to GCC developers when processing object
13526 files in LTO mode (via @option{-flto}).
13528 Disabled by default.
13530 @item -flto-report-wpa
13531 @opindex flto-report-wpa
13532 Like @option{-flto-report}, but only print for the WPA phase of Link
13533 Time Optimization.
13535 @item -fmem-report
13536 @opindex fmem-report
13537 Makes the compiler print some statistics about permanent memory
13538 allocation when it finishes.
13540 @item -fmem-report-wpa
13541 @opindex fmem-report-wpa
13542 Makes the compiler print some statistics about permanent memory
13543 allocation for the WPA phase only.
13545 @item -fpre-ipa-mem-report
13546 @opindex fpre-ipa-mem-report
13547 @item -fpost-ipa-mem-report
13548 @opindex fpost-ipa-mem-report
13549 Makes the compiler print some statistics about permanent memory
13550 allocation before or after interprocedural optimization.
13552 @item -fprofile-report
13553 @opindex fprofile-report
13554 Makes the compiler print some statistics about consistency of the
13555 (estimated) profile and effect of individual passes.
13557 @item -fstack-usage
13558 @opindex fstack-usage
13559 Makes the compiler output stack usage information for the program, on a
13560 per-function basis.  The filename for the dump is made by appending
13561 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
13562 the output file, if explicitly specified and it is not an executable,
13563 otherwise it is the basename of the source file.  An entry is made up
13564 of three fields:
13566 @itemize
13567 @item
13568 The name of the function.
13569 @item
13570 A number of bytes.
13571 @item
13572 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
13573 @end itemize
13575 The qualifier @code{static} means that the function manipulates the stack
13576 statically: a fixed number of bytes are allocated for the frame on function
13577 entry and released on function exit; no stack adjustments are otherwise made
13578 in the function.  The second field is this fixed number of bytes.
13580 The qualifier @code{dynamic} means that the function manipulates the stack
13581 dynamically: in addition to the static allocation described above, stack
13582 adjustments are made in the body of the function, for example to push/pop
13583 arguments around function calls.  If the qualifier @code{bounded} is also
13584 present, the amount of these adjustments is bounded at compile time and
13585 the second field is an upper bound of the total amount of stack used by
13586 the function.  If it is not present, the amount of these adjustments is
13587 not bounded at compile time and the second field only represents the
13588 bounded part.
13590 @item -fstats
13591 @opindex fstats
13592 Emit statistics about front-end processing at the end of the compilation.
13593 This option is supported only by the C++ front end, and
13594 the information is generally only useful to the G++ development team.
13596 @item -fdbg-cnt-list
13597 @opindex fdbg-cnt-list
13598 Print the name and the counter upper bound for all debug counters.
13601 @item -fdbg-cnt=@var{counter-value-list}
13602 @opindex fdbg-cnt
13603 Set the internal debug counter upper bound.  @var{counter-value-list}
13604 is a comma-separated list of @var{name}:@var{value} pairs
13605 which sets the upper bound of each debug counter @var{name} to @var{value}.
13606 All debug counters have the initial upper bound of @code{UINT_MAX};
13607 thus @code{dbg_cnt} returns true always unless the upper bound
13608 is set by this option.
13609 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
13610 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
13612 @item -print-file-name=@var{library}
13613 @opindex print-file-name
13614 Print the full absolute name of the library file @var{library} that
13615 would be used when linking---and don't do anything else.  With this
13616 option, GCC does not compile or link anything; it just prints the
13617 file name.
13619 @item -print-multi-directory
13620 @opindex print-multi-directory
13621 Print the directory name corresponding to the multilib selected by any
13622 other switches present in the command line.  This directory is supposed
13623 to exist in @env{GCC_EXEC_PREFIX}.
13625 @item -print-multi-lib
13626 @opindex print-multi-lib
13627 Print the mapping from multilib directory names to compiler switches
13628 that enable them.  The directory name is separated from the switches by
13629 @samp{;}, and each switch starts with an @samp{@@} instead of the
13630 @samp{-}, without spaces between multiple switches.  This is supposed to
13631 ease shell processing.
13633 @item -print-multi-os-directory
13634 @opindex print-multi-os-directory
13635 Print the path to OS libraries for the selected
13636 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
13637 present in the @file{lib} subdirectory and no multilibs are used, this is
13638 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
13639 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
13640 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
13641 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
13643 @item -print-multiarch
13644 @opindex print-multiarch
13645 Print the path to OS libraries for the selected multiarch,
13646 relative to some @file{lib} subdirectory.
13648 @item -print-prog-name=@var{program}
13649 @opindex print-prog-name
13650 Like @option{-print-file-name}, but searches for a program such as @command{cpp}.
13652 @item -print-libgcc-file-name
13653 @opindex print-libgcc-file-name
13654 Same as @option{-print-file-name=libgcc.a}.
13656 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
13657 but you do want to link with @file{libgcc.a}.  You can do:
13659 @smallexample
13660 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
13661 @end smallexample
13663 @item -print-search-dirs
13664 @opindex print-search-dirs
13665 Print the name of the configured installation directory and a list of
13666 program and library directories @command{gcc} searches---and don't do anything else.
13668 This is useful when @command{gcc} prints the error message
13669 @samp{installation problem, cannot exec cpp0: No such file or directory}.
13670 To resolve this you either need to put @file{cpp0} and the other compiler
13671 components where @command{gcc} expects to find them, or you can set the environment
13672 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
13673 Don't forget the trailing @samp{/}.
13674 @xref{Environment Variables}.
13676 @item -print-sysroot
13677 @opindex print-sysroot
13678 Print the target sysroot directory that is used during
13679 compilation.  This is the target sysroot specified either at configure
13680 time or using the @option{--sysroot} option, possibly with an extra
13681 suffix that depends on compilation options.  If no target sysroot is
13682 specified, the option prints nothing.
13684 @item -print-sysroot-headers-suffix
13685 @opindex print-sysroot-headers-suffix
13686 Print the suffix added to the target sysroot when searching for
13687 headers, or give an error if the compiler is not configured with such
13688 a suffix---and don't do anything else.
13690 @item -dumpmachine
13691 @opindex dumpmachine
13692 Print the compiler's target machine (for example,
13693 @samp{i686-pc-linux-gnu})---and don't do anything else.
13695 @item -dumpversion
13696 @opindex dumpversion
13697 Print the compiler version (for example, @code{3.0}, @code{6.3.0} or @code{7})---and don't do
13698 anything else.  This is the compiler version used in filesystem paths,
13699 specs, can be depending on how the compiler has been configured just
13700 a single number (major version), two numbers separated by dot (major and
13701 minor version) or three numbers separated by dots (major, minor and patchlevel
13702 version).
13704 @item -dumpfullversion
13705 @opindex dumpfullversion
13706 Print the full compiler version, always 3 numbers separated by dots,
13707 major, minor and patchlevel version.
13709 @item -dumpspecs
13710 @opindex dumpspecs
13711 Print the compiler's built-in specs---and don't do anything else.  (This
13712 is used when GCC itself is being built.)  @xref{Spec Files}.
13713 @end table
13715 @node Submodel Options
13716 @section Machine-Dependent Options
13717 @cindex submodel options
13718 @cindex specifying hardware config
13719 @cindex hardware models and configurations, specifying
13720 @cindex target-dependent options
13721 @cindex machine-dependent options
13723 Each target machine supported by GCC can have its own options---for
13724 example, to allow you to compile for a particular processor variant or
13725 ABI, or to control optimizations specific to that machine.  By
13726 convention, the names of machine-specific options start with
13727 @samp{-m}.
13729 Some configurations of the compiler also support additional target-specific
13730 options, usually for compatibility with other compilers on the same
13731 platform.
13733 @c This list is ordered alphanumerically by subsection name.
13734 @c It should be the same order and spelling as these options are listed
13735 @c in Machine Dependent Options
13737 @menu
13738 * AArch64 Options::
13739 * Adapteva Epiphany Options::
13740 * ARC Options::
13741 * ARM Options::
13742 * AVR Options::
13743 * Blackfin Options::
13744 * C6X Options::
13745 * CRIS Options::
13746 * CR16 Options::
13747 * Darwin Options::
13748 * DEC Alpha Options::
13749 * FR30 Options::
13750 * FT32 Options::
13751 * FRV Options::
13752 * GNU/Linux Options::
13753 * H8/300 Options::
13754 * HPPA Options::
13755 * IA-64 Options::
13756 * LM32 Options::
13757 * M32C Options::
13758 * M32R/D Options::
13759 * M680x0 Options::
13760 * MCore Options::
13761 * MeP Options::
13762 * MicroBlaze Options::
13763 * MIPS Options::
13764 * MMIX Options::
13765 * MN10300 Options::
13766 * Moxie Options::
13767 * MSP430 Options::
13768 * NDS32 Options::
13769 * Nios II Options::
13770 * Nvidia PTX Options::
13771 * PDP-11 Options::
13772 * picoChip Options::
13773 * PowerPC Options::
13774 * RISC-V Options::
13775 * RL78 Options::
13776 * RS/6000 and PowerPC Options::
13777 * RX Options::
13778 * S/390 and zSeries Options::
13779 * Score Options::
13780 * SH Options::
13781 * Solaris 2 Options::
13782 * SPARC Options::
13783 * SPU Options::
13784 * System V Options::
13785 * TILE-Gx Options::
13786 * TILEPro Options::
13787 * V850 Options::
13788 * VAX Options::
13789 * Visium Options::
13790 * VMS Options::
13791 * VxWorks Options::
13792 * x86 Options::
13793 * x86 Windows Options::
13794 * Xstormy16 Options::
13795 * Xtensa Options::
13796 * zSeries Options::
13797 @end menu
13799 @node AArch64 Options
13800 @subsection AArch64 Options
13801 @cindex AArch64 Options
13803 These options are defined for AArch64 implementations:
13805 @table @gcctabopt
13807 @item -mabi=@var{name}
13808 @opindex mabi
13809 Generate code for the specified data model.  Permissible values
13810 are @samp{ilp32} for SysV-like data model where int, long int and pointers
13811 are 32 bits, and @samp{lp64} for SysV-like data model where int is 32 bits,
13812 but long int and pointers are 64 bits.
13814 The default depends on the specific target configuration.  Note that
13815 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
13816 entire program with the same ABI, and link with a compatible set of libraries.
13818 @item -mbig-endian
13819 @opindex mbig-endian
13820 Generate big-endian code.  This is the default when GCC is configured for an
13821 @samp{aarch64_be-*-*} target.
13823 @item -mgeneral-regs-only
13824 @opindex mgeneral-regs-only
13825 Generate code which uses only the general-purpose registers.  This will prevent
13826 the compiler from using floating-point and Advanced SIMD registers but will not
13827 impose any restrictions on the assembler.
13829 @item -mlittle-endian
13830 @opindex mlittle-endian
13831 Generate little-endian code.  This is the default when GCC is configured for an
13832 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
13834 @item -mcmodel=tiny
13835 @opindex mcmodel=tiny
13836 Generate code for the tiny code model.  The program and its statically defined
13837 symbols must be within 1MB of each other.  Programs can be statically or
13838 dynamically linked.
13840 @item -mcmodel=small
13841 @opindex mcmodel=small
13842 Generate code for the small code model.  The program and its statically defined
13843 symbols must be within 4GB of each other.  Programs can be statically or
13844 dynamically linked.  This is the default code model.
13846 @item -mcmodel=large
13847 @opindex mcmodel=large
13848 Generate code for the large code model.  This makes no assumptions about
13849 addresses and sizes of sections.  Programs can be statically linked only.
13851 @item -mstrict-align
13852 @opindex mstrict-align
13853 Avoid generating memory accesses that may not be aligned on a natural object
13854 boundary as described in the architecture specification.
13856 @item -momit-leaf-frame-pointer
13857 @itemx -mno-omit-leaf-frame-pointer
13858 @opindex momit-leaf-frame-pointer
13859 @opindex mno-omit-leaf-frame-pointer
13860 Omit or keep the frame pointer in leaf functions.  The former behavior is the
13861 default.
13863 @item -mtls-dialect=desc
13864 @opindex mtls-dialect=desc
13865 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
13866 of TLS variables.  This is the default.
13868 @item -mtls-dialect=traditional
13869 @opindex mtls-dialect=traditional
13870 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
13871 of TLS variables.
13873 @item -mtls-size=@var{size}
13874 @opindex mtls-size
13875 Specify bit size of immediate TLS offsets.  Valid values are 12, 24, 32, 48.
13876 This option requires binutils 2.26 or newer.
13878 @item -mfix-cortex-a53-835769
13879 @itemx -mno-fix-cortex-a53-835769
13880 @opindex mfix-cortex-a53-835769
13881 @opindex mno-fix-cortex-a53-835769
13882 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
13883 This involves inserting a NOP instruction between memory instructions and
13884 64-bit integer multiply-accumulate instructions.
13886 @item -mfix-cortex-a53-843419
13887 @itemx -mno-fix-cortex-a53-843419
13888 @opindex mfix-cortex-a53-843419
13889 @opindex mno-fix-cortex-a53-843419
13890 Enable or disable the workaround for the ARM Cortex-A53 erratum number 843419.
13891 This erratum workaround is made at link time and this will only pass the
13892 corresponding flag to the linker.
13894 @item -mlow-precision-recip-sqrt
13895 @item -mno-low-precision-recip-sqrt
13896 @opindex mlow-precision-recip-sqrt
13897 @opindex mno-low-precision-recip-sqrt
13898 Enable or disable the reciprocal square root approximation.
13899 This option only has an effect if @option{-ffast-math} or
13900 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
13901 precision of reciprocal square root results to about 16 bits for
13902 single precision and to 32 bits for double precision.
13904 @item -mlow-precision-sqrt
13905 @item -mno-low-precision-sqrt
13906 @opindex -mlow-precision-sqrt
13907 @opindex -mno-low-precision-sqrt
13908 Enable or disable the square root approximation.
13909 This option only has an effect if @option{-ffast-math} or
13910 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
13911 precision of square root results to about 16 bits for
13912 single precision and to 32 bits for double precision.
13913 If enabled, it implies @option{-mlow-precision-recip-sqrt}.
13915 @item -mlow-precision-div
13916 @item -mno-low-precision-div
13917 @opindex -mlow-precision-div
13918 @opindex -mno-low-precision-div
13919 Enable or disable the division approximation.
13920 This option only has an effect if @option{-ffast-math} or
13921 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
13922 precision of division results to about 16 bits for
13923 single precision and to 32 bits for double precision.
13925 @item -march=@var{name}
13926 @opindex march
13927 Specify the name of the target architecture and, optionally, one or
13928 more feature modifiers.  This option has the form
13929 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}.
13931 The permissible values for @var{arch} are @samp{armv8-a},
13932 @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a} or @var{native}.
13934 The value @samp{armv8.3-a} implies @samp{armv8.2-a} and enables compiler
13935 support for the ARMv8.3-A architecture extensions.
13937 The value @samp{armv8.2-a} implies @samp{armv8.1-a} and enables compiler
13938 support for the ARMv8.2-A architecture extensions.
13940 The value @samp{armv8.1-a} implies @samp{armv8-a} and enables compiler
13941 support for the ARMv8.1-A architecture extension.  In particular, it
13942 enables the @samp{+crc} and @samp{+lse} features.
13944 The value @samp{native} is available on native AArch64 GNU/Linux and
13945 causes the compiler to pick the architecture of the host system.  This
13946 option has no effect if the compiler is unable to recognize the
13947 architecture of the host system,
13949 The permissible values for @var{feature} are listed in the sub-section
13950 on @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
13951 Feature Modifiers}.  Where conflicting feature modifiers are
13952 specified, the right-most feature is used.
13954 GCC uses @var{name} to determine what kind of instructions it can emit
13955 when generating assembly code.  If @option{-march} is specified
13956 without either of @option{-mtune} or @option{-mcpu} also being
13957 specified, the code is tuned to perform well across a range of target
13958 processors implementing the target architecture.
13960 @item -mtune=@var{name}
13961 @opindex mtune
13962 Specify the name of the target processor for which GCC should tune the
13963 performance of the code.  Permissible values for this option are:
13964 @samp{generic}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a57},
13965 @samp{cortex-a72}, @samp{cortex-a73}, @samp{exynos-m1}, @samp{falkor},
13966 @samp{qdf24xx}, @samp{xgene1}, @samp{vulcan}, @samp{thunderx},
13967 @samp{thunderxt88}, @samp{thunderxt88p1}, @samp{thunderxt81},
13968 @samp{thunderxt83}, @samp{thunderx2t99}, @samp{cortex-a57.cortex-a53},
13969 @samp{cortex-a72.cortex-a53}, @samp{cortex-a73.cortex-a35},
13970 @samp{cortex-a73.cortex-a53}, @samp{native}.
13972 The values @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
13973 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53}
13974 specify that GCC should tune for a big.LITTLE system.
13976 Additionally on native AArch64 GNU/Linux systems the value
13977 @samp{native} tunes performance to the host system.  This option has no effect
13978 if the compiler is unable to recognize the processor of the host system.
13980 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
13981 are specified, the code is tuned to perform well across a range
13982 of target processors.
13984 This option cannot be suffixed by feature modifiers.
13986 @item -mcpu=@var{name}
13987 @opindex mcpu
13988 Specify the name of the target processor, optionally suffixed by one
13989 or more feature modifiers.  This option has the form
13990 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where
13991 the permissible values for @var{cpu} are the same as those available
13992 for @option{-mtune}.  The permissible values for @var{feature} are
13993 documented in the sub-section on
13994 @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
13995 Feature Modifiers}.  Where conflicting feature modifiers are
13996 specified, the right-most feature is used.
13998 GCC uses @var{name} to determine what kind of instructions it can emit when
13999 generating assembly code (as if by @option{-march}) and to determine
14000 the target processor for which to tune for performance (as if
14001 by @option{-mtune}).  Where this option is used in conjunction
14002 with @option{-march} or @option{-mtune}, those options take precedence
14003 over the appropriate part of this option.
14005 @item -moverride=@var{string}
14006 @opindex moverride
14007 Override tuning decisions made by the back-end in response to a
14008 @option{-mtune=} switch.  The syntax, semantics, and accepted values
14009 for @var{string} in this option are not guaranteed to be consistent
14010 across releases.
14012 This option is only intended to be useful when developing GCC.
14014 @item -mpc-relative-literal-loads
14015 @opindex mpc-relative-literal-loads
14016 Enable PC-relative literal loads.  With this option literal pools are
14017 accessed using a single instruction and emitted after each function.  This
14018 limits the maximum size of functions to 1MB.  This is enabled by default for
14019 @option{-mcmodel=tiny}.
14021 @item -msign-return-address=@var{scope}
14022 @opindex msign-return-address
14023 Select the function scope on which return address signing will be applied.
14024 Permissible values are @samp{none}, which disables return address signing,
14025 @samp{non-leaf}, which enables pointer signing for functions which are not leaf
14026 functions, and @samp{all}, which enables pointer signing for all functions.  The
14027 default value is @samp{none}.
14029 @end table
14031 @subsubsection @option{-march} and @option{-mcpu} Feature Modifiers
14032 @anchor{aarch64-feature-modifiers}
14033 @cindex @option{-march} feature modifiers
14034 @cindex @option{-mcpu} feature modifiers
14035 Feature modifiers used with @option{-march} and @option{-mcpu} can be any of
14036 the following and their inverses @option{no@var{feature}}:
14038 @table @samp
14039 @item crc
14040 Enable CRC extension.  This is on by default for
14041 @option{-march=armv8.1-a}.
14042 @item crypto
14043 Enable Crypto extension.  This also enables Advanced SIMD and floating-point
14044 instructions.
14045 @item fp
14046 Enable floating-point instructions.  This is on by default for all possible
14047 values for options @option{-march} and @option{-mcpu}.
14048 @item simd
14049 Enable Advanced SIMD instructions.  This also enables floating-point
14050 instructions.  This is on by default for all possible values for options
14051 @option{-march} and @option{-mcpu}.
14052 @item lse
14053 Enable Large System Extension instructions.  This is on by default for
14054 @option{-march=armv8.1-a}.
14055 @item fp16
14056 Enable FP16 extension.  This also enables floating-point instructions.
14058 @end table
14060 Feature @option{crypto} implies @option{simd}, which implies @option{fp}.
14061 Conversely, @option{nofp} implies @option{nosimd}, which implies
14062 @option{nocrypto}.
14064 @node Adapteva Epiphany Options
14065 @subsection Adapteva Epiphany Options
14067 These @samp{-m} options are defined for Adapteva Epiphany:
14069 @table @gcctabopt
14070 @item -mhalf-reg-file
14071 @opindex mhalf-reg-file
14072 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
14073 That allows code to run on hardware variants that lack these registers.
14075 @item -mprefer-short-insn-regs
14076 @opindex mprefer-short-insn-regs
14077 Preferentially allocate registers that allow short instruction generation.
14078 This can result in increased instruction count, so this may either reduce or
14079 increase overall code size.
14081 @item -mbranch-cost=@var{num}
14082 @opindex mbranch-cost
14083 Set the cost of branches to roughly @var{num} ``simple'' instructions.
14084 This cost is only a heuristic and is not guaranteed to produce
14085 consistent results across releases.
14087 @item -mcmove
14088 @opindex mcmove
14089 Enable the generation of conditional moves.
14091 @item -mnops=@var{num}
14092 @opindex mnops
14093 Emit @var{num} NOPs before every other generated instruction.
14095 @item -mno-soft-cmpsf
14096 @opindex mno-soft-cmpsf
14097 For single-precision floating-point comparisons, emit an @code{fsub} instruction
14098 and test the flags.  This is faster than a software comparison, but can
14099 get incorrect results in the presence of NaNs, or when two different small
14100 numbers are compared such that their difference is calculated as zero.
14101 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
14102 software comparisons.
14104 @item -mstack-offset=@var{num}
14105 @opindex mstack-offset
14106 Set the offset between the top of the stack and the stack pointer.
14107 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
14108 can be used by leaf functions without stack allocation.
14109 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
14110 Note also that this option changes the ABI; compiling a program with a
14111 different stack offset than the libraries have been compiled with
14112 generally does not work.
14113 This option can be useful if you want to evaluate if a different stack
14114 offset would give you better code, but to actually use a different stack
14115 offset to build working programs, it is recommended to configure the
14116 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
14118 @item -mno-round-nearest
14119 @opindex mno-round-nearest
14120 Make the scheduler assume that the rounding mode has been set to
14121 truncating.  The default is @option{-mround-nearest}.
14123 @item -mlong-calls
14124 @opindex mlong-calls
14125 If not otherwise specified by an attribute, assume all calls might be beyond
14126 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
14127 function address into a register before performing a (otherwise direct) call.
14128 This is the default.
14130 @item -mshort-calls
14131 @opindex short-calls
14132 If not otherwise specified by an attribute, assume all direct calls are
14133 in the range of the @code{b} / @code{bl} instructions, so use these instructions
14134 for direct calls.  The default is @option{-mlong-calls}.
14136 @item -msmall16
14137 @opindex msmall16
14138 Assume addresses can be loaded as 16-bit unsigned values.  This does not
14139 apply to function addresses for which @option{-mlong-calls} semantics
14140 are in effect.
14142 @item -mfp-mode=@var{mode}
14143 @opindex mfp-mode
14144 Set the prevailing mode of the floating-point unit.
14145 This determines the floating-point mode that is provided and expected
14146 at function call and return time.  Making this mode match the mode you
14147 predominantly need at function start can make your programs smaller and
14148 faster by avoiding unnecessary mode switches.
14150 @var{mode} can be set to one the following values:
14152 @table @samp
14153 @item caller
14154 Any mode at function entry is valid, and retained or restored when
14155 the function returns, and when it calls other functions.
14156 This mode is useful for compiling libraries or other compilation units
14157 you might want to incorporate into different programs with different
14158 prevailing FPU modes, and the convenience of being able to use a single
14159 object file outweighs the size and speed overhead for any extra
14160 mode switching that might be needed, compared with what would be needed
14161 with a more specific choice of prevailing FPU mode.
14163 @item truncate
14164 This is the mode used for floating-point calculations with
14165 truncating (i.e.@: round towards zero) rounding mode.  That includes
14166 conversion from floating point to integer.
14168 @item round-nearest
14169 This is the mode used for floating-point calculations with
14170 round-to-nearest-or-even rounding mode.
14172 @item int
14173 This is the mode used to perform integer calculations in the FPU, e.g.@:
14174 integer multiply, or integer multiply-and-accumulate.
14175 @end table
14177 The default is @option{-mfp-mode=caller}
14179 @item -mnosplit-lohi
14180 @itemx -mno-postinc
14181 @itemx -mno-postmodify
14182 @opindex mnosplit-lohi
14183 @opindex mno-postinc
14184 @opindex mno-postmodify
14185 Code generation tweaks that disable, respectively, splitting of 32-bit
14186 loads, generation of post-increment addresses, and generation of
14187 post-modify addresses.  The defaults are @option{msplit-lohi},
14188 @option{-mpost-inc}, and @option{-mpost-modify}.
14190 @item -mnovect-double
14191 @opindex mno-vect-double
14192 Change the preferred SIMD mode to SImode.  The default is
14193 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
14195 @item -max-vect-align=@var{num}
14196 @opindex max-vect-align
14197 The maximum alignment for SIMD vector mode types.
14198 @var{num} may be 4 or 8.  The default is 8.
14199 Note that this is an ABI change, even though many library function
14200 interfaces are unaffected if they don't use SIMD vector modes
14201 in places that affect size and/or alignment of relevant types.
14203 @item -msplit-vecmove-early
14204 @opindex msplit-vecmove-early
14205 Split vector moves into single word moves before reload.  In theory this
14206 can give better register allocation, but so far the reverse seems to be
14207 generally the case.
14209 @item -m1reg-@var{reg}
14210 @opindex m1reg-
14211 Specify a register to hold the constant @minus{}1, which makes loading small negative
14212 constants and certain bitmasks faster.
14213 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
14214 which specify use of that register as a fixed register,
14215 and @samp{none}, which means that no register is used for this
14216 purpose.  The default is @option{-m1reg-none}.
14218 @end table
14220 @node ARC Options
14221 @subsection ARC Options
14222 @cindex ARC options
14224 The following options control the architecture variant for which code
14225 is being compiled:
14227 @c architecture variants
14228 @table @gcctabopt
14230 @item -mbarrel-shifter
14231 @opindex mbarrel-shifter
14232 Generate instructions supported by barrel shifter.  This is the default
14233 unless @option{-mcpu=ARC601} or @samp{-mcpu=ARCEM} is in effect.
14235 @item -mcpu=@var{cpu}
14236 @opindex mcpu
14237 Set architecture type, register usage, and instruction scheduling
14238 parameters for @var{cpu}.  There are also shortcut alias options
14239 available for backward compatibility and convenience.  Supported
14240 values for @var{cpu} are
14242 @table @samp
14243 @opindex mA6
14244 @opindex mARC600
14245 @item arc600
14246 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
14248 @item arc601
14249 @opindex mARC601
14250 Compile for ARC601.  Alias: @option{-mARC601}.
14252 @item arc700
14253 @opindex mA7
14254 @opindex mARC700
14255 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
14256 This is the default when configured with @option{--with-cpu=arc700}@.
14258 @item arcem
14259 Compile for ARC EM.
14261 @item archs
14262 Compile for ARC HS.
14264 @item em
14265 Compile for ARC EM CPU with no hardware extensions.
14267 @item em4
14268 Compile for ARC EM4 CPU.
14270 @item em4_dmips
14271 Compile for ARC EM4 DMIPS CPU.
14273 @item em4_fpus
14274 Compile for ARC EM4 DMIPS CPU with the single-precision floating-point
14275 extension.
14277 @item em4_fpuda
14278 Compile for ARC EM4 DMIPS CPU with single-precision floating-point and
14279 double assist instructions.
14281 @item hs
14282 Compile for ARC HS CPU with no hardware extensions except the atomic
14283 instructions.
14285 @item hs34
14286 Compile for ARC HS34 CPU.
14288 @item hs38
14289 Compile for ARC HS38 CPU.
14291 @item hs38_linux
14292 Compile for ARC HS38 CPU with all hardware extensions on.
14294 @item arc600_norm
14295 Compile for ARC 600 CPU with @code{norm} instructions enabled.
14297 @item arc600_mul32x16
14298 Compile for ARC 600 CPU with @code{norm} and 32x16-bit multiply 
14299 instructions enabled.
14301 @item arc600_mul64
14302 Compile for ARC 600 CPU with @code{norm} and @code{mul64}-family 
14303 instructions enabled.
14305 @item arc601_norm
14306 Compile for ARC 601 CPU with @code{norm} instructions enabled.
14308 @item arc601_mul32x16
14309 Compile for ARC 601 CPU with @code{norm} and 32x16-bit multiply
14310 instructions enabled.
14312 @item arc601_mul64
14313 Compile for ARC 601 CPU with @code{norm} and @code{mul64}-family
14314 instructions enabled.
14316 @item nps400
14317 Compile for ARC 700 on NPS400 chip.
14319 @end table
14321 @item -mdpfp
14322 @opindex mdpfp
14323 @itemx -mdpfp-compact
14324 @opindex mdpfp-compact
14325 Generate double-precision FPX instructions, tuned for the compact
14326 implementation.
14328 @item -mdpfp-fast
14329 @opindex mdpfp-fast
14330 Generate double-precision FPX instructions, tuned for the fast
14331 implementation.
14333 @item -mno-dpfp-lrsr
14334 @opindex mno-dpfp-lrsr
14335 Disable @code{lr} and @code{sr} instructions from using FPX extension
14336 aux registers.
14338 @item -mea
14339 @opindex mea
14340 Generate extended arithmetic instructions.  Currently only
14341 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
14342 supported.  This is always enabled for @option{-mcpu=ARC700}.
14344 @item -mno-mpy
14345 @opindex mno-mpy
14346 Do not generate @code{mpy}-family instructions for ARC700.  This option is
14347 deprecated.
14349 @item -mmul32x16
14350 @opindex mmul32x16
14351 Generate 32x16-bit multiply and multiply-accumulate instructions.
14353 @item -mmul64
14354 @opindex mmul64
14355 Generate @code{mul64} and @code{mulu64} instructions.  
14356 Only valid for @option{-mcpu=ARC600}.
14358 @item -mnorm
14359 @opindex mnorm
14360 Generate @code{norm} instructions.  This is the default if @option{-mcpu=ARC700}
14361 is in effect.
14363 @item -mspfp
14364 @opindex mspfp
14365 @itemx -mspfp-compact
14366 @opindex mspfp-compact
14367 Generate single-precision FPX instructions, tuned for the compact
14368 implementation.
14370 @item -mspfp-fast
14371 @opindex mspfp-fast
14372 Generate single-precision FPX instructions, tuned for the fast
14373 implementation.
14375 @item -msimd
14376 @opindex msimd
14377 Enable generation of ARC SIMD instructions via target-specific
14378 builtins.  Only valid for @option{-mcpu=ARC700}.
14380 @item -msoft-float
14381 @opindex msoft-float
14382 This option ignored; it is provided for compatibility purposes only.
14383 Software floating-point code is emitted by default, and this default
14384 can overridden by FPX options; @option{-mspfp}, @option{-mspfp-compact}, or
14385 @option{-mspfp-fast} for single precision, and @option{-mdpfp},
14386 @option{-mdpfp-compact}, or @option{-mdpfp-fast} for double precision.
14388 @item -mswap
14389 @opindex mswap
14390 Generate @code{swap} instructions.
14392 @item -matomic
14393 @opindex matomic
14394 This enables use of the locked load/store conditional extension to implement
14395 atomic memory built-in functions.  Not available for ARC 6xx or ARC
14396 EM cores.
14398 @item -mdiv-rem
14399 @opindex mdiv-rem
14400 Enable @code{div} and @code{rem} instructions for ARCv2 cores.
14402 @item -mcode-density
14403 @opindex mcode-density
14404 Enable code density instructions for ARC EM.  
14405 This option is on by default for ARC HS.
14407 @item -mll64
14408 @opindex mll64
14409 Enable double load/store operations for ARC HS cores.
14411 @item -mtp-regno=@var{regno}
14412 @opindex mtp-regno
14413 Specify thread pointer register number.
14415 @item -mmpy-option=@var{multo}
14416 @opindex mmpy-option
14417 Compile ARCv2 code with a multiplier design option.  You can specify 
14418 the option using either a string or numeric value for @var{multo}.  
14419 @samp{wlh1} is the default value.  The recognized values are:
14421 @table @samp
14422 @item 0
14423 @itemx none
14424 No multiplier available.
14426 @item 1
14427 @itemx w
14428 16x16 multiplier, fully pipelined.
14429 The following instructions are enabled: @code{mpyw} and @code{mpyuw}.
14431 @item 2
14432 @itemx wlh1
14433 32x32 multiplier, fully
14434 pipelined (1 stage).  The following instructions are additionally
14435 enabled: @code{mpy}, @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14437 @item 3
14438 @itemx wlh2
14439 32x32 multiplier, fully pipelined
14440 (2 stages).  The following instructions are additionally enabled: @code{mpy},
14441 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14443 @item 4
14444 @itemx wlh3
14445 Two 16x16 multipliers, blocking,
14446 sequential.  The following instructions are additionally enabled: @code{mpy},
14447 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14449 @item 5
14450 @itemx wlh4
14451 One 16x16 multiplier, blocking,
14452 sequential.  The following instructions are additionally enabled: @code{mpy},
14453 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14455 @item 6
14456 @itemx wlh5
14457 One 32x4 multiplier, blocking,
14458 sequential.  The following instructions are additionally enabled: @code{mpy},
14459 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14461 @item 7
14462 @itemx plus_dmpy
14463 ARC HS SIMD support.
14465 @item 8
14466 @itemx plus_macd
14467 ARC HS SIMD support.
14469 @item 9
14470 @itemx plus_qmacw
14471 ARC HS SIMD support.
14473 @end table
14475 This option is only available for ARCv2 cores@.
14477 @item -mfpu=@var{fpu}
14478 @opindex mfpu
14479 Enables support for specific floating-point hardware extensions for ARCv2
14480 cores.  Supported values for @var{fpu} are:
14482 @table @samp
14484 @item fpus
14485 Enables support for single-precision floating-point hardware
14486 extensions@.
14488 @item fpud
14489 Enables support for double-precision floating-point hardware
14490 extensions.  The single-precision floating-point extension is also
14491 enabled.  Not available for ARC EM@.
14493 @item fpuda
14494 Enables support for double-precision floating-point hardware
14495 extensions using double-precision assist instructions.  The single-precision
14496 floating-point extension is also enabled.  This option is
14497 only available for ARC EM@.
14499 @item fpuda_div
14500 Enables support for double-precision floating-point hardware
14501 extensions using double-precision assist instructions.
14502 The single-precision floating-point, square-root, and divide 
14503 extensions are also enabled.  This option is
14504 only available for ARC EM@.
14506 @item fpuda_fma
14507 Enables support for double-precision floating-point hardware
14508 extensions using double-precision assist instructions.
14509 The single-precision floating-point and fused multiply and add 
14510 hardware extensions are also enabled.  This option is
14511 only available for ARC EM@.
14513 @item fpuda_all
14514 Enables support for double-precision floating-point hardware
14515 extensions using double-precision assist instructions.
14516 All single-precision floating-point hardware extensions are also
14517 enabled.  This option is only available for ARC EM@.
14519 @item fpus_div
14520 Enables support for single-precision floating-point, square-root and divide 
14521 hardware extensions@.
14523 @item fpud_div
14524 Enables support for double-precision floating-point, square-root and divide 
14525 hardware extensions.  This option
14526 includes option @samp{fpus_div}. Not available for ARC EM@.
14528 @item fpus_fma
14529 Enables support for single-precision floating-point and 
14530 fused multiply and add hardware extensions@.
14532 @item fpud_fma
14533 Enables support for double-precision floating-point and 
14534 fused multiply and add hardware extensions.  This option
14535 includes option @samp{fpus_fma}.  Not available for ARC EM@.
14537 @item fpus_all
14538 Enables support for all single-precision floating-point hardware
14539 extensions@.
14541 @item fpud_all
14542 Enables support for all single- and double-precision floating-point
14543 hardware extensions.  Not available for ARC EM@.
14545 @end table
14547 @end table
14549 The following options are passed through to the assembler, and also
14550 define preprocessor macro symbols.
14552 @c Flags used by the assembler, but for which we define preprocessor
14553 @c macro symbols as well.
14554 @table @gcctabopt
14555 @item -mdsp-packa
14556 @opindex mdsp-packa
14557 Passed down to the assembler to enable the DSP Pack A extensions.
14558 Also sets the preprocessor symbol @code{__Xdsp_packa}.  This option is
14559 deprecated.
14561 @item -mdvbf
14562 @opindex mdvbf
14563 Passed down to the assembler to enable the dual Viterbi butterfly
14564 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.  This
14565 option is deprecated.
14567 @c ARC700 4.10 extension instruction
14568 @item -mlock
14569 @opindex mlock
14570 Passed down to the assembler to enable the locked load/store
14571 conditional extension.  Also sets the preprocessor symbol
14572 @code{__Xlock}.
14574 @item -mmac-d16
14575 @opindex mmac-d16
14576 Passed down to the assembler.  Also sets the preprocessor symbol
14577 @code{__Xxmac_d16}.  This option is deprecated.
14579 @item -mmac-24
14580 @opindex mmac-24
14581 Passed down to the assembler.  Also sets the preprocessor symbol
14582 @code{__Xxmac_24}.  This option is deprecated.
14584 @c ARC700 4.10 extension instruction
14585 @item -mrtsc
14586 @opindex mrtsc
14587 Passed down to the assembler to enable the 64-bit time-stamp counter
14588 extension instruction.  Also sets the preprocessor symbol
14589 @code{__Xrtsc}.  This option is deprecated.
14591 @c ARC700 4.10 extension instruction
14592 @item -mswape
14593 @opindex mswape
14594 Passed down to the assembler to enable the swap byte ordering
14595 extension instruction.  Also sets the preprocessor symbol
14596 @code{__Xswape}.
14598 @item -mtelephony
14599 @opindex mtelephony
14600 Passed down to the assembler to enable dual- and single-operand
14601 instructions for telephony.  Also sets the preprocessor symbol
14602 @code{__Xtelephony}.  This option is deprecated.
14604 @item -mxy
14605 @opindex mxy
14606 Passed down to the assembler to enable the XY memory extension.  Also
14607 sets the preprocessor symbol @code{__Xxy}.
14609 @end table
14611 The following options control how the assembly code is annotated:
14613 @c Assembly annotation options
14614 @table @gcctabopt
14615 @item -misize
14616 @opindex misize
14617 Annotate assembler instructions with estimated addresses.
14619 @item -mannotate-align
14620 @opindex mannotate-align
14621 Explain what alignment considerations lead to the decision to make an
14622 instruction short or long.
14624 @end table
14626 The following options are passed through to the linker:
14628 @c options passed through to the linker
14629 @table @gcctabopt
14630 @item -marclinux
14631 @opindex marclinux
14632 Passed through to the linker, to specify use of the @code{arclinux} emulation.
14633 This option is enabled by default in tool chains built for
14634 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
14635 when profiling is not requested.
14637 @item -marclinux_prof
14638 @opindex marclinux_prof
14639 Passed through to the linker, to specify use of the
14640 @code{arclinux_prof} emulation.  This option is enabled by default in
14641 tool chains built for @w{@code{arc-linux-uclibc}} and
14642 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
14644 @end table
14646 The following options control the semantics of generated code:
14648 @c semantically relevant code generation options
14649 @table @gcctabopt
14650 @item -mlong-calls
14651 @opindex mlong-calls
14652 Generate calls as register indirect calls, thus providing access
14653 to the full 32-bit address range.
14655 @item -mmedium-calls
14656 @opindex mmedium-calls
14657 Don't use less than 25-bit addressing range for calls, which is the
14658 offset available for an unconditional branch-and-link
14659 instruction.  Conditional execution of function calls is suppressed, to
14660 allow use of the 25-bit range, rather than the 21-bit range with
14661 conditional branch-and-link.  This is the default for tool chains built
14662 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
14664 @item -mno-sdata
14665 @opindex mno-sdata
14666 Do not generate sdata references.  This is the default for tool chains
14667 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
14668 targets.
14670 @item -mvolatile-cache
14671 @opindex mvolatile-cache
14672 Use ordinarily cached memory accesses for volatile references.  This is the
14673 default.
14675 @item -mno-volatile-cache
14676 @opindex mno-volatile-cache
14677 Enable cache bypass for volatile references.
14679 @end table
14681 The following options fine tune code generation:
14682 @c code generation tuning options
14683 @table @gcctabopt
14684 @item -malign-call
14685 @opindex malign-call
14686 Do alignment optimizations for call instructions.
14688 @item -mauto-modify-reg
14689 @opindex mauto-modify-reg
14690 Enable the use of pre/post modify with register displacement.
14692 @item -mbbit-peephole
14693 @opindex mbbit-peephole
14694 Enable bbit peephole2.
14696 @item -mno-brcc
14697 @opindex mno-brcc
14698 This option disables a target-specific pass in @file{arc_reorg} to
14699 generate compare-and-branch (@code{br@var{cc}}) instructions.  
14700 It has no effect on
14701 generation of these instructions driven by the combiner pass.
14703 @item -mcase-vector-pcrel
14704 @opindex mcase-vector-pcrel
14705 Use PC-relative switch case tables to enable case table shortening.
14706 This is the default for @option{-Os}.
14708 @item -mcompact-casesi
14709 @opindex mcompact-casesi
14710 Enable compact @code{casesi} pattern.  This is the default for @option{-Os},
14711 and only available for ARCv1 cores.
14713 @item -mno-cond-exec
14714 @opindex mno-cond-exec
14715 Disable the ARCompact-specific pass to generate conditional 
14716 execution instructions.
14718 Due to delay slot scheduling and interactions between operand numbers,
14719 literal sizes, instruction lengths, and the support for conditional execution,
14720 the target-independent pass to generate conditional execution is often lacking,
14721 so the ARC port has kept a special pass around that tries to find more
14722 conditional execution generation opportunities after register allocation,
14723 branch shortening, and delay slot scheduling have been done.  This pass
14724 generally, but not always, improves performance and code size, at the cost of
14725 extra compilation time, which is why there is an option to switch it off.
14726 If you have a problem with call instructions exceeding their allowable
14727 offset range because they are conditionalized, you should consider using
14728 @option{-mmedium-calls} instead.
14730 @item -mearly-cbranchsi
14731 @opindex mearly-cbranchsi
14732 Enable pre-reload use of the @code{cbranchsi} pattern.
14734 @item -mexpand-adddi
14735 @opindex mexpand-adddi
14736 Expand @code{adddi3} and @code{subdi3} at RTL generation time into
14737 @code{add.f}, @code{adc} etc.
14739 @item -mindexed-loads
14740 @opindex mindexed-loads
14741 Enable the use of indexed loads.  This can be problematic because some
14742 optimizers then assume that indexed stores exist, which is not
14743 the case.
14745 @opindex mlra
14746 Enable Local Register Allocation.  This is still experimental for ARC,
14747 so by default the compiler uses standard reload
14748 (i.e. @option{-mno-lra}).
14750 @item -mlra-priority-none
14751 @opindex mlra-priority-none
14752 Don't indicate any priority for target registers.
14754 @item -mlra-priority-compact
14755 @opindex mlra-priority-compact
14756 Indicate target register priority for r0..r3 / r12..r15.
14758 @item -mlra-priority-noncompact
14759 @opindex mlra-priority-noncompact
14760 Reduce target register priority for r0..r3 / r12..r15.
14762 @item -mno-millicode
14763 @opindex mno-millicode
14764 When optimizing for size (using @option{-Os}), prologues and epilogues
14765 that have to save or restore a large number of registers are often
14766 shortened by using call to a special function in libgcc; this is
14767 referred to as a @emph{millicode} call.  As these calls can pose
14768 performance issues, and/or cause linking issues when linking in a
14769 nonstandard way, this option is provided to turn off millicode call
14770 generation.
14772 @item -mmixed-code
14773 @opindex mmixed-code
14774 Tweak register allocation to help 16-bit instruction generation.
14775 This generally has the effect of decreasing the average instruction size
14776 while increasing the instruction count.
14778 @item -mq-class
14779 @opindex mq-class
14780 Enable @samp{q} instruction alternatives.
14781 This is the default for @option{-Os}.
14783 @item -mRcq
14784 @opindex mRcq
14785 Enable @samp{Rcq} constraint handling.  
14786 Most short code generation depends on this.
14787 This is the default.
14789 @item -mRcw
14790 @opindex mRcw
14791 Enable @samp{Rcw} constraint handling.  
14792 Most ccfsm condexec mostly depends on this.
14793 This is the default.
14795 @item -msize-level=@var{level}
14796 @opindex msize-level
14797 Fine-tune size optimization with regards to instruction lengths and alignment.
14798 The recognized values for @var{level} are:
14799 @table @samp
14800 @item 0
14801 No size optimization.  This level is deprecated and treated like @samp{1}.
14803 @item 1
14804 Short instructions are used opportunistically.
14806 @item 2
14807 In addition, alignment of loops and of code after barriers are dropped.
14809 @item 3
14810 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
14812 @end table
14814 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
14815 the behavior when this is not set is equivalent to level @samp{1}.
14817 @item -mtune=@var{cpu}
14818 @opindex mtune
14819 Set instruction scheduling parameters for @var{cpu}, overriding any implied
14820 by @option{-mcpu=}.
14822 Supported values for @var{cpu} are
14824 @table @samp
14825 @item ARC600
14826 Tune for ARC600 CPU.
14828 @item ARC601
14829 Tune for ARC601 CPU.
14831 @item ARC700
14832 Tune for ARC700 CPU with standard multiplier block.
14834 @item ARC700-xmac
14835 Tune for ARC700 CPU with XMAC block.
14837 @item ARC725D
14838 Tune for ARC725D CPU.
14840 @item ARC750D
14841 Tune for ARC750D CPU.
14843 @end table
14845 @item -mmultcost=@var{num}
14846 @opindex mmultcost
14847 Cost to assume for a multiply instruction, with @samp{4} being equal to a
14848 normal instruction.
14850 @item -munalign-prob-threshold=@var{probability}
14851 @opindex munalign-prob-threshold
14852 Set probability threshold for unaligning branches.
14853 When tuning for @samp{ARC700} and optimizing for speed, branches without
14854 filled delay slot are preferably emitted unaligned and long, unless
14855 profiling indicates that the probability for the branch to be taken
14856 is below @var{probability}.  @xref{Cross-profiling}.
14857 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
14859 @end table
14861 The following options are maintained for backward compatibility, but
14862 are now deprecated and will be removed in a future release:
14864 @c Deprecated options
14865 @table @gcctabopt
14867 @item -margonaut
14868 @opindex margonaut
14869 Obsolete FPX.
14871 @item -mbig-endian
14872 @opindex mbig-endian
14873 @itemx -EB
14874 @opindex EB
14875 Compile code for big-endian targets.  Use of these options is now
14876 deprecated.  Big-endian code is supported by configuring GCC to build
14877 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets,
14878 for which big endian is the default.
14880 @item -mlittle-endian
14881 @opindex mlittle-endian
14882 @itemx -EL
14883 @opindex EL
14884 Compile code for little-endian targets.  Use of these options is now
14885 deprecated.  Little-endian code is supported by configuring GCC to build 
14886 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets,
14887 for which little endian is the default.
14889 @item -mbarrel_shifter
14890 @opindex mbarrel_shifter
14891 Replaced by @option{-mbarrel-shifter}.
14893 @item -mdpfp_compact
14894 @opindex mdpfp_compact
14895 Replaced by @option{-mdpfp-compact}.
14897 @item -mdpfp_fast
14898 @opindex mdpfp_fast
14899 Replaced by @option{-mdpfp-fast}.
14901 @item -mdsp_packa
14902 @opindex mdsp_packa
14903 Replaced by @option{-mdsp-packa}.
14905 @item -mEA
14906 @opindex mEA
14907 Replaced by @option{-mea}.
14909 @item -mmac_24
14910 @opindex mmac_24
14911 Replaced by @option{-mmac-24}.
14913 @item -mmac_d16
14914 @opindex mmac_d16
14915 Replaced by @option{-mmac-d16}.
14917 @item -mspfp_compact
14918 @opindex mspfp_compact
14919 Replaced by @option{-mspfp-compact}.
14921 @item -mspfp_fast
14922 @opindex mspfp_fast
14923 Replaced by @option{-mspfp-fast}.
14925 @item -mtune=@var{cpu}
14926 @opindex mtune
14927 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
14928 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
14929 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively.
14931 @item -multcost=@var{num}
14932 @opindex multcost
14933 Replaced by @option{-mmultcost}.
14935 @end table
14937 @node ARM Options
14938 @subsection ARM Options
14939 @cindex ARM options
14941 These @samp{-m} options are defined for the ARM port:
14943 @table @gcctabopt
14944 @item -mabi=@var{name}
14945 @opindex mabi
14946 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
14947 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
14949 @item -mapcs-frame
14950 @opindex mapcs-frame
14951 Generate a stack frame that is compliant with the ARM Procedure Call
14952 Standard for all functions, even if this is not strictly necessary for
14953 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
14954 with this option causes the stack frames not to be generated for
14955 leaf functions.  The default is @option{-mno-apcs-frame}.
14956 This option is deprecated.
14958 @item -mapcs
14959 @opindex mapcs
14960 This is a synonym for @option{-mapcs-frame} and is deprecated.
14962 @ignore
14963 @c not currently implemented
14964 @item -mapcs-stack-check
14965 @opindex mapcs-stack-check
14966 Generate code to check the amount of stack space available upon entry to
14967 every function (that actually uses some stack space).  If there is
14968 insufficient space available then either the function
14969 @code{__rt_stkovf_split_small} or @code{__rt_stkovf_split_big} is
14970 called, depending upon the amount of stack space required.  The runtime
14971 system is required to provide these functions.  The default is
14972 @option{-mno-apcs-stack-check}, since this produces smaller code.
14974 @c not currently implemented
14975 @item -mapcs-reentrant
14976 @opindex mapcs-reentrant
14977 Generate reentrant, position-independent code.  The default is
14978 @option{-mno-apcs-reentrant}.
14979 @end ignore
14981 @item -mthumb-interwork
14982 @opindex mthumb-interwork
14983 Generate code that supports calling between the ARM and Thumb
14984 instruction sets.  Without this option, on pre-v5 architectures, the
14985 two instruction sets cannot be reliably used inside one program.  The
14986 default is @option{-mno-thumb-interwork}, since slightly larger code
14987 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
14988 configurations this option is meaningless.
14990 @item -mno-sched-prolog
14991 @opindex mno-sched-prolog
14992 Prevent the reordering of instructions in the function prologue, or the
14993 merging of those instruction with the instructions in the function's
14994 body.  This means that all functions start with a recognizable set
14995 of instructions (or in fact one of a choice from a small set of
14996 different function prologues), and this information can be used to
14997 locate the start of functions inside an executable piece of code.  The
14998 default is @option{-msched-prolog}.
15000 @item -mfloat-abi=@var{name}
15001 @opindex mfloat-abi
15002 Specifies which floating-point ABI to use.  Permissible values
15003 are: @samp{soft}, @samp{softfp} and @samp{hard}.
15005 Specifying @samp{soft} causes GCC to generate output containing
15006 library calls for floating-point operations.
15007 @samp{softfp} allows the generation of code using hardware floating-point
15008 instructions, but still uses the soft-float calling conventions.
15009 @samp{hard} allows generation of floating-point instructions
15010 and uses FPU-specific calling conventions.
15012 The default depends on the specific target configuration.  Note that
15013 the hard-float and soft-float ABIs are not link-compatible; you must
15014 compile your entire program with the same ABI, and link with a
15015 compatible set of libraries.
15017 @item -mlittle-endian
15018 @opindex mlittle-endian
15019 Generate code for a processor running in little-endian mode.  This is
15020 the default for all standard configurations.
15022 @item -mbig-endian
15023 @opindex mbig-endian
15024 Generate code for a processor running in big-endian mode; the default is
15025 to compile code for a little-endian processor.
15027 @item -march=@var{name}
15028 @opindex march
15029 This specifies the name of the target ARM architecture.  GCC uses this
15030 name to determine what kind of instructions it can emit when generating
15031 assembly code.  This option can be used in conjunction with or instead
15032 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
15033 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
15034 @samp{armv5}, @samp{armv5e}, @samp{armv5t}, @samp{armv5te},
15035 @samp{armv6}, @samp{armv6-m}, @samp{armv6j}, @samp{armv6k},
15036 @samp{armv6kz}, @samp{armv6s-m},
15037 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk},
15038 @samp{armv7}, @samp{armv7-a}, @samp{armv7-m}, @samp{armv7-r}, @samp{armv7e-m},
15039 @samp{armv7ve}, @samp{armv8-a}, @samp{armv8-a+crc}, @samp{armv8.1-a},
15040 @samp{armv8.1-a+crc}, @samp{armv8-m.base}, @samp{armv8-m.main},
15041 @samp{armv8-m.main+dsp}, @samp{iwmmxt}, @samp{iwmmxt2}.
15043 Architecture revisions older than @samp{armv4t} are deprecated.
15045 @option{-march=armv6s-m} is the @samp{armv6-m} architecture with support for
15046 the (now mandatory) SVC instruction.
15048 @option{-march=armv6zk} is an alias for @samp{armv6kz}, existing for backwards
15049 compatibility.
15051 @option{-march=armv7ve} is the @samp{armv7-a} architecture with virtualization
15052 extensions.
15054 @option{-march=armv8-a+crc} enables code generation for the ARMv8-A
15055 architecture together with the optional CRC32 extensions.
15057 @option{-march=armv8.1-a} enables compiler support for the ARMv8.1-A
15058 architecture.  This also enables the features provided by
15059 @option{-march=armv8-a+crc}.
15061 @option{-march=armv8.2-a} enables compiler support for the ARMv8.2-A
15062 architecture.  This also enables the features provided by
15063 @option{-march=armv8.1-a}.
15065 @option{-march=armv8.2-a+fp16} enables compiler support for the
15066 ARMv8.2-A architecture with the optional FP16 instructions extension.
15067 This also enables the features provided by @option{-march=armv8.1-a}
15068 and implies @option{-mfp16-format=ieee}.
15070 @option{-march=native} causes the compiler to auto-detect the architecture
15071 of the build computer.  At present, this feature is only supported on
15072 GNU/Linux, and not all architectures are recognized.  If the auto-detect
15073 is unsuccessful the option has no effect.
15075 @item -mtune=@var{name}
15076 @opindex mtune
15077 This option specifies the name of the target ARM processor for
15078 which GCC should tune the performance of the code.
15079 For some ARM implementations better performance can be obtained by using
15080 this option.
15081 Permissible names are: @samp{arm2}, @samp{arm250},
15082 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
15083 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
15084 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
15085 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
15086 @samp{arm720},
15087 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
15088 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
15089 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
15090 @samp{strongarm1110},
15091 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
15092 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
15093 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
15094 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
15095 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
15096 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
15097 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
15098 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8},
15099 @samp{cortex-a9}, @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a17},
15100 @samp{cortex-a32}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a57},
15101 @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-r4},
15102 @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-r8},
15103 @samp{cortex-m33},
15104 @samp{cortex-m23},
15105 @samp{cortex-m7},
15106 @samp{cortex-m4},
15107 @samp{cortex-m3},
15108 @samp{cortex-m1},
15109 @samp{cortex-m0},
15110 @samp{cortex-m0plus},
15111 @samp{cortex-m1.small-multiply},
15112 @samp{cortex-m0.small-multiply},
15113 @samp{cortex-m0plus.small-multiply},
15114 @samp{exynos-m1},
15115 @samp{falkor},
15116 @samp{qdf24xx},
15117 @samp{marvell-pj4},
15118 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
15119 @samp{fa526}, @samp{fa626},
15120 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te},
15121 @samp{xgene1}.
15123 Additionally, this option can specify that GCC should tune the performance
15124 of the code for a big.LITTLE system.  Permissible names are:
15125 @samp{cortex-a15.cortex-a7}, @samp{cortex-a17.cortex-a7},
15126 @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
15127 @samp{cortex-a72.cortex-a35}, @samp{cortex-a73.cortex-a53}.
15129 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
15130 performance for a blend of processors within architecture @var{arch}.
15131 The aim is to generate code that run well on the current most popular
15132 processors, balancing between optimizations that benefit some CPUs in the
15133 range, and avoiding performance pitfalls of other CPUs.  The effects of
15134 this option may change in future GCC versions as CPU models come and go.
15136 @option{-mtune=native} causes the compiler to auto-detect the CPU
15137 of the build computer.  At present, this feature is only supported on
15138 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
15139 unsuccessful the option has no effect.
15141 @item -mcpu=@var{name}
15142 @opindex mcpu
15143 This specifies the name of the target ARM processor.  GCC uses this name
15144 to derive the name of the target ARM architecture (as if specified
15145 by @option{-march}) and the ARM processor type for which to tune for
15146 performance (as if specified by @option{-mtune}).  Where this option
15147 is used in conjunction with @option{-march} or @option{-mtune},
15148 those options take precedence over the appropriate part of this option.
15150 Permissible names for this option are the same as those for
15151 @option{-mtune}.
15153 @option{-mcpu=generic-@var{arch}} is also permissible, and is
15154 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
15155 See @option{-mtune} for more information.
15157 @option{-mcpu=native} causes the compiler to auto-detect the CPU
15158 of the build computer.  At present, this feature is only supported on
15159 GNU/Linux, and not all architectures are recognized.  If the auto-detect
15160 is unsuccessful the option has no effect.
15162 @item -mfpu=@var{name}
15163 @opindex mfpu
15164 This specifies what floating-point hardware (or hardware emulation) is
15165 available on the target.  Permissible names are: @samp{vfpv2}, @samp{vfpv3},
15166 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
15167 @samp{vfpv3xd-fp16}, @samp{neon-vfpv3}, @samp{neon-fp16}, @samp{vfpv4},
15168 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
15169 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
15170 @samp{fp-armv8}, @samp{neon-fp-armv8} and @samp{crypto-neon-fp-armv8}.
15171 Note that @samp{neon} is an alias for @samp{neon-vfpv3} and @samp{vfp}
15172 is an alias for @samp{vfpv2}.
15174 If @option{-msoft-float} is specified this specifies the format of
15175 floating-point values.
15177 If the selected floating-point hardware includes the NEON extension
15178 (e.g. @option{-mfpu}=@samp{neon}), note that floating-point
15179 operations are not generated by GCC's auto-vectorization pass unless
15180 @option{-funsafe-math-optimizations} is also specified.  This is
15181 because NEON hardware does not fully implement the IEEE 754 standard for
15182 floating-point arithmetic (in particular denormal values are treated as
15183 zero), so the use of NEON instructions may lead to a loss of precision.
15185 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}).
15187 @item -mfp16-format=@var{name}
15188 @opindex mfp16-format
15189 Specify the format of the @code{__fp16} half-precision floating-point type.
15190 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
15191 the default is @samp{none}, in which case the @code{__fp16} type is not
15192 defined.  @xref{Half-Precision}, for more information.
15194 @item -mstructure-size-boundary=@var{n}
15195 @opindex mstructure-size-boundary
15196 The sizes of all structures and unions are rounded up to a multiple
15197 of the number of bits set by this option.  Permissible values are 8, 32
15198 and 64.  The default value varies for different toolchains.  For the COFF
15199 targeted toolchain the default value is 8.  A value of 64 is only allowed
15200 if the underlying ABI supports it.
15202 Specifying a larger number can produce faster, more efficient code, but
15203 can also increase the size of the program.  Different values are potentially
15204 incompatible.  Code compiled with one value cannot necessarily expect to
15205 work with code or libraries compiled with another value, if they exchange
15206 information using structures or unions.
15208 @item -mabort-on-noreturn
15209 @opindex mabort-on-noreturn
15210 Generate a call to the function @code{abort} at the end of a
15211 @code{noreturn} function.  It is executed if the function tries to
15212 return.
15214 @item -mlong-calls
15215 @itemx -mno-long-calls
15216 @opindex mlong-calls
15217 @opindex mno-long-calls
15218 Tells the compiler to perform function calls by first loading the
15219 address of the function into a register and then performing a subroutine
15220 call on this register.  This switch is needed if the target function
15221 lies outside of the 64-megabyte addressing range of the offset-based
15222 version of subroutine call instruction.
15224 Even if this switch is enabled, not all function calls are turned
15225 into long calls.  The heuristic is that static functions, functions
15226 that have the @code{short_call} attribute, functions that are inside
15227 the scope of a @code{#pragma no_long_calls} directive, and functions whose
15228 definitions have already been compiled within the current compilation
15229 unit are not turned into long calls.  The exceptions to this rule are
15230 that weak function definitions, functions with the @code{long_call}
15231 attribute or the @code{section} attribute, and functions that are within
15232 the scope of a @code{#pragma long_calls} directive are always
15233 turned into long calls.
15235 This feature is not enabled by default.  Specifying
15236 @option{-mno-long-calls} restores the default behavior, as does
15237 placing the function calls within the scope of a @code{#pragma
15238 long_calls_off} directive.  Note these switches have no effect on how
15239 the compiler generates code to handle function calls via function
15240 pointers.
15242 @item -msingle-pic-base
15243 @opindex msingle-pic-base
15244 Treat the register used for PIC addressing as read-only, rather than
15245 loading it in the prologue for each function.  The runtime system is
15246 responsible for initializing this register with an appropriate value
15247 before execution begins.
15249 @item -mpic-register=@var{reg}
15250 @opindex mpic-register
15251 Specify the register to be used for PIC addressing.
15252 For standard PIC base case, the default is any suitable register
15253 determined by compiler.  For single PIC base case, the default is
15254 @samp{R9} if target is EABI based or stack-checking is enabled,
15255 otherwise the default is @samp{R10}.
15257 @item -mpic-data-is-text-relative
15258 @opindex mpic-data-is-text-relative
15259 Assume that the displacement between the text and data segments is fixed
15260 at static link time.  This permits using PC-relative addressing
15261 operations to access data known to be in the data segment.  For
15262 non-VxWorks RTP targets, this option is enabled by default.  When
15263 disabled on such targets, it will enable @option{-msingle-pic-base} by
15264 default.
15266 @item -mpoke-function-name
15267 @opindex mpoke-function-name
15268 Write the name of each function into the text section, directly
15269 preceding the function prologue.  The generated code is similar to this:
15271 @smallexample
15272      t0
15273          .ascii "arm_poke_function_name", 0
15274          .align
15275      t1
15276          .word 0xff000000 + (t1 - t0)
15277      arm_poke_function_name
15278          mov     ip, sp
15279          stmfd   sp!, @{fp, ip, lr, pc@}
15280          sub     fp, ip, #4
15281 @end smallexample
15283 When performing a stack backtrace, code can inspect the value of
15284 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
15285 location @code{pc - 12} and the top 8 bits are set, then we know that
15286 there is a function name embedded immediately preceding this location
15287 and has length @code{((pc[-3]) & 0xff000000)}.
15289 @item -mthumb
15290 @itemx -marm
15291 @opindex marm
15292 @opindex mthumb
15294 Select between generating code that executes in ARM and Thumb
15295 states.  The default for most configurations is to generate code
15296 that executes in ARM state, but the default can be changed by
15297 configuring GCC with the @option{--with-mode=}@var{state}
15298 configure option.
15300 You can also override the ARM and Thumb mode for each function
15301 by using the @code{target("thumb")} and @code{target("arm")} function attributes
15302 (@pxref{ARM Function Attributes}) or pragmas (@pxref{Function Specific Option Pragmas}).
15304 @item -mtpcs-frame
15305 @opindex mtpcs-frame
15306 Generate a stack frame that is compliant with the Thumb Procedure Call
15307 Standard for all non-leaf functions.  (A leaf function is one that does
15308 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
15310 @item -mtpcs-leaf-frame
15311 @opindex mtpcs-leaf-frame
15312 Generate a stack frame that is compliant with the Thumb Procedure Call
15313 Standard for all leaf functions.  (A leaf function is one that does
15314 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
15316 @item -mcallee-super-interworking
15317 @opindex mcallee-super-interworking
15318 Gives all externally visible functions in the file being compiled an ARM
15319 instruction set header which switches to Thumb mode before executing the
15320 rest of the function.  This allows these functions to be called from
15321 non-interworking code.  This option is not valid in AAPCS configurations
15322 because interworking is enabled by default.
15324 @item -mcaller-super-interworking
15325 @opindex mcaller-super-interworking
15326 Allows calls via function pointers (including virtual functions) to
15327 execute correctly regardless of whether the target code has been
15328 compiled for interworking or not.  There is a small overhead in the cost
15329 of executing a function pointer if this option is enabled.  This option
15330 is not valid in AAPCS configurations because interworking is enabled
15331 by default.
15333 @item -mtp=@var{name}
15334 @opindex mtp
15335 Specify the access model for the thread local storage pointer.  The valid
15336 models are @samp{soft}, which generates calls to @code{__aeabi_read_tp},
15337 @samp{cp15}, which fetches the thread pointer from @code{cp15} directly
15338 (supported in the arm6k architecture), and @samp{auto}, which uses the
15339 best available method for the selected processor.  The default setting is
15340 @samp{auto}.
15342 @item -mtls-dialect=@var{dialect}
15343 @opindex mtls-dialect
15344 Specify the dialect to use for accessing thread local storage.  Two
15345 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
15346 @samp{gnu} dialect selects the original GNU scheme for supporting
15347 local and global dynamic TLS models.  The @samp{gnu2} dialect
15348 selects the GNU descriptor scheme, which provides better performance
15349 for shared libraries.  The GNU descriptor scheme is compatible with
15350 the original scheme, but does require new assembler, linker and
15351 library support.  Initial and local exec TLS models are unaffected by
15352 this option and always use the original scheme.
15354 @item -mword-relocations
15355 @opindex mword-relocations
15356 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
15357 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
15358 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
15359 is specified.
15361 @item -mfix-cortex-m3-ldrd
15362 @opindex mfix-cortex-m3-ldrd
15363 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
15364 with overlapping destination and base registers are used.  This option avoids
15365 generating these instructions.  This option is enabled by default when
15366 @option{-mcpu=cortex-m3} is specified.
15368 @item -munaligned-access
15369 @itemx -mno-unaligned-access
15370 @opindex munaligned-access
15371 @opindex mno-unaligned-access
15372 Enables (or disables) reading and writing of 16- and 32- bit values
15373 from addresses that are not 16- or 32- bit aligned.  By default
15374 unaligned access is disabled for all pre-ARMv6, all ARMv6-M and for
15375 ARMv8-M Baseline architectures, and enabled for all other
15376 architectures.  If unaligned access is not enabled then words in packed
15377 data structures are accessed a byte at a time.
15379 The ARM attribute @code{Tag_CPU_unaligned_access} is set in the
15380 generated object file to either true or false, depending upon the
15381 setting of this option.  If unaligned access is enabled then the
15382 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} is also
15383 defined.
15385 @item -mneon-for-64bits
15386 @opindex mneon-for-64bits
15387 Enables using Neon to handle scalar 64-bits operations. This is
15388 disabled by default since the cost of moving data from core registers
15389 to Neon is high.
15391 @item -mslow-flash-data
15392 @opindex mslow-flash-data
15393 Assume loading data from flash is slower than fetching instruction.
15394 Therefore literal load is minimized for better performance.
15395 This option is only supported when compiling for ARMv7 M-profile and
15396 off by default.
15398 @item -masm-syntax-unified
15399 @opindex masm-syntax-unified
15400 Assume inline assembler is using unified asm syntax.  The default is
15401 currently off which implies divided syntax.  This option has no impact
15402 on Thumb2. However, this may change in future releases of GCC.
15403 Divided syntax should be considered deprecated.
15405 @item -mrestrict-it
15406 @opindex mrestrict-it
15407 Restricts generation of IT blocks to conform to the rules of ARMv8.
15408 IT blocks can only contain a single 16-bit instruction from a select
15409 set of instructions. This option is on by default for ARMv8 Thumb mode.
15411 @item -mprint-tune-info
15412 @opindex mprint-tune-info
15413 Print CPU tuning information as comment in assembler file.  This is
15414 an option used only for regression testing of the compiler and not
15415 intended for ordinary use in compiling code.  This option is disabled
15416 by default.
15418 @item -mpure-code
15419 @opindex mpure-code
15420 Do not allow constant data to be placed in code sections.
15421 Additionally, when compiling for ELF object format give all text sections the
15422 ELF processor-specific section attribute @code{SHF_ARM_PURECODE}.  This option
15423 is only available when generating non-pic code for ARMv7-M targets.
15425 @item -mcmse
15426 @opindex mcmse
15427 Generate secure code as per the "ARMv8-M Security Extensions: Requirements on
15428 Development Tools Engineering Specification", which can be found on
15429 @url{http://infocenter.arm.com/help/topic/com.arm.doc.ecm0359818/ECM0359818_armv8m_security_extensions_reqs_on_dev_tools_1_0.pdf}.
15430 @end table
15432 @node AVR Options
15433 @subsection AVR Options
15434 @cindex AVR Options
15436 These options are defined for AVR implementations:
15438 @table @gcctabopt
15439 @item -mmcu=@var{mcu}
15440 @opindex mmcu
15441 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
15443 The default for this option is@tie{}@samp{avr2}.
15445 GCC supports the following AVR devices and ISAs:
15447 @include avr-mmcu.texi
15449 @item -mabsdata
15450 @opindex mabsdata
15452 Assume that all data in static storage can be accessed by LDS / STS
15453 instructions.  This option has only an effect on reduced Tiny devices like
15454 ATtiny40.  See also the @code{absdata}
15455 @ref{AVR Variable Attributes,variable attribute}.
15457 @item -maccumulate-args
15458 @opindex maccumulate-args
15459 Accumulate outgoing function arguments and acquire/release the needed
15460 stack space for outgoing function arguments once in function
15461 prologue/epilogue.  Without this option, outgoing arguments are pushed
15462 before calling a function and popped afterwards.
15464 Popping the arguments after the function call can be expensive on
15465 AVR so that accumulating the stack space might lead to smaller
15466 executables because arguments need not be removed from the
15467 stack after such a function call.
15469 This option can lead to reduced code size for functions that perform
15470 several calls to functions that get their arguments on the stack like
15471 calls to printf-like functions.
15473 @item -mbranch-cost=@var{cost}
15474 @opindex mbranch-cost
15475 Set the branch costs for conditional branch instructions to
15476 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
15477 integers. The default branch cost is 0.
15479 @item -mcall-prologues
15480 @opindex mcall-prologues
15481 Functions prologues/epilogues are expanded as calls to appropriate
15482 subroutines.  Code size is smaller.
15484 @item -mint8
15485 @opindex mint8
15486 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
15487 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
15488 and @code{long long} is 4 bytes.  Please note that this option does not
15489 conform to the C standards, but it results in smaller code
15490 size.
15492 @item -mn-flash=@var{num}
15493 @opindex mn-flash
15494 Assume that the flash memory has a size of 
15495 @var{num} times 64@tie{}KiB.
15497 @item -mno-interrupts
15498 @opindex mno-interrupts
15499 Generated code is not compatible with hardware interrupts.
15500 Code size is smaller.
15502 @item -mrelax
15503 @opindex mrelax
15504 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
15505 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
15506 Setting @option{-mrelax} just adds the @option{--mlink-relax} option to
15507 the assembler's command line and the @option{--relax} option to the
15508 linker's command line.
15510 Jump relaxing is performed by the linker because jump offsets are not
15511 known before code is located. Therefore, the assembler code generated by the
15512 compiler is the same, but the instructions in the executable may
15513 differ from instructions in the assembler code.
15515 Relaxing must be turned on if linker stubs are needed, see the
15516 section on @code{EIND} and linker stubs below.
15518 @item -mrmw
15519 @opindex mrmw
15520 Assume that the device supports the Read-Modify-Write
15521 instructions @code{XCH}, @code{LAC}, @code{LAS} and @code{LAT}.
15523 @item -msp8
15524 @opindex msp8
15525 Treat the stack pointer register as an 8-bit register,
15526 i.e.@: assume the high byte of the stack pointer is zero.
15527 In general, you don't need to set this option by hand.
15529 This option is used internally by the compiler to select and
15530 build multilibs for architectures @code{avr2} and @code{avr25}.
15531 These architectures mix devices with and without @code{SPH}.
15532 For any setting other than @option{-mmcu=avr2} or @option{-mmcu=avr25}
15533 the compiler driver adds or removes this option from the compiler
15534 proper's command line, because the compiler then knows if the device
15535 or architecture has an 8-bit stack pointer and thus no @code{SPH}
15536 register or not.
15538 @item -mstrict-X
15539 @opindex mstrict-X
15540 Use address register @code{X} in a way proposed by the hardware.  This means
15541 that @code{X} is only used in indirect, post-increment or
15542 pre-decrement addressing.
15544 Without this option, the @code{X} register may be used in the same way
15545 as @code{Y} or @code{Z} which then is emulated by additional
15546 instructions.  
15547 For example, loading a value with @code{X+const} addressing with a
15548 small non-negative @code{const < 64} to a register @var{Rn} is
15549 performed as
15551 @example
15552 adiw r26, const   ; X += const
15553 ld   @var{Rn}, X        ; @var{Rn} = *X
15554 sbiw r26, const   ; X -= const
15555 @end example
15557 @item -mtiny-stack
15558 @opindex mtiny-stack
15559 Only change the lower 8@tie{}bits of the stack pointer.
15561 @item -mfract-convert-truncate
15562 @opindex mfract-convert-truncate
15563 Allow to use truncation instead of rounding towards zero for fractional fixed-point types.
15565 @item -nodevicelib
15566 @opindex nodevicelib
15567 Don't link against AVR-LibC's device specific library @code{lib<mcu>.a}.
15569 @item -Waddr-space-convert
15570 @opindex Waddr-space-convert
15571 Warn about conversions between address spaces in the case where the
15572 resulting address space is not contained in the incoming address space.
15574 @item -Wmisspelled-isr
15575 @opindex Wmisspelled-isr
15576 Warn if the ISR is misspelled, i.e. without __vector prefix.
15577 Enabled by default.
15578 @end table
15580 @subsubsection @code{EIND} and Devices with More Than 128 Ki Bytes of Flash
15581 @cindex @code{EIND}
15582 Pointers in the implementation are 16@tie{}bits wide.
15583 The address of a function or label is represented as word address so
15584 that indirect jumps and calls can target any code address in the
15585 range of 64@tie{}Ki words.
15587 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
15588 bytes of program memory space, there is a special function register called
15589 @code{EIND} that serves as most significant part of the target address
15590 when @code{EICALL} or @code{EIJMP} instructions are used.
15592 Indirect jumps and calls on these devices are handled as follows by
15593 the compiler and are subject to some limitations:
15595 @itemize @bullet
15597 @item
15598 The compiler never sets @code{EIND}.
15600 @item
15601 The compiler uses @code{EIND} implicitly in @code{EICALL}/@code{EIJMP}
15602 instructions or might read @code{EIND} directly in order to emulate an
15603 indirect call/jump by means of a @code{RET} instruction.
15605 @item
15606 The compiler assumes that @code{EIND} never changes during the startup
15607 code or during the application. In particular, @code{EIND} is not
15608 saved/restored in function or interrupt service routine
15609 prologue/epilogue.
15611 @item
15612 For indirect calls to functions and computed goto, the linker
15613 generates @emph{stubs}. Stubs are jump pads sometimes also called
15614 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
15615 The stub contains a direct jump to the desired address.
15617 @item
15618 Linker relaxation must be turned on so that the linker generates
15619 the stubs correctly in all situations. See the compiler option
15620 @option{-mrelax} and the linker option @option{--relax}.
15621 There are corner cases where the linker is supposed to generate stubs
15622 but aborts without relaxation and without a helpful error message.
15624 @item
15625 The default linker script is arranged for code with @code{EIND = 0}.
15626 If code is supposed to work for a setup with @code{EIND != 0}, a custom
15627 linker script has to be used in order to place the sections whose
15628 name start with @code{.trampolines} into the segment where @code{EIND}
15629 points to.
15631 @item
15632 The startup code from libgcc never sets @code{EIND}.
15633 Notice that startup code is a blend of code from libgcc and AVR-LibC.
15634 For the impact of AVR-LibC on @code{EIND}, see the
15635 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
15637 @item
15638 It is legitimate for user-specific startup code to set up @code{EIND}
15639 early, for example by means of initialization code located in
15640 section @code{.init3}. Such code runs prior to general startup code
15641 that initializes RAM and calls constructors, but after the bit
15642 of startup code from AVR-LibC that sets @code{EIND} to the segment
15643 where the vector table is located.
15644 @example
15645 #include <avr/io.h>
15647 static void
15648 __attribute__((section(".init3"),naked,used,no_instrument_function))
15649 init3_set_eind (void)
15651   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
15652                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
15654 @end example
15656 @noindent
15657 The @code{__trampolines_start} symbol is defined in the linker script.
15659 @item
15660 Stubs are generated automatically by the linker if
15661 the following two conditions are met:
15662 @itemize @minus
15664 @item The address of a label is taken by means of the @code{gs} modifier
15665 (short for @emph{generate stubs}) like so:
15666 @example
15667 LDI r24, lo8(gs(@var{func}))
15668 LDI r25, hi8(gs(@var{func}))
15669 @end example
15670 @item The final location of that label is in a code segment
15671 @emph{outside} the segment where the stubs are located.
15672 @end itemize
15674 @item
15675 The compiler emits such @code{gs} modifiers for code labels in the
15676 following situations:
15677 @itemize @minus
15678 @item Taking address of a function or code label.
15679 @item Computed goto.
15680 @item If prologue-save function is used, see @option{-mcall-prologues}
15681 command-line option.
15682 @item Switch/case dispatch tables. If you do not want such dispatch
15683 tables you can specify the @option{-fno-jump-tables} command-line option.
15684 @item C and C++ constructors/destructors called during startup/shutdown.
15685 @item If the tools hit a @code{gs()} modifier explained above.
15686 @end itemize
15688 @item
15689 Jumping to non-symbolic addresses like so is @emph{not} supported:
15691 @example
15692 int main (void)
15694     /* Call function at word address 0x2 */
15695     return ((int(*)(void)) 0x2)();
15697 @end example
15699 Instead, a stub has to be set up, i.e.@: the function has to be called
15700 through a symbol (@code{func_4} in the example):
15702 @example
15703 int main (void)
15705     extern int func_4 (void);
15707     /* Call function at byte address 0x4 */
15708     return func_4();
15710 @end example
15712 and the application be linked with @option{-Wl,--defsym,func_4=0x4}.
15713 Alternatively, @code{func_4} can be defined in the linker script.
15714 @end itemize
15716 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
15717 @cindex @code{RAMPD}
15718 @cindex @code{RAMPX}
15719 @cindex @code{RAMPY}
15720 @cindex @code{RAMPZ}
15721 Some AVR devices support memories larger than the 64@tie{}KiB range
15722 that can be accessed with 16-bit pointers.  To access memory locations
15723 outside this 64@tie{}KiB range, the content of a @code{RAMP}
15724 register is used as high part of the address:
15725 The @code{X}, @code{Y}, @code{Z} address register is concatenated
15726 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
15727 register, respectively, to get a wide address. Similarly,
15728 @code{RAMPD} is used together with direct addressing.
15730 @itemize
15731 @item
15732 The startup code initializes the @code{RAMP} special function
15733 registers with zero.
15735 @item
15736 If a @ref{AVR Named Address Spaces,named address space} other than
15737 generic or @code{__flash} is used, then @code{RAMPZ} is set
15738 as needed before the operation.
15740 @item
15741 If the device supports RAM larger than 64@tie{}KiB and the compiler
15742 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
15743 is reset to zero after the operation.
15745 @item
15746 If the device comes with a specific @code{RAMP} register, the ISR
15747 prologue/epilogue saves/restores that SFR and initializes it with
15748 zero in case the ISR code might (implicitly) use it.
15750 @item
15751 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
15752 If you use inline assembler to read from locations outside the
15753 16-bit address range and change one of the @code{RAMP} registers,
15754 you must reset it to zero after the access.
15756 @end itemize
15758 @subsubsection AVR Built-in Macros
15760 GCC defines several built-in macros so that the user code can test
15761 for the presence or absence of features.  Almost any of the following
15762 built-in macros are deduced from device capabilities and thus
15763 triggered by the @option{-mmcu=} command-line option.
15765 For even more AVR-specific built-in macros see
15766 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
15768 @table @code
15770 @item __AVR_ARCH__
15771 Build-in macro that resolves to a decimal number that identifies the
15772 architecture and depends on the @option{-mmcu=@var{mcu}} option.
15773 Possible values are:
15775 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
15776 @code{4}, @code{5}, @code{51}, @code{6}
15778 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3}, @code{avr31},
15779 @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51}, @code{avr6},
15781 respectively and
15783 @code{100}, @code{102}, @code{104},
15784 @code{105}, @code{106}, @code{107}
15786 for @var{mcu}=@code{avrtiny}, @code{avrxmega2}, @code{avrxmega4},
15787 @code{avrxmega5}, @code{avrxmega6}, @code{avrxmega7}, respectively.
15788 If @var{mcu} specifies a device, this built-in macro is set
15789 accordingly. For example, with @option{-mmcu=atmega8} the macro is
15790 defined to @code{4}.
15792 @item __AVR_@var{Device}__
15793 Setting @option{-mmcu=@var{device}} defines this built-in macro which reflects
15794 the device's name. For example, @option{-mmcu=atmega8} defines the
15795 built-in macro @code{__AVR_ATmega8__}, @option{-mmcu=attiny261a} defines
15796 @code{__AVR_ATtiny261A__}, etc.
15798 The built-in macros' names follow
15799 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
15800 the device name as from the AVR user manual. The difference between
15801 @var{Device} in the built-in macro and @var{device} in
15802 @option{-mmcu=@var{device}} is that the latter is always lowercase.
15804 If @var{device} is not a device but only a core architecture like
15805 @samp{avr51}, this macro is not defined.
15807 @item __AVR_DEVICE_NAME__
15808 Setting @option{-mmcu=@var{device}} defines this built-in macro to
15809 the device's name. For example, with @option{-mmcu=atmega8} the macro
15810 is defined to @code{atmega8}.
15812 If @var{device} is not a device but only a core architecture like
15813 @samp{avr51}, this macro is not defined.
15815 @item __AVR_XMEGA__
15816 The device / architecture belongs to the XMEGA family of devices.
15818 @item __AVR_HAVE_ELPM__
15819 The device has the @code{ELPM} instruction.
15821 @item __AVR_HAVE_ELPMX__
15822 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
15823 R@var{n},Z+} instructions.
15825 @item __AVR_HAVE_MOVW__
15826 The device has the @code{MOVW} instruction to perform 16-bit
15827 register-register moves.
15829 @item __AVR_HAVE_LPMX__
15830 The device has the @code{LPM R@var{n},Z} and
15831 @code{LPM R@var{n},Z+} instructions.
15833 @item __AVR_HAVE_MUL__
15834 The device has a hardware multiplier. 
15836 @item __AVR_HAVE_JMP_CALL__
15837 The device has the @code{JMP} and @code{CALL} instructions.
15838 This is the case for devices with at least 16@tie{}KiB of program
15839 memory.
15841 @item __AVR_HAVE_EIJMP_EICALL__
15842 @itemx __AVR_3_BYTE_PC__
15843 The device has the @code{EIJMP} and @code{EICALL} instructions.
15844 This is the case for devices with more than 128@tie{}KiB of program memory.
15845 This also means that the program counter
15846 (PC) is 3@tie{}bytes wide.
15848 @item __AVR_2_BYTE_PC__
15849 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
15850 with up to 128@tie{}KiB of program memory.
15852 @item __AVR_HAVE_8BIT_SP__
15853 @itemx __AVR_HAVE_16BIT_SP__
15854 The stack pointer (SP) register is treated as 8-bit respectively
15855 16-bit register by the compiler.
15856 The definition of these macros is affected by @option{-mtiny-stack}.
15858 @item __AVR_HAVE_SPH__
15859 @itemx __AVR_SP8__
15860 The device has the SPH (high part of stack pointer) special function
15861 register or has an 8-bit stack pointer, respectively.
15862 The definition of these macros is affected by @option{-mmcu=} and
15863 in the cases of @option{-mmcu=avr2} and @option{-mmcu=avr25} also
15864 by @option{-msp8}.
15866 @item __AVR_HAVE_RAMPD__
15867 @itemx __AVR_HAVE_RAMPX__
15868 @itemx __AVR_HAVE_RAMPY__
15869 @itemx __AVR_HAVE_RAMPZ__
15870 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
15871 @code{RAMPZ} special function register, respectively.
15873 @item __NO_INTERRUPTS__
15874 This macro reflects the @option{-mno-interrupts} command-line option.
15876 @item __AVR_ERRATA_SKIP__
15877 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
15878 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
15879 instructions because of a hardware erratum.  Skip instructions are
15880 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
15881 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
15882 set.
15884 @item __AVR_ISA_RMW__
15885 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
15887 @item __AVR_SFR_OFFSET__=@var{offset}
15888 Instructions that can address I/O special function registers directly
15889 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
15890 address as if addressed by an instruction to access RAM like @code{LD}
15891 or @code{STS}. This offset depends on the device architecture and has
15892 to be subtracted from the RAM address in order to get the
15893 respective I/O@tie{}address.
15895 @item __WITH_AVRLIBC__
15896 The compiler is configured to be used together with AVR-Libc.
15897 See the @option{--with-avrlibc} configure option.
15899 @end table
15901 @node Blackfin Options
15902 @subsection Blackfin Options
15903 @cindex Blackfin Options
15905 @table @gcctabopt
15906 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
15907 @opindex mcpu=
15908 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
15909 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
15910 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
15911 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
15912 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
15913 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
15914 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
15915 @samp{bf561}, @samp{bf592}.
15917 The optional @var{sirevision} specifies the silicon revision of the target
15918 Blackfin processor.  Any workarounds available for the targeted silicon revision
15919 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
15920 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
15921 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
15922 hexadecimal digits representing the major and minor numbers in the silicon
15923 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
15924 is not defined.  If @var{sirevision} is @samp{any}, the
15925 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
15926 If this optional @var{sirevision} is not used, GCC assumes the latest known
15927 silicon revision of the targeted Blackfin processor.
15929 GCC defines a preprocessor macro for the specified @var{cpu}.
15930 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
15931 provided by libgloss to be linked in if @option{-msim} is not given.
15933 Without this option, @samp{bf532} is used as the processor by default.
15935 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
15936 only the preprocessor macro is defined.
15938 @item -msim
15939 @opindex msim
15940 Specifies that the program will be run on the simulator.  This causes
15941 the simulator BSP provided by libgloss to be linked in.  This option
15942 has effect only for @samp{bfin-elf} toolchain.
15943 Certain other options, such as @option{-mid-shared-library} and
15944 @option{-mfdpic}, imply @option{-msim}.
15946 @item -momit-leaf-frame-pointer
15947 @opindex momit-leaf-frame-pointer
15948 Don't keep the frame pointer in a register for leaf functions.  This
15949 avoids the instructions to save, set up and restore frame pointers and
15950 makes an extra register available in leaf functions.  The option
15951 @option{-fomit-frame-pointer} removes the frame pointer for all functions,
15952 which might make debugging harder.
15954 @item -mspecld-anomaly
15955 @opindex mspecld-anomaly
15956 When enabled, the compiler ensures that the generated code does not
15957 contain speculative loads after jump instructions. If this option is used,
15958 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
15960 @item -mno-specld-anomaly
15961 @opindex mno-specld-anomaly
15962 Don't generate extra code to prevent speculative loads from occurring.
15964 @item -mcsync-anomaly
15965 @opindex mcsync-anomaly
15966 When enabled, the compiler ensures that the generated code does not
15967 contain CSYNC or SSYNC instructions too soon after conditional branches.
15968 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
15970 @item -mno-csync-anomaly
15971 @opindex mno-csync-anomaly
15972 Don't generate extra code to prevent CSYNC or SSYNC instructions from
15973 occurring too soon after a conditional branch.
15975 @item -mlow-64k
15976 @opindex mlow-64k
15977 When enabled, the compiler is free to take advantage of the knowledge that
15978 the entire program fits into the low 64k of memory.
15980 @item -mno-low-64k
15981 @opindex mno-low-64k
15982 Assume that the program is arbitrarily large.  This is the default.
15984 @item -mstack-check-l1
15985 @opindex mstack-check-l1
15986 Do stack checking using information placed into L1 scratchpad memory by the
15987 uClinux kernel.
15989 @item -mid-shared-library
15990 @opindex mid-shared-library
15991 Generate code that supports shared libraries via the library ID method.
15992 This allows for execute in place and shared libraries in an environment
15993 without virtual memory management.  This option implies @option{-fPIC}.
15994 With a @samp{bfin-elf} target, this option implies @option{-msim}.
15996 @item -mno-id-shared-library
15997 @opindex mno-id-shared-library
15998 Generate code that doesn't assume ID-based shared libraries are being used.
15999 This is the default.
16001 @item -mleaf-id-shared-library
16002 @opindex mleaf-id-shared-library
16003 Generate code that supports shared libraries via the library ID method,
16004 but assumes that this library or executable won't link against any other
16005 ID shared libraries.  That allows the compiler to use faster code for jumps
16006 and calls.
16008 @item -mno-leaf-id-shared-library
16009 @opindex mno-leaf-id-shared-library
16010 Do not assume that the code being compiled won't link against any ID shared
16011 libraries.  Slower code is generated for jump and call insns.
16013 @item -mshared-library-id=n
16014 @opindex mshared-library-id
16015 Specifies the identification number of the ID-based shared library being
16016 compiled.  Specifying a value of 0 generates more compact code; specifying
16017 other values forces the allocation of that number to the current
16018 library but is no more space- or time-efficient than omitting this option.
16020 @item -msep-data
16021 @opindex msep-data
16022 Generate code that allows the data segment to be located in a different
16023 area of memory from the text segment.  This allows for execute in place in
16024 an environment without virtual memory management by eliminating relocations
16025 against the text section.
16027 @item -mno-sep-data
16028 @opindex mno-sep-data
16029 Generate code that assumes that the data segment follows the text segment.
16030 This is the default.
16032 @item -mlong-calls
16033 @itemx -mno-long-calls
16034 @opindex mlong-calls
16035 @opindex mno-long-calls
16036 Tells the compiler to perform function calls by first loading the
16037 address of the function into a register and then performing a subroutine
16038 call on this register.  This switch is needed if the target function
16039 lies outside of the 24-bit addressing range of the offset-based
16040 version of subroutine call instruction.
16042 This feature is not enabled by default.  Specifying
16043 @option{-mno-long-calls} restores the default behavior.  Note these
16044 switches have no effect on how the compiler generates code to handle
16045 function calls via function pointers.
16047 @item -mfast-fp
16048 @opindex mfast-fp
16049 Link with the fast floating-point library. This library relaxes some of
16050 the IEEE floating-point standard's rules for checking inputs against
16051 Not-a-Number (NAN), in the interest of performance.
16053 @item -minline-plt
16054 @opindex minline-plt
16055 Enable inlining of PLT entries in function calls to functions that are
16056 not known to bind locally.  It has no effect without @option{-mfdpic}.
16058 @item -mmulticore
16059 @opindex mmulticore
16060 Build a standalone application for multicore Blackfin processors. 
16061 This option causes proper start files and link scripts supporting 
16062 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
16063 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
16065 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
16066 selects the one-application-per-core programming model.  Without
16067 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
16068 programming model is used. In this model, the main function of Core B
16069 should be named as @code{coreb_main}.
16071 If this option is not used, the single-core application programming
16072 model is used.
16074 @item -mcorea
16075 @opindex mcorea
16076 Build a standalone application for Core A of BF561 when using
16077 the one-application-per-core programming model. Proper start files
16078 and link scripts are used to support Core A, and the macro
16079 @code{__BFIN_COREA} is defined.
16080 This option can only be used in conjunction with @option{-mmulticore}.
16082 @item -mcoreb
16083 @opindex mcoreb
16084 Build a standalone application for Core B of BF561 when using
16085 the one-application-per-core programming model. Proper start files
16086 and link scripts are used to support Core B, and the macro
16087 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
16088 should be used instead of @code{main}. 
16089 This option can only be used in conjunction with @option{-mmulticore}.
16091 @item -msdram
16092 @opindex msdram
16093 Build a standalone application for SDRAM. Proper start files and
16094 link scripts are used to put the application into SDRAM, and the macro
16095 @code{__BFIN_SDRAM} is defined.
16096 The loader should initialize SDRAM before loading the application.
16098 @item -micplb
16099 @opindex micplb
16100 Assume that ICPLBs are enabled at run time.  This has an effect on certain
16101 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
16102 are enabled; for standalone applications the default is off.
16103 @end table
16105 @node C6X Options
16106 @subsection C6X Options
16107 @cindex C6X Options
16109 @table @gcctabopt
16110 @item -march=@var{name}
16111 @opindex march
16112 This specifies the name of the target architecture.  GCC uses this
16113 name to determine what kind of instructions it can emit when generating
16114 assembly code.  Permissible names are: @samp{c62x},
16115 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
16117 @item -mbig-endian
16118 @opindex mbig-endian
16119 Generate code for a big-endian target.
16121 @item -mlittle-endian
16122 @opindex mlittle-endian
16123 Generate code for a little-endian target.  This is the default.
16125 @item -msim
16126 @opindex msim
16127 Choose startup files and linker script suitable for the simulator.
16129 @item -msdata=default
16130 @opindex msdata=default
16131 Put small global and static data in the @code{.neardata} section,
16132 which is pointed to by register @code{B14}.  Put small uninitialized
16133 global and static data in the @code{.bss} section, which is adjacent
16134 to the @code{.neardata} section.  Put small read-only data into the
16135 @code{.rodata} section.  The corresponding sections used for large
16136 pieces of data are @code{.fardata}, @code{.far} and @code{.const}.
16138 @item -msdata=all
16139 @opindex msdata=all
16140 Put all data, not just small objects, into the sections reserved for
16141 small data, and use addressing relative to the @code{B14} register to
16142 access them.
16144 @item -msdata=none
16145 @opindex msdata=none
16146 Make no use of the sections reserved for small data, and use absolute
16147 addresses to access all data.  Put all initialized global and static
16148 data in the @code{.fardata} section, and all uninitialized data in the
16149 @code{.far} section.  Put all constant data into the @code{.const}
16150 section.
16151 @end table
16153 @node CRIS Options
16154 @subsection CRIS Options
16155 @cindex CRIS Options
16157 These options are defined specifically for the CRIS ports.
16159 @table @gcctabopt
16160 @item -march=@var{architecture-type}
16161 @itemx -mcpu=@var{architecture-type}
16162 @opindex march
16163 @opindex mcpu
16164 Generate code for the specified architecture.  The choices for
16165 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
16166 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
16167 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
16168 @samp{v10}.
16170 @item -mtune=@var{architecture-type}
16171 @opindex mtune
16172 Tune to @var{architecture-type} everything applicable about the generated
16173 code, except for the ABI and the set of available instructions.  The
16174 choices for @var{architecture-type} are the same as for
16175 @option{-march=@var{architecture-type}}.
16177 @item -mmax-stack-frame=@var{n}
16178 @opindex mmax-stack-frame
16179 Warn when the stack frame of a function exceeds @var{n} bytes.
16181 @item -metrax4
16182 @itemx -metrax100
16183 @opindex metrax4
16184 @opindex metrax100
16185 The options @option{-metrax4} and @option{-metrax100} are synonyms for
16186 @option{-march=v3} and @option{-march=v8} respectively.
16188 @item -mmul-bug-workaround
16189 @itemx -mno-mul-bug-workaround
16190 @opindex mmul-bug-workaround
16191 @opindex mno-mul-bug-workaround
16192 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
16193 models where it applies.  This option is active by default.
16195 @item -mpdebug
16196 @opindex mpdebug
16197 Enable CRIS-specific verbose debug-related information in the assembly
16198 code.  This option also has the effect of turning off the @samp{#NO_APP}
16199 formatted-code indicator to the assembler at the beginning of the
16200 assembly file.
16202 @item -mcc-init
16203 @opindex mcc-init
16204 Do not use condition-code results from previous instruction; always emit
16205 compare and test instructions before use of condition codes.
16207 @item -mno-side-effects
16208 @opindex mno-side-effects
16209 Do not emit instructions with side effects in addressing modes other than
16210 post-increment.
16212 @item -mstack-align
16213 @itemx -mno-stack-align
16214 @itemx -mdata-align
16215 @itemx -mno-data-align
16216 @itemx -mconst-align
16217 @itemx -mno-const-align
16218 @opindex mstack-align
16219 @opindex mno-stack-align
16220 @opindex mdata-align
16221 @opindex mno-data-align
16222 @opindex mconst-align
16223 @opindex mno-const-align
16224 These options (@samp{no-} options) arrange (eliminate arrangements) for the
16225 stack frame, individual data and constants to be aligned for the maximum
16226 single data access size for the chosen CPU model.  The default is to
16227 arrange for 32-bit alignment.  ABI details such as structure layout are
16228 not affected by these options.
16230 @item -m32-bit
16231 @itemx -m16-bit
16232 @itemx -m8-bit
16233 @opindex m32-bit
16234 @opindex m16-bit
16235 @opindex m8-bit
16236 Similar to the stack- data- and const-align options above, these options
16237 arrange for stack frame, writable data and constants to all be 32-bit,
16238 16-bit or 8-bit aligned.  The default is 32-bit alignment.
16240 @item -mno-prologue-epilogue
16241 @itemx -mprologue-epilogue
16242 @opindex mno-prologue-epilogue
16243 @opindex mprologue-epilogue
16244 With @option{-mno-prologue-epilogue}, the normal function prologue and
16245 epilogue which set up the stack frame are omitted and no return
16246 instructions or return sequences are generated in the code.  Use this
16247 option only together with visual inspection of the compiled code: no
16248 warnings or errors are generated when call-saved registers must be saved,
16249 or storage for local variables needs to be allocated.
16251 @item -mno-gotplt
16252 @itemx -mgotplt
16253 @opindex mno-gotplt
16254 @opindex mgotplt
16255 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
16256 instruction sequences that load addresses for functions from the PLT part
16257 of the GOT rather than (traditional on other architectures) calls to the
16258 PLT@.  The default is @option{-mgotplt}.
16260 @item -melf
16261 @opindex melf
16262 Legacy no-op option only recognized with the cris-axis-elf and
16263 cris-axis-linux-gnu targets.
16265 @item -mlinux
16266 @opindex mlinux
16267 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
16269 @item -sim
16270 @opindex sim
16271 This option, recognized for the cris-axis-elf, arranges
16272 to link with input-output functions from a simulator library.  Code,
16273 initialized data and zero-initialized data are allocated consecutively.
16275 @item -sim2
16276 @opindex sim2
16277 Like @option{-sim}, but pass linker options to locate initialized data at
16278 0x40000000 and zero-initialized data at 0x80000000.
16279 @end table
16281 @node CR16 Options
16282 @subsection CR16 Options
16283 @cindex CR16 Options
16285 These options are defined specifically for the CR16 ports.
16287 @table @gcctabopt
16289 @item -mmac
16290 @opindex mmac
16291 Enable the use of multiply-accumulate instructions. Disabled by default.
16293 @item -mcr16cplus
16294 @itemx -mcr16c
16295 @opindex mcr16cplus
16296 @opindex mcr16c
16297 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
16298 is default.
16300 @item -msim
16301 @opindex msim
16302 Links the library libsim.a which is in compatible with simulator. Applicable
16303 to ELF compiler only.
16305 @item -mint32
16306 @opindex mint32
16307 Choose integer type as 32-bit wide.
16309 @item -mbit-ops
16310 @opindex mbit-ops
16311 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
16313 @item -mdata-model=@var{model}
16314 @opindex mdata-model
16315 Choose a data model. The choices for @var{model} are @samp{near},
16316 @samp{far} or @samp{medium}. @samp{medium} is default.
16317 However, @samp{far} is not valid with @option{-mcr16c}, as the
16318 CR16C architecture does not support the far data model.
16319 @end table
16321 @node Darwin Options
16322 @subsection Darwin Options
16323 @cindex Darwin options
16325 These options are defined for all architectures running the Darwin operating
16326 system.
16328 FSF GCC on Darwin does not create ``fat'' object files; it creates
16329 an object file for the single architecture that GCC was built to
16330 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
16331 @option{-arch} options are used; it does so by running the compiler or
16332 linker multiple times and joining the results together with
16333 @file{lipo}.
16335 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
16336 @samp{i686}) is determined by the flags that specify the ISA
16337 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
16338 @option{-force_cpusubtype_ALL} option can be used to override this.
16340 The Darwin tools vary in their behavior when presented with an ISA
16341 mismatch.  The assembler, @file{as}, only permits instructions to
16342 be used that are valid for the subtype of the file it is generating,
16343 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
16344 The linker for shared libraries, @file{/usr/bin/libtool}, fails
16345 and prints an error if asked to create a shared library with a less
16346 restrictive subtype than its input files (for instance, trying to put
16347 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
16348 for executables, @command{ld}, quietly gives the executable the most
16349 restrictive subtype of any of its input files.
16351 @table @gcctabopt
16352 @item -F@var{dir}
16353 @opindex F
16354 Add the framework directory @var{dir} to the head of the list of
16355 directories to be searched for header files.  These directories are
16356 interleaved with those specified by @option{-I} options and are
16357 scanned in a left-to-right order.
16359 A framework directory is a directory with frameworks in it.  A
16360 framework is a directory with a @file{Headers} and/or
16361 @file{PrivateHeaders} directory contained directly in it that ends
16362 in @file{.framework}.  The name of a framework is the name of this
16363 directory excluding the @file{.framework}.  Headers associated with
16364 the framework are found in one of those two directories, with
16365 @file{Headers} being searched first.  A subframework is a framework
16366 directory that is in a framework's @file{Frameworks} directory.
16367 Includes of subframework headers can only appear in a header of a
16368 framework that contains the subframework, or in a sibling subframework
16369 header.  Two subframeworks are siblings if they occur in the same
16370 framework.  A subframework should not have the same name as a
16371 framework; a warning is issued if this is violated.  Currently a
16372 subframework cannot have subframeworks; in the future, the mechanism
16373 may be extended to support this.  The standard frameworks can be found
16374 in @file{/System/Library/Frameworks} and
16375 @file{/Library/Frameworks}.  An example include looks like
16376 @code{#include <Framework/header.h>}, where @file{Framework} denotes
16377 the name of the framework and @file{header.h} is found in the
16378 @file{PrivateHeaders} or @file{Headers} directory.
16380 @item -iframework@var{dir}
16381 @opindex iframework
16382 Like @option{-F} except the directory is a treated as a system
16383 directory.  The main difference between this @option{-iframework} and
16384 @option{-F} is that with @option{-iframework} the compiler does not
16385 warn about constructs contained within header files found via
16386 @var{dir}.  This option is valid only for the C family of languages.
16388 @item -gused
16389 @opindex gused
16390 Emit debugging information for symbols that are used.  For stabs
16391 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
16392 This is by default ON@.
16394 @item -gfull
16395 @opindex gfull
16396 Emit debugging information for all symbols and types.
16398 @item -mmacosx-version-min=@var{version}
16399 The earliest version of MacOS X that this executable will run on
16400 is @var{version}.  Typical values of @var{version} include @code{10.1},
16401 @code{10.2}, and @code{10.3.9}.
16403 If the compiler was built to use the system's headers by default,
16404 then the default for this option is the system version on which the
16405 compiler is running, otherwise the default is to make choices that
16406 are compatible with as many systems and code bases as possible.
16408 @item -mkernel
16409 @opindex mkernel
16410 Enable kernel development mode.  The @option{-mkernel} option sets
16411 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
16412 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
16413 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
16414 applicable.  This mode also sets @option{-mno-altivec},
16415 @option{-msoft-float}, @option{-fno-builtin} and
16416 @option{-mlong-branch} for PowerPC targets.
16418 @item -mone-byte-bool
16419 @opindex mone-byte-bool
16420 Override the defaults for @code{bool} so that @code{sizeof(bool)==1}.
16421 By default @code{sizeof(bool)} is @code{4} when compiling for
16422 Darwin/PowerPC and @code{1} when compiling for Darwin/x86, so this
16423 option has no effect on x86.
16425 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
16426 to generate code that is not binary compatible with code generated
16427 without that switch.  Using this switch may require recompiling all
16428 other modules in a program, including system libraries.  Use this
16429 switch to conform to a non-default data model.
16431 @item -mfix-and-continue
16432 @itemx -ffix-and-continue
16433 @itemx -findirect-data
16434 @opindex mfix-and-continue
16435 @opindex ffix-and-continue
16436 @opindex findirect-data
16437 Generate code suitable for fast turnaround development, such as to
16438 allow GDB to dynamically load @file{.o} files into already-running
16439 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
16440 are provided for backwards compatibility.
16442 @item -all_load
16443 @opindex all_load
16444 Loads all members of static archive libraries.
16445 See man ld(1) for more information.
16447 @item -arch_errors_fatal
16448 @opindex arch_errors_fatal
16449 Cause the errors having to do with files that have the wrong architecture
16450 to be fatal.
16452 @item -bind_at_load
16453 @opindex bind_at_load
16454 Causes the output file to be marked such that the dynamic linker will
16455 bind all undefined references when the file is loaded or launched.
16457 @item -bundle
16458 @opindex bundle
16459 Produce a Mach-o bundle format file.
16460 See man ld(1) for more information.
16462 @item -bundle_loader @var{executable}
16463 @opindex bundle_loader
16464 This option specifies the @var{executable} that will load the build
16465 output file being linked.  See man ld(1) for more information.
16467 @item -dynamiclib
16468 @opindex dynamiclib
16469 When passed this option, GCC produces a dynamic library instead of
16470 an executable when linking, using the Darwin @file{libtool} command.
16472 @item -force_cpusubtype_ALL
16473 @opindex force_cpusubtype_ALL
16474 This causes GCC's output file to have the @samp{ALL} subtype, instead of
16475 one controlled by the @option{-mcpu} or @option{-march} option.
16477 @item -allowable_client  @var{client_name}
16478 @itemx -client_name
16479 @itemx -compatibility_version
16480 @itemx -current_version
16481 @itemx -dead_strip
16482 @itemx -dependency-file
16483 @itemx -dylib_file
16484 @itemx -dylinker_install_name
16485 @itemx -dynamic
16486 @itemx -exported_symbols_list
16487 @itemx -filelist
16488 @need 800
16489 @itemx -flat_namespace
16490 @itemx -force_flat_namespace
16491 @itemx -headerpad_max_install_names
16492 @itemx -image_base
16493 @itemx -init
16494 @itemx -install_name
16495 @itemx -keep_private_externs
16496 @itemx -multi_module
16497 @itemx -multiply_defined
16498 @itemx -multiply_defined_unused
16499 @need 800
16500 @itemx -noall_load
16501 @itemx -no_dead_strip_inits_and_terms
16502 @itemx -nofixprebinding
16503 @itemx -nomultidefs
16504 @itemx -noprebind
16505 @itemx -noseglinkedit
16506 @itemx -pagezero_size
16507 @itemx -prebind
16508 @itemx -prebind_all_twolevel_modules
16509 @itemx -private_bundle
16510 @need 800
16511 @itemx -read_only_relocs
16512 @itemx -sectalign
16513 @itemx -sectobjectsymbols
16514 @itemx -whyload
16515 @itemx -seg1addr
16516 @itemx -sectcreate
16517 @itemx -sectobjectsymbols
16518 @itemx -sectorder
16519 @itemx -segaddr
16520 @itemx -segs_read_only_addr
16521 @need 800
16522 @itemx -segs_read_write_addr
16523 @itemx -seg_addr_table
16524 @itemx -seg_addr_table_filename
16525 @itemx -seglinkedit
16526 @itemx -segprot
16527 @itemx -segs_read_only_addr
16528 @itemx -segs_read_write_addr
16529 @itemx -single_module
16530 @itemx -static
16531 @itemx -sub_library
16532 @need 800
16533 @itemx -sub_umbrella
16534 @itemx -twolevel_namespace
16535 @itemx -umbrella
16536 @itemx -undefined
16537 @itemx -unexported_symbols_list
16538 @itemx -weak_reference_mismatches
16539 @itemx -whatsloaded
16540 @opindex allowable_client
16541 @opindex client_name
16542 @opindex compatibility_version
16543 @opindex current_version
16544 @opindex dead_strip
16545 @opindex dependency-file
16546 @opindex dylib_file
16547 @opindex dylinker_install_name
16548 @opindex dynamic
16549 @opindex exported_symbols_list
16550 @opindex filelist
16551 @opindex flat_namespace
16552 @opindex force_flat_namespace
16553 @opindex headerpad_max_install_names
16554 @opindex image_base
16555 @opindex init
16556 @opindex install_name
16557 @opindex keep_private_externs
16558 @opindex multi_module
16559 @opindex multiply_defined
16560 @opindex multiply_defined_unused
16561 @opindex noall_load
16562 @opindex no_dead_strip_inits_and_terms
16563 @opindex nofixprebinding
16564 @opindex nomultidefs
16565 @opindex noprebind
16566 @opindex noseglinkedit
16567 @opindex pagezero_size
16568 @opindex prebind
16569 @opindex prebind_all_twolevel_modules
16570 @opindex private_bundle
16571 @opindex read_only_relocs
16572 @opindex sectalign
16573 @opindex sectobjectsymbols
16574 @opindex whyload
16575 @opindex seg1addr
16576 @opindex sectcreate
16577 @opindex sectobjectsymbols
16578 @opindex sectorder
16579 @opindex segaddr
16580 @opindex segs_read_only_addr
16581 @opindex segs_read_write_addr
16582 @opindex seg_addr_table
16583 @opindex seg_addr_table_filename
16584 @opindex seglinkedit
16585 @opindex segprot
16586 @opindex segs_read_only_addr
16587 @opindex segs_read_write_addr
16588 @opindex single_module
16589 @opindex static
16590 @opindex sub_library
16591 @opindex sub_umbrella
16592 @opindex twolevel_namespace
16593 @opindex umbrella
16594 @opindex undefined
16595 @opindex unexported_symbols_list
16596 @opindex weak_reference_mismatches
16597 @opindex whatsloaded
16598 These options are passed to the Darwin linker.  The Darwin linker man page
16599 describes them in detail.
16600 @end table
16602 @node DEC Alpha Options
16603 @subsection DEC Alpha Options
16605 These @samp{-m} options are defined for the DEC Alpha implementations:
16607 @table @gcctabopt
16608 @item -mno-soft-float
16609 @itemx -msoft-float
16610 @opindex mno-soft-float
16611 @opindex msoft-float
16612 Use (do not use) the hardware floating-point instructions for
16613 floating-point operations.  When @option{-msoft-float} is specified,
16614 functions in @file{libgcc.a} are used to perform floating-point
16615 operations.  Unless they are replaced by routines that emulate the
16616 floating-point operations, or compiled in such a way as to call such
16617 emulations routines, these routines issue floating-point
16618 operations.   If you are compiling for an Alpha without floating-point
16619 operations, you must ensure that the library is built so as not to call
16620 them.
16622 Note that Alpha implementations without floating-point operations are
16623 required to have floating-point registers.
16625 @item -mfp-reg
16626 @itemx -mno-fp-regs
16627 @opindex mfp-reg
16628 @opindex mno-fp-regs
16629 Generate code that uses (does not use) the floating-point register set.
16630 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
16631 register set is not used, floating-point operands are passed in integer
16632 registers as if they were integers and floating-point results are passed
16633 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
16634 so any function with a floating-point argument or return value called by code
16635 compiled with @option{-mno-fp-regs} must also be compiled with that
16636 option.
16638 A typical use of this option is building a kernel that does not use,
16639 and hence need not save and restore, any floating-point registers.
16641 @item -mieee
16642 @opindex mieee
16643 The Alpha architecture implements floating-point hardware optimized for
16644 maximum performance.  It is mostly compliant with the IEEE floating-point
16645 standard.  However, for full compliance, software assistance is
16646 required.  This option generates code fully IEEE-compliant code
16647 @emph{except} that the @var{inexact-flag} is not maintained (see below).
16648 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
16649 defined during compilation.  The resulting code is less efficient but is
16650 able to correctly support denormalized numbers and exceptional IEEE
16651 values such as not-a-number and plus/minus infinity.  Other Alpha
16652 compilers call this option @option{-ieee_with_no_inexact}.
16654 @item -mieee-with-inexact
16655 @opindex mieee-with-inexact
16656 This is like @option{-mieee} except the generated code also maintains
16657 the IEEE @var{inexact-flag}.  Turning on this option causes the
16658 generated code to implement fully-compliant IEEE math.  In addition to
16659 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
16660 macro.  On some Alpha implementations the resulting code may execute
16661 significantly slower than the code generated by default.  Since there is
16662 very little code that depends on the @var{inexact-flag}, you should
16663 normally not specify this option.  Other Alpha compilers call this
16664 option @option{-ieee_with_inexact}.
16666 @item -mfp-trap-mode=@var{trap-mode}
16667 @opindex mfp-trap-mode
16668 This option controls what floating-point related traps are enabled.
16669 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
16670 The trap mode can be set to one of four values:
16672 @table @samp
16673 @item n
16674 This is the default (normal) setting.  The only traps that are enabled
16675 are the ones that cannot be disabled in software (e.g., division by zero
16676 trap).
16678 @item u
16679 In addition to the traps enabled by @samp{n}, underflow traps are enabled
16680 as well.
16682 @item su
16683 Like @samp{u}, but the instructions are marked to be safe for software
16684 completion (see Alpha architecture manual for details).
16686 @item sui
16687 Like @samp{su}, but inexact traps are enabled as well.
16688 @end table
16690 @item -mfp-rounding-mode=@var{rounding-mode}
16691 @opindex mfp-rounding-mode
16692 Selects the IEEE rounding mode.  Other Alpha compilers call this option
16693 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
16696 @table @samp
16697 @item n
16698 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
16699 the nearest machine number or towards the even machine number in case
16700 of a tie.
16702 @item m
16703 Round towards minus infinity.
16705 @item c
16706 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
16708 @item d
16709 Dynamic rounding mode.  A field in the floating-point control register
16710 (@var{fpcr}, see Alpha architecture reference manual) controls the
16711 rounding mode in effect.  The C library initializes this register for
16712 rounding towards plus infinity.  Thus, unless your program modifies the
16713 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
16714 @end table
16716 @item -mtrap-precision=@var{trap-precision}
16717 @opindex mtrap-precision
16718 In the Alpha architecture, floating-point traps are imprecise.  This
16719 means without software assistance it is impossible to recover from a
16720 floating trap and program execution normally needs to be terminated.
16721 GCC can generate code that can assist operating system trap handlers
16722 in determining the exact location that caused a floating-point trap.
16723 Depending on the requirements of an application, different levels of
16724 precisions can be selected:
16726 @table @samp
16727 @item p
16728 Program precision.  This option is the default and means a trap handler
16729 can only identify which program caused a floating-point exception.
16731 @item f
16732 Function precision.  The trap handler can determine the function that
16733 caused a floating-point exception.
16735 @item i
16736 Instruction precision.  The trap handler can determine the exact
16737 instruction that caused a floating-point exception.
16738 @end table
16740 Other Alpha compilers provide the equivalent options called
16741 @option{-scope_safe} and @option{-resumption_safe}.
16743 @item -mieee-conformant
16744 @opindex mieee-conformant
16745 This option marks the generated code as IEEE conformant.  You must not
16746 use this option unless you also specify @option{-mtrap-precision=i} and either
16747 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
16748 is to emit the line @samp{.eflag 48} in the function prologue of the
16749 generated assembly file.
16751 @item -mbuild-constants
16752 @opindex mbuild-constants
16753 Normally GCC examines a 32- or 64-bit integer constant to
16754 see if it can construct it from smaller constants in two or three
16755 instructions.  If it cannot, it outputs the constant as a literal and
16756 generates code to load it from the data segment at run time.
16758 Use this option to require GCC to construct @emph{all} integer constants
16759 using code, even if it takes more instructions (the maximum is six).
16761 You typically use this option to build a shared library dynamic
16762 loader.  Itself a shared library, it must relocate itself in memory
16763 before it can find the variables and constants in its own data segment.
16765 @item -mbwx
16766 @itemx -mno-bwx
16767 @itemx -mcix
16768 @itemx -mno-cix
16769 @itemx -mfix
16770 @itemx -mno-fix
16771 @itemx -mmax
16772 @itemx -mno-max
16773 @opindex mbwx
16774 @opindex mno-bwx
16775 @opindex mcix
16776 @opindex mno-cix
16777 @opindex mfix
16778 @opindex mno-fix
16779 @opindex mmax
16780 @opindex mno-max
16781 Indicate whether GCC should generate code to use the optional BWX,
16782 CIX, FIX and MAX instruction sets.  The default is to use the instruction
16783 sets supported by the CPU type specified via @option{-mcpu=} option or that
16784 of the CPU on which GCC was built if none is specified.
16786 @item -mfloat-vax
16787 @itemx -mfloat-ieee
16788 @opindex mfloat-vax
16789 @opindex mfloat-ieee
16790 Generate code that uses (does not use) VAX F and G floating-point
16791 arithmetic instead of IEEE single and double precision.
16793 @item -mexplicit-relocs
16794 @itemx -mno-explicit-relocs
16795 @opindex mexplicit-relocs
16796 @opindex mno-explicit-relocs
16797 Older Alpha assemblers provided no way to generate symbol relocations
16798 except via assembler macros.  Use of these macros does not allow
16799 optimal instruction scheduling.  GNU binutils as of version 2.12
16800 supports a new syntax that allows the compiler to explicitly mark
16801 which relocations should apply to which instructions.  This option
16802 is mostly useful for debugging, as GCC detects the capabilities of
16803 the assembler when it is built and sets the default accordingly.
16805 @item -msmall-data
16806 @itemx -mlarge-data
16807 @opindex msmall-data
16808 @opindex mlarge-data
16809 When @option{-mexplicit-relocs} is in effect, static data is
16810 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
16811 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
16812 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
16813 16-bit relocations off of the @code{$gp} register.  This limits the
16814 size of the small data area to 64KB, but allows the variables to be
16815 directly accessed via a single instruction.
16817 The default is @option{-mlarge-data}.  With this option the data area
16818 is limited to just below 2GB@.  Programs that require more than 2GB of
16819 data must use @code{malloc} or @code{mmap} to allocate the data in the
16820 heap instead of in the program's data segment.
16822 When generating code for shared libraries, @option{-fpic} implies
16823 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
16825 @item -msmall-text
16826 @itemx -mlarge-text
16827 @opindex msmall-text
16828 @opindex mlarge-text
16829 When @option{-msmall-text} is used, the compiler assumes that the
16830 code of the entire program (or shared library) fits in 4MB, and is
16831 thus reachable with a branch instruction.  When @option{-msmall-data}
16832 is used, the compiler can assume that all local symbols share the
16833 same @code{$gp} value, and thus reduce the number of instructions
16834 required for a function call from 4 to 1.
16836 The default is @option{-mlarge-text}.
16838 @item -mcpu=@var{cpu_type}
16839 @opindex mcpu
16840 Set the instruction set and instruction scheduling parameters for
16841 machine type @var{cpu_type}.  You can specify either the @samp{EV}
16842 style name or the corresponding chip number.  GCC supports scheduling
16843 parameters for the EV4, EV5 and EV6 family of processors and
16844 chooses the default values for the instruction set from the processor
16845 you specify.  If you do not specify a processor type, GCC defaults
16846 to the processor on which the compiler was built.
16848 Supported values for @var{cpu_type} are
16850 @table @samp
16851 @item ev4
16852 @itemx ev45
16853 @itemx 21064
16854 Schedules as an EV4 and has no instruction set extensions.
16856 @item ev5
16857 @itemx 21164
16858 Schedules as an EV5 and has no instruction set extensions.
16860 @item ev56
16861 @itemx 21164a
16862 Schedules as an EV5 and supports the BWX extension.
16864 @item pca56
16865 @itemx 21164pc
16866 @itemx 21164PC
16867 Schedules as an EV5 and supports the BWX and MAX extensions.
16869 @item ev6
16870 @itemx 21264
16871 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
16873 @item ev67
16874 @itemx 21264a
16875 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
16876 @end table
16878 Native toolchains also support the value @samp{native},
16879 which selects the best architecture option for the host processor.
16880 @option{-mcpu=native} has no effect if GCC does not recognize
16881 the processor.
16883 @item -mtune=@var{cpu_type}
16884 @opindex mtune
16885 Set only the instruction scheduling parameters for machine type
16886 @var{cpu_type}.  The instruction set is not changed.
16888 Native toolchains also support the value @samp{native},
16889 which selects the best architecture option for the host processor.
16890 @option{-mtune=native} has no effect if GCC does not recognize
16891 the processor.
16893 @item -mmemory-latency=@var{time}
16894 @opindex mmemory-latency
16895 Sets the latency the scheduler should assume for typical memory
16896 references as seen by the application.  This number is highly
16897 dependent on the memory access patterns used by the application
16898 and the size of the external cache on the machine.
16900 Valid options for @var{time} are
16902 @table @samp
16903 @item @var{number}
16904 A decimal number representing clock cycles.
16906 @item L1
16907 @itemx L2
16908 @itemx L3
16909 @itemx main
16910 The compiler contains estimates of the number of clock cycles for
16911 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
16912 (also called Dcache, Scache, and Bcache), as well as to main memory.
16913 Note that L3 is only valid for EV5.
16915 @end table
16916 @end table
16918 @node FR30 Options
16919 @subsection FR30 Options
16920 @cindex FR30 Options
16922 These options are defined specifically for the FR30 port.
16924 @table @gcctabopt
16926 @item -msmall-model
16927 @opindex msmall-model
16928 Use the small address space model.  This can produce smaller code, but
16929 it does assume that all symbolic values and addresses fit into a
16930 20-bit range.
16932 @item -mno-lsim
16933 @opindex mno-lsim
16934 Assume that runtime support has been provided and so there is no need
16935 to include the simulator library (@file{libsim.a}) on the linker
16936 command line.
16938 @end table
16940 @node FT32 Options
16941 @subsection FT32 Options
16942 @cindex FT32 Options
16944 These options are defined specifically for the FT32 port.
16946 @table @gcctabopt
16948 @item -msim
16949 @opindex msim
16950 Specifies that the program will be run on the simulator.  This causes
16951 an alternate runtime startup and library to be linked.
16952 You must not use this option when generating programs that will run on
16953 real hardware; you must provide your own runtime library for whatever
16954 I/O functions are needed.
16956 @item -mlra
16957 @opindex mlra
16958 Enable Local Register Allocation.  This is still experimental for FT32,
16959 so by default the compiler uses standard reload.
16961 @item -mnodiv
16962 @opindex mnodiv
16963 Do not use div and mod instructions.
16965 @end table
16967 @node FRV Options
16968 @subsection FRV Options
16969 @cindex FRV Options
16971 @table @gcctabopt
16972 @item -mgpr-32
16973 @opindex mgpr-32
16975 Only use the first 32 general-purpose registers.
16977 @item -mgpr-64
16978 @opindex mgpr-64
16980 Use all 64 general-purpose registers.
16982 @item -mfpr-32
16983 @opindex mfpr-32
16985 Use only the first 32 floating-point registers.
16987 @item -mfpr-64
16988 @opindex mfpr-64
16990 Use all 64 floating-point registers.
16992 @item -mhard-float
16993 @opindex mhard-float
16995 Use hardware instructions for floating-point operations.
16997 @item -msoft-float
16998 @opindex msoft-float
17000 Use library routines for floating-point operations.
17002 @item -malloc-cc
17003 @opindex malloc-cc
17005 Dynamically allocate condition code registers.
17007 @item -mfixed-cc
17008 @opindex mfixed-cc
17010 Do not try to dynamically allocate condition code registers, only
17011 use @code{icc0} and @code{fcc0}.
17013 @item -mdword
17014 @opindex mdword
17016 Change ABI to use double word insns.
17018 @item -mno-dword
17019 @opindex mno-dword
17021 Do not use double word instructions.
17023 @item -mdouble
17024 @opindex mdouble
17026 Use floating-point double instructions.
17028 @item -mno-double
17029 @opindex mno-double
17031 Do not use floating-point double instructions.
17033 @item -mmedia
17034 @opindex mmedia
17036 Use media instructions.
17038 @item -mno-media
17039 @opindex mno-media
17041 Do not use media instructions.
17043 @item -mmuladd
17044 @opindex mmuladd
17046 Use multiply and add/subtract instructions.
17048 @item -mno-muladd
17049 @opindex mno-muladd
17051 Do not use multiply and add/subtract instructions.
17053 @item -mfdpic
17054 @opindex mfdpic
17056 Select the FDPIC ABI, which uses function descriptors to represent
17057 pointers to functions.  Without any PIC/PIE-related options, it
17058 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
17059 assumes GOT entries and small data are within a 12-bit range from the
17060 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
17061 are computed with 32 bits.
17062 With a @samp{bfin-elf} target, this option implies @option{-msim}.
17064 @item -minline-plt
17065 @opindex minline-plt
17067 Enable inlining of PLT entries in function calls to functions that are
17068 not known to bind locally.  It has no effect without @option{-mfdpic}.
17069 It's enabled by default if optimizing for speed and compiling for
17070 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
17071 optimization option such as @option{-O3} or above is present in the
17072 command line.
17074 @item -mTLS
17075 @opindex mTLS
17077 Assume a large TLS segment when generating thread-local code.
17079 @item -mtls
17080 @opindex mtls
17082 Do not assume a large TLS segment when generating thread-local code.
17084 @item -mgprel-ro
17085 @opindex mgprel-ro
17087 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
17088 that is known to be in read-only sections.  It's enabled by default,
17089 except for @option{-fpic} or @option{-fpie}: even though it may help
17090 make the global offset table smaller, it trades 1 instruction for 4.
17091 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
17092 one of which may be shared by multiple symbols, and it avoids the need
17093 for a GOT entry for the referenced symbol, so it's more likely to be a
17094 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
17096 @item -multilib-library-pic
17097 @opindex multilib-library-pic
17099 Link with the (library, not FD) pic libraries.  It's implied by
17100 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
17101 @option{-fpic} without @option{-mfdpic}.  You should never have to use
17102 it explicitly.
17104 @item -mlinked-fp
17105 @opindex mlinked-fp
17107 Follow the EABI requirement of always creating a frame pointer whenever
17108 a stack frame is allocated.  This option is enabled by default and can
17109 be disabled with @option{-mno-linked-fp}.
17111 @item -mlong-calls
17112 @opindex mlong-calls
17114 Use indirect addressing to call functions outside the current
17115 compilation unit.  This allows the functions to be placed anywhere
17116 within the 32-bit address space.
17118 @item -malign-labels
17119 @opindex malign-labels
17121 Try to align labels to an 8-byte boundary by inserting NOPs into the
17122 previous packet.  This option only has an effect when VLIW packing
17123 is enabled.  It doesn't create new packets; it merely adds NOPs to
17124 existing ones.
17126 @item -mlibrary-pic
17127 @opindex mlibrary-pic
17129 Generate position-independent EABI code.
17131 @item -macc-4
17132 @opindex macc-4
17134 Use only the first four media accumulator registers.
17136 @item -macc-8
17137 @opindex macc-8
17139 Use all eight media accumulator registers.
17141 @item -mpack
17142 @opindex mpack
17144 Pack VLIW instructions.
17146 @item -mno-pack
17147 @opindex mno-pack
17149 Do not pack VLIW instructions.
17151 @item -mno-eflags
17152 @opindex mno-eflags
17154 Do not mark ABI switches in e_flags.
17156 @item -mcond-move
17157 @opindex mcond-move
17159 Enable the use of conditional-move instructions (default).
17161 This switch is mainly for debugging the compiler and will likely be removed
17162 in a future version.
17164 @item -mno-cond-move
17165 @opindex mno-cond-move
17167 Disable the use of conditional-move instructions.
17169 This switch is mainly for debugging the compiler and will likely be removed
17170 in a future version.
17172 @item -mscc
17173 @opindex mscc
17175 Enable the use of conditional set instructions (default).
17177 This switch is mainly for debugging the compiler and will likely be removed
17178 in a future version.
17180 @item -mno-scc
17181 @opindex mno-scc
17183 Disable the use of conditional set instructions.
17185 This switch is mainly for debugging the compiler and will likely be removed
17186 in a future version.
17188 @item -mcond-exec
17189 @opindex mcond-exec
17191 Enable the use of conditional execution (default).
17193 This switch is mainly for debugging the compiler and will likely be removed
17194 in a future version.
17196 @item -mno-cond-exec
17197 @opindex mno-cond-exec
17199 Disable the use of conditional execution.
17201 This switch is mainly for debugging the compiler and will likely be removed
17202 in a future version.
17204 @item -mvliw-branch
17205 @opindex mvliw-branch
17207 Run a pass to pack branches into VLIW instructions (default).
17209 This switch is mainly for debugging the compiler and will likely be removed
17210 in a future version.
17212 @item -mno-vliw-branch
17213 @opindex mno-vliw-branch
17215 Do not run a pass to pack branches into VLIW instructions.
17217 This switch is mainly for debugging the compiler and will likely be removed
17218 in a future version.
17220 @item -mmulti-cond-exec
17221 @opindex mmulti-cond-exec
17223 Enable optimization of @code{&&} and @code{||} in conditional execution
17224 (default).
17226 This switch is mainly for debugging the compiler and will likely be removed
17227 in a future version.
17229 @item -mno-multi-cond-exec
17230 @opindex mno-multi-cond-exec
17232 Disable optimization of @code{&&} and @code{||} in conditional execution.
17234 This switch is mainly for debugging the compiler and will likely be removed
17235 in a future version.
17237 @item -mnested-cond-exec
17238 @opindex mnested-cond-exec
17240 Enable nested conditional execution optimizations (default).
17242 This switch is mainly for debugging the compiler and will likely be removed
17243 in a future version.
17245 @item -mno-nested-cond-exec
17246 @opindex mno-nested-cond-exec
17248 Disable nested conditional execution optimizations.
17250 This switch is mainly for debugging the compiler and will likely be removed
17251 in a future version.
17253 @item -moptimize-membar
17254 @opindex moptimize-membar
17256 This switch removes redundant @code{membar} instructions from the
17257 compiler-generated code.  It is enabled by default.
17259 @item -mno-optimize-membar
17260 @opindex mno-optimize-membar
17262 This switch disables the automatic removal of redundant @code{membar}
17263 instructions from the generated code.
17265 @item -mtomcat-stats
17266 @opindex mtomcat-stats
17268 Cause gas to print out tomcat statistics.
17270 @item -mcpu=@var{cpu}
17271 @opindex mcpu
17273 Select the processor type for which to generate code.  Possible values are
17274 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
17275 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
17277 @end table
17279 @node GNU/Linux Options
17280 @subsection GNU/Linux Options
17282 These @samp{-m} options are defined for GNU/Linux targets:
17284 @table @gcctabopt
17285 @item -mglibc
17286 @opindex mglibc
17287 Use the GNU C library.  This is the default except
17288 on @samp{*-*-linux-*uclibc*}, @samp{*-*-linux-*musl*} and
17289 @samp{*-*-linux-*android*} targets.
17291 @item -muclibc
17292 @opindex muclibc
17293 Use uClibc C library.  This is the default on
17294 @samp{*-*-linux-*uclibc*} targets.
17296 @item -mmusl
17297 @opindex mmusl
17298 Use the musl C library.  This is the default on
17299 @samp{*-*-linux-*musl*} targets.
17301 @item -mbionic
17302 @opindex mbionic
17303 Use Bionic C library.  This is the default on
17304 @samp{*-*-linux-*android*} targets.
17306 @item -mandroid
17307 @opindex mandroid
17308 Compile code compatible with Android platform.  This is the default on
17309 @samp{*-*-linux-*android*} targets.
17311 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
17312 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
17313 this option makes the GCC driver pass Android-specific options to the linker.
17314 Finally, this option causes the preprocessor macro @code{__ANDROID__}
17315 to be defined.
17317 @item -tno-android-cc
17318 @opindex tno-android-cc
17319 Disable compilation effects of @option{-mandroid}, i.e., do not enable
17320 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
17321 @option{-fno-rtti} by default.
17323 @item -tno-android-ld
17324 @opindex tno-android-ld
17325 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
17326 linking options to the linker.
17328 @end table
17330 @node H8/300 Options
17331 @subsection H8/300 Options
17333 These @samp{-m} options are defined for the H8/300 implementations:
17335 @table @gcctabopt
17336 @item -mrelax
17337 @opindex mrelax
17338 Shorten some address references at link time, when possible; uses the
17339 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
17340 ld, Using ld}, for a fuller description.
17342 @item -mh
17343 @opindex mh
17344 Generate code for the H8/300H@.
17346 @item -ms
17347 @opindex ms
17348 Generate code for the H8S@.
17350 @item -mn
17351 @opindex mn
17352 Generate code for the H8S and H8/300H in the normal mode.  This switch
17353 must be used either with @option{-mh} or @option{-ms}.
17355 @item -ms2600
17356 @opindex ms2600
17357 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
17359 @item -mexr
17360 @opindex mexr
17361 Extended registers are stored on stack before execution of function
17362 with monitor attribute. Default option is @option{-mexr}.
17363 This option is valid only for H8S targets.
17365 @item -mno-exr
17366 @opindex mno-exr
17367 Extended registers are not stored on stack before execution of function 
17368 with monitor attribute. Default option is @option{-mno-exr}. 
17369 This option is valid only for H8S targets.
17371 @item -mint32
17372 @opindex mint32
17373 Make @code{int} data 32 bits by default.
17375 @item -malign-300
17376 @opindex malign-300
17377 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
17378 The default for the H8/300H and H8S is to align longs and floats on
17379 4-byte boundaries.
17380 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
17381 This option has no effect on the H8/300.
17382 @end table
17384 @node HPPA Options
17385 @subsection HPPA Options
17386 @cindex HPPA Options
17388 These @samp{-m} options are defined for the HPPA family of computers:
17390 @table @gcctabopt
17391 @item -march=@var{architecture-type}
17392 @opindex march
17393 Generate code for the specified architecture.  The choices for
17394 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
17395 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
17396 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
17397 architecture option for your machine.  Code compiled for lower numbered
17398 architectures runs on higher numbered architectures, but not the
17399 other way around.
17401 @item -mpa-risc-1-0
17402 @itemx -mpa-risc-1-1
17403 @itemx -mpa-risc-2-0
17404 @opindex mpa-risc-1-0
17405 @opindex mpa-risc-1-1
17406 @opindex mpa-risc-2-0
17407 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
17409 @item -mcaller-copies
17410 @opindex mcaller-copies
17411 The caller copies function arguments passed by hidden reference.  This
17412 option should be used with care as it is not compatible with the default
17413 32-bit runtime.  However, only aggregates larger than eight bytes are
17414 passed by hidden reference and the option provides better compatibility
17415 with OpenMP.
17417 @item -mjump-in-delay
17418 @opindex mjump-in-delay
17419 This option is ignored and provided for compatibility purposes only.
17421 @item -mdisable-fpregs
17422 @opindex mdisable-fpregs
17423 Prevent floating-point registers from being used in any manner.  This is
17424 necessary for compiling kernels that perform lazy context switching of
17425 floating-point registers.  If you use this option and attempt to perform
17426 floating-point operations, the compiler aborts.
17428 @item -mdisable-indexing
17429 @opindex mdisable-indexing
17430 Prevent the compiler from using indexing address modes.  This avoids some
17431 rather obscure problems when compiling MIG generated code under MACH@.
17433 @item -mno-space-regs
17434 @opindex mno-space-regs
17435 Generate code that assumes the target has no space registers.  This allows
17436 GCC to generate faster indirect calls and use unscaled index address modes.
17438 Such code is suitable for level 0 PA systems and kernels.
17440 @item -mfast-indirect-calls
17441 @opindex mfast-indirect-calls
17442 Generate code that assumes calls never cross space boundaries.  This
17443 allows GCC to emit code that performs faster indirect calls.
17445 This option does not work in the presence of shared libraries or nested
17446 functions.
17448 @item -mfixed-range=@var{register-range}
17449 @opindex mfixed-range
17450 Generate code treating the given register range as fixed registers.
17451 A fixed register is one that the register allocator cannot use.  This is
17452 useful when compiling kernel code.  A register range is specified as
17453 two registers separated by a dash.  Multiple register ranges can be
17454 specified separated by a comma.
17456 @item -mlong-load-store
17457 @opindex mlong-load-store
17458 Generate 3-instruction load and store sequences as sometimes required by
17459 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
17460 the HP compilers.
17462 @item -mportable-runtime
17463 @opindex mportable-runtime
17464 Use the portable calling conventions proposed by HP for ELF systems.
17466 @item -mgas
17467 @opindex mgas
17468 Enable the use of assembler directives only GAS understands.
17470 @item -mschedule=@var{cpu-type}
17471 @opindex mschedule
17472 Schedule code according to the constraints for the machine type
17473 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
17474 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
17475 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
17476 proper scheduling option for your machine.  The default scheduling is
17477 @samp{8000}.
17479 @item -mlinker-opt
17480 @opindex mlinker-opt
17481 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
17482 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
17483 linkers in which they give bogus error messages when linking some programs.
17485 @item -msoft-float
17486 @opindex msoft-float
17487 Generate output containing library calls for floating point.
17488 @strong{Warning:} the requisite libraries are not available for all HPPA
17489 targets.  Normally the facilities of the machine's usual C compiler are
17490 used, but this cannot be done directly in cross-compilation.  You must make
17491 your own arrangements to provide suitable library functions for
17492 cross-compilation.
17494 @option{-msoft-float} changes the calling convention in the output file;
17495 therefore, it is only useful if you compile @emph{all} of a program with
17496 this option.  In particular, you need to compile @file{libgcc.a}, the
17497 library that comes with GCC, with @option{-msoft-float} in order for
17498 this to work.
17500 @item -msio
17501 @opindex msio
17502 Generate the predefine, @code{_SIO}, for server IO@.  The default is
17503 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
17504 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
17505 options are available under HP-UX and HI-UX@.
17507 @item -mgnu-ld
17508 @opindex mgnu-ld
17509 Use options specific to GNU @command{ld}.
17510 This passes @option{-shared} to @command{ld} when
17511 building a shared library.  It is the default when GCC is configured,
17512 explicitly or implicitly, with the GNU linker.  This option does not
17513 affect which @command{ld} is called; it only changes what parameters
17514 are passed to that @command{ld}.
17515 The @command{ld} that is called is determined by the
17516 @option{--with-ld} configure option, GCC's program search path, and
17517 finally by the user's @env{PATH}.  The linker used by GCC can be printed
17518 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
17519 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
17521 @item -mhp-ld
17522 @opindex mhp-ld
17523 Use options specific to HP @command{ld}.
17524 This passes @option{-b} to @command{ld} when building
17525 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
17526 links.  It is the default when GCC is configured, explicitly or
17527 implicitly, with the HP linker.  This option does not affect
17528 which @command{ld} is called; it only changes what parameters are passed to that
17529 @command{ld}.
17530 The @command{ld} that is called is determined by the @option{--with-ld}
17531 configure option, GCC's program search path, and finally by the user's
17532 @env{PATH}.  The linker used by GCC can be printed using @samp{which
17533 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
17534 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
17536 @item -mlong-calls
17537 @opindex mno-long-calls
17538 Generate code that uses long call sequences.  This ensures that a call
17539 is always able to reach linker generated stubs.  The default is to generate
17540 long calls only when the distance from the call site to the beginning
17541 of the function or translation unit, as the case may be, exceeds a
17542 predefined limit set by the branch type being used.  The limits for
17543 normal calls are 7,600,000 and 240,000 bytes, respectively for the
17544 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
17545 240,000 bytes.
17547 Distances are measured from the beginning of functions when using the
17548 @option{-ffunction-sections} option, or when using the @option{-mgas}
17549 and @option{-mno-portable-runtime} options together under HP-UX with
17550 the SOM linker.
17552 It is normally not desirable to use this option as it degrades
17553 performance.  However, it may be useful in large applications,
17554 particularly when partial linking is used to build the application.
17556 The types of long calls used depends on the capabilities of the
17557 assembler and linker, and the type of code being generated.  The
17558 impact on systems that support long absolute calls, and long pic
17559 symbol-difference or pc-relative calls should be relatively small.
17560 However, an indirect call is used on 32-bit ELF systems in pic code
17561 and it is quite long.
17563 @item -munix=@var{unix-std}
17564 @opindex march
17565 Generate compiler predefines and select a startfile for the specified
17566 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
17567 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
17568 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
17569 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
17570 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
17571 and later.
17573 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
17574 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
17575 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
17576 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
17577 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
17578 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
17580 It is @emph{important} to note that this option changes the interfaces
17581 for various library routines.  It also affects the operational behavior
17582 of the C library.  Thus, @emph{extreme} care is needed in using this
17583 option.
17585 Library code that is intended to operate with more than one UNIX
17586 standard must test, set and restore the variable @code{__xpg4_extended_mask}
17587 as appropriate.  Most GNU software doesn't provide this capability.
17589 @item -nolibdld
17590 @opindex nolibdld
17591 Suppress the generation of link options to search libdld.sl when the
17592 @option{-static} option is specified on HP-UX 10 and later.
17594 @item -static
17595 @opindex static
17596 The HP-UX implementation of setlocale in libc has a dependency on
17597 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
17598 when the @option{-static} option is specified, special link options
17599 are needed to resolve this dependency.
17601 On HP-UX 10 and later, the GCC driver adds the necessary options to
17602 link with libdld.sl when the @option{-static} option is specified.
17603 This causes the resulting binary to be dynamic.  On the 64-bit port,
17604 the linkers generate dynamic binaries by default in any case.  The
17605 @option{-nolibdld} option can be used to prevent the GCC driver from
17606 adding these link options.
17608 @item -threads
17609 @opindex threads
17610 Add support for multithreading with the @dfn{dce thread} library
17611 under HP-UX@.  This option sets flags for both the preprocessor and
17612 linker.
17613 @end table
17615 @node IA-64 Options
17616 @subsection IA-64 Options
17617 @cindex IA-64 Options
17619 These are the @samp{-m} options defined for the Intel IA-64 architecture.
17621 @table @gcctabopt
17622 @item -mbig-endian
17623 @opindex mbig-endian
17624 Generate code for a big-endian target.  This is the default for HP-UX@.
17626 @item -mlittle-endian
17627 @opindex mlittle-endian
17628 Generate code for a little-endian target.  This is the default for AIX5
17629 and GNU/Linux.
17631 @item -mgnu-as
17632 @itemx -mno-gnu-as
17633 @opindex mgnu-as
17634 @opindex mno-gnu-as
17635 Generate (or don't) code for the GNU assembler.  This is the default.
17636 @c Also, this is the default if the configure option @option{--with-gnu-as}
17637 @c is used.
17639 @item -mgnu-ld
17640 @itemx -mno-gnu-ld
17641 @opindex mgnu-ld
17642 @opindex mno-gnu-ld
17643 Generate (or don't) code for the GNU linker.  This is the default.
17644 @c Also, this is the default if the configure option @option{--with-gnu-ld}
17645 @c is used.
17647 @item -mno-pic
17648 @opindex mno-pic
17649 Generate code that does not use a global pointer register.  The result
17650 is not position independent code, and violates the IA-64 ABI@.
17652 @item -mvolatile-asm-stop
17653 @itemx -mno-volatile-asm-stop
17654 @opindex mvolatile-asm-stop
17655 @opindex mno-volatile-asm-stop
17656 Generate (or don't) a stop bit immediately before and after volatile asm
17657 statements.
17659 @item -mregister-names
17660 @itemx -mno-register-names
17661 @opindex mregister-names
17662 @opindex mno-register-names
17663 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
17664 the stacked registers.  This may make assembler output more readable.
17666 @item -mno-sdata
17667 @itemx -msdata
17668 @opindex mno-sdata
17669 @opindex msdata
17670 Disable (or enable) optimizations that use the small data section.  This may
17671 be useful for working around optimizer bugs.
17673 @item -mconstant-gp
17674 @opindex mconstant-gp
17675 Generate code that uses a single constant global pointer value.  This is
17676 useful when compiling kernel code.
17678 @item -mauto-pic
17679 @opindex mauto-pic
17680 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
17681 This is useful when compiling firmware code.
17683 @item -minline-float-divide-min-latency
17684 @opindex minline-float-divide-min-latency
17685 Generate code for inline divides of floating-point values
17686 using the minimum latency algorithm.
17688 @item -minline-float-divide-max-throughput
17689 @opindex minline-float-divide-max-throughput
17690 Generate code for inline divides of floating-point values
17691 using the maximum throughput algorithm.
17693 @item -mno-inline-float-divide
17694 @opindex mno-inline-float-divide
17695 Do not generate inline code for divides of floating-point values.
17697 @item -minline-int-divide-min-latency
17698 @opindex minline-int-divide-min-latency
17699 Generate code for inline divides of integer values
17700 using the minimum latency algorithm.
17702 @item -minline-int-divide-max-throughput
17703 @opindex minline-int-divide-max-throughput
17704 Generate code for inline divides of integer values
17705 using the maximum throughput algorithm.
17707 @item -mno-inline-int-divide
17708 @opindex mno-inline-int-divide
17709 Do not generate inline code for divides of integer values.
17711 @item -minline-sqrt-min-latency
17712 @opindex minline-sqrt-min-latency
17713 Generate code for inline square roots
17714 using the minimum latency algorithm.
17716 @item -minline-sqrt-max-throughput
17717 @opindex minline-sqrt-max-throughput
17718 Generate code for inline square roots
17719 using the maximum throughput algorithm.
17721 @item -mno-inline-sqrt
17722 @opindex mno-inline-sqrt
17723 Do not generate inline code for @code{sqrt}.
17725 @item -mfused-madd
17726 @itemx -mno-fused-madd
17727 @opindex mfused-madd
17728 @opindex mno-fused-madd
17729 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
17730 instructions.  The default is to use these instructions.
17732 @item -mno-dwarf2-asm
17733 @itemx -mdwarf2-asm
17734 @opindex mno-dwarf2-asm
17735 @opindex mdwarf2-asm
17736 Don't (or do) generate assembler code for the DWARF line number debugging
17737 info.  This may be useful when not using the GNU assembler.
17739 @item -mearly-stop-bits
17740 @itemx -mno-early-stop-bits
17741 @opindex mearly-stop-bits
17742 @opindex mno-early-stop-bits
17743 Allow stop bits to be placed earlier than immediately preceding the
17744 instruction that triggered the stop bit.  This can improve instruction
17745 scheduling, but does not always do so.
17747 @item -mfixed-range=@var{register-range}
17748 @opindex mfixed-range
17749 Generate code treating the given register range as fixed registers.
17750 A fixed register is one that the register allocator cannot use.  This is
17751 useful when compiling kernel code.  A register range is specified as
17752 two registers separated by a dash.  Multiple register ranges can be
17753 specified separated by a comma.
17755 @item -mtls-size=@var{tls-size}
17756 @opindex mtls-size
17757 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
17760 @item -mtune=@var{cpu-type}
17761 @opindex mtune
17762 Tune the instruction scheduling for a particular CPU, Valid values are
17763 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
17764 and @samp{mckinley}.
17766 @item -milp32
17767 @itemx -mlp64
17768 @opindex milp32
17769 @opindex mlp64
17770 Generate code for a 32-bit or 64-bit environment.
17771 The 32-bit environment sets int, long and pointer to 32 bits.
17772 The 64-bit environment sets int to 32 bits and long and pointer
17773 to 64 bits.  These are HP-UX specific flags.
17775 @item -mno-sched-br-data-spec
17776 @itemx -msched-br-data-spec
17777 @opindex mno-sched-br-data-spec
17778 @opindex msched-br-data-spec
17779 (Dis/En)able data speculative scheduling before reload.
17780 This results in generation of @code{ld.a} instructions and
17781 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
17782 The default setting is disabled.
17784 @item -msched-ar-data-spec
17785 @itemx -mno-sched-ar-data-spec
17786 @opindex msched-ar-data-spec
17787 @opindex mno-sched-ar-data-spec
17788 (En/Dis)able data speculative scheduling after reload.
17789 This results in generation of @code{ld.a} instructions and
17790 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
17791 The default setting is enabled.
17793 @item -mno-sched-control-spec
17794 @itemx -msched-control-spec
17795 @opindex mno-sched-control-spec
17796 @opindex msched-control-spec
17797 (Dis/En)able control speculative scheduling.  This feature is
17798 available only during region scheduling (i.e.@: before reload).
17799 This results in generation of the @code{ld.s} instructions and
17800 the corresponding check instructions @code{chk.s}.
17801 The default setting is disabled.
17803 @item -msched-br-in-data-spec
17804 @itemx -mno-sched-br-in-data-spec
17805 @opindex msched-br-in-data-spec
17806 @opindex mno-sched-br-in-data-spec
17807 (En/Dis)able speculative scheduling of the instructions that
17808 are dependent on the data speculative loads before reload.
17809 This is effective only with @option{-msched-br-data-spec} enabled.
17810 The default setting is enabled.
17812 @item -msched-ar-in-data-spec
17813 @itemx -mno-sched-ar-in-data-spec
17814 @opindex msched-ar-in-data-spec
17815 @opindex mno-sched-ar-in-data-spec
17816 (En/Dis)able speculative scheduling of the instructions that
17817 are dependent on the data speculative loads after reload.
17818 This is effective only with @option{-msched-ar-data-spec} enabled.
17819 The default setting is enabled.
17821 @item -msched-in-control-spec
17822 @itemx -mno-sched-in-control-spec
17823 @opindex msched-in-control-spec
17824 @opindex mno-sched-in-control-spec
17825 (En/Dis)able speculative scheduling of the instructions that
17826 are dependent on the control speculative loads.
17827 This is effective only with @option{-msched-control-spec} enabled.
17828 The default setting is enabled.
17830 @item -mno-sched-prefer-non-data-spec-insns
17831 @itemx -msched-prefer-non-data-spec-insns
17832 @opindex mno-sched-prefer-non-data-spec-insns
17833 @opindex msched-prefer-non-data-spec-insns
17834 If enabled, data-speculative instructions are chosen for schedule
17835 only if there are no other choices at the moment.  This makes
17836 the use of the data speculation much more conservative.
17837 The default setting is disabled.
17839 @item -mno-sched-prefer-non-control-spec-insns
17840 @itemx -msched-prefer-non-control-spec-insns
17841 @opindex mno-sched-prefer-non-control-spec-insns
17842 @opindex msched-prefer-non-control-spec-insns
17843 If enabled, control-speculative instructions are chosen for schedule
17844 only if there are no other choices at the moment.  This makes
17845 the use of the control speculation much more conservative.
17846 The default setting is disabled.
17848 @item -mno-sched-count-spec-in-critical-path
17849 @itemx -msched-count-spec-in-critical-path
17850 @opindex mno-sched-count-spec-in-critical-path
17851 @opindex msched-count-spec-in-critical-path
17852 If enabled, speculative dependencies are considered during
17853 computation of the instructions priorities.  This makes the use of the
17854 speculation a bit more conservative.
17855 The default setting is disabled.
17857 @item -msched-spec-ldc
17858 @opindex msched-spec-ldc
17859 Use a simple data speculation check.  This option is on by default.
17861 @item -msched-control-spec-ldc
17862 @opindex msched-spec-ldc
17863 Use a simple check for control speculation.  This option is on by default.
17865 @item -msched-stop-bits-after-every-cycle
17866 @opindex msched-stop-bits-after-every-cycle
17867 Place a stop bit after every cycle when scheduling.  This option is on
17868 by default.
17870 @item -msched-fp-mem-deps-zero-cost
17871 @opindex msched-fp-mem-deps-zero-cost
17872 Assume that floating-point stores and loads are not likely to cause a conflict
17873 when placed into the same instruction group.  This option is disabled by
17874 default.
17876 @item -msel-sched-dont-check-control-spec
17877 @opindex msel-sched-dont-check-control-spec
17878 Generate checks for control speculation in selective scheduling.
17879 This flag is disabled by default.
17881 @item -msched-max-memory-insns=@var{max-insns}
17882 @opindex msched-max-memory-insns
17883 Limit on the number of memory insns per instruction group, giving lower
17884 priority to subsequent memory insns attempting to schedule in the same
17885 instruction group. Frequently useful to prevent cache bank conflicts.
17886 The default value is 1.
17888 @item -msched-max-memory-insns-hard-limit
17889 @opindex msched-max-memory-insns-hard-limit
17890 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
17891 disallowing more than that number in an instruction group.
17892 Otherwise, the limit is ``soft'', meaning that non-memory operations
17893 are preferred when the limit is reached, but memory operations may still
17894 be scheduled.
17896 @end table
17898 @node LM32 Options
17899 @subsection LM32 Options
17900 @cindex LM32 options
17902 These @option{-m} options are defined for the LatticeMico32 architecture:
17904 @table @gcctabopt
17905 @item -mbarrel-shift-enabled
17906 @opindex mbarrel-shift-enabled
17907 Enable barrel-shift instructions.
17909 @item -mdivide-enabled
17910 @opindex mdivide-enabled
17911 Enable divide and modulus instructions.
17913 @item -mmultiply-enabled
17914 @opindex multiply-enabled
17915 Enable multiply instructions.
17917 @item -msign-extend-enabled
17918 @opindex msign-extend-enabled
17919 Enable sign extend instructions.
17921 @item -muser-enabled
17922 @opindex muser-enabled
17923 Enable user-defined instructions.
17925 @end table
17927 @node M32C Options
17928 @subsection M32C Options
17929 @cindex M32C options
17931 @table @gcctabopt
17932 @item -mcpu=@var{name}
17933 @opindex mcpu=
17934 Select the CPU for which code is generated.  @var{name} may be one of
17935 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
17936 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
17937 the M32C/80 series.
17939 @item -msim
17940 @opindex msim
17941 Specifies that the program will be run on the simulator.  This causes
17942 an alternate runtime library to be linked in which supports, for
17943 example, file I/O@.  You must not use this option when generating
17944 programs that will run on real hardware; you must provide your own
17945 runtime library for whatever I/O functions are needed.
17947 @item -memregs=@var{number}
17948 @opindex memregs=
17949 Specifies the number of memory-based pseudo-registers GCC uses
17950 during code generation.  These pseudo-registers are used like real
17951 registers, so there is a tradeoff between GCC's ability to fit the
17952 code into available registers, and the performance penalty of using
17953 memory instead of registers.  Note that all modules in a program must
17954 be compiled with the same value for this option.  Because of that, you
17955 must not use this option with GCC's default runtime libraries.
17957 @end table
17959 @node M32R/D Options
17960 @subsection M32R/D Options
17961 @cindex M32R/D options
17963 These @option{-m} options are defined for Renesas M32R/D architectures:
17965 @table @gcctabopt
17966 @item -m32r2
17967 @opindex m32r2
17968 Generate code for the M32R/2@.
17970 @item -m32rx
17971 @opindex m32rx
17972 Generate code for the M32R/X@.
17974 @item -m32r
17975 @opindex m32r
17976 Generate code for the M32R@.  This is the default.
17978 @item -mmodel=small
17979 @opindex mmodel=small
17980 Assume all objects live in the lower 16MB of memory (so that their addresses
17981 can be loaded with the @code{ld24} instruction), and assume all subroutines
17982 are reachable with the @code{bl} instruction.
17983 This is the default.
17985 The addressability of a particular object can be set with the
17986 @code{model} attribute.
17988 @item -mmodel=medium
17989 @opindex mmodel=medium
17990 Assume objects may be anywhere in the 32-bit address space (the compiler
17991 generates @code{seth/add3} instructions to load their addresses), and
17992 assume all subroutines are reachable with the @code{bl} instruction.
17994 @item -mmodel=large
17995 @opindex mmodel=large
17996 Assume objects may be anywhere in the 32-bit address space (the compiler
17997 generates @code{seth/add3} instructions to load their addresses), and
17998 assume subroutines may not be reachable with the @code{bl} instruction
17999 (the compiler generates the much slower @code{seth/add3/jl}
18000 instruction sequence).
18002 @item -msdata=none
18003 @opindex msdata=none
18004 Disable use of the small data area.  Variables are put into
18005 one of @code{.data}, @code{.bss}, or @code{.rodata} (unless the
18006 @code{section} attribute has been specified).
18007 This is the default.
18009 The small data area consists of sections @code{.sdata} and @code{.sbss}.
18010 Objects may be explicitly put in the small data area with the
18011 @code{section} attribute using one of these sections.
18013 @item -msdata=sdata
18014 @opindex msdata=sdata
18015 Put small global and static data in the small data area, but do not
18016 generate special code to reference them.
18018 @item -msdata=use
18019 @opindex msdata=use
18020 Put small global and static data in the small data area, and generate
18021 special instructions to reference them.
18023 @item -G @var{num}
18024 @opindex G
18025 @cindex smaller data references
18026 Put global and static objects less than or equal to @var{num} bytes
18027 into the small data or BSS sections instead of the normal data or BSS
18028 sections.  The default value of @var{num} is 8.
18029 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
18030 for this option to have any effect.
18032 All modules should be compiled with the same @option{-G @var{num}} value.
18033 Compiling with different values of @var{num} may or may not work; if it
18034 doesn't the linker gives an error message---incorrect code is not
18035 generated.
18037 @item -mdebug
18038 @opindex mdebug
18039 Makes the M32R-specific code in the compiler display some statistics
18040 that might help in debugging programs.
18042 @item -malign-loops
18043 @opindex malign-loops
18044 Align all loops to a 32-byte boundary.
18046 @item -mno-align-loops
18047 @opindex mno-align-loops
18048 Do not enforce a 32-byte alignment for loops.  This is the default.
18050 @item -missue-rate=@var{number}
18051 @opindex missue-rate=@var{number}
18052 Issue @var{number} instructions per cycle.  @var{number} can only be 1
18053 or 2.
18055 @item -mbranch-cost=@var{number}
18056 @opindex mbranch-cost=@var{number}
18057 @var{number} can only be 1 or 2.  If it is 1 then branches are
18058 preferred over conditional code, if it is 2, then the opposite applies.
18060 @item -mflush-trap=@var{number}
18061 @opindex mflush-trap=@var{number}
18062 Specifies the trap number to use to flush the cache.  The default is
18063 12.  Valid numbers are between 0 and 15 inclusive.
18065 @item -mno-flush-trap
18066 @opindex mno-flush-trap
18067 Specifies that the cache cannot be flushed by using a trap.
18069 @item -mflush-func=@var{name}
18070 @opindex mflush-func=@var{name}
18071 Specifies the name of the operating system function to call to flush
18072 the cache.  The default is @samp{_flush_cache}, but a function call
18073 is only used if a trap is not available.
18075 @item -mno-flush-func
18076 @opindex mno-flush-func
18077 Indicates that there is no OS function for flushing the cache.
18079 @end table
18081 @node M680x0 Options
18082 @subsection M680x0 Options
18083 @cindex M680x0 options
18085 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
18086 The default settings depend on which architecture was selected when
18087 the compiler was configured; the defaults for the most common choices
18088 are given below.
18090 @table @gcctabopt
18091 @item -march=@var{arch}
18092 @opindex march
18093 Generate code for a specific M680x0 or ColdFire instruction set
18094 architecture.  Permissible values of @var{arch} for M680x0
18095 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
18096 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
18097 architectures are selected according to Freescale's ISA classification
18098 and the permissible values are: @samp{isaa}, @samp{isaaplus},
18099 @samp{isab} and @samp{isac}.
18101 GCC defines a macro @code{__mcf@var{arch}__} whenever it is generating
18102 code for a ColdFire target.  The @var{arch} in this macro is one of the
18103 @option{-march} arguments given above.
18105 When used together, @option{-march} and @option{-mtune} select code
18106 that runs on a family of similar processors but that is optimized
18107 for a particular microarchitecture.
18109 @item -mcpu=@var{cpu}
18110 @opindex mcpu
18111 Generate code for a specific M680x0 or ColdFire processor.
18112 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
18113 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
18114 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
18115 below, which also classifies the CPUs into families:
18117 @multitable @columnfractions 0.20 0.80
18118 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
18119 @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}
18120 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
18121 @item @samp{5206e} @tab @samp{5206e}
18122 @item @samp{5208} @tab @samp{5207} @samp{5208}
18123 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
18124 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
18125 @item @samp{5216} @tab @samp{5214} @samp{5216}
18126 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
18127 @item @samp{5225} @tab @samp{5224} @samp{5225}
18128 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
18129 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
18130 @item @samp{5249} @tab @samp{5249}
18131 @item @samp{5250} @tab @samp{5250}
18132 @item @samp{5271} @tab @samp{5270} @samp{5271}
18133 @item @samp{5272} @tab @samp{5272}
18134 @item @samp{5275} @tab @samp{5274} @samp{5275}
18135 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
18136 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
18137 @item @samp{5307} @tab @samp{5307}
18138 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
18139 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
18140 @item @samp{5407} @tab @samp{5407}
18141 @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}
18142 @end multitable
18144 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
18145 @var{arch} is compatible with @var{cpu}.  Other combinations of
18146 @option{-mcpu} and @option{-march} are rejected.
18148 GCC defines the macro @code{__mcf_cpu_@var{cpu}} when ColdFire target
18149 @var{cpu} is selected.  It also defines @code{__mcf_family_@var{family}},
18150 where the value of @var{family} is given by the table above.
18152 @item -mtune=@var{tune}
18153 @opindex mtune
18154 Tune the code for a particular microarchitecture within the
18155 constraints set by @option{-march} and @option{-mcpu}.
18156 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
18157 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
18158 and @samp{cpu32}.  The ColdFire microarchitectures
18159 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
18161 You can also use @option{-mtune=68020-40} for code that needs
18162 to run relatively well on 68020, 68030 and 68040 targets.
18163 @option{-mtune=68020-60} is similar but includes 68060 targets
18164 as well.  These two options select the same tuning decisions as
18165 @option{-m68020-40} and @option{-m68020-60} respectively.
18167 GCC defines the macros @code{__mc@var{arch}} and @code{__mc@var{arch}__}
18168 when tuning for 680x0 architecture @var{arch}.  It also defines
18169 @code{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
18170 option is used.  If GCC is tuning for a range of architectures,
18171 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
18172 it defines the macros for every architecture in the range.
18174 GCC also defines the macro @code{__m@var{uarch}__} when tuning for
18175 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
18176 of the arguments given above.
18178 @item -m68000
18179 @itemx -mc68000
18180 @opindex m68000
18181 @opindex mc68000
18182 Generate output for a 68000.  This is the default
18183 when the compiler is configured for 68000-based systems.
18184 It is equivalent to @option{-march=68000}.
18186 Use this option for microcontrollers with a 68000 or EC000 core,
18187 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
18189 @item -m68010
18190 @opindex m68010
18191 Generate output for a 68010.  This is the default
18192 when the compiler is configured for 68010-based systems.
18193 It is equivalent to @option{-march=68010}.
18195 @item -m68020
18196 @itemx -mc68020
18197 @opindex m68020
18198 @opindex mc68020
18199 Generate output for a 68020.  This is the default
18200 when the compiler is configured for 68020-based systems.
18201 It is equivalent to @option{-march=68020}.
18203 @item -m68030
18204 @opindex m68030
18205 Generate output for a 68030.  This is the default when the compiler is
18206 configured for 68030-based systems.  It is equivalent to
18207 @option{-march=68030}.
18209 @item -m68040
18210 @opindex m68040
18211 Generate output for a 68040.  This is the default when the compiler is
18212 configured for 68040-based systems.  It is equivalent to
18213 @option{-march=68040}.
18215 This option inhibits the use of 68881/68882 instructions that have to be
18216 emulated by software on the 68040.  Use this option if your 68040 does not
18217 have code to emulate those instructions.
18219 @item -m68060
18220 @opindex m68060
18221 Generate output for a 68060.  This is the default when the compiler is
18222 configured for 68060-based systems.  It is equivalent to
18223 @option{-march=68060}.
18225 This option inhibits the use of 68020 and 68881/68882 instructions that
18226 have to be emulated by software on the 68060.  Use this option if your 68060
18227 does not have code to emulate those instructions.
18229 @item -mcpu32
18230 @opindex mcpu32
18231 Generate output for a CPU32.  This is the default
18232 when the compiler is configured for CPU32-based systems.
18233 It is equivalent to @option{-march=cpu32}.
18235 Use this option for microcontrollers with a
18236 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
18237 68336, 68340, 68341, 68349 and 68360.
18239 @item -m5200
18240 @opindex m5200
18241 Generate output for a 520X ColdFire CPU@.  This is the default
18242 when the compiler is configured for 520X-based systems.
18243 It is equivalent to @option{-mcpu=5206}, and is now deprecated
18244 in favor of that option.
18246 Use this option for microcontroller with a 5200 core, including
18247 the MCF5202, MCF5203, MCF5204 and MCF5206.
18249 @item -m5206e
18250 @opindex m5206e
18251 Generate output for a 5206e ColdFire CPU@.  The option is now
18252 deprecated in favor of the equivalent @option{-mcpu=5206e}.
18254 @item -m528x
18255 @opindex m528x
18256 Generate output for a member of the ColdFire 528X family.
18257 The option is now deprecated in favor of the equivalent
18258 @option{-mcpu=528x}.
18260 @item -m5307
18261 @opindex m5307
18262 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
18263 in favor of the equivalent @option{-mcpu=5307}.
18265 @item -m5407
18266 @opindex m5407
18267 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
18268 in favor of the equivalent @option{-mcpu=5407}.
18270 @item -mcfv4e
18271 @opindex mcfv4e
18272 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
18273 This includes use of hardware floating-point instructions.
18274 The option is equivalent to @option{-mcpu=547x}, and is now
18275 deprecated in favor of that option.
18277 @item -m68020-40
18278 @opindex m68020-40
18279 Generate output for a 68040, without using any of the new instructions.
18280 This results in code that can run relatively efficiently on either a
18281 68020/68881 or a 68030 or a 68040.  The generated code does use the
18282 68881 instructions that are emulated on the 68040.
18284 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
18286 @item -m68020-60
18287 @opindex m68020-60
18288 Generate output for a 68060, without using any of the new instructions.
18289 This results in code that can run relatively efficiently on either a
18290 68020/68881 or a 68030 or a 68040.  The generated code does use the
18291 68881 instructions that are emulated on the 68060.
18293 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
18295 @item -mhard-float
18296 @itemx -m68881
18297 @opindex mhard-float
18298 @opindex m68881
18299 Generate floating-point instructions.  This is the default for 68020
18300 and above, and for ColdFire devices that have an FPU@.  It defines the
18301 macro @code{__HAVE_68881__} on M680x0 targets and @code{__mcffpu__}
18302 on ColdFire targets.
18304 @item -msoft-float
18305 @opindex msoft-float
18306 Do not generate floating-point instructions; use library calls instead.
18307 This is the default for 68000, 68010, and 68832 targets.  It is also
18308 the default for ColdFire devices that have no FPU.
18310 @item -mdiv
18311 @itemx -mno-div
18312 @opindex mdiv
18313 @opindex mno-div
18314 Generate (do not generate) ColdFire hardware divide and remainder
18315 instructions.  If @option{-march} is used without @option{-mcpu},
18316 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
18317 architectures.  Otherwise, the default is taken from the target CPU
18318 (either the default CPU, or the one specified by @option{-mcpu}).  For
18319 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
18320 @option{-mcpu=5206e}.
18322 GCC defines the macro @code{__mcfhwdiv__} when this option is enabled.
18324 @item -mshort
18325 @opindex mshort
18326 Consider type @code{int} to be 16 bits wide, like @code{short int}.
18327 Additionally, parameters passed on the stack are also aligned to a
18328 16-bit boundary even on targets whose API mandates promotion to 32-bit.
18330 @item -mno-short
18331 @opindex mno-short
18332 Do not consider type @code{int} to be 16 bits wide.  This is the default.
18334 @item -mnobitfield
18335 @itemx -mno-bitfield
18336 @opindex mnobitfield
18337 @opindex mno-bitfield
18338 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
18339 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
18341 @item -mbitfield
18342 @opindex mbitfield
18343 Do use the bit-field instructions.  The @option{-m68020} option implies
18344 @option{-mbitfield}.  This is the default if you use a configuration
18345 designed for a 68020.
18347 @item -mrtd
18348 @opindex mrtd
18349 Use a different function-calling convention, in which functions
18350 that take a fixed number of arguments return with the @code{rtd}
18351 instruction, which pops their arguments while returning.  This
18352 saves one instruction in the caller since there is no need to pop
18353 the arguments there.
18355 This calling convention is incompatible with the one normally
18356 used on Unix, so you cannot use it if you need to call libraries
18357 compiled with the Unix compiler.
18359 Also, you must provide function prototypes for all functions that
18360 take variable numbers of arguments (including @code{printf});
18361 otherwise incorrect code is generated for calls to those
18362 functions.
18364 In addition, seriously incorrect code results if you call a
18365 function with too many arguments.  (Normally, extra arguments are
18366 harmlessly ignored.)
18368 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
18369 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
18371 @item -mno-rtd
18372 @opindex mno-rtd
18373 Do not use the calling conventions selected by @option{-mrtd}.
18374 This is the default.
18376 @item -malign-int
18377 @itemx -mno-align-int
18378 @opindex malign-int
18379 @opindex mno-align-int
18380 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
18381 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
18382 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
18383 Aligning variables on 32-bit boundaries produces code that runs somewhat
18384 faster on processors with 32-bit busses at the expense of more memory.
18386 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
18387 aligns structures containing the above types differently than
18388 most published application binary interface specifications for the m68k.
18390 @item -mpcrel
18391 @opindex mpcrel
18392 Use the pc-relative addressing mode of the 68000 directly, instead of
18393 using a global offset table.  At present, this option implies @option{-fpic},
18394 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
18395 not presently supported with @option{-mpcrel}, though this could be supported for
18396 68020 and higher processors.
18398 @item -mno-strict-align
18399 @itemx -mstrict-align
18400 @opindex mno-strict-align
18401 @opindex mstrict-align
18402 Do not (do) assume that unaligned memory references are handled by
18403 the system.
18405 @item -msep-data
18406 Generate code that allows the data segment to be located in a different
18407 area of memory from the text segment.  This allows for execute-in-place in
18408 an environment without virtual memory management.  This option implies
18409 @option{-fPIC}.
18411 @item -mno-sep-data
18412 Generate code that assumes that the data segment follows the text segment.
18413 This is the default.
18415 @item -mid-shared-library
18416 Generate code that supports shared libraries via the library ID method.
18417 This allows for execute-in-place and shared libraries in an environment
18418 without virtual memory management.  This option implies @option{-fPIC}.
18420 @item -mno-id-shared-library
18421 Generate code that doesn't assume ID-based shared libraries are being used.
18422 This is the default.
18424 @item -mshared-library-id=n
18425 Specifies the identification number of the ID-based shared library being
18426 compiled.  Specifying a value of 0 generates more compact code; specifying
18427 other values forces the allocation of that number to the current
18428 library, but is no more space- or time-efficient than omitting this option.
18430 @item -mxgot
18431 @itemx -mno-xgot
18432 @opindex mxgot
18433 @opindex mno-xgot
18434 When generating position-independent code for ColdFire, generate code
18435 that works if the GOT has more than 8192 entries.  This code is
18436 larger and slower than code generated without this option.  On M680x0
18437 processors, this option is not needed; @option{-fPIC} suffices.
18439 GCC normally uses a single instruction to load values from the GOT@.
18440 While this is relatively efficient, it only works if the GOT
18441 is smaller than about 64k.  Anything larger causes the linker
18442 to report an error such as:
18444 @cindex relocation truncated to fit (ColdFire)
18445 @smallexample
18446 relocation truncated to fit: R_68K_GOT16O foobar
18447 @end smallexample
18449 If this happens, you should recompile your code with @option{-mxgot}.
18450 It should then work with very large GOTs.  However, code generated with
18451 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
18452 the value of a global symbol.
18454 Note that some linkers, including newer versions of the GNU linker,
18455 can create multiple GOTs and sort GOT entries.  If you have such a linker,
18456 you should only need to use @option{-mxgot} when compiling a single
18457 object file that accesses more than 8192 GOT entries.  Very few do.
18459 These options have no effect unless GCC is generating
18460 position-independent code.
18462 @item -mlong-jump-table-offsets
18463 @opindex mlong-jump-table-offsets
18464 Use 32-bit offsets in @code{switch} tables.  The default is to use
18465 16-bit offsets.
18467 @end table
18469 @node MCore Options
18470 @subsection MCore Options
18471 @cindex MCore options
18473 These are the @samp{-m} options defined for the Motorola M*Core
18474 processors.
18476 @table @gcctabopt
18478 @item -mhardlit
18479 @itemx -mno-hardlit
18480 @opindex mhardlit
18481 @opindex mno-hardlit
18482 Inline constants into the code stream if it can be done in two
18483 instructions or less.
18485 @item -mdiv
18486 @itemx -mno-div
18487 @opindex mdiv
18488 @opindex mno-div
18489 Use the divide instruction.  (Enabled by default).
18491 @item -mrelax-immediate
18492 @itemx -mno-relax-immediate
18493 @opindex mrelax-immediate
18494 @opindex mno-relax-immediate
18495 Allow arbitrary-sized immediates in bit operations.
18497 @item -mwide-bitfields
18498 @itemx -mno-wide-bitfields
18499 @opindex mwide-bitfields
18500 @opindex mno-wide-bitfields
18501 Always treat bit-fields as @code{int}-sized.
18503 @item -m4byte-functions
18504 @itemx -mno-4byte-functions
18505 @opindex m4byte-functions
18506 @opindex mno-4byte-functions
18507 Force all functions to be aligned to a 4-byte boundary.
18509 @item -mcallgraph-data
18510 @itemx -mno-callgraph-data
18511 @opindex mcallgraph-data
18512 @opindex mno-callgraph-data
18513 Emit callgraph information.
18515 @item -mslow-bytes
18516 @itemx -mno-slow-bytes
18517 @opindex mslow-bytes
18518 @opindex mno-slow-bytes
18519 Prefer word access when reading byte quantities.
18521 @item -mlittle-endian
18522 @itemx -mbig-endian
18523 @opindex mlittle-endian
18524 @opindex mbig-endian
18525 Generate code for a little-endian target.
18527 @item -m210
18528 @itemx -m340
18529 @opindex m210
18530 @opindex m340
18531 Generate code for the 210 processor.
18533 @item -mno-lsim
18534 @opindex mno-lsim
18535 Assume that runtime support has been provided and so omit the
18536 simulator library (@file{libsim.a)} from the linker command line.
18538 @item -mstack-increment=@var{size}
18539 @opindex mstack-increment
18540 Set the maximum amount for a single stack increment operation.  Large
18541 values can increase the speed of programs that contain functions
18542 that need a large amount of stack space, but they can also trigger a
18543 segmentation fault if the stack is extended too much.  The default
18544 value is 0x1000.
18546 @end table
18548 @node MeP Options
18549 @subsection MeP Options
18550 @cindex MeP options
18552 @table @gcctabopt
18554 @item -mabsdiff
18555 @opindex mabsdiff
18556 Enables the @code{abs} instruction, which is the absolute difference
18557 between two registers.
18559 @item -mall-opts
18560 @opindex mall-opts
18561 Enables all the optional instructions---average, multiply, divide, bit
18562 operations, leading zero, absolute difference, min/max, clip, and
18563 saturation.
18566 @item -maverage
18567 @opindex maverage
18568 Enables the @code{ave} instruction, which computes the average of two
18569 registers.
18571 @item -mbased=@var{n}
18572 @opindex mbased=
18573 Variables of size @var{n} bytes or smaller are placed in the
18574 @code{.based} section by default.  Based variables use the @code{$tp}
18575 register as a base register, and there is a 128-byte limit to the
18576 @code{.based} section.
18578 @item -mbitops
18579 @opindex mbitops
18580 Enables the bit operation instructions---bit test (@code{btstm}), set
18581 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
18582 test-and-set (@code{tas}).
18584 @item -mc=@var{name}
18585 @opindex mc=
18586 Selects which section constant data is placed in.  @var{name} may
18587 be @samp{tiny}, @samp{near}, or @samp{far}.
18589 @item -mclip
18590 @opindex mclip
18591 Enables the @code{clip} instruction.  Note that @option{-mclip} is not
18592 useful unless you also provide @option{-mminmax}.
18594 @item -mconfig=@var{name}
18595 @opindex mconfig=
18596 Selects one of the built-in core configurations.  Each MeP chip has
18597 one or more modules in it; each module has a core CPU and a variety of
18598 coprocessors, optional instructions, and peripherals.  The
18599 @code{MeP-Integrator} tool, not part of GCC, provides these
18600 configurations through this option; using this option is the same as
18601 using all the corresponding command-line options.  The default
18602 configuration is @samp{default}.
18604 @item -mcop
18605 @opindex mcop
18606 Enables the coprocessor instructions.  By default, this is a 32-bit
18607 coprocessor.  Note that the coprocessor is normally enabled via the
18608 @option{-mconfig=} option.
18610 @item -mcop32
18611 @opindex mcop32
18612 Enables the 32-bit coprocessor's instructions.
18614 @item -mcop64
18615 @opindex mcop64
18616 Enables the 64-bit coprocessor's instructions.
18618 @item -mivc2
18619 @opindex mivc2
18620 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
18622 @item -mdc
18623 @opindex mdc
18624 Causes constant variables to be placed in the @code{.near} section.
18626 @item -mdiv
18627 @opindex mdiv
18628 Enables the @code{div} and @code{divu} instructions.
18630 @item -meb
18631 @opindex meb
18632 Generate big-endian code.
18634 @item -mel
18635 @opindex mel
18636 Generate little-endian code.
18638 @item -mio-volatile
18639 @opindex mio-volatile
18640 Tells the compiler that any variable marked with the @code{io}
18641 attribute is to be considered volatile.
18643 @item -ml
18644 @opindex ml
18645 Causes variables to be assigned to the @code{.far} section by default.
18647 @item -mleadz
18648 @opindex mleadz
18649 Enables the @code{leadz} (leading zero) instruction.
18651 @item -mm
18652 @opindex mm
18653 Causes variables to be assigned to the @code{.near} section by default.
18655 @item -mminmax
18656 @opindex mminmax
18657 Enables the @code{min} and @code{max} instructions.
18659 @item -mmult
18660 @opindex mmult
18661 Enables the multiplication and multiply-accumulate instructions.
18663 @item -mno-opts
18664 @opindex mno-opts
18665 Disables all the optional instructions enabled by @option{-mall-opts}.
18667 @item -mrepeat
18668 @opindex mrepeat
18669 Enables the @code{repeat} and @code{erepeat} instructions, used for
18670 low-overhead looping.
18672 @item -ms
18673 @opindex ms
18674 Causes all variables to default to the @code{.tiny} section.  Note
18675 that there is a 65536-byte limit to this section.  Accesses to these
18676 variables use the @code{%gp} base register.
18678 @item -msatur
18679 @opindex msatur
18680 Enables the saturation instructions.  Note that the compiler does not
18681 currently generate these itself, but this option is included for
18682 compatibility with other tools, like @code{as}.
18684 @item -msdram
18685 @opindex msdram
18686 Link the SDRAM-based runtime instead of the default ROM-based runtime.
18688 @item -msim
18689 @opindex msim
18690 Link the simulator run-time libraries.
18692 @item -msimnovec
18693 @opindex msimnovec
18694 Link the simulator runtime libraries, excluding built-in support
18695 for reset and exception vectors and tables.
18697 @item -mtf
18698 @opindex mtf
18699 Causes all functions to default to the @code{.far} section.  Without
18700 this option, functions default to the @code{.near} section.
18702 @item -mtiny=@var{n}
18703 @opindex mtiny=
18704 Variables that are @var{n} bytes or smaller are allocated to the
18705 @code{.tiny} section.  These variables use the @code{$gp} base
18706 register.  The default for this option is 4, but note that there's a
18707 65536-byte limit to the @code{.tiny} section.
18709 @end table
18711 @node MicroBlaze Options
18712 @subsection MicroBlaze Options
18713 @cindex MicroBlaze Options
18715 @table @gcctabopt
18717 @item -msoft-float
18718 @opindex msoft-float
18719 Use software emulation for floating point (default).
18721 @item -mhard-float
18722 @opindex mhard-float
18723 Use hardware floating-point instructions.
18725 @item -mmemcpy
18726 @opindex mmemcpy
18727 Do not optimize block moves, use @code{memcpy}.
18729 @item -mno-clearbss
18730 @opindex mno-clearbss
18731 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
18733 @item -mcpu=@var{cpu-type}
18734 @opindex mcpu=
18735 Use features of, and schedule code for, the given CPU.
18736 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
18737 where @var{X} is a major version, @var{YY} is the minor version, and
18738 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
18739 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
18741 @item -mxl-soft-mul
18742 @opindex mxl-soft-mul
18743 Use software multiply emulation (default).
18745 @item -mxl-soft-div
18746 @opindex mxl-soft-div
18747 Use software emulation for divides (default).
18749 @item -mxl-barrel-shift
18750 @opindex mxl-barrel-shift
18751 Use the hardware barrel shifter.
18753 @item -mxl-pattern-compare
18754 @opindex mxl-pattern-compare
18755 Use pattern compare instructions.
18757 @item -msmall-divides
18758 @opindex msmall-divides
18759 Use table lookup optimization for small signed integer divisions.
18761 @item -mxl-stack-check
18762 @opindex mxl-stack-check
18763 This option is deprecated.  Use @option{-fstack-check} instead.
18765 @item -mxl-gp-opt
18766 @opindex mxl-gp-opt
18767 Use GP-relative @code{.sdata}/@code{.sbss} sections.
18769 @item -mxl-multiply-high
18770 @opindex mxl-multiply-high
18771 Use multiply high instructions for high part of 32x32 multiply.
18773 @item -mxl-float-convert
18774 @opindex mxl-float-convert
18775 Use hardware floating-point conversion instructions.
18777 @item -mxl-float-sqrt
18778 @opindex mxl-float-sqrt
18779 Use hardware floating-point square root instruction.
18781 @item -mbig-endian
18782 @opindex mbig-endian
18783 Generate code for a big-endian target.
18785 @item -mlittle-endian
18786 @opindex mlittle-endian
18787 Generate code for a little-endian target.
18789 @item -mxl-reorder
18790 @opindex mxl-reorder
18791 Use reorder instructions (swap and byte reversed load/store).
18793 @item -mxl-mode-@var{app-model}
18794 Select application model @var{app-model}.  Valid models are
18795 @table @samp
18796 @item executable
18797 normal executable (default), uses startup code @file{crt0.o}.
18799 @item xmdstub
18800 for use with Xilinx Microprocessor Debugger (XMD) based
18801 software intrusive debug agent called xmdstub. This uses startup file
18802 @file{crt1.o} and sets the start address of the program to 0x800.
18804 @item bootstrap
18805 for applications that are loaded using a bootloader.
18806 This model uses startup file @file{crt2.o} which does not contain a processor
18807 reset vector handler. This is suitable for transferring control on a
18808 processor reset to the bootloader rather than the application.
18810 @item novectors
18811 for applications that do not require any of the
18812 MicroBlaze vectors. This option may be useful for applications running
18813 within a monitoring application. This model uses @file{crt3.o} as a startup file.
18814 @end table
18816 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
18817 @option{-mxl-mode-@var{app-model}}.
18819 @end table
18821 @node MIPS Options
18822 @subsection MIPS Options
18823 @cindex MIPS options
18825 @table @gcctabopt
18827 @item -EB
18828 @opindex EB
18829 Generate big-endian code.
18831 @item -EL
18832 @opindex EL
18833 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
18834 configurations.
18836 @item -march=@var{arch}
18837 @opindex march
18838 Generate code that runs on @var{arch}, which can be the name of a
18839 generic MIPS ISA, or the name of a particular processor.
18840 The ISA names are:
18841 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
18842 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5},
18843 @samp{mips32r6}, @samp{mips64}, @samp{mips64r2}, @samp{mips64r3},
18844 @samp{mips64r5} and @samp{mips64r6}.
18845 The processor names are:
18846 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
18847 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
18848 @samp{5kc}, @samp{5kf},
18849 @samp{20kc},
18850 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
18851 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
18852 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
18853 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
18854 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
18855 @samp{i6400},
18856 @samp{interaptiv},
18857 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
18858 @samp{m4k},
18859 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
18860 @samp{m5100}, @samp{m5101},
18861 @samp{octeon}, @samp{octeon+}, @samp{octeon2}, @samp{octeon3},
18862 @samp{orion},
18863 @samp{p5600},
18864 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
18865 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
18866 @samp{rm7000}, @samp{rm9000},
18867 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
18868 @samp{sb1},
18869 @samp{sr71000},
18870 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
18871 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
18872 @samp{xlr} and @samp{xlp}.
18873 The special value @samp{from-abi} selects the
18874 most compatible architecture for the selected ABI (that is,
18875 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
18877 The native Linux/GNU toolchain also supports the value @samp{native},
18878 which selects the best architecture option for the host processor.
18879 @option{-march=native} has no effect if GCC does not recognize
18880 the processor.
18882 In processor names, a final @samp{000} can be abbreviated as @samp{k}
18883 (for example, @option{-march=r2k}).  Prefixes are optional, and
18884 @samp{vr} may be written @samp{r}.
18886 Names of the form @samp{@var{n}f2_1} refer to processors with
18887 FPUs clocked at half the rate of the core, names of the form
18888 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
18889 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
18890 processors with FPUs clocked a ratio of 3:2 with respect to the core.
18891 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
18892 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
18893 accepted as synonyms for @samp{@var{n}f1_1}.
18895 GCC defines two macros based on the value of this option.  The first
18896 is @code{_MIPS_ARCH}, which gives the name of target architecture, as
18897 a string.  The second has the form @code{_MIPS_ARCH_@var{foo}},
18898 where @var{foo} is the capitalized value of @code{_MIPS_ARCH}@.
18899 For example, @option{-march=r2000} sets @code{_MIPS_ARCH}
18900 to @code{"r2000"} and defines the macro @code{_MIPS_ARCH_R2000}.
18902 Note that the @code{_MIPS_ARCH} macro uses the processor names given
18903 above.  In other words, it has the full prefix and does not
18904 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
18905 the macro names the resolved architecture (either @code{"mips1"} or
18906 @code{"mips3"}).  It names the default architecture when no
18907 @option{-march} option is given.
18909 @item -mtune=@var{arch}
18910 @opindex mtune
18911 Optimize for @var{arch}.  Among other things, this option controls
18912 the way instructions are scheduled, and the perceived cost of arithmetic
18913 operations.  The list of @var{arch} values is the same as for
18914 @option{-march}.
18916 When this option is not used, GCC optimizes for the processor
18917 specified by @option{-march}.  By using @option{-march} and
18918 @option{-mtune} together, it is possible to generate code that
18919 runs on a family of processors, but optimize the code for one
18920 particular member of that family.
18922 @option{-mtune} defines the macros @code{_MIPS_TUNE} and
18923 @code{_MIPS_TUNE_@var{foo}}, which work in the same way as the
18924 @option{-march} ones described above.
18926 @item -mips1
18927 @opindex mips1
18928 Equivalent to @option{-march=mips1}.
18930 @item -mips2
18931 @opindex mips2
18932 Equivalent to @option{-march=mips2}.
18934 @item -mips3
18935 @opindex mips3
18936 Equivalent to @option{-march=mips3}.
18938 @item -mips4
18939 @opindex mips4
18940 Equivalent to @option{-march=mips4}.
18942 @item -mips32
18943 @opindex mips32
18944 Equivalent to @option{-march=mips32}.
18946 @item -mips32r3
18947 @opindex mips32r3
18948 Equivalent to @option{-march=mips32r3}.
18950 @item -mips32r5
18951 @opindex mips32r5
18952 Equivalent to @option{-march=mips32r5}.
18954 @item -mips32r6
18955 @opindex mips32r6
18956 Equivalent to @option{-march=mips32r6}.
18958 @item -mips64
18959 @opindex mips64
18960 Equivalent to @option{-march=mips64}.
18962 @item -mips64r2
18963 @opindex mips64r2
18964 Equivalent to @option{-march=mips64r2}.
18966 @item -mips64r3
18967 @opindex mips64r3
18968 Equivalent to @option{-march=mips64r3}.
18970 @item -mips64r5
18971 @opindex mips64r5
18972 Equivalent to @option{-march=mips64r5}.
18974 @item -mips64r6
18975 @opindex mips64r6
18976 Equivalent to @option{-march=mips64r6}.
18978 @item -mips16
18979 @itemx -mno-mips16
18980 @opindex mips16
18981 @opindex mno-mips16
18982 Generate (do not generate) MIPS16 code.  If GCC is targeting a
18983 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
18985 MIPS16 code generation can also be controlled on a per-function basis
18986 by means of @code{mips16} and @code{nomips16} attributes.
18987 @xref{Function Attributes}, for more information.
18989 @item -mflip-mips16
18990 @opindex mflip-mips16
18991 Generate MIPS16 code on alternating functions.  This option is provided
18992 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
18993 not intended for ordinary use in compiling user code.
18995 @item -minterlink-compressed
18996 @item -mno-interlink-compressed
18997 @opindex minterlink-compressed
18998 @opindex mno-interlink-compressed
18999 Require (do not require) that code using the standard (uncompressed) MIPS ISA
19000 be link-compatible with MIPS16 and microMIPS code, and vice versa.
19002 For example, code using the standard ISA encoding cannot jump directly
19003 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
19004 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
19005 knows that the target of the jump is not compressed.
19007 @item -minterlink-mips16
19008 @itemx -mno-interlink-mips16
19009 @opindex minterlink-mips16
19010 @opindex mno-interlink-mips16
19011 Aliases of @option{-minterlink-compressed} and
19012 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
19013 and are retained for backwards compatibility.
19015 @item -mabi=32
19016 @itemx -mabi=o64
19017 @itemx -mabi=n32
19018 @itemx -mabi=64
19019 @itemx -mabi=eabi
19020 @opindex mabi=32
19021 @opindex mabi=o64
19022 @opindex mabi=n32
19023 @opindex mabi=64
19024 @opindex mabi=eabi
19025 Generate code for the given ABI@.
19027 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
19028 generates 64-bit code when you select a 64-bit architecture, but you
19029 can use @option{-mgp32} to get 32-bit code instead.
19031 For information about the O64 ABI, see
19032 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
19034 GCC supports a variant of the o32 ABI in which floating-point registers
19035 are 64 rather than 32 bits wide.  You can select this combination with
19036 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
19037 and @code{mfhc1} instructions and is therefore only supported for
19038 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
19040 The register assignments for arguments and return values remain the
19041 same, but each scalar value is passed in a single 64-bit register
19042 rather than a pair of 32-bit registers.  For example, scalar
19043 floating-point values are returned in @samp{$f0} only, not a
19044 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
19045 remains the same in that the even-numbered double-precision registers
19046 are saved.
19048 Two additional variants of the o32 ABI are supported to enable
19049 a transition from 32-bit to 64-bit registers.  These are FPXX
19050 (@option{-mfpxx}) and FP64A (@option{-mfp64} @option{-mno-odd-spreg}).
19051 The FPXX extension mandates that all code must execute correctly
19052 when run using 32-bit or 64-bit registers.  The code can be interlinked
19053 with either FP32 or FP64, but not both.
19054 The FP64A extension is similar to the FP64 extension but forbids the
19055 use of odd-numbered single-precision registers.  This can be used
19056 in conjunction with the @code{FRE} mode of FPUs in MIPS32R5
19057 processors and allows both FP32 and FP64A code to interlink and
19058 run in the same process without changing FPU modes.
19060 @item -mabicalls
19061 @itemx -mno-abicalls
19062 @opindex mabicalls
19063 @opindex mno-abicalls
19064 Generate (do not generate) code that is suitable for SVR4-style
19065 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
19066 systems.
19068 @item -mshared
19069 @itemx -mno-shared
19070 Generate (do not generate) code that is fully position-independent,
19071 and that can therefore be linked into shared libraries.  This option
19072 only affects @option{-mabicalls}.
19074 All @option{-mabicalls} code has traditionally been position-independent,
19075 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
19076 as an extension, the GNU toolchain allows executables to use absolute
19077 accesses for locally-binding symbols.  It can also use shorter GP
19078 initialization sequences and generate direct calls to locally-defined
19079 functions.  This mode is selected by @option{-mno-shared}.
19081 @option{-mno-shared} depends on binutils 2.16 or higher and generates
19082 objects that can only be linked by the GNU linker.  However, the option
19083 does not affect the ABI of the final executable; it only affects the ABI
19084 of relocatable objects.  Using @option{-mno-shared} generally makes
19085 executables both smaller and quicker.
19087 @option{-mshared} is the default.
19089 @item -mplt
19090 @itemx -mno-plt
19091 @opindex mplt
19092 @opindex mno-plt
19093 Assume (do not assume) that the static and dynamic linkers
19094 support PLTs and copy relocations.  This option only affects
19095 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
19096 has no effect without @option{-msym32}.
19098 You can make @option{-mplt} the default by configuring
19099 GCC with @option{--with-mips-plt}.  The default is
19100 @option{-mno-plt} otherwise.
19102 @item -mxgot
19103 @itemx -mno-xgot
19104 @opindex mxgot
19105 @opindex mno-xgot
19106 Lift (do not lift) the usual restrictions on the size of the global
19107 offset table.
19109 GCC normally uses a single instruction to load values from the GOT@.
19110 While this is relatively efficient, it only works if the GOT
19111 is smaller than about 64k.  Anything larger causes the linker
19112 to report an error such as:
19114 @cindex relocation truncated to fit (MIPS)
19115 @smallexample
19116 relocation truncated to fit: R_MIPS_GOT16 foobar
19117 @end smallexample
19119 If this happens, you should recompile your code with @option{-mxgot}.
19120 This works with very large GOTs, although the code is also
19121 less efficient, since it takes three instructions to fetch the
19122 value of a global symbol.
19124 Note that some linkers can create multiple GOTs.  If you have such a
19125 linker, you should only need to use @option{-mxgot} when a single object
19126 file accesses more than 64k's worth of GOT entries.  Very few do.
19128 These options have no effect unless GCC is generating position
19129 independent code.
19131 @item -mgp32
19132 @opindex mgp32
19133 Assume that general-purpose registers are 32 bits wide.
19135 @item -mgp64
19136 @opindex mgp64
19137 Assume that general-purpose registers are 64 bits wide.
19139 @item -mfp32
19140 @opindex mfp32
19141 Assume that floating-point registers are 32 bits wide.
19143 @item -mfp64
19144 @opindex mfp64
19145 Assume that floating-point registers are 64 bits wide.
19147 @item -mfpxx
19148 @opindex mfpxx
19149 Do not assume the width of floating-point registers.
19151 @item -mhard-float
19152 @opindex mhard-float
19153 Use floating-point coprocessor instructions.
19155 @item -msoft-float
19156 @opindex msoft-float
19157 Do not use floating-point coprocessor instructions.  Implement
19158 floating-point calculations using library calls instead.
19160 @item -mno-float
19161 @opindex mno-float
19162 Equivalent to @option{-msoft-float}, but additionally asserts that the
19163 program being compiled does not perform any floating-point operations.
19164 This option is presently supported only by some bare-metal MIPS
19165 configurations, where it may select a special set of libraries
19166 that lack all floating-point support (including, for example, the
19167 floating-point @code{printf} formats).  
19168 If code compiled with @option{-mno-float} accidentally contains
19169 floating-point operations, it is likely to suffer a link-time
19170 or run-time failure.
19172 @item -msingle-float
19173 @opindex msingle-float
19174 Assume that the floating-point coprocessor only supports single-precision
19175 operations.
19177 @item -mdouble-float
19178 @opindex mdouble-float
19179 Assume that the floating-point coprocessor supports double-precision
19180 operations.  This is the default.
19182 @item -modd-spreg
19183 @itemx -mno-odd-spreg
19184 @opindex modd-spreg
19185 @opindex mno-odd-spreg
19186 Enable the use of odd-numbered single-precision floating-point registers
19187 for the o32 ABI.  This is the default for processors that are known to
19188 support these registers.  When using the o32 FPXX ABI, @option{-mno-odd-spreg}
19189 is set by default.
19191 @item -mabs=2008
19192 @itemx -mabs=legacy
19193 @opindex mabs=2008
19194 @opindex mabs=legacy
19195 These options control the treatment of the special not-a-number (NaN)
19196 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
19197 @code{neg.@i{fmt}} machine instructions.
19199 By default or when @option{-mabs=legacy} is used the legacy
19200 treatment is selected.  In this case these instructions are considered
19201 arithmetic and avoided where correct operation is required and the
19202 input operand might be a NaN.  A longer sequence of instructions that
19203 manipulate the sign bit of floating-point datum manually is used
19204 instead unless the @option{-ffinite-math-only} option has also been
19205 specified.
19207 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
19208 this case these instructions are considered non-arithmetic and therefore
19209 operating correctly in all cases, including in particular where the
19210 input operand is a NaN.  These instructions are therefore always used
19211 for the respective operations.
19213 @item -mnan=2008
19214 @itemx -mnan=legacy
19215 @opindex mnan=2008
19216 @opindex mnan=legacy
19217 These options control the encoding of the special not-a-number (NaN)
19218 IEEE 754 floating-point data.
19220 The @option{-mnan=legacy} option selects the legacy encoding.  In this
19221 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
19222 significand field being 0, whereas signaling NaNs (sNaNs) are denoted
19223 by the first bit of their trailing significand field being 1.
19225 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
19226 this case qNaNs are denoted by the first bit of their trailing
19227 significand field being 1, whereas sNaNs are denoted by the first bit of
19228 their trailing significand field being 0.
19230 The default is @option{-mnan=legacy} unless GCC has been configured with
19231 @option{--with-nan=2008}.
19233 @item -mllsc
19234 @itemx -mno-llsc
19235 @opindex mllsc
19236 @opindex mno-llsc
19237 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
19238 implement atomic memory built-in functions.  When neither option is
19239 specified, GCC uses the instructions if the target architecture
19240 supports them.
19242 @option{-mllsc} is useful if the runtime environment can emulate the
19243 instructions and @option{-mno-llsc} can be useful when compiling for
19244 nonstandard ISAs.  You can make either option the default by
19245 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
19246 respectively.  @option{--with-llsc} is the default for some
19247 configurations; see the installation documentation for details.
19249 @item -mdsp
19250 @itemx -mno-dsp
19251 @opindex mdsp
19252 @opindex mno-dsp
19253 Use (do not use) revision 1 of the MIPS DSP ASE@.
19254 @xref{MIPS DSP Built-in Functions}.  This option defines the
19255 preprocessor macro @code{__mips_dsp}.  It also defines
19256 @code{__mips_dsp_rev} to 1.
19258 @item -mdspr2
19259 @itemx -mno-dspr2
19260 @opindex mdspr2
19261 @opindex mno-dspr2
19262 Use (do not use) revision 2 of the MIPS DSP ASE@.
19263 @xref{MIPS DSP Built-in Functions}.  This option defines the
19264 preprocessor macros @code{__mips_dsp} and @code{__mips_dspr2}.
19265 It also defines @code{__mips_dsp_rev} to 2.
19267 @item -msmartmips
19268 @itemx -mno-smartmips
19269 @opindex msmartmips
19270 @opindex mno-smartmips
19271 Use (do not use) the MIPS SmartMIPS ASE.
19273 @item -mpaired-single
19274 @itemx -mno-paired-single
19275 @opindex mpaired-single
19276 @opindex mno-paired-single
19277 Use (do not use) paired-single floating-point instructions.
19278 @xref{MIPS Paired-Single Support}.  This option requires
19279 hardware floating-point support to be enabled.
19281 @item -mdmx
19282 @itemx -mno-mdmx
19283 @opindex mdmx
19284 @opindex mno-mdmx
19285 Use (do not use) MIPS Digital Media Extension instructions.
19286 This option can only be used when generating 64-bit code and requires
19287 hardware floating-point support to be enabled.
19289 @item -mips3d
19290 @itemx -mno-mips3d
19291 @opindex mips3d
19292 @opindex mno-mips3d
19293 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
19294 The option @option{-mips3d} implies @option{-mpaired-single}.
19296 @item -mmicromips
19297 @itemx -mno-micromips
19298 @opindex mmicromips
19299 @opindex mno-mmicromips
19300 Generate (do not generate) microMIPS code.
19302 MicroMIPS code generation can also be controlled on a per-function basis
19303 by means of @code{micromips} and @code{nomicromips} attributes.
19304 @xref{Function Attributes}, for more information.
19306 @item -mmt
19307 @itemx -mno-mt
19308 @opindex mmt
19309 @opindex mno-mt
19310 Use (do not use) MT Multithreading instructions.
19312 @item -mmcu
19313 @itemx -mno-mcu
19314 @opindex mmcu
19315 @opindex mno-mcu
19316 Use (do not use) the MIPS MCU ASE instructions.
19318 @item -meva
19319 @itemx -mno-eva
19320 @opindex meva
19321 @opindex mno-eva
19322 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
19324 @item -mvirt
19325 @itemx -mno-virt
19326 @opindex mvirt
19327 @opindex mno-virt
19328 Use (do not use) the MIPS Virtualization Application Specific instructions.
19330 @item -mxpa
19331 @itemx -mno-xpa
19332 @opindex mxpa
19333 @opindex mno-xpa
19334 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
19336 @item -mlong64
19337 @opindex mlong64
19338 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
19339 an explanation of the default and the way that the pointer size is
19340 determined.
19342 @item -mlong32
19343 @opindex mlong32
19344 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
19346 The default size of @code{int}s, @code{long}s and pointers depends on
19347 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
19348 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
19349 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
19350 or the same size as integer registers, whichever is smaller.
19352 @item -msym32
19353 @itemx -mno-sym32
19354 @opindex msym32
19355 @opindex mno-sym32
19356 Assume (do not assume) that all symbols have 32-bit values, regardless
19357 of the selected ABI@.  This option is useful in combination with
19358 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
19359 to generate shorter and faster references to symbolic addresses.
19361 @item -G @var{num}
19362 @opindex G
19363 Put definitions of externally-visible data in a small data section
19364 if that data is no bigger than @var{num} bytes.  GCC can then generate
19365 more efficient accesses to the data; see @option{-mgpopt} for details.
19367 The default @option{-G} option depends on the configuration.
19369 @item -mlocal-sdata
19370 @itemx -mno-local-sdata
19371 @opindex mlocal-sdata
19372 @opindex mno-local-sdata
19373 Extend (do not extend) the @option{-G} behavior to local data too,
19374 such as to static variables in C@.  @option{-mlocal-sdata} is the
19375 default for all configurations.
19377 If the linker complains that an application is using too much small data,
19378 you might want to try rebuilding the less performance-critical parts with
19379 @option{-mno-local-sdata}.  You might also want to build large
19380 libraries with @option{-mno-local-sdata}, so that the libraries leave
19381 more room for the main program.
19383 @item -mextern-sdata
19384 @itemx -mno-extern-sdata
19385 @opindex mextern-sdata
19386 @opindex mno-extern-sdata
19387 Assume (do not assume) that externally-defined data is in
19388 a small data section if the size of that data is within the @option{-G} limit.
19389 @option{-mextern-sdata} is the default for all configurations.
19391 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
19392 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
19393 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
19394 is placed in a small data section.  If @var{Var} is defined by another
19395 module, you must either compile that module with a high-enough
19396 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
19397 definition.  If @var{Var} is common, you must link the application
19398 with a high-enough @option{-G} setting.
19400 The easiest way of satisfying these restrictions is to compile
19401 and link every module with the same @option{-G} option.  However,
19402 you may wish to build a library that supports several different
19403 small data limits.  You can do this by compiling the library with
19404 the highest supported @option{-G} setting and additionally using
19405 @option{-mno-extern-sdata} to stop the library from making assumptions
19406 about externally-defined data.
19408 @item -mgpopt
19409 @itemx -mno-gpopt
19410 @opindex mgpopt
19411 @opindex mno-gpopt
19412 Use (do not use) GP-relative accesses for symbols that are known to be
19413 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
19414 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
19415 configurations.
19417 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
19418 might not hold the value of @code{_gp}.  For example, if the code is
19419 part of a library that might be used in a boot monitor, programs that
19420 call boot monitor routines pass an unknown value in @code{$gp}.
19421 (In such situations, the boot monitor itself is usually compiled
19422 with @option{-G0}.)
19424 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
19425 @option{-mno-extern-sdata}.
19427 @item -membedded-data
19428 @itemx -mno-embedded-data
19429 @opindex membedded-data
19430 @opindex mno-embedded-data
19431 Allocate variables to the read-only data section first if possible, then
19432 next in the small data section if possible, otherwise in data.  This gives
19433 slightly slower code than the default, but reduces the amount of RAM required
19434 when executing, and thus may be preferred for some embedded systems.
19436 @item -muninit-const-in-rodata
19437 @itemx -mno-uninit-const-in-rodata
19438 @opindex muninit-const-in-rodata
19439 @opindex mno-uninit-const-in-rodata
19440 Put uninitialized @code{const} variables in the read-only data section.
19441 This option is only meaningful in conjunction with @option{-membedded-data}.
19443 @item -mcode-readable=@var{setting}
19444 @opindex mcode-readable
19445 Specify whether GCC may generate code that reads from executable sections.
19446 There are three possible settings:
19448 @table @gcctabopt
19449 @item -mcode-readable=yes
19450 Instructions may freely access executable sections.  This is the
19451 default setting.
19453 @item -mcode-readable=pcrel
19454 MIPS16 PC-relative load instructions can access executable sections,
19455 but other instructions must not do so.  This option is useful on 4KSc
19456 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
19457 It is also useful on processors that can be configured to have a dual
19458 instruction/data SRAM interface and that, like the M4K, automatically
19459 redirect PC-relative loads to the instruction RAM.
19461 @item -mcode-readable=no
19462 Instructions must not access executable sections.  This option can be
19463 useful on targets that are configured to have a dual instruction/data
19464 SRAM interface but that (unlike the M4K) do not automatically redirect
19465 PC-relative loads to the instruction RAM.
19466 @end table
19468 @item -msplit-addresses
19469 @itemx -mno-split-addresses
19470 @opindex msplit-addresses
19471 @opindex mno-split-addresses
19472 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
19473 relocation operators.  This option has been superseded by
19474 @option{-mexplicit-relocs} but is retained for backwards compatibility.
19476 @item -mexplicit-relocs
19477 @itemx -mno-explicit-relocs
19478 @opindex mexplicit-relocs
19479 @opindex mno-explicit-relocs
19480 Use (do not use) assembler relocation operators when dealing with symbolic
19481 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
19482 is to use assembler macros instead.
19484 @option{-mexplicit-relocs} is the default if GCC was configured
19485 to use an assembler that supports relocation operators.
19487 @item -mcheck-zero-division
19488 @itemx -mno-check-zero-division
19489 @opindex mcheck-zero-division
19490 @opindex mno-check-zero-division
19491 Trap (do not trap) on integer division by zero.
19493 The default is @option{-mcheck-zero-division}.
19495 @item -mdivide-traps
19496 @itemx -mdivide-breaks
19497 @opindex mdivide-traps
19498 @opindex mdivide-breaks
19499 MIPS systems check for division by zero by generating either a
19500 conditional trap or a break instruction.  Using traps results in
19501 smaller code, but is only supported on MIPS II and later.  Also, some
19502 versions of the Linux kernel have a bug that prevents trap from
19503 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
19504 allow conditional traps on architectures that support them and
19505 @option{-mdivide-breaks} to force the use of breaks.
19507 The default is usually @option{-mdivide-traps}, but this can be
19508 overridden at configure time using @option{--with-divide=breaks}.
19509 Divide-by-zero checks can be completely disabled using
19510 @option{-mno-check-zero-division}.
19512 @item -mload-store-pairs
19513 @itemx -mno-load-store-pairs
19514 @opindex mload-store-pairs
19515 @opindex mno-load-store-pairs
19516 Enable (disable) an optimization that pairs consecutive load or store
19517 instructions to enable load/store bonding.  This option is enabled by
19518 default but only takes effect when the selected architecture is known
19519 to support bonding.
19521 @item -mmemcpy
19522 @itemx -mno-memcpy
19523 @opindex mmemcpy
19524 @opindex mno-memcpy
19525 Force (do not force) the use of @code{memcpy} for non-trivial block
19526 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
19527 most constant-sized copies.
19529 @item -mlong-calls
19530 @itemx -mno-long-calls
19531 @opindex mlong-calls
19532 @opindex mno-long-calls
19533 Disable (do not disable) use of the @code{jal} instruction.  Calling
19534 functions using @code{jal} is more efficient but requires the caller
19535 and callee to be in the same 256 megabyte segment.
19537 This option has no effect on abicalls code.  The default is
19538 @option{-mno-long-calls}.
19540 @item -mmad
19541 @itemx -mno-mad
19542 @opindex mmad
19543 @opindex mno-mad
19544 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
19545 instructions, as provided by the R4650 ISA@.
19547 @item -mimadd
19548 @itemx -mno-imadd
19549 @opindex mimadd
19550 @opindex mno-imadd
19551 Enable (disable) use of the @code{madd} and @code{msub} integer
19552 instructions.  The default is @option{-mimadd} on architectures
19553 that support @code{madd} and @code{msub} except for the 74k 
19554 architecture where it was found to generate slower code.
19556 @item -mfused-madd
19557 @itemx -mno-fused-madd
19558 @opindex mfused-madd
19559 @opindex mno-fused-madd
19560 Enable (disable) use of the floating-point multiply-accumulate
19561 instructions, when they are available.  The default is
19562 @option{-mfused-madd}.
19564 On the R8000 CPU when multiply-accumulate instructions are used,
19565 the intermediate product is calculated to infinite precision
19566 and is not subject to the FCSR Flush to Zero bit.  This may be
19567 undesirable in some circumstances.  On other processors the result
19568 is numerically identical to the equivalent computation using
19569 separate multiply, add, subtract and negate instructions.
19571 @item -nocpp
19572 @opindex nocpp
19573 Tell the MIPS assembler to not run its preprocessor over user
19574 assembler files (with a @samp{.s} suffix) when assembling them.
19576 @item -mfix-24k
19577 @item -mno-fix-24k
19578 @opindex mfix-24k
19579 @opindex mno-fix-24k
19580 Work around the 24K E48 (lost data on stores during refill) errata.
19581 The workarounds are implemented by the assembler rather than by GCC@.
19583 @item -mfix-r4000
19584 @itemx -mno-fix-r4000
19585 @opindex mfix-r4000
19586 @opindex mno-fix-r4000
19587 Work around certain R4000 CPU errata:
19588 @itemize @minus
19589 @item
19590 A double-word or a variable shift may give an incorrect result if executed
19591 immediately after starting an integer division.
19592 @item
19593 A double-word or a variable shift may give an incorrect result if executed
19594 while an integer multiplication is in progress.
19595 @item
19596 An integer division may give an incorrect result if started in a delay slot
19597 of a taken branch or a jump.
19598 @end itemize
19600 @item -mfix-r4400
19601 @itemx -mno-fix-r4400
19602 @opindex mfix-r4400
19603 @opindex mno-fix-r4400
19604 Work around certain R4400 CPU errata:
19605 @itemize @minus
19606 @item
19607 A double-word or a variable shift may give an incorrect result if executed
19608 immediately after starting an integer division.
19609 @end itemize
19611 @item -mfix-r10000
19612 @itemx -mno-fix-r10000
19613 @opindex mfix-r10000
19614 @opindex mno-fix-r10000
19615 Work around certain R10000 errata:
19616 @itemize @minus
19617 @item
19618 @code{ll}/@code{sc} sequences may not behave atomically on revisions
19619 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
19620 @end itemize
19622 This option can only be used if the target architecture supports
19623 branch-likely instructions.  @option{-mfix-r10000} is the default when
19624 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
19625 otherwise.
19627 @item -mfix-rm7000
19628 @itemx -mno-fix-rm7000
19629 @opindex mfix-rm7000
19630 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
19631 workarounds are implemented by the assembler rather than by GCC@.
19633 @item -mfix-vr4120
19634 @itemx -mno-fix-vr4120
19635 @opindex mfix-vr4120
19636 Work around certain VR4120 errata:
19637 @itemize @minus
19638 @item
19639 @code{dmultu} does not always produce the correct result.
19640 @item
19641 @code{div} and @code{ddiv} do not always produce the correct result if one
19642 of the operands is negative.
19643 @end itemize
19644 The workarounds for the division errata rely on special functions in
19645 @file{libgcc.a}.  At present, these functions are only provided by
19646 the @code{mips64vr*-elf} configurations.
19648 Other VR4120 errata require a NOP to be inserted between certain pairs of
19649 instructions.  These errata are handled by the assembler, not by GCC itself.
19651 @item -mfix-vr4130
19652 @opindex mfix-vr4130
19653 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
19654 workarounds are implemented by the assembler rather than by GCC,
19655 although GCC avoids using @code{mflo} and @code{mfhi} if the
19656 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
19657 instructions are available instead.
19659 @item -mfix-sb1
19660 @itemx -mno-fix-sb1
19661 @opindex mfix-sb1
19662 Work around certain SB-1 CPU core errata.
19663 (This flag currently works around the SB-1 revision 2
19664 ``F1'' and ``F2'' floating-point errata.)
19666 @item -mr10k-cache-barrier=@var{setting}
19667 @opindex mr10k-cache-barrier
19668 Specify whether GCC should insert cache barriers to avoid the
19669 side-effects of speculation on R10K processors.
19671 In common with many processors, the R10K tries to predict the outcome
19672 of a conditional branch and speculatively executes instructions from
19673 the ``taken'' branch.  It later aborts these instructions if the
19674 predicted outcome is wrong.  However, on the R10K, even aborted
19675 instructions can have side effects.
19677 This problem only affects kernel stores and, depending on the system,
19678 kernel loads.  As an example, a speculatively-executed store may load
19679 the target memory into cache and mark the cache line as dirty, even if
19680 the store itself is later aborted.  If a DMA operation writes to the
19681 same area of memory before the ``dirty'' line is flushed, the cached
19682 data overwrites the DMA-ed data.  See the R10K processor manual
19683 for a full description, including other potential problems.
19685 One workaround is to insert cache barrier instructions before every memory
19686 access that might be speculatively executed and that might have side
19687 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
19688 controls GCC's implementation of this workaround.  It assumes that
19689 aborted accesses to any byte in the following regions does not have
19690 side effects:
19692 @enumerate
19693 @item
19694 the memory occupied by the current function's stack frame;
19696 @item
19697 the memory occupied by an incoming stack argument;
19699 @item
19700 the memory occupied by an object with a link-time-constant address.
19701 @end enumerate
19703 It is the kernel's responsibility to ensure that speculative
19704 accesses to these regions are indeed safe.
19706 If the input program contains a function declaration such as:
19708 @smallexample
19709 void foo (void);
19710 @end smallexample
19712 then the implementation of @code{foo} must allow @code{j foo} and
19713 @code{jal foo} to be executed speculatively.  GCC honors this
19714 restriction for functions it compiles itself.  It expects non-GCC
19715 functions (such as hand-written assembly code) to do the same.
19717 The option has three forms:
19719 @table @gcctabopt
19720 @item -mr10k-cache-barrier=load-store
19721 Insert a cache barrier before a load or store that might be
19722 speculatively executed and that might have side effects even
19723 if aborted.
19725 @item -mr10k-cache-barrier=store
19726 Insert a cache barrier before a store that might be speculatively
19727 executed and that might have side effects even if aborted.
19729 @item -mr10k-cache-barrier=none
19730 Disable the insertion of cache barriers.  This is the default setting.
19731 @end table
19733 @item -mflush-func=@var{func}
19734 @itemx -mno-flush-func
19735 @opindex mflush-func
19736 Specifies the function to call to flush the I and D caches, or to not
19737 call any such function.  If called, the function must take the same
19738 arguments as the common @code{_flush_func}, that is, the address of the
19739 memory range for which the cache is being flushed, the size of the
19740 memory range, and the number 3 (to flush both caches).  The default
19741 depends on the target GCC was configured for, but commonly is either
19742 @code{_flush_func} or @code{__cpu_flush}.
19744 @item mbranch-cost=@var{num}
19745 @opindex mbranch-cost
19746 Set the cost of branches to roughly @var{num} ``simple'' instructions.
19747 This cost is only a heuristic and is not guaranteed to produce
19748 consistent results across releases.  A zero cost redundantly selects
19749 the default, which is based on the @option{-mtune} setting.
19751 @item -mbranch-likely
19752 @itemx -mno-branch-likely
19753 @opindex mbranch-likely
19754 @opindex mno-branch-likely
19755 Enable or disable use of Branch Likely instructions, regardless of the
19756 default for the selected architecture.  By default, Branch Likely
19757 instructions may be generated if they are supported by the selected
19758 architecture.  An exception is for the MIPS32 and MIPS64 architectures
19759 and processors that implement those architectures; for those, Branch
19760 Likely instructions are not be generated by default because the MIPS32
19761 and MIPS64 architectures specifically deprecate their use.
19763 @item -mcompact-branches=never
19764 @itemx -mcompact-branches=optimal
19765 @itemx -mcompact-branches=always
19766 @opindex mcompact-branches=never
19767 @opindex mcompact-branches=optimal
19768 @opindex mcompact-branches=always
19769 These options control which form of branches will be generated.  The
19770 default is @option{-mcompact-branches=optimal}.
19772 The @option{-mcompact-branches=never} option ensures that compact branch
19773 instructions will never be generated.
19775 The @option{-mcompact-branches=always} option ensures that a compact
19776 branch instruction will be generated if available.  If a compact branch
19777 instruction is not available, a delay slot form of the branch will be
19778 used instead.
19780 This option is supported from MIPS Release 6 onwards.
19782 The @option{-mcompact-branches=optimal} option will cause a delay slot
19783 branch to be used if one is available in the current ISA and the delay
19784 slot is successfully filled.  If the delay slot is not filled, a compact
19785 branch will be chosen if one is available.
19787 @item -mfp-exceptions
19788 @itemx -mno-fp-exceptions
19789 @opindex mfp-exceptions
19790 Specifies whether FP exceptions are enabled.  This affects how
19791 FP instructions are scheduled for some processors.
19792 The default is that FP exceptions are
19793 enabled.
19795 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
19796 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
19797 FP pipe.
19799 @item -mvr4130-align
19800 @itemx -mno-vr4130-align
19801 @opindex mvr4130-align
19802 The VR4130 pipeline is two-way superscalar, but can only issue two
19803 instructions together if the first one is 8-byte aligned.  When this
19804 option is enabled, GCC aligns pairs of instructions that it
19805 thinks should execute in parallel.
19807 This option only has an effect when optimizing for the VR4130.
19808 It normally makes code faster, but at the expense of making it bigger.
19809 It is enabled by default at optimization level @option{-O3}.
19811 @item -msynci
19812 @itemx -mno-synci
19813 @opindex msynci
19814 Enable (disable) generation of @code{synci} instructions on
19815 architectures that support it.  The @code{synci} instructions (if
19816 enabled) are generated when @code{__builtin___clear_cache} is
19817 compiled.
19819 This option defaults to @option{-mno-synci}, but the default can be
19820 overridden by configuring GCC with @option{--with-synci}.
19822 When compiling code for single processor systems, it is generally safe
19823 to use @code{synci}.  However, on many multi-core (SMP) systems, it
19824 does not invalidate the instruction caches on all cores and may lead
19825 to undefined behavior.
19827 @item -mrelax-pic-calls
19828 @itemx -mno-relax-pic-calls
19829 @opindex mrelax-pic-calls
19830 Try to turn PIC calls that are normally dispatched via register
19831 @code{$25} into direct calls.  This is only possible if the linker can
19832 resolve the destination at link time and if the destination is within
19833 range for a direct call.
19835 @option{-mrelax-pic-calls} is the default if GCC was configured to use
19836 an assembler and a linker that support the @code{.reloc} assembly
19837 directive and @option{-mexplicit-relocs} is in effect.  With
19838 @option{-mno-explicit-relocs}, this optimization can be performed by the
19839 assembler and the linker alone without help from the compiler.
19841 @item -mmcount-ra-address
19842 @itemx -mno-mcount-ra-address
19843 @opindex mmcount-ra-address
19844 @opindex mno-mcount-ra-address
19845 Emit (do not emit) code that allows @code{_mcount} to modify the
19846 calling function's return address.  When enabled, this option extends
19847 the usual @code{_mcount} interface with a new @var{ra-address}
19848 parameter, which has type @code{intptr_t *} and is passed in register
19849 @code{$12}.  @code{_mcount} can then modify the return address by
19850 doing both of the following:
19851 @itemize
19852 @item
19853 Returning the new address in register @code{$31}.
19854 @item
19855 Storing the new address in @code{*@var{ra-address}},
19856 if @var{ra-address} is nonnull.
19857 @end itemize
19859 The default is @option{-mno-mcount-ra-address}.
19861 @item -mframe-header-opt
19862 @itemx -mno-frame-header-opt
19863 @opindex mframe-header-opt
19864 Enable (disable) frame header optimization in the o32 ABI.  When using the
19865 o32 ABI, calling functions will allocate 16 bytes on the stack for the called
19866 function to write out register arguments.  When enabled, this optimization
19867 will suppress the allocation of the frame header if it can be determined that
19868 it is unused.
19870 This optimization is off by default at all optimization levels.
19872 @item -mlxc1-sxc1
19873 @itemx -mno-lxc1-sxc1
19874 @opindex mlxc1-sxc1
19875 When applicable, enable (disable) the generation of @code{lwxc1},
19876 @code{swxc1}, @code{ldxc1}, @code{sdxc1} instructions.  Enabled by default.
19878 @item -mmadd4
19879 @itemx -mno-madd4
19880 @opindex mmadd4
19881 When applicable, enable (disable) the generation of 4-operand @code{madd.s},
19882 @code{madd.d} and related instructions.  Enabled by default.
19884 @end table
19886 @node MMIX Options
19887 @subsection MMIX Options
19888 @cindex MMIX Options
19890 These options are defined for the MMIX:
19892 @table @gcctabopt
19893 @item -mlibfuncs
19894 @itemx -mno-libfuncs
19895 @opindex mlibfuncs
19896 @opindex mno-libfuncs
19897 Specify that intrinsic library functions are being compiled, passing all
19898 values in registers, no matter the size.
19900 @item -mepsilon
19901 @itemx -mno-epsilon
19902 @opindex mepsilon
19903 @opindex mno-epsilon
19904 Generate floating-point comparison instructions that compare with respect
19905 to the @code{rE} epsilon register.
19907 @item -mabi=mmixware
19908 @itemx -mabi=gnu
19909 @opindex mabi=mmixware
19910 @opindex mabi=gnu
19911 Generate code that passes function parameters and return values that (in
19912 the called function) are seen as registers @code{$0} and up, as opposed to
19913 the GNU ABI which uses global registers @code{$231} and up.
19915 @item -mzero-extend
19916 @itemx -mno-zero-extend
19917 @opindex mzero-extend
19918 @opindex mno-zero-extend
19919 When reading data from memory in sizes shorter than 64 bits, use (do not
19920 use) zero-extending load instructions by default, rather than
19921 sign-extending ones.
19923 @item -mknuthdiv
19924 @itemx -mno-knuthdiv
19925 @opindex mknuthdiv
19926 @opindex mno-knuthdiv
19927 Make the result of a division yielding a remainder have the same sign as
19928 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
19929 remainder follows the sign of the dividend.  Both methods are
19930 arithmetically valid, the latter being almost exclusively used.
19932 @item -mtoplevel-symbols
19933 @itemx -mno-toplevel-symbols
19934 @opindex mtoplevel-symbols
19935 @opindex mno-toplevel-symbols
19936 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
19937 code can be used with the @code{PREFIX} assembly directive.
19939 @item -melf
19940 @opindex melf
19941 Generate an executable in the ELF format, rather than the default
19942 @samp{mmo} format used by the @command{mmix} simulator.
19944 @item -mbranch-predict
19945 @itemx -mno-branch-predict
19946 @opindex mbranch-predict
19947 @opindex mno-branch-predict
19948 Use (do not use) the probable-branch instructions, when static branch
19949 prediction indicates a probable branch.
19951 @item -mbase-addresses
19952 @itemx -mno-base-addresses
19953 @opindex mbase-addresses
19954 @opindex mno-base-addresses
19955 Generate (do not generate) code that uses @emph{base addresses}.  Using a
19956 base address automatically generates a request (handled by the assembler
19957 and the linker) for a constant to be set up in a global register.  The
19958 register is used for one or more base address requests within the range 0
19959 to 255 from the value held in the register.  The generally leads to short
19960 and fast code, but the number of different data items that can be
19961 addressed is limited.  This means that a program that uses lots of static
19962 data may require @option{-mno-base-addresses}.
19964 @item -msingle-exit
19965 @itemx -mno-single-exit
19966 @opindex msingle-exit
19967 @opindex mno-single-exit
19968 Force (do not force) generated code to have a single exit point in each
19969 function.
19970 @end table
19972 @node MN10300 Options
19973 @subsection MN10300 Options
19974 @cindex MN10300 options
19976 These @option{-m} options are defined for Matsushita MN10300 architectures:
19978 @table @gcctabopt
19979 @item -mmult-bug
19980 @opindex mmult-bug
19981 Generate code to avoid bugs in the multiply instructions for the MN10300
19982 processors.  This is the default.
19984 @item -mno-mult-bug
19985 @opindex mno-mult-bug
19986 Do not generate code to avoid bugs in the multiply instructions for the
19987 MN10300 processors.
19989 @item -mam33
19990 @opindex mam33
19991 Generate code using features specific to the AM33 processor.
19993 @item -mno-am33
19994 @opindex mno-am33
19995 Do not generate code using features specific to the AM33 processor.  This
19996 is the default.
19998 @item -mam33-2
19999 @opindex mam33-2
20000 Generate code using features specific to the AM33/2.0 processor.
20002 @item -mam34
20003 @opindex mam34
20004 Generate code using features specific to the AM34 processor.
20006 @item -mtune=@var{cpu-type}
20007 @opindex mtune
20008 Use the timing characteristics of the indicated CPU type when
20009 scheduling instructions.  This does not change the targeted processor
20010 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
20011 @samp{am33-2} or @samp{am34}.
20013 @item -mreturn-pointer-on-d0
20014 @opindex mreturn-pointer-on-d0
20015 When generating a function that returns a pointer, return the pointer
20016 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
20017 only in @code{a0}, and attempts to call such functions without a prototype
20018 result in errors.  Note that this option is on by default; use
20019 @option{-mno-return-pointer-on-d0} to disable it.
20021 @item -mno-crt0
20022 @opindex mno-crt0
20023 Do not link in the C run-time initialization object file.
20025 @item -mrelax
20026 @opindex mrelax
20027 Indicate to the linker that it should perform a relaxation optimization pass
20028 to shorten branches, calls and absolute memory addresses.  This option only
20029 has an effect when used on the command line for the final link step.
20031 This option makes symbolic debugging impossible.
20033 @item -mliw
20034 @opindex mliw
20035 Allow the compiler to generate @emph{Long Instruction Word}
20036 instructions if the target is the @samp{AM33} or later.  This is the
20037 default.  This option defines the preprocessor macro @code{__LIW__}.
20039 @item -mnoliw
20040 @opindex mnoliw
20041 Do not allow the compiler to generate @emph{Long Instruction Word}
20042 instructions.  This option defines the preprocessor macro
20043 @code{__NO_LIW__}.
20045 @item -msetlb
20046 @opindex msetlb
20047 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
20048 instructions if the target is the @samp{AM33} or later.  This is the
20049 default.  This option defines the preprocessor macro @code{__SETLB__}.
20051 @item -mnosetlb
20052 @opindex mnosetlb
20053 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
20054 instructions.  This option defines the preprocessor macro
20055 @code{__NO_SETLB__}.
20057 @end table
20059 @node Moxie Options
20060 @subsection Moxie Options
20061 @cindex Moxie Options
20063 @table @gcctabopt
20065 @item -meb
20066 @opindex meb
20067 Generate big-endian code.  This is the default for @samp{moxie-*-*}
20068 configurations.
20070 @item -mel
20071 @opindex mel
20072 Generate little-endian code.
20074 @item -mmul.x
20075 @opindex mmul.x
20076 Generate mul.x and umul.x instructions.  This is the default for
20077 @samp{moxiebox-*-*} configurations.
20079 @item -mno-crt0
20080 @opindex mno-crt0
20081 Do not link in the C run-time initialization object file.
20083 @end table
20085 @node MSP430 Options
20086 @subsection MSP430 Options
20087 @cindex MSP430 Options
20089 These options are defined for the MSP430:
20091 @table @gcctabopt
20093 @item -masm-hex
20094 @opindex masm-hex
20095 Force assembly output to always use hex constants.  Normally such
20096 constants are signed decimals, but this option is available for
20097 testsuite and/or aesthetic purposes.
20099 @item -mmcu=
20100 @opindex mmcu=
20101 Select the MCU to target.  This is used to create a C preprocessor
20102 symbol based upon the MCU name, converted to upper case and pre- and
20103 post-fixed with @samp{__}.  This in turn is used by the
20104 @file{msp430.h} header file to select an MCU-specific supplementary
20105 header file.
20107 The option also sets the ISA to use.  If the MCU name is one that is
20108 known to only support the 430 ISA then that is selected, otherwise the
20109 430X ISA is selected.  A generic MCU name of @samp{msp430} can also be
20110 used to select the 430 ISA.  Similarly the generic @samp{msp430x} MCU
20111 name selects the 430X ISA.
20113 In addition an MCU-specific linker script is added to the linker
20114 command line.  The script's name is the name of the MCU with
20115 @file{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the @command{gcc}
20116 command line defines the C preprocessor symbol @code{__XXX__} and
20117 cause the linker to search for a script called @file{xxx.ld}.
20119 This option is also passed on to the assembler.
20121 @item -mwarn-mcu
20122 @itemx -mno-warn-mcu
20123 @opindex mwarn-mcu
20124 @opindex mno-warn-mcu
20125 This option enables or disables warnings about conflicts between the
20126 MCU name specified by the @option{-mmcu} option and the ISA set by the
20127 @option{-mcpu} option and/or the hardware multiply support set by the
20128 @option{-mhwmult} option.  It also toggles warnings about unrecognized
20129 MCU names.  This option is on by default.
20131 @item -mcpu=
20132 @opindex mcpu=
20133 Specifies the ISA to use.  Accepted values are @samp{msp430},
20134 @samp{msp430x} and @samp{msp430xv2}.  This option is deprecated.  The
20135 @option{-mmcu=} option should be used to select the ISA.
20137 @item -msim
20138 @opindex msim
20139 Link to the simulator runtime libraries and linker script.  Overrides
20140 any scripts that would be selected by the @option{-mmcu=} option.
20142 @item -mlarge
20143 @opindex mlarge
20144 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
20146 @item -msmall
20147 @opindex msmall
20148 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
20150 @item -mrelax
20151 @opindex mrelax
20152 This option is passed to the assembler and linker, and allows the
20153 linker to perform certain optimizations that cannot be done until
20154 the final link.
20156 @item mhwmult=
20157 @opindex mhwmult=
20158 Describes the type of hardware multiply supported by the target.
20159 Accepted values are @samp{none} for no hardware multiply, @samp{16bit}
20160 for the original 16-bit-only multiply supported by early MCUs.
20161 @samp{32bit} for the 16/32-bit multiply supported by later MCUs and
20162 @samp{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
20163 A value of @samp{auto} can also be given.  This tells GCC to deduce
20164 the hardware multiply support based upon the MCU name provided by the
20165 @option{-mmcu} option.  If no @option{-mmcu} option is specified or if
20166 the MCU name is not recognized then no hardware multiply support is
20167 assumed.  @code{auto} is the default setting.
20169 Hardware multiplies are normally performed by calling a library
20170 routine.  This saves space in the generated code.  When compiling at
20171 @option{-O3} or higher however the hardware multiplier is invoked
20172 inline.  This makes for bigger, but faster code.
20174 The hardware multiply routines disable interrupts whilst running and
20175 restore the previous interrupt state when they finish.  This makes
20176 them safe to use inside interrupt handlers as well as in normal code.
20178 @item -minrt
20179 @opindex minrt
20180 Enable the use of a minimum runtime environment - no static
20181 initializers or constructors.  This is intended for memory-constrained
20182 devices.  The compiler includes special symbols in some objects
20183 that tell the linker and runtime which code fragments are required.
20185 @item -mcode-region=
20186 @itemx -mdata-region=
20187 @opindex mcode-region
20188 @opindex mdata-region
20189 These options tell the compiler where to place functions and data that
20190 do not have one of the @code{lower}, @code{upper}, @code{either} or
20191 @code{section} attributes.  Possible values are @code{lower},
20192 @code{upper}, @code{either} or @code{any}.  The first three behave
20193 like the corresponding attribute.  The fourth possible value -
20194 @code{any} - is the default.  It leaves placement entirely up to the
20195 linker script and how it assigns the standard sections
20196 (@code{.text}, @code{.data}, etc) to the memory regions.
20198 @item -msilicon-errata=
20199 @opindex msilicon-errata
20200 This option passes on a request to assembler to enable the fixes for
20201 the named silicon errata.
20203 @item -msilicon-errata-warn=
20204 @opindex msilicon-errata-warn
20205 This option passes on a request to the assembler to enable warning
20206 messages when a silicon errata might need to be applied.
20208 @end table
20210 @node NDS32 Options
20211 @subsection NDS32 Options
20212 @cindex NDS32 Options
20214 These options are defined for NDS32 implementations:
20216 @table @gcctabopt
20218 @item -mbig-endian
20219 @opindex mbig-endian
20220 Generate code in big-endian mode.
20222 @item -mlittle-endian
20223 @opindex mlittle-endian
20224 Generate code in little-endian mode.
20226 @item -mreduced-regs
20227 @opindex mreduced-regs
20228 Use reduced-set registers for register allocation.
20230 @item -mfull-regs
20231 @opindex mfull-regs
20232 Use full-set registers for register allocation.
20234 @item -mcmov
20235 @opindex mcmov
20236 Generate conditional move instructions.
20238 @item -mno-cmov
20239 @opindex mno-cmov
20240 Do not generate conditional move instructions.
20242 @item -mperf-ext
20243 @opindex mperf-ext
20244 Generate performance extension instructions.
20246 @item -mno-perf-ext
20247 @opindex mno-perf-ext
20248 Do not generate performance extension instructions.
20250 @item -mv3push
20251 @opindex mv3push
20252 Generate v3 push25/pop25 instructions.
20254 @item -mno-v3push
20255 @opindex mno-v3push
20256 Do not generate v3 push25/pop25 instructions.
20258 @item -m16-bit
20259 @opindex m16-bit
20260 Generate 16-bit instructions.
20262 @item -mno-16-bit
20263 @opindex mno-16-bit
20264 Do not generate 16-bit instructions.
20266 @item -misr-vector-size=@var{num}
20267 @opindex misr-vector-size
20268 Specify the size of each interrupt vector, which must be 4 or 16.
20270 @item -mcache-block-size=@var{num}
20271 @opindex mcache-block-size
20272 Specify the size of each cache block,
20273 which must be a power of 2 between 4 and 512.
20275 @item -march=@var{arch}
20276 @opindex march
20277 Specify the name of the target architecture.
20279 @item -mcmodel=@var{code-model}
20280 @opindex mcmodel
20281 Set the code model to one of
20282 @table @asis
20283 @item @samp{small}
20284 All the data and read-only data segments must be within 512KB addressing space.
20285 The text segment must be within 16MB addressing space.
20286 @item @samp{medium}
20287 The data segment must be within 512KB while the read-only data segment can be
20288 within 4GB addressing space.  The text segment should be still within 16MB
20289 addressing space.
20290 @item @samp{large}
20291 All the text and data segments can be within 4GB addressing space.
20292 @end table
20294 @item -mctor-dtor
20295 @opindex mctor-dtor
20296 Enable constructor/destructor feature.
20298 @item -mrelax
20299 @opindex mrelax
20300 Guide linker to relax instructions.
20302 @end table
20304 @node Nios II Options
20305 @subsection Nios II Options
20306 @cindex Nios II options
20307 @cindex Altera Nios II options
20309 These are the options defined for the Altera Nios II processor.
20311 @table @gcctabopt
20313 @item -G @var{num}
20314 @opindex G
20315 @cindex smaller data references
20316 Put global and static objects less than or equal to @var{num} bytes
20317 into the small data or BSS sections instead of the normal data or BSS
20318 sections.  The default value of @var{num} is 8.
20320 @item -mgpopt=@var{option}
20321 @item -mgpopt
20322 @itemx -mno-gpopt
20323 @opindex mgpopt
20324 @opindex mno-gpopt
20325 Generate (do not generate) GP-relative accesses.  The following 
20326 @var{option} names are recognized:
20328 @table @samp
20330 @item none
20331 Do not generate GP-relative accesses.
20333 @item local
20334 Generate GP-relative accesses for small data objects that are not 
20335 external, weak, or uninitialized common symbols.  
20336 Also use GP-relative addressing for objects that
20337 have been explicitly placed in a small data section via a @code{section}
20338 attribute.
20340 @item global
20341 As for @samp{local}, but also generate GP-relative accesses for
20342 small data objects that are external, weak, or common.  If you use this option,
20343 you must ensure that all parts of your program (including libraries) are
20344 compiled with the same @option{-G} setting.
20346 @item data
20347 Generate GP-relative accesses for all data objects in the program.  If you
20348 use this option, the entire data and BSS segments
20349 of your program must fit in 64K of memory and you must use an appropriate
20350 linker script to allocate them within the addressable range of the
20351 global pointer.
20353 @item all
20354 Generate GP-relative addresses for function pointers as well as data
20355 pointers.  If you use this option, the entire text, data, and BSS segments
20356 of your program must fit in 64K of memory and you must use an appropriate
20357 linker script to allocate them within the addressable range of the
20358 global pointer.
20360 @end table
20362 @option{-mgpopt} is equivalent to @option{-mgpopt=local}, and
20363 @option{-mno-gpopt} is equivalent to @option{-mgpopt=none}.
20365 The default is @option{-mgpopt} except when @option{-fpic} or
20366 @option{-fPIC} is specified to generate position-independent code.
20367 Note that the Nios II ABI does not permit GP-relative accesses from
20368 shared libraries.
20370 You may need to specify @option{-mno-gpopt} explicitly when building
20371 programs that include large amounts of small data, including large
20372 GOT data sections.  In this case, the 16-bit offset for GP-relative
20373 addressing may not be large enough to allow access to the entire 
20374 small data section.
20376 @item -mel
20377 @itemx -meb
20378 @opindex mel
20379 @opindex meb
20380 Generate little-endian (default) or big-endian (experimental) code,
20381 respectively.
20383 @item -march=@var{arch}
20384 @opindex march
20385 This specifies the name of the target Nios II architecture.  GCC uses this
20386 name to determine what kind of instructions it can emit when generating
20387 assembly code.  Permissible names are: @samp{r1}, @samp{r2}.
20389 The preprocessor macro @code{__nios2_arch__} is available to programs,
20390 with value 1 or 2, indicating the targeted ISA level.
20392 @item -mbypass-cache
20393 @itemx -mno-bypass-cache
20394 @opindex mno-bypass-cache
20395 @opindex mbypass-cache
20396 Force all load and store instructions to always bypass cache by 
20397 using I/O variants of the instructions. The default is not to
20398 bypass the cache.
20400 @item -mno-cache-volatile 
20401 @itemx -mcache-volatile       
20402 @opindex mcache-volatile 
20403 @opindex mno-cache-volatile
20404 Volatile memory access bypass the cache using the I/O variants of 
20405 the load and store instructions. The default is not to bypass the cache.
20407 @item -mno-fast-sw-div
20408 @itemx -mfast-sw-div
20409 @opindex mno-fast-sw-div
20410 @opindex mfast-sw-div
20411 Do not use table-based fast divide for small numbers. The default 
20412 is to use the fast divide at @option{-O3} and above.
20414 @item -mno-hw-mul
20415 @itemx -mhw-mul
20416 @itemx -mno-hw-mulx
20417 @itemx -mhw-mulx
20418 @itemx -mno-hw-div
20419 @itemx -mhw-div
20420 @opindex mno-hw-mul
20421 @opindex mhw-mul
20422 @opindex mno-hw-mulx
20423 @opindex mhw-mulx
20424 @opindex mno-hw-div
20425 @opindex mhw-div
20426 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
20427 instructions by the compiler. The default is to emit @code{mul}
20428 and not emit @code{div} and @code{mulx}.
20430 @item -mbmx
20431 @itemx -mno-bmx
20432 @itemx -mcdx
20433 @itemx -mno-cdx
20434 Enable or disable generation of Nios II R2 BMX (bit manipulation) and
20435 CDX (code density) instructions.  Enabling these instructions also
20436 requires @option{-march=r2}.  Since these instructions are optional
20437 extensions to the R2 architecture, the default is not to emit them.
20439 @item -mcustom-@var{insn}=@var{N}
20440 @itemx -mno-custom-@var{insn}
20441 @opindex mcustom-@var{insn}
20442 @opindex mno-custom-@var{insn}
20443 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
20444 custom instruction with encoding @var{N} when generating code that uses 
20445 @var{insn}.  For example, @option{-mcustom-fadds=253} generates custom
20446 instruction 253 for single-precision floating-point add operations instead
20447 of the default behavior of using a library call.
20449 The following values of @var{insn} are supported.  Except as otherwise
20450 noted, floating-point operations are expected to be implemented with
20451 normal IEEE 754 semantics and correspond directly to the C operators or the
20452 equivalent GCC built-in functions (@pxref{Other Builtins}).
20454 Single-precision floating point:
20455 @table @asis
20457 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
20458 Binary arithmetic operations.
20460 @item @samp{fnegs}
20461 Unary negation.
20463 @item @samp{fabss}
20464 Unary absolute value.
20466 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
20467 Comparison operations.
20469 @item @samp{fmins}, @samp{fmaxs}
20470 Floating-point minimum and maximum.  These instructions are only
20471 generated if @option{-ffinite-math-only} is specified.
20473 @item @samp{fsqrts}
20474 Unary square root operation.
20476 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
20477 Floating-point trigonometric and exponential functions.  These instructions
20478 are only generated if @option{-funsafe-math-optimizations} is also specified.
20480 @end table
20482 Double-precision floating point:
20483 @table @asis
20485 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
20486 Binary arithmetic operations.
20488 @item @samp{fnegd}
20489 Unary negation.
20491 @item @samp{fabsd}
20492 Unary absolute value.
20494 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
20495 Comparison operations.
20497 @item @samp{fmind}, @samp{fmaxd}
20498 Double-precision minimum and maximum.  These instructions are only
20499 generated if @option{-ffinite-math-only} is specified.
20501 @item @samp{fsqrtd}
20502 Unary square root operation.
20504 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
20505 Double-precision trigonometric and exponential functions.  These instructions
20506 are only generated if @option{-funsafe-math-optimizations} is also specified.
20508 @end table
20510 Conversions:
20511 @table @asis
20512 @item @samp{fextsd}
20513 Conversion from single precision to double precision.
20515 @item @samp{ftruncds}
20516 Conversion from double precision to single precision.
20518 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
20519 Conversion from floating point to signed or unsigned integer types, with
20520 truncation towards zero.
20522 @item @samp{round}
20523 Conversion from single-precision floating point to signed integer,
20524 rounding to the nearest integer and ties away from zero.
20525 This corresponds to the @code{__builtin_lroundf} function when
20526 @option{-fno-math-errno} is used.
20528 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
20529 Conversion from signed or unsigned integer types to floating-point types.
20531 @end table
20533 In addition, all of the following transfer instructions for internal
20534 registers X and Y must be provided to use any of the double-precision
20535 floating-point instructions.  Custom instructions taking two
20536 double-precision source operands expect the first operand in the
20537 64-bit register X.  The other operand (or only operand of a unary
20538 operation) is given to the custom arithmetic instruction with the
20539 least significant half in source register @var{src1} and the most
20540 significant half in @var{src2}.  A custom instruction that returns a
20541 double-precision result returns the most significant 32 bits in the
20542 destination register and the other half in 32-bit register Y.  
20543 GCC automatically generates the necessary code sequences to write
20544 register X and/or read register Y when double-precision floating-point
20545 instructions are used.
20547 @table @asis
20549 @item @samp{fwrx}
20550 Write @var{src1} into the least significant half of X and @var{src2} into
20551 the most significant half of X.
20553 @item @samp{fwry}
20554 Write @var{src1} into Y.
20556 @item @samp{frdxhi}, @samp{frdxlo}
20557 Read the most or least (respectively) significant half of X and store it in
20558 @var{dest}.
20560 @item @samp{frdy}
20561 Read the value of Y and store it into @var{dest}.
20562 @end table
20564 Note that you can gain more local control over generation of Nios II custom
20565 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
20566 and @code{target("no-custom-@var{insn}")} function attributes
20567 (@pxref{Function Attributes})
20568 or pragmas (@pxref{Function Specific Option Pragmas}).
20570 @item -mcustom-fpu-cfg=@var{name}
20571 @opindex mcustom-fpu-cfg
20573 This option enables a predefined, named set of custom instruction encodings
20574 (see @option{-mcustom-@var{insn}} above).  
20575 Currently, the following sets are defined:
20577 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
20578 @gccoptlist{-mcustom-fmuls=252 @gol
20579 -mcustom-fadds=253 @gol
20580 -mcustom-fsubs=254 @gol
20581 -fsingle-precision-constant}
20583 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
20584 @gccoptlist{-mcustom-fmuls=252 @gol
20585 -mcustom-fadds=253 @gol
20586 -mcustom-fsubs=254 @gol
20587 -mcustom-fdivs=255 @gol
20588 -fsingle-precision-constant}
20590 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
20591 @gccoptlist{-mcustom-floatus=243 @gol
20592 -mcustom-fixsi=244 @gol
20593 -mcustom-floatis=245 @gol
20594 -mcustom-fcmpgts=246 @gol
20595 -mcustom-fcmples=249 @gol
20596 -mcustom-fcmpeqs=250 @gol
20597 -mcustom-fcmpnes=251 @gol
20598 -mcustom-fmuls=252 @gol
20599 -mcustom-fadds=253 @gol
20600 -mcustom-fsubs=254 @gol
20601 -mcustom-fdivs=255 @gol
20602 -fsingle-precision-constant}
20604 Custom instruction assignments given by individual
20605 @option{-mcustom-@var{insn}=} options override those given by
20606 @option{-mcustom-fpu-cfg=}, regardless of the
20607 order of the options on the command line.
20609 Note that you can gain more local control over selection of a FPU
20610 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
20611 function attribute (@pxref{Function Attributes})
20612 or pragma (@pxref{Function Specific Option Pragmas}).
20614 @end table
20616 These additional @samp{-m} options are available for the Altera Nios II
20617 ELF (bare-metal) target:
20619 @table @gcctabopt
20621 @item -mhal
20622 @opindex mhal
20623 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
20624 startup and termination code, and is typically used in conjunction with
20625 @option{-msys-crt0=} to specify the location of the alternate startup code
20626 provided by the HAL BSP.
20628 @item -msmallc
20629 @opindex msmallc
20630 Link with a limited version of the C library, @option{-lsmallc}, rather than
20631 Newlib.
20633 @item -msys-crt0=@var{startfile}
20634 @opindex msys-crt0
20635 @var{startfile} is the file name of the startfile (crt0) to use 
20636 when linking.  This option is only useful in conjunction with @option{-mhal}.
20638 @item -msys-lib=@var{systemlib}
20639 @opindex msys-lib
20640 @var{systemlib} is the library name of the library that provides
20641 low-level system calls required by the C library,
20642 e.g. @code{read} and @code{write}.
20643 This option is typically used to link with a library provided by a HAL BSP.
20645 @end table
20647 @node Nvidia PTX Options
20648 @subsection Nvidia PTX Options
20649 @cindex Nvidia PTX options
20650 @cindex nvptx options
20652 These options are defined for Nvidia PTX:
20654 @table @gcctabopt
20656 @item -m32
20657 @itemx -m64
20658 @opindex m32
20659 @opindex m64
20660 Generate code for 32-bit or 64-bit ABI.
20662 @item -mmainkernel
20663 @opindex mmainkernel
20664 Link in code for a __main kernel.  This is for stand-alone instead of
20665 offloading execution.
20667 @item -moptimize
20668 @opindex moptimize
20669 Apply partitioned execution optimizations.  This is the default when any
20670 level of optimization is selected.
20672 @item -msoft-stack
20673 @opindex msoft-stack
20674 Generate code that does not use @code{.local} memory
20675 directly for stack storage. Instead, a per-warp stack pointer is
20676 maintained explicitly. This enables variable-length stack allocation (with
20677 variable-length arrays or @code{alloca}), and when global memory is used for
20678 underlying storage, makes it possible to access automatic variables from other
20679 threads, or with atomic instructions. This code generation variant is used
20680 for OpenMP offloading, but the option is exposed on its own for the purpose
20681 of testing the compiler; to generate code suitable for linking into programs
20682 using OpenMP offloading, use option @option{-mgomp}.
20684 @item -muniform-simt
20685 @opindex muniform-simt
20686 Switch to code generation variant that allows to execute all threads in each
20687 warp, while maintaining memory state and side effects as if only one thread
20688 in each warp was active outside of OpenMP SIMD regions.  All atomic operations
20689 and calls to runtime (malloc, free, vprintf) are conditionally executed (iff
20690 current lane index equals the master lane index), and the register being
20691 assigned is copied via a shuffle instruction from the master lane.  Outside of
20692 SIMD regions lane 0 is the master; inside, each thread sees itself as the
20693 master.  Shared memory array @code{int __nvptx_uni[]} stores all-zeros or
20694 all-ones bitmasks for each warp, indicating current mode (0 outside of SIMD
20695 regions).  Each thread can bitwise-and the bitmask at position @code{tid.y}
20696 with current lane index to compute the master lane index.
20698 @item -mgomp
20699 @opindex mgomp
20700 Generate code for use in OpenMP offloading: enables @option{-msoft-stack} and
20701 @option{-muniform-simt} options, and selects corresponding multilib variant.
20703 @end table
20705 @node PDP-11 Options
20706 @subsection PDP-11 Options
20707 @cindex PDP-11 Options
20709 These options are defined for the PDP-11:
20711 @table @gcctabopt
20712 @item -mfpu
20713 @opindex mfpu
20714 Use hardware FPP floating point.  This is the default.  (FIS floating
20715 point on the PDP-11/40 is not supported.)
20717 @item -msoft-float
20718 @opindex msoft-float
20719 Do not use hardware floating point.
20721 @item -mac0
20722 @opindex mac0
20723 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
20725 @item -mno-ac0
20726 @opindex mno-ac0
20727 Return floating-point results in memory.  This is the default.
20729 @item -m40
20730 @opindex m40
20731 Generate code for a PDP-11/40.
20733 @item -m45
20734 @opindex m45
20735 Generate code for a PDP-11/45.  This is the default.
20737 @item -m10
20738 @opindex m10
20739 Generate code for a PDP-11/10.
20741 @item -mbcopy-builtin
20742 @opindex mbcopy-builtin
20743 Use inline @code{movmemhi} patterns for copying memory.  This is the
20744 default.
20746 @item -mbcopy
20747 @opindex mbcopy
20748 Do not use inline @code{movmemhi} patterns for copying memory.
20750 @item -mint16
20751 @itemx -mno-int32
20752 @opindex mint16
20753 @opindex mno-int32
20754 Use 16-bit @code{int}.  This is the default.
20756 @item -mint32
20757 @itemx -mno-int16
20758 @opindex mint32
20759 @opindex mno-int16
20760 Use 32-bit @code{int}.
20762 @item -mfloat64
20763 @itemx -mno-float32
20764 @opindex mfloat64
20765 @opindex mno-float32
20766 Use 64-bit @code{float}.  This is the default.
20768 @item -mfloat32
20769 @itemx -mno-float64
20770 @opindex mfloat32
20771 @opindex mno-float64
20772 Use 32-bit @code{float}.
20774 @item -mabshi
20775 @opindex mabshi
20776 Use @code{abshi2} pattern.  This is the default.
20778 @item -mno-abshi
20779 @opindex mno-abshi
20780 Do not use @code{abshi2} pattern.
20782 @item -mbranch-expensive
20783 @opindex mbranch-expensive
20784 Pretend that branches are expensive.  This is for experimenting with
20785 code generation only.
20787 @item -mbranch-cheap
20788 @opindex mbranch-cheap
20789 Do not pretend that branches are expensive.  This is the default.
20791 @item -munix-asm
20792 @opindex munix-asm
20793 Use Unix assembler syntax.  This is the default when configured for
20794 @samp{pdp11-*-bsd}.
20796 @item -mdec-asm
20797 @opindex mdec-asm
20798 Use DEC assembler syntax.  This is the default when configured for any
20799 PDP-11 target other than @samp{pdp11-*-bsd}.
20800 @end table
20802 @node picoChip Options
20803 @subsection picoChip Options
20804 @cindex picoChip options
20806 These @samp{-m} options are defined for picoChip implementations:
20808 @table @gcctabopt
20810 @item -mae=@var{ae_type}
20811 @opindex mcpu
20812 Set the instruction set, register set, and instruction scheduling
20813 parameters for array element type @var{ae_type}.  Supported values
20814 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
20816 @option{-mae=ANY} selects a completely generic AE type.  Code
20817 generated with this option runs on any of the other AE types.  The
20818 code is not as efficient as it would be if compiled for a specific
20819 AE type, and some types of operation (e.g., multiplication) do not
20820 work properly on all types of AE.
20822 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
20823 for compiled code, and is the default.
20825 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
20826 option may suffer from poor performance of byte (char) manipulation,
20827 since the DSP AE does not provide hardware support for byte load/stores.
20829 @item -msymbol-as-address
20830 Enable the compiler to directly use a symbol name as an address in a
20831 load/store instruction, without first loading it into a
20832 register.  Typically, the use of this option generates larger
20833 programs, which run faster than when the option isn't used.  However, the
20834 results vary from program to program, so it is left as a user option,
20835 rather than being permanently enabled.
20837 @item -mno-inefficient-warnings
20838 Disables warnings about the generation of inefficient code.  These
20839 warnings can be generated, for example, when compiling code that
20840 performs byte-level memory operations on the MAC AE type.  The MAC AE has
20841 no hardware support for byte-level memory operations, so all byte
20842 load/stores must be synthesized from word load/store operations.  This is
20843 inefficient and a warning is generated to indicate
20844 that you should rewrite the code to avoid byte operations, or to target
20845 an AE type that has the necessary hardware support.  This option disables
20846 these warnings.
20848 @end table
20850 @node PowerPC Options
20851 @subsection PowerPC Options
20852 @cindex PowerPC options
20854 These are listed under @xref{RS/6000 and PowerPC Options}.
20856 @node RISC-V Options
20857 @subsection RISC-V Options
20858 @cindex RISC-V Options
20860 These command-line options are defined for RISC-V targets:
20862 @table @gcctabopt
20863 @item -mbranch-cost=@var{n}
20864 @opindex mbranch-cost
20865 Set the cost of branches to roughly @var{n} instructions.
20867 @item -mmemcpy
20868 @itemx -mno-memcpy
20869 @opindex mmemcpy
20870 Don't optimize block moves.
20872 @item -mplt
20873 @itemx -mno-plt
20874 @opindex plt
20875 When generating PIC code, allow the use of PLTs. Ignored for non-PIC.
20877 @item -mabi=@var{ABI-string}
20878 @opindex mabi
20879 Specify integer and floating-point calling convention.  This defaults to the
20880 natural calling convention: e.g.@ LP64 for RV64I, ILP32 for RV32I, LP64D for
20881 RV64G.
20883 @item -mfdiv
20884 @itemx -mno-fdiv
20885 @opindex mfdiv
20886 Use hardware floating-point divide and square root instructions.  This requires
20887 the F or D extensions for floating-point registers.
20889 @item -mdiv
20890 @itemx -mno-div
20891 @opindex mdiv
20892 Use hardware instructions for integer division.  This requires the M extension.
20894 @item -march=@var{ISA-string}
20895 @opindex march
20896 Generate code for given RISC-V ISA (e.g.@ @samp{rv64im}).  ISA strings must be
20897 lower-case.  Examples include @samp{rv64i}, @samp{rv32g}, and @samp{rv32imaf}.
20899 @item -mtune=@var{processor-string}
20900 @opindex mtune
20901 Optimize the output for the given processor, specified by microarchitecture
20902 name.
20904 @item -msmall-data-limit=@var{n}
20905 @opindex msmall-data-limit
20906 Put global and static data smaller than @var{n} bytes into a special section
20907 (on some targets).
20909 @item -msave-restore
20910 @itemx -mno-save-restore
20911 @opindex msave-restore
20912 Use smaller but slower prologue and epilogue code.
20914 @item -mcmodel=@var{code-model}
20915 @opindex mcmodel
20916 Specify the code model.
20918 @end table
20920 @node RL78 Options
20921 @subsection RL78 Options
20922 @cindex RL78 Options
20924 @table @gcctabopt
20926 @item -msim
20927 @opindex msim
20928 Links in additional target libraries to support operation within a
20929 simulator.
20931 @item -mmul=none
20932 @itemx -mmul=g10
20933 @itemx -mmul=g13
20934 @itemx -mmul=g14
20935 @itemx -mmul=rl78
20936 @opindex mmul
20937 Specifies the type of hardware multiplication and division support to
20938 be used.  The simplest is @code{none}, which uses software for both
20939 multiplication and division.  This is the default.  The @code{g13}
20940 value is for the hardware multiply/divide peripheral found on the
20941 RL78/G13 (S2 core) targets.  The @code{g14} value selects the use of
20942 the multiplication and division instructions supported by the RL78/G14
20943 (S3 core) parts.  The value @code{rl78} is an alias for @code{g14} and
20944 the value @code{mg10} is an alias for @code{none}.
20946 In addition a C preprocessor macro is defined, based upon the setting
20947 of this option.  Possible values are: @code{__RL78_MUL_NONE__},
20948 @code{__RL78_MUL_G13__} or @code{__RL78_MUL_G14__}.
20950 @item -mcpu=g10
20951 @itemx -mcpu=g13
20952 @itemx -mcpu=g14
20953 @itemx -mcpu=rl78
20954 @opindex mcpu
20955 Specifies the RL78 core to target.  The default is the G14 core, also
20956 known as an S3 core or just RL78.  The G13 or S2 core does not have
20957 multiply or divide instructions, instead it uses a hardware peripheral
20958 for these operations.  The G10 or S1 core does not have register
20959 banks, so it uses a different calling convention.
20961 If this option is set it also selects the type of hardware multiply
20962 support to use, unless this is overridden by an explicit
20963 @option{-mmul=none} option on the command line.  Thus specifying
20964 @option{-mcpu=g13} enables the use of the G13 hardware multiply
20965 peripheral and specifying @option{-mcpu=g10} disables the use of
20966 hardware multiplications altogether.
20968 Note, although the RL78/G14 core is the default target, specifying
20969 @option{-mcpu=g14} or @option{-mcpu=rl78} on the command line does
20970 change the behavior of the toolchain since it also enables G14
20971 hardware multiply support.  If these options are not specified on the
20972 command line then software multiplication routines will be used even
20973 though the code targets the RL78 core.  This is for backwards
20974 compatibility with older toolchains which did not have hardware
20975 multiply and divide support.
20977 In addition a C preprocessor macro is defined, based upon the setting
20978 of this option.  Possible values are: @code{__RL78_G10__},
20979 @code{__RL78_G13__} or @code{__RL78_G14__}.
20981 @item -mg10
20982 @itemx -mg13
20983 @itemx -mg14
20984 @itemx -mrl78
20985 @opindex mg10
20986 @opindex mg13
20987 @opindex mg14
20988 @opindex mrl78
20989 These are aliases for the corresponding @option{-mcpu=} option.  They
20990 are provided for backwards compatibility.
20992 @item -mallregs
20993 @opindex mallregs
20994 Allow the compiler to use all of the available registers.  By default
20995 registers @code{r24..r31} are reserved for use in interrupt handlers.
20996 With this option enabled these registers can be used in ordinary
20997 functions as well.
20999 @item -m64bit-doubles
21000 @itemx -m32bit-doubles
21001 @opindex m64bit-doubles
21002 @opindex m32bit-doubles
21003 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
21004 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
21005 @option{-m32bit-doubles}.
21007 @item -msave-mduc-in-interrupts
21008 @item -mno-save-mduc-in-interrupts
21009 @opindex msave-mduc-in-interrupts
21010 @opindex mno-save-mduc-in-interrupts
21011 Specifies that interrupt handler functions should preserve the
21012 MDUC registers.  This is only necessary if normal code might use
21013 the MDUC registers, for example because it performs multiplication
21014 and division operations.  The default is to ignore the MDUC registers
21015 as this makes the interrupt handlers faster.  The target option -mg13
21016 needs to be passed for this to work as this feature is only available
21017 on the G13 target (S2 core).  The MDUC registers will only be saved
21018 if the interrupt handler performs a multiplication or division
21019 operation or it calls another function.
21021 @end table
21023 @node RS/6000 and PowerPC Options
21024 @subsection IBM RS/6000 and PowerPC Options
21025 @cindex RS/6000 and PowerPC Options
21026 @cindex IBM RS/6000 and PowerPC Options
21028 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
21029 @table @gcctabopt
21030 @item -mpowerpc-gpopt
21031 @itemx -mno-powerpc-gpopt
21032 @itemx -mpowerpc-gfxopt
21033 @itemx -mno-powerpc-gfxopt
21034 @need 800
21035 @itemx -mpowerpc64
21036 @itemx -mno-powerpc64
21037 @itemx -mmfcrf
21038 @itemx -mno-mfcrf
21039 @itemx -mpopcntb
21040 @itemx -mno-popcntb
21041 @itemx -mpopcntd
21042 @itemx -mno-popcntd
21043 @itemx -mfprnd
21044 @itemx -mno-fprnd
21045 @need 800
21046 @itemx -mcmpb
21047 @itemx -mno-cmpb
21048 @itemx -mmfpgpr
21049 @itemx -mno-mfpgpr
21050 @itemx -mhard-dfp
21051 @itemx -mno-hard-dfp
21052 @opindex mpowerpc-gpopt
21053 @opindex mno-powerpc-gpopt
21054 @opindex mpowerpc-gfxopt
21055 @opindex mno-powerpc-gfxopt
21056 @opindex mpowerpc64
21057 @opindex mno-powerpc64
21058 @opindex mmfcrf
21059 @opindex mno-mfcrf
21060 @opindex mpopcntb
21061 @opindex mno-popcntb
21062 @opindex mpopcntd
21063 @opindex mno-popcntd
21064 @opindex mfprnd
21065 @opindex mno-fprnd
21066 @opindex mcmpb
21067 @opindex mno-cmpb
21068 @opindex mmfpgpr
21069 @opindex mno-mfpgpr
21070 @opindex mhard-dfp
21071 @opindex mno-hard-dfp
21072 You use these options to specify which instructions are available on the
21073 processor you are using.  The default value of these options is
21074 determined when configuring GCC@.  Specifying the
21075 @option{-mcpu=@var{cpu_type}} overrides the specification of these
21076 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
21077 rather than the options listed above.
21079 Specifying @option{-mpowerpc-gpopt} allows
21080 GCC to use the optional PowerPC architecture instructions in the
21081 General Purpose group, including floating-point square root.  Specifying
21082 @option{-mpowerpc-gfxopt} allows GCC to
21083 use the optional PowerPC architecture instructions in the Graphics
21084 group, including floating-point select.
21086 The @option{-mmfcrf} option allows GCC to generate the move from
21087 condition register field instruction implemented on the POWER4
21088 processor and other processors that support the PowerPC V2.01
21089 architecture.
21090 The @option{-mpopcntb} option allows GCC to generate the popcount and
21091 double-precision FP reciprocal estimate instruction implemented on the
21092 POWER5 processor and other processors that support the PowerPC V2.02
21093 architecture.
21094 The @option{-mpopcntd} option allows GCC to generate the popcount
21095 instruction implemented on the POWER7 processor and other processors
21096 that support the PowerPC V2.06 architecture.
21097 The @option{-mfprnd} option allows GCC to generate the FP round to
21098 integer instructions implemented on the POWER5+ processor and other
21099 processors that support the PowerPC V2.03 architecture.
21100 The @option{-mcmpb} option allows GCC to generate the compare bytes
21101 instruction implemented on the POWER6 processor and other processors
21102 that support the PowerPC V2.05 architecture.
21103 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
21104 general-purpose register instructions implemented on the POWER6X
21105 processor and other processors that support the extended PowerPC V2.05
21106 architecture.
21107 The @option{-mhard-dfp} option allows GCC to generate the decimal
21108 floating-point instructions implemented on some POWER processors.
21110 The @option{-mpowerpc64} option allows GCC to generate the additional
21111 64-bit instructions that are found in the full PowerPC64 architecture
21112 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
21113 @option{-mno-powerpc64}.
21115 @item -mcpu=@var{cpu_type}
21116 @opindex mcpu
21117 Set architecture type, register usage, and
21118 instruction scheduling parameters for machine type @var{cpu_type}.
21119 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
21120 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
21121 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
21122 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
21123 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
21124 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
21125 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
21126 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
21127 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
21128 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8},
21129 @samp{power9}, @samp{powerpc}, @samp{powerpc64}, @samp{powerpc64le},
21130 and @samp{rs64}.
21132 @option{-mcpu=powerpc}, @option{-mcpu=powerpc64}, and
21133 @option{-mcpu=powerpc64le} specify pure 32-bit PowerPC (either
21134 endian), 64-bit big endian PowerPC and 64-bit little endian PowerPC
21135 architecture machine types, with an appropriate, generic processor
21136 model assumed for scheduling purposes.
21138 The other options specify a specific processor.  Code generated under
21139 those options runs best on that processor, and may not run at all on
21140 others.
21142 The @option{-mcpu} options automatically enable or disable the
21143 following options:
21145 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
21146 -mpopcntb -mpopcntd  -mpowerpc64 @gol
21147 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
21148 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
21149 -mcrypto -mdirect-move -mhtm -mpower8-fusion -mpower8-vector @gol
21150 -mquad-memory -mquad-memory-atomic -mfloat128 -mfloat128-hardware}
21152 The particular options set for any particular CPU varies between
21153 compiler versions, depending on what setting seems to produce optimal
21154 code for that CPU; it doesn't necessarily reflect the actual hardware's
21155 capabilities.  If you wish to set an individual option to a particular
21156 value, you may specify it after the @option{-mcpu} option, like
21157 @option{-mcpu=970 -mno-altivec}.
21159 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
21160 not enabled or disabled by the @option{-mcpu} option at present because
21161 AIX does not have full support for these options.  You may still
21162 enable or disable them individually if you're sure it'll work in your
21163 environment.
21165 @item -mtune=@var{cpu_type}
21166 @opindex mtune
21167 Set the instruction scheduling parameters for machine type
21168 @var{cpu_type}, but do not set the architecture type or register usage,
21169 as @option{-mcpu=@var{cpu_type}} does.  The same
21170 values for @var{cpu_type} are used for @option{-mtune} as for
21171 @option{-mcpu}.  If both are specified, the code generated uses the
21172 architecture and registers set by @option{-mcpu}, but the
21173 scheduling parameters set by @option{-mtune}.
21175 @item -mcmodel=small
21176 @opindex mcmodel=small
21177 Generate PowerPC64 code for the small model: The TOC is limited to
21178 64k.
21180 @item -mcmodel=medium
21181 @opindex mcmodel=medium
21182 Generate PowerPC64 code for the medium model: The TOC and other static
21183 data may be up to a total of 4G in size.  This is the default for 64-bit
21184 Linux.
21186 @item -mcmodel=large
21187 @opindex mcmodel=large
21188 Generate PowerPC64 code for the large model: The TOC may be up to 4G
21189 in size.  Other data and code is only limited by the 64-bit address
21190 space.
21192 @item -maltivec
21193 @itemx -mno-altivec
21194 @opindex maltivec
21195 @opindex mno-altivec
21196 Generate code that uses (does not use) AltiVec instructions, and also
21197 enable the use of built-in functions that allow more direct access to
21198 the AltiVec instruction set.  You may also need to set
21199 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
21200 enhancements.
21202 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
21203 @option{-maltivec=be}, the element order for AltiVec intrinsics such
21204 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} 
21205 match array element order corresponding to the endianness of the
21206 target.  That is, element zero identifies the leftmost element in a
21207 vector register when targeting a big-endian platform, and identifies
21208 the rightmost element in a vector register when targeting a
21209 little-endian platform.
21211 @item -maltivec=be
21212 @opindex maltivec=be
21213 Generate AltiVec instructions using big-endian element order,
21214 regardless of whether the target is big- or little-endian.  This is
21215 the default when targeting a big-endian platform.
21217 The element order is used to interpret element numbers in AltiVec
21218 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
21219 @code{vec_insert}.  By default, these match array element order
21220 corresponding to the endianness for the target.
21222 @item -maltivec=le
21223 @opindex maltivec=le
21224 Generate AltiVec instructions using little-endian element order,
21225 regardless of whether the target is big- or little-endian.  This is
21226 the default when targeting a little-endian platform.  This option is
21227 currently ignored when targeting a big-endian platform.
21229 The element order is used to interpret element numbers in AltiVec
21230 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
21231 @code{vec_insert}.  By default, these match array element order
21232 corresponding to the endianness for the target.
21234 @item -mvrsave
21235 @itemx -mno-vrsave
21236 @opindex mvrsave
21237 @opindex mno-vrsave
21238 Generate VRSAVE instructions when generating AltiVec code.
21240 @item -mgen-cell-microcode
21241 @opindex mgen-cell-microcode
21242 Generate Cell microcode instructions.
21244 @item -mwarn-cell-microcode
21245 @opindex mwarn-cell-microcode
21246 Warn when a Cell microcode instruction is emitted.  An example
21247 of a Cell microcode instruction is a variable shift.
21249 @item -msecure-plt
21250 @opindex msecure-plt
21251 Generate code that allows @command{ld} and @command{ld.so}
21252 to build executables and shared
21253 libraries with non-executable @code{.plt} and @code{.got} sections.
21254 This is a PowerPC
21255 32-bit SYSV ABI option.
21257 @item -mbss-plt
21258 @opindex mbss-plt
21259 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
21260 fills in, and
21261 requires @code{.plt} and @code{.got}
21262 sections that are both writable and executable.
21263 This is a PowerPC 32-bit SYSV ABI option.
21265 @item -misel
21266 @itemx -mno-isel
21267 @opindex misel
21268 @opindex mno-isel
21269 This switch enables or disables the generation of ISEL instructions.
21271 @item -misel=@var{yes/no}
21272 This switch has been deprecated.  Use @option{-misel} and
21273 @option{-mno-isel} instead.
21275 @item -mlra
21276 @opindex mlra
21277 Enable Local Register Allocation. By default the port uses LRA.
21278 (i.e. @option{-mno-lra}).
21280 @item -mspe
21281 @itemx -mno-spe
21282 @opindex mspe
21283 @opindex mno-spe
21284 This switch enables or disables the generation of SPE simd
21285 instructions.
21287 @item -mpaired
21288 @itemx -mno-paired
21289 @opindex mpaired
21290 @opindex mno-paired
21291 This switch enables or disables the generation of PAIRED simd
21292 instructions.
21294 @item -mspe=@var{yes/no}
21295 This option has been deprecated.  Use @option{-mspe} and
21296 @option{-mno-spe} instead.
21298 @item -mvsx
21299 @itemx -mno-vsx
21300 @opindex mvsx
21301 @opindex mno-vsx
21302 Generate code that uses (does not use) vector/scalar (VSX)
21303 instructions, and also enable the use of built-in functions that allow
21304 more direct access to the VSX instruction set.
21306 @item -mcrypto
21307 @itemx -mno-crypto
21308 @opindex mcrypto
21309 @opindex mno-crypto
21310 Enable the use (disable) of the built-in functions that allow direct
21311 access to the cryptographic instructions that were added in version
21312 2.07 of the PowerPC ISA.
21314 @item -mdirect-move
21315 @itemx -mno-direct-move
21316 @opindex mdirect-move
21317 @opindex mno-direct-move
21318 Generate code that uses (does not use) the instructions to move data
21319 between the general purpose registers and the vector/scalar (VSX)
21320 registers that were added in version 2.07 of the PowerPC ISA.
21322 @item -mhtm
21323 @itemx -mno-htm
21324 @opindex mhtm
21325 @opindex mno-htm
21326 Enable (disable) the use of the built-in functions that allow direct
21327 access to the Hardware Transactional Memory (HTM) instructions that
21328 were added in version 2.07 of the PowerPC ISA.
21330 @item -mpower8-fusion
21331 @itemx -mno-power8-fusion
21332 @opindex mpower8-fusion
21333 @opindex mno-power8-fusion
21334 Generate code that keeps (does not keeps) some integer operations
21335 adjacent so that the instructions can be fused together on power8 and
21336 later processors.
21338 @item -mpower8-vector
21339 @itemx -mno-power8-vector
21340 @opindex mpower8-vector
21341 @opindex mno-power8-vector
21342 Generate code that uses (does not use) the vector and scalar
21343 instructions that were added in version 2.07 of the PowerPC ISA.  Also
21344 enable the use of built-in functions that allow more direct access to
21345 the vector instructions.
21347 @item -mquad-memory
21348 @itemx -mno-quad-memory
21349 @opindex mquad-memory
21350 @opindex mno-quad-memory
21351 Generate code that uses (does not use) the non-atomic quad word memory
21352 instructions.  The @option{-mquad-memory} option requires use of
21353 64-bit mode.
21355 @item -mquad-memory-atomic
21356 @itemx -mno-quad-memory-atomic
21357 @opindex mquad-memory-atomic
21358 @opindex mno-quad-memory-atomic
21359 Generate code that uses (does not use) the atomic quad word memory
21360 instructions.  The @option{-mquad-memory-atomic} option requires use of
21361 64-bit mode.
21363 @item -mupper-regs-di
21364 @itemx -mno-upper-regs-di
21365 @opindex mupper-regs-di
21366 @opindex mno-upper-regs-di
21367 Generate code that uses (does not use) the scalar instructions that
21368 target all 64 registers in the vector/scalar floating point register
21369 set that were added in version 2.06 of the PowerPC ISA when processing
21370 integers.  @option{-mupper-regs-di} is turned on by default if you use
21371 any of the @option{-mcpu=power7}, @option{-mcpu=power8},
21372 @option{-mcpu=power9}, or @option{-mvsx} options.
21374 @item -mupper-regs-df
21375 @itemx -mno-upper-regs-df
21376 @opindex mupper-regs-df
21377 @opindex mno-upper-regs-df
21378 Generate code that uses (does not use) the scalar double precision
21379 instructions that target all 64 registers in the vector/scalar
21380 floating point register set that were added in version 2.06 of the
21381 PowerPC ISA.  @option{-mupper-regs-df} is turned on by default if you
21382 use any of the @option{-mcpu=power7}, @option{-mcpu=power8},
21383 @option{-mcpu=power9}, or @option{-mvsx} options.
21385 @item -mupper-regs-sf
21386 @itemx -mno-upper-regs-sf
21387 @opindex mupper-regs-sf
21388 @opindex mno-upper-regs-sf
21389 Generate code that uses (does not use) the scalar single precision
21390 instructions that target all 64 registers in the vector/scalar
21391 floating point register set that were added in version 2.07 of the
21392 PowerPC ISA.  @option{-mupper-regs-sf} is turned on by default if you
21393 use either of the @option{-mcpu=power8}, @option{-mpower8-vector}, or
21394 @option{-mcpu=power9} options.
21396 @item -mupper-regs
21397 @itemx -mno-upper-regs
21398 @opindex mupper-regs
21399 @opindex mno-upper-regs
21400 Generate code that uses (does not use) the scalar
21401 instructions that target all 64 registers in the vector/scalar
21402 floating point register set, depending on the model of the machine.
21404 If the @option{-mno-upper-regs} option is used, it turns off both
21405 @option{-mupper-regs-sf} and @option{-mupper-regs-df} options.
21407 @item -mfloat128
21408 @itemx -mno-float128
21409 @opindex mfloat128
21410 @opindex mno-float128
21411 Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point
21412 and use either software emulation for IEEE 128-bit floating point or
21413 hardware instructions.
21415 The VSX instruction set (@option{-mvsx}, @option{-mcpu=power7}, or
21416 @option{-mcpu=power8}) must be enabled to use the @option{-mfloat128}
21417 option.  The @option{-mfloat128} option only works on PowerPC 64-bit
21418 Linux systems.
21420 If you use the ISA 3.0 instruction set (@option{-mcpu=power9}), the
21421 @option{-mfloat128} option will also enable the generation of ISA 3.0
21422 IEEE 128-bit floating point instructions.  Otherwise, IEEE 128-bit
21423 floating point will be done with software emulation.
21425 @item -mfloat128-hardware
21426 @itemx -mno-float128-hardware
21427 @opindex mfloat128-hardware
21428 @opindex mno-float128-hardware
21429 Enable/disable using ISA 3.0 hardware instructions to support the
21430 @var{__float128} data type.
21432 If you use @option{-mfloat128-hardware}, it will enable the option
21433 @option{-mfloat128} as well.
21435 If you select ISA 3.0 instructions with @option{-mcpu=power9}, but do
21436 not use either @option{-mfloat128} or @option{-mfloat128-hardware},
21437 the IEEE 128-bit floating point support will not be enabled.
21439 @item -mfloat-gprs=@var{yes/single/double/no}
21440 @itemx -mfloat-gprs
21441 @opindex mfloat-gprs
21442 This switch enables or disables the generation of floating-point
21443 operations on the general-purpose registers for architectures that
21444 support it.
21446 The argument @samp{yes} or @samp{single} enables the use of
21447 single-precision floating-point operations.
21449 The argument @samp{double} enables the use of single and
21450 double-precision floating-point operations.
21452 The argument @samp{no} disables floating-point operations on the
21453 general-purpose registers.
21455 This option is currently only available on the MPC854x.
21457 @item -m32
21458 @itemx -m64
21459 @opindex m32
21460 @opindex m64
21461 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
21462 targets (including GNU/Linux).  The 32-bit environment sets int, long
21463 and pointer to 32 bits and generates code that runs on any PowerPC
21464 variant.  The 64-bit environment sets int to 32 bits and long and
21465 pointer to 64 bits, and generates code for PowerPC64, as for
21466 @option{-mpowerpc64}.
21468 @item -mfull-toc
21469 @itemx -mno-fp-in-toc
21470 @itemx -mno-sum-in-toc
21471 @itemx -mminimal-toc
21472 @opindex mfull-toc
21473 @opindex mno-fp-in-toc
21474 @opindex mno-sum-in-toc
21475 @opindex mminimal-toc
21476 Modify generation of the TOC (Table Of Contents), which is created for
21477 every executable file.  The @option{-mfull-toc} option is selected by
21478 default.  In that case, GCC allocates at least one TOC entry for
21479 each unique non-automatic variable reference in your program.  GCC
21480 also places floating-point constants in the TOC@.  However, only
21481 16,384 entries are available in the TOC@.
21483 If you receive a linker error message that saying you have overflowed
21484 the available TOC space, you can reduce the amount of TOC space used
21485 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
21486 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
21487 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
21488 generate code to calculate the sum of an address and a constant at
21489 run time instead of putting that sum into the TOC@.  You may specify one
21490 or both of these options.  Each causes GCC to produce very slightly
21491 slower and larger code at the expense of conserving TOC space.
21493 If you still run out of space in the TOC even when you specify both of
21494 these options, specify @option{-mminimal-toc} instead.  This option causes
21495 GCC to make only one TOC entry for every file.  When you specify this
21496 option, GCC produces code that is slower and larger but which
21497 uses extremely little TOC space.  You may wish to use this option
21498 only on files that contain less frequently-executed code.
21500 @item -maix64
21501 @itemx -maix32
21502 @opindex maix64
21503 @opindex maix32
21504 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
21505 @code{long} type, and the infrastructure needed to support them.
21506 Specifying @option{-maix64} implies @option{-mpowerpc64},
21507 while @option{-maix32} disables the 64-bit ABI and
21508 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
21510 @item -mxl-compat
21511 @itemx -mno-xl-compat
21512 @opindex mxl-compat
21513 @opindex mno-xl-compat
21514 Produce code that conforms more closely to IBM XL compiler semantics
21515 when using AIX-compatible ABI@.  Pass floating-point arguments to
21516 prototyped functions beyond the register save area (RSA) on the stack
21517 in addition to argument FPRs.  Do not assume that most significant
21518 double in 128-bit long double value is properly rounded when comparing
21519 values and converting to double.  Use XL symbol names for long double
21520 support routines.
21522 The AIX calling convention was extended but not initially documented to
21523 handle an obscure K&R C case of calling a function that takes the
21524 address of its arguments with fewer arguments than declared.  IBM XL
21525 compilers access floating-point arguments that do not fit in the
21526 RSA from the stack when a subroutine is compiled without
21527 optimization.  Because always storing floating-point arguments on the
21528 stack is inefficient and rarely needed, this option is not enabled by
21529 default and only is necessary when calling subroutines compiled by IBM
21530 XL compilers without optimization.
21532 @item -mpe
21533 @opindex mpe
21534 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
21535 application written to use message passing with special startup code to
21536 enable the application to run.  The system must have PE installed in the
21537 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
21538 must be overridden with the @option{-specs=} option to specify the
21539 appropriate directory location.  The Parallel Environment does not
21540 support threads, so the @option{-mpe} option and the @option{-pthread}
21541 option are incompatible.
21543 @item -malign-natural
21544 @itemx -malign-power
21545 @opindex malign-natural
21546 @opindex malign-power
21547 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
21548 @option{-malign-natural} overrides the ABI-defined alignment of larger
21549 types, such as floating-point doubles, on their natural size-based boundary.
21550 The option @option{-malign-power} instructs GCC to follow the ABI-specified
21551 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
21553 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
21554 is not supported.
21556 @item -msoft-float
21557 @itemx -mhard-float
21558 @opindex msoft-float
21559 @opindex mhard-float
21560 Generate code that does not use (uses) the floating-point register set.
21561 Software floating-point emulation is provided if you use the
21562 @option{-msoft-float} option, and pass the option to GCC when linking.
21564 @item -msingle-float
21565 @itemx -mdouble-float
21566 @opindex msingle-float
21567 @opindex mdouble-float
21568 Generate code for single- or double-precision floating-point operations.
21569 @option{-mdouble-float} implies @option{-msingle-float}.
21571 @item -msimple-fpu
21572 @opindex msimple-fpu
21573 Do not generate @code{sqrt} and @code{div} instructions for hardware
21574 floating-point unit.
21576 @item -mfpu=@var{name}
21577 @opindex mfpu
21578 Specify type of floating-point unit.  Valid values for @var{name} are
21579 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
21580 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
21581 @samp{sp_full} (equivalent to @option{-msingle-float}),
21582 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
21584 @item -mxilinx-fpu
21585 @opindex mxilinx-fpu
21586 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
21588 @item -mmultiple
21589 @itemx -mno-multiple
21590 @opindex mmultiple
21591 @opindex mno-multiple
21592 Generate code that uses (does not use) the load multiple word
21593 instructions and the store multiple word instructions.  These
21594 instructions are generated by default on POWER systems, and not
21595 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
21596 PowerPC systems, since those instructions do not work when the
21597 processor is in little-endian mode.  The exceptions are PPC740 and
21598 PPC750 which permit these instructions in little-endian mode.
21600 @item -mstring
21601 @itemx -mno-string
21602 @opindex mstring
21603 @opindex mno-string
21604 Generate code that uses (does not use) the load string instructions
21605 and the store string word instructions to save multiple registers and
21606 do small block moves.  These instructions are generated by default on
21607 POWER systems, and not generated on PowerPC systems.  Do not use
21608 @option{-mstring} on little-endian PowerPC systems, since those
21609 instructions do not work when the processor is in little-endian mode.
21610 The exceptions are PPC740 and PPC750 which permit these instructions
21611 in little-endian mode.
21613 @item -mupdate
21614 @itemx -mno-update
21615 @opindex mupdate
21616 @opindex mno-update
21617 Generate code that uses (does not use) the load or store instructions
21618 that update the base register to the address of the calculated memory
21619 location.  These instructions are generated by default.  If you use
21620 @option{-mno-update}, there is a small window between the time that the
21621 stack pointer is updated and the address of the previous frame is
21622 stored, which means code that walks the stack frame across interrupts or
21623 signals may get corrupted data.
21625 @item -mavoid-indexed-addresses
21626 @itemx -mno-avoid-indexed-addresses
21627 @opindex mavoid-indexed-addresses
21628 @opindex mno-avoid-indexed-addresses
21629 Generate code that tries to avoid (not avoid) the use of indexed load
21630 or store instructions. These instructions can incur a performance
21631 penalty on Power6 processors in certain situations, such as when
21632 stepping through large arrays that cross a 16M boundary.  This option
21633 is enabled by default when targeting Power6 and disabled otherwise.
21635 @item -mfused-madd
21636 @itemx -mno-fused-madd
21637 @opindex mfused-madd
21638 @opindex mno-fused-madd
21639 Generate code that uses (does not use) the floating-point multiply and
21640 accumulate instructions.  These instructions are generated by default
21641 if hardware floating point is used.  The machine-dependent
21642 @option{-mfused-madd} option is now mapped to the machine-independent
21643 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
21644 mapped to @option{-ffp-contract=off}.
21646 @item -mmulhw
21647 @itemx -mno-mulhw
21648 @opindex mmulhw
21649 @opindex mno-mulhw
21650 Generate code that uses (does not use) the half-word multiply and
21651 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
21652 These instructions are generated by default when targeting those
21653 processors.
21655 @item -mdlmzb
21656 @itemx -mno-dlmzb
21657 @opindex mdlmzb
21658 @opindex mno-dlmzb
21659 Generate code that uses (does not use) the string-search @samp{dlmzb}
21660 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
21661 generated by default when targeting those processors.
21663 @item -mno-bit-align
21664 @itemx -mbit-align
21665 @opindex mno-bit-align
21666 @opindex mbit-align
21667 On System V.4 and embedded PowerPC systems do not (do) force structures
21668 and unions that contain bit-fields to be aligned to the base type of the
21669 bit-field.
21671 For example, by default a structure containing nothing but 8
21672 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
21673 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
21674 the structure is aligned to a 1-byte boundary and is 1 byte in
21675 size.
21677 @item -mno-strict-align
21678 @itemx -mstrict-align
21679 @opindex mno-strict-align
21680 @opindex mstrict-align
21681 On System V.4 and embedded PowerPC systems do not (do) assume that
21682 unaligned memory references are handled by the system.
21684 @item -mrelocatable
21685 @itemx -mno-relocatable
21686 @opindex mrelocatable
21687 @opindex mno-relocatable
21688 Generate code that allows (does not allow) a static executable to be
21689 relocated to a different address at run time.  A simple embedded
21690 PowerPC system loader should relocate the entire contents of
21691 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
21692 a table of 32-bit addresses generated by this option.  For this to
21693 work, all objects linked together must be compiled with
21694 @option{-mrelocatable} or @option{-mrelocatable-lib}.
21695 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
21697 @item -mrelocatable-lib
21698 @itemx -mno-relocatable-lib
21699 @opindex mrelocatable-lib
21700 @opindex mno-relocatable-lib
21701 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
21702 @code{.fixup} section to allow static executables to be relocated at
21703 run time, but @option{-mrelocatable-lib} does not use the smaller stack
21704 alignment of @option{-mrelocatable}.  Objects compiled with
21705 @option{-mrelocatable-lib} may be linked with objects compiled with
21706 any combination of the @option{-mrelocatable} options.
21708 @item -mno-toc
21709 @itemx -mtoc
21710 @opindex mno-toc
21711 @opindex mtoc
21712 On System V.4 and embedded PowerPC systems do not (do) assume that
21713 register 2 contains a pointer to a global area pointing to the addresses
21714 used in the program.
21716 @item -mlittle
21717 @itemx -mlittle-endian
21718 @opindex mlittle
21719 @opindex mlittle-endian
21720 On System V.4 and embedded PowerPC systems compile code for the
21721 processor in little-endian mode.  The @option{-mlittle-endian} option is
21722 the same as @option{-mlittle}.
21724 @item -mbig
21725 @itemx -mbig-endian
21726 @opindex mbig
21727 @opindex mbig-endian
21728 On System V.4 and embedded PowerPC systems compile code for the
21729 processor in big-endian mode.  The @option{-mbig-endian} option is
21730 the same as @option{-mbig}.
21732 @item -mdynamic-no-pic
21733 @opindex mdynamic-no-pic
21734 On Darwin and Mac OS X systems, compile code so that it is not
21735 relocatable, but that its external references are relocatable.  The
21736 resulting code is suitable for applications, but not shared
21737 libraries.
21739 @item -msingle-pic-base
21740 @opindex msingle-pic-base
21741 Treat the register used for PIC addressing as read-only, rather than
21742 loading it in the prologue for each function.  The runtime system is
21743 responsible for initializing this register with an appropriate value
21744 before execution begins.
21746 @item -mprioritize-restricted-insns=@var{priority}
21747 @opindex mprioritize-restricted-insns
21748 This option controls the priority that is assigned to
21749 dispatch-slot restricted instructions during the second scheduling
21750 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
21751 or @samp{2} to assign no, highest, or second-highest (respectively) 
21752 priority to dispatch-slot restricted
21753 instructions.
21755 @item -msched-costly-dep=@var{dependence_type}
21756 @opindex msched-costly-dep
21757 This option controls which dependences are considered costly
21758 by the target during instruction scheduling.  The argument
21759 @var{dependence_type} takes one of the following values:
21761 @table @asis
21762 @item @samp{no}
21763 No dependence is costly.
21765 @item @samp{all}
21766 All dependences are costly.
21768 @item @samp{true_store_to_load}
21769 A true dependence from store to load is costly.
21771 @item @samp{store_to_load}
21772 Any dependence from store to load is costly.
21774 @item @var{number}
21775 Any dependence for which the latency is greater than or equal to 
21776 @var{number} is costly.
21777 @end table
21779 @item -minsert-sched-nops=@var{scheme}
21780 @opindex minsert-sched-nops
21781 This option controls which NOP insertion scheme is used during
21782 the second scheduling pass.  The argument @var{scheme} takes one of the
21783 following values:
21785 @table @asis
21786 @item @samp{no}
21787 Don't insert NOPs.
21789 @item @samp{pad}
21790 Pad with NOPs any dispatch group that has vacant issue slots,
21791 according to the scheduler's grouping.
21793 @item @samp{regroup_exact}
21794 Insert NOPs to force costly dependent insns into
21795 separate groups.  Insert exactly as many NOPs as needed to force an insn
21796 to a new group, according to the estimated processor grouping.
21798 @item @var{number}
21799 Insert NOPs to force costly dependent insns into
21800 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
21801 @end table
21803 @item -mcall-sysv
21804 @opindex mcall-sysv
21805 On System V.4 and embedded PowerPC systems compile code using calling
21806 conventions that adhere to the March 1995 draft of the System V
21807 Application Binary Interface, PowerPC processor supplement.  This is the
21808 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
21810 @item -mcall-sysv-eabi
21811 @itemx -mcall-eabi
21812 @opindex mcall-sysv-eabi
21813 @opindex mcall-eabi
21814 Specify both @option{-mcall-sysv} and @option{-meabi} options.
21816 @item -mcall-sysv-noeabi
21817 @opindex mcall-sysv-noeabi
21818 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
21820 @item -mcall-aixdesc
21821 @opindex m
21822 On System V.4 and embedded PowerPC systems compile code for the AIX
21823 operating system.
21825 @item -mcall-linux
21826 @opindex mcall-linux
21827 On System V.4 and embedded PowerPC systems compile code for the
21828 Linux-based GNU system.
21830 @item -mcall-freebsd
21831 @opindex mcall-freebsd
21832 On System V.4 and embedded PowerPC systems compile code for the
21833 FreeBSD operating system.
21835 @item -mcall-netbsd
21836 @opindex mcall-netbsd
21837 On System V.4 and embedded PowerPC systems compile code for the
21838 NetBSD operating system.
21840 @item -mcall-openbsd
21841 @opindex mcall-netbsd
21842 On System V.4 and embedded PowerPC systems compile code for the
21843 OpenBSD operating system.
21845 @item -maix-struct-return
21846 @opindex maix-struct-return
21847 Return all structures in memory (as specified by the AIX ABI)@.
21849 @item -msvr4-struct-return
21850 @opindex msvr4-struct-return
21851 Return structures smaller than 8 bytes in registers (as specified by the
21852 SVR4 ABI)@.
21854 @item -mabi=@var{abi-type}
21855 @opindex mabi
21856 Extend the current ABI with a particular extension, or remove such extension.
21857 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
21858 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
21859 @samp{elfv1}, @samp{elfv2}@.
21861 @item -mabi=spe
21862 @opindex mabi=spe
21863 Extend the current ABI with SPE ABI extensions.  This does not change
21864 the default ABI, instead it adds the SPE ABI extensions to the current
21865 ABI@.
21867 @item -mabi=no-spe
21868 @opindex mabi=no-spe
21869 Disable Book-E SPE ABI extensions for the current ABI@.
21871 @item -mabi=ibmlongdouble
21872 @opindex mabi=ibmlongdouble
21873 Change the current ABI to use IBM extended-precision long double.
21874 This is a PowerPC 32-bit SYSV ABI option.
21876 @item -mabi=ieeelongdouble
21877 @opindex mabi=ieeelongdouble
21878 Change the current ABI to use IEEE extended-precision long double.
21879 This is a PowerPC 32-bit Linux ABI option.
21881 @item -mabi=elfv1
21882 @opindex mabi=elfv1
21883 Change the current ABI to use the ELFv1 ABI.
21884 This is the default ABI for big-endian PowerPC 64-bit Linux.
21885 Overriding the default ABI requires special system support and is
21886 likely to fail in spectacular ways.
21888 @item -mabi=elfv2
21889 @opindex mabi=elfv2
21890 Change the current ABI to use the ELFv2 ABI.
21891 This is the default ABI for little-endian PowerPC 64-bit Linux.
21892 Overriding the default ABI requires special system support and is
21893 likely to fail in spectacular ways.
21895 @item -mgnu-attribute
21896 @itemx -mno-gnu-attribute
21897 @opindex mgnu-attribute
21898 @opindex mno-gnu-attribute
21899 Emit .gnu_attribute assembly directives to set tag/value pairs in a
21900 .gnu.attributes section that specify ABI variations in function
21901 parameters or return values.
21903 @item -mprototype
21904 @itemx -mno-prototype
21905 @opindex mprototype
21906 @opindex mno-prototype
21907 On System V.4 and embedded PowerPC systems assume that all calls to
21908 variable argument functions are properly prototyped.  Otherwise, the
21909 compiler must insert an instruction before every non-prototyped call to
21910 set or clear bit 6 of the condition code register (@code{CR}) to
21911 indicate whether floating-point values are passed in the floating-point
21912 registers in case the function takes variable arguments.  With
21913 @option{-mprototype}, only calls to prototyped variable argument functions
21914 set or clear the bit.
21916 @item -msim
21917 @opindex msim
21918 On embedded PowerPC systems, assume that the startup module is called
21919 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
21920 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
21921 configurations.
21923 @item -mmvme
21924 @opindex mmvme
21925 On embedded PowerPC systems, assume that the startup module is called
21926 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
21927 @file{libc.a}.
21929 @item -mads
21930 @opindex mads
21931 On embedded PowerPC systems, assume that the startup module is called
21932 @file{crt0.o} and the standard C libraries are @file{libads.a} and
21933 @file{libc.a}.
21935 @item -myellowknife
21936 @opindex myellowknife
21937 On embedded PowerPC systems, assume that the startup module is called
21938 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
21939 @file{libc.a}.
21941 @item -mvxworks
21942 @opindex mvxworks
21943 On System V.4 and embedded PowerPC systems, specify that you are
21944 compiling for a VxWorks system.
21946 @item -memb
21947 @opindex memb
21948 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
21949 header to indicate that @samp{eabi} extended relocations are used.
21951 @item -meabi
21952 @itemx -mno-eabi
21953 @opindex meabi
21954 @opindex mno-eabi
21955 On System V.4 and embedded PowerPC systems do (do not) adhere to the
21956 Embedded Applications Binary Interface (EABI), which is a set of
21957 modifications to the System V.4 specifications.  Selecting @option{-meabi}
21958 means that the stack is aligned to an 8-byte boundary, a function
21959 @code{__eabi} is called from @code{main} to set up the EABI
21960 environment, and the @option{-msdata} option can use both @code{r2} and
21961 @code{r13} to point to two separate small data areas.  Selecting
21962 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
21963 no EABI initialization function is called from @code{main}, and the
21964 @option{-msdata} option only uses @code{r13} to point to a single
21965 small data area.  The @option{-meabi} option is on by default if you
21966 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
21968 @item -msdata=eabi
21969 @opindex msdata=eabi
21970 On System V.4 and embedded PowerPC systems, put small initialized
21971 @code{const} global and static data in the @code{.sdata2} section, which
21972 is pointed to by register @code{r2}.  Put small initialized
21973 non-@code{const} global and static data in the @code{.sdata} section,
21974 which is pointed to by register @code{r13}.  Put small uninitialized
21975 global and static data in the @code{.sbss} section, which is adjacent to
21976 the @code{.sdata} section.  The @option{-msdata=eabi} option is
21977 incompatible with the @option{-mrelocatable} option.  The
21978 @option{-msdata=eabi} option also sets the @option{-memb} option.
21980 @item -msdata=sysv
21981 @opindex msdata=sysv
21982 On System V.4 and embedded PowerPC systems, put small global and static
21983 data in the @code{.sdata} section, which is pointed to by register
21984 @code{r13}.  Put small uninitialized global and static data in the
21985 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
21986 The @option{-msdata=sysv} option is incompatible with the
21987 @option{-mrelocatable} option.
21989 @item -msdata=default
21990 @itemx -msdata
21991 @opindex msdata=default
21992 @opindex msdata
21993 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
21994 compile code the same as @option{-msdata=eabi}, otherwise compile code the
21995 same as @option{-msdata=sysv}.
21997 @item -msdata=data
21998 @opindex msdata=data
21999 On System V.4 and embedded PowerPC systems, put small global
22000 data in the @code{.sdata} section.  Put small uninitialized global
22001 data in the @code{.sbss} section.  Do not use register @code{r13}
22002 to address small data however.  This is the default behavior unless
22003 other @option{-msdata} options are used.
22005 @item -msdata=none
22006 @itemx -mno-sdata
22007 @opindex msdata=none
22008 @opindex mno-sdata
22009 On embedded PowerPC systems, put all initialized global and static data
22010 in the @code{.data} section, and all uninitialized data in the
22011 @code{.bss} section.
22013 @item -mblock-move-inline-limit=@var{num}
22014 @opindex mblock-move-inline-limit
22015 Inline all block moves (such as calls to @code{memcpy} or structure
22016 copies) less than or equal to @var{num} bytes.  The minimum value for
22017 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
22018 targets.  The default value is target-specific.
22020 @item -G @var{num}
22021 @opindex G
22022 @cindex smaller data references (PowerPC)
22023 @cindex .sdata/.sdata2 references (PowerPC)
22024 On embedded PowerPC systems, put global and static items less than or
22025 equal to @var{num} bytes into the small data or BSS sections instead of
22026 the normal data or BSS section.  By default, @var{num} is 8.  The
22027 @option{-G @var{num}} switch is also passed to the linker.
22028 All modules should be compiled with the same @option{-G @var{num}} value.
22030 @item -mregnames
22031 @itemx -mno-regnames
22032 @opindex mregnames
22033 @opindex mno-regnames
22034 On System V.4 and embedded PowerPC systems do (do not) emit register
22035 names in the assembly language output using symbolic forms.
22037 @item -mlongcall
22038 @itemx -mno-longcall
22039 @opindex mlongcall
22040 @opindex mno-longcall
22041 By default assume that all calls are far away so that a longer and more
22042 expensive calling sequence is required.  This is required for calls
22043 farther than 32 megabytes (33,554,432 bytes) from the current location.
22044 A short call is generated if the compiler knows
22045 the call cannot be that far away.  This setting can be overridden by
22046 the @code{shortcall} function attribute, or by @code{#pragma
22047 longcall(0)}.
22049 Some linkers are capable of detecting out-of-range calls and generating
22050 glue code on the fly.  On these systems, long calls are unnecessary and
22051 generate slower code.  As of this writing, the AIX linker can do this,
22052 as can the GNU linker for PowerPC/64.  It is planned to add this feature
22053 to the GNU linker for 32-bit PowerPC systems as well.
22055 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
22056 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
22057 addresses represent the callee and the branch island.  The
22058 Darwin/PPC linker prefers the first address and generates a @code{bl
22059 callee} if the PPC @code{bl} instruction reaches the callee directly;
22060 otherwise, the linker generates @code{bl L42} to call the branch
22061 island.  The branch island is appended to the body of the
22062 calling function; it computes the full 32-bit address of the callee
22063 and jumps to it.
22065 On Mach-O (Darwin) systems, this option directs the compiler emit to
22066 the glue for every direct call, and the Darwin linker decides whether
22067 to use or discard it.
22069 In the future, GCC may ignore all longcall specifications
22070 when the linker is known to generate glue.
22072 @item -mtls-markers
22073 @itemx -mno-tls-markers
22074 @opindex mtls-markers
22075 @opindex mno-tls-markers
22076 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
22077 specifying the function argument.  The relocation allows the linker to
22078 reliably associate function call with argument setup instructions for
22079 TLS optimization, which in turn allows GCC to better schedule the
22080 sequence.
22082 @item -mrecip
22083 @itemx -mno-recip
22084 @opindex mrecip
22085 This option enables use of the reciprocal estimate and
22086 reciprocal square root estimate instructions with additional
22087 Newton-Raphson steps to increase precision instead of doing a divide or
22088 square root and divide for floating-point arguments.  You should use
22089 the @option{-ffast-math} option when using @option{-mrecip} (or at
22090 least @option{-funsafe-math-optimizations},
22091 @option{-ffinite-math-only}, @option{-freciprocal-math} and
22092 @option{-fno-trapping-math}).  Note that while the throughput of the
22093 sequence is generally higher than the throughput of the non-reciprocal
22094 instruction, the precision of the sequence can be decreased by up to 2
22095 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
22096 roots.
22098 @item -mrecip=@var{opt}
22099 @opindex mrecip=opt
22100 This option controls which reciprocal estimate instructions
22101 may be used.  @var{opt} is a comma-separated list of options, which may
22102 be preceded by a @code{!} to invert the option:
22104 @table @samp
22106 @item all
22107 Enable all estimate instructions.
22109 @item default 
22110 Enable the default instructions, equivalent to @option{-mrecip}.
22112 @item none 
22113 Disable all estimate instructions, equivalent to @option{-mno-recip}.
22115 @item div 
22116 Enable the reciprocal approximation instructions for both 
22117 single and double precision.
22119 @item divf 
22120 Enable the single-precision reciprocal approximation instructions.
22122 @item divd 
22123 Enable the double-precision reciprocal approximation instructions.
22125 @item rsqrt 
22126 Enable the reciprocal square root approximation instructions for both
22127 single and double precision.
22129 @item rsqrtf 
22130 Enable the single-precision reciprocal square root approximation instructions.
22132 @item rsqrtd 
22133 Enable the double-precision reciprocal square root approximation instructions.
22135 @end table
22137 So, for example, @option{-mrecip=all,!rsqrtd} enables
22138 all of the reciprocal estimate instructions, except for the
22139 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
22140 which handle the double-precision reciprocal square root calculations.
22142 @item -mrecip-precision
22143 @itemx -mno-recip-precision
22144 @opindex mrecip-precision
22145 Assume (do not assume) that the reciprocal estimate instructions
22146 provide higher-precision estimates than is mandated by the PowerPC
22147 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
22148 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
22149 The double-precision square root estimate instructions are not generated by
22150 default on low-precision machines, since they do not provide an
22151 estimate that converges after three steps.
22153 @item -mveclibabi=@var{type}
22154 @opindex mveclibabi
22155 Specifies the ABI type to use for vectorizing intrinsics using an
22156 external library.  The only type supported at present is @samp{mass},
22157 which specifies to use IBM's Mathematical Acceleration Subsystem
22158 (MASS) libraries for vectorizing intrinsics using external libraries.
22159 GCC currently emits calls to @code{acosd2}, @code{acosf4},
22160 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
22161 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
22162 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
22163 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
22164 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
22165 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
22166 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
22167 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
22168 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
22169 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
22170 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
22171 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
22172 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
22173 for power7.  Both @option{-ftree-vectorize} and
22174 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
22175 libraries must be specified at link time.
22177 @item -mfriz
22178 @itemx -mno-friz
22179 @opindex mfriz
22180 Generate (do not generate) the @code{friz} instruction when the
22181 @option{-funsafe-math-optimizations} option is used to optimize
22182 rounding of floating-point values to 64-bit integer and back to floating
22183 point.  The @code{friz} instruction does not return the same value if
22184 the floating-point number is too large to fit in an integer.
22186 @item -mpointers-to-nested-functions
22187 @itemx -mno-pointers-to-nested-functions
22188 @opindex mpointers-to-nested-functions
22189 Generate (do not generate) code to load up the static chain register
22190 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
22191 systems where a function pointer points to a 3-word descriptor giving
22192 the function address, TOC value to be loaded in register @code{r2}, and
22193 static chain value to be loaded in register @code{r11}.  The
22194 @option{-mpointers-to-nested-functions} is on by default.  You cannot
22195 call through pointers to nested functions or pointers
22196 to functions compiled in other languages that use the static chain if
22197 you use @option{-mno-pointers-to-nested-functions}.
22199 @item -msave-toc-indirect
22200 @itemx -mno-save-toc-indirect
22201 @opindex msave-toc-indirect
22202 Generate (do not generate) code to save the TOC value in the reserved
22203 stack location in the function prologue if the function calls through
22204 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
22205 saved in the prologue, it is saved just before the call through the
22206 pointer.  The @option{-mno-save-toc-indirect} option is the default.
22208 @item -mcompat-align-parm
22209 @itemx -mno-compat-align-parm
22210 @opindex mcompat-align-parm
22211 Generate (do not generate) code to pass structure parameters with a
22212 maximum alignment of 64 bits, for compatibility with older versions
22213 of GCC.
22215 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
22216 structure parameter on a 128-bit boundary when that structure contained
22217 a member requiring 128-bit alignment.  This is corrected in more
22218 recent versions of GCC.  This option may be used to generate code
22219 that is compatible with functions compiled with older versions of
22220 GCC.
22222 The @option{-mno-compat-align-parm} option is the default.
22224 @item -mstack-protector-guard=@var{guard}
22225 @itemx -mstack-protector-guard-reg=@var{reg}
22226 @itemx -mstack-protector-guard-offset=@var{offset}
22227 @opindex mstack-protector-guard
22228 @opindex mstack-protector-guard-reg
22229 @opindex mstack-protector-guard-offset
22230 Generate stack protection code using canary at @var{guard}.  Supported
22231 locations are @samp{global} for global canary or @samp{tls} for per-thread
22232 canary in the TLS block (the default with GNU libc version 2.4 or later).
22234 With the latter choice the options
22235 @option{-mstack-protector-guard-reg=@var{reg}} and
22236 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
22237 which register to use as base register for reading the canary, and from what
22238 offset from that base register. The default for those is as specified in the
22239 relevant ABI.
22240 @end table
22242 @node RX Options
22243 @subsection RX Options
22244 @cindex RX Options
22246 These command-line options are defined for RX targets:
22248 @table @gcctabopt
22249 @item -m64bit-doubles
22250 @itemx -m32bit-doubles
22251 @opindex m64bit-doubles
22252 @opindex m32bit-doubles
22253 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
22254 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
22255 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
22256 works on 32-bit values, which is why the default is
22257 @option{-m32bit-doubles}.
22259 @item -fpu
22260 @itemx -nofpu
22261 @opindex fpu
22262 @opindex nofpu
22263 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
22264 floating-point hardware.  The default is enabled for the RX600
22265 series and disabled for the RX200 series.
22267 Floating-point instructions are only generated for 32-bit floating-point 
22268 values, however, so the FPU hardware is not used for doubles if the
22269 @option{-m64bit-doubles} option is used.
22271 @emph{Note} If the @option{-fpu} option is enabled then
22272 @option{-funsafe-math-optimizations} is also enabled automatically.
22273 This is because the RX FPU instructions are themselves unsafe.
22275 @item -mcpu=@var{name}
22276 @opindex mcpu
22277 Selects the type of RX CPU to be targeted.  Currently three types are
22278 supported, the generic @samp{RX600} and @samp{RX200} series hardware and
22279 the specific @samp{RX610} CPU.  The default is @samp{RX600}.
22281 The only difference between @samp{RX600} and @samp{RX610} is that the
22282 @samp{RX610} does not support the @code{MVTIPL} instruction.
22284 The @samp{RX200} series does not have a hardware floating-point unit
22285 and so @option{-nofpu} is enabled by default when this type is
22286 selected.
22288 @item -mbig-endian-data
22289 @itemx -mlittle-endian-data
22290 @opindex mbig-endian-data
22291 @opindex mlittle-endian-data
22292 Store data (but not code) in the big-endian format.  The default is
22293 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
22294 format.
22296 @item -msmall-data-limit=@var{N}
22297 @opindex msmall-data-limit
22298 Specifies the maximum size in bytes of global and static variables
22299 which can be placed into the small data area.  Using the small data
22300 area can lead to smaller and faster code, but the size of area is
22301 limited and it is up to the programmer to ensure that the area does
22302 not overflow.  Also when the small data area is used one of the RX's
22303 registers (usually @code{r13}) is reserved for use pointing to this
22304 area, so it is no longer available for use by the compiler.  This
22305 could result in slower and/or larger code if variables are pushed onto
22306 the stack instead of being held in this register.
22308 Note, common variables (variables that have not been initialized) and
22309 constants are not placed into the small data area as they are assigned
22310 to other sections in the output executable.
22312 The default value is zero, which disables this feature.  Note, this
22313 feature is not enabled by default with higher optimization levels
22314 (@option{-O2} etc) because of the potentially detrimental effects of
22315 reserving a register.  It is up to the programmer to experiment and
22316 discover whether this feature is of benefit to their program.  See the
22317 description of the @option{-mpid} option for a description of how the
22318 actual register to hold the small data area pointer is chosen.
22320 @item -msim
22321 @itemx -mno-sim
22322 @opindex msim
22323 @opindex mno-sim
22324 Use the simulator runtime.  The default is to use the libgloss
22325 board-specific runtime.
22327 @item -mas100-syntax
22328 @itemx -mno-as100-syntax
22329 @opindex mas100-syntax
22330 @opindex mno-as100-syntax
22331 When generating assembler output use a syntax that is compatible with
22332 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
22333 assembler, but it has some restrictions so it is not generated by default.
22335 @item -mmax-constant-size=@var{N}
22336 @opindex mmax-constant-size
22337 Specifies the maximum size, in bytes, of a constant that can be used as
22338 an operand in a RX instruction.  Although the RX instruction set does
22339 allow constants of up to 4 bytes in length to be used in instructions,
22340 a longer value equates to a longer instruction.  Thus in some
22341 circumstances it can be beneficial to restrict the size of constants
22342 that are used in instructions.  Constants that are too big are instead
22343 placed into a constant pool and referenced via register indirection.
22345 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
22346 or 4 means that constants of any size are allowed.
22348 @item -mrelax
22349 @opindex mrelax
22350 Enable linker relaxation.  Linker relaxation is a process whereby the
22351 linker attempts to reduce the size of a program by finding shorter
22352 versions of various instructions.  Disabled by default.
22354 @item -mint-register=@var{N}
22355 @opindex mint-register
22356 Specify the number of registers to reserve for fast interrupt handler
22357 functions.  The value @var{N} can be between 0 and 4.  A value of 1
22358 means that register @code{r13} is reserved for the exclusive use
22359 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
22360 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
22361 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
22362 A value of 0, the default, does not reserve any registers.
22364 @item -msave-acc-in-interrupts
22365 @opindex msave-acc-in-interrupts
22366 Specifies that interrupt handler functions should preserve the
22367 accumulator register.  This is only necessary if normal code might use
22368 the accumulator register, for example because it performs 64-bit
22369 multiplications.  The default is to ignore the accumulator as this
22370 makes the interrupt handlers faster.
22372 @item -mpid
22373 @itemx -mno-pid
22374 @opindex mpid
22375 @opindex mno-pid
22376 Enables the generation of position independent data.  When enabled any
22377 access to constant data is done via an offset from a base address
22378 held in a register.  This allows the location of constant data to be
22379 determined at run time without requiring the executable to be
22380 relocated, which is a benefit to embedded applications with tight
22381 memory constraints.  Data that can be modified is not affected by this
22382 option.
22384 Note, using this feature reserves a register, usually @code{r13}, for
22385 the constant data base address.  This can result in slower and/or
22386 larger code, especially in complicated functions.
22388 The actual register chosen to hold the constant data base address
22389 depends upon whether the @option{-msmall-data-limit} and/or the
22390 @option{-mint-register} command-line options are enabled.  Starting
22391 with register @code{r13} and proceeding downwards, registers are
22392 allocated first to satisfy the requirements of @option{-mint-register},
22393 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
22394 is possible for the small data area register to be @code{r8} if both
22395 @option{-mint-register=4} and @option{-mpid} are specified on the
22396 command line.
22398 By default this feature is not enabled.  The default can be restored
22399 via the @option{-mno-pid} command-line option.
22401 @item -mno-warn-multiple-fast-interrupts
22402 @itemx -mwarn-multiple-fast-interrupts
22403 @opindex mno-warn-multiple-fast-interrupts
22404 @opindex mwarn-multiple-fast-interrupts
22405 Prevents GCC from issuing a warning message if it finds more than one
22406 fast interrupt handler when it is compiling a file.  The default is to
22407 issue a warning for each extra fast interrupt handler found, as the RX
22408 only supports one such interrupt.
22410 @item -mallow-string-insns
22411 @itemx -mno-allow-string-insns
22412 @opindex mallow-string-insns
22413 @opindex mno-allow-string-insns
22414 Enables or disables the use of the string manipulation instructions
22415 @code{SMOVF}, @code{SCMPU}, @code{SMOVB}, @code{SMOVU}, @code{SUNTIL}
22416 @code{SWHILE} and also the @code{RMPA} instruction.  These
22417 instructions may prefetch data, which is not safe to do if accessing
22418 an I/O register.  (See section 12.2.7 of the RX62N Group User's Manual
22419 for more information).
22421 The default is to allow these instructions, but it is not possible for
22422 GCC to reliably detect all circumstances where a string instruction
22423 might be used to access an I/O register, so their use cannot be
22424 disabled automatically.  Instead it is reliant upon the programmer to
22425 use the @option{-mno-allow-string-insns} option if their program
22426 accesses I/O space.
22428 When the instructions are enabled GCC defines the C preprocessor
22429 symbol @code{__RX_ALLOW_STRING_INSNS__}, otherwise it defines the
22430 symbol @code{__RX_DISALLOW_STRING_INSNS__}.
22432 @item -mjsr
22433 @itemx -mno-jsr
22434 @opindex mjsr
22435 @opindex mno-jsr
22436 Use only (or not only) @code{JSR} instructions to access functions.
22437 This option can be used when code size exceeds the range of @code{BSR}
22438 instructions.  Note that @option{-mno-jsr} does not mean to not use
22439 @code{JSR} but instead means that any type of branch may be used.
22440 @end table
22442 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
22443 has special significance to the RX port when used with the
22444 @code{interrupt} function attribute.  This attribute indicates a
22445 function intended to process fast interrupts.  GCC ensures
22446 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
22447 and/or @code{r13} and only provided that the normal use of the
22448 corresponding registers have been restricted via the
22449 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
22450 options.
22452 @node S/390 and zSeries Options
22453 @subsection S/390 and zSeries Options
22454 @cindex S/390 and zSeries Options
22456 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
22458 @table @gcctabopt
22459 @item -mhard-float
22460 @itemx -msoft-float
22461 @opindex mhard-float
22462 @opindex msoft-float
22463 Use (do not use) the hardware floating-point instructions and registers
22464 for floating-point operations.  When @option{-msoft-float} is specified,
22465 functions in @file{libgcc.a} are used to perform floating-point
22466 operations.  When @option{-mhard-float} is specified, the compiler
22467 generates IEEE floating-point instructions.  This is the default.
22469 @item -mhard-dfp
22470 @itemx -mno-hard-dfp
22471 @opindex mhard-dfp
22472 @opindex mno-hard-dfp
22473 Use (do not use) the hardware decimal-floating-point instructions for
22474 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
22475 specified, functions in @file{libgcc.a} are used to perform
22476 decimal-floating-point operations.  When @option{-mhard-dfp} is
22477 specified, the compiler generates decimal-floating-point hardware
22478 instructions.  This is the default for @option{-march=z9-ec} or higher.
22480 @item -mlong-double-64
22481 @itemx -mlong-double-128
22482 @opindex mlong-double-64
22483 @opindex mlong-double-128
22484 These switches control the size of @code{long double} type. A size
22485 of 64 bits makes the @code{long double} type equivalent to the @code{double}
22486 type. This is the default.
22488 @item -mbackchain
22489 @itemx -mno-backchain
22490 @opindex mbackchain
22491 @opindex mno-backchain
22492 Store (do not store) the address of the caller's frame as backchain pointer
22493 into the callee's stack frame.
22494 A backchain may be needed to allow debugging using tools that do not understand
22495 DWARF call frame information.
22496 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
22497 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
22498 the backchain is placed into the topmost word of the 96/160 byte register
22499 save area.
22501 In general, code compiled with @option{-mbackchain} is call-compatible with
22502 code compiled with @option{-mmo-backchain}; however, use of the backchain
22503 for debugging purposes usually requires that the whole binary is built with
22504 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
22505 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
22506 to build a linux kernel use @option{-msoft-float}.
22508 The default is to not maintain the backchain.
22510 @item -mpacked-stack
22511 @itemx -mno-packed-stack
22512 @opindex mpacked-stack
22513 @opindex mno-packed-stack
22514 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
22515 specified, the compiler uses the all fields of the 96/160 byte register save
22516 area only for their default purpose; unused fields still take up stack space.
22517 When @option{-mpacked-stack} is specified, register save slots are densely
22518 packed at the top of the register save area; unused space is reused for other
22519 purposes, allowing for more efficient use of the available stack space.
22520 However, when @option{-mbackchain} is also in effect, the topmost word of
22521 the save area is always used to store the backchain, and the return address
22522 register is always saved two words below the backchain.
22524 As long as the stack frame backchain is not used, code generated with
22525 @option{-mpacked-stack} is call-compatible with code generated with
22526 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
22527 S/390 or zSeries generated code that uses the stack frame backchain at run
22528 time, not just for debugging purposes.  Such code is not call-compatible
22529 with code compiled with @option{-mpacked-stack}.  Also, note that the
22530 combination of @option{-mbackchain},
22531 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
22532 to build a linux kernel use @option{-msoft-float}.
22534 The default is to not use the packed stack layout.
22536 @item -msmall-exec
22537 @itemx -mno-small-exec
22538 @opindex msmall-exec
22539 @opindex mno-small-exec
22540 Generate (or do not generate) code using the @code{bras} instruction
22541 to do subroutine calls.
22542 This only works reliably if the total executable size does not
22543 exceed 64k.  The default is to use the @code{basr} instruction instead,
22544 which does not have this limitation.
22546 @item -m64
22547 @itemx -m31
22548 @opindex m64
22549 @opindex m31
22550 When @option{-m31} is specified, generate code compliant to the
22551 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
22552 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
22553 particular to generate 64-bit instructions.  For the @samp{s390}
22554 targets, the default is @option{-m31}, while the @samp{s390x}
22555 targets default to @option{-m64}.
22557 @item -mzarch
22558 @itemx -mesa
22559 @opindex mzarch
22560 @opindex mesa
22561 When @option{-mzarch} is specified, generate code using the
22562 instructions available on z/Architecture.
22563 When @option{-mesa} is specified, generate code using the
22564 instructions available on ESA/390.  Note that @option{-mesa} is
22565 not possible with @option{-m64}.
22566 When generating code compliant to the GNU/Linux for S/390 ABI,
22567 the default is @option{-mesa}.  When generating code compliant
22568 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
22570 @item -mhtm
22571 @itemx -mno-htm
22572 @opindex mhtm
22573 @opindex mno-htm
22574 The @option{-mhtm} option enables a set of builtins making use of
22575 instructions available with the transactional execution facility
22576 introduced with the IBM zEnterprise EC12 machine generation
22577 @ref{S/390 System z Built-in Functions}.
22578 @option{-mhtm} is enabled by default when using @option{-march=zEC12}.
22580 @item -mvx
22581 @itemx -mno-vx
22582 @opindex mvx
22583 @opindex mno-vx
22584 When @option{-mvx} is specified, generate code using the instructions
22585 available with the vector extension facility introduced with the IBM
22586 z13 machine generation.
22587 This option changes the ABI for some vector type values with regard to
22588 alignment and calling conventions.  In case vector type values are
22589 being used in an ABI-relevant context a GAS @samp{.gnu_attribute}
22590 command will be added to mark the resulting binary with the ABI used.
22591 @option{-mvx} is enabled by default when using @option{-march=z13}.
22593 @item -mzvector
22594 @itemx -mno-zvector
22595 @opindex mzvector
22596 @opindex mno-zvector
22597 The @option{-mzvector} option enables vector language extensions and
22598 builtins using instructions available with the vector extension
22599 facility introduced with the IBM z13 machine generation.
22600 This option adds support for @samp{vector} to be used as a keyword to
22601 define vector type variables and arguments.  @samp{vector} is only
22602 available when GNU extensions are enabled.  It will not be expanded
22603 when requesting strict standard compliance e.g. with @option{-std=c99}.
22604 In addition to the GCC low-level builtins @option{-mzvector} enables
22605 a set of builtins added for compatibility with AltiVec-style
22606 implementations like Power and Cell.  In order to make use of these
22607 builtins the header file @file{vecintrin.h} needs to be included.
22608 @option{-mzvector} is disabled by default.
22610 @item -mmvcle
22611 @itemx -mno-mvcle
22612 @opindex mmvcle
22613 @opindex mno-mvcle
22614 Generate (or do not generate) code using the @code{mvcle} instruction
22615 to perform block moves.  When @option{-mno-mvcle} is specified,
22616 use a @code{mvc} loop instead.  This is the default unless optimizing for
22617 size.
22619 @item -mdebug
22620 @itemx -mno-debug
22621 @opindex mdebug
22622 @opindex mno-debug
22623 Print (or do not print) additional debug information when compiling.
22624 The default is to not print debug information.
22626 @item -march=@var{cpu-type}
22627 @opindex march
22628 Generate code that runs on @var{cpu-type}, which is the name of a
22629 system representing a certain processor type.  Possible values for
22630 @var{cpu-type} are @samp{z900}/@samp{arch5}, @samp{z990}/@samp{arch6},
22631 @samp{z9-109}, @samp{z9-ec}/@samp{arch7}, @samp{z10}/@samp{arch8},
22632 @samp{z196}/@samp{arch9}, @samp{zEC12}, @samp{z13}/@samp{arch11}, and
22633 @samp{native}.
22635 The default is @option{-march=z900}.  @samp{g5}/@samp{arch3} and
22636 @samp{g6} are deprecated and will be removed with future releases.
22638 Specifying @samp{native} as cpu type can be used to select the best
22639 architecture option for the host processor.
22640 @option{-march=native} has no effect if GCC does not recognize the
22641 processor.
22643 @item -mtune=@var{cpu-type}
22644 @opindex mtune
22645 Tune to @var{cpu-type} everything applicable about the generated code,
22646 except for the ABI and the set of available instructions.
22647 The list of @var{cpu-type} values is the same as for @option{-march}.
22648 The default is the value used for @option{-march}.
22650 @item -mtpf-trace
22651 @itemx -mno-tpf-trace
22652 @opindex mtpf-trace
22653 @opindex mno-tpf-trace
22654 Generate code that adds (does not add) in TPF OS specific branches to trace
22655 routines in the operating system.  This option is off by default, even
22656 when compiling for the TPF OS@.
22658 @item -mfused-madd
22659 @itemx -mno-fused-madd
22660 @opindex mfused-madd
22661 @opindex mno-fused-madd
22662 Generate code that uses (does not use) the floating-point multiply and
22663 accumulate instructions.  These instructions are generated by default if
22664 hardware floating point is used.
22666 @item -mwarn-framesize=@var{framesize}
22667 @opindex mwarn-framesize
22668 Emit a warning if the current function exceeds the given frame size.  Because
22669 this is a compile-time check it doesn't need to be a real problem when the program
22670 runs.  It is intended to identify functions that most probably cause
22671 a stack overflow.  It is useful to be used in an environment with limited stack
22672 size e.g.@: the linux kernel.
22674 @item -mwarn-dynamicstack
22675 @opindex mwarn-dynamicstack
22676 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
22677 arrays.  This is generally a bad idea with a limited stack size.
22679 @item -mstack-guard=@var{stack-guard}
22680 @itemx -mstack-size=@var{stack-size}
22681 @opindex mstack-guard
22682 @opindex mstack-size
22683 If these options are provided the S/390 back end emits additional instructions in
22684 the function prologue that trigger a trap if the stack size is @var{stack-guard}
22685 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
22686 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
22687 the frame size of the compiled function is chosen.
22688 These options are intended to be used to help debugging stack overflow problems.
22689 The additionally emitted code causes only little overhead and hence can also be
22690 used in production-like systems without greater performance degradation.  The given
22691 values have to be exact powers of 2 and @var{stack-size} has to be greater than
22692 @var{stack-guard} without exceeding 64k.
22693 In order to be efficient the extra code makes the assumption that the stack starts
22694 at an address aligned to the value given by @var{stack-size}.
22695 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
22697 @item -mhotpatch=@var{pre-halfwords},@var{post-halfwords}
22698 @opindex mhotpatch
22699 If the hotpatch option is enabled, a ``hot-patching'' function
22700 prologue is generated for all functions in the compilation unit.
22701 The funtion label is prepended with the given number of two-byte
22702 NOP instructions (@var{pre-halfwords}, maximum 1000000).  After
22703 the label, 2 * @var{post-halfwords} bytes are appended, using the
22704 largest NOP like instructions the architecture allows (maximum
22705 1000000).
22707 If both arguments are zero, hotpatching is disabled.
22709 This option can be overridden for individual functions with the
22710 @code{hotpatch} attribute.
22711 @end table
22713 @node Score Options
22714 @subsection Score Options
22715 @cindex Score Options
22717 These options are defined for Score implementations:
22719 @table @gcctabopt
22720 @item -meb
22721 @opindex meb
22722 Compile code for big-endian mode.  This is the default.
22724 @item -mel
22725 @opindex mel
22726 Compile code for little-endian mode.
22728 @item -mnhwloop
22729 @opindex mnhwloop
22730 Disable generation of @code{bcnz} instructions.
22732 @item -muls
22733 @opindex muls
22734 Enable generation of unaligned load and store instructions.
22736 @item -mmac
22737 @opindex mmac
22738 Enable the use of multiply-accumulate instructions. Disabled by default.
22740 @item -mscore5
22741 @opindex mscore5
22742 Specify the SCORE5 as the target architecture.
22744 @item -mscore5u
22745 @opindex mscore5u
22746 Specify the SCORE5U of the target architecture.
22748 @item -mscore7
22749 @opindex mscore7
22750 Specify the SCORE7 as the target architecture. This is the default.
22752 @item -mscore7d
22753 @opindex mscore7d
22754 Specify the SCORE7D as the target architecture.
22755 @end table
22757 @node SH Options
22758 @subsection SH Options
22760 These @samp{-m} options are defined for the SH implementations:
22762 @table @gcctabopt
22763 @item -m1
22764 @opindex m1
22765 Generate code for the SH1.
22767 @item -m2
22768 @opindex m2
22769 Generate code for the SH2.
22771 @item -m2e
22772 Generate code for the SH2e.
22774 @item -m2a-nofpu
22775 @opindex m2a-nofpu
22776 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
22777 that the floating-point unit is not used.
22779 @item -m2a-single-only
22780 @opindex m2a-single-only
22781 Generate code for the SH2a-FPU, in such a way that no double-precision
22782 floating-point operations are used.
22784 @item -m2a-single
22785 @opindex m2a-single
22786 Generate code for the SH2a-FPU assuming the floating-point unit is in
22787 single-precision mode by default.
22789 @item -m2a
22790 @opindex m2a
22791 Generate code for the SH2a-FPU assuming the floating-point unit is in
22792 double-precision mode by default.
22794 @item -m3
22795 @opindex m3
22796 Generate code for the SH3.
22798 @item -m3e
22799 @opindex m3e
22800 Generate code for the SH3e.
22802 @item -m4-nofpu
22803 @opindex m4-nofpu
22804 Generate code for the SH4 without a floating-point unit.
22806 @item -m4-single-only
22807 @opindex m4-single-only
22808 Generate code for the SH4 with a floating-point unit that only
22809 supports single-precision arithmetic.
22811 @item -m4-single
22812 @opindex m4-single
22813 Generate code for the SH4 assuming the floating-point unit is in
22814 single-precision mode by default.
22816 @item -m4
22817 @opindex m4
22818 Generate code for the SH4.
22820 @item -m4-100
22821 @opindex m4-100
22822 Generate code for SH4-100.
22824 @item -m4-100-nofpu
22825 @opindex m4-100-nofpu
22826 Generate code for SH4-100 in such a way that the
22827 floating-point unit is not used.
22829 @item -m4-100-single
22830 @opindex m4-100-single
22831 Generate code for SH4-100 assuming the floating-point unit is in
22832 single-precision mode by default.
22834 @item -m4-100-single-only
22835 @opindex m4-100-single-only
22836 Generate code for SH4-100 in such a way that no double-precision
22837 floating-point operations are used.
22839 @item -m4-200
22840 @opindex m4-200
22841 Generate code for SH4-200.
22843 @item -m4-200-nofpu
22844 @opindex m4-200-nofpu
22845 Generate code for SH4-200 without in such a way that the
22846 floating-point unit is not used.
22848 @item -m4-200-single
22849 @opindex m4-200-single
22850 Generate code for SH4-200 assuming the floating-point unit is in
22851 single-precision mode by default.
22853 @item -m4-200-single-only
22854 @opindex m4-200-single-only
22855 Generate code for SH4-200 in such a way that no double-precision
22856 floating-point operations are used.
22858 @item -m4-300
22859 @opindex m4-300
22860 Generate code for SH4-300.
22862 @item -m4-300-nofpu
22863 @opindex m4-300-nofpu
22864 Generate code for SH4-300 without in such a way that the
22865 floating-point unit is not used.
22867 @item -m4-300-single
22868 @opindex m4-300-single
22869 Generate code for SH4-300 in such a way that no double-precision
22870 floating-point operations are used.
22872 @item -m4-300-single-only
22873 @opindex m4-300-single-only
22874 Generate code for SH4-300 in such a way that no double-precision
22875 floating-point operations are used.
22877 @item -m4-340
22878 @opindex m4-340
22879 Generate code for SH4-340 (no MMU, no FPU).
22881 @item -m4-500
22882 @opindex m4-500
22883 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
22884 assembler.
22886 @item -m4a-nofpu
22887 @opindex m4a-nofpu
22888 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
22889 floating-point unit is not used.
22891 @item -m4a-single-only
22892 @opindex m4a-single-only
22893 Generate code for the SH4a, in such a way that no double-precision
22894 floating-point operations are used.
22896 @item -m4a-single
22897 @opindex m4a-single
22898 Generate code for the SH4a assuming the floating-point unit is in
22899 single-precision mode by default.
22901 @item -m4a
22902 @opindex m4a
22903 Generate code for the SH4a.
22905 @item -m4al
22906 @opindex m4al
22907 Same as @option{-m4a-nofpu}, except that it implicitly passes
22908 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
22909 instructions at the moment.
22911 @item -mb
22912 @opindex mb
22913 Compile code for the processor in big-endian mode.
22915 @item -ml
22916 @opindex ml
22917 Compile code for the processor in little-endian mode.
22919 @item -mdalign
22920 @opindex mdalign
22921 Align doubles at 64-bit boundaries.  Note that this changes the calling
22922 conventions, and thus some functions from the standard C library do
22923 not work unless you recompile it first with @option{-mdalign}.
22925 @item -mrelax
22926 @opindex mrelax
22927 Shorten some address references at link time, when possible; uses the
22928 linker option @option{-relax}.
22930 @item -mbigtable
22931 @opindex mbigtable
22932 Use 32-bit offsets in @code{switch} tables.  The default is to use
22933 16-bit offsets.
22935 @item -mbitops
22936 @opindex mbitops
22937 Enable the use of bit manipulation instructions on SH2A.
22939 @item -mfmovd
22940 @opindex mfmovd
22941 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
22942 alignment constraints.
22944 @item -mrenesas
22945 @opindex mrenesas
22946 Comply with the calling conventions defined by Renesas.
22948 @item -mno-renesas
22949 @opindex mno-renesas
22950 Comply with the calling conventions defined for GCC before the Renesas
22951 conventions were available.  This option is the default for all
22952 targets of the SH toolchain.
22954 @item -mnomacsave
22955 @opindex mnomacsave
22956 Mark the @code{MAC} register as call-clobbered, even if
22957 @option{-mrenesas} is given.
22959 @item -mieee
22960 @itemx -mno-ieee
22961 @opindex mieee
22962 @opindex mno-ieee
22963 Control the IEEE compliance of floating-point comparisons, which affects the
22964 handling of cases where the result of a comparison is unordered.  By default
22965 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
22966 enabled @option{-mno-ieee} is implicitly set, which results in faster
22967 floating-point greater-equal and less-equal comparisons.  The implicit settings
22968 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
22970 @item -minline-ic_invalidate
22971 @opindex minline-ic_invalidate
22972 Inline code to invalidate instruction cache entries after setting up
22973 nested function trampolines.
22974 This option has no effect if @option{-musermode} is in effect and the selected
22975 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
22976 instruction.
22977 If the selected code generation option does not allow the use of the @code{icbi}
22978 instruction, and @option{-musermode} is not in effect, the inlined code
22979 manipulates the instruction cache address array directly with an associative
22980 write.  This not only requires privileged mode at run time, but it also
22981 fails if the cache line had been mapped via the TLB and has become unmapped.
22983 @item -misize
22984 @opindex misize
22985 Dump instruction size and location in the assembly code.
22987 @item -mpadstruct
22988 @opindex mpadstruct
22989 This option is deprecated.  It pads structures to multiple of 4 bytes,
22990 which is incompatible with the SH ABI@.
22992 @item -matomic-model=@var{model}
22993 @opindex matomic-model=@var{model}
22994 Sets the model of atomic operations and additional parameters as a comma
22995 separated list.  For details on the atomic built-in functions see
22996 @ref{__atomic Builtins}.  The following models and parameters are supported:
22998 @table @samp
23000 @item none
23001 Disable compiler generated atomic sequences and emit library calls for atomic
23002 operations.  This is the default if the target is not @code{sh*-*-linux*}.
23004 @item soft-gusa
23005 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
23006 built-in functions.  The generated atomic sequences require additional support
23007 from the interrupt/exception handling code of the system and are only suitable
23008 for SH3* and SH4* single-core systems.  This option is enabled by default when
23009 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
23010 this option also partially utilizes the hardware atomic instructions
23011 @code{movli.l} and @code{movco.l} to create more efficient code, unless
23012 @samp{strict} is specified.  
23014 @item soft-tcb
23015 Generate software atomic sequences that use a variable in the thread control
23016 block.  This is a variation of the gUSA sequences which can also be used on
23017 SH1* and SH2* targets.  The generated atomic sequences require additional
23018 support from the interrupt/exception handling code of the system and are only
23019 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
23020 parameter has to be specified as well.
23022 @item soft-imask
23023 Generate software atomic sequences that temporarily disable interrupts by
23024 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
23025 in privileged mode and is only suitable for single-core systems.  Additional
23026 support from the interrupt/exception handling code of the system is not
23027 required.  This model is enabled by default when the target is
23028 @code{sh*-*-linux*} and SH1* or SH2*.
23030 @item hard-llcs
23031 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
23032 instructions only.  This is only available on SH4A and is suitable for
23033 multi-core systems.  Since the hardware instructions support only 32 bit atomic
23034 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
23035 Code compiled with this option is also compatible with other software
23036 atomic model interrupt/exception handling systems if executed on an SH4A
23037 system.  Additional support from the interrupt/exception handling code of the
23038 system is not required for this model.
23040 @item gbr-offset=
23041 This parameter specifies the offset in bytes of the variable in the thread
23042 control block structure that should be used by the generated atomic sequences
23043 when the @samp{soft-tcb} model has been selected.  For other models this
23044 parameter is ignored.  The specified value must be an integer multiple of four
23045 and in the range 0-1020.
23047 @item strict
23048 This parameter prevents mixed usage of multiple atomic models, even if they
23049 are compatible, and makes the compiler generate atomic sequences of the
23050 specified model only.
23052 @end table
23054 @item -mtas
23055 @opindex mtas
23056 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
23057 Notice that depending on the particular hardware and software configuration
23058 this can degrade overall performance due to the operand cache line flushes
23059 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
23060 processors the @code{tas.b} instruction must be used with caution since it
23061 can result in data corruption for certain cache configurations.
23063 @item -mprefergot
23064 @opindex mprefergot
23065 When generating position-independent code, emit function calls using
23066 the Global Offset Table instead of the Procedure Linkage Table.
23068 @item -musermode
23069 @itemx -mno-usermode
23070 @opindex musermode
23071 @opindex mno-usermode
23072 Don't allow (allow) the compiler generating privileged mode code.  Specifying
23073 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
23074 inlined code would not work in user mode.  @option{-musermode} is the default
23075 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
23076 @option{-musermode} has no effect, since there is no user mode.
23078 @item -multcost=@var{number}
23079 @opindex multcost=@var{number}
23080 Set the cost to assume for a multiply insn.
23082 @item -mdiv=@var{strategy}
23083 @opindex mdiv=@var{strategy}
23084 Set the division strategy to be used for integer division operations.
23085 @var{strategy} can be one of: 
23087 @table @samp
23089 @item call-div1
23090 Calls a library function that uses the single-step division instruction
23091 @code{div1} to perform the operation.  Division by zero calculates an
23092 unspecified result and does not trap.  This is the default except for SH4,
23093 SH2A and SHcompact.
23095 @item call-fp
23096 Calls a library function that performs the operation in double precision
23097 floating point.  Division by zero causes a floating-point exception.  This is
23098 the default for SHcompact with FPU.  Specifying this for targets that do not
23099 have a double precision FPU defaults to @code{call-div1}.
23101 @item call-table
23102 Calls a library function that uses a lookup table for small divisors and
23103 the @code{div1} instruction with case distinction for larger divisors.  Division
23104 by zero calculates an unspecified result and does not trap.  This is the default
23105 for SH4.  Specifying this for targets that do not have dynamic shift
23106 instructions defaults to @code{call-div1}.
23108 @end table
23110 When a division strategy has not been specified the default strategy is
23111 selected based on the current target.  For SH2A the default strategy is to
23112 use the @code{divs} and @code{divu} instructions instead of library function
23113 calls.
23115 @item -maccumulate-outgoing-args
23116 @opindex maccumulate-outgoing-args
23117 Reserve space once for outgoing arguments in the function prologue rather
23118 than around each call.  Generally beneficial for performance and size.  Also
23119 needed for unwinding to avoid changing the stack frame around conditional code.
23121 @item -mdivsi3_libfunc=@var{name}
23122 @opindex mdivsi3_libfunc=@var{name}
23123 Set the name of the library function used for 32-bit signed division to
23124 @var{name}.
23125 This only affects the name used in the @samp{call} division strategies, and
23126 the compiler still expects the same sets of input/output/clobbered registers as
23127 if this option were not present.
23129 @item -mfixed-range=@var{register-range}
23130 @opindex mfixed-range
23131 Generate code treating the given register range as fixed registers.
23132 A fixed register is one that the register allocator can not use.  This is
23133 useful when compiling kernel code.  A register range is specified as
23134 two registers separated by a dash.  Multiple register ranges can be
23135 specified separated by a comma.
23137 @item -mbranch-cost=@var{num}
23138 @opindex mbranch-cost=@var{num}
23139 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
23140 make the compiler try to generate more branch-free code if possible.  
23141 If not specified the value is selected depending on the processor type that
23142 is being compiled for.
23144 @item -mzdcbranch
23145 @itemx -mno-zdcbranch
23146 @opindex mzdcbranch
23147 @opindex mno-zdcbranch
23148 Assume (do not assume) that zero displacement conditional branch instructions
23149 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
23150 compiler prefers zero displacement branch code sequences.  This is
23151 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
23152 disabled by specifying @option{-mno-zdcbranch}.
23154 @item -mcbranch-force-delay-slot
23155 @opindex mcbranch-force-delay-slot
23156 Force the usage of delay slots for conditional branches, which stuffs the delay
23157 slot with a @code{nop} if a suitable instruction can't be found.  By default
23158 this option is disabled.  It can be enabled to work around hardware bugs as
23159 found in the original SH7055.
23161 @item -mfused-madd
23162 @itemx -mno-fused-madd
23163 @opindex mfused-madd
23164 @opindex mno-fused-madd
23165 Generate code that uses (does not use) the floating-point multiply and
23166 accumulate instructions.  These instructions are generated by default
23167 if hardware floating point is used.  The machine-dependent
23168 @option{-mfused-madd} option is now mapped to the machine-independent
23169 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
23170 mapped to @option{-ffp-contract=off}.
23172 @item -mfsca
23173 @itemx -mno-fsca
23174 @opindex mfsca
23175 @opindex mno-fsca
23176 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
23177 and cosine approximations.  The option @option{-mfsca} must be used in
23178 combination with @option{-funsafe-math-optimizations}.  It is enabled by default
23179 when generating code for SH4A.  Using @option{-mno-fsca} disables sine and cosine
23180 approximations even if @option{-funsafe-math-optimizations} is in effect.
23182 @item -mfsrra
23183 @itemx -mno-fsrra
23184 @opindex mfsrra
23185 @opindex mno-fsrra
23186 Allow or disallow the compiler to emit the @code{fsrra} instruction for
23187 reciprocal square root approximations.  The option @option{-mfsrra} must be used
23188 in combination with @option{-funsafe-math-optimizations} and
23189 @option{-ffinite-math-only}.  It is enabled by default when generating code for
23190 SH4A.  Using @option{-mno-fsrra} disables reciprocal square root approximations
23191 even if @option{-funsafe-math-optimizations} and @option{-ffinite-math-only} are
23192 in effect.
23194 @item -mpretend-cmove
23195 @opindex mpretend-cmove
23196 Prefer zero-displacement conditional branches for conditional move instruction
23197 patterns.  This can result in faster code on the SH4 processor.
23199 @item -mfdpic
23200 @opindex fdpic
23201 Generate code using the FDPIC ABI.
23203 @end table
23205 @node Solaris 2 Options
23206 @subsection Solaris 2 Options
23207 @cindex Solaris 2 options
23209 These @samp{-m} options are supported on Solaris 2:
23211 @table @gcctabopt
23212 @item -mclear-hwcap
23213 @opindex mclear-hwcap
23214 @option{-mclear-hwcap} tells the compiler to remove the hardware
23215 capabilities generated by the Solaris assembler.  This is only necessary
23216 when object files use ISA extensions not supported by the current
23217 machine, but check at runtime whether or not to use them.
23219 @item -mimpure-text
23220 @opindex mimpure-text
23221 @option{-mimpure-text}, used in addition to @option{-shared}, tells
23222 the compiler to not pass @option{-z text} to the linker when linking a
23223 shared object.  Using this option, you can link position-dependent
23224 code into a shared object.
23226 @option{-mimpure-text} suppresses the ``relocations remain against
23227 allocatable but non-writable sections'' linker error message.
23228 However, the necessary relocations trigger copy-on-write, and the
23229 shared object is not actually shared across processes.  Instead of
23230 using @option{-mimpure-text}, you should compile all source code with
23231 @option{-fpic} or @option{-fPIC}.
23233 @end table
23235 These switches are supported in addition to the above on Solaris 2:
23237 @table @gcctabopt
23238 @item -pthreads
23239 @opindex pthreads
23240 This is a synonym for @option{-pthread}.
23241 @end table
23243 @node SPARC Options
23244 @subsection SPARC Options
23245 @cindex SPARC options
23247 These @samp{-m} options are supported on the SPARC:
23249 @table @gcctabopt
23250 @item -mno-app-regs
23251 @itemx -mapp-regs
23252 @opindex mno-app-regs
23253 @opindex mapp-regs
23254 Specify @option{-mapp-regs} to generate output using the global registers
23255 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
23256 global register 1, each global register 2 through 4 is then treated as an
23257 allocable register that is clobbered by function calls.  This is the default.
23259 To be fully SVR4 ABI-compliant at the cost of some performance loss,
23260 specify @option{-mno-app-regs}.  You should compile libraries and system
23261 software with this option.
23263 @item -mflat
23264 @itemx -mno-flat
23265 @opindex mflat
23266 @opindex mno-flat
23267 With @option{-mflat}, the compiler does not generate save/restore instructions
23268 and uses a ``flat'' or single register window model.  This model is compatible
23269 with the regular register window model.  The local registers and the input
23270 registers (0--5) are still treated as ``call-saved'' registers and are
23271 saved on the stack as needed.
23273 With @option{-mno-flat} (the default), the compiler generates save/restore
23274 instructions (except for leaf functions).  This is the normal operating mode.
23276 @item -mfpu
23277 @itemx -mhard-float
23278 @opindex mfpu
23279 @opindex mhard-float
23280 Generate output containing floating-point instructions.  This is the
23281 default.
23283 @item -mno-fpu
23284 @itemx -msoft-float
23285 @opindex mno-fpu
23286 @opindex msoft-float
23287 Generate output containing library calls for floating point.
23288 @strong{Warning:} the requisite libraries are not available for all SPARC
23289 targets.  Normally the facilities of the machine's usual C compiler are
23290 used, but this cannot be done directly in cross-compilation.  You must make
23291 your own arrangements to provide suitable library functions for
23292 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
23293 @samp{sparclite-*-*} do provide software floating-point support.
23295 @option{-msoft-float} changes the calling convention in the output file;
23296 therefore, it is only useful if you compile @emph{all} of a program with
23297 this option.  In particular, you need to compile @file{libgcc.a}, the
23298 library that comes with GCC, with @option{-msoft-float} in order for
23299 this to work.
23301 @item -mhard-quad-float
23302 @opindex mhard-quad-float
23303 Generate output containing quad-word (long double) floating-point
23304 instructions.
23306 @item -msoft-quad-float
23307 @opindex msoft-quad-float
23308 Generate output containing library calls for quad-word (long double)
23309 floating-point instructions.  The functions called are those specified
23310 in the SPARC ABI@.  This is the default.
23312 As of this writing, there are no SPARC implementations that have hardware
23313 support for the quad-word floating-point instructions.  They all invoke
23314 a trap handler for one of these instructions, and then the trap handler
23315 emulates the effect of the instruction.  Because of the trap handler overhead,
23316 this is much slower than calling the ABI library routines.  Thus the
23317 @option{-msoft-quad-float} option is the default.
23319 @item -mno-unaligned-doubles
23320 @itemx -munaligned-doubles
23321 @opindex mno-unaligned-doubles
23322 @opindex munaligned-doubles
23323 Assume that doubles have 8-byte alignment.  This is the default.
23325 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
23326 alignment only if they are contained in another type, or if they have an
23327 absolute address.  Otherwise, it assumes they have 4-byte alignment.
23328 Specifying this option avoids some rare compatibility problems with code
23329 generated by other compilers.  It is not the default because it results
23330 in a performance loss, especially for floating-point code.
23332 @item -muser-mode
23333 @itemx -mno-user-mode
23334 @opindex muser-mode
23335 @opindex mno-user-mode
23336 Do not generate code that can only run in supervisor mode.  This is relevant
23337 only for the @code{casa} instruction emitted for the LEON3 processor.  This
23338 is the default.
23340 @item -mfaster-structs
23341 @itemx -mno-faster-structs
23342 @opindex mfaster-structs
23343 @opindex mno-faster-structs
23344 With @option{-mfaster-structs}, the compiler assumes that structures
23345 should have 8-byte alignment.  This enables the use of pairs of
23346 @code{ldd} and @code{std} instructions for copies in structure
23347 assignment, in place of twice as many @code{ld} and @code{st} pairs.
23348 However, the use of this changed alignment directly violates the SPARC
23349 ABI@.  Thus, it's intended only for use on targets where the developer
23350 acknowledges that their resulting code is not directly in line with
23351 the rules of the ABI@.
23353 @item -mstd-struct-return
23354 @itemx -mno-std-struct-return
23355 @opindex mstd-struct-return
23356 @opindex mno-std-struct-return
23357 With @option{-mstd-struct-return}, the compiler generates checking code
23358 in functions returning structures or unions to detect size mismatches
23359 between the two sides of function calls, as per the 32-bit ABI@.
23361 The default is @option{-mno-std-struct-return}.  This option has no effect
23362 in 64-bit mode.
23364 @item -mlra
23365 @itemx -mno-lra
23366 @opindex mlra
23367 @opindex mno-lra
23368 Enable Local Register Allocation.  This is the default for SPARC since GCC 7
23369 so @option{-mno-lra} needs to be passed to get old Reload.
23371 @item -mcpu=@var{cpu_type}
23372 @opindex mcpu
23373 Set the instruction set, register set, and instruction scheduling parameters
23374 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
23375 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
23376 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
23377 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
23378 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
23379 @samp{niagara3}, @samp{niagara4} and @samp{niagara7}.
23381 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
23382 which selects the best architecture option for the host processor.
23383 @option{-mcpu=native} has no effect if GCC does not recognize
23384 the processor.
23386 Default instruction scheduling parameters are used for values that select
23387 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
23388 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
23390 Here is a list of each supported architecture and their supported
23391 implementations.
23393 @table @asis
23394 @item v7
23395 cypress, leon3v7
23397 @item v8
23398 supersparc, hypersparc, leon, leon3
23400 @item sparclite
23401 f930, f934, sparclite86x
23403 @item sparclet
23404 tsc701
23406 @item v9
23407 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4, niagara7
23408 @end table
23410 By default (unless configured otherwise), GCC generates code for the V7
23411 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
23412 additionally optimizes it for the Cypress CY7C602 chip, as used in the
23413 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
23414 SPARCStation 1, 2, IPX etc.
23416 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
23417 architecture.  The only difference from V7 code is that the compiler emits
23418 the integer multiply and integer divide instructions which exist in SPARC-V8
23419 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
23420 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
23421 2000 series.
23423 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
23424 the SPARC architecture.  This adds the integer multiply, integer divide step
23425 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
23426 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
23427 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
23428 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
23429 MB86934 chip, which is the more recent SPARClite with FPU@.
23431 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
23432 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
23433 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
23434 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
23435 optimizes it for the TEMIC SPARClet chip.
23437 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
23438 architecture.  This adds 64-bit integer and floating-point move instructions,
23439 3 additional floating-point condition code registers and conditional move
23440 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
23441 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
23442 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
23443 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
23444 @option{-mcpu=niagara}, the compiler additionally optimizes it for
23445 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
23446 additionally optimizes it for Sun UltraSPARC T2 chips. With
23447 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
23448 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
23449 additionally optimizes it for Sun UltraSPARC T4 chips.  With
23450 @option{-mcpu=niagara7}, the compiler additionally optimizes it for
23451 Oracle SPARC M7 chips.
23453 @item -mtune=@var{cpu_type}
23454 @opindex mtune
23455 Set the instruction scheduling parameters for machine type
23456 @var{cpu_type}, but do not set the instruction set or register set that the
23457 option @option{-mcpu=@var{cpu_type}} does.
23459 The same values for @option{-mcpu=@var{cpu_type}} can be used for
23460 @option{-mtune=@var{cpu_type}}, but the only useful values are those
23461 that select a particular CPU implementation.  Those are
23462 @samp{cypress}, @samp{supersparc}, @samp{hypersparc}, @samp{leon},
23463 @samp{leon3}, @samp{leon3v7}, @samp{f930}, @samp{f934},
23464 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
23465 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3},
23466 @samp{niagara4} and @samp{niagara7}.  With native Solaris and
23467 GNU/Linux toolchains, @samp{native} can also be used.
23469 @item -mv8plus
23470 @itemx -mno-v8plus
23471 @opindex mv8plus
23472 @opindex mno-v8plus
23473 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
23474 difference from the V8 ABI is that the global and out registers are
23475 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
23476 mode for all SPARC-V9 processors.
23478 @item -mvis
23479 @itemx -mno-vis
23480 @opindex mvis
23481 @opindex mno-vis
23482 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
23483 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
23485 @item -mvis2
23486 @itemx -mno-vis2
23487 @opindex mvis2
23488 @opindex mno-vis2
23489 With @option{-mvis2}, GCC generates code that takes advantage of
23490 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
23491 default is @option{-mvis2} when targeting a cpu that supports such
23492 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
23493 also sets @option{-mvis}.
23495 @item -mvis3
23496 @itemx -mno-vis3
23497 @opindex mvis3
23498 @opindex mno-vis3
23499 With @option{-mvis3}, GCC generates code that takes advantage of
23500 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
23501 default is @option{-mvis3} when targeting a cpu that supports such
23502 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
23503 also sets @option{-mvis2} and @option{-mvis}.
23505 @item -mvis4
23506 @itemx -mno-vis4
23507 @opindex mvis4
23508 @opindex mno-vis4
23509 With @option{-mvis4}, GCC generates code that takes advantage of
23510 version 4.0 of the UltraSPARC Visual Instruction Set extensions.  The
23511 default is @option{-mvis4} when targeting a cpu that supports such
23512 instructions, such as niagara-7 and later.  Setting @option{-mvis4}
23513 also sets @option{-mvis3}, @option{-mvis2} and @option{-mvis}.
23515 @item -mcbcond
23516 @itemx -mno-cbcond
23517 @opindex mcbcond
23518 @opindex mno-cbcond
23519 With @option{-mcbcond}, GCC generates code that takes advantage of the UltraSPARC
23520 Compare-and-Branch-on-Condition instructions.  The default is @option{-mcbcond}
23521 when targeting a CPU that supports such instructions, such as Niagara-4 and
23522 later.
23524 @item -mfmaf
23525 @itemx -mno-fmaf
23526 @opindex mfmaf
23527 @opindex mno-fmaf
23528 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
23529 Fused Multiply-Add Floating-point instructions.  The default is @option{-mfmaf}
23530 when targeting a CPU that supports such instructions, such as Niagara-3 and
23531 later.
23533 @item -mpopc
23534 @itemx -mno-popc
23535 @opindex mpopc
23536 @opindex mno-popc
23537 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
23538 Population Count instruction.  The default is @option{-mpopc}
23539 when targeting a CPU that supports such an instruction, such as Niagara-2 and
23540 later.
23542 @item -msubxc
23543 @itemx -mno-subxc
23544 @opindex msubxc
23545 @opindex mno-subxc
23546 With @option{-msubxc}, GCC generates code that takes advantage of the UltraSPARC
23547 Subtract-Extended-with-Carry instruction.  The default is @option{-msubxc}
23548 when targeting a CPU that supports such an instruction, such as Niagara-7 and
23549 later.
23551 @item -mfix-at697f
23552 @opindex mfix-at697f
23553 Enable the documented workaround for the single erratum of the Atmel AT697F
23554 processor (which corresponds to erratum #13 of the AT697E processor).
23556 @item -mfix-ut699
23557 @opindex mfix-ut699
23558 Enable the documented workarounds for the floating-point errata and the data
23559 cache nullify errata of the UT699 processor.
23560 @end table
23562 These @samp{-m} options are supported in addition to the above
23563 on SPARC-V9 processors in 64-bit environments:
23565 @table @gcctabopt
23566 @item -m32
23567 @itemx -m64
23568 @opindex m32
23569 @opindex m64
23570 Generate code for a 32-bit or 64-bit environment.
23571 The 32-bit environment sets int, long and pointer to 32 bits.
23572 The 64-bit environment sets int to 32 bits and long and pointer
23573 to 64 bits.
23575 @item -mcmodel=@var{which}
23576 @opindex mcmodel
23577 Set the code model to one of
23579 @table @samp
23580 @item medlow
23581 The Medium/Low code model: 64-bit addresses, programs
23582 must be linked in the low 32 bits of memory.  Programs can be statically
23583 or dynamically linked.
23585 @item medmid
23586 The Medium/Middle code model: 64-bit addresses, programs
23587 must be linked in the low 44 bits of memory, the text and data segments must
23588 be less than 2GB in size and the data segment must be located within 2GB of
23589 the text segment.
23591 @item medany
23592 The Medium/Anywhere code model: 64-bit addresses, programs
23593 may be linked anywhere in memory, the text and data segments must be less
23594 than 2GB in size and the data segment must be located within 2GB of the
23595 text segment.
23597 @item embmedany
23598 The Medium/Anywhere code model for embedded systems:
23599 64-bit addresses, the text and data segments must be less than 2GB in
23600 size, both starting anywhere in memory (determined at link time).  The
23601 global register %g4 points to the base of the data segment.  Programs
23602 are statically linked and PIC is not supported.
23603 @end table
23605 @item -mmemory-model=@var{mem-model}
23606 @opindex mmemory-model
23607 Set the memory model in force on the processor to one of
23609 @table @samp
23610 @item default
23611 The default memory model for the processor and operating system.
23613 @item rmo
23614 Relaxed Memory Order
23616 @item pso
23617 Partial Store Order
23619 @item tso
23620 Total Store Order
23622 @item sc
23623 Sequential Consistency
23624 @end table
23626 These memory models are formally defined in Appendix D of the SPARC-V9
23627 architecture manual, as set in the processor's @code{PSTATE.MM} field.
23629 @item -mstack-bias
23630 @itemx -mno-stack-bias
23631 @opindex mstack-bias
23632 @opindex mno-stack-bias
23633 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
23634 frame pointer if present, are offset by @minus{}2047 which must be added back
23635 when making stack frame references.  This is the default in 64-bit mode.
23636 Otherwise, assume no such offset is present.
23637 @end table
23639 @node SPU Options
23640 @subsection SPU Options
23641 @cindex SPU options
23643 These @samp{-m} options are supported on the SPU:
23645 @table @gcctabopt
23646 @item -mwarn-reloc
23647 @itemx -merror-reloc
23648 @opindex mwarn-reloc
23649 @opindex merror-reloc
23651 The loader for SPU does not handle dynamic relocations.  By default, GCC
23652 gives an error when it generates code that requires a dynamic
23653 relocation.  @option{-mno-error-reloc} disables the error,
23654 @option{-mwarn-reloc} generates a warning instead.
23656 @item -msafe-dma
23657 @itemx -munsafe-dma
23658 @opindex msafe-dma
23659 @opindex munsafe-dma
23661 Instructions that initiate or test completion of DMA must not be
23662 reordered with respect to loads and stores of the memory that is being
23663 accessed.
23664 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
23665 memory accesses, but that can lead to inefficient code in places where the
23666 memory is known to not change.  Rather than mark the memory as volatile,
23667 you can use @option{-msafe-dma} to tell the compiler to treat
23668 the DMA instructions as potentially affecting all memory.  
23670 @item -mbranch-hints
23671 @opindex mbranch-hints
23673 By default, GCC generates a branch hint instruction to avoid
23674 pipeline stalls for always-taken or probably-taken branches.  A hint
23675 is not generated closer than 8 instructions away from its branch.
23676 There is little reason to disable them, except for debugging purposes,
23677 or to make an object a little bit smaller.
23679 @item -msmall-mem
23680 @itemx -mlarge-mem
23681 @opindex msmall-mem
23682 @opindex mlarge-mem
23684 By default, GCC generates code assuming that addresses are never larger
23685 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
23686 a full 32-bit address.
23688 @item -mstdmain
23689 @opindex mstdmain
23691 By default, GCC links against startup code that assumes the SPU-style
23692 main function interface (which has an unconventional parameter list).
23693 With @option{-mstdmain}, GCC links your program against startup
23694 code that assumes a C99-style interface to @code{main}, including a
23695 local copy of @code{argv} strings.
23697 @item -mfixed-range=@var{register-range}
23698 @opindex mfixed-range
23699 Generate code treating the given register range as fixed registers.
23700 A fixed register is one that the register allocator cannot use.  This is
23701 useful when compiling kernel code.  A register range is specified as
23702 two registers separated by a dash.  Multiple register ranges can be
23703 specified separated by a comma.
23705 @item -mea32
23706 @itemx -mea64
23707 @opindex mea32
23708 @opindex mea64
23709 Compile code assuming that pointers to the PPU address space accessed
23710 via the @code{__ea} named address space qualifier are either 32 or 64
23711 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
23712 all object code in an executable must be compiled with the same setting.
23714 @item -maddress-space-conversion
23715 @itemx -mno-address-space-conversion
23716 @opindex maddress-space-conversion
23717 @opindex mno-address-space-conversion
23718 Allow/disallow treating the @code{__ea} address space as superset
23719 of the generic address space.  This enables explicit type casts
23720 between @code{__ea} and generic pointer as well as implicit
23721 conversions of generic pointers to @code{__ea} pointers.  The
23722 default is to allow address space pointer conversions.
23724 @item -mcache-size=@var{cache-size}
23725 @opindex mcache-size
23726 This option controls the version of libgcc that the compiler links to an
23727 executable and selects a software-managed cache for accessing variables
23728 in the @code{__ea} address space with a particular cache size.  Possible
23729 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
23730 and @samp{128}.  The default cache size is 64KB.
23732 @item -matomic-updates
23733 @itemx -mno-atomic-updates
23734 @opindex matomic-updates
23735 @opindex mno-atomic-updates
23736 This option controls the version of libgcc that the compiler links to an
23737 executable and selects whether atomic updates to the software-managed
23738 cache of PPU-side variables are used.  If you use atomic updates, changes
23739 to a PPU variable from SPU code using the @code{__ea} named address space
23740 qualifier do not interfere with changes to other PPU variables residing
23741 in the same cache line from PPU code.  If you do not use atomic updates,
23742 such interference may occur; however, writing back cache lines is
23743 more efficient.  The default behavior is to use atomic updates.
23745 @item -mdual-nops
23746 @itemx -mdual-nops=@var{n}
23747 @opindex mdual-nops
23748 By default, GCC inserts NOPs to increase dual issue when it expects
23749 it to increase performance.  @var{n} can be a value from 0 to 10.  A
23750 smaller @var{n} inserts fewer NOPs.  10 is the default, 0 is the
23751 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
23753 @item -mhint-max-nops=@var{n}
23754 @opindex mhint-max-nops
23755 Maximum number of NOPs to insert for a branch hint.  A branch hint must
23756 be at least 8 instructions away from the branch it is affecting.  GCC
23757 inserts up to @var{n} NOPs to enforce this, otherwise it does not
23758 generate the branch hint.
23760 @item -mhint-max-distance=@var{n}
23761 @opindex mhint-max-distance
23762 The encoding of the branch hint instruction limits the hint to be within
23763 256 instructions of the branch it is affecting.  By default, GCC makes
23764 sure it is within 125.
23766 @item -msafe-hints
23767 @opindex msafe-hints
23768 Work around a hardware bug that causes the SPU to stall indefinitely.
23769 By default, GCC inserts the @code{hbrp} instruction to make sure
23770 this stall won't happen.
23772 @end table
23774 @node System V Options
23775 @subsection Options for System V
23777 These additional options are available on System V Release 4 for
23778 compatibility with other compilers on those systems:
23780 @table @gcctabopt
23781 @item -G
23782 @opindex G
23783 Create a shared object.
23784 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
23786 @item -Qy
23787 @opindex Qy
23788 Identify the versions of each tool used by the compiler, in a
23789 @code{.ident} assembler directive in the output.
23791 @item -Qn
23792 @opindex Qn
23793 Refrain from adding @code{.ident} directives to the output file (this is
23794 the default).
23796 @item -YP,@var{dirs}
23797 @opindex YP
23798 Search the directories @var{dirs}, and no others, for libraries
23799 specified with @option{-l}.
23801 @item -Ym,@var{dir}
23802 @opindex Ym
23803 Look in the directory @var{dir} to find the M4 preprocessor.
23804 The assembler uses this option.
23805 @c This is supposed to go with a -Yd for predefined M4 macro files, but
23806 @c the generic assembler that comes with Solaris takes just -Ym.
23807 @end table
23809 @node TILE-Gx Options
23810 @subsection TILE-Gx Options
23811 @cindex TILE-Gx options
23813 These @samp{-m} options are supported on the TILE-Gx:
23815 @table @gcctabopt
23816 @item -mcmodel=small
23817 @opindex mcmodel=small
23818 Generate code for the small model.  The distance for direct calls is
23819 limited to 500M in either direction.  PC-relative addresses are 32
23820 bits.  Absolute addresses support the full address range.
23822 @item -mcmodel=large
23823 @opindex mcmodel=large
23824 Generate code for the large model.  There is no limitation on call
23825 distance, pc-relative addresses, or absolute addresses.
23827 @item -mcpu=@var{name}
23828 @opindex mcpu
23829 Selects the type of CPU to be targeted.  Currently the only supported
23830 type is @samp{tilegx}.
23832 @item -m32
23833 @itemx -m64
23834 @opindex m32
23835 @opindex m64
23836 Generate code for a 32-bit or 64-bit environment.  The 32-bit
23837 environment sets int, long, and pointer to 32 bits.  The 64-bit
23838 environment sets int to 32 bits and long and pointer to 64 bits.
23840 @item -mbig-endian
23841 @itemx -mlittle-endian
23842 @opindex mbig-endian
23843 @opindex mlittle-endian
23844 Generate code in big/little endian mode, respectively.
23845 @end table
23847 @node TILEPro Options
23848 @subsection TILEPro Options
23849 @cindex TILEPro options
23851 These @samp{-m} options are supported on the TILEPro:
23853 @table @gcctabopt
23854 @item -mcpu=@var{name}
23855 @opindex mcpu
23856 Selects the type of CPU to be targeted.  Currently the only supported
23857 type is @samp{tilepro}.
23859 @item -m32
23860 @opindex m32
23861 Generate code for a 32-bit environment, which sets int, long, and
23862 pointer to 32 bits.  This is the only supported behavior so the flag
23863 is essentially ignored.
23864 @end table
23866 @node V850 Options
23867 @subsection V850 Options
23868 @cindex V850 Options
23870 These @samp{-m} options are defined for V850 implementations:
23872 @table @gcctabopt
23873 @item -mlong-calls
23874 @itemx -mno-long-calls
23875 @opindex mlong-calls
23876 @opindex mno-long-calls
23877 Treat all calls as being far away (near).  If calls are assumed to be
23878 far away, the compiler always loads the function's address into a
23879 register, and calls indirect through the pointer.
23881 @item -mno-ep
23882 @itemx -mep
23883 @opindex mno-ep
23884 @opindex mep
23885 Do not optimize (do optimize) basic blocks that use the same index
23886 pointer 4 or more times to copy pointer into the @code{ep} register, and
23887 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
23888 option is on by default if you optimize.
23890 @item -mno-prolog-function
23891 @itemx -mprolog-function
23892 @opindex mno-prolog-function
23893 @opindex mprolog-function
23894 Do not use (do use) external functions to save and restore registers
23895 at the prologue and epilogue of a function.  The external functions
23896 are slower, but use less code space if more than one function saves
23897 the same number of registers.  The @option{-mprolog-function} option
23898 is on by default if you optimize.
23900 @item -mspace
23901 @opindex mspace
23902 Try to make the code as small as possible.  At present, this just turns
23903 on the @option{-mep} and @option{-mprolog-function} options.
23905 @item -mtda=@var{n}
23906 @opindex mtda
23907 Put static or global variables whose size is @var{n} bytes or less into
23908 the tiny data area that register @code{ep} points to.  The tiny data
23909 area can hold up to 256 bytes in total (128 bytes for byte references).
23911 @item -msda=@var{n}
23912 @opindex msda
23913 Put static or global variables whose size is @var{n} bytes or less into
23914 the small data area that register @code{gp} points to.  The small data
23915 area can hold up to 64 kilobytes.
23917 @item -mzda=@var{n}
23918 @opindex mzda
23919 Put static or global variables whose size is @var{n} bytes or less into
23920 the first 32 kilobytes of memory.
23922 @item -mv850
23923 @opindex mv850
23924 Specify that the target processor is the V850.
23926 @item -mv850e3v5
23927 @opindex mv850e3v5
23928 Specify that the target processor is the V850E3V5.  The preprocessor
23929 constant @code{__v850e3v5__} is defined if this option is used.
23931 @item -mv850e2v4
23932 @opindex mv850e2v4
23933 Specify that the target processor is the V850E3V5.  This is an alias for
23934 the @option{-mv850e3v5} option.
23936 @item -mv850e2v3
23937 @opindex mv850e2v3
23938 Specify that the target processor is the V850E2V3.  The preprocessor
23939 constant @code{__v850e2v3__} is defined if this option is used.
23941 @item -mv850e2
23942 @opindex mv850e2
23943 Specify that the target processor is the V850E2.  The preprocessor
23944 constant @code{__v850e2__} is defined if this option is used.
23946 @item -mv850e1
23947 @opindex mv850e1
23948 Specify that the target processor is the V850E1.  The preprocessor
23949 constants @code{__v850e1__} and @code{__v850e__} are defined if
23950 this option is used.
23952 @item -mv850es
23953 @opindex mv850es
23954 Specify that the target processor is the V850ES.  This is an alias for
23955 the @option{-mv850e1} option.
23957 @item -mv850e
23958 @opindex mv850e
23959 Specify that the target processor is the V850E@.  The preprocessor
23960 constant @code{__v850e__} is defined if this option is used.
23962 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
23963 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
23964 are defined then a default target processor is chosen and the
23965 relevant @samp{__v850*__} preprocessor constant is defined.
23967 The preprocessor constants @code{__v850} and @code{__v851__} are always
23968 defined, regardless of which processor variant is the target.
23970 @item -mdisable-callt
23971 @itemx -mno-disable-callt
23972 @opindex mdisable-callt
23973 @opindex mno-disable-callt
23974 This option suppresses generation of the @code{CALLT} instruction for the
23975 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
23976 architecture.
23978 This option is enabled by default when the RH850 ABI is
23979 in use (see @option{-mrh850-abi}), and disabled by default when the
23980 GCC ABI is in use.  If @code{CALLT} instructions are being generated
23981 then the C preprocessor symbol @code{__V850_CALLT__} is defined.
23983 @item -mrelax
23984 @itemx -mno-relax
23985 @opindex mrelax
23986 @opindex mno-relax
23987 Pass on (or do not pass on) the @option{-mrelax} command-line option
23988 to the assembler.
23990 @item -mlong-jumps
23991 @itemx -mno-long-jumps
23992 @opindex mlong-jumps
23993 @opindex mno-long-jumps
23994 Disable (or re-enable) the generation of PC-relative jump instructions.
23996 @item -msoft-float
23997 @itemx -mhard-float
23998 @opindex msoft-float
23999 @opindex mhard-float
24000 Disable (or re-enable) the generation of hardware floating point
24001 instructions.  This option is only significant when the target
24002 architecture is @samp{V850E2V3} or higher.  If hardware floating point
24003 instructions are being generated then the C preprocessor symbol
24004 @code{__FPU_OK__} is defined, otherwise the symbol
24005 @code{__NO_FPU__} is defined.
24007 @item -mloop
24008 @opindex mloop
24009 Enables the use of the e3v5 LOOP instruction.  The use of this
24010 instruction is not enabled by default when the e3v5 architecture is
24011 selected because its use is still experimental.
24013 @item -mrh850-abi
24014 @itemx -mghs
24015 @opindex mrh850-abi
24016 @opindex mghs
24017 Enables support for the RH850 version of the V850 ABI.  This is the
24018 default.  With this version of the ABI the following rules apply:
24020 @itemize
24021 @item
24022 Integer sized structures and unions are returned via a memory pointer
24023 rather than a register.
24025 @item
24026 Large structures and unions (more than 8 bytes in size) are passed by
24027 value.
24029 @item
24030 Functions are aligned to 16-bit boundaries.
24032 @item
24033 The @option{-m8byte-align} command-line option is supported.
24035 @item
24036 The @option{-mdisable-callt} command-line option is enabled by
24037 default.  The @option{-mno-disable-callt} command-line option is not
24038 supported.
24039 @end itemize
24041 When this version of the ABI is enabled the C preprocessor symbol
24042 @code{__V850_RH850_ABI__} is defined.
24044 @item -mgcc-abi
24045 @opindex mgcc-abi
24046 Enables support for the old GCC version of the V850 ABI.  With this
24047 version of the ABI the following rules apply:
24049 @itemize
24050 @item
24051 Integer sized structures and unions are returned in register @code{r10}.
24053 @item
24054 Large structures and unions (more than 8 bytes in size) are passed by
24055 reference.
24057 @item
24058 Functions are aligned to 32-bit boundaries, unless optimizing for
24059 size.
24061 @item
24062 The @option{-m8byte-align} command-line option is not supported.
24064 @item
24065 The @option{-mdisable-callt} command-line option is supported but not
24066 enabled by default.
24067 @end itemize
24069 When this version of the ABI is enabled the C preprocessor symbol
24070 @code{__V850_GCC_ABI__} is defined.
24072 @item -m8byte-align
24073 @itemx -mno-8byte-align
24074 @opindex m8byte-align
24075 @opindex mno-8byte-align
24076 Enables support for @code{double} and @code{long long} types to be
24077 aligned on 8-byte boundaries.  The default is to restrict the
24078 alignment of all objects to at most 4-bytes.  When
24079 @option{-m8byte-align} is in effect the C preprocessor symbol
24080 @code{__V850_8BYTE_ALIGN__} is defined.
24082 @item -mbig-switch
24083 @opindex mbig-switch
24084 Generate code suitable for big switch tables.  Use this option only if
24085 the assembler/linker complain about out of range branches within a switch
24086 table.
24088 @item -mapp-regs
24089 @opindex mapp-regs
24090 This option causes r2 and r5 to be used in the code generated by
24091 the compiler.  This setting is the default.
24093 @item -mno-app-regs
24094 @opindex mno-app-regs
24095 This option causes r2 and r5 to be treated as fixed registers.
24097 @end table
24099 @node VAX Options
24100 @subsection VAX Options
24101 @cindex VAX options
24103 These @samp{-m} options are defined for the VAX:
24105 @table @gcctabopt
24106 @item -munix
24107 @opindex munix
24108 Do not output certain jump instructions (@code{aobleq} and so on)
24109 that the Unix assembler for the VAX cannot handle across long
24110 ranges.
24112 @item -mgnu
24113 @opindex mgnu
24114 Do output those jump instructions, on the assumption that the
24115 GNU assembler is being used.
24117 @item -mg
24118 @opindex mg
24119 Output code for G-format floating-point numbers instead of D-format.
24120 @end table
24122 @node Visium Options
24123 @subsection Visium Options
24124 @cindex Visium options
24126 @table @gcctabopt
24128 @item -mdebug
24129 @opindex mdebug
24130 A program which performs file I/O and is destined to run on an MCM target
24131 should be linked with this option.  It causes the libraries libc.a and
24132 libdebug.a to be linked.  The program should be run on the target under
24133 the control of the GDB remote debugging stub.
24135 @item -msim
24136 @opindex msim
24137 A program which performs file I/O and is destined to run on the simulator
24138 should be linked with option.  This causes libraries libc.a and libsim.a to
24139 be linked.
24141 @item -mfpu
24142 @itemx -mhard-float
24143 @opindex mfpu
24144 @opindex mhard-float
24145 Generate code containing floating-point instructions.  This is the
24146 default.
24148 @item -mno-fpu
24149 @itemx -msoft-float
24150 @opindex mno-fpu
24151 @opindex msoft-float
24152 Generate code containing library calls for floating-point.
24154 @option{-msoft-float} changes the calling convention in the output file;
24155 therefore, it is only useful if you compile @emph{all} of a program with
24156 this option.  In particular, you need to compile @file{libgcc.a}, the
24157 library that comes with GCC, with @option{-msoft-float} in order for
24158 this to work.
24160 @item -mcpu=@var{cpu_type}
24161 @opindex mcpu
24162 Set the instruction set, register set, and instruction scheduling parameters
24163 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
24164 @samp{mcm}, @samp{gr5} and @samp{gr6}.
24166 @samp{mcm} is a synonym of @samp{gr5} present for backward compatibility.
24168 By default (unless configured otherwise), GCC generates code for the GR5
24169 variant of the Visium architecture.  
24171 With @option{-mcpu=gr6}, GCC generates code for the GR6 variant of the Visium
24172 architecture.  The only difference from GR5 code is that the compiler will
24173 generate block move instructions.
24175 @item -mtune=@var{cpu_type}
24176 @opindex mtune
24177 Set the instruction scheduling parameters for machine type @var{cpu_type},
24178 but do not set the instruction set or register set that the option
24179 @option{-mcpu=@var{cpu_type}} would.
24181 @item -msv-mode
24182 @opindex msv-mode
24183 Generate code for the supervisor mode, where there are no restrictions on
24184 the access to general registers.  This is the default.
24186 @item -muser-mode
24187 @opindex muser-mode
24188 Generate code for the user mode, where the access to some general registers
24189 is forbidden: on the GR5, registers r24 to r31 cannot be accessed in this
24190 mode; on the GR6, only registers r29 to r31 are affected.
24191 @end table
24193 @node VMS Options
24194 @subsection VMS Options
24196 These @samp{-m} options are defined for the VMS implementations:
24198 @table @gcctabopt
24199 @item -mvms-return-codes
24200 @opindex mvms-return-codes
24201 Return VMS condition codes from @code{main}. The default is to return POSIX-style
24202 condition (e.g.@ error) codes.
24204 @item -mdebug-main=@var{prefix}
24205 @opindex mdebug-main=@var{prefix}
24206 Flag the first routine whose name starts with @var{prefix} as the main
24207 routine for the debugger.
24209 @item -mmalloc64
24210 @opindex mmalloc64
24211 Default to 64-bit memory allocation routines.
24213 @item -mpointer-size=@var{size}
24214 @opindex mpointer-size=@var{size}
24215 Set the default size of pointers. Possible options for @var{size} are
24216 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
24217 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
24218 The later option disables @code{pragma pointer_size}.
24219 @end table
24221 @node VxWorks Options
24222 @subsection VxWorks Options
24223 @cindex VxWorks Options
24225 The options in this section are defined for all VxWorks targets.
24226 Options specific to the target hardware are listed with the other
24227 options for that target.
24229 @table @gcctabopt
24230 @item -mrtp
24231 @opindex mrtp
24232 GCC can generate code for both VxWorks kernels and real time processes
24233 (RTPs).  This option switches from the former to the latter.  It also
24234 defines the preprocessor macro @code{__RTP__}.
24236 @item -non-static
24237 @opindex non-static
24238 Link an RTP executable against shared libraries rather than static
24239 libraries.  The options @option{-static} and @option{-shared} can
24240 also be used for RTPs (@pxref{Link Options}); @option{-static}
24241 is the default.
24243 @item -Bstatic
24244 @itemx -Bdynamic
24245 @opindex Bstatic
24246 @opindex Bdynamic
24247 These options are passed down to the linker.  They are defined for
24248 compatibility with Diab.
24250 @item -Xbind-lazy
24251 @opindex Xbind-lazy
24252 Enable lazy binding of function calls.  This option is equivalent to
24253 @option{-Wl,-z,now} and is defined for compatibility with Diab.
24255 @item -Xbind-now
24256 @opindex Xbind-now
24257 Disable lazy binding of function calls.  This option is the default and
24258 is defined for compatibility with Diab.
24259 @end table
24261 @node x86 Options
24262 @subsection x86 Options
24263 @cindex x86 Options
24265 These @samp{-m} options are defined for the x86 family of computers.
24267 @table @gcctabopt
24269 @item -march=@var{cpu-type}
24270 @opindex march
24271 Generate instructions for the machine type @var{cpu-type}.  In contrast to
24272 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
24273 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
24274 to generate code that may not run at all on processors other than the one
24275 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
24276 @option{-mtune=@var{cpu-type}}.
24278 The choices for @var{cpu-type} are:
24280 @table @samp
24281 @item native
24282 This selects the CPU to generate code for at compilation time by determining
24283 the processor type of the compiling machine.  Using @option{-march=native}
24284 enables all instruction subsets supported by the local machine (hence
24285 the result might not run on different machines).  Using @option{-mtune=native}
24286 produces code optimized for the local machine under the constraints
24287 of the selected instruction set.  
24289 @item i386
24290 Original Intel i386 CPU@.
24292 @item i486
24293 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
24295 @item i586
24296 @itemx pentium
24297 Intel Pentium CPU with no MMX support.
24299 @item lakemont
24300 Intel Lakemont MCU, based on Intel Pentium CPU.
24302 @item pentium-mmx
24303 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
24305 @item pentiumpro
24306 Intel Pentium Pro CPU@.
24308 @item i686
24309 When used with @option{-march}, the Pentium Pro
24310 instruction set is used, so the code runs on all i686 family chips.
24311 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
24313 @item pentium2
24314 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
24315 support.
24317 @item pentium3
24318 @itemx pentium3m
24319 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
24320 set support.
24322 @item pentium-m
24323 Intel Pentium M; low-power version of Intel Pentium III CPU
24324 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
24326 @item pentium4
24327 @itemx pentium4m
24328 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
24330 @item prescott
24331 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
24332 set support.
24334 @item nocona
24335 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
24336 SSE2 and SSE3 instruction set support.
24338 @item core2
24339 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
24340 instruction set support.
24342 @item nehalem
24343 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
24344 SSE4.1, SSE4.2 and POPCNT instruction set support.
24346 @item westmere
24347 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
24348 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
24350 @item sandybridge
24351 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
24352 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
24354 @item ivybridge
24355 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
24356 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
24357 instruction set support.
24359 @item haswell
24360 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
24361 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24362 BMI, BMI2 and F16C instruction set support.
24364 @item broadwell
24365 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
24366 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24367 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
24369 @item skylake
24370 Intel Skylake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
24371 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24372 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC and
24373 XSAVES instruction set support.
24375 @item bonnell
24376 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
24377 instruction set support.
24379 @item silvermont
24380 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
24381 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
24383 @item knl
24384 Intel Knight's Landing CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
24385 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24386 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER and
24387 AVX512CD instruction set support.
24389 @item skylake-avx512
24390 Intel Skylake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
24391 SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24392 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F,
24393 AVX512VL, AVX512BW, AVX512DQ and AVX512CD instruction set support.
24395 @item k6
24396 AMD K6 CPU with MMX instruction set support.
24398 @item k6-2
24399 @itemx k6-3
24400 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
24402 @item athlon
24403 @itemx athlon-tbird
24404 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
24405 support.
24407 @item athlon-4
24408 @itemx athlon-xp
24409 @itemx athlon-mp
24410 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
24411 instruction set support.
24413 @item k8
24414 @itemx opteron
24415 @itemx athlon64
24416 @itemx athlon-fx
24417 Processors based on the AMD K8 core with x86-64 instruction set support,
24418 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
24419 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
24420 instruction set extensions.)
24422 @item k8-sse3
24423 @itemx opteron-sse3
24424 @itemx athlon64-sse3
24425 Improved versions of AMD K8 cores with SSE3 instruction set support.
24427 @item amdfam10
24428 @itemx barcelona
24429 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
24430 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
24431 instruction set extensions.)
24433 @item bdver1
24434 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
24435 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
24436 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
24437 @item bdver2
24438 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
24439 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
24440 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
24441 extensions.)
24442 @item bdver3
24443 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
24444 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
24445 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
24446 64-bit instruction set extensions.
24447 @item bdver4
24448 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
24449 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
24450 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
24451 SSE4.2, ABM and 64-bit instruction set extensions.
24453 @item znver1
24454 AMD Family 17h core based CPUs with x86-64 instruction set support.  (This
24455 supersets BMI, BMI2, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX,
24456 SHA, CLZERO, AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3,
24457 SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, and 64-bit
24458 instruction set extensions.
24460 @item btver1
24461 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
24462 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
24463 instruction set extensions.)
24465 @item btver2
24466 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
24467 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
24468 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
24470 @item winchip-c6
24471 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
24472 set support.
24474 @item winchip2
24475 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
24476 instruction set support.
24478 @item c3
24479 VIA C3 CPU with MMX and 3DNow!@: instruction set support.
24480 (No scheduling is implemented for this chip.)
24482 @item c3-2
24483 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
24484 (No scheduling is implemented for this chip.)
24486 @item c7
24487 VIA C7 (Esther) CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
24488 (No scheduling is implemented for this chip.)
24490 @item samuel-2
24491 VIA Eden Samuel 2 CPU with MMX and 3DNow!@: instruction set support.
24492 (No scheduling is implemented for this chip.)
24494 @item nehemiah
24495 VIA Eden Nehemiah CPU with MMX and SSE instruction set support.
24496 (No scheduling is implemented for this chip.)
24498 @item esther
24499 VIA Eden Esther CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
24500 (No scheduling is implemented for this chip.)
24502 @item eden-x2
24503 VIA Eden X2 CPU with x86-64, MMX, SSE, SSE2 and SSE3 instruction set support.
24504 (No scheduling is implemented for this chip.)
24506 @item eden-x4
24507 VIA Eden X4 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2,
24508 AVX and AVX2 instruction set support.
24509 (No scheduling is implemented for this chip.)
24511 @item nano
24512 Generic VIA Nano CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
24513 instruction set support.
24514 (No scheduling is implemented for this chip.)
24516 @item nano-1000
24517 VIA Nano 1xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
24518 instruction set support.
24519 (No scheduling is implemented for this chip.)
24521 @item nano-2000
24522 VIA Nano 2xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
24523 instruction set support.
24524 (No scheduling is implemented for this chip.)
24526 @item nano-3000
24527 VIA Nano 3xxx CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
24528 instruction set support.
24529 (No scheduling is implemented for this chip.)
24531 @item nano-x2
24532 VIA Nano Dual Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
24533 instruction set support.
24534 (No scheduling is implemented for this chip.)
24536 @item nano-x4
24537 VIA Nano Quad Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
24538 instruction set support.
24539 (No scheduling is implemented for this chip.)
24541 @item geode
24542 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
24543 @end table
24545 @item -mtune=@var{cpu-type}
24546 @opindex mtune
24547 Tune to @var{cpu-type} everything applicable about the generated code, except
24548 for the ABI and the set of available instructions.  
24549 While picking a specific @var{cpu-type} schedules things appropriately
24550 for that particular chip, the compiler does not generate any code that
24551 cannot run on the default machine type unless you use a
24552 @option{-march=@var{cpu-type}} option.
24553 For example, if GCC is configured for i686-pc-linux-gnu
24554 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
24555 but still runs on i686 machines.
24557 The choices for @var{cpu-type} are the same as for @option{-march}.
24558 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
24560 @table @samp
24561 @item generic
24562 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
24563 If you know the CPU on which your code will run, then you should use
24564 the corresponding @option{-mtune} or @option{-march} option instead of
24565 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
24566 of your application will have, then you should use this option.
24568 As new processors are deployed in the marketplace, the behavior of this
24569 option will change.  Therefore, if you upgrade to a newer version of
24570 GCC, code generation controlled by this option will change to reflect
24571 the processors
24572 that are most common at the time that version of GCC is released.
24574 There is no @option{-march=generic} option because @option{-march}
24575 indicates the instruction set the compiler can use, and there is no
24576 generic instruction set applicable to all processors.  In contrast,
24577 @option{-mtune} indicates the processor (or, in this case, collection of
24578 processors) for which the code is optimized.
24580 @item intel
24581 Produce code optimized for the most current Intel processors, which are
24582 Haswell and Silvermont for this version of GCC.  If you know the CPU
24583 on which your code will run, then you should use the corresponding
24584 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
24585 But, if you want your application performs better on both Haswell and
24586 Silvermont, then you should use this option.
24588 As new Intel processors are deployed in the marketplace, the behavior of
24589 this option will change.  Therefore, if you upgrade to a newer version of
24590 GCC, code generation controlled by this option will change to reflect
24591 the most current Intel processors at the time that version of GCC is
24592 released.
24594 There is no @option{-march=intel} option because @option{-march} indicates
24595 the instruction set the compiler can use, and there is no common
24596 instruction set applicable to all processors.  In contrast,
24597 @option{-mtune} indicates the processor (or, in this case, collection of
24598 processors) for which the code is optimized.
24599 @end table
24601 @item -mcpu=@var{cpu-type}
24602 @opindex mcpu
24603 A deprecated synonym for @option{-mtune}.
24605 @item -mfpmath=@var{unit}
24606 @opindex mfpmath
24607 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
24608 for @var{unit} are:
24610 @table @samp
24611 @item 387
24612 Use the standard 387 floating-point coprocessor present on the majority of chips and
24613 emulated otherwise.  Code compiled with this option runs almost everywhere.
24614 The temporary results are computed in 80-bit precision instead of the precision
24615 specified by the type, resulting in slightly different results compared to most
24616 of other chips.  See @option{-ffloat-store} for more detailed description.
24618 This is the default choice for non-Darwin x86-32 targets.
24620 @item sse
24621 Use scalar floating-point instructions present in the SSE instruction set.
24622 This instruction set is supported by Pentium III and newer chips,
24623 and in the AMD line
24624 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
24625 instruction set supports only single-precision arithmetic, thus the double and
24626 extended-precision arithmetic are still done using 387.  A later version, present
24627 only in Pentium 4 and AMD x86-64 chips, supports double-precision
24628 arithmetic too.
24630 For the x86-32 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
24631 or @option{-msse2} switches to enable SSE extensions and make this option
24632 effective.  For the x86-64 compiler, these extensions are enabled by default.
24634 The resulting code should be considerably faster in the majority of cases and avoid
24635 the numerical instability problems of 387 code, but may break some existing
24636 code that expects temporaries to be 80 bits.
24638 This is the default choice for the x86-64 compiler, Darwin x86-32 targets,
24639 and the default choice for x86-32 targets with the SSE2 instruction set
24640 when @option{-ffast-math} is enabled.
24642 @item sse,387
24643 @itemx sse+387
24644 @itemx both
24645 Attempt to utilize both instruction sets at once.  This effectively doubles the
24646 amount of available registers, and on chips with separate execution units for
24647 387 and SSE the execution resources too.  Use this option with care, as it is
24648 still experimental, because the GCC register allocator does not model separate
24649 functional units well, resulting in unstable performance.
24650 @end table
24652 @item -masm=@var{dialect}
24653 @opindex masm=@var{dialect}
24654 Output assembly instructions using selected @var{dialect}.  Also affects
24655 which dialect is used for basic @code{asm} (@pxref{Basic Asm}) and
24656 extended @code{asm} (@pxref{Extended Asm}). Supported choices (in dialect
24657 order) are @samp{att} or @samp{intel}. The default is @samp{att}. Darwin does
24658 not support @samp{intel}.
24660 @item -mieee-fp
24661 @itemx -mno-ieee-fp
24662 @opindex mieee-fp
24663 @opindex mno-ieee-fp
24664 Control whether or not the compiler uses IEEE floating-point
24665 comparisons.  These correctly handle the case where the result of a
24666 comparison is unordered.
24668 @item -m80387
24669 @item -mhard-float
24670 @opindex 80387
24671 @opindex mhard-float
24672 Generate output containing 80387 instructions for floating point.
24674 @item -mno-80387
24675 @item -msoft-float
24676 @opindex no-80387
24677 @opindex msoft-float
24678 Generate output containing library calls for floating point.
24680 @strong{Warning:} the requisite libraries are not part of GCC@.
24681 Normally the facilities of the machine's usual C compiler are used, but
24682 this can't be done directly in cross-compilation.  You must make your
24683 own arrangements to provide suitable library functions for
24684 cross-compilation.
24686 On machines where a function returns floating-point results in the 80387
24687 register stack, some floating-point opcodes may be emitted even if
24688 @option{-msoft-float} is used.
24690 @item -mno-fp-ret-in-387
24691 @opindex mno-fp-ret-in-387
24692 Do not use the FPU registers for return values of functions.
24694 The usual calling convention has functions return values of types
24695 @code{float} and @code{double} in an FPU register, even if there
24696 is no FPU@.  The idea is that the operating system should emulate
24697 an FPU@.
24699 The option @option{-mno-fp-ret-in-387} causes such values to be returned
24700 in ordinary CPU registers instead.
24702 @item -mno-fancy-math-387
24703 @opindex mno-fancy-math-387
24704 Some 387 emulators do not support the @code{sin}, @code{cos} and
24705 @code{sqrt} instructions for the 387.  Specify this option to avoid
24706 generating those instructions.  This option is the default on
24707 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
24708 indicates that the target CPU always has an FPU and so the
24709 instruction does not need emulation.  These
24710 instructions are not generated unless you also use the
24711 @option{-funsafe-math-optimizations} switch.
24713 @item -malign-double
24714 @itemx -mno-align-double
24715 @opindex malign-double
24716 @opindex mno-align-double
24717 Control whether GCC aligns @code{double}, @code{long double}, and
24718 @code{long long} variables on a two-word boundary or a one-word
24719 boundary.  Aligning @code{double} variables on a two-word boundary
24720 produces code that runs somewhat faster on a Pentium at the
24721 expense of more memory.
24723 On x86-64, @option{-malign-double} is enabled by default.
24725 @strong{Warning:} if you use the @option{-malign-double} switch,
24726 structures containing the above types are aligned differently than
24727 the published application binary interface specifications for the x86-32
24728 and are not binary compatible with structures in code compiled
24729 without that switch.
24731 @item -m96bit-long-double
24732 @itemx -m128bit-long-double
24733 @opindex m96bit-long-double
24734 @opindex m128bit-long-double
24735 These switches control the size of @code{long double} type.  The x86-32
24736 application binary interface specifies the size to be 96 bits,
24737 so @option{-m96bit-long-double} is the default in 32-bit mode.
24739 Modern architectures (Pentium and newer) prefer @code{long double}
24740 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
24741 conforming to the ABI, this is not possible.  So specifying
24742 @option{-m128bit-long-double} aligns @code{long double}
24743 to a 16-byte boundary by padding the @code{long double} with an additional
24744 32-bit zero.
24746 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
24747 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
24749 Notice that neither of these options enable any extra precision over the x87
24750 standard of 80 bits for a @code{long double}.
24752 @strong{Warning:} if you override the default value for your target ABI, this
24753 changes the size of 
24754 structures and arrays containing @code{long double} variables,
24755 as well as modifying the function calling convention for functions taking
24756 @code{long double}.  Hence they are not binary-compatible
24757 with code compiled without that switch.
24759 @item -mlong-double-64
24760 @itemx -mlong-double-80
24761 @itemx -mlong-double-128
24762 @opindex mlong-double-64
24763 @opindex mlong-double-80
24764 @opindex mlong-double-128
24765 These switches control the size of @code{long double} type. A size
24766 of 64 bits makes the @code{long double} type equivalent to the @code{double}
24767 type. This is the default for 32-bit Bionic C library.  A size
24768 of 128 bits makes the @code{long double} type equivalent to the
24769 @code{__float128} type. This is the default for 64-bit Bionic C library.
24771 @strong{Warning:} if you override the default value for your target ABI, this
24772 changes the size of
24773 structures and arrays containing @code{long double} variables,
24774 as well as modifying the function calling convention for functions taking
24775 @code{long double}.  Hence they are not binary-compatible
24776 with code compiled without that switch.
24778 @item -malign-data=@var{type}
24779 @opindex malign-data
24780 Control how GCC aligns variables.  Supported values for @var{type} are
24781 @samp{compat} uses increased alignment value compatible uses GCC 4.8
24782 and earlier, @samp{abi} uses alignment value as specified by the
24783 psABI, and @samp{cacheline} uses increased alignment value to match
24784 the cache line size.  @samp{compat} is the default.
24786 @item -mlarge-data-threshold=@var{threshold}
24787 @opindex mlarge-data-threshold
24788 When @option{-mcmodel=medium} is specified, data objects larger than
24789 @var{threshold} are placed in the large data section.  This value must be the
24790 same across all objects linked into the binary, and defaults to 65535.
24792 @item -mrtd
24793 @opindex mrtd
24794 Use a different function-calling convention, in which functions that
24795 take a fixed number of arguments return with the @code{ret @var{num}}
24796 instruction, which pops their arguments while returning.  This saves one
24797 instruction in the caller since there is no need to pop the arguments
24798 there.
24800 You can specify that an individual function is called with this calling
24801 sequence with the function attribute @code{stdcall}.  You can also
24802 override the @option{-mrtd} option by using the function attribute
24803 @code{cdecl}.  @xref{Function Attributes}.
24805 @strong{Warning:} this calling convention is incompatible with the one
24806 normally used on Unix, so you cannot use it if you need to call
24807 libraries compiled with the Unix compiler.
24809 Also, you must provide function prototypes for all functions that
24810 take variable numbers of arguments (including @code{printf});
24811 otherwise incorrect code is generated for calls to those
24812 functions.
24814 In addition, seriously incorrect code results if you call a
24815 function with too many arguments.  (Normally, extra arguments are
24816 harmlessly ignored.)
24818 @item -mregparm=@var{num}
24819 @opindex mregparm
24820 Control how many registers are used to pass integer arguments.  By
24821 default, no registers are used to pass arguments, and at most 3
24822 registers can be used.  You can control this behavior for a specific
24823 function by using the function attribute @code{regparm}.
24824 @xref{Function Attributes}.
24826 @strong{Warning:} if you use this switch, and
24827 @var{num} is nonzero, then you must build all modules with the same
24828 value, including any libraries.  This includes the system libraries and
24829 startup modules.
24831 @item -msseregparm
24832 @opindex msseregparm
24833 Use SSE register passing conventions for float and double arguments
24834 and return values.  You can control this behavior for a specific
24835 function by using the function attribute @code{sseregparm}.
24836 @xref{Function Attributes}.
24838 @strong{Warning:} if you use this switch then you must build all
24839 modules with the same value, including any libraries.  This includes
24840 the system libraries and startup modules.
24842 @item -mvect8-ret-in-mem
24843 @opindex mvect8-ret-in-mem
24844 Return 8-byte vectors in memory instead of MMX registers.  This is the
24845 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
24846 Studio compilers until version 12.  Later compiler versions (starting
24847 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
24848 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
24849 you need to remain compatible with existing code produced by those
24850 previous compiler versions or older versions of GCC@.
24852 @item -mpc32
24853 @itemx -mpc64
24854 @itemx -mpc80
24855 @opindex mpc32
24856 @opindex mpc64
24857 @opindex mpc80
24859 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
24860 is specified, the significands of results of floating-point operations are
24861 rounded to 24 bits (single precision); @option{-mpc64} rounds the
24862 significands of results of floating-point operations to 53 bits (double
24863 precision) and @option{-mpc80} rounds the significands of results of
24864 floating-point operations to 64 bits (extended double precision), which is
24865 the default.  When this option is used, floating-point operations in higher
24866 precisions are not available to the programmer without setting the FPU
24867 control word explicitly.
24869 Setting the rounding of floating-point operations to less than the default
24870 80 bits can speed some programs by 2% or more.  Note that some mathematical
24871 libraries assume that extended-precision (80-bit) floating-point operations
24872 are enabled by default; routines in such libraries could suffer significant
24873 loss of accuracy, typically through so-called ``catastrophic cancellation'',
24874 when this option is used to set the precision to less than extended precision.
24876 @item -mstackrealign
24877 @opindex mstackrealign
24878 Realign the stack at entry.  On the x86, the @option{-mstackrealign}
24879 option generates an alternate prologue and epilogue that realigns the
24880 run-time stack if necessary.  This supports mixing legacy codes that keep
24881 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
24882 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
24883 applicable to individual functions.
24885 @item -mpreferred-stack-boundary=@var{num}
24886 @opindex mpreferred-stack-boundary
24887 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
24888 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
24889 the default is 4 (16 bytes or 128 bits).
24891 @strong{Warning:} When generating code for the x86-64 architecture with
24892 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
24893 used to keep the stack boundary aligned to 8 byte boundary.  Since
24894 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
24895 intended to be used in controlled environment where stack space is
24896 important limitation.  This option leads to wrong code when functions
24897 compiled with 16 byte stack alignment (such as functions from a standard
24898 library) are called with misaligned stack.  In this case, SSE
24899 instructions may lead to misaligned memory access traps.  In addition,
24900 variable arguments are handled incorrectly for 16 byte aligned
24901 objects (including x87 long double and __int128), leading to wrong
24902 results.  You must build all modules with
24903 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
24904 includes the system libraries and startup modules.
24906 @item -mincoming-stack-boundary=@var{num}
24907 @opindex mincoming-stack-boundary
24908 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
24909 boundary.  If @option{-mincoming-stack-boundary} is not specified,
24910 the one specified by @option{-mpreferred-stack-boundary} is used.
24912 On Pentium and Pentium Pro, @code{double} and @code{long double} values
24913 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
24914 suffer significant run time performance penalties.  On Pentium III, the
24915 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
24916 properly if it is not 16-byte aligned.
24918 To ensure proper alignment of this values on the stack, the stack boundary
24919 must be as aligned as that required by any value stored on the stack.
24920 Further, every function must be generated such that it keeps the stack
24921 aligned.  Thus calling a function compiled with a higher preferred
24922 stack boundary from a function compiled with a lower preferred stack
24923 boundary most likely misaligns the stack.  It is recommended that
24924 libraries that use callbacks always use the default setting.
24926 This extra alignment does consume extra stack space, and generally
24927 increases code size.  Code that is sensitive to stack space usage, such
24928 as embedded systems and operating system kernels, may want to reduce the
24929 preferred alignment to @option{-mpreferred-stack-boundary=2}.
24931 @need 200
24932 @item -mmmx
24933 @opindex mmmx
24934 @need 200
24935 @itemx -msse
24936 @opindex msse
24937 @need 200
24938 @itemx -msse2
24939 @opindex msse2
24940 @need 200
24941 @itemx -msse3
24942 @opindex msse3
24943 @need 200
24944 @itemx -mssse3
24945 @opindex mssse3
24946 @need 200
24947 @itemx -msse4
24948 @opindex msse4
24949 @need 200
24950 @itemx -msse4a
24951 @opindex msse4a
24952 @need 200
24953 @itemx -msse4.1
24954 @opindex msse4.1
24955 @need 200
24956 @itemx -msse4.2
24957 @opindex msse4.2
24958 @need 200
24959 @itemx -mavx
24960 @opindex mavx
24961 @need 200
24962 @itemx -mavx2
24963 @opindex mavx2
24964 @need 200
24965 @itemx -mavx512f
24966 @opindex mavx512f
24967 @need 200
24968 @itemx -mavx512pf
24969 @opindex mavx512pf
24970 @need 200
24971 @itemx -mavx512er
24972 @opindex mavx512er
24973 @need 200
24974 @itemx -mavx512cd
24975 @opindex mavx512cd
24976 @need 200
24977 @itemx -mavx512vl
24978 @opindex mavx512vl
24979 @need 200
24980 @itemx -mavx512bw
24981 @opindex mavx512bw
24982 @need 200
24983 @itemx -mavx512dq
24984 @opindex mavx512dq
24985 @need 200
24986 @itemx -mavx512ifma
24987 @opindex mavx512ifma
24988 @need 200
24989 @itemx -mavx512vbmi
24990 @opindex mavx512vbmi
24991 @need 200
24992 @itemx -msha
24993 @opindex msha
24994 @need 200
24995 @itemx -maes
24996 @opindex maes
24997 @need 200
24998 @itemx -mpclmul
24999 @opindex mpclmul
25000 @need 200
25001 @itemx -mclfushopt
25002 @opindex mclfushopt
25003 @need 200
25004 @itemx -mfsgsbase
25005 @opindex mfsgsbase
25006 @need 200
25007 @itemx -mrdrnd
25008 @opindex mrdrnd
25009 @need 200
25010 @itemx -mf16c
25011 @opindex mf16c
25012 @need 200
25013 @itemx -mfma
25014 @opindex mfma
25015 @need 200
25016 @itemx -mfma4
25017 @opindex mfma4
25018 @need 200
25019 @itemx -mprefetchwt1
25020 @opindex mprefetchwt1
25021 @need 200
25022 @itemx -mxop
25023 @opindex mxop
25024 @need 200
25025 @itemx -mlwp
25026 @opindex mlwp
25027 @need 200
25028 @itemx -m3dnow
25029 @opindex m3dnow
25030 @need 200
25031 @itemx -m3dnowa
25032 @opindex m3dnowa
25033 @need 200
25034 @itemx -mpopcnt
25035 @opindex mpopcnt
25036 @need 200
25037 @itemx -mabm
25038 @opindex mabm
25039 @need 200
25040 @itemx -mbmi
25041 @opindex mbmi
25042 @need 200
25043 @itemx -mbmi2
25044 @need 200
25045 @itemx -mlzcnt
25046 @opindex mlzcnt
25047 @need 200
25048 @itemx -mfxsr
25049 @opindex mfxsr
25050 @need 200
25051 @itemx -mxsave
25052 @opindex mxsave
25053 @need 200
25054 @itemx -mxsaveopt
25055 @opindex mxsaveopt
25056 @need 200
25057 @itemx -mxsavec
25058 @opindex mxsavec
25059 @need 200
25060 @itemx -mxsaves
25061 @opindex mxsaves
25062 @need 200
25063 @itemx -mrtm
25064 @opindex mrtm
25065 @need 200
25066 @itemx -mtbm
25067 @opindex mtbm
25068 @need 200
25069 @itemx -mmpx
25070 @opindex mmpx
25071 @need 200
25072 @itemx -mmwaitx
25073 @opindex mmwaitx
25074 @need 200
25075 @itemx -mclzero
25076 @opindex mclzero
25077 @itemx -mpku
25078 @opindex mpku
25079 These switches enable the use of instructions in the MMX, SSE,
25080 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
25081 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
25082 AVX512VL, AVX512BW, AVX512DQ, AVX512IFMA AVX512VBMI, BMI, BMI2, FXSR,
25083 XSAVE, XSAVEOPT, LZCNT, RTM, MPX, MWAITX, PKU, 3DNow!@: or enhanced 3DNow!@:
25084 extended instruction sets.  Each has a corresponding @option{-mno-} option
25085 to disable use of these instructions.
25087 These extensions are also available as built-in functions: see
25088 @ref{x86 Built-in Functions}, for details of the functions enabled and
25089 disabled by these switches.
25091 To generate SSE/SSE2 instructions automatically from floating-point
25092 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
25094 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
25095 generates new AVX instructions or AVX equivalence for all SSEx instructions
25096 when needed.
25098 These options enable GCC to use these extended instructions in
25099 generated code, even without @option{-mfpmath=sse}.  Applications that
25100 perform run-time CPU detection must compile separate files for each
25101 supported architecture, using the appropriate flags.  In particular,
25102 the file containing the CPU detection code should be compiled without
25103 these options.
25105 @item -mdump-tune-features
25106 @opindex mdump-tune-features
25107 This option instructs GCC to dump the names of the x86 performance 
25108 tuning features and default settings. The names can be used in 
25109 @option{-mtune-ctrl=@var{feature-list}}.
25111 @item -mtune-ctrl=@var{feature-list}
25112 @opindex mtune-ctrl=@var{feature-list}
25113 This option is used to do fine grain control of x86 code generation features.
25114 @var{feature-list} is a comma separated list of @var{feature} names. See also
25115 @option{-mdump-tune-features}. When specified, the @var{feature} is turned
25116 on if it is not preceded with @samp{^}, otherwise, it is turned off. 
25117 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
25118 developers. Using it may lead to code paths not covered by testing and can
25119 potentially result in compiler ICEs or runtime errors.
25121 @item -mno-default
25122 @opindex mno-default
25123 This option instructs GCC to turn off all tunable features. See also 
25124 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
25126 @item -mcld
25127 @opindex mcld
25128 This option instructs GCC to emit a @code{cld} instruction in the prologue
25129 of functions that use string instructions.  String instructions depend on
25130 the DF flag to select between autoincrement or autodecrement mode.  While the
25131 ABI specifies the DF flag to be cleared on function entry, some operating
25132 systems violate this specification by not clearing the DF flag in their
25133 exception dispatchers.  The exception handler can be invoked with the DF flag
25134 set, which leads to wrong direction mode when string instructions are used.
25135 This option can be enabled by default on 32-bit x86 targets by configuring
25136 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
25137 instructions can be suppressed with the @option{-mno-cld} compiler option
25138 in this case.
25140 @item -mvzeroupper
25141 @opindex mvzeroupper
25142 This option instructs GCC to emit a @code{vzeroupper} instruction
25143 before a transfer of control flow out of the function to minimize
25144 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
25145 intrinsics.
25147 @item -mprefer-avx128
25148 @opindex mprefer-avx128
25149 This option instructs GCC to use 128-bit AVX instructions instead of
25150 256-bit AVX instructions in the auto-vectorizer.
25152 @item -mcx16
25153 @opindex mcx16
25154 This option enables GCC to generate @code{CMPXCHG16B} instructions.
25155 @code{CMPXCHG16B} allows for atomic operations on 128-bit double quadword
25156 (or oword) data types.  
25157 This is useful for high-resolution counters that can be updated
25158 by multiple processors (or cores).  This instruction is generated as part of
25159 atomic built-in functions: see @ref{__sync Builtins} or
25160 @ref{__atomic Builtins} for details.
25162 @item -msahf
25163 @opindex msahf
25164 This option enables generation of @code{SAHF} instructions in 64-bit code.
25165 Early Intel Pentium 4 CPUs with Intel 64 support,
25166 prior to the introduction of Pentium 4 G1 step in December 2005,
25167 lacked the @code{LAHF} and @code{SAHF} instructions
25168 which are supported by AMD64.
25169 These are load and store instructions, respectively, for certain status flags.
25170 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
25171 @code{drem}, and @code{remainder} built-in functions;
25172 see @ref{Other Builtins} for details.
25174 @item -mmovbe
25175 @opindex mmovbe
25176 This option enables use of the @code{movbe} instruction to implement
25177 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
25179 @item -mcrc32
25180 @opindex mcrc32
25181 This option enables built-in functions @code{__builtin_ia32_crc32qi},
25182 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
25183 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
25185 @item -mrecip
25186 @opindex mrecip
25187 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
25188 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
25189 with an additional Newton-Raphson step
25190 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
25191 (and their vectorized
25192 variants) for single-precision floating-point arguments.  These instructions
25193 are generated only when @option{-funsafe-math-optimizations} is enabled
25194 together with @option{-ffinite-math-only} and @option{-fno-trapping-math}.
25195 Note that while the throughput of the sequence is higher than the throughput
25196 of the non-reciprocal instruction, the precision of the sequence can be
25197 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
25199 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
25200 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
25201 combination), and doesn't need @option{-mrecip}.
25203 Also note that GCC emits the above sequence with additional Newton-Raphson step
25204 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
25205 already with @option{-ffast-math} (or the above option combination), and
25206 doesn't need @option{-mrecip}.
25208 @item -mrecip=@var{opt}
25209 @opindex mrecip=opt
25210 This option controls which reciprocal estimate instructions
25211 may be used.  @var{opt} is a comma-separated list of options, which may
25212 be preceded by a @samp{!} to invert the option:
25214 @table @samp
25215 @item all
25216 Enable all estimate instructions.
25218 @item default
25219 Enable the default instructions, equivalent to @option{-mrecip}.
25221 @item none
25222 Disable all estimate instructions, equivalent to @option{-mno-recip}.
25224 @item div
25225 Enable the approximation for scalar division.
25227 @item vec-div
25228 Enable the approximation for vectorized division.
25230 @item sqrt
25231 Enable the approximation for scalar square root.
25233 @item vec-sqrt
25234 Enable the approximation for vectorized square root.
25235 @end table
25237 So, for example, @option{-mrecip=all,!sqrt} enables
25238 all of the reciprocal approximations, except for square root.
25240 @item -mveclibabi=@var{type}
25241 @opindex mveclibabi
25242 Specifies the ABI type to use for vectorizing intrinsics using an
25243 external library.  Supported values for @var{type} are @samp{svml} 
25244 for the Intel short
25245 vector math library and @samp{acml} for the AMD math core library.
25246 To use this option, both @option{-ftree-vectorize} and
25247 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
25248 ABI-compatible library must be specified at link time.
25250 GCC currently emits calls to @code{vmldExp2},
25251 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
25252 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
25253 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
25254 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
25255 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
25256 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
25257 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
25258 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
25259 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
25260 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
25261 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
25262 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
25263 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
25264 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
25265 when @option{-mveclibabi=acml} is used.  
25267 @item -mabi=@var{name}
25268 @opindex mabi
25269 Generate code for the specified calling convention.  Permissible values
25270 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
25271 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
25272 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
25273 You can control this behavior for specific functions by
25274 using the function attributes @code{ms_abi} and @code{sysv_abi}.
25275 @xref{Function Attributes}.
25277 @item -mtls-dialect=@var{type}
25278 @opindex mtls-dialect
25279 Generate code to access thread-local storage using the @samp{gnu} or
25280 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
25281 @samp{gnu2} is more efficient, but it may add compile- and run-time
25282 requirements that cannot be satisfied on all systems.
25284 @item -mpush-args
25285 @itemx -mno-push-args
25286 @opindex mpush-args
25287 @opindex mno-push-args
25288 Use PUSH operations to store outgoing parameters.  This method is shorter
25289 and usually equally fast as method using SUB/MOV operations and is enabled
25290 by default.  In some cases disabling it may improve performance because of
25291 improved scheduling and reduced dependencies.
25293 @item -maccumulate-outgoing-args
25294 @opindex maccumulate-outgoing-args
25295 If enabled, the maximum amount of space required for outgoing arguments is
25296 computed in the function prologue.  This is faster on most modern CPUs
25297 because of reduced dependencies, improved scheduling and reduced stack usage
25298 when the preferred stack boundary is not equal to 2.  The drawback is a notable
25299 increase in code size.  This switch implies @option{-mno-push-args}.
25301 @item -mthreads
25302 @opindex mthreads
25303 Support thread-safe exception handling on MinGW.  Programs that rely
25304 on thread-safe exception handling must compile and link all code with the
25305 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
25306 @option{-D_MT}; when linking, it links in a special thread helper library
25307 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
25309 @item -mms-bitfields
25310 @itemx -mno-ms-bitfields
25311 @opindex mms-bitfields
25312 @opindex mno-ms-bitfields
25314 Enable/disable bit-field layout compatible with the native Microsoft
25315 Windows compiler.  
25317 If @code{packed} is used on a structure, or if bit-fields are used,
25318 it may be that the Microsoft ABI lays out the structure differently
25319 than the way GCC normally does.  Particularly when moving packed
25320 data between functions compiled with GCC and the native Microsoft compiler
25321 (either via function call or as data in a file), it may be necessary to access
25322 either format.
25324 This option is enabled by default for Microsoft Windows
25325 targets.  This behavior can also be controlled locally by use of variable
25326 or type attributes.  For more information, see @ref{x86 Variable Attributes}
25327 and @ref{x86 Type Attributes}.
25329 The Microsoft structure layout algorithm is fairly simple with the exception
25330 of the bit-field packing.  
25331 The padding and alignment of members of structures and whether a bit-field 
25332 can straddle a storage-unit boundary are determine by these rules:
25334 @enumerate
25335 @item Structure members are stored sequentially in the order in which they are
25336 declared: the first member has the lowest memory address and the last member
25337 the highest.
25339 @item Every data object has an alignment requirement.  The alignment requirement
25340 for all data except structures, unions, and arrays is either the size of the
25341 object or the current packing size (specified with either the
25342 @code{aligned} attribute or the @code{pack} pragma),
25343 whichever is less.  For structures, unions, and arrays,
25344 the alignment requirement is the largest alignment requirement of its members.
25345 Every object is allocated an offset so that:
25347 @smallexample
25348 offset % alignment_requirement == 0
25349 @end smallexample
25351 @item Adjacent bit-fields are packed into the same 1-, 2-, or 4-byte allocation
25352 unit if the integral types are the same size and if the next bit-field fits
25353 into the current allocation unit without crossing the boundary imposed by the
25354 common alignment requirements of the bit-fields.
25355 @end enumerate
25357 MSVC interprets zero-length bit-fields in the following ways:
25359 @enumerate
25360 @item If a zero-length bit-field is inserted between two bit-fields that
25361 are normally coalesced, the bit-fields are not coalesced.
25363 For example:
25365 @smallexample
25366 struct
25367  @{
25368    unsigned long bf_1 : 12;
25369    unsigned long : 0;
25370    unsigned long bf_2 : 12;
25371  @} t1;
25372 @end smallexample
25374 @noindent
25375 The size of @code{t1} is 8 bytes with the zero-length bit-field.  If the
25376 zero-length bit-field were removed, @code{t1}'s size would be 4 bytes.
25378 @item If a zero-length bit-field is inserted after a bit-field, @code{foo}, and the
25379 alignment of the zero-length bit-field is greater than the member that follows it,
25380 @code{bar}, @code{bar} is aligned as the type of the zero-length bit-field.
25382 For example:
25384 @smallexample
25385 struct
25386  @{
25387    char foo : 4;
25388    short : 0;
25389    char bar;
25390  @} t2;
25392 struct
25393  @{
25394    char foo : 4;
25395    short : 0;
25396    double bar;
25397  @} t3;
25398 @end smallexample
25400 @noindent
25401 For @code{t2}, @code{bar} is placed at offset 2, rather than offset 1.
25402 Accordingly, the size of @code{t2} is 4.  For @code{t3}, the zero-length
25403 bit-field does not affect the alignment of @code{bar} or, as a result, the size
25404 of the structure.
25406 Taking this into account, it is important to note the following:
25408 @enumerate
25409 @item If a zero-length bit-field follows a normal bit-field, the type of the
25410 zero-length bit-field may affect the alignment of the structure as whole. For
25411 example, @code{t2} has a size of 4 bytes, since the zero-length bit-field follows a
25412 normal bit-field, and is of type short.
25414 @item Even if a zero-length bit-field is not followed by a normal bit-field, it may
25415 still affect the alignment of the structure:
25417 @smallexample
25418 struct
25419  @{
25420    char foo : 6;
25421    long : 0;
25422  @} t4;
25423 @end smallexample
25425 @noindent
25426 Here, @code{t4} takes up 4 bytes.
25427 @end enumerate
25429 @item Zero-length bit-fields following non-bit-field members are ignored:
25431 @smallexample
25432 struct
25433  @{
25434    char foo;
25435    long : 0;
25436    char bar;
25437  @} t5;
25438 @end smallexample
25440 @noindent
25441 Here, @code{t5} takes up 2 bytes.
25442 @end enumerate
25445 @item -mno-align-stringops
25446 @opindex mno-align-stringops
25447 Do not align the destination of inlined string operations.  This switch reduces
25448 code size and improves performance in case the destination is already aligned,
25449 but GCC doesn't know about it.
25451 @item -minline-all-stringops
25452 @opindex minline-all-stringops
25453 By default GCC inlines string operations only when the destination is 
25454 known to be aligned to least a 4-byte boundary.  
25455 This enables more inlining and increases code
25456 size, but may improve performance of code that depends on fast
25457 @code{memcpy}, @code{strlen},
25458 and @code{memset} for short lengths.
25460 @item -minline-stringops-dynamically
25461 @opindex minline-stringops-dynamically
25462 For string operations of unknown size, use run-time checks with
25463 inline code for small blocks and a library call for large blocks.
25465 @item -mstringop-strategy=@var{alg}
25466 @opindex mstringop-strategy=@var{alg}
25467 Override the internal decision heuristic for the particular algorithm to use
25468 for inlining string operations.  The allowed values for @var{alg} are:
25470 @table @samp
25471 @item rep_byte
25472 @itemx rep_4byte
25473 @itemx rep_8byte
25474 Expand using i386 @code{rep} prefix of the specified size.
25476 @item byte_loop
25477 @itemx loop
25478 @itemx unrolled_loop
25479 Expand into an inline loop.
25481 @item libcall
25482 Always use a library call.
25483 @end table
25485 @item -mmemcpy-strategy=@var{strategy}
25486 @opindex mmemcpy-strategy=@var{strategy}
25487 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
25488 should be inlined and what inline algorithm to use when the expected size
25489 of the copy operation is known. @var{strategy} 
25490 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
25491 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
25492 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
25493 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
25494 in the list must be specified in increasing order.  The minimal byte size for 
25495 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
25496 preceding range.
25498 @item -mmemset-strategy=@var{strategy}
25499 @opindex mmemset-strategy=@var{strategy}
25500 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
25501 @code{__builtin_memset} expansion.
25503 @item -momit-leaf-frame-pointer
25504 @opindex momit-leaf-frame-pointer
25505 Don't keep the frame pointer in a register for leaf functions.  This
25506 avoids the instructions to save, set up, and restore frame pointers and
25507 makes an extra register available in leaf functions.  The option
25508 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
25509 which might make debugging harder.
25511 @item -mtls-direct-seg-refs
25512 @itemx -mno-tls-direct-seg-refs
25513 @opindex mtls-direct-seg-refs
25514 Controls whether TLS variables may be accessed with offsets from the
25515 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
25516 or whether the thread base pointer must be added.  Whether or not this
25517 is valid depends on the operating system, and whether it maps the
25518 segment to cover the entire TLS area.
25520 For systems that use the GNU C Library, the default is on.
25522 @item -msse2avx
25523 @itemx -mno-sse2avx
25524 @opindex msse2avx
25525 Specify that the assembler should encode SSE instructions with VEX
25526 prefix.  The option @option{-mavx} turns this on by default.
25528 @item -mfentry
25529 @itemx -mno-fentry
25530 @opindex mfentry
25531 If profiling is active (@option{-pg}), put the profiling
25532 counter call before the prologue.
25533 Note: On x86 architectures the attribute @code{ms_hook_prologue}
25534 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
25536 @item -mrecord-mcount
25537 @itemx -mno-record-mcount
25538 @opindex mrecord-mcount
25539 If profiling is active (@option{-pg}), generate a __mcount_loc section
25540 that contains pointers to each profiling call. This is useful for
25541 automatically patching and out calls.
25543 @item -mnop-mcount
25544 @itemx -mno-nop-mcount
25545 @opindex mnop-mcount
25546 If profiling is active (@option{-pg}), generate the calls to
25547 the profiling functions as NOPs. This is useful when they
25548 should be patched in later dynamically. This is likely only
25549 useful together with @option{-mrecord-mcount}.
25551 @item -mskip-rax-setup
25552 @itemx -mno-skip-rax-setup
25553 @opindex mskip-rax-setup
25554 When generating code for the x86-64 architecture with SSE extensions
25555 disabled, @option{-mskip-rax-setup} can be used to skip setting up RAX
25556 register when there are no variable arguments passed in vector registers.
25558 @strong{Warning:} Since RAX register is used to avoid unnecessarily
25559 saving vector registers on stack when passing variable arguments, the
25560 impacts of this option are callees may waste some stack space,
25561 misbehave or jump to a random location.  GCC 4.4 or newer don't have
25562 those issues, regardless the RAX register value.
25564 @item -m8bit-idiv
25565 @itemx -mno-8bit-idiv
25566 @opindex m8bit-idiv
25567 On some processors, like Intel Atom, 8-bit unsigned integer divide is
25568 much faster than 32-bit/64-bit integer divide.  This option generates a
25569 run-time check.  If both dividend and divisor are within range of 0
25570 to 255, 8-bit unsigned integer divide is used instead of
25571 32-bit/64-bit integer divide.
25573 @item -mavx256-split-unaligned-load
25574 @itemx -mavx256-split-unaligned-store
25575 @opindex mavx256-split-unaligned-load
25576 @opindex mavx256-split-unaligned-store
25577 Split 32-byte AVX unaligned load and store.
25579 @item -mstack-protector-guard=@var{guard}
25580 @opindex mstack-protector-guard=@var{guard}
25581 Generate stack protection code using canary at @var{guard}.  Supported
25582 locations are @samp{global} for global canary or @samp{tls} for per-thread
25583 canary in the TLS block (the default).  This option has effect only when
25584 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
25586 @item -mmitigate-rop
25587 @opindex mmitigate-rop
25588 Try to avoid generating code sequences that contain unintended return
25589 opcodes, to mitigate against certain forms of attack. At the moment,
25590 this option is limited in what it can do and should not be relied
25591 on to provide serious protection.
25593 @item -mgeneral-regs-only
25594 @opindex mgeneral-regs-only
25595 Generate code that uses only the general-purpose registers.  This
25596 prevents the compiler from using floating-point, vector, mask and bound
25597 registers.
25599 @end table
25601 These @samp{-m} switches are supported in addition to the above
25602 on x86-64 processors in 64-bit environments.
25604 @table @gcctabopt
25605 @item -m32
25606 @itemx -m64
25607 @itemx -mx32
25608 @itemx -m16
25609 @itemx -miamcu
25610 @opindex m32
25611 @opindex m64
25612 @opindex mx32
25613 @opindex m16
25614 @opindex miamcu
25615 Generate code for a 16-bit, 32-bit or 64-bit environment.
25616 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
25617 to 32 bits, and
25618 generates code that runs on any i386 system.
25620 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
25621 types to 64 bits, and generates code for the x86-64 architecture.
25622 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
25623 and @option{-mdynamic-no-pic} options.
25625 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
25626 to 32 bits, and
25627 generates code for the x86-64 architecture.
25629 The @option{-m16} option is the same as @option{-m32}, except for that
25630 it outputs the @code{.code16gcc} assembly directive at the beginning of
25631 the assembly output so that the binary can run in 16-bit mode.
25633 The @option{-miamcu} option generates code which conforms to Intel MCU
25634 psABI.  It requires the @option{-m32} option to be turned on.
25636 @item -mno-red-zone
25637 @opindex mno-red-zone
25638 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
25639 by the x86-64 ABI; it is a 128-byte area beyond the location of the
25640 stack pointer that is not modified by signal or interrupt handlers
25641 and therefore can be used for temporary data without adjusting the stack
25642 pointer.  The flag @option{-mno-red-zone} disables this red zone.
25644 @item -mcmodel=small
25645 @opindex mcmodel=small
25646 Generate code for the small code model: the program and its symbols must
25647 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
25648 Programs can be statically or dynamically linked.  This is the default
25649 code model.
25651 @item -mcmodel=kernel
25652 @opindex mcmodel=kernel
25653 Generate code for the kernel code model.  The kernel runs in the
25654 negative 2 GB of the address space.
25655 This model has to be used for Linux kernel code.
25657 @item -mcmodel=medium
25658 @opindex mcmodel=medium
25659 Generate code for the medium model: the program is linked in the lower 2
25660 GB of the address space.  Small symbols are also placed there.  Symbols
25661 with sizes larger than @option{-mlarge-data-threshold} are put into
25662 large data or BSS sections and can be located above 2GB.  Programs can
25663 be statically or dynamically linked.
25665 @item -mcmodel=large
25666 @opindex mcmodel=large
25667 Generate code for the large model.  This model makes no assumptions
25668 about addresses and sizes of sections.
25670 @item -maddress-mode=long
25671 @opindex maddress-mode=long
25672 Generate code for long address mode.  This is only supported for 64-bit
25673 and x32 environments.  It is the default address mode for 64-bit
25674 environments.
25676 @item -maddress-mode=short
25677 @opindex maddress-mode=short
25678 Generate code for short address mode.  This is only supported for 32-bit
25679 and x32 environments.  It is the default address mode for 32-bit and
25680 x32 environments.
25681 @end table
25683 @node x86 Windows Options
25684 @subsection x86 Windows Options
25685 @cindex x86 Windows Options
25686 @cindex Windows Options for x86
25688 These additional options are available for Microsoft Windows targets:
25690 @table @gcctabopt
25691 @item -mconsole
25692 @opindex mconsole
25693 This option
25694 specifies that a console application is to be generated, by
25695 instructing the linker to set the PE header subsystem type
25696 required for console applications.
25697 This option is available for Cygwin and MinGW targets and is
25698 enabled by default on those targets.
25700 @item -mdll
25701 @opindex mdll
25702 This option is available for Cygwin and MinGW targets.  It
25703 specifies that a DLL---a dynamic link library---is to be
25704 generated, enabling the selection of the required runtime
25705 startup object and entry point.
25707 @item -mnop-fun-dllimport
25708 @opindex mnop-fun-dllimport
25709 This option is available for Cygwin and MinGW targets.  It
25710 specifies that the @code{dllimport} attribute should be ignored.
25712 @item -mthread
25713 @opindex mthread
25714 This option is available for MinGW targets. It specifies
25715 that MinGW-specific thread support is to be used.
25717 @item -municode
25718 @opindex municode
25719 This option is available for MinGW-w64 targets.  It causes
25720 the @code{UNICODE} preprocessor macro to be predefined, and
25721 chooses Unicode-capable runtime startup code.
25723 @item -mwin32
25724 @opindex mwin32
25725 This option is available for Cygwin and MinGW targets.  It
25726 specifies that the typical Microsoft Windows predefined macros are to
25727 be set in the pre-processor, but does not influence the choice
25728 of runtime library/startup code.
25730 @item -mwindows
25731 @opindex mwindows
25732 This option is available for Cygwin and MinGW targets.  It
25733 specifies that a GUI application is to be generated by
25734 instructing the linker to set the PE header subsystem type
25735 appropriately.
25737 @item -fno-set-stack-executable
25738 @opindex fno-set-stack-executable
25739 This option is available for MinGW targets. It specifies that
25740 the executable flag for the stack used by nested functions isn't
25741 set. This is necessary for binaries running in kernel mode of
25742 Microsoft Windows, as there the User32 API, which is used to set executable
25743 privileges, isn't available.
25745 @item -fwritable-relocated-rdata
25746 @opindex fno-writable-relocated-rdata
25747 This option is available for MinGW and Cygwin targets.  It specifies
25748 that relocated-data in read-only section is put into the @code{.data}
25749 section.  This is a necessary for older runtimes not supporting
25750 modification of @code{.rdata} sections for pseudo-relocation.
25752 @item -mpe-aligned-commons
25753 @opindex mpe-aligned-commons
25754 This option is available for Cygwin and MinGW targets.  It
25755 specifies that the GNU extension to the PE file format that
25756 permits the correct alignment of COMMON variables should be
25757 used when generating code.  It is enabled by default if
25758 GCC detects that the target assembler found during configuration
25759 supports the feature.
25760 @end table
25762 See also under @ref{x86 Options} for standard options.
25764 @node Xstormy16 Options
25765 @subsection Xstormy16 Options
25766 @cindex Xstormy16 Options
25768 These options are defined for Xstormy16:
25770 @table @gcctabopt
25771 @item -msim
25772 @opindex msim
25773 Choose startup files and linker script suitable for the simulator.
25774 @end table
25776 @node Xtensa Options
25777 @subsection Xtensa Options
25778 @cindex Xtensa Options
25780 These options are supported for Xtensa targets:
25782 @table @gcctabopt
25783 @item -mconst16
25784 @itemx -mno-const16
25785 @opindex mconst16
25786 @opindex mno-const16
25787 Enable or disable use of @code{CONST16} instructions for loading
25788 constant values.  The @code{CONST16} instruction is currently not a
25789 standard option from Tensilica.  When enabled, @code{CONST16}
25790 instructions are always used in place of the standard @code{L32R}
25791 instructions.  The use of @code{CONST16} is enabled by default only if
25792 the @code{L32R} instruction is not available.
25794 @item -mfused-madd
25795 @itemx -mno-fused-madd
25796 @opindex mfused-madd
25797 @opindex mno-fused-madd
25798 Enable or disable use of fused multiply/add and multiply/subtract
25799 instructions in the floating-point option.  This has no effect if the
25800 floating-point option is not also enabled.  Disabling fused multiply/add
25801 and multiply/subtract instructions forces the compiler to use separate
25802 instructions for the multiply and add/subtract operations.  This may be
25803 desirable in some cases where strict IEEE 754-compliant results are
25804 required: the fused multiply add/subtract instructions do not round the
25805 intermediate result, thereby producing results with @emph{more} bits of
25806 precision than specified by the IEEE standard.  Disabling fused multiply
25807 add/subtract instructions also ensures that the program output is not
25808 sensitive to the compiler's ability to combine multiply and add/subtract
25809 operations.
25811 @item -mserialize-volatile
25812 @itemx -mno-serialize-volatile
25813 @opindex mserialize-volatile
25814 @opindex mno-serialize-volatile
25815 When this option is enabled, GCC inserts @code{MEMW} instructions before
25816 @code{volatile} memory references to guarantee sequential consistency.
25817 The default is @option{-mserialize-volatile}.  Use
25818 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
25820 @item -mforce-no-pic
25821 @opindex mforce-no-pic
25822 For targets, like GNU/Linux, where all user-mode Xtensa code must be
25823 position-independent code (PIC), this option disables PIC for compiling
25824 kernel code.
25826 @item -mtext-section-literals
25827 @itemx -mno-text-section-literals
25828 @opindex mtext-section-literals
25829 @opindex mno-text-section-literals
25830 These options control the treatment of literal pools.  The default is
25831 @option{-mno-text-section-literals}, which places literals in a separate
25832 section in the output file.  This allows the literal pool to be placed
25833 in a data RAM/ROM, and it also allows the linker to combine literal
25834 pools from separate object files to remove redundant literals and
25835 improve code size.  With @option{-mtext-section-literals}, the literals
25836 are interspersed in the text section in order to keep them as close as
25837 possible to their references.  This may be necessary for large assembly
25838 files.  Literals for each function are placed right before that function.
25840 @item -mauto-litpools
25841 @itemx -mno-auto-litpools
25842 @opindex mauto-litpools
25843 @opindex mno-auto-litpools
25844 These options control the treatment of literal pools.  The default is
25845 @option{-mno-auto-litpools}, which places literals in a separate
25846 section in the output file unless @option{-mtext-section-literals} is
25847 used.  With @option{-mauto-litpools} the literals are interspersed in
25848 the text section by the assembler.  Compiler does not produce explicit
25849 @code{.literal} directives and loads literals into registers with
25850 @code{MOVI} instructions instead of @code{L32R} to let the assembler
25851 do relaxation and place literals as necessary.  This option allows
25852 assembler to create several literal pools per function and assemble
25853 very big functions, which may not be possible with
25854 @option{-mtext-section-literals}.
25856 @item -mtarget-align
25857 @itemx -mno-target-align
25858 @opindex mtarget-align
25859 @opindex mno-target-align
25860 When this option is enabled, GCC instructs the assembler to
25861 automatically align instructions to reduce branch penalties at the
25862 expense of some code density.  The assembler attempts to widen density
25863 instructions to align branch targets and the instructions following call
25864 instructions.  If there are not enough preceding safe density
25865 instructions to align a target, no widening is performed.  The
25866 default is @option{-mtarget-align}.  These options do not affect the
25867 treatment of auto-aligned instructions like @code{LOOP}, which the
25868 assembler always aligns, either by widening density instructions or
25869 by inserting NOP instructions.
25871 @item -mlongcalls
25872 @itemx -mno-longcalls
25873 @opindex mlongcalls
25874 @opindex mno-longcalls
25875 When this option is enabled, GCC instructs the assembler to translate
25876 direct calls to indirect calls unless it can determine that the target
25877 of a direct call is in the range allowed by the call instruction.  This
25878 translation typically occurs for calls to functions in other source
25879 files.  Specifically, the assembler translates a direct @code{CALL}
25880 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
25881 The default is @option{-mno-longcalls}.  This option should be used in
25882 programs where the call target can potentially be out of range.  This
25883 option is implemented in the assembler, not the compiler, so the
25884 assembly code generated by GCC still shows direct call
25885 instructions---look at the disassembled object code to see the actual
25886 instructions.  Note that the assembler uses an indirect call for
25887 every cross-file call, not just those that really are out of range.
25888 @end table
25890 @node zSeries Options
25891 @subsection zSeries Options
25892 @cindex zSeries options
25894 These are listed under @xref{S/390 and zSeries Options}.
25897 @c man end
25899 @node Spec Files
25900 @section Specifying Subprocesses and the Switches to Pass to Them
25901 @cindex Spec Files
25903 @command{gcc} is a driver program.  It performs its job by invoking a
25904 sequence of other programs to do the work of compiling, assembling and
25905 linking.  GCC interprets its command-line parameters and uses these to
25906 deduce which programs it should invoke, and which command-line options
25907 it ought to place on their command lines.  This behavior is controlled
25908 by @dfn{spec strings}.  In most cases there is one spec string for each
25909 program that GCC can invoke, but a few programs have multiple spec
25910 strings to control their behavior.  The spec strings built into GCC can
25911 be overridden by using the @option{-specs=} command-line switch to specify
25912 a spec file.
25914 @dfn{Spec files} are plain-text files that are used to construct spec
25915 strings.  They consist of a sequence of directives separated by blank
25916 lines.  The type of directive is determined by the first non-whitespace
25917 character on the line, which can be one of the following:
25919 @table @code
25920 @item %@var{command}
25921 Issues a @var{command} to the spec file processor.  The commands that can
25922 appear here are:
25924 @table @code
25925 @item %include <@var{file}>
25926 @cindex @code{%include}
25927 Search for @var{file} and insert its text at the current point in the
25928 specs file.
25930 @item %include_noerr <@var{file}>
25931 @cindex @code{%include_noerr}
25932 Just like @samp{%include}, but do not generate an error message if the include
25933 file cannot be found.
25935 @item %rename @var{old_name} @var{new_name}
25936 @cindex @code{%rename}
25937 Rename the spec string @var{old_name} to @var{new_name}.
25939 @end table
25941 @item *[@var{spec_name}]:
25942 This tells the compiler to create, override or delete the named spec
25943 string.  All lines after this directive up to the next directive or
25944 blank line are considered to be the text for the spec string.  If this
25945 results in an empty string then the spec is deleted.  (Or, if the
25946 spec did not exist, then nothing happens.)  Otherwise, if the spec
25947 does not currently exist a new spec is created.  If the spec does
25948 exist then its contents are overridden by the text of this
25949 directive, unless the first character of that text is the @samp{+}
25950 character, in which case the text is appended to the spec.
25952 @item [@var{suffix}]:
25953 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
25954 and up to the next directive or blank line are considered to make up the
25955 spec string for the indicated suffix.  When the compiler encounters an
25956 input file with the named suffix, it processes the spec string in
25957 order to work out how to compile that file.  For example:
25959 @smallexample
25960 .ZZ:
25961 z-compile -input %i
25962 @end smallexample
25964 This says that any input file whose name ends in @samp{.ZZ} should be
25965 passed to the program @samp{z-compile}, which should be invoked with the
25966 command-line switch @option{-input} and with the result of performing the
25967 @samp{%i} substitution.  (See below.)
25969 As an alternative to providing a spec string, the text following a
25970 suffix directive can be one of the following:
25972 @table @code
25973 @item @@@var{language}
25974 This says that the suffix is an alias for a known @var{language}.  This is
25975 similar to using the @option{-x} command-line switch to GCC to specify a
25976 language explicitly.  For example:
25978 @smallexample
25979 .ZZ:
25980 @@c++
25981 @end smallexample
25983 Says that .ZZ files are, in fact, C++ source files.
25985 @item #@var{name}
25986 This causes an error messages saying:
25988 @smallexample
25989 @var{name} compiler not installed on this system.
25990 @end smallexample
25991 @end table
25993 GCC already has an extensive list of suffixes built into it.
25994 This directive adds an entry to the end of the list of suffixes, but
25995 since the list is searched from the end backwards, it is effectively
25996 possible to override earlier entries using this technique.
25998 @end table
26000 GCC has the following spec strings built into it.  Spec files can
26001 override these strings or create their own.  Note that individual
26002 targets can also add their own spec strings to this list.
26004 @smallexample
26005 asm          Options to pass to the assembler
26006 asm_final    Options to pass to the assembler post-processor
26007 cpp          Options to pass to the C preprocessor
26008 cc1          Options to pass to the C compiler
26009 cc1plus      Options to pass to the C++ compiler
26010 endfile      Object files to include at the end of the link
26011 link         Options to pass to the linker
26012 lib          Libraries to include on the command line to the linker
26013 libgcc       Decides which GCC support library to pass to the linker
26014 linker       Sets the name of the linker
26015 predefines   Defines to be passed to the C preprocessor
26016 signed_char  Defines to pass to CPP to say whether @code{char} is signed
26017              by default
26018 startfile    Object files to include at the start of the link
26019 @end smallexample
26021 Here is a small example of a spec file:
26023 @smallexample
26024 %rename lib                 old_lib
26026 *lib:
26027 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
26028 @end smallexample
26030 This example renames the spec called @samp{lib} to @samp{old_lib} and
26031 then overrides the previous definition of @samp{lib} with a new one.
26032 The new definition adds in some extra command-line options before
26033 including the text of the old definition.
26035 @dfn{Spec strings} are a list of command-line options to be passed to their
26036 corresponding program.  In addition, the spec strings can contain
26037 @samp{%}-prefixed sequences to substitute variable text or to
26038 conditionally insert text into the command line.  Using these constructs
26039 it is possible to generate quite complex command lines.
26041 Here is a table of all defined @samp{%}-sequences for spec
26042 strings.  Note that spaces are not generated automatically around the
26043 results of expanding these sequences.  Therefore you can concatenate them
26044 together or combine them with constant text in a single argument.
26046 @table @code
26047 @item %%
26048 Substitute one @samp{%} into the program name or argument.
26050 @item %i
26051 Substitute the name of the input file being processed.
26053 @item %b
26054 Substitute the basename of the input file being processed.
26055 This is the substring up to (and not including) the last period
26056 and not including the directory.
26058 @item %B
26059 This is the same as @samp{%b}, but include the file suffix (text after
26060 the last period).
26062 @item %d
26063 Marks the argument containing or following the @samp{%d} as a
26064 temporary file name, so that that file is deleted if GCC exits
26065 successfully.  Unlike @samp{%g}, this contributes no text to the
26066 argument.
26068 @item %g@var{suffix}
26069 Substitute a file name that has suffix @var{suffix} and is chosen
26070 once per compilation, and mark the argument in the same way as
26071 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
26072 name is now chosen in a way that is hard to predict even when previously
26073 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
26074 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
26075 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
26076 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
26077 was simply substituted with a file name chosen once per compilation,
26078 without regard to any appended suffix (which was therefore treated
26079 just like ordinary text), making such attacks more likely to succeed.
26081 @item %u@var{suffix}
26082 Like @samp{%g}, but generates a new temporary file name
26083 each time it appears instead of once per compilation.
26085 @item %U@var{suffix}
26086 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
26087 new one if there is no such last file name.  In the absence of any
26088 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
26089 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
26090 involves the generation of two distinct file names, one
26091 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
26092 simply substituted with a file name chosen for the previous @samp{%u},
26093 without regard to any appended suffix.
26095 @item %j@var{suffix}
26096 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
26097 writable, and if @option{-save-temps} is not used; 
26098 otherwise, substitute the name
26099 of a temporary file, just like @samp{%u}.  This temporary file is not
26100 meant for communication between processes, but rather as a junk
26101 disposal mechanism.
26103 @item %|@var{suffix}
26104 @itemx %m@var{suffix}
26105 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
26106 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
26107 all.  These are the two most common ways to instruct a program that it
26108 should read from standard input or write to standard output.  If you
26109 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
26110 construct: see for example @file{f/lang-specs.h}.
26112 @item %.@var{SUFFIX}
26113 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
26114 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
26115 terminated by the next space or %.
26117 @item %w
26118 Marks the argument containing or following the @samp{%w} as the
26119 designated output file of this compilation.  This puts the argument
26120 into the sequence of arguments that @samp{%o} substitutes.
26122 @item %o
26123 Substitutes the names of all the output files, with spaces
26124 automatically placed around them.  You should write spaces
26125 around the @samp{%o} as well or the results are undefined.
26126 @samp{%o} is for use in the specs for running the linker.
26127 Input files whose names have no recognized suffix are not compiled
26128 at all, but they are included among the output files, so they are
26129 linked.
26131 @item %O
26132 Substitutes the suffix for object files.  Note that this is
26133 handled specially when it immediately follows @samp{%g, %u, or %U},
26134 because of the need for those to form complete file names.  The
26135 handling is such that @samp{%O} is treated exactly as if it had already
26136 been substituted, except that @samp{%g, %u, and %U} do not currently
26137 support additional @var{suffix} characters following @samp{%O} as they do
26138 following, for example, @samp{.o}.
26140 @item %p
26141 Substitutes the standard macro predefinitions for the
26142 current target machine.  Use this when running @command{cpp}.
26144 @item %P
26145 Like @samp{%p}, but puts @samp{__} before and after the name of each
26146 predefined macro, except for macros that start with @samp{__} or with
26147 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
26150 @item %I
26151 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
26152 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
26153 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
26154 and @option{-imultilib} as necessary.
26156 @item %s
26157 Current argument is the name of a library or startup file of some sort.
26158 Search for that file in a standard list of directories and substitute
26159 the full name found.  The current working directory is included in the
26160 list of directories scanned.
26162 @item %T
26163 Current argument is the name of a linker script.  Search for that file
26164 in the current list of directories to scan for libraries. If the file
26165 is located insert a @option{--script} option into the command line
26166 followed by the full path name found.  If the file is not found then
26167 generate an error message.  Note: the current working directory is not
26168 searched.
26170 @item %e@var{str}
26171 Print @var{str} as an error message.  @var{str} is terminated by a newline.
26172 Use this when inconsistent options are detected.
26174 @item %(@var{name})
26175 Substitute the contents of spec string @var{name} at this point.
26177 @item %x@{@var{option}@}
26178 Accumulate an option for @samp{%X}.
26180 @item %X
26181 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
26182 spec string.
26184 @item %Y
26185 Output the accumulated assembler options specified by @option{-Wa}.
26187 @item %Z
26188 Output the accumulated preprocessor options specified by @option{-Wp}.
26190 @item %a
26191 Process the @code{asm} spec.  This is used to compute the
26192 switches to be passed to the assembler.
26194 @item %A
26195 Process the @code{asm_final} spec.  This is a spec string for
26196 passing switches to an assembler post-processor, if such a program is
26197 needed.
26199 @item %l
26200 Process the @code{link} spec.  This is the spec for computing the
26201 command line passed to the linker.  Typically it makes use of the
26202 @samp{%L %G %S %D and %E} sequences.
26204 @item %D
26205 Dump out a @option{-L} option for each directory that GCC believes might
26206 contain startup files.  If the target supports multilibs then the
26207 current multilib directory is prepended to each of these paths.
26209 @item %L
26210 Process the @code{lib} spec.  This is a spec string for deciding which
26211 libraries are included on the command line to the linker.
26213 @item %G
26214 Process the @code{libgcc} spec.  This is a spec string for deciding
26215 which GCC support library is included on the command line to the linker.
26217 @item %S
26218 Process the @code{startfile} spec.  This is a spec for deciding which
26219 object files are the first ones passed to the linker.  Typically
26220 this might be a file named @file{crt0.o}.
26222 @item %E
26223 Process the @code{endfile} spec.  This is a spec string that specifies
26224 the last object files that are passed to the linker.
26226 @item %C
26227 Process the @code{cpp} spec.  This is used to construct the arguments
26228 to be passed to the C preprocessor.
26230 @item %1
26231 Process the @code{cc1} spec.  This is used to construct the options to be
26232 passed to the actual C compiler (@command{cc1}).
26234 @item %2
26235 Process the @code{cc1plus} spec.  This is used to construct the options to be
26236 passed to the actual C++ compiler (@command{cc1plus}).
26238 @item %*
26239 Substitute the variable part of a matched option.  See below.
26240 Note that each comma in the substituted string is replaced by
26241 a single space.
26243 @item %<@code{S}
26244 Remove all occurrences of @code{-S} from the command line.  Note---this
26245 command is position dependent.  @samp{%} commands in the spec string
26246 before this one see @code{-S}, @samp{%} commands in the spec string
26247 after this one do not.
26249 @item %:@var{function}(@var{args})
26250 Call the named function @var{function}, passing it @var{args}.
26251 @var{args} is first processed as a nested spec string, then split
26252 into an argument vector in the usual fashion.  The function returns
26253 a string which is processed as if it had appeared literally as part
26254 of the current spec.
26256 The following built-in spec functions are provided:
26258 @table @code
26259 @item @code{getenv}
26260 The @code{getenv} spec function takes two arguments: an environment
26261 variable name and a string.  If the environment variable is not
26262 defined, a fatal error is issued.  Otherwise, the return value is the
26263 value of the environment variable concatenated with the string.  For
26264 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
26266 @smallexample
26267 %:getenv(TOPDIR /include)
26268 @end smallexample
26270 expands to @file{/path/to/top/include}.
26272 @item @code{if-exists}
26273 The @code{if-exists} spec function takes one argument, an absolute
26274 pathname to a file.  If the file exists, @code{if-exists} returns the
26275 pathname.  Here is a small example of its usage:
26277 @smallexample
26278 *startfile:
26279 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
26280 @end smallexample
26282 @item @code{if-exists-else}
26283 The @code{if-exists-else} spec function is similar to the @code{if-exists}
26284 spec function, except that it takes two arguments.  The first argument is
26285 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
26286 returns the pathname.  If it does not exist, it returns the second argument.
26287 This way, @code{if-exists-else} can be used to select one file or another,
26288 based on the existence of the first.  Here is a small example of its usage:
26290 @smallexample
26291 *startfile:
26292 crt0%O%s %:if-exists(crti%O%s) \
26293 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
26294 @end smallexample
26296 @item @code{replace-outfile}
26297 The @code{replace-outfile} spec function takes two arguments.  It looks for the
26298 first argument in the outfiles array and replaces it with the second argument.  Here
26299 is a small example of its usage:
26301 @smallexample
26302 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
26303 @end smallexample
26305 @item @code{remove-outfile}
26306 The @code{remove-outfile} spec function takes one argument.  It looks for the
26307 first argument in the outfiles array and removes it.  Here is a small example
26308 its usage:
26310 @smallexample
26311 %:remove-outfile(-lm)
26312 @end smallexample
26314 @item @code{pass-through-libs}
26315 The @code{pass-through-libs} spec function takes any number of arguments.  It
26316 finds any @option{-l} options and any non-options ending in @file{.a} (which it
26317 assumes are the names of linker input library archive files) and returns a
26318 result containing all the found arguments each prepended by
26319 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
26320 intended to be passed to the LTO linker plugin.
26322 @smallexample
26323 %:pass-through-libs(%G %L %G)
26324 @end smallexample
26326 @item @code{print-asm-header}
26327 The @code{print-asm-header} function takes no arguments and simply
26328 prints a banner like:
26330 @smallexample
26331 Assembler options
26332 =================
26334 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
26335 @end smallexample
26337 It is used to separate compiler options from assembler options
26338 in the @option{--target-help} output.
26339 @end table
26341 @item %@{@code{S}@}
26342 Substitutes the @code{-S} switch, if that switch is given to GCC@.
26343 If that switch is not specified, this substitutes nothing.  Note that
26344 the leading dash is omitted when specifying this option, and it is
26345 automatically inserted if the substitution is performed.  Thus the spec
26346 string @samp{%@{foo@}} matches the command-line option @option{-foo}
26347 and outputs the command-line option @option{-foo}.
26349 @item %W@{@code{S}@}
26350 Like %@{@code{S}@} but mark last argument supplied within as a file to be
26351 deleted on failure.
26353 @item %@{@code{S}*@}
26354 Substitutes all the switches specified to GCC whose names start
26355 with @code{-S}, but which also take an argument.  This is used for
26356 switches like @option{-o}, @option{-D}, @option{-I}, etc.
26357 GCC considers @option{-o foo} as being
26358 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
26359 text, including the space.  Thus two arguments are generated.
26361 @item %@{@code{S}*&@code{T}*@}
26362 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
26363 (the order of @code{S} and @code{T} in the spec is not significant).
26364 There can be any number of ampersand-separated variables; for each the
26365 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
26367 @item %@{@code{S}:@code{X}@}
26368 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
26370 @item %@{!@code{S}:@code{X}@}
26371 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
26373 @item %@{@code{S}*:@code{X}@}
26374 Substitutes @code{X} if one or more switches whose names start with
26375 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
26376 once, no matter how many such switches appeared.  However, if @code{%*}
26377 appears somewhere in @code{X}, then @code{X} is substituted once
26378 for each matching switch, with the @code{%*} replaced by the part of
26379 that switch matching the @code{*}.
26381 If @code{%*} appears as the last part of a spec sequence then a space
26382 is added after the end of the last substitution.  If there is more
26383 text in the sequence, however, then a space is not generated.  This
26384 allows the @code{%*} substitution to be used as part of a larger
26385 string.  For example, a spec string like this:
26387 @smallexample
26388 %@{mcu=*:--script=%*/memory.ld@}
26389 @end smallexample
26391 @noindent
26392 when matching an option like @option{-mcu=newchip} produces:
26394 @smallexample
26395 --script=newchip/memory.ld
26396 @end smallexample
26398 @item %@{.@code{S}:@code{X}@}
26399 Substitutes @code{X}, if processing a file with suffix @code{S}.
26401 @item %@{!.@code{S}:@code{X}@}
26402 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
26404 @item %@{,@code{S}:@code{X}@}
26405 Substitutes @code{X}, if processing a file for language @code{S}.
26407 @item %@{!,@code{S}:@code{X}@}
26408 Substitutes @code{X}, if not processing a file for language @code{S}.
26410 @item %@{@code{S}|@code{P}:@code{X}@}
26411 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
26412 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
26413 @code{*} sequences as well, although they have a stronger binding than
26414 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
26415 alternatives must be starred, and only the first matching alternative
26416 is substituted.
26418 For example, a spec string like this:
26420 @smallexample
26421 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
26422 @end smallexample
26424 @noindent
26425 outputs the following command-line options from the following input
26426 command-line options:
26428 @smallexample
26429 fred.c        -foo -baz
26430 jim.d         -bar -boggle
26431 -d fred.c     -foo -baz -boggle
26432 -d jim.d      -bar -baz -boggle
26433 @end smallexample
26435 @item %@{S:X; T:Y; :D@}
26437 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
26438 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
26439 be as many clauses as you need.  This may be combined with @code{.},
26440 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
26443 @end table
26445 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
26446 construct may contain other nested @samp{%} constructs or spaces, or
26447 even newlines.  They are processed as usual, as described above.
26448 Trailing white space in @code{X} is ignored.  White space may also
26449 appear anywhere on the left side of the colon in these constructs,
26450 except between @code{.} or @code{*} and the corresponding word.
26452 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
26453 handled specifically in these constructs.  If another value of
26454 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
26455 @option{-W} switch is found later in the command line, the earlier
26456 switch value is ignored, except with @{@code{S}*@} where @code{S} is
26457 just one letter, which passes all matching options.
26459 The character @samp{|} at the beginning of the predicate text is used to
26460 indicate that a command should be piped to the following command, but
26461 only if @option{-pipe} is specified.
26463 It is built into GCC which switches take arguments and which do not.
26464 (You might think it would be useful to generalize this to allow each
26465 compiler's spec to say which switches take arguments.  But this cannot
26466 be done in a consistent fashion.  GCC cannot even decide which input
26467 files have been specified without knowing which switches take arguments,
26468 and it must know which input files to compile in order to tell which
26469 compilers to run).
26471 GCC also knows implicitly that arguments starting in @option{-l} are to be
26472 treated as compiler output files, and passed to the linker in their
26473 proper position among the other output files.
26475 @node Environment Variables
26476 @section Environment Variables Affecting GCC
26477 @cindex environment variables
26479 @c man begin ENVIRONMENT
26480 This section describes several environment variables that affect how GCC
26481 operates.  Some of them work by specifying directories or prefixes to use
26482 when searching for various kinds of files.  Some are used to specify other
26483 aspects of the compilation environment.
26485 Note that you can also specify places to search using options such as
26486 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
26487 take precedence over places specified using environment variables, which
26488 in turn take precedence over those specified by the configuration of GCC@.
26489 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
26490 GNU Compiler Collection (GCC) Internals}.
26492 @table @env
26493 @item LANG
26494 @itemx LC_CTYPE
26495 @c @itemx LC_COLLATE
26496 @itemx LC_MESSAGES
26497 @c @itemx LC_MONETARY
26498 @c @itemx LC_NUMERIC
26499 @c @itemx LC_TIME
26500 @itemx LC_ALL
26501 @findex LANG
26502 @findex LC_CTYPE
26503 @c @findex LC_COLLATE
26504 @findex LC_MESSAGES
26505 @c @findex LC_MONETARY
26506 @c @findex LC_NUMERIC
26507 @c @findex LC_TIME
26508 @findex LC_ALL
26509 @cindex locale
26510 These environment variables control the way that GCC uses
26511 localization information which allows GCC to work with different
26512 national conventions.  GCC inspects the locale categories
26513 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
26514 so.  These locale categories can be set to any value supported by your
26515 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
26516 Kingdom encoded in UTF-8.
26518 The @env{LC_CTYPE} environment variable specifies character
26519 classification.  GCC uses it to determine the character boundaries in
26520 a string; this is needed for some multibyte encodings that contain quote
26521 and escape characters that are otherwise interpreted as a string
26522 end or escape.
26524 The @env{LC_MESSAGES} environment variable specifies the language to
26525 use in diagnostic messages.
26527 If the @env{LC_ALL} environment variable is set, it overrides the value
26528 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
26529 and @env{LC_MESSAGES} default to the value of the @env{LANG}
26530 environment variable.  If none of these variables are set, GCC
26531 defaults to traditional C English behavior.
26533 @item TMPDIR
26534 @findex TMPDIR
26535 If @env{TMPDIR} is set, it specifies the directory to use for temporary
26536 files.  GCC uses temporary files to hold the output of one stage of
26537 compilation which is to be used as input to the next stage: for example,
26538 the output of the preprocessor, which is the input to the compiler
26539 proper.
26541 @item GCC_COMPARE_DEBUG
26542 @findex GCC_COMPARE_DEBUG
26543 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
26544 @option{-fcompare-debug} to the compiler driver.  See the documentation
26545 of this option for more details.
26547 @item GCC_EXEC_PREFIX
26548 @findex GCC_EXEC_PREFIX
26549 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
26550 names of the subprograms executed by the compiler.  No slash is added
26551 when this prefix is combined with the name of a subprogram, but you can
26552 specify a prefix that ends with a slash if you wish.
26554 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
26555 an appropriate prefix to use based on the pathname it is invoked with.
26557 If GCC cannot find the subprogram using the specified prefix, it
26558 tries looking in the usual places for the subprogram.
26560 The default value of @env{GCC_EXEC_PREFIX} is
26561 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
26562 the installed compiler. In many cases @var{prefix} is the value
26563 of @code{prefix} when you ran the @file{configure} script.
26565 Other prefixes specified with @option{-B} take precedence over this prefix.
26567 This prefix is also used for finding files such as @file{crt0.o} that are
26568 used for linking.
26570 In addition, the prefix is used in an unusual way in finding the
26571 directories to search for header files.  For each of the standard
26572 directories whose name normally begins with @samp{/usr/local/lib/gcc}
26573 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
26574 replacing that beginning with the specified prefix to produce an
26575 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
26576 @file{foo/bar} just before it searches the standard directory 
26577 @file{/usr/local/lib/bar}.
26578 If a standard directory begins with the configured
26579 @var{prefix} then the value of @var{prefix} is replaced by
26580 @env{GCC_EXEC_PREFIX} when looking for header files.
26582 @item COMPILER_PATH
26583 @findex COMPILER_PATH
26584 The value of @env{COMPILER_PATH} is a colon-separated list of
26585 directories, much like @env{PATH}.  GCC tries the directories thus
26586 specified when searching for subprograms, if it can't find the
26587 subprograms using @env{GCC_EXEC_PREFIX}.
26589 @item LIBRARY_PATH
26590 @findex LIBRARY_PATH
26591 The value of @env{LIBRARY_PATH} is a colon-separated list of
26592 directories, much like @env{PATH}.  When configured as a native compiler,
26593 GCC tries the directories thus specified when searching for special
26594 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
26595 using GCC also uses these directories when searching for ordinary
26596 libraries for the @option{-l} option (but directories specified with
26597 @option{-L} come first).
26599 @item LANG
26600 @findex LANG
26601 @cindex locale definition
26602 This variable is used to pass locale information to the compiler.  One way in
26603 which this information is used is to determine the character set to be used
26604 when character literals, string literals and comments are parsed in C and C++.
26605 When the compiler is configured to allow multibyte characters,
26606 the following values for @env{LANG} are recognized:
26608 @table @samp
26609 @item C-JIS
26610 Recognize JIS characters.
26611 @item C-SJIS
26612 Recognize SJIS characters.
26613 @item C-EUCJP
26614 Recognize EUCJP characters.
26615 @end table
26617 If @env{LANG} is not defined, or if it has some other value, then the
26618 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
26619 recognize and translate multibyte characters.
26620 @end table
26622 @noindent
26623 Some additional environment variables affect the behavior of the
26624 preprocessor.
26626 @include cppenv.texi
26628 @c man end
26630 @node Precompiled Headers
26631 @section Using Precompiled Headers
26632 @cindex precompiled headers
26633 @cindex speed of compilation
26635 Often large projects have many header files that are included in every
26636 source file.  The time the compiler takes to process these header files
26637 over and over again can account for nearly all of the time required to
26638 build the project.  To make builds faster, GCC allows you to
26639 @dfn{precompile} a header file.
26641 To create a precompiled header file, simply compile it as you would any
26642 other file, if necessary using the @option{-x} option to make the driver
26643 treat it as a C or C++ header file.  You may want to use a
26644 tool like @command{make} to keep the precompiled header up-to-date when
26645 the headers it contains change.
26647 A precompiled header file is searched for when @code{#include} is
26648 seen in the compilation.  As it searches for the included file
26649 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
26650 compiler looks for a precompiled header in each directory just before it
26651 looks for the include file in that directory.  The name searched for is
26652 the name specified in the @code{#include} with @samp{.gch} appended.  If
26653 the precompiled header file can't be used, it is ignored.
26655 For instance, if you have @code{#include "all.h"}, and you have
26656 @file{all.h.gch} in the same directory as @file{all.h}, then the
26657 precompiled header file is used if possible, and the original
26658 header is used otherwise.
26660 Alternatively, you might decide to put the precompiled header file in a
26661 directory and use @option{-I} to ensure that directory is searched
26662 before (or instead of) the directory containing the original header.
26663 Then, if you want to check that the precompiled header file is always
26664 used, you can put a file of the same name as the original header in this
26665 directory containing an @code{#error} command.
26667 This also works with @option{-include}.  So yet another way to use
26668 precompiled headers, good for projects not designed with precompiled
26669 header files in mind, is to simply take most of the header files used by
26670 a project, include them from another header file, precompile that header
26671 file, and @option{-include} the precompiled header.  If the header files
26672 have guards against multiple inclusion, they are skipped because
26673 they've already been included (in the precompiled header).
26675 If you need to precompile the same header file for different
26676 languages, targets, or compiler options, you can instead make a
26677 @emph{directory} named like @file{all.h.gch}, and put each precompiled
26678 header in the directory, perhaps using @option{-o}.  It doesn't matter
26679 what you call the files in the directory; every precompiled header in
26680 the directory is considered.  The first precompiled header
26681 encountered in the directory that is valid for this compilation is
26682 used; they're searched in no particular order.
26684 There are many other possibilities, limited only by your imagination,
26685 good sense, and the constraints of your build system.
26687 A precompiled header file can be used only when these conditions apply:
26689 @itemize
26690 @item
26691 Only one precompiled header can be used in a particular compilation.
26693 @item
26694 A precompiled header can't be used once the first C token is seen.  You
26695 can have preprocessor directives before a precompiled header; you cannot
26696 include a precompiled header from inside another header.
26698 @item
26699 The precompiled header file must be produced for the same language as
26700 the current compilation.  You can't use a C precompiled header for a C++
26701 compilation.
26703 @item
26704 The precompiled header file must have been produced by the same compiler
26705 binary as the current compilation is using.
26707 @item
26708 Any macros defined before the precompiled header is included must
26709 either be defined in the same way as when the precompiled header was
26710 generated, or must not affect the precompiled header, which usually
26711 means that they don't appear in the precompiled header at all.
26713 The @option{-D} option is one way to define a macro before a
26714 precompiled header is included; using a @code{#define} can also do it.
26715 There are also some options that define macros implicitly, like
26716 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
26717 defined this way.
26719 @item If debugging information is output when using the precompiled
26720 header, using @option{-g} or similar, the same kind of debugging information
26721 must have been output when building the precompiled header.  However,
26722 a precompiled header built using @option{-g} can be used in a compilation
26723 when no debugging information is being output.
26725 @item The same @option{-m} options must generally be used when building
26726 and using the precompiled header.  @xref{Submodel Options},
26727 for any cases where this rule is relaxed.
26729 @item Each of the following options must be the same when building and using
26730 the precompiled header:
26732 @gccoptlist{-fexceptions}
26734 @item
26735 Some other command-line options starting with @option{-f},
26736 @option{-p}, or @option{-O} must be defined in the same way as when
26737 the precompiled header was generated.  At present, it's not clear
26738 which options are safe to change and which are not; the safest choice
26739 is to use exactly the same options when generating and using the
26740 precompiled header.  The following are known to be safe:
26742 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
26743 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
26744 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
26745 -pedantic-errors}
26747 @end itemize
26749 For all of these except the last, the compiler automatically
26750 ignores the precompiled header if the conditions aren't met.  If you
26751 find an option combination that doesn't work and doesn't cause the
26752 precompiled header to be ignored, please consider filing a bug report,
26753 see @ref{Bugs}.
26755 If you do use differing options when generating and using the
26756 precompiled header, the actual behavior is a mixture of the
26757 behavior for the options.  For instance, if you use @option{-g} to
26758 generate the precompiled header but not when using it, you may or may
26759 not get debugging information for routines in the precompiled header.