check.c (gfc_check_x): Remove function.
[official-gcc.git] / gcc / doc / invoke.texi
blob9ad1fb339babe2ce8f45ecac2fa93d7b9ae5fd30
1 @c Copyright (C) 1988-2017 Free Software Foundation, Inc.
2 @c This is part of the GCC manual.
3 @c For copying conditions, see the file gcc.texi.
5 @ignore
6 @c man begin INCLUDE
7 @include gcc-vers.texi
8 @c man end
10 @c man begin COPYRIGHT
11 Copyright @copyright{} 1988-2017 Free Software Foundation, Inc.
13 Permission is granted to copy, distribute and/or modify this document
14 under the terms of the GNU Free Documentation License, Version 1.3 or
15 any later version published by the Free Software Foundation; with the
16 Invariant Sections being ``GNU General Public License'' and ``Funding
17 Free Software'', the Front-Cover texts being (a) (see below), and with
18 the Back-Cover Texts being (b) (see below).  A copy of the license is
19 included in the gfdl(7) man page.
21 (a) The FSF's Front-Cover Text is:
23      A GNU Manual
25 (b) The FSF's Back-Cover Text is:
27      You have freedom to copy and modify this GNU Manual, like GNU
28      software.  Copies published by the Free Software Foundation raise
29      funds for GNU development.
30 @c man end
31 @c Set file name and title for the man page.
32 @setfilename gcc
33 @settitle GNU project C and C++ compiler
34 @c man begin SYNOPSIS
35 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
36     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
37     [@option{-W}@var{warn}@dots{}] [@option{-Wpedantic}]
38     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
39     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
40     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
41     [@option{-o} @var{outfile}] [@@@var{file}] @var{infile}@dots{}
43 Only the most useful options are listed here; see below for the
44 remainder.  @command{g++} accepts mostly the same options as @command{gcc}.
45 @c man end
46 @c man begin SEEALSO
47 gpl(7), gfdl(7), fsf-funding(7),
48 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
49 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
50 @file{ld}, @file{binutils} and @file{gdb}.
51 @c man end
52 @c man begin BUGS
53 For instructions on reporting bugs, see
54 @w{@value{BUGURL}}.
55 @c man end
56 @c man begin AUTHOR
57 See the Info entry for @command{gcc}, or
58 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
59 for contributors to GCC@.
60 @c man end
61 @end ignore
63 @node Invoking GCC
64 @chapter GCC Command Options
65 @cindex GCC command options
66 @cindex command options
67 @cindex options, GCC command
69 @c man begin DESCRIPTION
70 When you invoke GCC, it normally does preprocessing, compilation,
71 assembly and linking.  The ``overall options'' allow you to stop this
72 process at an intermediate stage.  For example, the @option{-c} option
73 says not to run the linker.  Then the output consists of object files
74 output by the assembler.
75 @xref{Overall Options,,Options Controlling the Kind of Output}.
77 Other options are passed on to one or more stages of processing.  Some options
78 control the preprocessor and others the compiler itself.  Yet other
79 options control the assembler and linker; most of these are not
80 documented here, since you rarely need to use any of them.
82 @cindex C compilation options
83 Most of the command-line options that you can use with GCC are useful
84 for C programs; when an option is only useful with another language
85 (usually C++), the explanation says so explicitly.  If the description
86 for a particular option does not mention a source language, you can use
87 that option with all supported languages.
89 @cindex cross compiling
90 @cindex specifying machine version
91 @cindex specifying compiler version and target machine
92 @cindex compiler version, specifying
93 @cindex target machine, specifying
94 The usual way to run GCC is to run the executable called @command{gcc}, or
95 @command{@var{machine}-gcc} when cross-compiling, or
96 @command{@var{machine}-gcc-@var{version}} to run a specific version of GCC.
97 When you compile C++ programs, you should invoke GCC as @command{g++} 
98 instead.  @xref{Invoking G++,,Compiling C++ Programs}, 
99 for information about the differences in behavior between @command{gcc} 
100 and @code{g++} when compiling C++ programs.
102 @cindex grouping options
103 @cindex options, grouping
104 The @command{gcc} program accepts options and file names as operands.  Many
105 options have multi-letter names; therefore multiple single-letter options
106 may @emph{not} be grouped: @option{-dv} is very different from @w{@samp{-d
107 -v}}.
109 @cindex order of options
110 @cindex options, order
111 You can mix options and other arguments.  For the most part, the order
112 you use doesn't matter.  Order does matter when you use several
113 options of the same kind; for example, if you specify @option{-L} more
114 than once, the directories are searched in the order specified.  Also,
115 the placement of the @option{-l} option is significant.
117 Many options have long names starting with @samp{-f} or with
118 @samp{-W}---for example,
119 @option{-fmove-loop-invariants}, @option{-Wformat} and so on.  Most of
120 these have both positive and negative forms; the negative form of
121 @option{-ffoo} is @option{-fno-foo}.  This manual documents
122 only one of these two forms, whichever one is not the default.
124 @c man end
126 @xref{Option Index}, for an index to GCC's options.
128 @menu
129 * Option Summary::      Brief list of all options, without explanations.
130 * Overall Options::     Controlling the kind of output:
131                         an executable, object files, assembler files,
132                         or preprocessed source.
133 * Invoking G++::        Compiling C++ programs.
134 * C Dialect Options::   Controlling the variant of C language compiled.
135 * C++ Dialect Options:: Variations on C++.
136 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
137                         and Objective-C++.
138 * Diagnostic Message Formatting Options:: Controlling how diagnostics should
139                         be formatted.
140 * Warning Options::     How picky should the compiler be?
141 * Debugging Options::   Producing debuggable code.
142 * Optimize Options::    How much optimization?
143 * Instrumentation Options:: Enabling profiling and extra run-time error checking.
144 * Preprocessor Options:: Controlling header files and macro definitions.
145                          Also, getting dependency information for Make.
146 * Assembler Options::   Passing options to the assembler.
147 * Link Options::        Specifying libraries and so on.
148 * Directory Options::   Where to find header files and libraries.
149                         Where to find the compiler executable files.
150 * Code Gen Options::    Specifying conventions for function calls, data layout
151                         and register usage.
152 * Developer Options::   Printing GCC configuration info, statistics, and
153                         debugging dumps.
154 * Submodel Options::    Target-specific options, such as compiling for a
155                         specific processor variant.
156 * Spec Files::          How to pass switches to sub-processes.
157 * Environment Variables:: Env vars that affect GCC.
158 * Precompiled Headers:: Compiling a header once, and using it many times.
159 @end menu
161 @c man begin OPTIONS
163 @node Option Summary
164 @section Option Summary
166 Here is a summary of all the options, grouped by type.  Explanations are
167 in the following sections.
169 @table @emph
170 @item Overall Options
171 @xref{Overall Options,,Options Controlling the Kind of Output}.
172 @gccoptlist{-c  -S  -E  -o @var{file}  -x @var{language}  @gol
173 -v  -###  --help@r{[}=@var{class}@r{[},@dots{}@r{]]}  --target-help  --version @gol
174 -pass-exit-codes  -pipe  -specs=@var{file}  -wrapper  @gol
175 @@@var{file}  -fplugin=@var{file}  -fplugin-arg-@var{name}=@var{arg}  @gol
176 -fdump-ada-spec@r{[}-slim@r{]}  -fada-spec-parent=@var{unit}  -fdump-go-spec=@var{file}}
178 @item C Language Options
179 @xref{C Dialect Options,,Options Controlling C Dialect}.
180 @gccoptlist{-ansi  -std=@var{standard}  -fgnu89-inline @gol
181 -fpermitted-flt-eval-methods=@var{standard} @gol
182 -aux-info @var{filename}  -fallow-parameterless-variadic-functions @gol
183 -fno-asm  -fno-builtin  -fno-builtin-@var{function}  -fgimple@gol
184 -fhosted  -ffreestanding  -fopenacc  -fopenmp  -fopenmp-simd @gol
185 -fms-extensions  -fplan9-extensions  -fsso-struct=@var{endianness} @gol
186 -fallow-single-precision  -fcond-mismatch  -flax-vector-conversions @gol
187 -fsigned-bitfields  -fsigned-char @gol
188 -funsigned-bitfields  -funsigned-char}
190 @item C++ Language Options
191 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
192 @gccoptlist{-fabi-version=@var{n}  -fno-access-control @gol
193 -faligned-new=@var{n}  -fargs-in-order=@var{n}  -fcheck-new @gol
194 -fconstexpr-depth=@var{n}  -fconstexpr-loop-limit=@var{n} @gol
195 -ffriend-injection @gol
196 -fno-elide-constructors @gol
197 -fno-enforce-eh-specs @gol
198 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
199 -fno-implicit-templates @gol
200 -fno-implicit-inline-templates @gol
201 -fno-implement-inlines  -fms-extensions @gol
202 -fnew-inheriting-ctors @gol
203 -fnew-ttp-matching @gol
204 -fno-nonansi-builtins  -fnothrow-opt  -fno-operator-names @gol
205 -fno-optional-diags  -fpermissive @gol
206 -fno-pretty-templates @gol
207 -frepo  -fno-rtti  -fsized-deallocation @gol
208 -ftemplate-backtrace-limit=@var{n} @gol
209 -ftemplate-depth=@var{n} @gol
210 -fno-threadsafe-statics  -fuse-cxa-atexit @gol
211 -fno-weak  -nostdinc++ @gol
212 -fvisibility-inlines-hidden @gol
213 -fvisibility-ms-compat @gol
214 -fext-numeric-literals @gol
215 -Wabi=@var{n}  -Wabi-tag  -Wconversion-null  -Wctor-dtor-privacy @gol
216 -Wdelete-non-virtual-dtor  -Wliteral-suffix  -Wmultiple-inheritance @gol
217 -Wnamespaces  -Wnarrowing @gol
218 -Wnoexcept  -Wnoexcept-type  -Wclass-memaccess @gol
219 -Wnon-virtual-dtor  -Wreorder  -Wregister @gol
220 -Weffc++  -Wstrict-null-sentinel  -Wtemplates @gol
221 -Wno-non-template-friend  -Wold-style-cast @gol
222 -Woverloaded-virtual  -Wno-pmf-conversions @gol
223 -Wsign-promo  -Wvirtual-inheritance}
225 @item Objective-C and Objective-C++ Language Options
226 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
227 Objective-C and Objective-C++ Dialects}.
228 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
229 -fgnu-runtime  -fnext-runtime @gol
230 -fno-nil-receivers @gol
231 -fobjc-abi-version=@var{n} @gol
232 -fobjc-call-cxx-cdtors @gol
233 -fobjc-direct-dispatch @gol
234 -fobjc-exceptions @gol
235 -fobjc-gc @gol
236 -fobjc-nilcheck @gol
237 -fobjc-std=objc1 @gol
238 -fno-local-ivars @gol
239 -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]} @gol
240 -freplace-objc-classes @gol
241 -fzero-link @gol
242 -gen-decls @gol
243 -Wassign-intercept @gol
244 -Wno-protocol  -Wselector @gol
245 -Wstrict-selector-match @gol
246 -Wundeclared-selector}
248 @item Diagnostic Message Formatting Options
249 @xref{Diagnostic Message Formatting Options,,Options to Control Diagnostic Messages Formatting}.
250 @gccoptlist{-fmessage-length=@var{n}  @gol
251 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
252 -fdiagnostics-color=@r{[}auto@r{|}never@r{|}always@r{]}  @gol
253 -fno-diagnostics-show-option  -fno-diagnostics-show-caret @gol
254 -fdiagnostics-parseable-fixits  -fdiagnostics-generate-patch @gol
255 -fdiagnostics-show-template-tree -fno-elide-type @gol
256 -fno-show-column}
258 @item Warning Options
259 @xref{Warning Options,,Options to Request or Suppress Warnings}.
260 @gccoptlist{-fsyntax-only  -fmax-errors=@var{n}  -Wpedantic @gol
261 -pedantic-errors @gol
262 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  @gol
263 -Walloc-zero  -Walloc-size-larger-than=@var{n}
264 -Walloca  -Walloca-larger-than=@var{n} @gol
265 -Wno-aggressive-loop-optimizations  -Warray-bounds  -Warray-bounds=@var{n} @gol
266 -Wno-attributes  -Wbool-compare  -Wbool-operation @gol
267 -Wno-builtin-declaration-mismatch @gol
268 -Wno-builtin-macro-redefined  -Wc90-c99-compat  -Wc99-c11-compat @gol
269 -Wc++-compat  -Wc++11-compat  -Wc++14-compat  @gol
270 -Wcast-align  -Wcast-align=strict  -Wcast-qual  @gol
271 -Wchar-subscripts  -Wchkp  -Wcatch-value  -Wcatch-value=@var{n} @gol
272 -Wclobbered  -Wcomment  -Wconditionally-supported @gol
273 -Wconversion  -Wcoverage-mismatch  -Wno-cpp  -Wdangling-else  -Wdate-time @gol
274 -Wdelete-incomplete @gol
275 -Wno-deprecated  -Wno-deprecated-declarations  -Wno-designated-init @gol
276 -Wdisabled-optimization @gol
277 -Wno-discarded-qualifiers  -Wno-discarded-array-qualifiers @gol
278 -Wno-div-by-zero  -Wdouble-promotion @gol
279 -Wduplicated-branches  -Wduplicated-cond @gol
280 -Wempty-body  -Wenum-compare  -Wno-endif-labels  -Wexpansion-to-defined @gol
281 -Werror  -Werror=*  -Wextra-semi  -Wfatal-errors @gol
282 -Wfloat-equal  -Wformat  -Wformat=2 @gol
283 -Wno-format-contains-nul  -Wno-format-extra-args  @gol
284 -Wformat-nonliteral -Wformat-overflow=@var{n} @gol
285 -Wformat-security  -Wformat-signedness  -Wformat-truncation=@var{n} @gol
286 -Wformat-y2k  -Wframe-address @gol
287 -Wframe-larger-than=@var{len}  -Wno-free-nonheap-object  -Wjump-misses-init @gol
288 -Wif-not-aligned @gol
289 -Wignored-qualifiers  -Wignored-attributes  -Wincompatible-pointer-types @gol
290 -Wimplicit  -Wimplicit-fallthrough  -Wimplicit-fallthrough=@var{n} @gol
291 -Wimplicit-function-declaration  -Wimplicit-int @gol
292 -Winit-self  -Winline  -Wno-int-conversion  -Wint-in-bool-context @gol
293 -Wno-int-to-pointer-cast  -Winvalid-memory-model  -Wno-invalid-offsetof @gol
294 -Winvalid-pch  -Wlarger-than=@var{len} @gol
295 -Wlogical-op  -Wlogical-not-parentheses  -Wlong-long @gol
296 -Wmain  -Wmaybe-uninitialized  -Wmemset-elt-size  -Wmemset-transposed-args @gol
297 -Wmisleading-indentation  -Wmissing-braces @gol
298 -Wmissing-field-initializers  -Wmissing-include-dirs @gol
299 -Wno-multichar  -Wmultistatement-macros  -Wnonnull  -Wnonnull-compare @gol
300 -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]} @gol
301 -Wnull-dereference  -Wodr  -Wno-overflow  -Wopenmp-simd  @gol
302 -Woverride-init-side-effects  -Woverlength-strings @gol
303 -Wpacked  -Wpacked-bitfield-compat -Wpacked-not-aligned -Wpadded @gol
304 -Wparentheses  -Wno-pedantic-ms-format @gol
305 -Wplacement-new  -Wplacement-new=@var{n} @gol
306 -Wpointer-arith  -Wpointer-compare  -Wno-pointer-to-int-cast @gol
307 -Wno-pragmas  -Wredundant-decls  -Wrestrict  -Wno-return-local-addr @gol
308 -Wreturn-type  -Wsequence-point  -Wshadow  -Wno-shadow-ivar @gol
309 -Wshadow=global,  -Wshadow=local,  -Wshadow=compatible-local @gol
310 -Wshift-overflow  -Wshift-overflow=@var{n} @gol
311 -Wshift-count-negative  -Wshift-count-overflow  -Wshift-negative-value @gol
312 -Wsign-compare  -Wsign-conversion  -Wfloat-conversion @gol
313 -Wno-scalar-storage-order  -Wsizeof-pointer-div @gol
314 -Wsizeof-pointer-memaccess  -Wsizeof-array-argument @gol
315 -Wstack-protector  -Wstack-usage=@var{len}  -Wstrict-aliasing @gol
316 -Wstrict-aliasing=n  -Wstrict-overflow  -Wstrict-overflow=@var{n} @gol
317 -Wstringop-overflow=@var{n} @gol
318 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]} @gol
319 -Wsuggest-final-types @gol  -Wsuggest-final-methods  -Wsuggest-override @gol
320 -Wmissing-format-attribute  -Wsubobject-linkage @gol
321 -Wswitch  -Wswitch-bool  -Wswitch-default  -Wswitch-enum @gol
322 -Wswitch-unreachable  -Wsync-nand @gol
323 -Wsystem-headers  -Wtautological-compare  -Wtrampolines  -Wtrigraphs @gol
324 -Wtype-limits  -Wundef @gol
325 -Wuninitialized  -Wunknown-pragmas  -Wunsafe-loop-optimizations @gol
326 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
327 -Wunused-label  -Wunused-local-typedefs  -Wunused-macros @gol
328 -Wunused-parameter  -Wno-unused-result @gol
329 -Wunused-value  -Wunused-variable @gol
330 -Wunused-const-variable  -Wunused-const-variable=@var{n} @gol
331 -Wunused-but-set-parameter  -Wunused-but-set-variable @gol
332 -Wuseless-cast  -Wvariadic-macros  -Wvector-operation-performance @gol
333 -Wvla  -Wvla-larger-than=@var{n}  -Wvolatile-register-var  -Wwrite-strings @gol
334 -Wzero-as-null-pointer-constant  -Whsa}
336 @item C and Objective-C-only Warning Options
337 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
338 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
339 -Wold-style-declaration  -Wold-style-definition @gol
340 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
341 -Wdeclaration-after-statement  -Wpointer-sign}
343 @item Debugging Options
344 @xref{Debugging Options,,Options for Debugging Your Program}.
345 @gccoptlist{-g  -g@var{level}  -gcoff  -gdwarf  -gdwarf-@var{version} @gol
346 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
347 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
348 -gcolumn-info  -gno-column-info @gol
349 -gvms  -gxcoff  -gxcoff+  -gz@r{[}=@var{type}@r{]} @gol
350 -fdebug-prefix-map=@var{old}=@var{new}  -fdebug-types-section @gol
351 -fno-eliminate-unused-debug-types @gol
352 -femit-struct-debug-baseonly  -femit-struct-debug-reduced @gol
353 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
354 -feliminate-unused-debug-symbols  -femit-class-debug-always @gol
355 -fno-merge-debug-strings  -fno-dwarf2-cfi-asm @gol
356 -fvar-tracking  -fvar-tracking-assignments}
358 @item Optimization Options
359 @xref{Optimize Options,,Options that Control Optimization}.
360 @gccoptlist{-faggressive-loop-optimizations  -falign-functions[=@var{n}] @gol
361 -falign-jumps[=@var{n}] @gol
362 -falign-labels[=@var{n}]  -falign-loops[=@var{n}] @gol
363 -fassociative-math  -fauto-profile  -fauto-profile[=@var{path}] @gol
364 -fauto-inc-dec  -fbranch-probabilities @gol
365 -fbranch-target-load-optimize  -fbranch-target-load-optimize2 @gol
366 -fbtr-bb-exclusive  -fcaller-saves @gol
367 -fcombine-stack-adjustments  -fconserve-stack @gol
368 -fcompare-elim  -fcprop-registers  -fcrossjumping @gol
369 -fcse-follow-jumps  -fcse-skip-blocks  -fcx-fortran-rules @gol
370 -fcx-limited-range @gol
371 -fdata-sections  -fdce  -fdelayed-branch @gol
372 -fdelete-null-pointer-checks  -fdevirtualize  -fdevirtualize-speculatively @gol
373 -fdevirtualize-at-ltrans  -fdse @gol
374 -fearly-inlining  -fipa-sra  -fexpensive-optimizations  -ffat-lto-objects @gol
375 -ffast-math  -ffinite-math-only  -ffloat-store  -fexcess-precision=@var{style} @gol
376 -fforward-propagate  -ffp-contract=@var{style}  -ffunction-sections @gol
377 -fgcse  -fgcse-after-reload  -fgcse-las  -fgcse-lm  -fgraphite-identity @gol
378 -fgcse-sm  -fhoist-adjacent-loads  -fif-conversion @gol
379 -fif-conversion2  -findirect-inlining @gol
380 -finline-functions  -finline-functions-called-once  -finline-limit=@var{n} @gol
381 -finline-small-functions  -fipa-cp  -fipa-cp-clone @gol
382 -fipa-bit-cp -fipa-vrp @gol
383 -fipa-pta  -fipa-profile  -fipa-pure-const  -fipa-reference  -fipa-icf @gol
384 -fira-algorithm=@var{algorithm} @gol
385 -fira-region=@var{region}  -fira-hoist-pressure @gol
386 -fira-loop-pressure  -fno-ira-share-save-slots @gol
387 -fno-ira-share-spill-slots @gol
388 -fisolate-erroneous-paths-dereference  -fisolate-erroneous-paths-attribute @gol
389 -fivopts  -fkeep-inline-functions  -fkeep-static-functions @gol
390 -fkeep-static-consts  -flimit-function-alignment  -flive-range-shrinkage @gol
391 -floop-block  -floop-interchange  -floop-strip-mine @gol
392 -floop-unroll-and-jam  -floop-nest-optimize @gol
393 -floop-parallelize-all  -flra-remat  -flto  -flto-compression-level @gol
394 -flto-partition=@var{alg}  -fmerge-all-constants @gol
395 -fmerge-constants  -fmodulo-sched  -fmodulo-sched-allow-regmoves @gol
396 -fmove-loop-invariants  -fno-branch-count-reg @gol
397 -fno-defer-pop  -fno-fp-int-builtin-inexact  -fno-function-cse @gol
398 -fno-guess-branch-probability  -fno-inline  -fno-math-errno  -fno-peephole @gol
399 -fno-peephole2  -fno-printf-return-value  -fno-sched-interblock @gol
400 -fno-sched-spec  -fno-signed-zeros @gol
401 -fno-toplevel-reorder  -fno-trapping-math  -fno-zero-initialized-in-bss @gol
402 -fomit-frame-pointer  -foptimize-sibling-calls @gol
403 -fpartial-inlining  -fpeel-loops  -fpredictive-commoning @gol
404 -fprefetch-loop-arrays @gol
405 -fprofile-correction @gol
406 -fprofile-use  -fprofile-use=@var{path}  -fprofile-values @gol
407 -fprofile-reorder-functions @gol
408 -freciprocal-math  -free  -frename-registers  -freorder-blocks @gol
409 -freorder-blocks-algorithm=@var{algorithm} @gol
410 -freorder-blocks-and-partition  -freorder-functions @gol
411 -frerun-cse-after-loop  -freschedule-modulo-scheduled-loops @gol
412 -frounding-math  -fsched2-use-superblocks  -fsched-pressure @gol
413 -fsched-spec-load  -fsched-spec-load-dangerous @gol
414 -fsched-stalled-insns-dep[=@var{n}]  -fsched-stalled-insns[=@var{n}] @gol
415 -fsched-group-heuristic  -fsched-critical-path-heuristic @gol
416 -fsched-spec-insn-heuristic  -fsched-rank-heuristic @gol
417 -fsched-last-insn-heuristic  -fsched-dep-count-heuristic @gol
418 -fschedule-fusion @gol
419 -fschedule-insns  -fschedule-insns2  -fsection-anchors @gol
420 -fselective-scheduling  -fselective-scheduling2 @gol
421 -fsel-sched-pipelining  -fsel-sched-pipelining-outer-loops @gol
422 -fsemantic-interposition  -fshrink-wrap  -fshrink-wrap-separate @gol
423 -fsignaling-nans @gol
424 -fsingle-precision-constant  -fsplit-ivs-in-unroller  -fsplit-loops@gol
425 -fsplit-paths @gol
426 -fsplit-wide-types  -fssa-backprop  -fssa-phiopt @gol
427 -fstdarg-opt  -fstore-merging  -fstrict-aliasing @gol
428 -fthread-jumps  -ftracer  -ftree-bit-ccp @gol
429 -ftree-builtin-call-dce  -ftree-ccp  -ftree-ch @gol
430 -ftree-coalesce-vars  -ftree-copy-prop  -ftree-dce  -ftree-dominator-opts @gol
431 -ftree-dse  -ftree-forwprop  -ftree-fre  -fcode-hoisting @gol
432 -ftree-loop-if-convert  -ftree-loop-im @gol
433 -ftree-phiprop  -ftree-loop-distribution  -ftree-loop-distribute-patterns @gol
434 -ftree-loop-ivcanon  -ftree-loop-linear  -ftree-loop-optimize @gol
435 -ftree-loop-vectorize @gol
436 -ftree-parallelize-loops=@var{n}  -ftree-pre  -ftree-partial-pre  -ftree-pta @gol
437 -ftree-reassoc  -ftree-sink  -ftree-slsr  -ftree-sra @gol
438 -ftree-switch-conversion  -ftree-tail-merge @gol
439 -ftree-ter  -ftree-vectorize  -ftree-vrp  -funconstrained-commons @gol
440 -funit-at-a-time  -funroll-all-loops  -funroll-loops @gol
441 -funsafe-math-optimizations  -funswitch-loops @gol
442 -fipa-ra  -fvariable-expansion-in-unroller  -fvect-cost-model  -fvpt @gol
443 -fweb  -fwhole-program  -fwpa  -fuse-linker-plugin @gol
444 --param @var{name}=@var{value}
445 -O  -O0  -O1  -O2  -O3  -Os  -Ofast  -Og}
447 @item Program Instrumentation Options
448 @xref{Instrumentation Options,,Program Instrumentation Options}.
449 @gccoptlist{-p  -pg  -fprofile-arcs  --coverage  -ftest-coverage @gol
450 -fprofile-abs-path @gol
451 -fprofile-dir=@var{path}  -fprofile-generate  -fprofile-generate=@var{path} @gol
452 -fsanitize=@var{style}  -fsanitize-recover  -fsanitize-recover=@var{style} @gol
453 -fasan-shadow-offset=@var{number}  -fsanitize-sections=@var{s1},@var{s2},... @gol
454 -fsanitize-undefined-trap-on-error  -fbounds-check @gol
455 -fcheck-pointer-bounds  -fchkp-check-incomplete-type @gol
456 -fchkp-first-field-has-own-bounds  -fchkp-narrow-bounds @gol
457 -fchkp-narrow-to-innermost-array  -fchkp-optimize @gol
458 -fchkp-use-fast-string-functions  -fchkp-use-nochk-string-functions @gol
459 -fchkp-use-static-bounds  -fchkp-use-static-const-bounds @gol
460 -fchkp-treat-zero-dynamic-size-as-infinite  -fchkp-check-read @gol
461 -fchkp-check-read  -fchkp-check-write  -fchkp-store-bounds @gol
462 -fchkp-instrument-calls  -fchkp-instrument-marked-only @gol
463 -fchkp-use-wrappers  -fchkp-flexible-struct-trailing-arrays@gol
464 -fstack-protector  -fstack-protector-all  -fstack-protector-strong @gol
465 -fstack-protector-explicit  -fstack-check @gol
466 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
467 -fno-stack-limit  -fsplit-stack @gol
468 -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]} @gol
469 -fvtv-counts  -fvtv-debug @gol
470 -finstrument-functions @gol
471 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
472 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}}
474 @item Preprocessor Options
475 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
476 @gccoptlist{-A@var{question}=@var{answer} @gol
477 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
478 -C  -CC  -D@var{macro}@r{[}=@var{defn}@r{]} @gol
479 -dD  -dI  -dM  -dN  -dU @gol
480 -fdebug-cpp  -fdirectives-only  -fdollars-in-identifiers  @gol
481 -fexec-charset=@var{charset}  -fextended-identifiers  @gol
482 -finput-charset=@var{charset}  -fno-canonical-system-headers @gol
483 -fpch-deps  -fpch-preprocess  -fpreprocessed @gol
484 -ftabstop=@var{width}  -ftrack-macro-expansion  @gol
485 -fwide-exec-charset=@var{charset}  -fworking-directory @gol
486 -H  -imacros @var{file}  -include @var{file} @gol
487 -M  -MD  -MF  -MG  -MM  -MMD  -MP  -MQ  -MT @gol
488 -no-integrated-cpp  -P  -pthread  -remap @gol
489 -traditional  -traditional-cpp  -trigraphs @gol
490 -U@var{macro}  -undef  @gol
491 -Wp,@var{option}  -Xpreprocessor @var{option}}
493 @item Assembler Options
494 @xref{Assembler Options,,Passing Options to the Assembler}.
495 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
497 @item Linker Options
498 @xref{Link Options,,Options for Linking}.
499 @gccoptlist{@var{object-file-name}  -fuse-ld=@var{linker}  -l@var{library} @gol
500 -nostartfiles  -nodefaultlibs  -nostdlib  -pie  -pthread  -rdynamic @gol
501 -s  -static -static-pie -static-libgcc  -static-libstdc++ @gol
502 -static-libasan  -static-libtsan  -static-liblsan  -static-libubsan @gol
503 -static-libmpx  -static-libmpxwrappers @gol
504 -shared  -shared-libgcc  -symbolic @gol
505 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
506 -u @var{symbol}  -z @var{keyword}}
508 @item Directory Options
509 @xref{Directory Options,,Options for Directory Search}.
510 @gccoptlist{-B@var{prefix}  -I@var{dir}  -I- @gol
511 -idirafter @var{dir} @gol
512 -imacros @var{file}  -imultilib @var{dir} @gol
513 -iplugindir=@var{dir}  -iprefix @var{file} @gol
514 -iquote @var{dir}  -isysroot @var{dir}  -isystem @var{dir} @gol
515 -iwithprefix @var{dir}  -iwithprefixbefore @var{dir}  @gol
516 -L@var{dir}  -no-canonical-prefixes  --no-sysroot-suffix @gol
517 -nostdinc  -nostdinc++  --sysroot=@var{dir}}
519 @item Code Generation Options
520 @xref{Code Gen Options,,Options for Code Generation Conventions}.
521 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
522 -ffixed-@var{reg}  -fexceptions @gol
523 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
524 -fasynchronous-unwind-tables @gol
525 -fno-gnu-unique @gol
526 -finhibit-size-directive  -fno-common  -fno-ident @gol
527 -fpcc-struct-return  -fpic  -fPIC  -fpie  -fPIE  -fno-plt @gol
528 -fno-jump-tables @gol
529 -frecord-gcc-switches @gol
530 -freg-struct-return  -fshort-enums  -fshort-wchar @gol
531 -fverbose-asm  -fpack-struct[=@var{n}]  @gol
532 -fleading-underscore  -ftls-model=@var{model} @gol
533 -fstack-reuse=@var{reuse_level} @gol
534 -ftrampolines  -ftrapv  -fwrapv @gol
535 -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]} @gol
536 -fstrict-volatile-bitfields  -fsync-libcalls}
538 @item Developer Options
539 @xref{Developer Options,,GCC Developer Options}.
540 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
541 -dumpfullversion  -fchecking  -fchecking=@var{n}  -fdbg-cnt-list @gol
542 -fdbg-cnt=@var{counter-value-list} @gol
543 -fdisable-ipa-@var{pass_name} @gol
544 -fdisable-rtl-@var{pass_name} @gol
545 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
546 -fdisable-tree-@var{pass_name} @gol
547 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
548 -fdump-noaddr  -fdump-unnumbered  -fdump-unnumbered-links @gol
549 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
550 -fdump-final-insns@r{[}=@var{file}@r{]}
551 -fdump-ipa-all  -fdump-ipa-cgraph  -fdump-ipa-inline @gol
552 -fdump-lang-all @gol
553 -fdump-lang-@var{switch} @gol
554 -fdump-lang-@var{switch}-@var{options} @gol
555 -fdump-lang-@var{switch}-@var{options}=@var{filename} @gol
556 -fdump-passes @gol
557 -fdump-rtl-@var{pass}  -fdump-rtl-@var{pass}=@var{filename} @gol
558 -fdump-statistics @gol
559 -fdump-tree-all @gol
560 -fdump-tree-@var{switch} @gol
561 -fdump-tree-@var{switch}-@var{options} @gol
562 -fdump-tree-@var{switch}-@var{options}=@var{filename} @gol
563 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
564 -fenable-@var{kind}-@var{pass} @gol
565 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
566 -fira-verbose=@var{n} @gol
567 -flto-report  -flto-report-wpa  -fmem-report-wpa @gol
568 -fmem-report  -fpre-ipa-mem-report  -fpost-ipa-mem-report @gol
569 -fopt-info  -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
570 -fprofile-report @gol
571 -frandom-seed=@var{string}  -fsched-verbose=@var{n} @gol
572 -fsel-sched-verbose  -fsel-sched-dump-cfg  -fsel-sched-pipelining-verbose @gol
573 -fstats  -fstack-usage  -ftime-report  -ftime-report-details @gol
574 -fvar-tracking-assignments-toggle  -gtoggle @gol
575 -print-file-name=@var{library}  -print-libgcc-file-name @gol
576 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
577 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
578 -print-sysroot  -print-sysroot-headers-suffix @gol
579 -save-temps  -save-temps=cwd  -save-temps=obj  -time@r{[}=@var{file}@r{]}}
581 @item Machine-Dependent Options
582 @xref{Submodel Options,,Machine-Dependent Options}.
583 @c This list is ordered alphanumerically by subsection name.
584 @c Try and put the significant identifier (CPU or system) first,
585 @c so users have a clue at guessing where the ones they want will be.
587 @emph{AArch64 Options}
588 @gccoptlist{-mabi=@var{name}  -mbig-endian  -mlittle-endian @gol
589 -mgeneral-regs-only @gol
590 -mcmodel=tiny  -mcmodel=small  -mcmodel=large @gol
591 -mstrict-align @gol
592 -momit-leaf-frame-pointer @gol
593 -mtls-dialect=desc  -mtls-dialect=traditional @gol
594 -mtls-size=@var{size} @gol
595 -mfix-cortex-a53-835769  -mfix-cortex-a53-843419 @gol
596 -mlow-precision-recip-sqrt  -mlow-precision-sqrt  -mlow-precision-div @gol
597 -mpc-relative-literal-loads @gol
598 -msign-return-address=@var{scope} @gol
599 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}  -moverride=@var{string}}
601 @emph{Adapteva Epiphany Options}
602 @gccoptlist{-mhalf-reg-file  -mprefer-short-insn-regs @gol
603 -mbranch-cost=@var{num}  -mcmove  -mnops=@var{num}  -msoft-cmpsf @gol
604 -msplit-lohi  -mpost-inc  -mpost-modify  -mstack-offset=@var{num} @gol
605 -mround-nearest  -mlong-calls  -mshort-calls  -msmall16 @gol
606 -mfp-mode=@var{mode}  -mvect-double  -max-vect-align=@var{num} @gol
607 -msplit-vecmove-early  -m1reg-@var{reg}}
609 @emph{ARC Options}
610 @gccoptlist{-mbarrel-shifter @gol
611 -mcpu=@var{cpu}  -mA6  -mARC600  -mA7  -mARC700 @gol
612 -mdpfp  -mdpfp-compact  -mdpfp-fast  -mno-dpfp-lrsr @gol
613 -mea  -mno-mpy  -mmul32x16  -mmul64  -matomic @gol
614 -mnorm  -mspfp  -mspfp-compact  -mspfp-fast  -msimd  -msoft-float  -mswap @gol
615 -mcrc  -mdsp-packa  -mdvbf  -mlock  -mmac-d16  -mmac-24  -mrtsc  -mswape @gol
616 -mtelephony  -mxy  -misize  -mannotate-align  -marclinux  -marclinux_prof @gol
617 -mlong-calls  -mmedium-calls  -msdata -mirq-ctrl-saved @gol
618 -mrgf-banked-regs -mlpc-width=@var{width} -G @var{num} @gol
619 -mvolatile-cache  -mtp-regno=@var{regno} @gol
620 -malign-call  -mauto-modify-reg  -mbbit-peephole  -mno-brcc @gol
621 -mcase-vector-pcrel  -mcompact-casesi  -mno-cond-exec  -mearly-cbranchsi @gol
622 -mexpand-adddi  -mindexed-loads  -mlra  -mlra-priority-none @gol
623 -mlra-priority-compact mlra-priority-noncompact  -mno-millicode @gol
624 -mmixed-code  -mq-class  -mRcq  -mRcw  -msize-level=@var{level} @gol
625 -mtune=@var{cpu}  -mmultcost=@var{num} @gol
626 -munalign-prob-threshold=@var{probability}  -mmpy-option=@var{multo} @gol
627 -mdiv-rem  -mcode-density  -mll64  -mfpu=@var{fpu}}
629 @emph{ARM Options}
630 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
631 -mabi=@var{name} @gol
632 -mapcs-stack-check  -mno-apcs-stack-check @gol
633 -mapcs-reentrant  -mno-apcs-reentrant @gol
634 -msched-prolog  -mno-sched-prolog @gol
635 -mlittle-endian  -mbig-endian @gol
636 -mbe8 -mbe32 @gol
637 -mfloat-abi=@var{name} @gol
638 -mfp16-format=@var{name}
639 -mthumb-interwork  -mno-thumb-interwork @gol
640 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
641 -mtune=@var{name}  -mprint-tune-info @gol
642 -mstructure-size-boundary=@var{n} @gol
643 -mabort-on-noreturn @gol
644 -mlong-calls  -mno-long-calls @gol
645 -msingle-pic-base  -mno-single-pic-base @gol
646 -mpic-register=@var{reg} @gol
647 -mnop-fun-dllimport @gol
648 -mpoke-function-name @gol
649 -mthumb  -marm @gol
650 -mtpcs-frame  -mtpcs-leaf-frame @gol
651 -mcaller-super-interworking  -mcallee-super-interworking @gol
652 -mtp=@var{name}  -mtls-dialect=@var{dialect} @gol
653 -mword-relocations @gol
654 -mfix-cortex-m3-ldrd @gol
655 -munaligned-access @gol
656 -mneon-for-64bits @gol
657 -mslow-flash-data @gol
658 -masm-syntax-unified @gol
659 -mrestrict-it @gol
660 -mpure-code @gol
661 -mcmse}
663 @emph{AVR Options}
664 @gccoptlist{-mmcu=@var{mcu}  -mabsdata  -maccumulate-args @gol
665 -mbranch-cost=@var{cost} @gol
666 -mcall-prologues  -mgas-isr-prologues  -mint8 @gol
667 -mn_flash=@var{size}  -mno-interrupts @gol
668 -mrelax  -mrmw  -mstrict-X  -mtiny-stack  -mfract-convert-truncate @gol
669 -mshort-calls  -nodevicelib @gol
670 -Waddr-space-convert  -Wmisspelled-isr}
672 @emph{Blackfin Options}
673 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
674 -msim  -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
675 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
676 -mlow-64k  -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
677 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
678 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
679 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
680 -mfast-fp  -minline-plt  -mmulticore  -mcorea  -mcoreb  -msdram @gol
681 -micplb}
683 @emph{C6X Options}
684 @gccoptlist{-mbig-endian  -mlittle-endian  -march=@var{cpu} @gol
685 -msim  -msdata=@var{sdata-type}}
687 @emph{CRIS Options}
688 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
689 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
690 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
691 -mstack-align  -mdata-align  -mconst-align @gol
692 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
693 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
694 -mmul-bug-workaround  -mno-mul-bug-workaround}
696 @emph{CR16 Options}
697 @gccoptlist{-mmac @gol
698 -mcr16cplus  -mcr16c @gol
699 -msim  -mint32  -mbit-ops
700 -mdata-model=@var{model}}
702 @emph{Darwin Options}
703 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
704 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
705 -client_name  -compatibility_version  -current_version @gol
706 -dead_strip @gol
707 -dependency-file  -dylib_file  -dylinker_install_name @gol
708 -dynamic  -dynamiclib  -exported_symbols_list @gol
709 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
710 -force_flat_namespace  -headerpad_max_install_names @gol
711 -iframework @gol
712 -image_base  -init  -install_name  -keep_private_externs @gol
713 -multi_module  -multiply_defined  -multiply_defined_unused @gol
714 -noall_load   -no_dead_strip_inits_and_terms @gol
715 -nofixprebinding  -nomultidefs  -noprebind  -noseglinkedit @gol
716 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
717 -private_bundle  -read_only_relocs  -sectalign @gol
718 -sectobjectsymbols  -whyload  -seg1addr @gol
719 -sectcreate  -sectobjectsymbols  -sectorder @gol
720 -segaddr  -segs_read_only_addr  -segs_read_write_addr @gol
721 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
722 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
723 -single_module  -static  -sub_library  -sub_umbrella @gol
724 -twolevel_namespace  -umbrella  -undefined @gol
725 -unexported_symbols_list  -weak_reference_mismatches @gol
726 -whatsloaded  -F  -gused  -gfull  -mmacosx-version-min=@var{version} @gol
727 -mkernel  -mone-byte-bool}
729 @emph{DEC Alpha Options}
730 @gccoptlist{-mno-fp-regs  -msoft-float @gol
731 -mieee  -mieee-with-inexact  -mieee-conformant @gol
732 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
733 -mtrap-precision=@var{mode}  -mbuild-constants @gol
734 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
735 -mbwx  -mmax  -mfix  -mcix @gol
736 -mfloat-vax  -mfloat-ieee @gol
737 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
738 -msmall-text  -mlarge-text @gol
739 -mmemory-latency=@var{time}}
741 @emph{FR30 Options}
742 @gccoptlist{-msmall-model  -mno-lsim}
744 @emph{FT32 Options}
745 @gccoptlist{-msim  -mlra  -mnodiv}
747 @emph{FRV Options}
748 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
749 -mhard-float  -msoft-float @gol
750 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
751 -mdouble  -mno-double @gol
752 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
753 -mfdpic  -minline-plt  -mgprel-ro  -multilib-library-pic @gol
754 -mlinked-fp  -mlong-calls  -malign-labels @gol
755 -mlibrary-pic  -macc-4  -macc-8 @gol
756 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
757 -moptimize-membar  -mno-optimize-membar @gol
758 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
759 -mvliw-branch  -mno-vliw-branch @gol
760 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
761 -mno-nested-cond-exec  -mtomcat-stats @gol
762 -mTLS  -mtls @gol
763 -mcpu=@var{cpu}}
765 @emph{GNU/Linux Options}
766 @gccoptlist{-mglibc  -muclibc  -mmusl  -mbionic  -mandroid @gol
767 -tno-android-cc  -tno-android-ld}
769 @emph{H8/300 Options}
770 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr  -mno-exr  -mint32  -malign-300}
772 @emph{HPPA Options}
773 @gccoptlist{-march=@var{architecture-type} @gol
774 -mcaller-copies  -mdisable-fpregs  -mdisable-indexing @gol
775 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
776 -mfixed-range=@var{register-range} @gol
777 -mjump-in-delay  -mlinker-opt  -mlong-calls @gol
778 -mlong-load-store  -mno-disable-fpregs @gol
779 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
780 -mno-jump-in-delay  -mno-long-load-store @gol
781 -mno-portable-runtime  -mno-soft-float @gol
782 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
783 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
784 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
785 -munix=@var{unix-std}  -nolibdld  -static  -threads}
787 @emph{IA-64 Options}
788 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
789 -mvolatile-asm-stop  -mregister-names  -msdata  -mno-sdata @gol
790 -mconstant-gp  -mauto-pic  -mfused-madd @gol
791 -minline-float-divide-min-latency @gol
792 -minline-float-divide-max-throughput @gol
793 -mno-inline-float-divide @gol
794 -minline-int-divide-min-latency @gol
795 -minline-int-divide-max-throughput  @gol
796 -mno-inline-int-divide @gol
797 -minline-sqrt-min-latency  -minline-sqrt-max-throughput @gol
798 -mno-inline-sqrt @gol
799 -mdwarf2-asm  -mearly-stop-bits @gol
800 -mfixed-range=@var{register-range}  -mtls-size=@var{tls-size} @gol
801 -mtune=@var{cpu-type}  -milp32  -mlp64 @gol
802 -msched-br-data-spec  -msched-ar-data-spec  -msched-control-spec @gol
803 -msched-br-in-data-spec  -msched-ar-in-data-spec  -msched-in-control-spec @gol
804 -msched-spec-ldc  -msched-spec-control-ldc @gol
805 -msched-prefer-non-data-spec-insns  -msched-prefer-non-control-spec-insns @gol
806 -msched-stop-bits-after-every-cycle  -msched-count-spec-in-critical-path @gol
807 -msel-sched-dont-check-control-spec  -msched-fp-mem-deps-zero-cost @gol
808 -msched-max-memory-insns-hard-limit  -msched-max-memory-insns=@var{max-insns}}
810 @emph{LM32 Options}
811 @gccoptlist{-mbarrel-shift-enabled  -mdivide-enabled  -mmultiply-enabled @gol
812 -msign-extend-enabled  -muser-enabled}
814 @emph{M32R/D Options}
815 @gccoptlist{-m32r2  -m32rx  -m32r @gol
816 -mdebug @gol
817 -malign-loops  -mno-align-loops @gol
818 -missue-rate=@var{number} @gol
819 -mbranch-cost=@var{number} @gol
820 -mmodel=@var{code-size-model-type} @gol
821 -msdata=@var{sdata-type} @gol
822 -mno-flush-func  -mflush-func=@var{name} @gol
823 -mno-flush-trap  -mflush-trap=@var{number} @gol
824 -G @var{num}}
826 @emph{M32C Options}
827 @gccoptlist{-mcpu=@var{cpu}  -msim  -memregs=@var{number}}
829 @emph{M680x0 Options}
830 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune} @gol
831 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
832 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
833 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
834 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
835 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
836 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
837 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
838 -mxgot  -mno-xgot  -mlong-jump-table-offsets}
840 @emph{MCore Options}
841 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
842 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
843 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
844 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
845 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
847 @emph{MeP Options}
848 @gccoptlist{-mabsdiff  -mall-opts  -maverage  -mbased=@var{n}  -mbitops @gol
849 -mc=@var{n}  -mclip  -mconfig=@var{name}  -mcop  -mcop32  -mcop64  -mivc2 @gol
850 -mdc  -mdiv  -meb  -mel  -mio-volatile  -ml  -mleadz  -mm  -mminmax @gol
851 -mmult  -mno-opts  -mrepeat  -ms  -msatur  -msdram  -msim  -msimnovec  -mtf @gol
852 -mtiny=@var{n}}
854 @emph{MicroBlaze Options}
855 @gccoptlist{-msoft-float  -mhard-float  -msmall-divides  -mcpu=@var{cpu} @gol
856 -mmemcpy  -mxl-soft-mul  -mxl-soft-div  -mxl-barrel-shift @gol
857 -mxl-pattern-compare  -mxl-stack-check  -mxl-gp-opt  -mno-clearbss @gol
858 -mxl-multiply-high  -mxl-float-convert  -mxl-float-sqrt @gol
859 -mbig-endian  -mlittle-endian  -mxl-reorder  -mxl-mode-@var{app-model}}
861 @emph{MIPS Options}
862 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
863 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips32r3  -mips32r5 @gol
864 -mips32r6  -mips64  -mips64r2  -mips64r3  -mips64r5  -mips64r6 @gol
865 -mips16  -mno-mips16  -mflip-mips16 @gol
866 -minterlink-compressed  -mno-interlink-compressed @gol
867 -minterlink-mips16  -mno-interlink-mips16 @gol
868 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
869 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
870 -mgp32  -mgp64  -mfp32  -mfpxx  -mfp64  -mhard-float  -msoft-float @gol
871 -mno-float  -msingle-float  -mdouble-float @gol
872 -modd-spreg  -mno-odd-spreg @gol
873 -mabs=@var{mode}  -mnan=@var{encoding} @gol
874 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
875 -mmcu  -mmno-mcu @gol
876 -meva  -mno-eva @gol
877 -mvirt  -mno-virt @gol
878 -mxpa  -mno-xpa @gol
879 -mmicromips  -mno-micromips @gol
880 -mmsa  -mno-msa @gol
881 -mfpu=@var{fpu-type} @gol
882 -msmartmips  -mno-smartmips @gol
883 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
884 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
885 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
886 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
887 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
888 -membedded-data  -mno-embedded-data @gol
889 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
890 -mcode-readable=@var{setting} @gol
891 -msplit-addresses  -mno-split-addresses @gol
892 -mexplicit-relocs  -mno-explicit-relocs @gol
893 -mcheck-zero-division  -mno-check-zero-division @gol
894 -mdivide-traps  -mdivide-breaks @gol
895 -mload-store-pairs  -mno-load-store-pairs @gol
896 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
897 -mmad  -mno-mad  -mimadd  -mno-imadd  -mfused-madd  -mno-fused-madd  -nocpp @gol
898 -mfix-24k  -mno-fix-24k @gol
899 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
900 -mfix-r10000  -mno-fix-r10000  -mfix-rm7000  -mno-fix-rm7000 @gol
901 -mfix-vr4120  -mno-fix-vr4120 @gol
902 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
903 -mflush-func=@var{func}  -mno-flush-func @gol
904 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
905 -mcompact-branches=@var{policy} @gol
906 -mfp-exceptions  -mno-fp-exceptions @gol
907 -mvr4130-align  -mno-vr4130-align  -msynci  -mno-synci @gol
908 -mlxc1-sxc1 -mno-lxc1-sxc1 -mmadd4 -mno-madd4 @gol
909 -mrelax-pic-calls  -mno-relax-pic-calls  -mmcount-ra-address @gol
910 -mframe-header-opt  -mno-frame-header-opt}
912 @emph{MMIX Options}
913 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
914 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
915 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
916 -mno-base-addresses  -msingle-exit  -mno-single-exit}
918 @emph{MN10300 Options}
919 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
920 -mno-am33  -mam33  -mam33-2  -mam34 @gol
921 -mtune=@var{cpu-type} @gol
922 -mreturn-pointer-on-d0 @gol
923 -mno-crt0  -mrelax  -mliw  -msetlb}
925 @emph{Moxie Options}
926 @gccoptlist{-meb  -mel  -mmul.x  -mno-crt0}
928 @emph{MSP430 Options}
929 @gccoptlist{-msim  -masm-hex  -mmcu=  -mcpu=  -mlarge  -msmall  -mrelax @gol
930 -mwarn-mcu @gol
931 -mcode-region=  -mdata-region= @gol
932 -msilicon-errata=  -msilicon-errata-warn= @gol
933 -mhwmult=  -minrt}
935 @emph{NDS32 Options}
936 @gccoptlist{-mbig-endian  -mlittle-endian @gol
937 -mreduced-regs  -mfull-regs @gol
938 -mcmov  -mno-cmov @gol
939 -mperf-ext  -mno-perf-ext @gol
940 -mv3push  -mno-v3push @gol
941 -m16bit  -mno-16bit @gol
942 -misr-vector-size=@var{num} @gol
943 -mcache-block-size=@var{num} @gol
944 -march=@var{arch} @gol
945 -mcmodel=@var{code-model} @gol
946 -mctor-dtor  -mrelax}
948 @emph{Nios II Options}
949 @gccoptlist{-G @var{num}  -mgpopt=@var{option}  -mgpopt  -mno-gpopt @gol
950 -mel  -meb @gol
951 -mno-bypass-cache  -mbypass-cache @gol
952 -mno-cache-volatile  -mcache-volatile @gol
953 -mno-fast-sw-div  -mfast-sw-div @gol
954 -mhw-mul  -mno-hw-mul  -mhw-mulx  -mno-hw-mulx  -mno-hw-div  -mhw-div @gol
955 -mcustom-@var{insn}=@var{N}  -mno-custom-@var{insn} @gol
956 -mcustom-fpu-cfg=@var{name} @gol
957 -mhal  -msmallc  -msys-crt0=@var{name}  -msys-lib=@var{name} @gol
958 -march=@var{arch}  -mbmx  -mno-bmx  -mcdx  -mno-cdx}
960 @emph{Nvidia PTX Options}
961 @gccoptlist{-m32  -m64  -mmainkernel  -moptimize}
963 @emph{PDP-11 Options}
964 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
965 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
966 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
967 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
968 -mbranch-expensive  -mbranch-cheap @gol
969 -munix-asm  -mdec-asm}
971 @emph{picoChip Options}
972 @gccoptlist{-mae=@var{ae_type}  -mvliw-lookahead=@var{N} @gol
973 -msymbol-as-address  -mno-inefficient-warnings}
975 @emph{PowerPC Options}
976 See RS/6000 and PowerPC Options.
978 @emph{RISC-V Options}
979 @gccoptlist{-mbranch-cost=@var{N-instruction} @gol
980 -mmemcpy  -mno-memcpy @gol
981 -mplt  -mno-plt @gol
982 -mabi=@var{ABI-string} @gol
983 -mfdiv  -mno-fdiv @gol
984 -mdiv  -mno-div @gol
985 -march=@var{ISA-string} @gol
986 -mtune=@var{processor-string} @gol
987 -msmall-data-limit=@var{N-bytes} @gol
988 -msave-restore  -mno-save-restore @gol
989 -mstrict-align -mno-strict-align @gol
990 -mcmodel=@var{code-model} @gol
991 -mexplicit-relocs  -mno-explicit-relocs @gol}
993 @emph{RL78 Options}
994 @gccoptlist{-msim  -mmul=none  -mmul=g13  -mmul=g14  -mallregs @gol
995 -mcpu=g10  -mcpu=g13  -mcpu=g14  -mg10  -mg13  -mg14 @gol
996 -m64bit-doubles  -m32bit-doubles  -msave-mduc-in-interrupts}
998 @emph{RS/6000 and PowerPC Options}
999 @gccoptlist{-mcpu=@var{cpu-type} @gol
1000 -mtune=@var{cpu-type} @gol
1001 -mcmodel=@var{code-model} @gol
1002 -mpowerpc64 @gol
1003 -maltivec  -mno-altivec @gol
1004 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
1005 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
1006 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mpopcntd  -mno-popcntd @gol
1007 -mfprnd  -mno-fprnd @gol
1008 -mcmpb  -mno-cmpb  -mmfpgpr  -mno-mfpgpr  -mhard-dfp  -mno-hard-dfp @gol
1009 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
1010 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
1011 -malign-power  -malign-natural @gol
1012 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
1013 -msingle-float  -mdouble-float  -msimple-fpu @gol
1014 -mstring  -mno-string  -mupdate  -mno-update @gol
1015 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
1016 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
1017 -mstrict-align  -mno-strict-align  -mrelocatable @gol
1018 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
1019 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
1020 -mdynamic-no-pic  -maltivec  -mswdiv  -msingle-pic-base @gol
1021 -mprioritize-restricted-insns=@var{priority} @gol
1022 -msched-costly-dep=@var{dependence_type} @gol
1023 -minsert-sched-nops=@var{scheme} @gol
1024 -mcall-sysv  -mcall-netbsd @gol
1025 -maix-struct-return  -msvr4-struct-return @gol
1026 -mabi=@var{abi-type}  -msecure-plt  -mbss-plt @gol
1027 -mblock-move-inline-limit=@var{num} @gol
1028 -misel  -mno-isel @gol
1029 -misel=yes  -misel=no @gol
1030 -mspe  -mno-spe @gol
1031 -mspe=yes  -mspe=no @gol
1032 -mpaired @gol
1033 -mvrsave  -mno-vrsave @gol
1034 -mmulhw  -mno-mulhw @gol
1035 -mdlmzb  -mno-dlmzb @gol
1036 -mfloat-gprs=yes  -mfloat-gprs=no  -mfloat-gprs=single  -mfloat-gprs=double @gol
1037 -mprototype  -mno-prototype @gol
1038 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
1039 -msdata=@var{opt}  -mvxworks  -G @var{num} @gol
1040 -mrecip  -mrecip=@var{opt}  -mno-recip  -mrecip-precision @gol
1041 -mno-recip-precision @gol
1042 -mveclibabi=@var{type}  -mfriz  -mno-friz @gol
1043 -mpointers-to-nested-functions  -mno-pointers-to-nested-functions @gol
1044 -msave-toc-indirect  -mno-save-toc-indirect @gol
1045 -mpower8-fusion  -mno-mpower8-fusion  -mpower8-vector  -mno-power8-vector @gol
1046 -mcrypto  -mno-crypto  -mhtm  -mno-htm  -mdirect-move  -mno-direct-move @gol
1047 -mquad-memory  -mno-quad-memory @gol
1048 -mquad-memory-atomic  -mno-quad-memory-atomic @gol
1049 -mcompat-align-parm  -mno-compat-align-parm @gol
1050 -mfloat128  -mno-float128  -mfloat128-hardware  -mno-float128-hardware @gol
1051 -mgnu-attribute  -mno-gnu-attribute @gol
1052 -mstack-protector-guard=@var{guard} -mstack-protector-guard-reg=@var{reg} @gol
1053 -mstack-protector-guard-offset=@var{offset}}
1055 @emph{RX Options}
1056 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
1057 -mcpu=@gol
1058 -mbig-endian-data  -mlittle-endian-data @gol
1059 -msmall-data @gol
1060 -msim  -mno-sim@gol
1061 -mas100-syntax  -mno-as100-syntax@gol
1062 -mrelax@gol
1063 -mmax-constant-size=@gol
1064 -mint-register=@gol
1065 -mpid@gol
1066 -mallow-string-insns  -mno-allow-string-insns@gol
1067 -mjsr@gol
1068 -mno-warn-multiple-fast-interrupts@gol
1069 -msave-acc-in-interrupts}
1071 @emph{S/390 and zSeries Options}
1072 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1073 -mhard-float  -msoft-float  -mhard-dfp  -mno-hard-dfp @gol
1074 -mlong-double-64  -mlong-double-128 @gol
1075 -mbackchain  -mno-backchain  -mpacked-stack  -mno-packed-stack @gol
1076 -msmall-exec  -mno-small-exec  -mmvcle  -mno-mvcle @gol
1077 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
1078 -mhtm  -mvx  -mzvector @gol
1079 -mtpf-trace  -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
1080 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size  -mstack-guard @gol
1081 -mhotpatch=@var{halfwords},@var{halfwords}}
1083 @emph{Score Options}
1084 @gccoptlist{-meb  -mel @gol
1085 -mnhwloop @gol
1086 -muls @gol
1087 -mmac @gol
1088 -mscore5  -mscore5u  -mscore7  -mscore7d}
1090 @emph{SH Options}
1091 @gccoptlist{-m1  -m2  -m2e @gol
1092 -m2a-nofpu  -m2a-single-only  -m2a-single  -m2a @gol
1093 -m3  -m3e @gol
1094 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
1095 -m4a-nofpu  -m4a-single-only  -m4a-single  -m4a  -m4al @gol
1096 -mb  -ml  -mdalign  -mrelax @gol
1097 -mbigtable  -mfmovd  -mrenesas  -mno-renesas  -mnomacsave @gol
1098 -mieee  -mno-ieee  -mbitops  -misize  -minline-ic_invalidate  -mpadstruct @gol
1099 -mprefergot  -musermode  -multcost=@var{number}  -mdiv=@var{strategy} @gol
1100 -mdivsi3_libfunc=@var{name}  -mfixed-range=@var{register-range} @gol
1101 -maccumulate-outgoing-args @gol
1102 -matomic-model=@var{atomic-model} @gol
1103 -mbranch-cost=@var{num}  -mzdcbranch  -mno-zdcbranch @gol
1104 -mcbranch-force-delay-slot @gol
1105 -mfused-madd  -mno-fused-madd  -mfsca  -mno-fsca  -mfsrra  -mno-fsrra @gol
1106 -mpretend-cmove  -mtas}
1108 @emph{Solaris 2 Options}
1109 @gccoptlist{-mclear-hwcap  -mno-clear-hwcap  -mimpure-text  -mno-impure-text @gol
1110 -pthreads}
1112 @emph{SPARC Options}
1113 @gccoptlist{-mcpu=@var{cpu-type} @gol
1114 -mtune=@var{cpu-type} @gol
1115 -mcmodel=@var{code-model} @gol
1116 -mmemory-model=@var{mem-model} @gol
1117 -m32  -m64  -mapp-regs  -mno-app-regs @gol
1118 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
1119 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1120 -mhard-quad-float  -msoft-quad-float @gol
1121 -mstack-bias  -mno-stack-bias @gol
1122 -mstd-struct-return  -mno-std-struct-return @gol
1123 -munaligned-doubles  -mno-unaligned-doubles @gol
1124 -muser-mode  -mno-user-mode @gol
1125 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
1126 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
1127 -mvis4 -mno-vis4 -mvis4b -mno-vis4b @gol
1128 -mcbcond  -mno-cbcond  -mfmaf  -mno-fmaf  -mfsmuld  -mno-fsmuld  @gol
1129 -mpopc  -mno-popc  -msubxc  -mno-subxc @gol
1130 -mfix-at697f  -mfix-ut699  -mfix-ut700  -mfix-gr712rc @gol
1131 -mlra  -mno-lra}
1133 @emph{SPU Options}
1134 @gccoptlist{-mwarn-reloc  -merror-reloc @gol
1135 -msafe-dma  -munsafe-dma @gol
1136 -mbranch-hints @gol
1137 -msmall-mem  -mlarge-mem  -mstdmain @gol
1138 -mfixed-range=@var{register-range} @gol
1139 -mea32  -mea64 @gol
1140 -maddress-space-conversion  -mno-address-space-conversion @gol
1141 -mcache-size=@var{cache-size} @gol
1142 -matomic-updates  -mno-atomic-updates}
1144 @emph{System V Options}
1145 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
1147 @emph{TILE-Gx Options}
1148 @gccoptlist{-mcpu=CPU  -m32  -m64  -mbig-endian  -mlittle-endian @gol
1149 -mcmodel=@var{code-model}}
1151 @emph{TILEPro Options}
1152 @gccoptlist{-mcpu=@var{cpu}  -m32}
1154 @emph{V850 Options}
1155 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
1156 -mprolog-function  -mno-prolog-function  -mspace @gol
1157 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
1158 -mapp-regs  -mno-app-regs @gol
1159 -mdisable-callt  -mno-disable-callt @gol
1160 -mv850e2v3  -mv850e2  -mv850e1  -mv850es @gol
1161 -mv850e  -mv850  -mv850e3v5 @gol
1162 -mloop @gol
1163 -mrelax @gol
1164 -mlong-jumps @gol
1165 -msoft-float @gol
1166 -mhard-float @gol
1167 -mgcc-abi @gol
1168 -mrh850-abi @gol
1169 -mbig-switch}
1171 @emph{VAX Options}
1172 @gccoptlist{-mg  -mgnu  -munix}
1174 @emph{Visium Options}
1175 @gccoptlist{-mdebug  -msim  -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1176 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type}  -msv-mode  -muser-mode}
1178 @emph{VMS Options}
1179 @gccoptlist{-mvms-return-codes  -mdebug-main=@var{prefix}  -mmalloc64 @gol
1180 -mpointer-size=@var{size}}
1182 @emph{VxWorks Options}
1183 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1184 -Xbind-lazy  -Xbind-now}
1186 @emph{x86 Options}
1187 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1188 -mtune-ctrl=@var{feature-list}  -mdump-tune-features  -mno-default @gol
1189 -mfpmath=@var{unit} @gol
1190 -masm=@var{dialect}  -mno-fancy-math-387 @gol
1191 -mno-fp-ret-in-387  -m80387  -mhard-float  -msoft-float @gol
1192 -mno-wide-multiply  -mrtd  -malign-double @gol
1193 -mpreferred-stack-boundary=@var{num} @gol
1194 -mincoming-stack-boundary=@var{num} @gol
1195 -mcld  -mcx16  -msahf  -mmovbe  -mcrc32 @gol
1196 -mrecip  -mrecip=@var{opt} @gol
1197 -mvzeroupper  -mprefer-avx128 -mprefer-avx256 @gol
1198 -mmmx  -msse  -msse2  -msse3  -mssse3  -msse4.1  -msse4.2  -msse4  -mavx @gol
1199 -mavx2  -mavx512f  -mavx512pf  -mavx512er  -mavx512cd  -mavx512vl @gol
1200 -mavx512bw  -mavx512dq  -mavx512ifma  -mavx512vbmi  -msha  -maes @gol
1201 -mpclmul  -mfsgsbase  -mrdrnd  -mf16c  -mfma @gol
1202 -mprefetchwt1  -mclflushopt  -mxsavec  -mxsaves @gol
1203 -msse4a  -m3dnow  -m3dnowa  -mpopcnt  -mabm  -mbmi  -mtbm  -mfma4  -mxop @gol
1204 -mlzcnt  -mbmi2  -mfxsr  -mxsave  -mxsaveopt  -mrtm  -mlwp  -mmpx  @gol
1205 -mmwaitx  -mclzero  -mpku  -mthreads @gol
1206 -mms-bitfields  -mno-align-stringops  -minline-all-stringops @gol
1207 -minline-stringops-dynamically  -mstringop-strategy=@var{alg} @gol
1208 -mmemcpy-strategy=@var{strategy}  -mmemset-strategy=@var{strategy} @gol
1209 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
1210 -m96bit-long-double  -mlong-double-64  -mlong-double-80  -mlong-double-128 @gol
1211 -mregparm=@var{num}  -msseregparm @gol
1212 -mveclibabi=@var{type}  -mvect8-ret-in-mem @gol
1213 -mpc32  -mpc64  -mpc80  -mstackrealign @gol
1214 -momit-leaf-frame-pointer  -mno-red-zone  -mno-tls-direct-seg-refs @gol
1215 -mcmodel=@var{code-model}  -mabi=@var{name}  -maddress-mode=@var{mode} @gol
1216 -m32  -m64  -mx32  -m16  -miamcu  -mlarge-data-threshold=@var{num} @gol
1217 -msse2avx  -mfentry  -mrecord-mcount  -mnop-mcount  -m8bit-idiv @gol
1218 -mavx256-split-unaligned-load  -mavx256-split-unaligned-store @gol
1219 -malign-data=@var{type}  -mstack-protector-guard=@var{guard} @gol
1220 -mstack-protector-guard-reg=@var{reg} @gol
1221 -mstack-protector-guard-offset=@var{offset} @gol
1222 -mstack-protector-guard-symbol=@var{symbol} -mmitigate-rop @gol
1223 -mgeneral-regs-only  -mcall-ms2sysv-xlogues}
1225 @emph{x86 Windows Options}
1226 @gccoptlist{-mconsole  -mcygwin  -mno-cygwin  -mdll @gol
1227 -mnop-fun-dllimport  -mthread @gol
1228 -municode  -mwin32  -mwindows  -fno-set-stack-executable}
1230 @emph{Xstormy16 Options}
1231 @gccoptlist{-msim}
1233 @emph{Xtensa Options}
1234 @gccoptlist{-mconst16  -mno-const16 @gol
1235 -mfused-madd  -mno-fused-madd @gol
1236 -mforce-no-pic @gol
1237 -mserialize-volatile  -mno-serialize-volatile @gol
1238 -mtext-section-literals  -mno-text-section-literals @gol
1239 -mauto-litpools  -mno-auto-litpools @gol
1240 -mtarget-align  -mno-target-align @gol
1241 -mlongcalls  -mno-longcalls}
1243 @emph{zSeries Options}
1244 See S/390 and zSeries Options.
1245 @end table
1248 @node Overall Options
1249 @section Options Controlling the Kind of Output
1251 Compilation can involve up to four stages: preprocessing, compilation
1252 proper, assembly and linking, always in that order.  GCC is capable of
1253 preprocessing and compiling several files either into several
1254 assembler input files, or into one assembler input file; then each
1255 assembler input file produces an object file, and linking combines all
1256 the object files (those newly compiled, and those specified as input)
1257 into an executable file.
1259 @cindex file name suffix
1260 For any given input file, the file name suffix determines what kind of
1261 compilation is done:
1263 @table @gcctabopt
1264 @item @var{file}.c
1265 C source code that must be preprocessed.
1267 @item @var{file}.i
1268 C source code that should not be preprocessed.
1270 @item @var{file}.ii
1271 C++ source code that should not be preprocessed.
1273 @item @var{file}.m
1274 Objective-C source code.  Note that you must link with the @file{libobjc}
1275 library to make an Objective-C program work.
1277 @item @var{file}.mi
1278 Objective-C source code that should not be preprocessed.
1280 @item @var{file}.mm
1281 @itemx @var{file}.M
1282 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1283 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1284 to a literal capital M@.
1286 @item @var{file}.mii
1287 Objective-C++ source code that should not be preprocessed.
1289 @item @var{file}.h
1290 C, C++, Objective-C or Objective-C++ header file to be turned into a
1291 precompiled header (default), or C, C++ header file to be turned into an
1292 Ada spec (via the @option{-fdump-ada-spec} switch).
1294 @item @var{file}.cc
1295 @itemx @var{file}.cp
1296 @itemx @var{file}.cxx
1297 @itemx @var{file}.cpp
1298 @itemx @var{file}.CPP
1299 @itemx @var{file}.c++
1300 @itemx @var{file}.C
1301 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1302 the last two letters must both be literally @samp{x}.  Likewise,
1303 @samp{.C} refers to a literal capital C@.
1305 @item @var{file}.mm
1306 @itemx @var{file}.M
1307 Objective-C++ source code that must be preprocessed.
1309 @item @var{file}.mii
1310 Objective-C++ source code that should not be preprocessed.
1312 @item @var{file}.hh
1313 @itemx @var{file}.H
1314 @itemx @var{file}.hp
1315 @itemx @var{file}.hxx
1316 @itemx @var{file}.hpp
1317 @itemx @var{file}.HPP
1318 @itemx @var{file}.h++
1319 @itemx @var{file}.tcc
1320 C++ header file to be turned into a precompiled header or Ada spec.
1322 @item @var{file}.f
1323 @itemx @var{file}.for
1324 @itemx @var{file}.ftn
1325 Fixed form Fortran source code that should not be preprocessed.
1327 @item @var{file}.F
1328 @itemx @var{file}.FOR
1329 @itemx @var{file}.fpp
1330 @itemx @var{file}.FPP
1331 @itemx @var{file}.FTN
1332 Fixed form Fortran source code that must be preprocessed (with the traditional
1333 preprocessor).
1335 @item @var{file}.f90
1336 @itemx @var{file}.f95
1337 @itemx @var{file}.f03
1338 @itemx @var{file}.f08
1339 Free form Fortran source code that should not be preprocessed.
1341 @item @var{file}.F90
1342 @itemx @var{file}.F95
1343 @itemx @var{file}.F03
1344 @itemx @var{file}.F08
1345 Free form Fortran source code that must be preprocessed (with the
1346 traditional preprocessor).
1348 @item @var{file}.go
1349 Go source code.
1351 @item @var{file}.brig
1352 BRIG files (binary representation of HSAIL).
1354 @item @var{file}.ads
1355 Ada source code file that contains a library unit declaration (a
1356 declaration of a package, subprogram, or generic, or a generic
1357 instantiation), or a library unit renaming declaration (a package,
1358 generic, or subprogram renaming declaration).  Such files are also
1359 called @dfn{specs}.
1361 @item @var{file}.adb
1362 Ada source code file containing a library unit body (a subprogram or
1363 package body).  Such files are also called @dfn{bodies}.
1365 @c GCC also knows about some suffixes for languages not yet included:
1366 @c Pascal:
1367 @c @var{file}.p
1368 @c @var{file}.pas
1369 @c Ratfor:
1370 @c @var{file}.r
1372 @item @var{file}.s
1373 Assembler code.
1375 @item @var{file}.S
1376 @itemx @var{file}.sx
1377 Assembler code that must be preprocessed.
1379 @item @var{other}
1380 An object file to be fed straight into linking.
1381 Any file name with no recognized suffix is treated this way.
1382 @end table
1384 @opindex x
1385 You can specify the input language explicitly with the @option{-x} option:
1387 @table @gcctabopt
1388 @item -x @var{language}
1389 Specify explicitly the @var{language} for the following input files
1390 (rather than letting the compiler choose a default based on the file
1391 name suffix).  This option applies to all following input files until
1392 the next @option{-x} option.  Possible values for @var{language} are:
1393 @smallexample
1394 c  c-header  cpp-output
1395 c++  c++-header  c++-cpp-output
1396 objective-c  objective-c-header  objective-c-cpp-output
1397 objective-c++ objective-c++-header objective-c++-cpp-output
1398 assembler  assembler-with-cpp
1400 f77  f77-cpp-input f95  f95-cpp-input
1402 brig
1403 @end smallexample
1405 @item -x none
1406 Turn off any specification of a language, so that subsequent files are
1407 handled according to their file name suffixes (as they are if @option{-x}
1408 has not been used at all).
1409 @end table
1411 If you only want some of the stages of compilation, you can use
1412 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1413 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1414 @command{gcc} is to stop.  Note that some combinations (for example,
1415 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1417 @table @gcctabopt
1418 @item -c
1419 @opindex c
1420 Compile or assemble the source files, but do not link.  The linking
1421 stage simply is not done.  The ultimate output is in the form of an
1422 object file for each source file.
1424 By default, the object file name for a source file is made by replacing
1425 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1427 Unrecognized input files, not requiring compilation or assembly, are
1428 ignored.
1430 @item -S
1431 @opindex S
1432 Stop after the stage of compilation proper; do not assemble.  The output
1433 is in the form of an assembler code file for each non-assembler input
1434 file specified.
1436 By default, the assembler file name for a source file is made by
1437 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1439 Input files that don't require compilation are ignored.
1441 @item -E
1442 @opindex E
1443 Stop after the preprocessing stage; do not run the compiler proper.  The
1444 output is in the form of preprocessed source code, which is sent to the
1445 standard output.
1447 Input files that don't require preprocessing are ignored.
1449 @cindex output file option
1450 @item -o @var{file}
1451 @opindex o
1452 Place output in file @var{file}.  This applies to whatever
1453 sort of output is being produced, whether it be an executable file,
1454 an object file, an assembler file or preprocessed C code.
1456 If @option{-o} is not specified, the default is to put an executable
1457 file in @file{a.out}, the object file for
1458 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1459 assembler file in @file{@var{source}.s}, a precompiled header file in
1460 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1461 standard output.
1463 @item -v
1464 @opindex v
1465 Print (on standard error output) the commands executed to run the stages
1466 of compilation.  Also print the version number of the compiler driver
1467 program and of the preprocessor and the compiler proper.
1469 @item -###
1470 @opindex ###
1471 Like @option{-v} except the commands are not executed and arguments
1472 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1473 This is useful for shell scripts to capture the driver-generated command lines.
1475 @item --help
1476 @opindex help
1477 Print (on the standard output) a description of the command-line options
1478 understood by @command{gcc}.  If the @option{-v} option is also specified
1479 then @option{--help} is also passed on to the various processes
1480 invoked by @command{gcc}, so that they can display the command-line options
1481 they accept.  If the @option{-Wextra} option has also been specified
1482 (prior to the @option{--help} option), then command-line options that
1483 have no documentation associated with them are also displayed.
1485 @item --target-help
1486 @opindex target-help
1487 Print (on the standard output) a description of target-specific command-line
1488 options for each tool.  For some targets extra target-specific
1489 information may also be printed.
1491 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1492 Print (on the standard output) a description of the command-line
1493 options understood by the compiler that fit into all specified classes
1494 and qualifiers.  These are the supported classes:
1496 @table @asis
1497 @item @samp{optimizers}
1498 Display all of the optimization options supported by the
1499 compiler.
1501 @item @samp{warnings}
1502 Display all of the options controlling warning messages
1503 produced by the compiler.
1505 @item @samp{target}
1506 Display target-specific options.  Unlike the
1507 @option{--target-help} option however, target-specific options of the
1508 linker and assembler are not displayed.  This is because those
1509 tools do not currently support the extended @option{--help=} syntax.
1511 @item @samp{params}
1512 Display the values recognized by the @option{--param}
1513 option.
1515 @item @var{language}
1516 Display the options supported for @var{language}, where
1517 @var{language} is the name of one of the languages supported in this
1518 version of GCC@.
1520 @item @samp{common}
1521 Display the options that are common to all languages.
1522 @end table
1524 These are the supported qualifiers:
1526 @table @asis
1527 @item @samp{undocumented}
1528 Display only those options that are undocumented.
1530 @item @samp{joined}
1531 Display options taking an argument that appears after an equal
1532 sign in the same continuous piece of text, such as:
1533 @samp{--help=target}.
1535 @item @samp{separate}
1536 Display options taking an argument that appears as a separate word
1537 following the original option, such as: @samp{-o output-file}.
1538 @end table
1540 Thus for example to display all the undocumented target-specific
1541 switches supported by the compiler, use:
1543 @smallexample
1544 --help=target,undocumented
1545 @end smallexample
1547 The sense of a qualifier can be inverted by prefixing it with the
1548 @samp{^} character, so for example to display all binary warning
1549 options (i.e., ones that are either on or off and that do not take an
1550 argument) that have a description, use:
1552 @smallexample
1553 --help=warnings,^joined,^undocumented
1554 @end smallexample
1556 The argument to @option{--help=} should not consist solely of inverted
1557 qualifiers.
1559 Combining several classes is possible, although this usually
1560 restricts the output so much that there is nothing to display.  One
1561 case where it does work, however, is when one of the classes is
1562 @var{target}.  For example, to display all the target-specific
1563 optimization options, use:
1565 @smallexample
1566 --help=target,optimizers
1567 @end smallexample
1569 The @option{--help=} option can be repeated on the command line.  Each
1570 successive use displays its requested class of options, skipping
1571 those that have already been displayed.
1573 If the @option{-Q} option appears on the command line before the
1574 @option{--help=} option, then the descriptive text displayed by
1575 @option{--help=} is changed.  Instead of describing the displayed
1576 options, an indication is given as to whether the option is enabled,
1577 disabled or set to a specific value (assuming that the compiler
1578 knows this at the point where the @option{--help=} option is used).
1580 Here is a truncated example from the ARM port of @command{gcc}:
1582 @smallexample
1583   % gcc -Q -mabi=2 --help=target -c
1584   The following options are target specific:
1585   -mabi=                                2
1586   -mabort-on-noreturn                   [disabled]
1587   -mapcs                                [disabled]
1588 @end smallexample
1590 The output is sensitive to the effects of previous command-line
1591 options, so for example it is possible to find out which optimizations
1592 are enabled at @option{-O2} by using:
1594 @smallexample
1595 -Q -O2 --help=optimizers
1596 @end smallexample
1598 Alternatively you can discover which binary optimizations are enabled
1599 by @option{-O3} by using:
1601 @smallexample
1602 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1603 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1604 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1605 @end smallexample
1607 @item --version
1608 @opindex version
1609 Display the version number and copyrights of the invoked GCC@.
1611 @item -pass-exit-codes
1612 @opindex pass-exit-codes
1613 Normally the @command{gcc} program exits with the code of 1 if any
1614 phase of the compiler returns a non-success return code.  If you specify
1615 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1616 the numerically highest error produced by any phase returning an error
1617 indication.  The C, C++, and Fortran front ends return 4 if an internal
1618 compiler error is encountered.
1620 @item -pipe
1621 @opindex pipe
1622 Use pipes rather than temporary files for communication between the
1623 various stages of compilation.  This fails to work on some systems where
1624 the assembler is unable to read from a pipe; but the GNU assembler has
1625 no trouble.
1627 @item -specs=@var{file}
1628 @opindex specs
1629 Process @var{file} after the compiler reads in the standard @file{specs}
1630 file, in order to override the defaults which the @command{gcc} driver
1631 program uses when determining what switches to pass to @command{cc1},
1632 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
1633 @option{-specs=@var{file}} can be specified on the command line, and they
1634 are processed in order, from left to right.  @xref{Spec Files}, for
1635 information about the format of the @var{file}.
1637 @item -wrapper
1638 @opindex wrapper
1639 Invoke all subcommands under a wrapper program.  The name of the
1640 wrapper program and its parameters are passed as a comma separated
1641 list.
1643 @smallexample
1644 gcc -c t.c -wrapper gdb,--args
1645 @end smallexample
1647 @noindent
1648 This invokes all subprograms of @command{gcc} under
1649 @samp{gdb --args}, thus the invocation of @command{cc1} is
1650 @samp{gdb --args cc1 @dots{}}.
1652 @item -fplugin=@var{name}.so
1653 @opindex fplugin
1654 Load the plugin code in file @var{name}.so, assumed to be a
1655 shared object to be dlopen'd by the compiler.  The base name of
1656 the shared object file is used to identify the plugin for the
1657 purposes of argument parsing (See
1658 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1659 Each plugin should define the callback functions specified in the
1660 Plugins API.
1662 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1663 @opindex fplugin-arg
1664 Define an argument called @var{key} with a value of @var{value}
1665 for the plugin called @var{name}.
1667 @item -fdump-ada-spec@r{[}-slim@r{]}
1668 @opindex fdump-ada-spec
1669 For C and C++ source and include files, generate corresponding Ada specs.
1670 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1671 GNAT User's Guide}, which provides detailed documentation on this feature.
1673 @item -fada-spec-parent=@var{unit}
1674 @opindex fada-spec-parent
1675 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1676 Ada specs as child units of parent @var{unit}.
1678 @item -fdump-go-spec=@var{file}
1679 @opindex fdump-go-spec
1680 For input files in any language, generate corresponding Go
1681 declarations in @var{file}.  This generates Go @code{const},
1682 @code{type}, @code{var}, and @code{func} declarations which may be a
1683 useful way to start writing a Go interface to code written in some
1684 other language.
1686 @include @value{srcdir}/../libiberty/at-file.texi
1687 @end table
1689 @node Invoking G++
1690 @section Compiling C++ Programs
1692 @cindex suffixes for C++ source
1693 @cindex C++ source file suffixes
1694 C++ source files conventionally use one of the suffixes @samp{.C},
1695 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1696 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1697 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1698 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1699 files with these names and compiles them as C++ programs even if you
1700 call the compiler the same way as for compiling C programs (usually
1701 with the name @command{gcc}).
1703 @findex g++
1704 @findex c++
1705 However, the use of @command{gcc} does not add the C++ library.
1706 @command{g++} is a program that calls GCC and automatically specifies linking
1707 against the C++ library.  It treats @samp{.c},
1708 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1709 files unless @option{-x} is used.  This program is also useful when
1710 precompiling a C header file with a @samp{.h} extension for use in C++
1711 compilations.  On many systems, @command{g++} is also installed with
1712 the name @command{c++}.
1714 @cindex invoking @command{g++}
1715 When you compile C++ programs, you may specify many of the same
1716 command-line options that you use for compiling programs in any
1717 language; or command-line options meaningful for C and related
1718 languages; or options that are meaningful only for C++ programs.
1719 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1720 explanations of options for languages related to C@.
1721 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1722 explanations of options that are meaningful only for C++ programs.
1724 @node C Dialect Options
1725 @section Options Controlling C Dialect
1726 @cindex dialect options
1727 @cindex language dialect options
1728 @cindex options, dialect
1730 The following options control the dialect of C (or languages derived
1731 from C, such as C++, Objective-C and Objective-C++) that the compiler
1732 accepts:
1734 @table @gcctabopt
1735 @cindex ANSI support
1736 @cindex ISO support
1737 @item -ansi
1738 @opindex ansi
1739 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1740 equivalent to @option{-std=c++98}.
1742 This turns off certain features of GCC that are incompatible with ISO
1743 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1744 such as the @code{asm} and @code{typeof} keywords, and
1745 predefined macros such as @code{unix} and @code{vax} that identify the
1746 type of system you are using.  It also enables the undesirable and
1747 rarely used ISO trigraph feature.  For the C compiler,
1748 it disables recognition of C++ style @samp{//} comments as well as
1749 the @code{inline} keyword.
1751 The alternate keywords @code{__asm__}, @code{__extension__},
1752 @code{__inline__} and @code{__typeof__} continue to work despite
1753 @option{-ansi}.  You would not want to use them in an ISO C program, of
1754 course, but it is useful to put them in header files that might be included
1755 in compilations done with @option{-ansi}.  Alternate predefined macros
1756 such as @code{__unix__} and @code{__vax__} are also available, with or
1757 without @option{-ansi}.
1759 The @option{-ansi} option does not cause non-ISO programs to be
1760 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1761 addition to @option{-ansi}.  @xref{Warning Options}.
1763 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1764 option is used.  Some header files may notice this macro and refrain
1765 from declaring certain functions or defining certain macros that the
1766 ISO standard doesn't call for; this is to avoid interfering with any
1767 programs that might use these names for other things.
1769 Functions that are normally built in but do not have semantics
1770 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1771 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1772 built-in functions provided by GCC}, for details of the functions
1773 affected.
1775 @item -std=
1776 @opindex std
1777 Determine the language standard. @xref{Standards,,Language Standards
1778 Supported by GCC}, for details of these standard versions.  This option
1779 is currently only supported when compiling C or C++.
1781 The compiler can accept several base standards, such as @samp{c90} or
1782 @samp{c++98}, and GNU dialects of those standards, such as
1783 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1784 compiler accepts all programs following that standard plus those
1785 using GNU extensions that do not contradict it.  For example,
1786 @option{-std=c90} turns off certain features of GCC that are
1787 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1788 keywords, but not other GNU extensions that do not have a meaning in
1789 ISO C90, such as omitting the middle term of a @code{?:}
1790 expression. On the other hand, when a GNU dialect of a standard is
1791 specified, all features supported by the compiler are enabled, even when
1792 those features change the meaning of the base standard.  As a result, some
1793 strict-conforming programs may be rejected.  The particular standard
1794 is used by @option{-Wpedantic} to identify which features are GNU
1795 extensions given that version of the standard. For example
1796 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1797 comments, while @option{-std=gnu99 -Wpedantic} does not.
1799 A value for this option must be provided; possible values are
1801 @table @samp
1802 @item c90
1803 @itemx c89
1804 @itemx iso9899:1990
1805 Support all ISO C90 programs (certain GNU extensions that conflict
1806 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1808 @item iso9899:199409
1809 ISO C90 as modified in amendment 1.
1811 @item c99
1812 @itemx c9x
1813 @itemx iso9899:1999
1814 @itemx iso9899:199x
1815 ISO C99.  This standard is substantially completely supported, modulo
1816 bugs and floating-point issues
1817 (mainly but not entirely relating to optional C99 features from
1818 Annexes F and G).  See
1819 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1820 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1822 @item c11
1823 @itemx c1x
1824 @itemx iso9899:2011
1825 ISO C11, the 2011 revision of the ISO C standard.  This standard is
1826 substantially completely supported, modulo bugs, floating-point issues
1827 (mainly but not entirely relating to optional C11 features from
1828 Annexes F and G) and the optional Annexes K (Bounds-checking
1829 interfaces) and L (Analyzability).  The name @samp{c1x} is deprecated.
1831 @item gnu90
1832 @itemx gnu89
1833 GNU dialect of ISO C90 (including some C99 features).
1835 @item gnu99
1836 @itemx gnu9x
1837 GNU dialect of ISO C99.  The name @samp{gnu9x} is deprecated.
1839 @item gnu11
1840 @itemx gnu1x
1841 GNU dialect of ISO C11.  This is the default for C code.
1842 The name @samp{gnu1x} is deprecated.
1844 @item c++98
1845 @itemx c++03
1846 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1847 additional defect reports. Same as @option{-ansi} for C++ code.
1849 @item gnu++98
1850 @itemx gnu++03
1851 GNU dialect of @option{-std=c++98}.
1853 @item c++11
1854 @itemx c++0x
1855 The 2011 ISO C++ standard plus amendments.
1856 The name @samp{c++0x} is deprecated.
1858 @item gnu++11
1859 @itemx gnu++0x
1860 GNU dialect of @option{-std=c++11}.
1861 The name @samp{gnu++0x} is deprecated.
1863 @item c++14
1864 @itemx c++1y
1865 The 2014 ISO C++ standard plus amendments.
1866 The name @samp{c++1y} is deprecated.
1868 @item gnu++14
1869 @itemx gnu++1y
1870 GNU dialect of @option{-std=c++14}.
1871 This is the default for C++ code.
1872 The name @samp{gnu++1y} is deprecated.
1874 @item c++17
1875 @itemx c++1z
1876 The 2017 ISO C++ standard plus amendments.
1877 The name @samp{c++1z} is deprecated.
1879 @item gnu++17
1880 @itemx gnu++1z
1881 GNU dialect of @option{-std=c++17}.
1882 The name @samp{gnu++1z} is deprecated.
1884 @item c++2a
1885 The next revision of the ISO C++ standard, tentatively planned for
1886 2020.  Support is highly experimental, and will almost certainly
1887 change in incompatible ways in future releases.
1889 @item gnu++2a
1890 GNU dialect of @option{-std=c++2a}.  Support is highly experimental,
1891 and will almost certainly change in incompatible ways in future
1892 releases.
1893 @end table
1895 @item -fgnu89-inline
1896 @opindex fgnu89-inline
1897 The option @option{-fgnu89-inline} tells GCC to use the traditional
1898 GNU semantics for @code{inline} functions when in C99 mode.
1899 @xref{Inline,,An Inline Function is As Fast As a Macro}.
1900 Using this option is roughly equivalent to adding the
1901 @code{gnu_inline} function attribute to all inline functions
1902 (@pxref{Function Attributes}).
1904 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1905 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1906 specifies the default behavior).
1907 This option is not supported in @option{-std=c90} or
1908 @option{-std=gnu90} mode.
1910 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1911 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1912 in effect for @code{inline} functions.  @xref{Common Predefined
1913 Macros,,,cpp,The C Preprocessor}.
1915 @item -fpermitted-flt-eval-methods=@var{style}
1916 @opindex fpermitted-flt-eval-methods
1917 @opindex fpermitted-flt-eval-methods=c11
1918 @opindex fpermitted-flt-eval-methods=ts-18661-3
1919 ISO/IEC TS 18661-3 defines new permissible values for
1920 @code{FLT_EVAL_METHOD} that indicate that operations and constants with
1921 a semantic type that is an interchange or extended format should be
1922 evaluated to the precision and range of that type.  These new values are
1923 a superset of those permitted under C99/C11, which does not specify the
1924 meaning of other positive values of @code{FLT_EVAL_METHOD}.  As such, code
1925 conforming to C11 may not have been written expecting the possibility of
1926 the new values.
1928 @option{-fpermitted-flt-eval-methods} specifies whether the compiler
1929 should allow only the values of @code{FLT_EVAL_METHOD} specified in C99/C11,
1930 or the extended set of values specified in ISO/IEC TS 18661-3.
1932 @var{style} is either @code{c11} or @code{ts-18661-3} as appropriate.
1934 The default when in a standards compliant mode (@option{-std=c11} or similar)
1935 is @option{-fpermitted-flt-eval-methods=c11}.  The default when in a GNU
1936 dialect (@option{-std=gnu11} or similar) is
1937 @option{-fpermitted-flt-eval-methods=ts-18661-3}.
1939 @item -aux-info @var{filename}
1940 @opindex aux-info
1941 Output to the given filename prototyped declarations for all functions
1942 declared and/or defined in a translation unit, including those in header
1943 files.  This option is silently ignored in any language other than C@.
1945 Besides declarations, the file indicates, in comments, the origin of
1946 each declaration (source file and line), whether the declaration was
1947 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1948 @samp{O} for old, respectively, in the first character after the line
1949 number and the colon), and whether it came from a declaration or a
1950 definition (@samp{C} or @samp{F}, respectively, in the following
1951 character).  In the case of function definitions, a K&R-style list of
1952 arguments followed by their declarations is also provided, inside
1953 comments, after the declaration.
1955 @item -fallow-parameterless-variadic-functions
1956 @opindex fallow-parameterless-variadic-functions
1957 Accept variadic functions without named parameters.
1959 Although it is possible to define such a function, this is not very
1960 useful as it is not possible to read the arguments.  This is only
1961 supported for C as this construct is allowed by C++.
1963 @item -fno-asm
1964 @opindex fno-asm
1965 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1966 keyword, so that code can use these words as identifiers.  You can use
1967 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1968 instead.  @option{-ansi} implies @option{-fno-asm}.
1970 In C++, this switch only affects the @code{typeof} keyword, since
1971 @code{asm} and @code{inline} are standard keywords.  You may want to
1972 use the @option{-fno-gnu-keywords} flag instead, which has the same
1973 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1974 switch only affects the @code{asm} and @code{typeof} keywords, since
1975 @code{inline} is a standard keyword in ISO C99.
1977 @item -fno-builtin
1978 @itemx -fno-builtin-@var{function}
1979 @opindex fno-builtin
1980 @cindex built-in functions
1981 Don't recognize built-in functions that do not begin with
1982 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1983 functions provided by GCC}, for details of the functions affected,
1984 including those which are not built-in functions when @option{-ansi} or
1985 @option{-std} options for strict ISO C conformance are used because they
1986 do not have an ISO standard meaning.
1988 GCC normally generates special code to handle certain built-in functions
1989 more efficiently; for instance, calls to @code{alloca} may become single
1990 instructions which adjust the stack directly, and calls to @code{memcpy}
1991 may become inline copy loops.  The resulting code is often both smaller
1992 and faster, but since the function calls no longer appear as such, you
1993 cannot set a breakpoint on those calls, nor can you change the behavior
1994 of the functions by linking with a different library.  In addition,
1995 when a function is recognized as a built-in function, GCC may use
1996 information about that function to warn about problems with calls to
1997 that function, or to generate more efficient code, even if the
1998 resulting code still contains calls to that function.  For example,
1999 warnings are given with @option{-Wformat} for bad calls to
2000 @code{printf} when @code{printf} is built in and @code{strlen} is
2001 known not to modify global memory.
2003 With the @option{-fno-builtin-@var{function}} option
2004 only the built-in function @var{function} is
2005 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
2006 function is named that is not built-in in this version of GCC, this
2007 option is ignored.  There is no corresponding
2008 @option{-fbuiltin-@var{function}} option; if you wish to enable
2009 built-in functions selectively when using @option{-fno-builtin} or
2010 @option{-ffreestanding}, you may define macros such as:
2012 @smallexample
2013 #define abs(n)          __builtin_abs ((n))
2014 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
2015 @end smallexample
2017 @item -fgimple
2018 @opindex fgimple
2020 Enable parsing of function definitions marked with @code{__GIMPLE}.
2021 This is an experimental feature that allows unit testing of GIMPLE
2022 passes.
2024 @item -fhosted
2025 @opindex fhosted
2026 @cindex hosted environment
2028 Assert that compilation targets a hosted environment.  This implies
2029 @option{-fbuiltin}.  A hosted environment is one in which the
2030 entire standard library is available, and in which @code{main} has a return
2031 type of @code{int}.  Examples are nearly everything except a kernel.
2032 This is equivalent to @option{-fno-freestanding}.
2034 @item -ffreestanding
2035 @opindex ffreestanding
2036 @cindex hosted environment
2038 Assert that compilation targets a freestanding environment.  This
2039 implies @option{-fno-builtin}.  A freestanding environment
2040 is one in which the standard library may not exist, and program startup may
2041 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
2042 This is equivalent to @option{-fno-hosted}.
2044 @xref{Standards,,Language Standards Supported by GCC}, for details of
2045 freestanding and hosted environments.
2047 @item -fopenacc
2048 @opindex fopenacc
2049 @cindex OpenACC accelerator programming
2050 Enable handling of OpenACC directives @code{#pragma acc} in C/C++ and
2051 @code{!$acc} in Fortran.  When @option{-fopenacc} is specified, the
2052 compiler generates accelerated code according to the OpenACC Application
2053 Programming Interface v2.0 @w{@uref{https://www.openacc.org}}.  This option
2054 implies @option{-pthread}, and thus is only supported on targets that
2055 have support for @option{-pthread}.
2057 @item -fopenacc-dim=@var{geom}
2058 @opindex fopenacc-dim
2059 @cindex OpenACC accelerator programming
2060 Specify default compute dimensions for parallel offload regions that do
2061 not explicitly specify.  The @var{geom} value is a triple of
2062 ':'-separated sizes, in order 'gang', 'worker' and, 'vector'.  A size
2063 can be omitted, to use a target-specific default value.
2065 @item -fopenmp
2066 @opindex fopenmp
2067 @cindex OpenMP parallel
2068 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
2069 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
2070 compiler generates parallel code according to the OpenMP Application
2071 Program Interface v4.5 @w{@uref{http://www.openmp.org/}}.  This option
2072 implies @option{-pthread}, and thus is only supported on targets that
2073 have support for @option{-pthread}. @option{-fopenmp} implies
2074 @option{-fopenmp-simd}.
2076 @item -fopenmp-simd
2077 @opindex fopenmp-simd
2078 @cindex OpenMP SIMD
2079 @cindex SIMD
2080 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
2081 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
2082 are ignored.
2084 @item -fcilkplus
2085 @opindex fcilkplus
2086 @cindex Enable Cilk Plus
2087 Enable the usage of Cilk Plus language extension features for C/C++.
2088 When the option @option{-fcilkplus} is specified, enable the usage of
2089 the Cilk Plus Language extension features for C/C++.  The present
2090 implementation follows ABI version 1.2.  This is an experimental
2091 feature that is only partially complete, and whose interface may
2092 change in future versions of GCC as the official specification
2093 changes.  Currently, all features but @code{_Cilk_for} have been
2094 implemented.
2096 @item -fgnu-tm
2097 @opindex fgnu-tm
2098 When the option @option{-fgnu-tm} is specified, the compiler
2099 generates code for the Linux variant of Intel's current Transactional
2100 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
2101 an experimental feature whose interface may change in future versions
2102 of GCC, as the official specification changes.  Please note that not
2103 all architectures are supported for this feature.
2105 For more information on GCC's support for transactional memory,
2106 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
2107 Transactional Memory Library}.
2109 Note that the transactional memory feature is not supported with
2110 non-call exceptions (@option{-fnon-call-exceptions}).
2112 @item -fms-extensions
2113 @opindex fms-extensions
2114 Accept some non-standard constructs used in Microsoft header files.
2116 In C++ code, this allows member names in structures to be similar
2117 to previous types declarations.
2119 @smallexample
2120 typedef int UOW;
2121 struct ABC @{
2122   UOW UOW;
2124 @end smallexample
2126 Some cases of unnamed fields in structures and unions are only
2127 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
2128 fields within structs/unions}, for details.
2130 Note that this option is off for all targets but x86 
2131 targets using ms-abi.
2133 @item -fplan9-extensions
2134 @opindex fplan9-extensions
2135 Accept some non-standard constructs used in Plan 9 code.
2137 This enables @option{-fms-extensions}, permits passing pointers to
2138 structures with anonymous fields to functions that expect pointers to
2139 elements of the type of the field, and permits referring to anonymous
2140 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
2141 struct/union fields within structs/unions}, for details.  This is only
2142 supported for C, not C++.
2144 @item -fcond-mismatch
2145 @opindex fcond-mismatch
2146 Allow conditional expressions with mismatched types in the second and
2147 third arguments.  The value of such an expression is void.  This option
2148 is not supported for C++.
2150 @item -flax-vector-conversions
2151 @opindex flax-vector-conversions
2152 Allow implicit conversions between vectors with differing numbers of
2153 elements and/or incompatible element types.  This option should not be
2154 used for new code.
2156 @item -funsigned-char
2157 @opindex funsigned-char
2158 Let the type @code{char} be unsigned, like @code{unsigned char}.
2160 Each kind of machine has a default for what @code{char} should
2161 be.  It is either like @code{unsigned char} by default or like
2162 @code{signed char} by default.
2164 Ideally, a portable program should always use @code{signed char} or
2165 @code{unsigned char} when it depends on the signedness of an object.
2166 But many programs have been written to use plain @code{char} and
2167 expect it to be signed, or expect it to be unsigned, depending on the
2168 machines they were written for.  This option, and its inverse, let you
2169 make such a program work with the opposite default.
2171 The type @code{char} is always a distinct type from each of
2172 @code{signed char} or @code{unsigned char}, even though its behavior
2173 is always just like one of those two.
2175 @item -fsigned-char
2176 @opindex fsigned-char
2177 Let the type @code{char} be signed, like @code{signed char}.
2179 Note that this is equivalent to @option{-fno-unsigned-char}, which is
2180 the negative form of @option{-funsigned-char}.  Likewise, the option
2181 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
2183 @item -fsigned-bitfields
2184 @itemx -funsigned-bitfields
2185 @itemx -fno-signed-bitfields
2186 @itemx -fno-unsigned-bitfields
2187 @opindex fsigned-bitfields
2188 @opindex funsigned-bitfields
2189 @opindex fno-signed-bitfields
2190 @opindex fno-unsigned-bitfields
2191 These options control whether a bit-field is signed or unsigned, when the
2192 declaration does not use either @code{signed} or @code{unsigned}.  By
2193 default, such a bit-field is signed, because this is consistent: the
2194 basic integer types such as @code{int} are signed types.
2196 @item -fsso-struct=@var{endianness}
2197 @opindex fsso-struct
2198 Set the default scalar storage order of structures and unions to the
2199 specified endianness.  The accepted values are @samp{big-endian},
2200 @samp{little-endian} and @samp{native} for the native endianness of
2201 the target (the default).  This option is not supported for C++.
2203 @strong{Warning:} the @option{-fsso-struct} switch causes GCC to generate
2204 code that is not binary compatible with code generated without it if the
2205 specified endianness is not the native endianness of the target.
2206 @end table
2208 @node C++ Dialect Options
2209 @section Options Controlling C++ Dialect
2211 @cindex compiler options, C++
2212 @cindex C++ options, command-line
2213 @cindex options, C++
2214 This section describes the command-line options that are only meaningful
2215 for C++ programs.  You can also use most of the GNU compiler options
2216 regardless of what language your program is in.  For example, you
2217 might compile a file @file{firstClass.C} like this:
2219 @smallexample
2220 g++ -g -fstrict-enums -O -c firstClass.C
2221 @end smallexample
2223 @noindent
2224 In this example, only @option{-fstrict-enums} is an option meant
2225 only for C++ programs; you can use the other options with any
2226 language supported by GCC@.
2228 Some options for compiling C programs, such as @option{-std}, are also
2229 relevant for C++ programs.
2230 @xref{C Dialect Options,,Options Controlling C Dialect}.
2232 Here is a list of options that are @emph{only} for compiling C++ programs:
2234 @table @gcctabopt
2236 @item -fabi-version=@var{n}
2237 @opindex fabi-version
2238 Use version @var{n} of the C++ ABI@.  The default is version 0.
2240 Version 0 refers to the version conforming most closely to
2241 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2242 will change in different versions of G++ as ABI bugs are fixed.
2244 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.
2246 Version 2 is the version of the C++ ABI that first appeared in G++
2247 3.4, and was the default through G++ 4.9.
2249 Version 3 corrects an error in mangling a constant address as a
2250 template argument.
2252 Version 4, which first appeared in G++ 4.5, implements a standard
2253 mangling for vector types.
2255 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2256 attribute const/volatile on function pointer types, decltype of a
2257 plain decl, and use of a function parameter in the declaration of
2258 another parameter.
2260 Version 6, which first appeared in G++ 4.7, corrects the promotion
2261 behavior of C++11 scoped enums and the mangling of template argument
2262 packs, const/static_cast, prefix ++ and --, and a class scope function
2263 used as a template argument.
2265 Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a
2266 builtin type and corrects the mangling of lambdas in default argument
2267 scope.
2269 Version 8, which first appeared in G++ 4.9, corrects the substitution
2270 behavior of function types with function-cv-qualifiers.
2272 Version 9, which first appeared in G++ 5.2, corrects the alignment of
2273 @code{nullptr_t}.
2275 Version 10, which first appeared in G++ 6.1, adds mangling of
2276 attributes that affect type identity, such as ia32 calling convention
2277 attributes (e.g. @samp{stdcall}).
2279 Version 11, which first appeared in G++ 7, corrects the mangling of
2280 sizeof... expressions and operator names.  For multiple entities with
2281 the same name within a function, that are declared in different scopes,
2282 the mangling now changes starting with the twelfth occurrence.  It also
2283 implies @option{-fnew-inheriting-ctors}.
2285 See also @option{-Wabi}.
2287 @item -fabi-compat-version=@var{n}
2288 @opindex fabi-compat-version
2289 On targets that support strong aliases, G++
2290 works around mangling changes by creating an alias with the correct
2291 mangled name when defining a symbol with an incorrect mangled name.
2292 This switch specifies which ABI version to use for the alias.
2294 With @option{-fabi-version=0} (the default), this defaults to 8 (GCC 5
2295 compatibility).  If another ABI version is explicitly selected, this
2296 defaults to 0.  For compatibility with GCC versions 3.2 through 4.9,
2297 use @option{-fabi-compat-version=2}.
2299 If this option is not provided but @option{-Wabi=@var{n}} is, that
2300 version is used for compatibility aliases.  If this option is provided
2301 along with @option{-Wabi} (without the version), the version from this
2302 option is used for the warning.
2304 @item -fno-access-control
2305 @opindex fno-access-control
2306 Turn off all access checking.  This switch is mainly useful for working
2307 around bugs in the access control code.
2309 @item -faligned-new
2310 @opindex faligned-new
2311 Enable support for C++17 @code{new} of types that require more
2312 alignment than @code{void* ::operator new(std::size_t)} provides.  A
2313 numeric argument such as @code{-faligned-new=32} can be used to
2314 specify how much alignment (in bytes) is provided by that function,
2315 but few users will need to override the default of
2316 @code{alignof(std::max_align_t)}.
2318 This flag is enabled by default for @option{-std=c++17}.
2320 @item -fcheck-new
2321 @opindex fcheck-new
2322 Check that the pointer returned by @code{operator new} is non-null
2323 before attempting to modify the storage allocated.  This check is
2324 normally unnecessary because the C++ standard specifies that
2325 @code{operator new} only returns @code{0} if it is declared
2326 @code{throw()}, in which case the compiler always checks the
2327 return value even without this option.  In all other cases, when
2328 @code{operator new} has a non-empty exception specification, memory
2329 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2330 @samp{new (nothrow)}.
2332 @item -fconcepts
2333 @opindex fconcepts
2334 Enable support for the C++ Extensions for Concepts Technical
2335 Specification, ISO 19217 (2015), which allows code like
2337 @smallexample
2338 template <class T> concept bool Addable = requires (T t) @{ t + t; @};
2339 template <Addable T> T add (T a, T b) @{ return a + b; @}
2340 @end smallexample
2342 @item -fconstexpr-depth=@var{n}
2343 @opindex fconstexpr-depth
2344 Set the maximum nested evaluation depth for C++11 constexpr functions
2345 to @var{n}.  A limit is needed to detect endless recursion during
2346 constant expression evaluation.  The minimum specified by the standard
2347 is 512.
2349 @item -fconstexpr-loop-limit=@var{n}
2350 @opindex fconstexpr-loop-limit
2351 Set the maximum number of iterations for a loop in C++14 constexpr functions
2352 to @var{n}.  A limit is needed to detect infinite loops during
2353 constant expression evaluation.  The default is 262144 (1<<18).
2355 @item -fdeduce-init-list
2356 @opindex fdeduce-init-list
2357 Enable deduction of a template type parameter as
2358 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2360 @smallexample
2361 template <class T> auto forward(T t) -> decltype (realfn (t))
2363   return realfn (t);
2366 void f()
2368   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2370 @end smallexample
2372 This deduction was implemented as a possible extension to the
2373 originally proposed semantics for the C++11 standard, but was not part
2374 of the final standard, so it is disabled by default.  This option is
2375 deprecated, and may be removed in a future version of G++.
2377 @item -ffriend-injection
2378 @opindex ffriend-injection
2379 Inject friend functions into the enclosing namespace, so that they are
2380 visible outside the scope of the class in which they are declared.
2381 Friend functions were documented to work this way in the old Annotated
2382 C++ Reference Manual.  
2383 However, in ISO C++ a friend function that is not declared
2384 in an enclosing scope can only be found using argument dependent
2385 lookup.  GCC defaults to the standard behavior.
2387 This option is for compatibility, and may be removed in a future
2388 release of G++.
2390 @item -fno-elide-constructors
2391 @opindex fno-elide-constructors
2392 The C++ standard allows an implementation to omit creating a temporary
2393 that is only used to initialize another object of the same type.
2394 Specifying this option disables that optimization, and forces G++ to
2395 call the copy constructor in all cases.  This option also causes G++
2396 to call trivial member functions which otherwise would be expanded inline.
2398 In C++17, the compiler is required to omit these temporaries, but this
2399 option still affects trivial member functions.
2401 @item -fno-enforce-eh-specs
2402 @opindex fno-enforce-eh-specs
2403 Don't generate code to check for violation of exception specifications
2404 at run time.  This option violates the C++ standard, but may be useful
2405 for reducing code size in production builds, much like defining
2406 @code{NDEBUG}.  This does not give user code permission to throw
2407 exceptions in violation of the exception specifications; the compiler
2408 still optimizes based on the specifications, so throwing an
2409 unexpected exception results in undefined behavior at run time.
2411 @item -fextern-tls-init
2412 @itemx -fno-extern-tls-init
2413 @opindex fextern-tls-init
2414 @opindex fno-extern-tls-init
2415 The C++11 and OpenMP standards allow @code{thread_local} and
2416 @code{threadprivate} variables to have dynamic (runtime)
2417 initialization.  To support this, any use of such a variable goes
2418 through a wrapper function that performs any necessary initialization.
2419 When the use and definition of the variable are in the same
2420 translation unit, this overhead can be optimized away, but when the
2421 use is in a different translation unit there is significant overhead
2422 even if the variable doesn't actually need dynamic initialization.  If
2423 the programmer can be sure that no use of the variable in a
2424 non-defining TU needs to trigger dynamic initialization (either
2425 because the variable is statically initialized, or a use of the
2426 variable in the defining TU will be executed before any uses in
2427 another TU), they can avoid this overhead with the
2428 @option{-fno-extern-tls-init} option.
2430 On targets that support symbol aliases, the default is
2431 @option{-fextern-tls-init}.  On targets that do not support symbol
2432 aliases, the default is @option{-fno-extern-tls-init}.
2434 @item -ffor-scope
2435 @itemx -fno-for-scope
2436 @opindex ffor-scope
2437 @opindex fno-for-scope
2438 If @option{-ffor-scope} is specified, the scope of variables declared in
2439 a @i{for-init-statement} is limited to the @code{for} loop itself,
2440 as specified by the C++ standard.
2441 If @option{-fno-for-scope} is specified, the scope of variables declared in
2442 a @i{for-init-statement} extends to the end of the enclosing scope,
2443 as was the case in old versions of G++, and other (traditional)
2444 implementations of C++.
2446 If neither flag is given, the default is to follow the standard,
2447 but to allow and give a warning for old-style code that would
2448 otherwise be invalid, or have different behavior.
2450 @item -fno-gnu-keywords
2451 @opindex fno-gnu-keywords
2452 Do not recognize @code{typeof} as a keyword, so that code can use this
2453 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2454 This option is implied by the strict ISO C++ dialects: @option{-ansi},
2455 @option{-std=c++98}, @option{-std=c++11}, etc.
2457 @item -fno-implicit-templates
2458 @opindex fno-implicit-templates
2459 Never emit code for non-inline templates that are instantiated
2460 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2461 @xref{Template Instantiation}, for more information.
2463 @item -fno-implicit-inline-templates
2464 @opindex fno-implicit-inline-templates
2465 Don't emit code for implicit instantiations of inline templates, either.
2466 The default is to handle inlines differently so that compiles with and
2467 without optimization need the same set of explicit instantiations.
2469 @item -fno-implement-inlines
2470 @opindex fno-implement-inlines
2471 To save space, do not emit out-of-line copies of inline functions
2472 controlled by @code{#pragma implementation}.  This causes linker
2473 errors if these functions are not inlined everywhere they are called.
2475 @item -fms-extensions
2476 @opindex fms-extensions
2477 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2478 int and getting a pointer to member function via non-standard syntax.
2480 @item -fnew-inheriting-ctors
2481 @opindex fnew-inheriting-ctors
2482 Enable the P0136 adjustment to the semantics of C++11 constructor
2483 inheritance.  This is part of C++17 but also considered to be a Defect
2484 Report against C++11 and C++14.  This flag is enabled by default
2485 unless @option{-fabi-version=10} or lower is specified.
2487 @item -fnew-ttp-matching
2488 @opindex fnew-ttp-matching
2489 Enable the P0522 resolution to Core issue 150, template template
2490 parameters and default arguments: this allows a template with default
2491 template arguments as an argument for a template template parameter
2492 with fewer template parameters.  This flag is enabled by default for
2493 @option{-std=c++17}.
2495 @item -fno-nonansi-builtins
2496 @opindex fno-nonansi-builtins
2497 Disable built-in declarations of functions that are not mandated by
2498 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2499 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2501 @item -fnothrow-opt
2502 @opindex fnothrow-opt
2503 Treat a @code{throw()} exception specification as if it were a
2504 @code{noexcept} specification to reduce or eliminate the text size
2505 overhead relative to a function with no exception specification.  If
2506 the function has local variables of types with non-trivial
2507 destructors, the exception specification actually makes the
2508 function smaller because the EH cleanups for those variables can be
2509 optimized away.  The semantic effect is that an exception thrown out of
2510 a function with such an exception specification results in a call
2511 to @code{terminate} rather than @code{unexpected}.
2513 @item -fno-operator-names
2514 @opindex fno-operator-names
2515 Do not treat the operator name keywords @code{and}, @code{bitand},
2516 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2517 synonyms as keywords.
2519 @item -fno-optional-diags
2520 @opindex fno-optional-diags
2521 Disable diagnostics that the standard says a compiler does not need to
2522 issue.  Currently, the only such diagnostic issued by G++ is the one for
2523 a name having multiple meanings within a class.
2525 @item -fpermissive
2526 @opindex fpermissive
2527 Downgrade some diagnostics about nonconformant code from errors to
2528 warnings.  Thus, using @option{-fpermissive} allows some
2529 nonconforming code to compile.
2531 @item -fno-pretty-templates
2532 @opindex fno-pretty-templates
2533 When an error message refers to a specialization of a function
2534 template, the compiler normally prints the signature of the
2535 template followed by the template arguments and any typedefs or
2536 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2537 rather than @code{void f(int)}) so that it's clear which template is
2538 involved.  When an error message refers to a specialization of a class
2539 template, the compiler omits any template arguments that match
2540 the default template arguments for that template.  If either of these
2541 behaviors make it harder to understand the error message rather than
2542 easier, you can use @option{-fno-pretty-templates} to disable them.
2544 @item -frepo
2545 @opindex frepo
2546 Enable automatic template instantiation at link time.  This option also
2547 implies @option{-fno-implicit-templates}.  @xref{Template
2548 Instantiation}, for more information.
2550 @item -fno-rtti
2551 @opindex fno-rtti
2552 Disable generation of information about every class with virtual
2553 functions for use by the C++ run-time type identification features
2554 (@code{dynamic_cast} and @code{typeid}).  If you don't use those parts
2555 of the language, you can save some space by using this flag.  Note that
2556 exception handling uses the same information, but G++ generates it as
2557 needed. The @code{dynamic_cast} operator can still be used for casts that
2558 do not require run-time type information, i.e.@: casts to @code{void *} or to
2559 unambiguous base classes.
2561 @item -fsized-deallocation
2562 @opindex fsized-deallocation
2563 Enable the built-in global declarations
2564 @smallexample
2565 void operator delete (void *, std::size_t) noexcept;
2566 void operator delete[] (void *, std::size_t) noexcept;
2567 @end smallexample
2568 as introduced in C++14.  This is useful for user-defined replacement
2569 deallocation functions that, for example, use the size of the object
2570 to make deallocation faster.  Enabled by default under
2571 @option{-std=c++14} and above.  The flag @option{-Wsized-deallocation}
2572 warns about places that might want to add a definition.
2574 @item -fstrict-enums
2575 @opindex fstrict-enums
2576 Allow the compiler to optimize using the assumption that a value of
2577 enumerated type can only be one of the values of the enumeration (as
2578 defined in the C++ standard; basically, a value that can be
2579 represented in the minimum number of bits needed to represent all the
2580 enumerators).  This assumption may not be valid if the program uses a
2581 cast to convert an arbitrary integer value to the enumerated type.
2583 @item -fstrong-eval-order
2584 @opindex fstrong-eval-order
2585 Evaluate member access, array subscripting, and shift expressions in
2586 left-to-right order, and evaluate assignment in right-to-left order,
2587 as adopted for C++17.  Enabled by default with @option{-std=c++17}.
2588 @option{-fstrong-eval-order=some} enables just the ordering of member
2589 access and shift expressions, and is the default without
2590 @option{-std=c++17}.
2592 @item -ftemplate-backtrace-limit=@var{n}
2593 @opindex ftemplate-backtrace-limit
2594 Set the maximum number of template instantiation notes for a single
2595 warning or error to @var{n}.  The default value is 10.
2597 @item -ftemplate-depth=@var{n}
2598 @opindex ftemplate-depth
2599 Set the maximum instantiation depth for template classes to @var{n}.
2600 A limit on the template instantiation depth is needed to detect
2601 endless recursions during template class instantiation.  ANSI/ISO C++
2602 conforming programs must not rely on a maximum depth greater than 17
2603 (changed to 1024 in C++11).  The default value is 900, as the compiler
2604 can run out of stack space before hitting 1024 in some situations.
2606 @item -fno-threadsafe-statics
2607 @opindex fno-threadsafe-statics
2608 Do not emit the extra code to use the routines specified in the C++
2609 ABI for thread-safe initialization of local statics.  You can use this
2610 option to reduce code size slightly in code that doesn't need to be
2611 thread-safe.
2613 @item -fuse-cxa-atexit
2614 @opindex fuse-cxa-atexit
2615 Register destructors for objects with static storage duration with the
2616 @code{__cxa_atexit} function rather than the @code{atexit} function.
2617 This option is required for fully standards-compliant handling of static
2618 destructors, but only works if your C library supports
2619 @code{__cxa_atexit}.
2621 @item -fno-use-cxa-get-exception-ptr
2622 @opindex fno-use-cxa-get-exception-ptr
2623 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2624 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2625 if the runtime routine is not available.
2627 @item -fvisibility-inlines-hidden
2628 @opindex fvisibility-inlines-hidden
2629 This switch declares that the user does not attempt to compare
2630 pointers to inline functions or methods where the addresses of the two functions
2631 are taken in different shared objects.
2633 The effect of this is that GCC may, effectively, mark inline methods with
2634 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2635 appear in the export table of a DSO and do not require a PLT indirection
2636 when used within the DSO@.  Enabling this option can have a dramatic effect
2637 on load and link times of a DSO as it massively reduces the size of the
2638 dynamic export table when the library makes heavy use of templates.
2640 The behavior of this switch is not quite the same as marking the
2641 methods as hidden directly, because it does not affect static variables
2642 local to the function or cause the compiler to deduce that
2643 the function is defined in only one shared object.
2645 You may mark a method as having a visibility explicitly to negate the
2646 effect of the switch for that method.  For example, if you do want to
2647 compare pointers to a particular inline method, you might mark it as
2648 having default visibility.  Marking the enclosing class with explicit
2649 visibility has no effect.
2651 Explicitly instantiated inline methods are unaffected by this option
2652 as their linkage might otherwise cross a shared library boundary.
2653 @xref{Template Instantiation}.
2655 @item -fvisibility-ms-compat
2656 @opindex fvisibility-ms-compat
2657 This flag attempts to use visibility settings to make GCC's C++
2658 linkage model compatible with that of Microsoft Visual Studio.
2660 The flag makes these changes to GCC's linkage model:
2662 @enumerate
2663 @item
2664 It sets the default visibility to @code{hidden}, like
2665 @option{-fvisibility=hidden}.
2667 @item
2668 Types, but not their members, are not hidden by default.
2670 @item
2671 The One Definition Rule is relaxed for types without explicit
2672 visibility specifications that are defined in more than one
2673 shared object: those declarations are permitted if they are
2674 permitted when this option is not used.
2675 @end enumerate
2677 In new code it is better to use @option{-fvisibility=hidden} and
2678 export those classes that are intended to be externally visible.
2679 Unfortunately it is possible for code to rely, perhaps accidentally,
2680 on the Visual Studio behavior.
2682 Among the consequences of these changes are that static data members
2683 of the same type with the same name but defined in different shared
2684 objects are different, so changing one does not change the other;
2685 and that pointers to function members defined in different shared
2686 objects may not compare equal.  When this flag is given, it is a
2687 violation of the ODR to define types with the same name differently.
2689 @item -fno-weak
2690 @opindex fno-weak
2691 Do not use weak symbol support, even if it is provided by the linker.
2692 By default, G++ uses weak symbols if they are available.  This
2693 option exists only for testing, and should not be used by end-users;
2694 it results in inferior code and has no benefits.  This option may
2695 be removed in a future release of G++.
2697 @item -nostdinc++
2698 @opindex nostdinc++
2699 Do not search for header files in the standard directories specific to
2700 C++, but do still search the other standard directories.  (This option
2701 is used when building the C++ library.)
2702 @end table
2704 In addition, these optimization, warning, and code generation options
2705 have meanings only for C++ programs:
2707 @table @gcctabopt
2708 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2709 @opindex Wabi
2710 @opindex Wno-abi
2711 Warn when G++ it generates code that is probably not compatible with
2712 the vendor-neutral C++ ABI@.  Since G++ now defaults to updating the
2713 ABI with each major release, normally @option{-Wabi} will warn only if
2714 there is a check added later in a release series for an ABI issue
2715 discovered since the initial release.  @option{-Wabi} will warn about
2716 more things if an older ABI version is selected (with
2717 @option{-fabi-version=@var{n}}).
2719 @option{-Wabi} can also be used with an explicit version number to
2720 warn about compatibility with a particular @option{-fabi-version}
2721 level, e.g. @option{-Wabi=2} to warn about changes relative to
2722 @option{-fabi-version=2}.
2724 If an explicit version number is provided and
2725 @option{-fabi-compat-version} is not specified, the version number
2726 from this option is used for compatibility aliases.  If no explicit
2727 version number is provided with this option, but
2728 @option{-fabi-compat-version} is specified, that version number is
2729 used for ABI warnings.
2731 Although an effort has been made to warn about
2732 all such cases, there are probably some cases that are not warned about,
2733 even though G++ is generating incompatible code.  There may also be
2734 cases where warnings are emitted even though the code that is generated
2735 is compatible.
2737 You should rewrite your code to avoid these warnings if you are
2738 concerned about the fact that code generated by G++ may not be binary
2739 compatible with code generated by other compilers.
2741 Known incompatibilities in @option{-fabi-version=2} (which was the
2742 default from GCC 3.4 to 4.9) include:
2744 @itemize @bullet
2746 @item
2747 A template with a non-type template parameter of reference type was
2748 mangled incorrectly:
2749 @smallexample
2750 extern int N;
2751 template <int &> struct S @{@};
2752 void n (S<N>) @{2@}
2753 @end smallexample
2755 This was fixed in @option{-fabi-version=3}.
2757 @item
2758 SIMD vector types declared using @code{__attribute ((vector_size))} were
2759 mangled in a non-standard way that does not allow for overloading of
2760 functions taking vectors of different sizes.
2762 The mangling was changed in @option{-fabi-version=4}.
2764 @item
2765 @code{__attribute ((const))} and @code{noreturn} were mangled as type
2766 qualifiers, and @code{decltype} of a plain declaration was folded away.
2768 These mangling issues were fixed in @option{-fabi-version=5}.
2770 @item
2771 Scoped enumerators passed as arguments to a variadic function are
2772 promoted like unscoped enumerators, causing @code{va_arg} to complain.
2773 On most targets this does not actually affect the parameter passing
2774 ABI, as there is no way to pass an argument smaller than @code{int}.
2776 Also, the ABI changed the mangling of template argument packs,
2777 @code{const_cast}, @code{static_cast}, prefix increment/decrement, and
2778 a class scope function used as a template argument.
2780 These issues were corrected in @option{-fabi-version=6}.
2782 @item
2783 Lambdas in default argument scope were mangled incorrectly, and the
2784 ABI changed the mangling of @code{nullptr_t}.
2786 These issues were corrected in @option{-fabi-version=7}.
2788 @item
2789 When mangling a function type with function-cv-qualifiers, the
2790 un-qualified function type was incorrectly treated as a substitution
2791 candidate.
2793 This was fixed in @option{-fabi-version=8}, the default for GCC 5.1.
2795 @item
2796 @code{decltype(nullptr)} incorrectly had an alignment of 1, leading to
2797 unaligned accesses.  Note that this did not affect the ABI of a
2798 function with a @code{nullptr_t} parameter, as parameters have a
2799 minimum alignment.
2801 This was fixed in @option{-fabi-version=9}, the default for GCC 5.2.
2803 @item
2804 Target-specific attributes that affect the identity of a type, such as
2805 ia32 calling conventions on a function type (stdcall, regparm, etc.),
2806 did not affect the mangled name, leading to name collisions when
2807 function pointers were used as template arguments.
2809 This was fixed in @option{-fabi-version=10}, the default for GCC 6.1.
2811 @end itemize
2813 It also warns about psABI-related changes.  The known psABI changes at this
2814 point include:
2816 @itemize @bullet
2818 @item
2819 For SysV/x86-64, unions with @code{long double} members are 
2820 passed in memory as specified in psABI.  For example:
2822 @smallexample
2823 union U @{
2824   long double ld;
2825   int i;
2827 @end smallexample
2829 @noindent
2830 @code{union U} is always passed in memory.
2832 @end itemize
2834 @item -Wabi-tag @r{(C++ and Objective-C++ only)}
2835 @opindex Wabi-tag
2836 @opindex -Wabi-tag
2837 Warn when a type with an ABI tag is used in a context that does not
2838 have that ABI tag.  See @ref{C++ Attributes} for more information
2839 about ABI tags.
2841 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2842 @opindex Wctor-dtor-privacy
2843 @opindex Wno-ctor-dtor-privacy
2844 Warn when a class seems unusable because all the constructors or
2845 destructors in that class are private, and it has neither friends nor
2846 public static member functions.  Also warn if there are no non-private
2847 methods, and there's at least one private member function that isn't
2848 a constructor or destructor.
2850 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2851 @opindex Wdelete-non-virtual-dtor
2852 @opindex Wno-delete-non-virtual-dtor
2853 Warn when @code{delete} is used to destroy an instance of a class that
2854 has virtual functions and non-virtual destructor. It is unsafe to delete
2855 an instance of a derived class through a pointer to a base class if the
2856 base class does not have a virtual destructor.  This warning is enabled
2857 by @option{-Wall}.
2859 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2860 @opindex Wliteral-suffix
2861 @opindex Wno-literal-suffix
2862 Warn when a string or character literal is followed by a ud-suffix which does
2863 not begin with an underscore.  As a conforming extension, GCC treats such
2864 suffixes as separate preprocessing tokens in order to maintain backwards
2865 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2866 For example:
2868 @smallexample
2869 #define __STDC_FORMAT_MACROS
2870 #include <inttypes.h>
2871 #include <stdio.h>
2873 int main() @{
2874   int64_t i64 = 123;
2875   printf("My int64: %" PRId64"\n", i64);
2877 @end smallexample
2879 In this case, @code{PRId64} is treated as a separate preprocessing token.
2881 Additionally, warn when a user-defined literal operator is declared with
2882 a literal suffix identifier that doesn't begin with an underscore. Literal
2883 suffix identifiers that don't begin with an underscore are reserved for
2884 future standardization.
2886 This warning is enabled by default.
2888 @item -Wlto-type-mismatch
2889 @opindex Wlto-type-mismatch
2890 @opindex Wno-lto-type-mismatch
2892 During the link-time optimization warn about type mismatches in
2893 global declarations from different compilation units.
2894 Requires @option{-flto} to be enabled.  Enabled by default.
2896 @item -Wno-narrowing @r{(C++ and Objective-C++ only)}
2897 @opindex Wnarrowing
2898 @opindex Wno-narrowing
2899 For C++11 and later standards, narrowing conversions are diagnosed by default,
2900 as required by the standard.  A narrowing conversion from a constant produces
2901 an error, and a narrowing conversion from a non-constant produces a warning,
2902 but @option{-Wno-narrowing} suppresses the diagnostic.
2903 Note that this does not affect the meaning of well-formed code;
2904 narrowing conversions are still considered ill-formed in SFINAE contexts.
2906 With @option{-Wnarrowing} in C++98, warn when a narrowing
2907 conversion prohibited by C++11 occurs within
2908 @samp{@{ @}}, e.g.
2910 @smallexample
2911 int i = @{ 2.2 @}; // error: narrowing from double to int
2912 @end smallexample
2914 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2916 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2917 @opindex Wnoexcept
2918 @opindex Wno-noexcept
2919 Warn when a noexcept-expression evaluates to false because of a call
2920 to a function that does not have a non-throwing exception
2921 specification (i.e. @code{throw()} or @code{noexcept}) but is known by
2922 the compiler to never throw an exception.
2924 @item -Wnoexcept-type @r{(C++ and Objective-C++ only)}
2925 @opindex Wnoexcept-type
2926 @opindex Wno-noexcept-type
2927 Warn if the C++17 feature making @code{noexcept} part of a function
2928 type changes the mangled name of a symbol relative to C++14.  Enabled
2929 by @option{-Wabi} and @option{-Wc++17-compat}.
2931 @smallexample
2932 template <class T> void f(T t) @{ t(); @};
2933 void g() noexcept;
2934 void h() @{ f(g); @} // in C++14 calls f<void(*)()>, in C++17 calls f<void(*)()noexcept>
2935 @end smallexample
2937 @item -Wclass-memaccess @r{(C++ and Objective-C++ only)}
2938 @opindex Wclass-memaccess
2939 Warn when the destination of a call to a raw memory function such as
2940 @code{memset} or @code{memcpy} is an object of class type writing into which
2941 might bypass the class non-trivial or deleted constructor or copy assignment,
2942 violate const-correctness or encapsulation, or corrupt the virtual table.
2943 Modifying the representation of such objects may violate invariants maintained
2944 by member functions of the class.  For example, the call to @code{memset}
2945 below is undefined becase it modifies a non-trivial class object and is,
2946 therefore, diagnosed.  The safe way to either initialize or clear the storage
2947 of objects of such types is by using the appropriate constructor or assignment
2948 operator, if one is available.
2949 @smallexample
2950 std::string str = "abc";
2951 memset (&str, 0, 3);
2952 @end smallexample
2953 The @option{-Wclass-memaccess} option is enabled by @option{-Wall}.
2955 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2956 @opindex Wnon-virtual-dtor
2957 @opindex Wno-non-virtual-dtor
2958 Warn when a class has virtual functions and an accessible non-virtual
2959 destructor itself or in an accessible polymorphic base class, in which
2960 case it is possible but unsafe to delete an instance of a derived
2961 class through a pointer to the class itself or base class.  This
2962 warning is automatically enabled if @option{-Weffc++} is specified.
2964 @item -Wregister @r{(C++ and Objective-C++ only)}
2965 @opindex Wregister
2966 @opindex Wno-register
2967 Warn on uses of the @code{register} storage class specifier, except
2968 when it is part of the GNU @ref{Explicit Register Variables} extension.
2969 The use of the @code{register} keyword as storage class specifier has
2970 been deprecated in C++11 and removed in C++17.
2971 Enabled by default with @option{-std=c++17}.
2973 @item -Wreorder @r{(C++ and Objective-C++ only)}
2974 @opindex Wreorder
2975 @opindex Wno-reorder
2976 @cindex reordering, warning
2977 @cindex warning for reordering of member initializers
2978 Warn when the order of member initializers given in the code does not
2979 match the order in which they must be executed.  For instance:
2981 @smallexample
2982 struct A @{
2983   int i;
2984   int j;
2985   A(): j (0), i (1) @{ @}
2987 @end smallexample
2989 @noindent
2990 The compiler rearranges the member initializers for @code{i}
2991 and @code{j} to match the declaration order of the members, emitting
2992 a warning to that effect.  This warning is enabled by @option{-Wall}.
2994 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
2995 @opindex fext-numeric-literals
2996 @opindex fno-ext-numeric-literals
2997 Accept imaginary, fixed-point, or machine-defined
2998 literal number suffixes as GNU extensions.
2999 When this option is turned off these suffixes are treated
3000 as C++11 user-defined literal numeric suffixes.
3001 This is on by default for all pre-C++11 dialects and all GNU dialects:
3002 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
3003 @option{-std=gnu++14}.
3004 This option is off by default
3005 for ISO C++11 onwards (@option{-std=c++11}, ...).
3006 @end table
3008 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
3010 @table @gcctabopt
3011 @item -Weffc++ @r{(C++ and Objective-C++ only)}
3012 @opindex Weffc++
3013 @opindex Wno-effc++
3014 Warn about violations of the following style guidelines from Scott Meyers'
3015 @cite{Effective C++} series of books:
3017 @itemize @bullet
3018 @item
3019 Define a copy constructor and an assignment operator for classes
3020 with dynamically-allocated memory.
3022 @item
3023 Prefer initialization to assignment in constructors.
3025 @item
3026 Have @code{operator=} return a reference to @code{*this}.
3028 @item
3029 Don't try to return a reference when you must return an object.
3031 @item
3032 Distinguish between prefix and postfix forms of increment and
3033 decrement operators.
3035 @item
3036 Never overload @code{&&}, @code{||}, or @code{,}.
3038 @end itemize
3040 This option also enables @option{-Wnon-virtual-dtor}, which is also
3041 one of the effective C++ recommendations.  However, the check is
3042 extended to warn about the lack of virtual destructor in accessible
3043 non-polymorphic bases classes too.
3045 When selecting this option, be aware that the standard library
3046 headers do not obey all of these guidelines; use @samp{grep -v}
3047 to filter out those warnings.
3049 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
3050 @opindex Wstrict-null-sentinel
3051 @opindex Wno-strict-null-sentinel
3052 Warn about the use of an uncasted @code{NULL} as sentinel.  When
3053 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
3054 to @code{__null}.  Although it is a null pointer constant rather than a
3055 null pointer, it is guaranteed to be of the same size as a pointer.
3056 But this use is not portable across different compilers.
3058 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
3059 @opindex Wno-non-template-friend
3060 @opindex Wnon-template-friend
3061 Disable warnings when non-template friend functions are declared
3062 within a template.  In very old versions of GCC that predate implementation
3063 of the ISO standard, declarations such as 
3064 @samp{friend int foo(int)}, where the name of the friend is an unqualified-id,
3065 could be interpreted as a particular specialization of a template
3066 function; the warning exists to diagnose compatibility problems, 
3067 and is enabled by default.
3069 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
3070 @opindex Wold-style-cast
3071 @opindex Wno-old-style-cast
3072 Warn if an old-style (C-style) cast to a non-void type is used within
3073 a C++ program.  The new-style casts (@code{dynamic_cast},
3074 @code{static_cast}, @code{reinterpret_cast}, and @code{const_cast}) are
3075 less vulnerable to unintended effects and much easier to search for.
3077 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
3078 @opindex Woverloaded-virtual
3079 @opindex Wno-overloaded-virtual
3080 @cindex overloaded virtual function, warning
3081 @cindex warning for overloaded virtual function
3082 Warn when a function declaration hides virtual functions from a
3083 base class.  For example, in:
3085 @smallexample
3086 struct A @{
3087   virtual void f();
3090 struct B: public A @{
3091   void f(int);
3093 @end smallexample
3095 the @code{A} class version of @code{f} is hidden in @code{B}, and code
3096 like:
3098 @smallexample
3099 B* b;
3100 b->f();
3101 @end smallexample
3103 @noindent
3104 fails to compile.
3106 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
3107 @opindex Wno-pmf-conversions
3108 @opindex Wpmf-conversions
3109 Disable the diagnostic for converting a bound pointer to member function
3110 to a plain pointer.
3112 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
3113 @opindex Wsign-promo
3114 @opindex Wno-sign-promo
3115 Warn when overload resolution chooses a promotion from unsigned or
3116 enumerated type to a signed type, over a conversion to an unsigned type of
3117 the same size.  Previous versions of G++ tried to preserve
3118 unsignedness, but the standard mandates the current behavior.
3120 @item -Wtemplates @r{(C++ and Objective-C++ only)}
3121 @opindex Wtemplates
3122 Warn when a primary template declaration is encountered.  Some coding
3123 rules disallow templates, and this may be used to enforce that rule.
3124 The warning is inactive inside a system header file, such as the STL, so
3125 one can still use the STL.  One may also instantiate or specialize
3126 templates.
3128 @item -Wmultiple-inheritance @r{(C++ and Objective-C++ only)}
3129 @opindex Wmultiple-inheritance
3130 Warn when a class is defined with multiple direct base classes.  Some
3131 coding rules disallow multiple inheritance, and this may be used to
3132 enforce that rule.  The warning is inactive inside a system header file,
3133 such as the STL, so one can still use the STL.  One may also define
3134 classes that indirectly use multiple inheritance.
3136 @item -Wvirtual-inheritance
3137 @opindex Wvirtual-inheritance
3138 Warn when a class is defined with a virtual direct base class.  Some
3139 coding rules disallow multiple inheritance, and this may be used to
3140 enforce that rule.  The warning is inactive inside a system header file,
3141 such as the STL, so one can still use the STL.  One may also define
3142 classes that indirectly use virtual inheritance.
3144 @item -Wnamespaces
3145 @opindex Wnamespaces
3146 Warn when a namespace definition is opened.  Some coding rules disallow
3147 namespaces, and this may be used to enforce that rule.  The warning is
3148 inactive inside a system header file, such as the STL, so one can still
3149 use the STL.  One may also use using directives and qualified names.
3151 @item -Wno-terminate @r{(C++ and Objective-C++ only)}
3152 @opindex Wterminate
3153 @opindex Wno-terminate
3154 Disable the warning about a throw-expression that will immediately
3155 result in a call to @code{terminate}.
3156 @end table
3158 @node Objective-C and Objective-C++ Dialect Options
3159 @section Options Controlling Objective-C and Objective-C++ Dialects
3161 @cindex compiler options, Objective-C and Objective-C++
3162 @cindex Objective-C and Objective-C++ options, command-line
3163 @cindex options, Objective-C and Objective-C++
3164 (NOTE: This manual does not describe the Objective-C and Objective-C++
3165 languages themselves.  @xref{Standards,,Language Standards
3166 Supported by GCC}, for references.)
3168 This section describes the command-line options that are only meaningful
3169 for Objective-C and Objective-C++ programs.  You can also use most of
3170 the language-independent GNU compiler options.
3171 For example, you might compile a file @file{some_class.m} like this:
3173 @smallexample
3174 gcc -g -fgnu-runtime -O -c some_class.m
3175 @end smallexample
3177 @noindent
3178 In this example, @option{-fgnu-runtime} is an option meant only for
3179 Objective-C and Objective-C++ programs; you can use the other options with
3180 any language supported by GCC@.
3182 Note that since Objective-C is an extension of the C language, Objective-C
3183 compilations may also use options specific to the C front-end (e.g.,
3184 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
3185 C++-specific options (e.g., @option{-Wabi}).
3187 Here is a list of options that are @emph{only} for compiling Objective-C
3188 and Objective-C++ programs:
3190 @table @gcctabopt
3191 @item -fconstant-string-class=@var{class-name}
3192 @opindex fconstant-string-class
3193 Use @var{class-name} as the name of the class to instantiate for each
3194 literal string specified with the syntax @code{@@"@dots{}"}.  The default
3195 class name is @code{NXConstantString} if the GNU runtime is being used, and
3196 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
3197 @option{-fconstant-cfstrings} option, if also present, overrides the
3198 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
3199 to be laid out as constant CoreFoundation strings.
3201 @item -fgnu-runtime
3202 @opindex fgnu-runtime
3203 Generate object code compatible with the standard GNU Objective-C
3204 runtime.  This is the default for most types of systems.
3206 @item -fnext-runtime
3207 @opindex fnext-runtime
3208 Generate output compatible with the NeXT runtime.  This is the default
3209 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
3210 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
3211 used.
3213 @item -fno-nil-receivers
3214 @opindex fno-nil-receivers
3215 Assume that all Objective-C message dispatches (@code{[receiver
3216 message:arg]}) in this translation unit ensure that the receiver is
3217 not @code{nil}.  This allows for more efficient entry points in the
3218 runtime to be used.  This option is only available in conjunction with
3219 the NeXT runtime and ABI version 0 or 1.
3221 @item -fobjc-abi-version=@var{n}
3222 @opindex fobjc-abi-version
3223 Use version @var{n} of the Objective-C ABI for the selected runtime.
3224 This option is currently supported only for the NeXT runtime.  In that
3225 case, Version 0 is the traditional (32-bit) ABI without support for
3226 properties and other Objective-C 2.0 additions.  Version 1 is the
3227 traditional (32-bit) ABI with support for properties and other
3228 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
3229 nothing is specified, the default is Version 0 on 32-bit target
3230 machines, and Version 2 on 64-bit target machines.
3232 @item -fobjc-call-cxx-cdtors
3233 @opindex fobjc-call-cxx-cdtors
3234 For each Objective-C class, check if any of its instance variables is a
3235 C++ object with a non-trivial default constructor.  If so, synthesize a
3236 special @code{- (id) .cxx_construct} instance method which runs
3237 non-trivial default constructors on any such instance variables, in order,
3238 and then return @code{self}.  Similarly, check if any instance variable
3239 is a C++ object with a non-trivial destructor, and if so, synthesize a
3240 special @code{- (void) .cxx_destruct} method which runs
3241 all such default destructors, in reverse order.
3243 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
3244 methods thusly generated only operate on instance variables
3245 declared in the current Objective-C class, and not those inherited
3246 from superclasses.  It is the responsibility of the Objective-C
3247 runtime to invoke all such methods in an object's inheritance
3248 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
3249 by the runtime immediately after a new object instance is allocated;
3250 the @code{- (void) .cxx_destruct} methods are invoked immediately
3251 before the runtime deallocates an object instance.
3253 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
3254 support for invoking the @code{- (id) .cxx_construct} and
3255 @code{- (void) .cxx_destruct} methods.
3257 @item -fobjc-direct-dispatch
3258 @opindex fobjc-direct-dispatch
3259 Allow fast jumps to the message dispatcher.  On Darwin this is
3260 accomplished via the comm page.
3262 @item -fobjc-exceptions
3263 @opindex fobjc-exceptions
3264 Enable syntactic support for structured exception handling in
3265 Objective-C, similar to what is offered by C++.  This option
3266 is required to use the Objective-C keywords @code{@@try},
3267 @code{@@throw}, @code{@@catch}, @code{@@finally} and
3268 @code{@@synchronized}.  This option is available with both the GNU
3269 runtime and the NeXT runtime (but not available in conjunction with
3270 the NeXT runtime on Mac OS X 10.2 and earlier).
3272 @item -fobjc-gc
3273 @opindex fobjc-gc
3274 Enable garbage collection (GC) in Objective-C and Objective-C++
3275 programs.  This option is only available with the NeXT runtime; the
3276 GNU runtime has a different garbage collection implementation that
3277 does not require special compiler flags.
3279 @item -fobjc-nilcheck
3280 @opindex fobjc-nilcheck
3281 For the NeXT runtime with version 2 of the ABI, check for a nil
3282 receiver in method invocations before doing the actual method call.
3283 This is the default and can be disabled using
3284 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
3285 checked for nil in this way no matter what this flag is set to.
3286 Currently this flag does nothing when the GNU runtime, or an older
3287 version of the NeXT runtime ABI, is used.
3289 @item -fobjc-std=objc1
3290 @opindex fobjc-std
3291 Conform to the language syntax of Objective-C 1.0, the language
3292 recognized by GCC 4.0.  This only affects the Objective-C additions to
3293 the C/C++ language; it does not affect conformance to C/C++ standards,
3294 which is controlled by the separate C/C++ dialect option flags.  When
3295 this option is used with the Objective-C or Objective-C++ compiler,
3296 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
3297 This is useful if you need to make sure that your Objective-C code can
3298 be compiled with older versions of GCC@.
3300 @item -freplace-objc-classes
3301 @opindex freplace-objc-classes
3302 Emit a special marker instructing @command{ld(1)} not to statically link in
3303 the resulting object file, and allow @command{dyld(1)} to load it in at
3304 run time instead.  This is used in conjunction with the Fix-and-Continue
3305 debugging mode, where the object file in question may be recompiled and
3306 dynamically reloaded in the course of program execution, without the need
3307 to restart the program itself.  Currently, Fix-and-Continue functionality
3308 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
3309 and later.
3311 @item -fzero-link
3312 @opindex fzero-link
3313 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
3314 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
3315 compile time) with static class references that get initialized at load time,
3316 which improves run-time performance.  Specifying the @option{-fzero-link} flag
3317 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
3318 to be retained.  This is useful in Zero-Link debugging mode, since it allows
3319 for individual class implementations to be modified during program execution.
3320 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
3321 regardless of command-line options.
3323 @item -fno-local-ivars
3324 @opindex fno-local-ivars
3325 @opindex flocal-ivars
3326 By default instance variables in Objective-C can be accessed as if
3327 they were local variables from within the methods of the class they're
3328 declared in.  This can lead to shadowing between instance variables
3329 and other variables declared either locally inside a class method or
3330 globally with the same name.  Specifying the @option{-fno-local-ivars}
3331 flag disables this behavior thus avoiding variable shadowing issues.
3333 @item -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]}
3334 @opindex fivar-visibility
3335 Set the default instance variable visibility to the specified option
3336 so that instance variables declared outside the scope of any access
3337 modifier directives default to the specified visibility.
3339 @item -gen-decls
3340 @opindex gen-decls
3341 Dump interface declarations for all classes seen in the source file to a
3342 file named @file{@var{sourcename}.decl}.
3344 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
3345 @opindex Wassign-intercept
3346 @opindex Wno-assign-intercept
3347 Warn whenever an Objective-C assignment is being intercepted by the
3348 garbage collector.
3350 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
3351 @opindex Wno-protocol
3352 @opindex Wprotocol
3353 If a class is declared to implement a protocol, a warning is issued for
3354 every method in the protocol that is not implemented by the class.  The
3355 default behavior is to issue a warning for every method not explicitly
3356 implemented in the class, even if a method implementation is inherited
3357 from the superclass.  If you use the @option{-Wno-protocol} option, then
3358 methods inherited from the superclass are considered to be implemented,
3359 and no warning is issued for them.
3361 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3362 @opindex Wselector
3363 @opindex Wno-selector
3364 Warn if multiple methods of different types for the same selector are
3365 found during compilation.  The check is performed on the list of methods
3366 in the final stage of compilation.  Additionally, a check is performed
3367 for each selector appearing in a @code{@@selector(@dots{})}
3368 expression, and a corresponding method for that selector has been found
3369 during compilation.  Because these checks scan the method table only at
3370 the end of compilation, these warnings are not produced if the final
3371 stage of compilation is not reached, for example because an error is
3372 found during compilation, or because the @option{-fsyntax-only} option is
3373 being used.
3375 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3376 @opindex Wstrict-selector-match
3377 @opindex Wno-strict-selector-match
3378 Warn if multiple methods with differing argument and/or return types are
3379 found for a given selector when attempting to send a message using this
3380 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3381 is off (which is the default behavior), the compiler omits such warnings
3382 if any differences found are confined to types that share the same size
3383 and alignment.
3385 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3386 @opindex Wundeclared-selector
3387 @opindex Wno-undeclared-selector
3388 Warn if a @code{@@selector(@dots{})} expression referring to an
3389 undeclared selector is found.  A selector is considered undeclared if no
3390 method with that name has been declared before the
3391 @code{@@selector(@dots{})} expression, either explicitly in an
3392 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3393 an @code{@@implementation} section.  This option always performs its
3394 checks as soon as a @code{@@selector(@dots{})} expression is found,
3395 while @option{-Wselector} only performs its checks in the final stage of
3396 compilation.  This also enforces the coding style convention
3397 that methods and selectors must be declared before being used.
3399 @item -print-objc-runtime-info
3400 @opindex print-objc-runtime-info
3401 Generate C header describing the largest structure that is passed by
3402 value, if any.
3404 @end table
3406 @node Diagnostic Message Formatting Options
3407 @section Options to Control Diagnostic Messages Formatting
3408 @cindex options to control diagnostics formatting
3409 @cindex diagnostic messages
3410 @cindex message formatting
3412 Traditionally, diagnostic messages have been formatted irrespective of
3413 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3414 options described below
3415 to control the formatting algorithm for diagnostic messages, 
3416 e.g.@: how many characters per line, how often source location
3417 information should be reported.  Note that some language front ends may not
3418 honor these options.
3420 @table @gcctabopt
3421 @item -fmessage-length=@var{n}
3422 @opindex fmessage-length
3423 Try to format error messages so that they fit on lines of about
3424 @var{n} characters.  If @var{n} is zero, then no line-wrapping is
3425 done; each error message appears on a single line.  This is the
3426 default for all front ends.
3428 @item -fdiagnostics-show-location=once
3429 @opindex fdiagnostics-show-location
3430 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3431 reporter to emit source location information @emph{once}; that is, in
3432 case the message is too long to fit on a single physical line and has to
3433 be wrapped, the source location won't be emitted (as prefix) again,
3434 over and over, in subsequent continuation lines.  This is the default
3435 behavior.
3437 @item -fdiagnostics-show-location=every-line
3438 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3439 messages reporter to emit the same source location information (as
3440 prefix) for physical lines that result from the process of breaking
3441 a message which is too long to fit on a single line.
3443 @item -fdiagnostics-color[=@var{WHEN}]
3444 @itemx -fno-diagnostics-color
3445 @opindex fdiagnostics-color
3446 @cindex highlight, color
3447 @vindex GCC_COLORS @r{environment variable}
3448 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3449 or @samp{auto}.  The default depends on how the compiler has been configured,
3450 it can be any of the above @var{WHEN} options or also @samp{never}
3451 if @env{GCC_COLORS} environment variable isn't present in the environment,
3452 and @samp{auto} otherwise.
3453 @samp{auto} means to use color only when the standard error is a terminal.
3454 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3455 aliases for @option{-fdiagnostics-color=always} and
3456 @option{-fdiagnostics-color=never}, respectively.
3458 The colors are defined by the environment variable @env{GCC_COLORS}.
3459 Its value is a colon-separated list of capabilities and Select Graphic
3460 Rendition (SGR) substrings. SGR commands are interpreted by the
3461 terminal or terminal emulator.  (See the section in the documentation
3462 of your text terminal for permitted values and their meanings as
3463 character attributes.)  These substring values are integers in decimal
3464 representation and can be concatenated with semicolons.
3465 Common values to concatenate include
3466 @samp{1} for bold,
3467 @samp{4} for underline,
3468 @samp{5} for blink,
3469 @samp{7} for inverse,
3470 @samp{39} for default foreground color,
3471 @samp{30} to @samp{37} for foreground colors,
3472 @samp{90} to @samp{97} for 16-color mode foreground colors,
3473 @samp{38;5;0} to @samp{38;5;255}
3474 for 88-color and 256-color modes foreground colors,
3475 @samp{49} for default background color,
3476 @samp{40} to @samp{47} for background colors,
3477 @samp{100} to @samp{107} for 16-color mode background colors,
3478 and @samp{48;5;0} to @samp{48;5;255}
3479 for 88-color and 256-color modes background colors.
3481 The default @env{GCC_COLORS} is
3482 @smallexample
3483 error=01;31:warning=01;35:note=01;36:range1=32:range2=34:locus=01:\
3484 quote=01:fixit-insert=32:fixit-delete=31:\
3485 diff-filename=01:diff-hunk=32:diff-delete=31:diff-insert=32:\
3486 type-diff=01;32
3487 @end smallexample
3488 @noindent
3489 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3490 @samp{01;36} is bold cyan, @samp{32} is green, @samp{34} is blue,
3491 @samp{01} is bold, and @samp{31} is red.
3492 Setting @env{GCC_COLORS} to the empty string disables colors.
3493 Supported capabilities are as follows.
3495 @table @code
3496 @item error=
3497 @vindex error GCC_COLORS @r{capability}
3498 SGR substring for error: markers.
3500 @item warning=
3501 @vindex warning GCC_COLORS @r{capability}
3502 SGR substring for warning: markers.
3504 @item note=
3505 @vindex note GCC_COLORS @r{capability}
3506 SGR substring for note: markers.
3508 @item range1=
3509 @vindex range1 GCC_COLORS @r{capability}
3510 SGR substring for first additional range.
3512 @item range2=
3513 @vindex range2 GCC_COLORS @r{capability}
3514 SGR substring for second additional range.
3516 @item locus=
3517 @vindex locus GCC_COLORS @r{capability}
3518 SGR substring for location information, @samp{file:line} or
3519 @samp{file:line:column} etc.
3521 @item quote=
3522 @vindex quote GCC_COLORS @r{capability}
3523 SGR substring for information printed within quotes.
3525 @item fixit-insert=
3526 @vindex fixit-insert GCC_COLORS @r{capability}
3527 SGR substring for fix-it hints suggesting text to
3528 be inserted or replaced.
3530 @item fixit-delete=
3531 @vindex fixit-delete GCC_COLORS @r{capability}
3532 SGR substring for fix-it hints suggesting text to
3533 be deleted.
3535 @item diff-filename=
3536 @vindex diff-filename GCC_COLORS @r{capability}
3537 SGR substring for filename headers within generated patches.
3539 @item diff-hunk=
3540 @vindex diff-hunk GCC_COLORS @r{capability}
3541 SGR substring for the starts of hunks within generated patches.
3543 @item diff-delete=
3544 @vindex diff-delete GCC_COLORS @r{capability}
3545 SGR substring for deleted lines within generated patches.
3547 @item diff-insert=
3548 @vindex diff-insert GCC_COLORS @r{capability}
3549 SGR substring for inserted lines within generated patches.
3551 @item type-diff=
3552 @vindex type-diff GCC_COLORS @r{capability}
3553 SGR substring for highlighting mismatching types within template
3554 arguments in the C++ frontend.
3555 @end table
3557 @item -fno-diagnostics-show-option
3558 @opindex fno-diagnostics-show-option
3559 @opindex fdiagnostics-show-option
3560 By default, each diagnostic emitted includes text indicating the
3561 command-line option that directly controls the diagnostic (if such an
3562 option is known to the diagnostic machinery).  Specifying the
3563 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3565 @item -fno-diagnostics-show-caret
3566 @opindex fno-diagnostics-show-caret
3567 @opindex fdiagnostics-show-caret
3568 By default, each diagnostic emitted includes the original source line
3569 and a caret @samp{^} indicating the column.  This option suppresses this
3570 information.  The source line is truncated to @var{n} characters, if
3571 the @option{-fmessage-length=n} option is given.  When the output is done
3572 to the terminal, the width is limited to the width given by the
3573 @env{COLUMNS} environment variable or, if not set, to the terminal width.
3575 @item -fdiagnostics-parseable-fixits
3576 @opindex fdiagnostics-parseable-fixits
3577 Emit fix-it hints in a machine-parseable format, suitable for consumption
3578 by IDEs.  For each fix-it, a line will be printed after the relevant
3579 diagnostic, starting with the string ``fix-it:''.  For example:
3581 @smallexample
3582 fix-it:"test.c":@{45:3-45:21@}:"gtk_widget_show_all"
3583 @end smallexample
3585 The location is expressed as a half-open range, expressed as a count of
3586 bytes, starting at byte 1 for the initial column.  In the above example,
3587 bytes 3 through 20 of line 45 of ``test.c'' are to be replaced with the
3588 given string:
3590 @smallexample
3591 00000000011111111112222222222
3592 12345678901234567890123456789
3593   gtk_widget_showall (dlg);
3594   ^^^^^^^^^^^^^^^^^^
3595   gtk_widget_show_all
3596 @end smallexample
3598 The filename and replacement string escape backslash as ``\\", tab as ``\t'',
3599 newline as ``\n'', double quotes as ``\"'', non-printable characters as octal
3600 (e.g. vertical tab as ``\013'').
3602 An empty replacement string indicates that the given range is to be removed.
3603 An empty range (e.g. ``45:3-45:3'') indicates that the string is to
3604 be inserted at the given position.
3606 @item -fdiagnostics-generate-patch
3607 @opindex fdiagnostics-generate-patch
3608 Print fix-it hints to stderr in unified diff format, after any diagnostics
3609 are printed.  For example:
3611 @smallexample
3612 --- test.c
3613 +++ test.c
3614 @@ -42,5 +42,5 @@
3616  void show_cb(GtkDialog *dlg)
3617  @{
3618 -  gtk_widget_showall(dlg);
3619 +  gtk_widget_show_all(dlg);
3620  @}
3622 @end smallexample
3624 The diff may or may not be colorized, following the same rules
3625 as for diagnostics (see @option{-fdiagnostics-color}).
3627 @item -fdiagnostics-show-template-tree
3628 @opindex fdiagnostics-show-template-tree
3630 In the C++ frontend, when printing diagnostics showing mismatching
3631 template types, such as:
3633 @smallexample
3634   could not convert 'std::map<int, std::vector<double> >()'
3635     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3636 @end smallexample
3638 the @option{-fdiagnostics-show-template-tree} flag enables printing a
3639 tree-like structure showing the common and differing parts of the types,
3640 such as:
3642 @smallexample
3643   map<
3644     [...],
3645     vector<
3646       [double != float]>>
3647 @end smallexample
3649 The parts that differ are highlighted with color (``double'' and
3650 ``float'' in this case).
3652 @item -fno-elide-type
3653 @opindex fno-elide-type
3654 @opindex felide-type
3655 By default when the C++ frontend prints diagnostics showing mismatching
3656 template types, common parts of the types are printed as ``[...]'' to
3657 simplify the error message.  For example:
3659 @smallexample
3660   could not convert 'std::map<int, std::vector<double> >()'
3661     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3662 @end smallexample
3664 Specifying the @option{-fno-elide-type} flag suppresses that behavior.
3665 This flag also affects the output of the
3666 @option{-fdiagnostics-show-template-tree} flag.
3668 @item -fno-show-column
3669 @opindex fno-show-column
3670 Do not print column numbers in diagnostics.  This may be necessary if
3671 diagnostics are being scanned by a program that does not understand the
3672 column numbers, such as @command{dejagnu}.
3674 @end table
3676 @node Warning Options
3677 @section Options to Request or Suppress Warnings
3678 @cindex options to control warnings
3679 @cindex warning messages
3680 @cindex messages, warning
3681 @cindex suppressing warnings
3683 Warnings are diagnostic messages that report constructions that
3684 are not inherently erroneous but that are risky or suggest there
3685 may have been an error.
3687 The following language-independent options do not enable specific
3688 warnings but control the kinds of diagnostics produced by GCC@.
3690 @table @gcctabopt
3691 @cindex syntax checking
3692 @item -fsyntax-only
3693 @opindex fsyntax-only
3694 Check the code for syntax errors, but don't do anything beyond that.
3696 @item -fmax-errors=@var{n}
3697 @opindex fmax-errors
3698 Limits the maximum number of error messages to @var{n}, at which point
3699 GCC bails out rather than attempting to continue processing the source
3700 code.  If @var{n} is 0 (the default), there is no limit on the number
3701 of error messages produced.  If @option{-Wfatal-errors} is also
3702 specified, then @option{-Wfatal-errors} takes precedence over this
3703 option.
3705 @item -w
3706 @opindex w
3707 Inhibit all warning messages.
3709 @item -Werror
3710 @opindex Werror
3711 @opindex Wno-error
3712 Make all warnings into errors.
3714 @item -Werror=
3715 @opindex Werror=
3716 @opindex Wno-error=
3717 Make the specified warning into an error.  The specifier for a warning
3718 is appended; for example @option{-Werror=switch} turns the warnings
3719 controlled by @option{-Wswitch} into errors.  This switch takes a
3720 negative form, to be used to negate @option{-Werror} for specific
3721 warnings; for example @option{-Wno-error=switch} makes
3722 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3723 is in effect.
3725 The warning message for each controllable warning includes the
3726 option that controls the warning.  That option can then be used with
3727 @option{-Werror=} and @option{-Wno-error=} as described above.
3728 (Printing of the option in the warning message can be disabled using the
3729 @option{-fno-diagnostics-show-option} flag.)
3731 Note that specifying @option{-Werror=}@var{foo} automatically implies
3732 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3733 imply anything.
3735 @item -Wfatal-errors
3736 @opindex Wfatal-errors
3737 @opindex Wno-fatal-errors
3738 This option causes the compiler to abort compilation on the first error
3739 occurred rather than trying to keep going and printing further error
3740 messages.
3742 @end table
3744 You can request many specific warnings with options beginning with
3745 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3746 implicit declarations.  Each of these specific warning options also
3747 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3748 example, @option{-Wno-implicit}.  This manual lists only one of the
3749 two forms, whichever is not the default.  For further
3750 language-specific options also refer to @ref{C++ Dialect Options} and
3751 @ref{Objective-C and Objective-C++ Dialect Options}.
3753 Some options, such as @option{-Wall} and @option{-Wextra}, turn on other
3754 options, such as @option{-Wunused}, which may turn on further options,
3755 such as @option{-Wunused-value}. The combined effect of positive and
3756 negative forms is that more specific options have priority over less
3757 specific ones, independently of their position in the command-line. For
3758 options of the same specificity, the last one takes effect. Options
3759 enabled or disabled via pragmas (@pxref{Diagnostic Pragmas}) take effect
3760 as if they appeared at the end of the command-line.
3762 When an unrecognized warning option is requested (e.g.,
3763 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3764 that the option is not recognized.  However, if the @option{-Wno-} form
3765 is used, the behavior is slightly different: no diagnostic is
3766 produced for @option{-Wno-unknown-warning} unless other diagnostics
3767 are being produced.  This allows the use of new @option{-Wno-} options
3768 with old compilers, but if something goes wrong, the compiler
3769 warns that an unrecognized option is present.
3771 @table @gcctabopt
3772 @item -Wpedantic
3773 @itemx -pedantic
3774 @opindex pedantic
3775 @opindex Wpedantic
3776 Issue all the warnings demanded by strict ISO C and ISO C++;
3777 reject all programs that use forbidden extensions, and some other
3778 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3779 version of the ISO C standard specified by any @option{-std} option used.
3781 Valid ISO C and ISO C++ programs should compile properly with or without
3782 this option (though a rare few require @option{-ansi} or a
3783 @option{-std} option specifying the required version of ISO C)@.  However,
3784 without this option, certain GNU extensions and traditional C and C++
3785 features are supported as well.  With this option, they are rejected.
3787 @option{-Wpedantic} does not cause warning messages for use of the
3788 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3789 warnings are also disabled in the expression that follows
3790 @code{__extension__}.  However, only system header files should use
3791 these escape routes; application programs should avoid them.
3792 @xref{Alternate Keywords}.
3794 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3795 C conformance.  They soon find that it does not do quite what they want:
3796 it finds some non-ISO practices, but not all---only those for which
3797 ISO C @emph{requires} a diagnostic, and some others for which
3798 diagnostics have been added.
3800 A feature to report any failure to conform to ISO C might be useful in
3801 some instances, but would require considerable additional work and would
3802 be quite different from @option{-Wpedantic}.  We don't have plans to
3803 support such a feature in the near future.
3805 Where the standard specified with @option{-std} represents a GNU
3806 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3807 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3808 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3809 where they are required by the base standard.  (It does not make sense
3810 for such warnings to be given only for features not in the specified GNU
3811 C dialect, since by definition the GNU dialects of C include all
3812 features the compiler supports with the given option, and there would be
3813 nothing to warn about.)
3815 @item -pedantic-errors
3816 @opindex pedantic-errors
3817 Give an error whenever the @dfn{base standard} (see @option{-Wpedantic})
3818 requires a diagnostic, in some cases where there is undefined behavior
3819 at compile-time and in some other cases that do not prevent compilation
3820 of programs that are valid according to the standard. This is not
3821 equivalent to @option{-Werror=pedantic}, since there are errors enabled
3822 by this option and not enabled by the latter and vice versa.
3824 @item -Wall
3825 @opindex Wall
3826 @opindex Wno-all
3827 This enables all the warnings about constructions that some users
3828 consider questionable, and that are easy to avoid (or modify to
3829 prevent the warning), even in conjunction with macros.  This also
3830 enables some language-specific warnings described in @ref{C++ Dialect
3831 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3833 @option{-Wall} turns on the following warning flags:
3835 @gccoptlist{-Waddress   @gol
3836 -Warray-bounds=1 @r{(only with} @option{-O2}@r{)}  @gol
3837 -Wbool-compare  @gol
3838 -Wbool-operation  @gol
3839 -Wc++11-compat  -Wc++14-compat  @gol
3840 -Wcatch-value @r{(C++ and Objective-C++ only)}  @gol
3841 -Wchar-subscripts  @gol
3842 -Wcomment  @gol
3843 -Wduplicate-decl-specifier @r{(C and Objective-C only)} @gol
3844 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3845 -Wformat   @gol
3846 -Wint-in-bool-context  @gol
3847 -Wimplicit @r{(C and Objective-C only)} @gol
3848 -Wimplicit-int @r{(C and Objective-C only)} @gol
3849 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3850 -Winit-self @r{(only for C++)} @gol
3851 -Wlogical-not-parentheses @gol
3852 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3853 -Wmaybe-uninitialized @gol
3854 -Wmemset-elt-size @gol
3855 -Wmemset-transposed-args @gol
3856 -Wmisleading-indentation @r{(only for C/C++)} @gol
3857 -Wmissing-braces @r{(only for C/ObjC)} @gol
3858 -Wmultistatement-macros  @gol
3859 -Wnarrowing @r{(only for C++)}  @gol
3860 -Wnonnull  @gol
3861 -Wnonnull-compare  @gol
3862 -Wopenmp-simd @gol
3863 -Wparentheses  @gol
3864 -Wpointer-sign  @gol
3865 -Wreorder   @gol
3866 -Wreturn-type  @gol
3867 -Wsequence-point  @gol
3868 -Wsign-compare @r{(only in C++)}  @gol
3869 -Wsizeof-pointer-div @gol
3870 -Wsizeof-pointer-memaccess @gol
3871 -Wstrict-aliasing  @gol
3872 -Wstrict-overflow=1  @gol
3873 -Wswitch  @gol
3874 -Wtautological-compare  @gol
3875 -Wtrigraphs  @gol
3876 -Wuninitialized  @gol
3877 -Wunknown-pragmas  @gol
3878 -Wunused-function  @gol
3879 -Wunused-label     @gol
3880 -Wunused-value     @gol
3881 -Wunused-variable  @gol
3882 -Wvolatile-register-var @gol
3885 Note that some warning flags are not implied by @option{-Wall}.  Some of
3886 them warn about constructions that users generally do not consider
3887 questionable, but which occasionally you might wish to check for;
3888 others warn about constructions that are necessary or hard to avoid in
3889 some cases, and there is no simple way to modify the code to suppress
3890 the warning. Some of them are enabled by @option{-Wextra} but many of
3891 them must be enabled individually.
3893 @item -Wextra
3894 @opindex W
3895 @opindex Wextra
3896 @opindex Wno-extra
3897 This enables some extra warning flags that are not enabled by
3898 @option{-Wall}. (This option used to be called @option{-W}.  The older
3899 name is still supported, but the newer name is more descriptive.)
3901 @gccoptlist{-Wclobbered  @gol
3902 -Wempty-body  @gol
3903 -Wignored-qualifiers @gol
3904 -Wimplicit-fallthrough=3 @gol
3905 -Wmissing-field-initializers  @gol
3906 -Wmissing-parameter-type @r{(C only)}  @gol
3907 -Wold-style-declaration @r{(C only)}  @gol
3908 -Woverride-init  @gol
3909 -Wsign-compare @r{(C only)} @gol
3910 -Wtype-limits  @gol
3911 -Wuninitialized  @gol
3912 -Wshift-negative-value @r{(in C++03 and in C99 and newer)}  @gol
3913 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3914 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3917 The option @option{-Wextra} also prints warning messages for the
3918 following cases:
3920 @itemize @bullet
3922 @item
3923 A pointer is compared against integer zero with @code{<}, @code{<=},
3924 @code{>}, or @code{>=}.
3926 @item
3927 (C++ only) An enumerator and a non-enumerator both appear in a
3928 conditional expression.
3930 @item
3931 (C++ only) Ambiguous virtual bases.
3933 @item
3934 (C++ only) Subscripting an array that has been declared @code{register}.
3936 @item
3937 (C++ only) Taking the address of a variable that has been declared
3938 @code{register}.
3940 @item
3941 (C++ only) A base class is not initialized in the copy constructor
3942 of a derived class.
3944 @end itemize
3946 @item -Wchar-subscripts
3947 @opindex Wchar-subscripts
3948 @opindex Wno-char-subscripts
3949 Warn if an array subscript has type @code{char}.  This is a common cause
3950 of error, as programmers often forget that this type is signed on some
3951 machines.
3952 This warning is enabled by @option{-Wall}.
3954 @item -Wchkp
3955 @opindex Wchkp
3956 Warn about an invalid memory access that is found by Pointer Bounds Checker
3957 (@option{-fcheck-pointer-bounds}).
3959 @item -Wno-coverage-mismatch
3960 @opindex Wno-coverage-mismatch
3961 Warn if feedback profiles do not match when using the
3962 @option{-fprofile-use} option.
3963 If a source file is changed between compiling with @option{-fprofile-gen} and
3964 with @option{-fprofile-use}, the files with the profile feedback can fail
3965 to match the source file and GCC cannot use the profile feedback
3966 information.  By default, this warning is enabled and is treated as an
3967 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3968 warning or @option{-Wno-error=coverage-mismatch} can be used to
3969 disable the error.  Disabling the error for this warning can result in
3970 poorly optimized code and is useful only in the
3971 case of very minor changes such as bug fixes to an existing code-base.
3972 Completely disabling the warning is not recommended.
3974 @item -Wno-cpp
3975 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3977 Suppress warning messages emitted by @code{#warning} directives.
3979 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3980 @opindex Wdouble-promotion
3981 @opindex Wno-double-promotion
3982 Give a warning when a value of type @code{float} is implicitly
3983 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
3984 floating-point unit implement @code{float} in hardware, but emulate
3985 @code{double} in software.  On such a machine, doing computations
3986 using @code{double} values is much more expensive because of the
3987 overhead required for software emulation.
3989 It is easy to accidentally do computations with @code{double} because
3990 floating-point literals are implicitly of type @code{double}.  For
3991 example, in:
3992 @smallexample
3993 @group
3994 float area(float radius)
3996    return 3.14159 * radius * radius;
3998 @end group
3999 @end smallexample
4000 the compiler performs the entire computation with @code{double}
4001 because the floating-point literal is a @code{double}.
4003 @item -Wduplicate-decl-specifier @r{(C and Objective-C only)}
4004 @opindex Wduplicate-decl-specifier
4005 @opindex Wno-duplicate-decl-specifier
4006 Warn if a declaration has duplicate @code{const}, @code{volatile},
4007 @code{restrict} or @code{_Atomic} specifier.  This warning is enabled by
4008 @option{-Wall}.
4010 @item -Wformat
4011 @itemx -Wformat=@var{n}
4012 @opindex Wformat
4013 @opindex Wno-format
4014 @opindex ffreestanding
4015 @opindex fno-builtin
4016 @opindex Wformat=
4017 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
4018 the arguments supplied have types appropriate to the format string
4019 specified, and that the conversions specified in the format string make
4020 sense.  This includes standard functions, and others specified by format
4021 attributes (@pxref{Function Attributes}), in the @code{printf},
4022 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
4023 not in the C standard) families (or other target-specific families).
4024 Which functions are checked without format attributes having been
4025 specified depends on the standard version selected, and such checks of
4026 functions without the attribute specified are disabled by
4027 @option{-ffreestanding} or @option{-fno-builtin}.
4029 The formats are checked against the format features supported by GNU
4030 libc version 2.2.  These include all ISO C90 and C99 features, as well
4031 as features from the Single Unix Specification and some BSD and GNU
4032 extensions.  Other library implementations may not support all these
4033 features; GCC does not support warning about features that go beyond a
4034 particular library's limitations.  However, if @option{-Wpedantic} is used
4035 with @option{-Wformat}, warnings are given about format features not
4036 in the selected standard version (but not for @code{strfmon} formats,
4037 since those are not in any version of the C standard).  @xref{C Dialect
4038 Options,,Options Controlling C Dialect}.
4040 @table @gcctabopt
4041 @item -Wformat=1
4042 @itemx -Wformat
4043 @opindex Wformat
4044 @opindex Wformat=1
4045 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
4046 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
4047 @option{-Wformat} also checks for null format arguments for several
4048 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
4049 aspects of this level of format checking can be disabled by the
4050 options: @option{-Wno-format-contains-nul},
4051 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
4052 @option{-Wformat} is enabled by @option{-Wall}.
4054 @item -Wno-format-contains-nul
4055 @opindex Wno-format-contains-nul
4056 @opindex Wformat-contains-nul
4057 If @option{-Wformat} is specified, do not warn about format strings that
4058 contain NUL bytes.
4060 @item -Wno-format-extra-args
4061 @opindex Wno-format-extra-args
4062 @opindex Wformat-extra-args
4063 If @option{-Wformat} is specified, do not warn about excess arguments to a
4064 @code{printf} or @code{scanf} format function.  The C standard specifies
4065 that such arguments are ignored.
4067 Where the unused arguments lie between used arguments that are
4068 specified with @samp{$} operand number specifications, normally
4069 warnings are still given, since the implementation could not know what
4070 type to pass to @code{va_arg} to skip the unused arguments.  However,
4071 in the case of @code{scanf} formats, this option suppresses the
4072 warning if the unused arguments are all pointers, since the Single
4073 Unix Specification says that such unused arguments are allowed.
4075 @item -Wformat-overflow
4076 @itemx -Wformat-overflow=@var{level}
4077 @opindex Wformat-overflow
4078 @opindex Wno-format-overflow
4079 Warn about calls to formatted input/output functions such as @code{sprintf}
4080 and @code{vsprintf} that might overflow the destination buffer.  When the
4081 exact number of bytes written by a format directive cannot be determined
4082 at compile-time it is estimated based on heuristics that depend on the
4083 @var{level} argument and on optimization.  While enabling optimization
4084 will in most cases improve the accuracy of the warning, it may also
4085 result in false positives.
4087 @table @gcctabopt
4088 @item -Wformat-overflow
4089 @item -Wformat-overflow=1
4090 @opindex Wformat-overflow
4091 @opindex Wno-format-overflow
4092 Level @var{1} of @option{-Wformat-overflow} enabled by @option{-Wformat}
4093 employs a conservative approach that warns only about calls that most
4094 likely overflow the buffer.  At this level, numeric arguments to format
4095 directives with unknown values are assumed to have the value of one, and
4096 strings of unknown length to be empty.  Numeric arguments that are known
4097 to be bounded to a subrange of their type, or string arguments whose output
4098 is bounded either by their directive's precision or by a finite set of
4099 string literals, are assumed to take on the value within the range that
4100 results in the most bytes on output.  For example, the call to @code{sprintf}
4101 below is diagnosed because even with both @var{a} and @var{b} equal to zero,
4102 the terminating NUL character (@code{'\0'}) appended by the function
4103 to the destination buffer will be written past its end.  Increasing
4104 the size of the buffer by a single byte is sufficient to avoid the
4105 warning, though it may not be sufficient to avoid the overflow.
4107 @smallexample
4108 void f (int a, int b)
4110   char buf [12];
4111   sprintf (buf, "a = %i, b = %i\n", a, b);
4113 @end smallexample
4115 @item -Wformat-overflow=2
4116 Level @var{2} warns also about calls that might overflow the destination
4117 buffer given an argument of sufficient length or magnitude.  At level
4118 @var{2}, unknown numeric arguments are assumed to have the minimum
4119 representable value for signed types with a precision greater than 1, and
4120 the maximum representable value otherwise.  Unknown string arguments whose
4121 length cannot be assumed to be bounded either by the directive's precision,
4122 or by a finite set of string literals they may evaluate to, or the character
4123 array they may point to, are assumed to be 1 character long.
4125 At level @var{2}, the call in the example above is again diagnosed, but
4126 this time because with @var{a} equal to a 32-bit @code{INT_MIN} the first
4127 @code{%i} directive will write some of its digits beyond the end of
4128 the destination buffer.  To make the call safe regardless of the values
4129 of the two variables, the size of the destination buffer must be increased
4130 to at least 34 bytes.  GCC includes the minimum size of the buffer in
4131 an informational note following the warning.
4133 An alternative to increasing the size of the destination buffer is to
4134 constrain the range of formatted values.  The maximum length of string
4135 arguments can be bounded by specifying the precision in the format
4136 directive.  When numeric arguments of format directives can be assumed
4137 to be bounded by less than the precision of their type, choosing
4138 an appropriate length modifier to the format specifier will reduce
4139 the required buffer size.  For example, if @var{a} and @var{b} in the
4140 example above can be assumed to be within the precision of
4141 the @code{short int} type then using either the @code{%hi} format
4142 directive or casting the argument to @code{short} reduces the maximum
4143 required size of the buffer to 24 bytes.
4145 @smallexample
4146 void f (int a, int b)
4148   char buf [23];
4149   sprintf (buf, "a = %hi, b = %i\n", a, (short)b);
4151 @end smallexample
4152 @end table
4154 @item -Wno-format-zero-length
4155 @opindex Wno-format-zero-length
4156 @opindex Wformat-zero-length
4157 If @option{-Wformat} is specified, do not warn about zero-length formats.
4158 The C standard specifies that zero-length formats are allowed.
4161 @item -Wformat=2
4162 @opindex Wformat=2
4163 Enable @option{-Wformat} plus additional format checks.  Currently
4164 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
4165 -Wformat-y2k}.
4167 @item -Wformat-nonliteral
4168 @opindex Wformat-nonliteral
4169 @opindex Wno-format-nonliteral
4170 If @option{-Wformat} is specified, also warn if the format string is not a
4171 string literal and so cannot be checked, unless the format function
4172 takes its format arguments as a @code{va_list}.
4174 @item -Wformat-security
4175 @opindex Wformat-security
4176 @opindex Wno-format-security
4177 If @option{-Wformat} is specified, also warn about uses of format
4178 functions that represent possible security problems.  At present, this
4179 warns about calls to @code{printf} and @code{scanf} functions where the
4180 format string is not a string literal and there are no format arguments,
4181 as in @code{printf (foo);}.  This may be a security hole if the format
4182 string came from untrusted input and contains @samp{%n}.  (This is
4183 currently a subset of what @option{-Wformat-nonliteral} warns about, but
4184 in future warnings may be added to @option{-Wformat-security} that are not
4185 included in @option{-Wformat-nonliteral}.)
4187 @item -Wformat-signedness
4188 @opindex Wformat-signedness
4189 @opindex Wno-format-signedness
4190 If @option{-Wformat} is specified, also warn if the format string
4191 requires an unsigned argument and the argument is signed and vice versa.
4193 @item -Wformat-truncation
4194 @itemx -Wformat-truncation=@var{level}
4195 @opindex Wformat-truncation
4196 @opindex Wno-format-truncation
4197 Warn about calls to formatted input/output functions such as @code{snprintf}
4198 and @code{vsnprintf} that might result in output truncation.  When the exact
4199 number of bytes written by a format directive cannot be determined at
4200 compile-time it is estimated based on heuristics that depend on
4201 the @var{level} argument and on optimization.  While enabling optimization
4202 will in most cases improve the accuracy of the warning, it may also result
4203 in false positives.  Except as noted otherwise, the option uses the same
4204 logic @option{-Wformat-overflow}.
4206 @table @gcctabopt
4207 @item -Wformat-truncation
4208 @item -Wformat-truncation=1
4209 @opindex Wformat-truncation
4210 @opindex Wno-format-overflow
4211 Level @var{1} of @option{-Wformat-truncation} enabled by @option{-Wformat}
4212 employs a conservative approach that warns only about calls to bounded
4213 functions whose return value is unused and that will most likely result
4214 in output truncation.
4216 @item -Wformat-truncation=2
4217 Level @var{2} warns also about calls to bounded functions whose return
4218 value is used and that might result in truncation given an argument of
4219 sufficient length or magnitude.
4220 @end table
4222 @item -Wformat-y2k
4223 @opindex Wformat-y2k
4224 @opindex Wno-format-y2k
4225 If @option{-Wformat} is specified, also warn about @code{strftime}
4226 formats that may yield only a two-digit year.
4227 @end table
4229 @item -Wnonnull
4230 @opindex Wnonnull
4231 @opindex Wno-nonnull
4232 Warn about passing a null pointer for arguments marked as
4233 requiring a non-null value by the @code{nonnull} function attribute.
4235 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
4236 can be disabled with the @option{-Wno-nonnull} option.
4238 @item -Wnonnull-compare
4239 @opindex Wnonnull-compare
4240 @opindex Wno-nonnull-compare
4241 Warn when comparing an argument marked with the @code{nonnull}
4242 function attribute against null inside the function.
4244 @option{-Wnonnull-compare} is included in @option{-Wall}.  It
4245 can be disabled with the @option{-Wno-nonnull-compare} option.
4247 @item -Wnull-dereference
4248 @opindex Wnull-dereference
4249 @opindex Wno-null-dereference
4250 Warn if the compiler detects paths that trigger erroneous or
4251 undefined behavior due to dereferencing a null pointer.  This option
4252 is only active when @option{-fdelete-null-pointer-checks} is active,
4253 which is enabled by optimizations in most targets.  The precision of
4254 the warnings depends on the optimization options used.
4256 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
4257 @opindex Winit-self
4258 @opindex Wno-init-self
4259 Warn about uninitialized variables that are initialized with themselves.
4260 Note this option can only be used with the @option{-Wuninitialized} option.
4262 For example, GCC warns about @code{i} being uninitialized in the
4263 following snippet only when @option{-Winit-self} has been specified:
4264 @smallexample
4265 @group
4266 int f()
4268   int i = i;
4269   return i;
4271 @end group
4272 @end smallexample
4274 This warning is enabled by @option{-Wall} in C++.
4276 @item -Wimplicit-int @r{(C and Objective-C only)}
4277 @opindex Wimplicit-int
4278 @opindex Wno-implicit-int
4279 Warn when a declaration does not specify a type.
4280 This warning is enabled by @option{-Wall}.
4282 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
4283 @opindex Wimplicit-function-declaration
4284 @opindex Wno-implicit-function-declaration
4285 Give a warning whenever a function is used before being declared. In
4286 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
4287 enabled by default and it is made into an error by
4288 @option{-pedantic-errors}. This warning is also enabled by
4289 @option{-Wall}.
4291 @item -Wimplicit @r{(C and Objective-C only)}
4292 @opindex Wimplicit
4293 @opindex Wno-implicit
4294 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
4295 This warning is enabled by @option{-Wall}.
4297 @item -Wimplicit-fallthrough
4298 @opindex Wimplicit-fallthrough
4299 @opindex Wno-implicit-fallthrough
4300 @option{-Wimplicit-fallthrough} is the same as @option{-Wimplicit-fallthrough=3}
4301 and @option{-Wno-implicit-fallthrough} is the same as
4302 @option{-Wimplicit-fallthrough=0}.
4304 @item -Wimplicit-fallthrough=@var{n}
4305 @opindex Wimplicit-fallthrough=
4306 Warn when a switch case falls through.  For example:
4308 @smallexample
4309 @group
4310 switch (cond)
4311   @{
4312   case 1:
4313     a = 1;
4314     break;
4315   case 2:
4316     a = 2;
4317   case 3:
4318     a = 3;
4319     break;
4320   @}
4321 @end group
4322 @end smallexample
4324 This warning does not warn when the last statement of a case cannot
4325 fall through, e.g. when there is a return statement or a call to function
4326 declared with the noreturn attribute.  @option{-Wimplicit-fallthrough=}
4327 also takes into account control flow statements, such as ifs, and only
4328 warns when appropriate.  E.g.@:
4330 @smallexample
4331 @group
4332 switch (cond)
4333   @{
4334   case 1:
4335     if (i > 3) @{
4336       bar (5);
4337       break;
4338     @} else if (i < 1) @{
4339       bar (0);
4340     @} else
4341       return;
4342   default:
4343     @dots{}
4344   @}
4345 @end group
4346 @end smallexample
4348 Since there are occasions where a switch case fall through is desirable,
4349 GCC provides an attribute, @code{__attribute__ ((fallthrough))}, that is
4350 to be used along with a null statement to suppress this warning that
4351 would normally occur:
4353 @smallexample
4354 @group
4355 switch (cond)
4356   @{
4357   case 1:
4358     bar (0);
4359     __attribute__ ((fallthrough));
4360   default:
4361     @dots{}
4362   @}
4363 @end group
4364 @end smallexample
4366 C++17 provides a standard way to suppress the @option{-Wimplicit-fallthrough}
4367 warning using @code{[[fallthrough]];} instead of the GNU attribute.  In C++11
4368 or C++14 users can use @code{[[gnu::fallthrough]];}, which is a GNU extension.
4369 Instead of these attributes, it is also possible to add a fallthrough comment
4370 to silence the warning.  The whole body of the C or C++ style comment should
4371 match the given regular expressions listed below.  The option argument @var{n}
4372 specifies what kind of comments are accepted:
4374 @itemize @bullet
4376 @item @option{-Wimplicit-fallthrough=0} disables the warning altogether.
4378 @item @option{-Wimplicit-fallthrough=1} matches @code{.*} regular
4379 expression, any comment is used as fallthrough comment.
4381 @item @option{-Wimplicit-fallthrough=2} case insensitively matches
4382 @code{.*falls?[ \t-]*thr(ough|u).*} regular expression.
4384 @item @option{-Wimplicit-fallthrough=3} case sensitively matches one of the
4385 following regular expressions:
4387 @itemize @bullet
4389 @item @code{-fallthrough}
4391 @item @code{@@fallthrough@@}
4393 @item @code{lint -fallthrough[ \t]*}
4395 @item @code{[ \t.!]*(ELSE,? |INTENTIONAL(LY)? )?@*FALL(S | |-)?THR(OUGH|U)[ \t.!]*(-[^\n\r]*)?}
4397 @item @code{[ \t.!]*(Else,? |Intentional(ly)? )?@*Fall((s | |-)[Tt]|t)hr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4399 @item @code{[ \t.!]*([Ee]lse,? |[Ii]ntentional(ly)? )?@*fall(s | |-)?thr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4401 @end itemize
4403 @item @option{-Wimplicit-fallthrough=4} case sensitively matches one of the
4404 following regular expressions:
4406 @itemize @bullet
4408 @item @code{-fallthrough}
4410 @item @code{@@fallthrough@@}
4412 @item @code{lint -fallthrough[ \t]*}
4414 @item @code{[ \t]*FALLTHR(OUGH|U)[ \t]*}
4416 @end itemize
4418 @item @option{-Wimplicit-fallthrough=5} doesn't recognize any comments as
4419 fallthrough comments, only attributes disable the warning.
4421 @end itemize
4423 The comment needs to be followed after optional whitespace and other comments
4424 by @code{case} or @code{default} keywords or by a user label that precedes some
4425 @code{case} or @code{default} label.
4427 @smallexample
4428 @group
4429 switch (cond)
4430   @{
4431   case 1:
4432     bar (0);
4433     /* FALLTHRU */
4434   default:
4435     @dots{}
4436   @}
4437 @end group
4438 @end smallexample
4440 The @option{-Wimplicit-fallthrough=3} warning is enabled by @option{-Wextra}.
4442 @item -Wif-not-aligned @r{(C, C++, Objective-C and Objective-C++ only)}
4443 @opindex Wif-not-aligned
4444 @opindex Wno-if-not-aligned
4445 Control if warning triggered by the @code{warn_if_not_aligned} attribute
4446 should be issued.  This is is enabled by default.
4447 Use @option{-Wno-if-not-aligned} to disable it.
4449 @item -Wignored-qualifiers @r{(C and C++ only)}
4450 @opindex Wignored-qualifiers
4451 @opindex Wno-ignored-qualifiers
4452 Warn if the return type of a function has a type qualifier
4453 such as @code{const}.  For ISO C such a type qualifier has no effect,
4454 since the value returned by a function is not an lvalue.
4455 For C++, the warning is only emitted for scalar types or @code{void}.
4456 ISO C prohibits qualified @code{void} return types on function
4457 definitions, so such return types always receive a warning
4458 even without this option.
4460 This warning is also enabled by @option{-Wextra}.
4462 @item -Wignored-attributes @r{(C and C++ only)}
4463 @opindex Wignored-attributes
4464 @opindex Wno-ignored-attributes
4465 Warn when an attribute is ignored.  This is different from the
4466 @option{-Wattributes} option in that it warns whenever the compiler decides
4467 to drop an attribute, not that the attribute is either unknown, used in a
4468 wrong place, etc.  This warning is enabled by default.
4470 @item -Wmain
4471 @opindex Wmain
4472 @opindex Wno-main
4473 Warn if the type of @code{main} is suspicious.  @code{main} should be
4474 a function with external linkage, returning int, taking either zero
4475 arguments, two, or three arguments of appropriate types.  This warning
4476 is enabled by default in C++ and is enabled by either @option{-Wall}
4477 or @option{-Wpedantic}.
4479 @item -Wmisleading-indentation @r{(C and C++ only)}
4480 @opindex Wmisleading-indentation
4481 @opindex Wno-misleading-indentation
4482 Warn when the indentation of the code does not reflect the block structure.
4483 Specifically, a warning is issued for @code{if}, @code{else}, @code{while}, and
4484 @code{for} clauses with a guarded statement that does not use braces,
4485 followed by an unguarded statement with the same indentation.
4487 In the following example, the call to ``bar'' is misleadingly indented as
4488 if it were guarded by the ``if'' conditional.
4490 @smallexample
4491   if (some_condition ())
4492     foo ();
4493     bar ();  /* Gotcha: this is not guarded by the "if".  */
4494 @end smallexample
4496 In the case of mixed tabs and spaces, the warning uses the
4497 @option{-ftabstop=} option to determine if the statements line up
4498 (defaulting to 8).
4500 The warning is not issued for code involving multiline preprocessor logic
4501 such as the following example.
4503 @smallexample
4504   if (flagA)
4505     foo (0);
4506 #if SOME_CONDITION_THAT_DOES_NOT_HOLD
4507   if (flagB)
4508 #endif
4509     foo (1);
4510 @end smallexample
4512 The warning is not issued after a @code{#line} directive, since this
4513 typically indicates autogenerated code, and no assumptions can be made
4514 about the layout of the file that the directive references.
4516 This warning is enabled by @option{-Wall} in C and C++.
4518 @item -Wmissing-braces
4519 @opindex Wmissing-braces
4520 @opindex Wno-missing-braces
4521 Warn if an aggregate or union initializer is not fully bracketed.  In
4522 the following example, the initializer for @code{a} is not fully
4523 bracketed, but that for @code{b} is fully bracketed.  This warning is
4524 enabled by @option{-Wall} in C.
4526 @smallexample
4527 int a[2][2] = @{ 0, 1, 2, 3 @};
4528 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
4529 @end smallexample
4531 This warning is enabled by @option{-Wall}.
4533 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
4534 @opindex Wmissing-include-dirs
4535 @opindex Wno-missing-include-dirs
4536 Warn if a user-supplied include directory does not exist.
4538 @item -Wmultistatement-macros
4539 @opindex Wmultistatement-macros
4540 @opindex Wno-multistatement-macros
4541 Warn about unsafe multiple statement macros that appear to be guarded
4542 by a clause such as @code{if}, @code{else}, @code{for}, @code{switch}, or
4543 @code{while}, in which only the first statement is actually guarded after
4544 the macro is expanded.
4546 For example:
4548 @smallexample
4549 #define DOIT x++; y++
4550 if (c)
4551   DOIT;
4552 @end smallexample
4554 will increment @code{y} unconditionally, not just when @code{c} holds.
4555 The can usually be fixed by wrapping the macro in a do-while loop:
4556 @smallexample
4557 #define DOIT do @{ x++; y++; @} while (0)
4558 if (c)
4559   DOIT;
4560 @end smallexample
4562 This warning is enabled by @option{-Wall} in C and C++.
4564 @item -Wparentheses
4565 @opindex Wparentheses
4566 @opindex Wno-parentheses
4567 Warn if parentheses are omitted in certain contexts, such
4568 as when there is an assignment in a context where a truth value
4569 is expected, or when operators are nested whose precedence people
4570 often get confused about.
4572 Also warn if a comparison like @code{x<=y<=z} appears; this is
4573 equivalent to @code{(x<=y ? 1 : 0) <= z}, which is a different
4574 interpretation from that of ordinary mathematical notation.
4576 Also warn for dangerous uses of the GNU extension to
4577 @code{?:} with omitted middle operand. When the condition
4578 in the @code{?}: operator is a boolean expression, the omitted value is
4579 always 1.  Often programmers expect it to be a value computed
4580 inside the conditional expression instead.
4582 For C++ this also warns for some cases of unnecessary parentheses in
4583 declarations, which can indicate an attempt at a function call instead
4584 of a declaration:
4585 @smallexample
4587   // Declares a local variable called mymutex.
4588   std::unique_lock<std::mutex> (mymutex);
4589   // User meant std::unique_lock<std::mutex> lock (mymutex);
4591 @end smallexample
4593 This warning is enabled by @option{-Wall}.
4595 @item -Wsequence-point
4596 @opindex Wsequence-point
4597 @opindex Wno-sequence-point
4598 Warn about code that may have undefined semantics because of violations
4599 of sequence point rules in the C and C++ standards.
4601 The C and C++ standards define the order in which expressions in a C/C++
4602 program are evaluated in terms of @dfn{sequence points}, which represent
4603 a partial ordering between the execution of parts of the program: those
4604 executed before the sequence point, and those executed after it.  These
4605 occur after the evaluation of a full expression (one which is not part
4606 of a larger expression), after the evaluation of the first operand of a
4607 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
4608 function is called (but after the evaluation of its arguments and the
4609 expression denoting the called function), and in certain other places.
4610 Other than as expressed by the sequence point rules, the order of
4611 evaluation of subexpressions of an expression is not specified.  All
4612 these rules describe only a partial order rather than a total order,
4613 since, for example, if two functions are called within one expression
4614 with no sequence point between them, the order in which the functions
4615 are called is not specified.  However, the standards committee have
4616 ruled that function calls do not overlap.
4618 It is not specified when between sequence points modifications to the
4619 values of objects take effect.  Programs whose behavior depends on this
4620 have undefined behavior; the C and C++ standards specify that ``Between
4621 the previous and next sequence point an object shall have its stored
4622 value modified at most once by the evaluation of an expression.
4623 Furthermore, the prior value shall be read only to determine the value
4624 to be stored.''.  If a program breaks these rules, the results on any
4625 particular implementation are entirely unpredictable.
4627 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
4628 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
4629 diagnosed by this option, and it may give an occasional false positive
4630 result, but in general it has been found fairly effective at detecting
4631 this sort of problem in programs.
4633 The C++17 standard will define the order of evaluation of operands in
4634 more cases: in particular it requires that the right-hand side of an
4635 assignment be evaluated before the left-hand side, so the above
4636 examples are no longer undefined.  But this warning will still warn
4637 about them, to help people avoid writing code that is undefined in C
4638 and earlier revisions of C++.
4640 The standard is worded confusingly, therefore there is some debate
4641 over the precise meaning of the sequence point rules in subtle cases.
4642 Links to discussions of the problem, including proposed formal
4643 definitions, may be found on the GCC readings page, at
4644 @uref{http://gcc.gnu.org/@/readings.html}.
4646 This warning is enabled by @option{-Wall} for C and C++.
4648 @item -Wno-return-local-addr
4649 @opindex Wno-return-local-addr
4650 @opindex Wreturn-local-addr
4651 Do not warn about returning a pointer (or in C++, a reference) to a
4652 variable that goes out of scope after the function returns.
4654 @item -Wreturn-type
4655 @opindex Wreturn-type
4656 @opindex Wno-return-type
4657 Warn whenever a function is defined with a return type that defaults
4658 to @code{int}.  Also warn about any @code{return} statement with no
4659 return value in a function whose return type is not @code{void}
4660 (falling off the end of the function body is considered returning
4661 without a value).
4663 For C only, warn about a @code{return} statement with an expression in a
4664 function whose return type is @code{void}, unless the expression type is
4665 also @code{void}.  As a GNU extension, the latter case is accepted
4666 without a warning unless @option{-Wpedantic} is used.
4668 For C++, a function without return type always produces a diagnostic
4669 message, even when @option{-Wno-return-type} is specified.  The only
4670 exceptions are @code{main} and functions defined in system headers.
4672 This warning is enabled by @option{-Wall}.
4674 @item -Wshift-count-negative
4675 @opindex Wshift-count-negative
4676 @opindex Wno-shift-count-negative
4677 Warn if shift count is negative. This warning is enabled by default.
4679 @item -Wshift-count-overflow
4680 @opindex Wshift-count-overflow
4681 @opindex Wno-shift-count-overflow
4682 Warn if shift count >= width of type. This warning is enabled by default.
4684 @item -Wshift-negative-value
4685 @opindex Wshift-negative-value
4686 @opindex Wno-shift-negative-value
4687 Warn if left shifting a negative value.  This warning is enabled by
4688 @option{-Wextra} in C99 and C++11 modes (and newer).
4690 @item -Wshift-overflow
4691 @itemx -Wshift-overflow=@var{n}
4692 @opindex Wshift-overflow
4693 @opindex Wno-shift-overflow
4694 Warn about left shift overflows.  This warning is enabled by
4695 default in C99 and C++11 modes (and newer).
4697 @table @gcctabopt
4698 @item -Wshift-overflow=1
4699 This is the warning level of @option{-Wshift-overflow} and is enabled
4700 by default in C99 and C++11 modes (and newer).  This warning level does
4701 not warn about left-shifting 1 into the sign bit.  (However, in C, such
4702 an overflow is still rejected in contexts where an integer constant expression
4703 is required.)
4705 @item -Wshift-overflow=2
4706 This warning level also warns about left-shifting 1 into the sign bit,
4707 unless C++14 mode is active.
4708 @end table
4710 @item -Wswitch
4711 @opindex Wswitch
4712 @opindex Wno-switch
4713 Warn whenever a @code{switch} statement has an index of enumerated type
4714 and lacks a @code{case} for one or more of the named codes of that
4715 enumeration.  (The presence of a @code{default} label prevents this
4716 warning.)  @code{case} labels outside the enumeration range also
4717 provoke warnings when this option is used (even if there is a
4718 @code{default} label).
4719 This warning is enabled by @option{-Wall}.
4721 @item -Wswitch-default
4722 @opindex Wswitch-default
4723 @opindex Wno-switch-default
4724 Warn whenever a @code{switch} statement does not have a @code{default}
4725 case.
4727 @item -Wswitch-enum
4728 @opindex Wswitch-enum
4729 @opindex Wno-switch-enum
4730 Warn whenever a @code{switch} statement has an index of enumerated type
4731 and lacks a @code{case} for one or more of the named codes of that
4732 enumeration.  @code{case} labels outside the enumeration range also
4733 provoke warnings when this option is used.  The only difference
4734 between @option{-Wswitch} and this option is that this option gives a
4735 warning about an omitted enumeration code even if there is a
4736 @code{default} label.
4738 @item -Wswitch-bool
4739 @opindex Wswitch-bool
4740 @opindex Wno-switch-bool
4741 Warn whenever a @code{switch} statement has an index of boolean type
4742 and the case values are outside the range of a boolean type.
4743 It is possible to suppress this warning by casting the controlling
4744 expression to a type other than @code{bool}.  For example:
4745 @smallexample
4746 @group
4747 switch ((int) (a == 4))
4748   @{
4749   @dots{}
4750   @}
4751 @end group
4752 @end smallexample
4753 This warning is enabled by default for C and C++ programs.
4755 @item -Wswitch-unreachable
4756 @opindex Wswitch-unreachable
4757 @opindex Wno-switch-unreachable
4758 Warn whenever a @code{switch} statement contains statements between the
4759 controlling expression and the first case label, which will never be
4760 executed.  For example:
4761 @smallexample
4762 @group
4763 switch (cond)
4764   @{
4765    i = 15;
4766   @dots{}
4767    case 5:
4768   @dots{}
4769   @}
4770 @end group
4771 @end smallexample
4772 @option{-Wswitch-unreachable} does not warn if the statement between the
4773 controlling expression and the first case label is just a declaration:
4774 @smallexample
4775 @group
4776 switch (cond)
4777   @{
4778    int i;
4779   @dots{}
4780    case 5:
4781    i = 5;
4782   @dots{}
4783   @}
4784 @end group
4785 @end smallexample
4786 This warning is enabled by default for C and C++ programs.
4788 @item -Wsync-nand @r{(C and C++ only)}
4789 @opindex Wsync-nand
4790 @opindex Wno-sync-nand
4791 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
4792 built-in functions are used.  These functions changed semantics in GCC 4.4.
4794 @item -Wunused-but-set-parameter
4795 @opindex Wunused-but-set-parameter
4796 @opindex Wno-unused-but-set-parameter
4797 Warn whenever a function parameter is assigned to, but otherwise unused
4798 (aside from its declaration).
4800 To suppress this warning use the @code{unused} attribute
4801 (@pxref{Variable Attributes}).
4803 This warning is also enabled by @option{-Wunused} together with
4804 @option{-Wextra}.
4806 @item -Wunused-but-set-variable
4807 @opindex Wunused-but-set-variable
4808 @opindex Wno-unused-but-set-variable
4809 Warn whenever a local variable is assigned to, but otherwise unused
4810 (aside from its declaration).
4811 This warning is enabled by @option{-Wall}.
4813 To suppress this warning use the @code{unused} attribute
4814 (@pxref{Variable Attributes}).
4816 This warning is also enabled by @option{-Wunused}, which is enabled
4817 by @option{-Wall}.
4819 @item -Wunused-function
4820 @opindex Wunused-function
4821 @opindex Wno-unused-function
4822 Warn whenever a static function is declared but not defined or a
4823 non-inline static function is unused.
4824 This warning is enabled by @option{-Wall}.
4826 @item -Wunused-label
4827 @opindex Wunused-label
4828 @opindex Wno-unused-label
4829 Warn whenever a label is declared but not used.
4830 This warning is enabled by @option{-Wall}.
4832 To suppress this warning use the @code{unused} attribute
4833 (@pxref{Variable Attributes}).
4835 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
4836 @opindex Wunused-local-typedefs
4837 Warn when a typedef locally defined in a function is not used.
4838 This warning is enabled by @option{-Wall}.
4840 @item -Wunused-parameter
4841 @opindex Wunused-parameter
4842 @opindex Wno-unused-parameter
4843 Warn whenever a function parameter is unused aside from its declaration.
4845 To suppress this warning use the @code{unused} attribute
4846 (@pxref{Variable Attributes}).
4848 @item -Wno-unused-result
4849 @opindex Wunused-result
4850 @opindex Wno-unused-result
4851 Do not warn if a caller of a function marked with attribute
4852 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
4853 its return value. The default is @option{-Wunused-result}.
4855 @item -Wunused-variable
4856 @opindex Wunused-variable
4857 @opindex Wno-unused-variable
4858 Warn whenever a local or static variable is unused aside from its
4859 declaration. This option implies @option{-Wunused-const-variable=1} for C,
4860 but not for C++. This warning is enabled by @option{-Wall}.
4862 To suppress this warning use the @code{unused} attribute
4863 (@pxref{Variable Attributes}).
4865 @item -Wunused-const-variable
4866 @itemx -Wunused-const-variable=@var{n}
4867 @opindex Wunused-const-variable
4868 @opindex Wno-unused-const-variable
4869 Warn whenever a constant static variable is unused aside from its declaration.
4870 @option{-Wunused-const-variable=1} is enabled by @option{-Wunused-variable}
4871 for C, but not for C++. In C this declares variable storage, but in C++ this
4872 is not an error since const variables take the place of @code{#define}s.
4874 To suppress this warning use the @code{unused} attribute
4875 (@pxref{Variable Attributes}).
4877 @table @gcctabopt
4878 @item -Wunused-const-variable=1
4879 This is the warning level that is enabled by @option{-Wunused-variable} for
4880 C.  It warns only about unused static const variables defined in the main
4881 compilation unit, but not about static const variables declared in any
4882 header included.
4884 @item -Wunused-const-variable=2
4885 This warning level also warns for unused constant static variables in
4886 headers (excluding system headers).  This is the warning level of
4887 @option{-Wunused-const-variable} and must be explicitly requested since
4888 in C++ this isn't an error and in C it might be harder to clean up all
4889 headers included.
4890 @end table
4892 @item -Wunused-value
4893 @opindex Wunused-value
4894 @opindex Wno-unused-value
4895 Warn whenever a statement computes a result that is explicitly not
4896 used. To suppress this warning cast the unused expression to
4897 @code{void}. This includes an expression-statement or the left-hand
4898 side of a comma expression that contains no side effects. For example,
4899 an expression such as @code{x[i,j]} causes a warning, while
4900 @code{x[(void)i,j]} does not.
4902 This warning is enabled by @option{-Wall}.
4904 @item -Wunused
4905 @opindex Wunused
4906 @opindex Wno-unused
4907 All the above @option{-Wunused} options combined.
4909 In order to get a warning about an unused function parameter, you must
4910 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
4911 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
4913 @item -Wuninitialized
4914 @opindex Wuninitialized
4915 @opindex Wno-uninitialized
4916 Warn if an automatic variable is used without first being initialized
4917 or if a variable may be clobbered by a @code{setjmp} call. In C++,
4918 warn if a non-static reference or non-static @code{const} member
4919 appears in a class without constructors.
4921 If you want to warn about code that uses the uninitialized value of the
4922 variable in its own initializer, use the @option{-Winit-self} option.
4924 These warnings occur for individual uninitialized or clobbered
4925 elements of structure, union or array variables as well as for
4926 variables that are uninitialized or clobbered as a whole.  They do
4927 not occur for variables or elements declared @code{volatile}.  Because
4928 these warnings depend on optimization, the exact variables or elements
4929 for which there are warnings depends on the precise optimization
4930 options and version of GCC used.
4932 Note that there may be no warning about a variable that is used only
4933 to compute a value that itself is never used, because such
4934 computations may be deleted by data flow analysis before the warnings
4935 are printed.
4937 @item -Winvalid-memory-model
4938 @opindex Winvalid-memory-model
4939 @opindex Wno-invalid-memory-model
4940 Warn for invocations of @ref{__atomic Builtins}, @ref{__sync Builtins},
4941 and the C11 atomic generic functions with a memory consistency argument
4942 that is either invalid for the operation or outside the range of values
4943 of the @code{memory_order} enumeration.  For example, since the
4944 @code{__atomic_store} and @code{__atomic_store_n} built-ins are only
4945 defined for the relaxed, release, and sequentially consistent memory
4946 orders the following code is diagnosed:
4948 @smallexample
4949 void store (int *i)
4951   __atomic_store_n (i, 0, memory_order_consume);
4953 @end smallexample
4955 @option{-Winvalid-memory-model} is enabled by default.
4957 @item -Wmaybe-uninitialized
4958 @opindex Wmaybe-uninitialized
4959 @opindex Wno-maybe-uninitialized
4960 For an automatic variable, if there exists a path from the function
4961 entry to a use of the variable that is initialized, but there exist
4962 some other paths for which the variable is not initialized, the compiler
4963 emits a warning if it cannot prove the uninitialized paths are not
4964 executed at run time. These warnings are made optional because GCC is
4965 not smart enough to see all the reasons why the code might be correct
4966 in spite of appearing to have an error.  Here is one example of how
4967 this can happen:
4969 @smallexample
4970 @group
4972   int x;
4973   switch (y)
4974     @{
4975     case 1: x = 1;
4976       break;
4977     case 2: x = 4;
4978       break;
4979     case 3: x = 5;
4980     @}
4981   foo (x);
4983 @end group
4984 @end smallexample
4986 @noindent
4987 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
4988 always initialized, but GCC doesn't know this. To suppress the
4989 warning, you need to provide a default case with assert(0) or
4990 similar code.
4992 @cindex @code{longjmp} warnings
4993 This option also warns when a non-volatile automatic variable might be
4994 changed by a call to @code{longjmp}.  These warnings as well are possible
4995 only in optimizing compilation.
4997 The compiler sees only the calls to @code{setjmp}.  It cannot know
4998 where @code{longjmp} will be called; in fact, a signal handler could
4999 call it at any point in the code.  As a result, you may get a warning
5000 even when there is in fact no problem because @code{longjmp} cannot
5001 in fact be called at the place that would cause a problem.
5003 Some spurious warnings can be avoided if you declare all the functions
5004 you use that never return as @code{noreturn}.  @xref{Function
5005 Attributes}.
5007 This warning is enabled by @option{-Wall} or @option{-Wextra}.
5009 @item -Wunknown-pragmas
5010 @opindex Wunknown-pragmas
5011 @opindex Wno-unknown-pragmas
5012 @cindex warning for unknown pragmas
5013 @cindex unknown pragmas, warning
5014 @cindex pragmas, warning of unknown
5015 Warn when a @code{#pragma} directive is encountered that is not understood by 
5016 GCC@.  If this command-line option is used, warnings are even issued
5017 for unknown pragmas in system header files.  This is not the case if
5018 the warnings are only enabled by the @option{-Wall} command-line option.
5020 @item -Wno-pragmas
5021 @opindex Wno-pragmas
5022 @opindex Wpragmas
5023 Do not warn about misuses of pragmas, such as incorrect parameters,
5024 invalid syntax, or conflicts between pragmas.  See also
5025 @option{-Wunknown-pragmas}.
5027 @item -Wstrict-aliasing
5028 @opindex Wstrict-aliasing
5029 @opindex Wno-strict-aliasing
5030 This option is only active when @option{-fstrict-aliasing} is active.
5031 It warns about code that might break the strict aliasing rules that the
5032 compiler is using for optimization.  The warning does not catch all
5033 cases, but does attempt to catch the more common pitfalls.  It is
5034 included in @option{-Wall}.
5035 It is equivalent to @option{-Wstrict-aliasing=3}
5037 @item -Wstrict-aliasing=n
5038 @opindex Wstrict-aliasing=n
5039 This option is only active when @option{-fstrict-aliasing} is active.
5040 It warns about code that might break the strict aliasing rules that the
5041 compiler is using for optimization.
5042 Higher levels correspond to higher accuracy (fewer false positives).
5043 Higher levels also correspond to more effort, similar to the way @option{-O} 
5044 works.
5045 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
5047 Level 1: Most aggressive, quick, least accurate.
5048 Possibly useful when higher levels
5049 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
5050 false negatives.  However, it has many false positives.
5051 Warns for all pointer conversions between possibly incompatible types,
5052 even if never dereferenced.  Runs in the front end only.
5054 Level 2: Aggressive, quick, not too precise.
5055 May still have many false positives (not as many as level 1 though),
5056 and few false negatives (but possibly more than level 1).
5057 Unlike level 1, it only warns when an address is taken.  Warns about
5058 incomplete types.  Runs in the front end only.
5060 Level 3 (default for @option{-Wstrict-aliasing}):
5061 Should have very few false positives and few false
5062 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
5063 Takes care of the common pun+dereference pattern in the front end:
5064 @code{*(int*)&some_float}.
5065 If optimization is enabled, it also runs in the back end, where it deals
5066 with multiple statement cases using flow-sensitive points-to information.
5067 Only warns when the converted pointer is dereferenced.
5068 Does not warn about incomplete types.
5070 @item -Wstrict-overflow
5071 @itemx -Wstrict-overflow=@var{n}
5072 @opindex Wstrict-overflow
5073 @opindex Wno-strict-overflow
5074 This option is only active when signed overflow is undefined.
5075 It warns about cases where the compiler optimizes based on the
5076 assumption that signed overflow does not occur.  Note that it does not
5077 warn about all cases where the code might overflow: it only warns
5078 about cases where the compiler implements some optimization.  Thus
5079 this warning depends on the optimization level.
5081 An optimization that assumes that signed overflow does not occur is
5082 perfectly safe if the values of the variables involved are such that
5083 overflow never does, in fact, occur.  Therefore this warning can
5084 easily give a false positive: a warning about code that is not
5085 actually a problem.  To help focus on important issues, several
5086 warning levels are defined.  No warnings are issued for the use of
5087 undefined signed overflow when estimating how many iterations a loop
5088 requires, in particular when determining whether a loop will be
5089 executed at all.
5091 @table @gcctabopt
5092 @item -Wstrict-overflow=1
5093 Warn about cases that are both questionable and easy to avoid.  For
5094 example the compiler simplifies
5095 @code{x + 1 > x} to @code{1}.  This level of
5096 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
5097 are not, and must be explicitly requested.
5099 @item -Wstrict-overflow=2
5100 Also warn about other cases where a comparison is simplified to a
5101 constant.  For example: @code{abs (x) >= 0}.  This can only be
5102 simplified when signed integer overflow is undefined, because
5103 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
5104 zero.  @option{-Wstrict-overflow} (with no level) is the same as
5105 @option{-Wstrict-overflow=2}.
5107 @item -Wstrict-overflow=3
5108 Also warn about other cases where a comparison is simplified.  For
5109 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
5111 @item -Wstrict-overflow=4
5112 Also warn about other simplifications not covered by the above cases.
5113 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
5115 @item -Wstrict-overflow=5
5116 Also warn about cases where the compiler reduces the magnitude of a
5117 constant involved in a comparison.  For example: @code{x + 2 > y} is
5118 simplified to @code{x + 1 >= y}.  This is reported only at the
5119 highest warning level because this simplification applies to many
5120 comparisons, so this warning level gives a very large number of
5121 false positives.
5122 @end table
5124 @item -Wstringop-overflow
5125 @itemx -Wstringop-overflow=@var{type}
5126 @opindex Wstringop-overflow
5127 @opindex Wno-stringop-overflow
5128 Warn for calls to string manipulation functions such as @code{memcpy} and
5129 @code{strcpy} that are determined to overflow the destination buffer.  The
5130 optional argument is one greater than the type of Object Size Checking to
5131 perform to determine the size of the destination.  @xref{Object Size Checking}.
5132 The argument is meaningful only for functions that operate on character arrays
5133 but not for raw memory functions like @code{memcpy} which always make use
5134 of Object Size type-0.  The option also warns for calls that specify a size
5135 in excess of the largest possible object or at most @code{SIZE_MAX / 2} bytes.
5136 The option produces the best results with optimization enabled but can detect
5137 a small subset of simple buffer overflows even without optimization in
5138 calls to the GCC built-in functions like @code{__builtin_memcpy} that
5139 correspond to the standard functions.  In any case, the option warns about
5140 just a subset of buffer overflows detected by the corresponding overflow
5141 checking built-ins.  For example, the option will issue a warning for
5142 the @code{strcpy} call below because it copies at least 5 characters
5143 (the string @code{"blue"} including the terminating NUL) into the buffer
5144 of size 4.
5146 @smallexample
5147 enum Color @{ blue, purple, yellow @};
5148 const char* f (enum Color clr)
5150   static char buf [4];
5151   const char *str;
5152   switch (clr)
5153     @{
5154       case blue: str = "blue"; break;
5155       case purple: str = "purple"; break;
5156       case yellow: str = "yellow"; break;
5157     @}
5159   return strcpy (buf, str);   // warning here
5161 @end smallexample
5163 Option @option{-Wstringop-overflow=2} is enabled by default.
5165 @table @gcctabopt
5166 @item -Wstringop-overflow
5167 @item -Wstringop-overflow=1
5168 @opindex Wstringop-overflow
5169 @opindex Wno-stringop-overflow
5170 The @option{-Wstringop-overflow=1} option uses type-zero Object Size Checking
5171 to determine the sizes of destination objects.  This is the default setting
5172 of the option.  At this setting the option will not warn for writes past
5173 the end of subobjects of larger objects accessed by pointers unless the
5174 size of the largest surrounding object is known.  When the destination may
5175 be one of several objects it is assumed to be the largest one of them.  On
5176 Linux systems, when optimization is enabled at this setting the option warns
5177 for the same code as when the @code{_FORTIFY_SOURCE} macro is defined to
5178 a non-zero value.
5180 @item -Wstringop-overflow=2
5181 The @option{-Wstringop-overflow=2} option uses type-one Object Size Checking
5182 to determine the sizes of destination objects.  At this setting the option
5183 will warn about overflows when writing to members of the largest complete
5184 objects whose exact size is known.  It will, however, not warn for excessive
5185 writes to the same members of unknown objects referenced by pointers since
5186 they may point to arrays containing unknown numbers of elements.
5188 @item -Wstringop-overflow=3
5189 The @option{-Wstringop-overflow=3} option uses type-two Object Size Checking
5190 to determine the sizes of destination objects.  At this setting the option
5191 warns about overflowing the smallest object or data member.  This is the
5192 most restrictive setting of the option that may result in warnings for safe
5193 code.
5195 @item -Wstringop-overflow=4
5196 The @option{-Wstringop-overflow=4} option uses type-three Object Size Checking
5197 to determine the sizes of destination objects.  At this setting the option
5198 will warn about overflowing any data members, and when the destination is
5199 one of several objects it uses the size of the largest of them to decide
5200 whether to issue a warning.  Similarly to @option{-Wstringop-overflow=3} this
5201 setting of the option may result in warnings for benign code.
5202 @end table
5204 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{|}cold@r{]}
5205 @opindex Wsuggest-attribute=
5206 @opindex Wno-suggest-attribute=
5207 Warn for cases where adding an attribute may be beneficial. The
5208 attributes currently supported are listed below.
5210 @table @gcctabopt
5211 @item -Wsuggest-attribute=pure
5212 @itemx -Wsuggest-attribute=const
5213 @itemx -Wsuggest-attribute=noreturn
5214 @opindex Wsuggest-attribute=pure
5215 @opindex Wno-suggest-attribute=pure
5216 @opindex Wsuggest-attribute=const
5217 @opindex Wno-suggest-attribute=const
5218 @opindex Wsuggest-attribute=noreturn
5219 @opindex Wno-suggest-attribute=noreturn
5221 Warn about functions that might be candidates for attributes
5222 @code{pure}, @code{const} or @code{noreturn}.  The compiler only warns for
5223 functions visible in other compilation units or (in the case of @code{pure} and
5224 @code{const}) if it cannot prove that the function returns normally. A function
5225 returns normally if it doesn't contain an infinite loop or return abnormally
5226 by throwing, calling @code{abort} or trapping.  This analysis requires option
5227 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
5228 higher.  Higher optimization levels improve the accuracy of the analysis.
5230 @item -Wsuggest-attribute=format
5231 @itemx -Wmissing-format-attribute
5232 @opindex Wsuggest-attribute=format
5233 @opindex Wmissing-format-attribute
5234 @opindex Wno-suggest-attribute=format
5235 @opindex Wno-missing-format-attribute
5236 @opindex Wformat
5237 @opindex Wno-format
5239 Warn about function pointers that might be candidates for @code{format}
5240 attributes.  Note these are only possible candidates, not absolute ones.
5241 GCC guesses that function pointers with @code{format} attributes that
5242 are used in assignment, initialization, parameter passing or return
5243 statements should have a corresponding @code{format} attribute in the
5244 resulting type.  I.e.@: the left-hand side of the assignment or
5245 initialization, the type of the parameter variable, or the return type
5246 of the containing function respectively should also have a @code{format}
5247 attribute to avoid the warning.
5249 GCC also warns about function definitions that might be
5250 candidates for @code{format} attributes.  Again, these are only
5251 possible candidates.  GCC guesses that @code{format} attributes
5252 might be appropriate for any function that calls a function like
5253 @code{vprintf} or @code{vscanf}, but this might not always be the
5254 case, and some functions for which @code{format} attributes are
5255 appropriate may not be detected.
5257 @item -Wsuggest-attribute=cold
5258 @opindex Wsuggest-attribute=cold
5259 @opindex Wno-suggest-attribute=cold
5261 Warn about functions that might be candidates for @code{cold} attribute.  This
5262 is based on static detection and generally will only warn about functions which
5263 always leads to a call to another @code{cold} function such as wrappers of
5264 C++ @code{throw} or fatal error reporting functions leading to @code{abort}.
5265 @end table
5267 @item -Wsuggest-final-types
5268 @opindex Wno-suggest-final-types
5269 @opindex Wsuggest-final-types
5270 Warn about types with virtual methods where code quality would be improved
5271 if the type were declared with the C++11 @code{final} specifier, 
5272 or, if possible,
5273 declared in an anonymous namespace. This allows GCC to more aggressively
5274 devirtualize the polymorphic calls. This warning is more effective with link
5275 time optimization, where the information about the class hierarchy graph is
5276 more complete.
5278 @item -Wsuggest-final-methods
5279 @opindex Wno-suggest-final-methods
5280 @opindex Wsuggest-final-methods
5281 Warn about virtual methods where code quality would be improved if the method
5282 were declared with the C++11 @code{final} specifier, 
5283 or, if possible, its type were
5284 declared in an anonymous namespace or with the @code{final} specifier.
5285 This warning is
5286 more effective with link-time optimization, where the information about the
5287 class hierarchy graph is more complete. It is recommended to first consider
5288 suggestions of @option{-Wsuggest-final-types} and then rebuild with new
5289 annotations.
5291 @item -Wsuggest-override
5292 Warn about overriding virtual functions that are not marked with the override
5293 keyword.
5295 @item -Walloc-zero
5296 @opindex Wno-alloc-zero
5297 @opindex Walloc-zero
5298 Warn about calls to allocation functions decorated with attribute
5299 @code{alloc_size} that specify zero bytes, including those to the built-in
5300 forms of the functions @code{aligned_alloc}, @code{alloca}, @code{calloc},
5301 @code{malloc}, and @code{realloc}.  Because the behavior of these functions
5302 when called with a zero size differs among implementations (and in the case
5303 of @code{realloc} has been deprecated) relying on it may result in subtle
5304 portability bugs and should be avoided.
5306 @item -Walloc-size-larger-than=@var{n}
5307 Warn about calls to functions decorated with attribute @code{alloc_size}
5308 that attempt to allocate objects larger than the specified number of bytes,
5309 or where the result of the size computation in an integer type with infinite
5310 precision would exceed @code{SIZE_MAX / 2}.  The option argument @var{n}
5311 may end in one of the standard suffixes designating a multiple of bytes
5312 such as @code{kB} and @code{KiB} for kilobyte and kibibyte, respectively,
5313 @code{MB} and @code{MiB} for megabyte and mebibyte, and so on.
5314 @xref{Function Attributes}.
5316 @item -Walloca
5317 @opindex Wno-alloca
5318 @opindex Walloca
5319 This option warns on all uses of @code{alloca} in the source.
5321 @item -Walloca-larger-than=@var{n}
5322 This option warns on calls to @code{alloca} that are not bounded by a
5323 controlling predicate limiting its argument of integer type to at most
5324 @var{n} bytes, or calls to @code{alloca} where the bound is unknown.
5325 Arguments of non-integer types are considered unbounded even if they
5326 appear to be constrained to the expected range.
5328 For example, a bounded case of @code{alloca} could be:
5330 @smallexample
5331 void func (size_t n)
5333   void *p;
5334   if (n <= 1000)
5335     p = alloca (n);
5336   else
5337     p = malloc (n);
5338   f (p);
5340 @end smallexample
5342 In the above example, passing @code{-Walloca-larger-than=1000} would not
5343 issue a warning because the call to @code{alloca} is known to be at most
5344 1000 bytes.  However, if @code{-Walloca-larger-than=500} were passed,
5345 the compiler would emit a warning.
5347 Unbounded uses, on the other hand, are uses of @code{alloca} with no
5348 controlling predicate constraining its integer argument.  For example:
5350 @smallexample
5351 void func ()
5353   void *p = alloca (n);
5354   f (p);
5356 @end smallexample
5358 If @code{-Walloca-larger-than=500} were passed, the above would trigger
5359 a warning, but this time because of the lack of bounds checking.
5361 Note, that even seemingly correct code involving signed integers could
5362 cause a warning:
5364 @smallexample
5365 void func (signed int n)
5367   if (n < 500)
5368     @{
5369       p = alloca (n);
5370       f (p);
5371     @}
5373 @end smallexample
5375 In the above example, @var{n} could be negative, causing a larger than
5376 expected argument to be implicitly cast into the @code{alloca} call.
5378 This option also warns when @code{alloca} is used in a loop.
5380 This warning is not enabled by @option{-Wall}, and is only active when
5381 @option{-ftree-vrp} is active (default for @option{-O2} and above).
5383 See also @option{-Wvla-larger-than=@var{n}}.
5385 @item -Warray-bounds
5386 @itemx -Warray-bounds=@var{n}
5387 @opindex Wno-array-bounds
5388 @opindex Warray-bounds
5389 This option is only active when @option{-ftree-vrp} is active
5390 (default for @option{-O2} and above). It warns about subscripts to arrays
5391 that are always out of bounds. This warning is enabled by @option{-Wall}.
5393 @table @gcctabopt
5394 @item -Warray-bounds=1
5395 This is the warning level of @option{-Warray-bounds} and is enabled
5396 by @option{-Wall}; higher levels are not, and must be explicitly requested.
5398 @item -Warray-bounds=2
5399 This warning level also warns about out of bounds access for
5400 arrays at the end of a struct and for arrays accessed through
5401 pointers. This warning level may give a larger number of
5402 false positives and is deactivated by default.
5403 @end table
5405 @item -Wbool-compare
5406 @opindex Wno-bool-compare
5407 @opindex Wbool-compare
5408 Warn about boolean expression compared with an integer value different from
5409 @code{true}/@code{false}.  For instance, the following comparison is
5410 always false:
5411 @smallexample
5412 int n = 5;
5413 @dots{}
5414 if ((n > 1) == 2) @{ @dots{} @}
5415 @end smallexample
5416 This warning is enabled by @option{-Wall}.
5418 @item -Wbool-operation
5419 @opindex Wno-bool-operation
5420 @opindex Wbool-operation
5421 Warn about suspicious operations on expressions of a boolean type.  For
5422 instance, bitwise negation of a boolean is very likely a bug in the program.
5423 For C, this warning also warns about incrementing or decrementing a boolean,
5424 which rarely makes sense.  (In C++, decrementing a boolean is always invalid.
5425 Incrementing a boolean is invalid in C++17, and deprecated otherwise.)
5427 This warning is enabled by @option{-Wall}.
5429 @item -Wduplicated-branches
5430 @opindex Wno-duplicated-branches
5431 @opindex Wduplicated-branches
5432 Warn when an if-else has identical branches.  This warning detects cases like
5433 @smallexample
5434 if (p != NULL)
5435   return 0;
5436 else
5437   return 0;
5438 @end smallexample
5439 It doesn't warn when both branches contain just a null statement.  This warning
5440 also warn for conditional operators:
5441 @smallexample
5442   int i = x ? *p : *p;
5443 @end smallexample
5445 @item -Wduplicated-cond
5446 @opindex Wno-duplicated-cond
5447 @opindex Wduplicated-cond
5448 Warn about duplicated conditions in an if-else-if chain.  For instance,
5449 warn for the following code:
5450 @smallexample
5451 if (p->q != NULL) @{ @dots{} @}
5452 else if (p->q != NULL) @{ @dots{} @}
5453 @end smallexample
5455 @item -Wframe-address
5456 @opindex Wno-frame-address
5457 @opindex Wframe-address
5458 Warn when the @samp{__builtin_frame_address} or @samp{__builtin_return_address}
5459 is called with an argument greater than 0.  Such calls may return indeterminate
5460 values or crash the program.  The warning is included in @option{-Wall}.
5462 @item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
5463 @opindex Wno-discarded-qualifiers
5464 @opindex Wdiscarded-qualifiers
5465 Do not warn if type qualifiers on pointers are being discarded.
5466 Typically, the compiler warns if a @code{const char *} variable is
5467 passed to a function that takes a @code{char *} parameter.  This option
5468 can be used to suppress such a warning.
5470 @item -Wno-discarded-array-qualifiers @r{(C and Objective-C only)}
5471 @opindex Wno-discarded-array-qualifiers
5472 @opindex Wdiscarded-array-qualifiers
5473 Do not warn if type qualifiers on arrays which are pointer targets
5474 are being discarded. Typically, the compiler warns if a
5475 @code{const int (*)[]} variable is passed to a function that
5476 takes a @code{int (*)[]} parameter.  This option can be used to
5477 suppress such a warning.
5479 @item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
5480 @opindex Wno-incompatible-pointer-types
5481 @opindex Wincompatible-pointer-types
5482 Do not warn when there is a conversion between pointers that have incompatible
5483 types.  This warning is for cases not covered by @option{-Wno-pointer-sign},
5484 which warns for pointer argument passing or assignment with different
5485 signedness.
5487 @item -Wno-int-conversion @r{(C and Objective-C only)}
5488 @opindex Wno-int-conversion
5489 @opindex Wint-conversion
5490 Do not warn about incompatible integer to pointer and pointer to integer
5491 conversions.  This warning is about implicit conversions; for explicit
5492 conversions the warnings @option{-Wno-int-to-pointer-cast} and
5493 @option{-Wno-pointer-to-int-cast} may be used.
5495 @item -Wno-div-by-zero
5496 @opindex Wno-div-by-zero
5497 @opindex Wdiv-by-zero
5498 Do not warn about compile-time integer division by zero.  Floating-point
5499 division by zero is not warned about, as it can be a legitimate way of
5500 obtaining infinities and NaNs.
5502 @item -Wsystem-headers
5503 @opindex Wsystem-headers
5504 @opindex Wno-system-headers
5505 @cindex warnings from system headers
5506 @cindex system headers, warnings from
5507 Print warning messages for constructs found in system header files.
5508 Warnings from system headers are normally suppressed, on the assumption
5509 that they usually do not indicate real problems and would only make the
5510 compiler output harder to read.  Using this command-line option tells
5511 GCC to emit warnings from system headers as if they occurred in user
5512 code.  However, note that using @option{-Wall} in conjunction with this
5513 option does @emph{not} warn about unknown pragmas in system
5514 headers---for that, @option{-Wunknown-pragmas} must also be used.
5516 @item -Wtautological-compare
5517 @opindex Wtautological-compare
5518 @opindex Wno-tautological-compare
5519 Warn if a self-comparison always evaluates to true or false.  This
5520 warning detects various mistakes such as:
5521 @smallexample
5522 int i = 1;
5523 @dots{}
5524 if (i > i) @{ @dots{} @}
5525 @end smallexample
5527 This warning also warns about bitwise comparisons that always evaluate
5528 to true or false, for instance:
5529 @smallexample
5530 if ((a & 16) == 10) @{ @dots{} @}
5531 @end smallexample
5532 will always be false.
5534 This warning is enabled by @option{-Wall}.
5536 @item -Wtrampolines
5537 @opindex Wtrampolines
5538 @opindex Wno-trampolines
5539 Warn about trampolines generated for pointers to nested functions.
5540 A trampoline is a small piece of data or code that is created at run
5541 time on the stack when the address of a nested function is taken, and is
5542 used to call the nested function indirectly.  For some targets, it is
5543 made up of data only and thus requires no special treatment.  But, for
5544 most targets, it is made up of code and thus requires the stack to be
5545 made executable in order for the program to work properly.
5547 @item -Wfloat-equal
5548 @opindex Wfloat-equal
5549 @opindex Wno-float-equal
5550 Warn if floating-point values are used in equality comparisons.
5552 The idea behind this is that sometimes it is convenient (for the
5553 programmer) to consider floating-point values as approximations to
5554 infinitely precise real numbers.  If you are doing this, then you need
5555 to compute (by analyzing the code, or in some other way) the maximum or
5556 likely maximum error that the computation introduces, and allow for it
5557 when performing comparisons (and when producing output, but that's a
5558 different problem).  In particular, instead of testing for equality, you
5559 should check to see whether the two values have ranges that overlap; and
5560 this is done with the relational operators, so equality comparisons are
5561 probably mistaken.
5563 @item -Wtraditional @r{(C and Objective-C only)}
5564 @opindex Wtraditional
5565 @opindex Wno-traditional
5566 Warn about certain constructs that behave differently in traditional and
5567 ISO C@.  Also warn about ISO C constructs that have no traditional C
5568 equivalent, and/or problematic constructs that should be avoided.
5570 @itemize @bullet
5571 @item
5572 Macro parameters that appear within string literals in the macro body.
5573 In traditional C macro replacement takes place within string literals,
5574 but in ISO C it does not.
5576 @item
5577 In traditional C, some preprocessor directives did not exist.
5578 Traditional preprocessors only considered a line to be a directive
5579 if the @samp{#} appeared in column 1 on the line.  Therefore
5580 @option{-Wtraditional} warns about directives that traditional C
5581 understands but ignores because the @samp{#} does not appear as the
5582 first character on the line.  It also suggests you hide directives like
5583 @code{#pragma} not understood by traditional C by indenting them.  Some
5584 traditional implementations do not recognize @code{#elif}, so this option
5585 suggests avoiding it altogether.
5587 @item
5588 A function-like macro that appears without arguments.
5590 @item
5591 The unary plus operator.
5593 @item
5594 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
5595 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
5596 constants.)  Note, these suffixes appear in macros defined in the system
5597 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
5598 Use of these macros in user code might normally lead to spurious
5599 warnings, however GCC's integrated preprocessor has enough context to
5600 avoid warning in these cases.
5602 @item
5603 A function declared external in one block and then used after the end of
5604 the block.
5606 @item
5607 A @code{switch} statement has an operand of type @code{long}.
5609 @item
5610 A non-@code{static} function declaration follows a @code{static} one.
5611 This construct is not accepted by some traditional C compilers.
5613 @item
5614 The ISO type of an integer constant has a different width or
5615 signedness from its traditional type.  This warning is only issued if
5616 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
5617 typically represent bit patterns, are not warned about.
5619 @item
5620 Usage of ISO string concatenation is detected.
5622 @item
5623 Initialization of automatic aggregates.
5625 @item
5626 Identifier conflicts with labels.  Traditional C lacks a separate
5627 namespace for labels.
5629 @item
5630 Initialization of unions.  If the initializer is zero, the warning is
5631 omitted.  This is done under the assumption that the zero initializer in
5632 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
5633 initializer warnings and relies on default initialization to zero in the
5634 traditional C case.
5636 @item
5637 Conversions by prototypes between fixed/floating-point values and vice
5638 versa.  The absence of these prototypes when compiling with traditional
5639 C causes serious problems.  This is a subset of the possible
5640 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
5642 @item
5643 Use of ISO C style function definitions.  This warning intentionally is
5644 @emph{not} issued for prototype declarations or variadic functions
5645 because these ISO C features appear in your code when using
5646 libiberty's traditional C compatibility macros, @code{PARAMS} and
5647 @code{VPARAMS}.  This warning is also bypassed for nested functions
5648 because that feature is already a GCC extension and thus not relevant to
5649 traditional C compatibility.
5650 @end itemize
5652 @item -Wtraditional-conversion @r{(C and Objective-C only)}
5653 @opindex Wtraditional-conversion
5654 @opindex Wno-traditional-conversion
5655 Warn if a prototype causes a type conversion that is different from what
5656 would happen to the same argument in the absence of a prototype.  This
5657 includes conversions of fixed point to floating and vice versa, and
5658 conversions changing the width or signedness of a fixed-point argument
5659 except when the same as the default promotion.
5661 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
5662 @opindex Wdeclaration-after-statement
5663 @opindex Wno-declaration-after-statement
5664 Warn when a declaration is found after a statement in a block.  This
5665 construct, known from C++, was introduced with ISO C99 and is by default
5666 allowed in GCC@.  It is not supported by ISO C90.  @xref{Mixed Declarations}.
5668 @item -Wshadow
5669 @opindex Wshadow
5670 @opindex Wno-shadow
5671 Warn whenever a local variable or type declaration shadows another
5672 variable, parameter, type, class member (in C++), or instance variable
5673 (in Objective-C) or whenever a built-in function is shadowed. Note
5674 that in C++, the compiler warns if a local variable shadows an
5675 explicit typedef, but not if it shadows a struct/class/enum.
5676 Same as @option{-Wshadow=global}.
5678 @item -Wno-shadow-ivar @r{(Objective-C only)}
5679 @opindex Wno-shadow-ivar
5680 @opindex Wshadow-ivar
5681 Do not warn whenever a local variable shadows an instance variable in an
5682 Objective-C method.
5684 @item -Wshadow=global
5685 @opindex Wshadow=local
5686 The default for @option{-Wshadow}. Warns for any (global) shadowing.
5688 @item -Wshadow=local
5689 @opindex Wshadow=local
5690 Warn when a local variable shadows another local variable or parameter.
5691 This warning is enabled by @option{-Wshadow=global}.
5693 @item -Wshadow=compatible-local
5694 @opindex Wshadow=compatible-local
5695 Warn when a local variable shadows another local variable or parameter
5696 whose type is compatible with that of the shadowing variable. In C++,
5697 type compatibility here means the type of the shadowing variable can be
5698 converted to that of the shadowed variable. The creation of this flag
5699 (in addition to @option{-Wshadow=local}) is based on the idea that when
5700 a local variable shadows another one of incompatible type, it is most
5701 likely intentional, not a bug or typo, as shown in the following example:
5703 @smallexample
5704 @group
5705 for (SomeIterator i = SomeObj.begin(); i != SomeObj.end(); ++i)
5707   for (int i = 0; i < N; ++i)
5708   @{
5709     ...
5710   @}
5711   ...
5713 @end group
5714 @end smallexample
5716 Since the two variable @code{i} in the example above have incompatible types,
5717 enabling only @option{-Wshadow=compatible-local} will not emit a warning.
5718 Because their types are incompatible, if a programmer accidentally uses one
5719 in place of the other, type checking will catch that and emit an error or
5720 warning. So not warning (about shadowing) in this case will not lead to
5721 undetected bugs. Use of this flag instead of @option{-Wshadow=local} can
5722 possibly reduce the number of warnings triggered by intentional shadowing.
5724 This warning is enabled by @option{-Wshadow=local}.
5726 @item -Wlarger-than=@var{len}
5727 @opindex Wlarger-than=@var{len}
5728 @opindex Wlarger-than-@var{len}
5729 Warn whenever an object of larger than @var{len} bytes is defined.
5731 @item -Wframe-larger-than=@var{len}
5732 @opindex Wframe-larger-than
5733 Warn if the size of a function frame is larger than @var{len} bytes.
5734 The computation done to determine the stack frame size is approximate
5735 and not conservative.
5736 The actual requirements may be somewhat greater than @var{len}
5737 even if you do not get a warning.  In addition, any space allocated
5738 via @code{alloca}, variable-length arrays, or related constructs
5739 is not included by the compiler when determining
5740 whether or not to issue a warning.
5742 @item -Wno-free-nonheap-object
5743 @opindex Wno-free-nonheap-object
5744 @opindex Wfree-nonheap-object
5745 Do not warn when attempting to free an object that was not allocated
5746 on the heap.
5748 @item -Wstack-usage=@var{len}
5749 @opindex Wstack-usage
5750 Warn if the stack usage of a function might be larger than @var{len} bytes.
5751 The computation done to determine the stack usage is conservative.
5752 Any space allocated via @code{alloca}, variable-length arrays, or related
5753 constructs is included by the compiler when determining whether or not to
5754 issue a warning.
5756 The message is in keeping with the output of @option{-fstack-usage}.
5758 @itemize
5759 @item
5760 If the stack usage is fully static but exceeds the specified amount, it's:
5762 @smallexample
5763   warning: stack usage is 1120 bytes
5764 @end smallexample
5765 @item
5766 If the stack usage is (partly) dynamic but bounded, it's:
5768 @smallexample
5769   warning: stack usage might be 1648 bytes
5770 @end smallexample
5771 @item
5772 If the stack usage is (partly) dynamic and not bounded, it's:
5774 @smallexample
5775   warning: stack usage might be unbounded
5776 @end smallexample
5777 @end itemize
5779 @item -Wunsafe-loop-optimizations
5780 @opindex Wunsafe-loop-optimizations
5781 @opindex Wno-unsafe-loop-optimizations
5782 Warn if the loop cannot be optimized because the compiler cannot
5783 assume anything on the bounds of the loop indices.  With
5784 @option{-funsafe-loop-optimizations} warn if the compiler makes
5785 such assumptions.
5787 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
5788 @opindex Wno-pedantic-ms-format
5789 @opindex Wpedantic-ms-format
5790 When used in combination with @option{-Wformat}
5791 and @option{-pedantic} without GNU extensions, this option
5792 disables the warnings about non-ISO @code{printf} / @code{scanf} format
5793 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
5794 which depend on the MS runtime.
5796 @item -Waligned-new
5797 @opindex Waligned-new
5798 @opindex Wno-aligned-new
5799 Warn about a new-expression of a type that requires greater alignment
5800 than the @code{alignof(std::max_align_t)} but uses an allocation
5801 function without an explicit alignment parameter. This option is
5802 enabled by @option{-Wall}.
5804 Normally this only warns about global allocation functions, but
5805 @option{-Waligned-new=all} also warns about class member allocation
5806 functions.
5808 @item -Wplacement-new
5809 @itemx -Wplacement-new=@var{n}
5810 @opindex Wplacement-new
5811 @opindex Wno-placement-new
5812 Warn about placement new expressions with undefined behavior, such as
5813 constructing an object in a buffer that is smaller than the type of
5814 the object.  For example, the placement new expression below is diagnosed
5815 because it attempts to construct an array of 64 integers in a buffer only
5816 64 bytes large.
5817 @smallexample
5818 char buf [64];
5819 new (buf) int[64];
5820 @end smallexample
5821 This warning is enabled by default.
5823 @table @gcctabopt
5824 @item -Wplacement-new=1
5825 This is the default warning level of @option{-Wplacement-new}.  At this
5826 level the warning is not issued for some strictly undefined constructs that
5827 GCC allows as extensions for compatibility with legacy code.  For example,
5828 the following @code{new} expression is not diagnosed at this level even
5829 though it has undefined behavior according to the C++ standard because
5830 it writes past the end of the one-element array.
5831 @smallexample
5832 struct S @{ int n, a[1]; @};
5833 S *s = (S *)malloc (sizeof *s + 31 * sizeof s->a[0]);
5834 new (s->a)int [32]();
5835 @end smallexample
5837 @item -Wplacement-new=2
5838 At this level, in addition to diagnosing all the same constructs as at level
5839 1, a diagnostic is also issued for placement new expressions that construct
5840 an object in the last member of structure whose type is an array of a single
5841 element and whose size is less than the size of the object being constructed.
5842 While the previous example would be diagnosed, the following construct makes
5843 use of the flexible member array extension to avoid the warning at level 2.
5844 @smallexample
5845 struct S @{ int n, a[]; @};
5846 S *s = (S *)malloc (sizeof *s + 32 * sizeof s->a[0]);
5847 new (s->a)int [32]();
5848 @end smallexample
5850 @end table
5852 @item -Wpointer-arith
5853 @opindex Wpointer-arith
5854 @opindex Wno-pointer-arith
5855 Warn about anything that depends on the ``size of'' a function type or
5856 of @code{void}.  GNU C assigns these types a size of 1, for
5857 convenience in calculations with @code{void *} pointers and pointers
5858 to functions.  In C++, warn also when an arithmetic operation involves
5859 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
5861 @item -Wpointer-compare
5862 @opindex Wpointer-compare
5863 @opindex Wno-pointer-compare
5864 Warn if a pointer is compared with a zero character constant.  This usually
5865 means that the pointer was meant to be dereferenced.  For example:
5867 @smallexample
5868 const char *p = foo ();
5869 if (p == '\0')
5870   return 42;
5871 @end smallexample
5873 Note that the code above is invalid in C++11.
5875 This warning is enabled by default.
5877 @item -Wtype-limits
5878 @opindex Wtype-limits
5879 @opindex Wno-type-limits
5880 Warn if a comparison is always true or always false due to the limited
5881 range of the data type, but do not warn for constant expressions.  For
5882 example, warn if an unsigned variable is compared against zero with
5883 @code{<} or @code{>=}.  This warning is also enabled by
5884 @option{-Wextra}.
5886 @include cppwarnopts.texi
5888 @item -Wbad-function-cast @r{(C and Objective-C only)}
5889 @opindex Wbad-function-cast
5890 @opindex Wno-bad-function-cast
5891 Warn when a function call is cast to a non-matching type.
5892 For example, warn if a call to a function returning an integer type 
5893 is cast to a pointer type.
5895 @item -Wc90-c99-compat @r{(C and Objective-C only)}
5896 @opindex Wc90-c99-compat
5897 @opindex Wno-c90-c99-compat
5898 Warn about features not present in ISO C90, but present in ISO C99.
5899 For instance, warn about use of variable length arrays, @code{long long}
5900 type, @code{bool} type, compound literals, designated initializers, and so
5901 on.  This option is independent of the standards mode.  Warnings are disabled
5902 in the expression that follows @code{__extension__}.
5904 @item -Wc99-c11-compat @r{(C and Objective-C only)}
5905 @opindex Wc99-c11-compat
5906 @opindex Wno-c99-c11-compat
5907 Warn about features not present in ISO C99, but present in ISO C11.
5908 For instance, warn about use of anonymous structures and unions,
5909 @code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier,
5910 @code{_Alignas} specifier, @code{Alignof} operator, @code{_Generic} keyword,
5911 and so on.  This option is independent of the standards mode.  Warnings are
5912 disabled in the expression that follows @code{__extension__}.
5914 @item -Wc++-compat @r{(C and Objective-C only)}
5915 @opindex Wc++-compat
5916 Warn about ISO C constructs that are outside of the common subset of
5917 ISO C and ISO C++, e.g.@: request for implicit conversion from
5918 @code{void *} to a pointer to non-@code{void} type.
5920 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
5921 @opindex Wc++11-compat
5922 Warn about C++ constructs whose meaning differs between ISO C++ 1998
5923 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
5924 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
5925 enabled by @option{-Wall}.
5927 @item -Wc++14-compat @r{(C++ and Objective-C++ only)}
5928 @opindex Wc++14-compat
5929 Warn about C++ constructs whose meaning differs between ISO C++ 2011
5930 and ISO C++ 2014.  This warning is enabled by @option{-Wall}.
5932 @item -Wc++17-compat @r{(C++ and Objective-C++ only)}
5933 @opindex Wc++17-compat
5934 Warn about C++ constructs whose meaning differs between ISO C++ 2014
5935 and ISO C++ 2017.  This warning is enabled by @option{-Wall}.
5937 @item -Wcast-qual
5938 @opindex Wcast-qual
5939 @opindex Wno-cast-qual
5940 Warn whenever a pointer is cast so as to remove a type qualifier from
5941 the target type.  For example, warn if a @code{const char *} is cast
5942 to an ordinary @code{char *}.
5944 Also warn when making a cast that introduces a type qualifier in an
5945 unsafe way.  For example, casting @code{char **} to @code{const char **}
5946 is unsafe, as in this example:
5948 @smallexample
5949   /* p is char ** value.  */
5950   const char **q = (const char **) p;
5951   /* Assignment of readonly string to const char * is OK.  */
5952   *q = "string";
5953   /* Now char** pointer points to read-only memory.  */
5954   **p = 'b';
5955 @end smallexample
5957 @item -Wcast-align
5958 @opindex Wcast-align
5959 @opindex Wno-cast-align
5960 Warn whenever a pointer is cast such that the required alignment of the
5961 target is increased.  For example, warn if a @code{char *} is cast to
5962 an @code{int *} on machines where integers can only be accessed at
5963 two- or four-byte boundaries.
5965 @item -Wcast-align=strict
5966 @opindex Wcast-align=strict
5967 Warn whenever a pointer is cast such that the required alignment of the
5968 target is increased.  For example, warn if a @code{char *} is cast to
5969 an @code{int *} regardless of the target machine.
5971 @item -Wwrite-strings
5972 @opindex Wwrite-strings
5973 @opindex Wno-write-strings
5974 When compiling C, give string constants the type @code{const
5975 char[@var{length}]} so that copying the address of one into a
5976 non-@code{const} @code{char *} pointer produces a warning.  These
5977 warnings help you find at compile time code that can try to write
5978 into a string constant, but only if you have been very careful about
5979 using @code{const} in declarations and prototypes.  Otherwise, it is
5980 just a nuisance. This is why we did not make @option{-Wall} request
5981 these warnings.
5983 When compiling C++, warn about the deprecated conversion from string
5984 literals to @code{char *}.  This warning is enabled by default for C++
5985 programs.
5987 @item -Wcatch-value
5988 @itemx -Wcatch-value=@var{n} @r{(C++ and Objective-C++ only)}
5989 @opindex Wcatch-value
5990 @opindex Wno-catch-value
5991 Warn about catch handlers that do not catch via reference.
5992 With @option{-Wcatch-value=1} (or @option{-Wcatch-value} for short)
5993 warn about polymorphic class types that are caught by value.
5994 With @option{-Wcatch-value=2} warn about all class types that are caught
5995 by value. With @option{-Wcatch-value=3} warn about all types that are
5996 not caught by reference. @option{-Wcatch-value} is enabled by @option{-Wall}.
5998 @item -Wclobbered
5999 @opindex Wclobbered
6000 @opindex Wno-clobbered
6001 Warn for variables that might be changed by @code{longjmp} or
6002 @code{vfork}.  This warning is also enabled by @option{-Wextra}.
6004 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
6005 @opindex Wconditionally-supported
6006 @opindex Wno-conditionally-supported
6007 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
6009 @item -Wconversion
6010 @opindex Wconversion
6011 @opindex Wno-conversion
6012 Warn for implicit conversions that may alter a value. This includes
6013 conversions between real and integer, like @code{abs (x)} when
6014 @code{x} is @code{double}; conversions between signed and unsigned,
6015 like @code{unsigned ui = -1}; and conversions to smaller types, like
6016 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
6017 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
6018 changed by the conversion like in @code{abs (2.0)}.  Warnings about
6019 conversions between signed and unsigned integers can be disabled by
6020 using @option{-Wno-sign-conversion}.
6022 For C++, also warn for confusing overload resolution for user-defined
6023 conversions; and conversions that never use a type conversion
6024 operator: conversions to @code{void}, the same type, a base class or a
6025 reference to them. Warnings about conversions between signed and
6026 unsigned integers are disabled by default in C++ unless
6027 @option{-Wsign-conversion} is explicitly enabled.
6029 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
6030 @opindex Wconversion-null
6031 @opindex Wno-conversion-null
6032 Do not warn for conversions between @code{NULL} and non-pointer
6033 types. @option{-Wconversion-null} is enabled by default.
6035 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
6036 @opindex Wzero-as-null-pointer-constant
6037 @opindex Wno-zero-as-null-pointer-constant
6038 Warn when a literal @samp{0} is used as null pointer constant.  This can
6039 be useful to facilitate the conversion to @code{nullptr} in C++11.
6041 @item -Wsubobject-linkage @r{(C++ and Objective-C++ only)}
6042 @opindex Wsubobject-linkage
6043 @opindex Wno-subobject-linkage
6044 Warn if a class type has a base or a field whose type uses the anonymous
6045 namespace or depends on a type with no linkage.  If a type A depends on
6046 a type B with no or internal linkage, defining it in multiple
6047 translation units would be an ODR violation because the meaning of B
6048 is different in each translation unit.  If A only appears in a single
6049 translation unit, the best way to silence the warning is to give it
6050 internal linkage by putting it in an anonymous namespace as well.  The
6051 compiler doesn't give this warning for types defined in the main .C
6052 file, as those are unlikely to have multiple definitions.
6053 @option{-Wsubobject-linkage} is enabled by default.
6055 @item -Wdangling-else
6056 @opindex Wdangling-else
6057 @opindex Wno-dangling-else
6058 Warn about constructions where there may be confusion to which
6059 @code{if} statement an @code{else} branch belongs.  Here is an example of
6060 such a case:
6062 @smallexample
6063 @group
6065   if (a)
6066     if (b)
6067       foo ();
6068   else
6069     bar ();
6071 @end group
6072 @end smallexample
6074 In C/C++, every @code{else} branch belongs to the innermost possible
6075 @code{if} statement, which in this example is @code{if (b)}.  This is
6076 often not what the programmer expected, as illustrated in the above
6077 example by indentation the programmer chose.  When there is the
6078 potential for this confusion, GCC issues a warning when this flag
6079 is specified.  To eliminate the warning, add explicit braces around
6080 the innermost @code{if} statement so there is no way the @code{else}
6081 can belong to the enclosing @code{if}.  The resulting code
6082 looks like this:
6084 @smallexample
6085 @group
6087   if (a)
6088     @{
6089       if (b)
6090         foo ();
6091       else
6092         bar ();
6093     @}
6095 @end group
6096 @end smallexample
6098 This warning is enabled by @option{-Wparentheses}.
6100 @item -Wdate-time
6101 @opindex Wdate-time
6102 @opindex Wno-date-time
6103 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
6104 are encountered as they might prevent bit-wise-identical reproducible
6105 compilations.
6107 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
6108 @opindex Wdelete-incomplete
6109 @opindex Wno-delete-incomplete
6110 Warn when deleting a pointer to incomplete type, which may cause
6111 undefined behavior at runtime.  This warning is enabled by default.
6113 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
6114 @opindex Wuseless-cast
6115 @opindex Wno-useless-cast
6116 Warn when an expression is casted to its own type.
6118 @item -Wempty-body
6119 @opindex Wempty-body
6120 @opindex Wno-empty-body
6121 Warn if an empty body occurs in an @code{if}, @code{else} or @code{do
6122 while} statement.  This warning is also enabled by @option{-Wextra}.
6124 @item -Wenum-compare
6125 @opindex Wenum-compare
6126 @opindex Wno-enum-compare
6127 Warn about a comparison between values of different enumerated types.
6128 In C++ enumerated type mismatches in conditional expressions are also
6129 diagnosed and the warning is enabled by default.  In C this warning is 
6130 enabled by @option{-Wall}.
6132 @item -Wextra-semi @r{(C++, Objective-C++ only)}
6133 @opindex Wextra-semi
6134 @opindex Wno-extra-semi
6135 Warn about redundant semicolon after in-class function definition.
6137 @item -Wjump-misses-init @r{(C, Objective-C only)}
6138 @opindex Wjump-misses-init
6139 @opindex Wno-jump-misses-init
6140 Warn if a @code{goto} statement or a @code{switch} statement jumps
6141 forward across the initialization of a variable, or jumps backward to a
6142 label after the variable has been initialized.  This only warns about
6143 variables that are initialized when they are declared.  This warning is
6144 only supported for C and Objective-C; in C++ this sort of branch is an
6145 error in any case.
6147 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
6148 can be disabled with the @option{-Wno-jump-misses-init} option.
6150 @item -Wsign-compare
6151 @opindex Wsign-compare
6152 @opindex Wno-sign-compare
6153 @cindex warning for comparison of signed and unsigned values
6154 @cindex comparison of signed and unsigned values, warning
6155 @cindex signed and unsigned values, comparison warning
6156 Warn when a comparison between signed and unsigned values could produce
6157 an incorrect result when the signed value is converted to unsigned.
6158 In C++, this warning is also enabled by @option{-Wall}.  In C, it is
6159 also enabled by @option{-Wextra}.
6161 @item -Wsign-conversion
6162 @opindex Wsign-conversion
6163 @opindex Wno-sign-conversion
6164 Warn for implicit conversions that may change the sign of an integer
6165 value, like assigning a signed integer expression to an unsigned
6166 integer variable. An explicit cast silences the warning. In C, this
6167 option is enabled also by @option{-Wconversion}.
6169 @item -Wfloat-conversion
6170 @opindex Wfloat-conversion
6171 @opindex Wno-float-conversion
6172 Warn for implicit conversions that reduce the precision of a real value.
6173 This includes conversions from real to integer, and from higher precision
6174 real to lower precision real values.  This option is also enabled by
6175 @option{-Wconversion}.
6177 @item -Wno-scalar-storage-order
6178 @opindex -Wno-scalar-storage-order
6179 @opindex -Wscalar-storage-order
6180 Do not warn on suspicious constructs involving reverse scalar storage order.
6182 @item -Wsized-deallocation @r{(C++ and Objective-C++ only)}
6183 @opindex Wsized-deallocation
6184 @opindex Wno-sized-deallocation
6185 Warn about a definition of an unsized deallocation function
6186 @smallexample
6187 void operator delete (void *) noexcept;
6188 void operator delete[] (void *) noexcept;
6189 @end smallexample
6190 without a definition of the corresponding sized deallocation function
6191 @smallexample
6192 void operator delete (void *, std::size_t) noexcept;
6193 void operator delete[] (void *, std::size_t) noexcept;
6194 @end smallexample
6195 or vice versa.  Enabled by @option{-Wextra} along with
6196 @option{-fsized-deallocation}.
6198 @item -Wsizeof-pointer-div
6199 @opindex Wsizeof-pointer-div
6200 @opindex Wno-sizeof-pointer-div
6201 Warn for suspicious divisions of two sizeof expressions that divide
6202 the pointer size by the element size, which is the usual way to compute
6203 the array size but won't work out correctly with pointers.  This warning
6204 warns e.g.@: about @code{sizeof (ptr) / sizeof (ptr[0])} if @code{ptr} is
6205 not an array, but a pointer.  This warning is enabled by @option{-Wall}.
6207 @item -Wsizeof-pointer-memaccess
6208 @opindex Wsizeof-pointer-memaccess
6209 @opindex Wno-sizeof-pointer-memaccess
6210 Warn for suspicious length parameters to certain string and memory built-in
6211 functions if the argument uses @code{sizeof}.  This warning warns e.g.@:
6212 about @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not an array,
6213 but a pointer, and suggests a possible fix, or about
6214 @code{memcpy (&foo, ptr, sizeof (&foo));}.  This warning is enabled by
6215 @option{-Wall}.
6217 @item -Wsizeof-array-argument
6218 @opindex Wsizeof-array-argument
6219 @opindex Wno-sizeof-array-argument
6220 Warn when the @code{sizeof} operator is applied to a parameter that is
6221 declared as an array in a function definition.  This warning is enabled by
6222 default for C and C++ programs.
6224 @item -Wmemset-elt-size
6225 @opindex Wmemset-elt-size
6226 @opindex Wno-memset-elt-size
6227 Warn for suspicious calls to the @code{memset} built-in function, if the
6228 first argument references an array, and the third argument is a number
6229 equal to the number of elements, but not equal to the size of the array
6230 in memory.  This indicates that the user has omitted a multiplication by
6231 the element size.  This warning is enabled by @option{-Wall}.
6233 @item -Wmemset-transposed-args
6234 @opindex Wmemset-transposed-args
6235 @opindex Wno-memset-transposed-args
6236 Warn for suspicious calls to the @code{memset} built-in function, if the
6237 second argument is not zero and the third argument is zero.  This warns e.g.@
6238 about @code{memset (buf, sizeof buf, 0)} where most probably
6239 @code{memset (buf, 0, sizeof buf)} was meant instead.  The diagnostics
6240 is only emitted if the third argument is literal zero.  If it is some
6241 expression that is folded to zero, a cast of zero to some type, etc., 
6242 it is far less likely that the user has mistakenly exchanged the arguments 
6243 and no warning is emitted.  This warning is enabled by @option{-Wall}.
6245 @item -Waddress
6246 @opindex Waddress
6247 @opindex Wno-address
6248 Warn about suspicious uses of memory addresses. These include using
6249 the address of a function in a conditional expression, such as
6250 @code{void func(void); if (func)}, and comparisons against the memory
6251 address of a string literal, such as @code{if (x == "abc")}.  Such
6252 uses typically indicate a programmer error: the address of a function
6253 always evaluates to true, so their use in a conditional usually
6254 indicate that the programmer forgot the parentheses in a function
6255 call; and comparisons against string literals result in unspecified
6256 behavior and are not portable in C, so they usually indicate that the
6257 programmer intended to use @code{strcmp}.  This warning is enabled by
6258 @option{-Wall}.
6260 @item -Wlogical-op
6261 @opindex Wlogical-op
6262 @opindex Wno-logical-op
6263 Warn about suspicious uses of logical operators in expressions.
6264 This includes using logical operators in contexts where a
6265 bit-wise operator is likely to be expected.  Also warns when
6266 the operands of a logical operator are the same:
6267 @smallexample
6268 extern int a;
6269 if (a < 0 && a < 0) @{ @dots{} @}
6270 @end smallexample
6272 @item -Wlogical-not-parentheses
6273 @opindex Wlogical-not-parentheses
6274 @opindex Wno-logical-not-parentheses
6275 Warn about logical not used on the left hand side operand of a comparison.
6276 This option does not warn if the right operand is considered to be a boolean
6277 expression.  Its purpose is to detect suspicious code like the following:
6278 @smallexample
6279 int a;
6280 @dots{}
6281 if (!a > 1) @{ @dots{} @}
6282 @end smallexample
6284 It is possible to suppress the warning by wrapping the LHS into
6285 parentheses:
6286 @smallexample
6287 if ((!a) > 1) @{ @dots{} @}
6288 @end smallexample
6290 This warning is enabled by @option{-Wall}.
6292 @item -Waggregate-return
6293 @opindex Waggregate-return
6294 @opindex Wno-aggregate-return
6295 Warn if any functions that return structures or unions are defined or
6296 called.  (In languages where you can return an array, this also elicits
6297 a warning.)
6299 @item -Wno-aggressive-loop-optimizations
6300 @opindex Wno-aggressive-loop-optimizations
6301 @opindex Waggressive-loop-optimizations
6302 Warn if in a loop with constant number of iterations the compiler detects
6303 undefined behavior in some statement during one or more of the iterations.
6305 @item -Wno-attributes
6306 @opindex Wno-attributes
6307 @opindex Wattributes
6308 Do not warn if an unexpected @code{__attribute__} is used, such as
6309 unrecognized attributes, function attributes applied to variables,
6310 etc.  This does not stop errors for incorrect use of supported
6311 attributes.
6313 @item -Wno-builtin-declaration-mismatch
6314 @opindex Wno-builtin-declaration-mismatch
6315 @opindex Wbuiltin-declaration-mismatch
6316 Warn if a built-in function is declared with the wrong signature.
6317 This warning is enabled by default.
6319 @item -Wno-builtin-macro-redefined
6320 @opindex Wno-builtin-macro-redefined
6321 @opindex Wbuiltin-macro-redefined
6322 Do not warn if certain built-in macros are redefined.  This suppresses
6323 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
6324 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
6326 @item -Wstrict-prototypes @r{(C and Objective-C only)}
6327 @opindex Wstrict-prototypes
6328 @opindex Wno-strict-prototypes
6329 Warn if a function is declared or defined without specifying the
6330 argument types.  (An old-style function definition is permitted without
6331 a warning if preceded by a declaration that specifies the argument
6332 types.)
6334 @item -Wold-style-declaration @r{(C and Objective-C only)}
6335 @opindex Wold-style-declaration
6336 @opindex Wno-old-style-declaration
6337 Warn for obsolescent usages, according to the C Standard, in a
6338 declaration. For example, warn if storage-class specifiers like
6339 @code{static} are not the first things in a declaration.  This warning
6340 is also enabled by @option{-Wextra}.
6342 @item -Wold-style-definition @r{(C and Objective-C only)}
6343 @opindex Wold-style-definition
6344 @opindex Wno-old-style-definition
6345 Warn if an old-style function definition is used.  A warning is given
6346 even if there is a previous prototype.
6348 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
6349 @opindex Wmissing-parameter-type
6350 @opindex Wno-missing-parameter-type
6351 A function parameter is declared without a type specifier in K&R-style
6352 functions:
6354 @smallexample
6355 void foo(bar) @{ @}
6356 @end smallexample
6358 This warning is also enabled by @option{-Wextra}.
6360 @item -Wmissing-prototypes @r{(C and Objective-C only)}
6361 @opindex Wmissing-prototypes
6362 @opindex Wno-missing-prototypes
6363 Warn if a global function is defined without a previous prototype
6364 declaration.  This warning is issued even if the definition itself
6365 provides a prototype.  Use this option to detect global functions
6366 that do not have a matching prototype declaration in a header file.
6367 This option is not valid for C++ because all function declarations
6368 provide prototypes and a non-matching declaration declares an
6369 overload rather than conflict with an earlier declaration.
6370 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
6372 @item -Wmissing-declarations
6373 @opindex Wmissing-declarations
6374 @opindex Wno-missing-declarations
6375 Warn if a global function is defined without a previous declaration.
6376 Do so even if the definition itself provides a prototype.
6377 Use this option to detect global functions that are not declared in
6378 header files.  In C, no warnings are issued for functions with previous
6379 non-prototype declarations; use @option{-Wmissing-prototypes} to detect
6380 missing prototypes.  In C++, no warnings are issued for function templates,
6381 or for inline functions, or for functions in anonymous namespaces.
6383 @item -Wmissing-field-initializers
6384 @opindex Wmissing-field-initializers
6385 @opindex Wno-missing-field-initializers
6386 @opindex W
6387 @opindex Wextra
6388 @opindex Wno-extra
6389 Warn if a structure's initializer has some fields missing.  For
6390 example, the following code causes such a warning, because
6391 @code{x.h} is implicitly zero:
6393 @smallexample
6394 struct s @{ int f, g, h; @};
6395 struct s x = @{ 3, 4 @};
6396 @end smallexample
6398 This option does not warn about designated initializers, so the following
6399 modification does not trigger a warning:
6401 @smallexample
6402 struct s @{ int f, g, h; @};
6403 struct s x = @{ .f = 3, .g = 4 @};
6404 @end smallexample
6406 In C this option does not warn about the universal zero initializer
6407 @samp{@{ 0 @}}:
6409 @smallexample
6410 struct s @{ int f, g, h; @};
6411 struct s x = @{ 0 @};
6412 @end smallexample
6414 Likewise, in C++ this option does not warn about the empty @{ @}
6415 initializer, for example:
6417 @smallexample
6418 struct s @{ int f, g, h; @};
6419 s x = @{ @};
6420 @end smallexample
6422 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
6423 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
6425 @item -Wno-multichar
6426 @opindex Wno-multichar
6427 @opindex Wmultichar
6428 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
6429 Usually they indicate a typo in the user's code, as they have
6430 implementation-defined values, and should not be used in portable code.
6432 @item -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]}
6433 @opindex Wnormalized=
6434 @opindex Wnormalized
6435 @opindex Wno-normalized
6436 @cindex NFC
6437 @cindex NFKC
6438 @cindex character set, input normalization
6439 In ISO C and ISO C++, two identifiers are different if they are
6440 different sequences of characters.  However, sometimes when characters
6441 outside the basic ASCII character set are used, you can have two
6442 different character sequences that look the same.  To avoid confusion,
6443 the ISO 10646 standard sets out some @dfn{normalization rules} which
6444 when applied ensure that two sequences that look the same are turned into
6445 the same sequence.  GCC can warn you if you are using identifiers that
6446 have not been normalized; this option controls that warning.
6448 There are four levels of warning supported by GCC@.  The default is
6449 @option{-Wnormalized=nfc}, which warns about any identifier that is
6450 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
6451 recommended form for most uses.  It is equivalent to
6452 @option{-Wnormalized}.
6454 Unfortunately, there are some characters allowed in identifiers by
6455 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
6456 identifiers.  That is, there's no way to use these symbols in portable
6457 ISO C or C++ and have all your identifiers in NFC@.
6458 @option{-Wnormalized=id} suppresses the warning for these characters.
6459 It is hoped that future versions of the standards involved will correct
6460 this, which is why this option is not the default.
6462 You can switch the warning off for all characters by writing
6463 @option{-Wnormalized=none} or @option{-Wno-normalized}.  You should
6464 only do this if you are using some other normalization scheme (like
6465 ``D''), because otherwise you can easily create bugs that are
6466 literally impossible to see.
6468 Some characters in ISO 10646 have distinct meanings but look identical
6469 in some fonts or display methodologies, especially once formatting has
6470 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
6471 LETTER N'', displays just like a regular @code{n} that has been
6472 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
6473 normalization scheme to convert all these into a standard form as
6474 well, and GCC warns if your code is not in NFKC if you use
6475 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
6476 about every identifier that contains the letter O because it might be
6477 confused with the digit 0, and so is not the default, but may be
6478 useful as a local coding convention if the programming environment 
6479 cannot be fixed to display these characters distinctly.
6481 @item -Wno-deprecated
6482 @opindex Wno-deprecated
6483 @opindex Wdeprecated
6484 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
6486 @item -Wno-deprecated-declarations
6487 @opindex Wno-deprecated-declarations
6488 @opindex Wdeprecated-declarations
6489 Do not warn about uses of functions (@pxref{Function Attributes}),
6490 variables (@pxref{Variable Attributes}), and types (@pxref{Type
6491 Attributes}) marked as deprecated by using the @code{deprecated}
6492 attribute.
6494 @item -Wno-overflow
6495 @opindex Wno-overflow
6496 @opindex Woverflow
6497 Do not warn about compile-time overflow in constant expressions.
6499 @item -Wno-odr
6500 @opindex Wno-odr
6501 @opindex Wodr
6502 Warn about One Definition Rule violations during link-time optimization.
6503 Requires @option{-flto-odr-type-merging} to be enabled.  Enabled by default.
6505 @item -Wopenmp-simd
6506 @opindex Wopenm-simd
6507 Warn if the vectorizer cost model overrides the OpenMP or the Cilk Plus
6508 simd directive set by user.  The @option{-fsimd-cost-model=unlimited}
6509 option can be used to relax the cost model.
6511 @item -Woverride-init @r{(C and Objective-C only)}
6512 @opindex Woverride-init
6513 @opindex Wno-override-init
6514 @opindex W
6515 @opindex Wextra
6516 @opindex Wno-extra
6517 Warn if an initialized field without side effects is overridden when
6518 using designated initializers (@pxref{Designated Inits, , Designated
6519 Initializers}).
6521 This warning is included in @option{-Wextra}.  To get other
6522 @option{-Wextra} warnings without this one, use @option{-Wextra
6523 -Wno-override-init}.
6525 @item -Woverride-init-side-effects @r{(C and Objective-C only)}
6526 @opindex Woverride-init-side-effects
6527 @opindex Wno-override-init-side-effects
6528 Warn if an initialized field with side effects is overridden when
6529 using designated initializers (@pxref{Designated Inits, , Designated
6530 Initializers}).  This warning is enabled by default.
6532 @item -Wpacked
6533 @opindex Wpacked
6534 @opindex Wno-packed
6535 Warn if a structure is given the packed attribute, but the packed
6536 attribute has no effect on the layout or size of the structure.
6537 Such structures may be mis-aligned for little benefit.  For
6538 instance, in this code, the variable @code{f.x} in @code{struct bar}
6539 is misaligned even though @code{struct bar} does not itself
6540 have the packed attribute:
6542 @smallexample
6543 @group
6544 struct foo @{
6545   int x;
6546   char a, b, c, d;
6547 @} __attribute__((packed));
6548 struct bar @{
6549   char z;
6550   struct foo f;
6552 @end group
6553 @end smallexample
6555 @item -Wpacked-bitfield-compat
6556 @opindex Wpacked-bitfield-compat
6557 @opindex Wno-packed-bitfield-compat
6558 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
6559 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
6560 the change can lead to differences in the structure layout.  GCC
6561 informs you when the offset of such a field has changed in GCC 4.4.
6562 For example there is no longer a 4-bit padding between field @code{a}
6563 and @code{b} in this structure:
6565 @smallexample
6566 struct foo
6568   char a:4;
6569   char b:8;
6570 @} __attribute__ ((packed));
6571 @end smallexample
6573 This warning is enabled by default.  Use
6574 @option{-Wno-packed-bitfield-compat} to disable this warning.
6576 @item -Wpacked-not-aligned @r{(C, C++, Objective-C and Objective-C++ only)}
6577 @opindex Wpacked-not-aligned
6578 @opindex Wno-packed-not-aligned
6579 Warn if a structure field with explicitly specified alignment in a
6580 packed struct or union is misaligned.  For example, a warning will
6581 be issued on @code{struct S}, like, @code{warning: alignment 1 of
6582 'struct S' is less than 8}, in this code:
6584 @smallexample
6585 @group
6586 struct __attribute__ ((aligned (8))) S8 @{ char a[8]; @};
6587 struct __attribute__ ((packed)) S @{
6588   struct S8 s8;
6590 @end group
6591 @end smallexample
6593 This warning is enabled by @option{-Wall}.
6595 @item -Wpadded
6596 @opindex Wpadded
6597 @opindex Wno-padded
6598 Warn if padding is included in a structure, either to align an element
6599 of the structure or to align the whole structure.  Sometimes when this
6600 happens it is possible to rearrange the fields of the structure to
6601 reduce the padding and so make the structure smaller.
6603 @item -Wredundant-decls
6604 @opindex Wredundant-decls
6605 @opindex Wno-redundant-decls
6606 Warn if anything is declared more than once in the same scope, even in
6607 cases where multiple declaration is valid and changes nothing.
6609 @item -Wrestrict
6610 @opindex Wrestrict
6611 @opindex Wno-restrict
6612 Warn when an argument passed to a restrict-qualified parameter
6613 aliases with another argument.
6615 @item -Wnested-externs @r{(C and Objective-C only)}
6616 @opindex Wnested-externs
6617 @opindex Wno-nested-externs
6618 Warn if an @code{extern} declaration is encountered within a function.
6620 @item -Wno-inherited-variadic-ctor
6621 @opindex Winherited-variadic-ctor
6622 @opindex Wno-inherited-variadic-ctor
6623 Suppress warnings about use of C++11 inheriting constructors when the
6624 base class inherited from has a C variadic constructor; the warning is
6625 on by default because the ellipsis is not inherited.
6627 @item -Winline
6628 @opindex Winline
6629 @opindex Wno-inline
6630 Warn if a function that is declared as inline cannot be inlined.
6631 Even with this option, the compiler does not warn about failures to
6632 inline functions declared in system headers.
6634 The compiler uses a variety of heuristics to determine whether or not
6635 to inline a function.  For example, the compiler takes into account
6636 the size of the function being inlined and the amount of inlining
6637 that has already been done in the current function.  Therefore,
6638 seemingly insignificant changes in the source program can cause the
6639 warnings produced by @option{-Winline} to appear or disappear.
6641 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
6642 @opindex Wno-invalid-offsetof
6643 @opindex Winvalid-offsetof
6644 Suppress warnings from applying the @code{offsetof} macro to a non-POD
6645 type.  According to the 2014 ISO C++ standard, applying @code{offsetof}
6646 to a non-standard-layout type is undefined.  In existing C++ implementations,
6647 however, @code{offsetof} typically gives meaningful results.
6648 This flag is for users who are aware that they are
6649 writing nonportable code and who have deliberately chosen to ignore the
6650 warning about it.
6652 The restrictions on @code{offsetof} may be relaxed in a future version
6653 of the C++ standard.
6655 @item -Wint-in-bool-context
6656 @opindex Wint-in-bool-context
6657 @opindex Wno-int-in-bool-context
6658 Warn for suspicious use of integer values where boolean values are expected,
6659 such as conditional expressions (?:) using non-boolean integer constants in
6660 boolean context, like @code{if (a <= b ? 2 : 3)}.  Or left shifting of signed
6661 integers in boolean context, like @code{for (a = 0; 1 << a; a++);}.  Likewise
6662 for all kinds of multiplications regardless of the data type.
6663 This warning is enabled by @option{-Wall}.
6665 @item -Wno-int-to-pointer-cast
6666 @opindex Wno-int-to-pointer-cast
6667 @opindex Wint-to-pointer-cast
6668 Suppress warnings from casts to pointer type of an integer of a
6669 different size. In C++, casting to a pointer type of smaller size is
6670 an error. @option{Wint-to-pointer-cast} is enabled by default.
6673 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
6674 @opindex Wno-pointer-to-int-cast
6675 @opindex Wpointer-to-int-cast
6676 Suppress warnings from casts from a pointer to an integer type of a
6677 different size.
6679 @item -Winvalid-pch
6680 @opindex Winvalid-pch
6681 @opindex Wno-invalid-pch
6682 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
6683 the search path but cannot be used.
6685 @item -Wlong-long
6686 @opindex Wlong-long
6687 @opindex Wno-long-long
6688 Warn if @code{long long} type is used.  This is enabled by either
6689 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
6690 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
6692 @item -Wvariadic-macros
6693 @opindex Wvariadic-macros
6694 @opindex Wno-variadic-macros
6695 Warn if variadic macros are used in ISO C90 mode, or if the GNU
6696 alternate syntax is used in ISO C99 mode.  This is enabled by either
6697 @option{-Wpedantic} or @option{-Wtraditional}.  To inhibit the warning
6698 messages, use @option{-Wno-variadic-macros}.
6700 @item -Wvarargs
6701 @opindex Wvarargs
6702 @opindex Wno-varargs
6703 Warn upon questionable usage of the macros used to handle variable
6704 arguments like @code{va_start}.  This is default.  To inhibit the
6705 warning messages, use @option{-Wno-varargs}.
6707 @item -Wvector-operation-performance
6708 @opindex Wvector-operation-performance
6709 @opindex Wno-vector-operation-performance
6710 Warn if vector operation is not implemented via SIMD capabilities of the
6711 architecture.  Mainly useful for the performance tuning.
6712 Vector operation can be implemented @code{piecewise}, which means that the
6713 scalar operation is performed on every vector element; 
6714 @code{in parallel}, which means that the vector operation is implemented
6715 using scalars of wider type, which normally is more performance efficient;
6716 and @code{as a single scalar}, which means that vector fits into a
6717 scalar type.
6719 @item -Wno-virtual-move-assign
6720 @opindex Wvirtual-move-assign
6721 @opindex Wno-virtual-move-assign
6722 Suppress warnings about inheriting from a virtual base with a
6723 non-trivial C++11 move assignment operator.  This is dangerous because
6724 if the virtual base is reachable along more than one path, it is
6725 moved multiple times, which can mean both objects end up in the
6726 moved-from state.  If the move assignment operator is written to avoid
6727 moving from a moved-from object, this warning can be disabled.
6729 @item -Wvla
6730 @opindex Wvla
6731 @opindex Wno-vla
6732 Warn if a variable-length array is used in the code.
6733 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
6734 the variable-length array.
6736 @item -Wvla-larger-than=@var{n}
6737 If this option is used, the compiler will warn on uses of
6738 variable-length arrays where the size is either unbounded, or bounded
6739 by an argument that can be larger than @var{n} bytes.  This is similar
6740 to how @option{-Walloca-larger-than=@var{n}} works, but with
6741 variable-length arrays.
6743 Note that GCC may optimize small variable-length arrays of a known
6744 value into plain arrays, so this warning may not get triggered for
6745 such arrays.
6747 This warning is not enabled by @option{-Wall}, and is only active when
6748 @option{-ftree-vrp} is active (default for @option{-O2} and above).
6750 See also @option{-Walloca-larger-than=@var{n}}.
6752 @item -Wvolatile-register-var
6753 @opindex Wvolatile-register-var
6754 @opindex Wno-volatile-register-var
6755 Warn if a register variable is declared volatile.  The volatile
6756 modifier does not inhibit all optimizations that may eliminate reads
6757 and/or writes to register variables.  This warning is enabled by
6758 @option{-Wall}.
6760 @item -Wdisabled-optimization
6761 @opindex Wdisabled-optimization
6762 @opindex Wno-disabled-optimization
6763 Warn if a requested optimization pass is disabled.  This warning does
6764 not generally indicate that there is anything wrong with your code; it
6765 merely indicates that GCC's optimizers are unable to handle the code
6766 effectively.  Often, the problem is that your code is too big or too
6767 complex; GCC refuses to optimize programs when the optimization
6768 itself is likely to take inordinate amounts of time.
6770 @item -Wpointer-sign @r{(C and Objective-C only)}
6771 @opindex Wpointer-sign
6772 @opindex Wno-pointer-sign
6773 Warn for pointer argument passing or assignment with different signedness.
6774 This option is only supported for C and Objective-C@.  It is implied by
6775 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
6776 @option{-Wno-pointer-sign}.
6778 @item -Wstack-protector
6779 @opindex Wstack-protector
6780 @opindex Wno-stack-protector
6781 This option is only active when @option{-fstack-protector} is active.  It
6782 warns about functions that are not protected against stack smashing.
6784 @item -Woverlength-strings
6785 @opindex Woverlength-strings
6786 @opindex Wno-overlength-strings
6787 Warn about string constants that are longer than the ``minimum
6788 maximum'' length specified in the C standard.  Modern compilers
6789 generally allow string constants that are much longer than the
6790 standard's minimum limit, but very portable programs should avoid
6791 using longer strings.
6793 The limit applies @emph{after} string constant concatenation, and does
6794 not count the trailing NUL@.  In C90, the limit was 509 characters; in
6795 C99, it was raised to 4095.  C++98 does not specify a normative
6796 minimum maximum, so we do not diagnose overlength strings in C++@.
6798 This option is implied by @option{-Wpedantic}, and can be disabled with
6799 @option{-Wno-overlength-strings}.
6801 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
6802 @opindex Wunsuffixed-float-constants
6804 Issue a warning for any floating constant that does not have
6805 a suffix.  When used together with @option{-Wsystem-headers} it
6806 warns about such constants in system header files.  This can be useful
6807 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
6808 from the decimal floating-point extension to C99.
6810 @item -Wno-designated-init @r{(C and Objective-C only)}
6811 Suppress warnings when a positional initializer is used to initialize
6812 a structure that has been marked with the @code{designated_init}
6813 attribute.
6815 @item -Whsa
6816 Issue a warning when HSAIL cannot be emitted for the compiled function or
6817 OpenMP construct.
6819 @end table
6821 @node Debugging Options
6822 @section Options for Debugging Your Program
6823 @cindex options, debugging
6824 @cindex debugging information options
6826 To tell GCC to emit extra information for use by a debugger, in almost 
6827 all cases you need only to add @option{-g} to your other options.
6829 GCC allows you to use @option{-g} with
6830 @option{-O}.  The shortcuts taken by optimized code may occasionally
6831 be surprising: some variables you declared may not exist
6832 at all; flow of control may briefly move where you did not expect it;
6833 some statements may not be executed because they compute constant
6834 results or their values are already at hand; some statements may
6835 execute in different places because they have been moved out of loops.
6836 Nevertheless it is possible to debug optimized output.  This makes
6837 it reasonable to use the optimizer for programs that might have bugs.
6839 If you are not using some other optimization option, consider
6840 using @option{-Og} (@pxref{Optimize Options}) with @option{-g}.  
6841 With no @option{-O} option at all, some compiler passes that collect
6842 information useful for debugging do not run at all, so that
6843 @option{-Og} may result in a better debugging experience.
6845 @table @gcctabopt
6846 @item -g
6847 @opindex g
6848 Produce debugging information in the operating system's native format
6849 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
6850 information.
6852 On most systems that use stabs format, @option{-g} enables use of extra
6853 debugging information that only GDB can use; this extra information
6854 makes debugging work better in GDB but probably makes other debuggers
6855 crash or
6856 refuse to read the program.  If you want to control for certain whether
6857 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
6858 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
6860 @item -ggdb
6861 @opindex ggdb
6862 Produce debugging information for use by GDB@.  This means to use the
6863 most expressive format available (DWARF, stabs, or the native format
6864 if neither of those are supported), including GDB extensions if at all
6865 possible.
6867 @item -gdwarf
6868 @itemx -gdwarf-@var{version}
6869 @opindex gdwarf
6870 Produce debugging information in DWARF format (if that is supported).
6871 The value of @var{version} may be either 2, 3, 4 or 5; the default version
6872 for most targets is 4.  DWARF Version 5 is only experimental.
6874 Note that with DWARF Version 2, some ports require and always
6875 use some non-conflicting DWARF 3 extensions in the unwind tables.
6877 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
6878 for maximum benefit.
6880 GCC no longer supports DWARF Version 1, which is substantially
6881 different than Version 2 and later.  For historical reasons, some
6882 other DWARF-related options such as
6883 @option{-fno-dwarf2-cfi-asm}) retain a reference to DWARF Version 2
6884 in their names, but apply to all currently-supported versions of DWARF.
6886 @item -gstabs
6887 @opindex gstabs
6888 Produce debugging information in stabs format (if that is supported),
6889 without GDB extensions.  This is the format used by DBX on most BSD
6890 systems.  On MIPS, Alpha and System V Release 4 systems this option
6891 produces stabs debugging output that is not understood by DBX or SDB@.
6892 On System V Release 4 systems this option requires the GNU assembler.
6894 @item -gstabs+
6895 @opindex gstabs+
6896 Produce debugging information in stabs format (if that is supported),
6897 using GNU extensions understood only by the GNU debugger (GDB)@.  The
6898 use of these extensions is likely to make other debuggers crash or
6899 refuse to read the program.
6901 @item -gcoff
6902 @opindex gcoff
6903 Produce debugging information in COFF format (if that is supported).
6904 This is the format used by SDB on most System V systems prior to
6905 System V Release 4.
6907 @item -gxcoff
6908 @opindex gxcoff
6909 Produce debugging information in XCOFF format (if that is supported).
6910 This is the format used by the DBX debugger on IBM RS/6000 systems.
6912 @item -gxcoff+
6913 @opindex gxcoff+
6914 Produce debugging information in XCOFF format (if that is supported),
6915 using GNU extensions understood only by the GNU debugger (GDB)@.  The
6916 use of these extensions is likely to make other debuggers crash or
6917 refuse to read the program, and may cause assemblers other than the GNU
6918 assembler (GAS) to fail with an error.
6920 @item -gvms
6921 @opindex gvms
6922 Produce debugging information in Alpha/VMS debug format (if that is
6923 supported).  This is the format used by DEBUG on Alpha/VMS systems.
6925 @item -g@var{level}
6926 @itemx -ggdb@var{level}
6927 @itemx -gstabs@var{level}
6928 @itemx -gcoff@var{level}
6929 @itemx -gxcoff@var{level}
6930 @itemx -gvms@var{level}
6931 Request debugging information and also use @var{level} to specify how
6932 much information.  The default level is 2.
6934 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
6935 @option{-g}.
6937 Level 1 produces minimal information, enough for making backtraces in
6938 parts of the program that you don't plan to debug.  This includes
6939 descriptions of functions and external variables, and line number
6940 tables, but no information about local variables.
6942 Level 3 includes extra information, such as all the macro definitions
6943 present in the program.  Some debuggers support macro expansion when
6944 you use @option{-g3}.
6946 @option{-gdwarf} does not accept a concatenated debug level, to avoid
6947 confusion with @option{-gdwarf-@var{level}}.
6948 Instead use an additional @option{-g@var{level}} option to change the
6949 debug level for DWARF.
6951 @item -feliminate-unused-debug-symbols
6952 @opindex feliminate-unused-debug-symbols
6953 Produce debugging information in stabs format (if that is supported),
6954 for only symbols that are actually used.
6956 @item -femit-class-debug-always
6957 @opindex femit-class-debug-always
6958 Instead of emitting debugging information for a C++ class in only one
6959 object file, emit it in all object files using the class.  This option
6960 should be used only with debuggers that are unable to handle the way GCC
6961 normally emits debugging information for classes because using this
6962 option increases the size of debugging information by as much as a
6963 factor of two.
6965 @item -fno-merge-debug-strings
6966 @opindex fmerge-debug-strings
6967 @opindex fno-merge-debug-strings
6968 Direct the linker to not merge together strings in the debugging
6969 information that are identical in different object files.  Merging is
6970 not supported by all assemblers or linkers.  Merging decreases the size
6971 of the debug information in the output file at the cost of increasing
6972 link processing time.  Merging is enabled by default.
6974 @item -fdebug-prefix-map=@var{old}=@var{new}
6975 @opindex fdebug-prefix-map
6976 When compiling files in directory @file{@var{old}}, record debugging
6977 information describing them as in @file{@var{new}} instead.
6979 @item -fvar-tracking
6980 @opindex fvar-tracking
6981 Run variable tracking pass.  It computes where variables are stored at each
6982 position in code.  Better debugging information is then generated
6983 (if the debugging information format supports this information).
6985 It is enabled by default when compiling with optimization (@option{-Os},
6986 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
6987 the debug info format supports it.
6989 @item -fvar-tracking-assignments
6990 @opindex fvar-tracking-assignments
6991 @opindex fno-var-tracking-assignments
6992 Annotate assignments to user variables early in the compilation and
6993 attempt to carry the annotations over throughout the compilation all the
6994 way to the end, in an attempt to improve debug information while
6995 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
6997 It can be enabled even if var-tracking is disabled, in which case
6998 annotations are created and maintained, but discarded at the end.
6999 By default, this flag is enabled together with @option{-fvar-tracking},
7000 except when selective scheduling is enabled.
7002 @item -gsplit-dwarf
7003 @opindex gsplit-dwarf
7004 Separate as much DWARF debugging information as possible into a
7005 separate output file with the extension @file{.dwo}.  This option allows
7006 the build system to avoid linking files with debug information.  To
7007 be useful, this option requires a debugger capable of reading @file{.dwo}
7008 files.
7010 @item -gpubnames
7011 @opindex gpubnames
7012 Generate DWARF @code{.debug_pubnames} and @code{.debug_pubtypes} sections.
7014 @item -ggnu-pubnames
7015 @opindex ggnu-pubnames
7016 Generate @code{.debug_pubnames} and @code{.debug_pubtypes} sections in a format
7017 suitable for conversion into a GDB@ index.  This option is only useful
7018 with a linker that can produce GDB@ index version 7.
7020 @item -fdebug-types-section
7021 @opindex fdebug-types-section
7022 @opindex fno-debug-types-section
7023 When using DWARF Version 4 or higher, type DIEs can be put into
7024 their own @code{.debug_types} section instead of making them part of the
7025 @code{.debug_info} section.  It is more efficient to put them in a separate
7026 comdat sections since the linker can then remove duplicates.
7027 But not all DWARF consumers support @code{.debug_types} sections yet
7028 and on some objects @code{.debug_types} produces larger instead of smaller
7029 debugging information.
7031 @item -grecord-gcc-switches
7032 @item -gno-record-gcc-switches
7033 @opindex grecord-gcc-switches
7034 @opindex gno-record-gcc-switches
7035 This switch causes the command-line options used to invoke the
7036 compiler that may affect code generation to be appended to the
7037 DW_AT_producer attribute in DWARF debugging information.  The options
7038 are concatenated with spaces separating them from each other and from
7039 the compiler version.  
7040 It is enabled by default.
7041 See also @option{-frecord-gcc-switches} for another
7042 way of storing compiler options into the object file.  
7044 @item -gstrict-dwarf
7045 @opindex gstrict-dwarf
7046 Disallow using extensions of later DWARF standard version than selected
7047 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
7048 DWARF extensions from later standard versions is allowed.
7050 @item -gno-strict-dwarf
7051 @opindex gno-strict-dwarf
7052 Allow using extensions of later DWARF standard version than selected with
7053 @option{-gdwarf-@var{version}}.
7055 @item -gcolumn-info
7056 @item -gno-column-info
7057 @opindex gcolumn-info
7058 @opindex gno-column-info
7059 Emit location column information into DWARF debugging information, rather
7060 than just file and line.
7061 This option is disabled by default.
7063 @item -gz@r{[}=@var{type}@r{]}
7064 @opindex gz
7065 Produce compressed debug sections in DWARF format, if that is supported.
7066 If @var{type} is not given, the default type depends on the capabilities
7067 of the assembler and linker used.  @var{type} may be one of
7068 @samp{none} (don't compress debug sections), @samp{zlib} (use zlib
7069 compression in ELF gABI format), or @samp{zlib-gnu} (use zlib
7070 compression in traditional GNU format).  If the linker doesn't support
7071 writing compressed debug sections, the option is rejected.  Otherwise,
7072 if the assembler does not support them, @option{-gz} is silently ignored
7073 when producing object files.
7075 @item -femit-struct-debug-baseonly
7076 @opindex femit-struct-debug-baseonly
7077 Emit debug information for struct-like types
7078 only when the base name of the compilation source file
7079 matches the base name of file in which the struct is defined.
7081 This option substantially reduces the size of debugging information,
7082 but at significant potential loss in type information to the debugger.
7083 See @option{-femit-struct-debug-reduced} for a less aggressive option.
7084 See @option{-femit-struct-debug-detailed} for more detailed control.
7086 This option works only with DWARF debug output.
7088 @item -femit-struct-debug-reduced
7089 @opindex femit-struct-debug-reduced
7090 Emit debug information for struct-like types
7091 only when the base name of the compilation source file
7092 matches the base name of file in which the type is defined,
7093 unless the struct is a template or defined in a system header.
7095 This option significantly reduces the size of debugging information,
7096 with some potential loss in type information to the debugger.
7097 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
7098 See @option{-femit-struct-debug-detailed} for more detailed control.
7100 This option works only with DWARF debug output.
7102 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
7103 @opindex femit-struct-debug-detailed
7104 Specify the struct-like types
7105 for which the compiler generates debug information.
7106 The intent is to reduce duplicate struct debug information
7107 between different object files within the same program.
7109 This option is a detailed version of
7110 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
7111 which serves for most needs.
7113 A specification has the syntax@*
7114 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
7116 The optional first word limits the specification to
7117 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
7118 A struct type is used directly when it is the type of a variable, member.
7119 Indirect uses arise through pointers to structs.
7120 That is, when use of an incomplete struct is valid, the use is indirect.
7121 An example is
7122 @samp{struct one direct; struct two * indirect;}.
7124 The optional second word limits the specification to
7125 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
7126 Generic structs are a bit complicated to explain.
7127 For C++, these are non-explicit specializations of template classes,
7128 or non-template classes within the above.
7129 Other programming languages have generics,
7130 but @option{-femit-struct-debug-detailed} does not yet implement them.
7132 The third word specifies the source files for those
7133 structs for which the compiler should emit debug information.
7134 The values @samp{none} and @samp{any} have the normal meaning.
7135 The value @samp{base} means that
7136 the base of name of the file in which the type declaration appears
7137 must match the base of the name of the main compilation file.
7138 In practice, this means that when compiling @file{foo.c}, debug information
7139 is generated for types declared in that file and @file{foo.h},
7140 but not other header files.
7141 The value @samp{sys} means those types satisfying @samp{base}
7142 or declared in system or compiler headers.
7144 You may need to experiment to determine the best settings for your application.
7146 The default is @option{-femit-struct-debug-detailed=all}.
7148 This option works only with DWARF debug output.
7150 @item -fno-dwarf2-cfi-asm
7151 @opindex fdwarf2-cfi-asm
7152 @opindex fno-dwarf2-cfi-asm
7153 Emit DWARF unwind info as compiler generated @code{.eh_frame} section
7154 instead of using GAS @code{.cfi_*} directives.
7156 @item -fno-eliminate-unused-debug-types
7157 @opindex feliminate-unused-debug-types
7158 @opindex fno-eliminate-unused-debug-types
7159 Normally, when producing DWARF output, GCC avoids producing debug symbol 
7160 output for types that are nowhere used in the source file being compiled.
7161 Sometimes it is useful to have GCC emit debugging
7162 information for all types declared in a compilation
7163 unit, regardless of whether or not they are actually used
7164 in that compilation unit, for example 
7165 if, in the debugger, you want to cast a value to a type that is
7166 not actually used in your program (but is declared).  More often,
7167 however, this results in a significant amount of wasted space.
7168 @end table
7170 @node Optimize Options
7171 @section Options That Control Optimization
7172 @cindex optimize options
7173 @cindex options, optimization
7175 These options control various sorts of optimizations.
7177 Without any optimization option, the compiler's goal is to reduce the
7178 cost of compilation and to make debugging produce the expected
7179 results.  Statements are independent: if you stop the program with a
7180 breakpoint between statements, you can then assign a new value to any
7181 variable or change the program counter to any other statement in the
7182 function and get exactly the results you expect from the source
7183 code.
7185 Turning on optimization flags makes the compiler attempt to improve
7186 the performance and/or code size at the expense of compilation time
7187 and possibly the ability to debug the program.
7189 The compiler performs optimization based on the knowledge it has of the
7190 program.  Compiling multiple files at once to a single output file mode allows
7191 the compiler to use information gained from all of the files when compiling
7192 each of them.
7194 Not all optimizations are controlled directly by a flag.  Only
7195 optimizations that have a flag are listed in this section.
7197 Most optimizations are only enabled if an @option{-O} level is set on
7198 the command line.  Otherwise they are disabled, even if individual
7199 optimization flags are specified.
7201 Depending on the target and how GCC was configured, a slightly different
7202 set of optimizations may be enabled at each @option{-O} level than
7203 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
7204 to find out the exact set of optimizations that are enabled at each level.
7205 @xref{Overall Options}, for examples.
7207 @table @gcctabopt
7208 @item -O
7209 @itemx -O1
7210 @opindex O
7211 @opindex O1
7212 Optimize.  Optimizing compilation takes somewhat more time, and a lot
7213 more memory for a large function.
7215 With @option{-O}, the compiler tries to reduce code size and execution
7216 time, without performing any optimizations that take a great deal of
7217 compilation time.
7219 @option{-O} turns on the following optimization flags:
7220 @gccoptlist{
7221 -fauto-inc-dec @gol
7222 -fbranch-count-reg @gol
7223 -fcombine-stack-adjustments @gol
7224 -fcompare-elim @gol
7225 -fcprop-registers @gol
7226 -fdce @gol
7227 -fdefer-pop @gol
7228 -fdelayed-branch @gol
7229 -fdse @gol
7230 -fforward-propagate @gol
7231 -fguess-branch-probability @gol
7232 -fif-conversion2 @gol
7233 -fif-conversion @gol
7234 -finline-functions-called-once @gol
7235 -fipa-pure-const @gol
7236 -fipa-profile @gol
7237 -fipa-reference @gol
7238 -fmerge-constants @gol
7239 -fmove-loop-invariants @gol
7240 -freorder-blocks @gol
7241 -fshrink-wrap @gol
7242 -fshrink-wrap-separate @gol
7243 -fsplit-wide-types @gol
7244 -fssa-backprop @gol
7245 -fssa-phiopt @gol
7246 -ftree-bit-ccp @gol
7247 -ftree-ccp @gol
7248 -ftree-ch @gol
7249 -ftree-coalesce-vars @gol
7250 -ftree-copy-prop @gol
7251 -ftree-dce @gol
7252 -ftree-dominator-opts @gol
7253 -ftree-dse @gol
7254 -ftree-forwprop @gol
7255 -ftree-fre @gol
7256 -ftree-phiprop @gol
7257 -ftree-sink @gol
7258 -ftree-slsr @gol
7259 -ftree-sra @gol
7260 -ftree-pta @gol
7261 -ftree-ter @gol
7262 -funit-at-a-time}
7264 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
7265 where doing so does not interfere with debugging.
7267 @item -O2
7268 @opindex O2
7269 Optimize even more.  GCC performs nearly all supported optimizations
7270 that do not involve a space-speed tradeoff.
7271 As compared to @option{-O}, this option increases both compilation time
7272 and the performance of the generated code.
7274 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
7275 also turns on the following optimization flags:
7276 @gccoptlist{-fthread-jumps @gol
7277 -falign-functions  -falign-jumps @gol
7278 -falign-loops  -falign-labels @gol
7279 -fcaller-saves @gol
7280 -fcrossjumping @gol
7281 -fcse-follow-jumps  -fcse-skip-blocks @gol
7282 -fdelete-null-pointer-checks @gol
7283 -fdevirtualize -fdevirtualize-speculatively @gol
7284 -fexpensive-optimizations @gol
7285 -fgcse  -fgcse-lm  @gol
7286 -fhoist-adjacent-loads @gol
7287 -finline-small-functions @gol
7288 -findirect-inlining @gol
7289 -fipa-cp @gol
7290 -fipa-bit-cp @gol
7291 -fipa-vrp @gol
7292 -fipa-sra @gol
7293 -fipa-icf @gol
7294 -fisolate-erroneous-paths-dereference @gol
7295 -flra-remat @gol
7296 -foptimize-sibling-calls @gol
7297 -foptimize-strlen @gol
7298 -fpartial-inlining @gol
7299 -fpeephole2 @gol
7300 -freorder-blocks-algorithm=stc @gol
7301 -freorder-blocks-and-partition -freorder-functions @gol
7302 -frerun-cse-after-loop  @gol
7303 -fsched-interblock  -fsched-spec @gol
7304 -fschedule-insns  -fschedule-insns2 @gol
7305 -fstore-merging @gol
7306 -fstrict-aliasing @gol
7307 -ftree-builtin-call-dce @gol
7308 -ftree-switch-conversion -ftree-tail-merge @gol
7309 -fcode-hoisting @gol
7310 -ftree-pre @gol
7311 -ftree-vrp @gol
7312 -fipa-ra}
7314 Please note the warning under @option{-fgcse} about
7315 invoking @option{-O2} on programs that use computed gotos.
7317 @item -O3
7318 @opindex O3
7319 Optimize yet more.  @option{-O3} turns on all optimizations specified
7320 by @option{-O2} and also turns on the following optimization flags:
7321 @gccoptlist{-finline-functions @gol
7322 -funswitch-loops @gol
7323 -fpredictive-commoning @gol
7324 -fgcse-after-reload @gol
7325 -ftree-loop-vectorize @gol
7326 -ftree-loop-distribution @gol
7327 -ftree-loop-distribute-patterns @gol
7328 -fsplit-paths @gol
7329 -ftree-slp-vectorize @gol
7330 -fvect-cost-model @gol
7331 -ftree-partial-pre @gol
7332 -fpeel-loops @gol
7333 -fipa-cp-clone}
7335 @item -O0
7336 @opindex O0
7337 Reduce compilation time and make debugging produce the expected
7338 results.  This is the default.
7340 @item -Os
7341 @opindex Os
7342 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
7343 do not typically increase code size.  It also performs further
7344 optimizations designed to reduce code size.
7346 @option{-Os} disables the following optimization flags:
7347 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
7348 -falign-labels  -freorder-blocks  -freorder-blocks-algorithm=stc @gol
7349 -freorder-blocks-and-partition  -fprefetch-loop-arrays}
7351 @item -Ofast
7352 @opindex Ofast
7353 Disregard strict standards compliance.  @option{-Ofast} enables all
7354 @option{-O3} optimizations.  It also enables optimizations that are not
7355 valid for all standard-compliant programs.
7356 It turns on @option{-ffast-math} and the Fortran-specific
7357 @option{-fstack-arrays}, unless @option{-fmax-stack-var-size} is
7358 specified, and @option{-fno-protect-parens}.
7360 @item -Og
7361 @opindex Og
7362 Optimize debugging experience.  @option{-Og} enables optimizations
7363 that do not interfere with debugging. It should be the optimization
7364 level of choice for the standard edit-compile-debug cycle, offering
7365 a reasonable level of optimization while maintaining fast compilation
7366 and a good debugging experience.
7367 @end table
7369 If you use multiple @option{-O} options, with or without level numbers,
7370 the last such option is the one that is effective.
7372 Options of the form @option{-f@var{flag}} specify machine-independent
7373 flags.  Most flags have both positive and negative forms; the negative
7374 form of @option{-ffoo} is @option{-fno-foo}.  In the table
7375 below, only one of the forms is listed---the one you typically 
7376 use.  You can figure out the other form by either removing @samp{no-}
7377 or adding it.
7379 The following options control specific optimizations.  They are either
7380 activated by @option{-O} options or are related to ones that are.  You
7381 can use the following flags in the rare cases when ``fine-tuning'' of
7382 optimizations to be performed is desired.
7384 @table @gcctabopt
7385 @item -fno-defer-pop
7386 @opindex fno-defer-pop
7387 Always pop the arguments to each function call as soon as that function
7388 returns.  For machines that must pop arguments after a function call,
7389 the compiler normally lets arguments accumulate on the stack for several
7390 function calls and pops them all at once.
7392 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7394 @item -fforward-propagate
7395 @opindex fforward-propagate
7396 Perform a forward propagation pass on RTL@.  The pass tries to combine two
7397 instructions and checks if the result can be simplified.  If loop unrolling
7398 is active, two passes are performed and the second is scheduled after
7399 loop unrolling.
7401 This option is enabled by default at optimization levels @option{-O},
7402 @option{-O2}, @option{-O3}, @option{-Os}.
7404 @item -ffp-contract=@var{style}
7405 @opindex ffp-contract
7406 @option{-ffp-contract=off} disables floating-point expression contraction.
7407 @option{-ffp-contract=fast} enables floating-point expression contraction
7408 such as forming of fused multiply-add operations if the target has
7409 native support for them.
7410 @option{-ffp-contract=on} enables floating-point expression contraction
7411 if allowed by the language standard.  This is currently not implemented
7412 and treated equal to @option{-ffp-contract=off}.
7414 The default is @option{-ffp-contract=fast}.
7416 @item -fomit-frame-pointer
7417 @opindex fomit-frame-pointer
7418 Don't keep the frame pointer in a register for functions that
7419 don't need one.  This avoids the instructions to save, set up and
7420 restore frame pointers; it also makes an extra register available
7421 in many functions.  @strong{It also makes debugging impossible on
7422 some machines.}
7424 On some machines, such as the VAX, this flag has no effect, because
7425 the standard calling sequence automatically handles the frame pointer
7426 and nothing is saved by pretending it doesn't exist.  The
7427 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
7428 whether a target machine supports this flag.  @xref{Registers,,Register
7429 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
7431 The default setting (when not optimizing for
7432 size) for 32-bit GNU/Linux x86 and 32-bit Darwin x86 targets is
7433 @option{-fomit-frame-pointer}.  You can configure GCC with the
7434 @option{--enable-frame-pointer} configure option to change the default.
7436 Note that @option{-fno-omit-frame-pointer} doesn't force a new stack
7437 frame for all functions if it isn't otherwise needed, and hence doesn't
7438 guarantee a new frame pointer for all functions.
7440 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7442 @item -foptimize-sibling-calls
7443 @opindex foptimize-sibling-calls
7444 Optimize sibling and tail recursive calls.
7446 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7448 @item -foptimize-strlen
7449 @opindex foptimize-strlen
7450 Optimize various standard C string functions (e.g. @code{strlen},
7451 @code{strchr} or @code{strcpy}) and
7452 their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
7454 Enabled at levels @option{-O2}, @option{-O3}.
7456 @item -fno-inline
7457 @opindex fno-inline
7458 Do not expand any functions inline apart from those marked with
7459 the @code{always_inline} attribute.  This is the default when not
7460 optimizing.
7462 Single functions can be exempted from inlining by marking them
7463 with the @code{noinline} attribute.
7465 @item -finline-small-functions
7466 @opindex finline-small-functions
7467 Integrate functions into their callers when their body is smaller than expected
7468 function call code (so overall size of program gets smaller).  The compiler
7469 heuristically decides which functions are simple enough to be worth integrating
7470 in this way.  This inlining applies to all functions, even those not declared
7471 inline.
7473 Enabled at level @option{-O2}.
7475 @item -findirect-inlining
7476 @opindex findirect-inlining
7477 Inline also indirect calls that are discovered to be known at compile
7478 time thanks to previous inlining.  This option has any effect only
7479 when inlining itself is turned on by the @option{-finline-functions}
7480 or @option{-finline-small-functions} options.
7482 Enabled at level @option{-O2}.
7484 @item -finline-functions
7485 @opindex finline-functions
7486 Consider all functions for inlining, even if they are not declared inline.
7487 The compiler heuristically decides which functions are worth integrating
7488 in this way.
7490 If all calls to a given function are integrated, and the function is
7491 declared @code{static}, then the function is normally not output as
7492 assembler code in its own right.
7494 Enabled at level @option{-O3}.
7496 @item -finline-functions-called-once
7497 @opindex finline-functions-called-once
7498 Consider all @code{static} functions called once for inlining into their
7499 caller even if they are not marked @code{inline}.  If a call to a given
7500 function is integrated, then the function is not output as assembler code
7501 in its own right.
7503 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
7505 @item -fearly-inlining
7506 @opindex fearly-inlining
7507 Inline functions marked by @code{always_inline} and functions whose body seems
7508 smaller than the function call overhead early before doing
7509 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
7510 makes profiling significantly cheaper and usually inlining faster on programs
7511 having large chains of nested wrapper functions.
7513 Enabled by default.
7515 @item -fipa-sra
7516 @opindex fipa-sra
7517 Perform interprocedural scalar replacement of aggregates, removal of
7518 unused parameters and replacement of parameters passed by reference
7519 by parameters passed by value.
7521 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
7523 @item -finline-limit=@var{n}
7524 @opindex finline-limit
7525 By default, GCC limits the size of functions that can be inlined.  This flag
7526 allows coarse control of this limit.  @var{n} is the size of functions that
7527 can be inlined in number of pseudo instructions.
7529 Inlining is actually controlled by a number of parameters, which may be
7530 specified individually by using @option{--param @var{name}=@var{value}}.
7531 The @option{-finline-limit=@var{n}} option sets some of these parameters
7532 as follows:
7534 @table @gcctabopt
7535 @item max-inline-insns-single
7536 is set to @var{n}/2.
7537 @item max-inline-insns-auto
7538 is set to @var{n}/2.
7539 @end table
7541 See below for a documentation of the individual
7542 parameters controlling inlining and for the defaults of these parameters.
7544 @emph{Note:} there may be no value to @option{-finline-limit} that results
7545 in default behavior.
7547 @emph{Note:} pseudo instruction represents, in this particular context, an
7548 abstract measurement of function's size.  In no way does it represent a count
7549 of assembly instructions and as such its exact meaning might change from one
7550 release to an another.
7552 @item -fno-keep-inline-dllexport
7553 @opindex fno-keep-inline-dllexport
7554 This is a more fine-grained version of @option{-fkeep-inline-functions},
7555 which applies only to functions that are declared using the @code{dllexport}
7556 attribute or declspec.  @xref{Function Attributes,,Declaring Attributes of
7557 Functions}.
7559 @item -fkeep-inline-functions
7560 @opindex fkeep-inline-functions
7561 In C, emit @code{static} functions that are declared @code{inline}
7562 into the object file, even if the function has been inlined into all
7563 of its callers.  This switch does not affect functions using the
7564 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
7565 inline functions into the object file.
7567 @item -fkeep-static-functions
7568 @opindex fkeep-static-functions
7569 Emit @code{static} functions into the object file, even if the function
7570 is never used.
7572 @item -fkeep-static-consts
7573 @opindex fkeep-static-consts
7574 Emit variables declared @code{static const} when optimization isn't turned
7575 on, even if the variables aren't referenced.
7577 GCC enables this option by default.  If you want to force the compiler to
7578 check if a variable is referenced, regardless of whether or not
7579 optimization is turned on, use the @option{-fno-keep-static-consts} option.
7581 @item -fmerge-constants
7582 @opindex fmerge-constants
7583 Attempt to merge identical constants (string constants and floating-point
7584 constants) across compilation units.
7586 This option is the default for optimized compilation if the assembler and
7587 linker support it.  Use @option{-fno-merge-constants} to inhibit this
7588 behavior.
7590 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7592 @item -fmerge-all-constants
7593 @opindex fmerge-all-constants
7594 Attempt to merge identical constants and identical variables.
7596 This option implies @option{-fmerge-constants}.  In addition to
7597 @option{-fmerge-constants} this considers e.g.@: even constant initialized
7598 arrays or initialized constant variables with integral or floating-point
7599 types.  Languages like C or C++ require each variable, including multiple
7600 instances of the same variable in recursive calls, to have distinct locations,
7601 so using this option results in non-conforming
7602 behavior.
7604 @item -fmodulo-sched
7605 @opindex fmodulo-sched
7606 Perform swing modulo scheduling immediately before the first scheduling
7607 pass.  This pass looks at innermost loops and reorders their
7608 instructions by overlapping different iterations.
7610 @item -fmodulo-sched-allow-regmoves
7611 @opindex fmodulo-sched-allow-regmoves
7612 Perform more aggressive SMS-based modulo scheduling with register moves
7613 allowed.  By setting this flag certain anti-dependences edges are
7614 deleted, which triggers the generation of reg-moves based on the
7615 life-range analysis.  This option is effective only with
7616 @option{-fmodulo-sched} enabled.
7618 @item -fno-branch-count-reg
7619 @opindex fno-branch-count-reg
7620 Avoid running a pass scanning for opportunities to use ``decrement and
7621 branch'' instructions on a count register instead of generating sequences
7622 of instructions that decrement a register, compare it against zero, and
7623 then branch based upon the result.  This option is only meaningful on
7624 architectures that support such instructions, which include x86, PowerPC,
7625 IA-64 and S/390.  Note that the @option{-fno-branch-count-reg} option
7626 doesn't remove the decrement and branch instructions from the generated
7627 instruction stream introduced by other optimization passes.
7629 Enabled by default at @option{-O1} and higher.
7631 The default is @option{-fbranch-count-reg}.
7633 @item -fno-function-cse
7634 @opindex fno-function-cse
7635 Do not put function addresses in registers; make each instruction that
7636 calls a constant function contain the function's address explicitly.
7638 This option results in less efficient code, but some strange hacks
7639 that alter the assembler output may be confused by the optimizations
7640 performed when this option is not used.
7642 The default is @option{-ffunction-cse}
7644 @item -fno-zero-initialized-in-bss
7645 @opindex fno-zero-initialized-in-bss
7646 If the target supports a BSS section, GCC by default puts variables that
7647 are initialized to zero into BSS@.  This can save space in the resulting
7648 code.
7650 This option turns off this behavior because some programs explicitly
7651 rely on variables going to the data section---e.g., so that the
7652 resulting executable can find the beginning of that section and/or make
7653 assumptions based on that.
7655 The default is @option{-fzero-initialized-in-bss}.
7657 @item -fthread-jumps
7658 @opindex fthread-jumps
7659 Perform optimizations that check to see if a jump branches to a
7660 location where another comparison subsumed by the first is found.  If
7661 so, the first branch is redirected to either the destination of the
7662 second branch or a point immediately following it, depending on whether
7663 the condition is known to be true or false.
7665 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7667 @item -fsplit-wide-types
7668 @opindex fsplit-wide-types
7669 When using a type that occupies multiple registers, such as @code{long
7670 long} on a 32-bit system, split the registers apart and allocate them
7671 independently.  This normally generates better code for those types,
7672 but may make debugging more difficult.
7674 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
7675 @option{-Os}.
7677 @item -fcse-follow-jumps
7678 @opindex fcse-follow-jumps
7679 In common subexpression elimination (CSE), scan through jump instructions
7680 when the target of the jump is not reached by any other path.  For
7681 example, when CSE encounters an @code{if} statement with an
7682 @code{else} clause, CSE follows the jump when the condition
7683 tested is false.
7685 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7687 @item -fcse-skip-blocks
7688 @opindex fcse-skip-blocks
7689 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
7690 follow jumps that conditionally skip over blocks.  When CSE
7691 encounters a simple @code{if} statement with no else clause,
7692 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
7693 body of the @code{if}.
7695 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7697 @item -frerun-cse-after-loop
7698 @opindex frerun-cse-after-loop
7699 Re-run common subexpression elimination after loop optimizations are
7700 performed.
7702 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7704 @item -fgcse
7705 @opindex fgcse
7706 Perform a global common subexpression elimination pass.
7707 This pass also performs global constant and copy propagation.
7709 @emph{Note:} When compiling a program using computed gotos, a GCC
7710 extension, you may get better run-time performance if you disable
7711 the global common subexpression elimination pass by adding
7712 @option{-fno-gcse} to the command line.
7714 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7716 @item -fgcse-lm
7717 @opindex fgcse-lm
7718 When @option{-fgcse-lm} is enabled, global common subexpression elimination
7719 attempts to move loads that are only killed by stores into themselves.  This
7720 allows a loop containing a load/store sequence to be changed to a load outside
7721 the loop, and a copy/store within the loop.
7723 Enabled by default when @option{-fgcse} is enabled.
7725 @item -fgcse-sm
7726 @opindex fgcse-sm
7727 When @option{-fgcse-sm} is enabled, a store motion pass is run after
7728 global common subexpression elimination.  This pass attempts to move
7729 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
7730 loops containing a load/store sequence can be changed to a load before
7731 the loop and a store after the loop.
7733 Not enabled at any optimization level.
7735 @item -fgcse-las
7736 @opindex fgcse-las
7737 When @option{-fgcse-las} is enabled, the global common subexpression
7738 elimination pass eliminates redundant loads that come after stores to the
7739 same memory location (both partial and full redundancies).
7741 Not enabled at any optimization level.
7743 @item -fgcse-after-reload
7744 @opindex fgcse-after-reload
7745 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
7746 pass is performed after reload.  The purpose of this pass is to clean up
7747 redundant spilling.
7749 @item -faggressive-loop-optimizations
7750 @opindex faggressive-loop-optimizations
7751 This option tells the loop optimizer to use language constraints to
7752 derive bounds for the number of iterations of a loop.  This assumes that
7753 loop code does not invoke undefined behavior by for example causing signed
7754 integer overflows or out-of-bound array accesses.  The bounds for the
7755 number of iterations of a loop are used to guide loop unrolling and peeling
7756 and loop exit test optimizations.
7757 This option is enabled by default.
7759 @item -funconstrained-commons
7760 @opindex funconstrained-commons
7761 This option tells the compiler that variables declared in common blocks
7762 (e.g. Fortran) may later be overridden with longer trailing arrays. This
7763 prevents certain optimizations that depend on knowing the array bounds.
7765 @item -fcrossjumping
7766 @opindex fcrossjumping
7767 Perform cross-jumping transformation.
7768 This transformation unifies equivalent code and saves code size.  The
7769 resulting code may or may not perform better than without cross-jumping.
7771 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7773 @item -fauto-inc-dec
7774 @opindex fauto-inc-dec
7775 Combine increments or decrements of addresses with memory accesses.
7776 This pass is always skipped on architectures that do not have
7777 instructions to support this.  Enabled by default at @option{-O} and
7778 higher on architectures that support this.
7780 @item -fdce
7781 @opindex fdce
7782 Perform dead code elimination (DCE) on RTL@.
7783 Enabled by default at @option{-O} and higher.
7785 @item -fdse
7786 @opindex fdse
7787 Perform dead store elimination (DSE) on RTL@.
7788 Enabled by default at @option{-O} and higher.
7790 @item -fif-conversion
7791 @opindex fif-conversion
7792 Attempt to transform conditional jumps into branch-less equivalents.  This
7793 includes use of conditional moves, min, max, set flags and abs instructions, and
7794 some tricks doable by standard arithmetics.  The use of conditional execution
7795 on chips where it is available is controlled by @option{-fif-conversion2}.
7797 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7799 @item -fif-conversion2
7800 @opindex fif-conversion2
7801 Use conditional execution (where available) to transform conditional jumps into
7802 branch-less equivalents.
7804 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7806 @item -fdeclone-ctor-dtor
7807 @opindex fdeclone-ctor-dtor
7808 The C++ ABI requires multiple entry points for constructors and
7809 destructors: one for a base subobject, one for a complete object, and
7810 one for a virtual destructor that calls operator delete afterwards.
7811 For a hierarchy with virtual bases, the base and complete variants are
7812 clones, which means two copies of the function.  With this option, the
7813 base and complete variants are changed to be thunks that call a common
7814 implementation.
7816 Enabled by @option{-Os}.
7818 @item -fdelete-null-pointer-checks
7819 @opindex fdelete-null-pointer-checks
7820 Assume that programs cannot safely dereference null pointers, and that
7821 no code or data element resides at address zero.
7822 This option enables simple constant
7823 folding optimizations at all optimization levels.  In addition, other
7824 optimization passes in GCC use this flag to control global dataflow
7825 analyses that eliminate useless checks for null pointers; these assume
7826 that a memory access to address zero always results in a trap, so
7827 that if a pointer is checked after it has already been dereferenced,
7828 it cannot be null.
7830 Note however that in some environments this assumption is not true.
7831 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
7832 for programs that depend on that behavior.
7834 This option is enabled by default on most targets.  On Nios II ELF, it
7835 defaults to off.  On AVR and CR16, this option is completely disabled.  
7837 Passes that use the dataflow information
7838 are enabled independently at different optimization levels.
7840 @item -fdevirtualize
7841 @opindex fdevirtualize
7842 Attempt to convert calls to virtual functions to direct calls.  This
7843 is done both within a procedure and interprocedurally as part of
7844 indirect inlining (@option{-findirect-inlining}) and interprocedural constant
7845 propagation (@option{-fipa-cp}).
7846 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7848 @item -fdevirtualize-speculatively
7849 @opindex fdevirtualize-speculatively
7850 Attempt to convert calls to virtual functions to speculative direct calls.
7851 Based on the analysis of the type inheritance graph, determine for a given call
7852 the set of likely targets. If the set is small, preferably of size 1, change
7853 the call into a conditional deciding between direct and indirect calls.  The
7854 speculative calls enable more optimizations, such as inlining.  When they seem
7855 useless after further optimization, they are converted back into original form.
7857 @item -fdevirtualize-at-ltrans
7858 @opindex fdevirtualize-at-ltrans
7859 Stream extra information needed for aggressive devirtualization when running
7860 the link-time optimizer in local transformation mode.  
7861 This option enables more devirtualization but
7862 significantly increases the size of streamed data. For this reason it is
7863 disabled by default.
7865 @item -fexpensive-optimizations
7866 @opindex fexpensive-optimizations
7867 Perform a number of minor optimizations that are relatively expensive.
7869 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7871 @item -free
7872 @opindex free
7873 Attempt to remove redundant extension instructions.  This is especially
7874 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
7875 registers after writing to their lower 32-bit half.
7877 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
7878 @option{-O3}, @option{-Os}.
7880 @item -fno-lifetime-dse
7881 @opindex fno-lifetime-dse
7882 In C++ the value of an object is only affected by changes within its
7883 lifetime: when the constructor begins, the object has an indeterminate
7884 value, and any changes during the lifetime of the object are dead when
7885 the object is destroyed.  Normally dead store elimination will take
7886 advantage of this; if your code relies on the value of the object
7887 storage persisting beyond the lifetime of the object, you can use this
7888 flag to disable this optimization.  To preserve stores before the
7889 constructor starts (e.g. because your operator new clears the object
7890 storage) but still treat the object as dead after the destructor you,
7891 can use @option{-flifetime-dse=1}.  The default behavior can be
7892 explicitly selected with @option{-flifetime-dse=2}.
7893 @option{-flifetime-dse=0} is equivalent to @option{-fno-lifetime-dse}.
7895 @item -flive-range-shrinkage
7896 @opindex flive-range-shrinkage
7897 Attempt to decrease register pressure through register live range
7898 shrinkage.  This is helpful for fast processors with small or moderate
7899 size register sets.
7901 @item -fira-algorithm=@var{algorithm}
7902 @opindex fira-algorithm
7903 Use the specified coloring algorithm for the integrated register
7904 allocator.  The @var{algorithm} argument can be @samp{priority}, which
7905 specifies Chow's priority coloring, or @samp{CB}, which specifies
7906 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
7907 for all architectures, but for those targets that do support it, it is
7908 the default because it generates better code.
7910 @item -fira-region=@var{region}
7911 @opindex fira-region
7912 Use specified regions for the integrated register allocator.  The
7913 @var{region} argument should be one of the following:
7915 @table @samp
7917 @item all
7918 Use all loops as register allocation regions.
7919 This can give the best results for machines with a small and/or
7920 irregular register set.
7922 @item mixed
7923 Use all loops except for loops with small register pressure 
7924 as the regions.  This value usually gives
7925 the best results in most cases and for most architectures,
7926 and is enabled by default when compiling with optimization for speed
7927 (@option{-O}, @option{-O2}, @dots{}).
7929 @item one
7930 Use all functions as a single region.  
7931 This typically results in the smallest code size, and is enabled by default for
7932 @option{-Os} or @option{-O0}.
7934 @end table
7936 @item -fira-hoist-pressure
7937 @opindex fira-hoist-pressure
7938 Use IRA to evaluate register pressure in the code hoisting pass for
7939 decisions to hoist expressions.  This option usually results in smaller
7940 code, but it can slow the compiler down.
7942 This option is enabled at level @option{-Os} for all targets.
7944 @item -fira-loop-pressure
7945 @opindex fira-loop-pressure
7946 Use IRA to evaluate register pressure in loops for decisions to move
7947 loop invariants.  This option usually results in generation
7948 of faster and smaller code on machines with large register files (>= 32
7949 registers), but it can slow the compiler down.
7951 This option is enabled at level @option{-O3} for some targets.
7953 @item -fno-ira-share-save-slots
7954 @opindex fno-ira-share-save-slots
7955 Disable sharing of stack slots used for saving call-used hard
7956 registers living through a call.  Each hard register gets a
7957 separate stack slot, and as a result function stack frames are
7958 larger.
7960 @item -fno-ira-share-spill-slots
7961 @opindex fno-ira-share-spill-slots
7962 Disable sharing of stack slots allocated for pseudo-registers.  Each
7963 pseudo-register that does not get a hard register gets a separate
7964 stack slot, and as a result function stack frames are larger.
7966 @item -flra-remat
7967 @opindex flra-remat
7968 Enable CFG-sensitive rematerialization in LRA.  Instead of loading
7969 values of spilled pseudos, LRA tries to rematerialize (recalculate)
7970 values if it is profitable.
7972 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7974 @item -fdelayed-branch
7975 @opindex fdelayed-branch
7976 If supported for the target machine, attempt to reorder instructions
7977 to exploit instruction slots available after delayed branch
7978 instructions.
7980 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7982 @item -fschedule-insns
7983 @opindex fschedule-insns
7984 If supported for the target machine, attempt to reorder instructions to
7985 eliminate execution stalls due to required data being unavailable.  This
7986 helps machines that have slow floating point or memory load instructions
7987 by allowing other instructions to be issued until the result of the load
7988 or floating-point instruction is required.
7990 Enabled at levels @option{-O2}, @option{-O3}.
7992 @item -fschedule-insns2
7993 @opindex fschedule-insns2
7994 Similar to @option{-fschedule-insns}, but requests an additional pass of
7995 instruction scheduling after register allocation has been done.  This is
7996 especially useful on machines with a relatively small number of
7997 registers and where memory load instructions take more than one cycle.
7999 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8001 @item -fno-sched-interblock
8002 @opindex fno-sched-interblock
8003 Don't schedule instructions across basic blocks.  This is normally
8004 enabled by default when scheduling before register allocation, i.e.@:
8005 with @option{-fschedule-insns} or at @option{-O2} or higher.
8007 @item -fno-sched-spec
8008 @opindex fno-sched-spec
8009 Don't allow speculative motion of non-load instructions.  This is normally
8010 enabled by default when scheduling before register allocation, i.e.@:
8011 with @option{-fschedule-insns} or at @option{-O2} or higher.
8013 @item -fsched-pressure
8014 @opindex fsched-pressure
8015 Enable register pressure sensitive insn scheduling before register
8016 allocation.  This only makes sense when scheduling before register
8017 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
8018 @option{-O2} or higher.  Usage of this option can improve the
8019 generated code and decrease its size by preventing register pressure
8020 increase above the number of available hard registers and subsequent
8021 spills in register allocation.
8023 @item -fsched-spec-load
8024 @opindex fsched-spec-load
8025 Allow speculative motion of some load instructions.  This only makes
8026 sense when scheduling before register allocation, i.e.@: with
8027 @option{-fschedule-insns} or at @option{-O2} or higher.
8029 @item -fsched-spec-load-dangerous
8030 @opindex fsched-spec-load-dangerous
8031 Allow speculative motion of more load instructions.  This only makes
8032 sense when scheduling before register allocation, i.e.@: with
8033 @option{-fschedule-insns} or at @option{-O2} or higher.
8035 @item -fsched-stalled-insns
8036 @itemx -fsched-stalled-insns=@var{n}
8037 @opindex fsched-stalled-insns
8038 Define how many insns (if any) can be moved prematurely from the queue
8039 of stalled insns into the ready list during the second scheduling pass.
8040 @option{-fno-sched-stalled-insns} means that no insns are moved
8041 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
8042 on how many queued insns can be moved prematurely.
8043 @option{-fsched-stalled-insns} without a value is equivalent to
8044 @option{-fsched-stalled-insns=1}.
8046 @item -fsched-stalled-insns-dep
8047 @itemx -fsched-stalled-insns-dep=@var{n}
8048 @opindex fsched-stalled-insns-dep
8049 Define how many insn groups (cycles) are examined for a dependency
8050 on a stalled insn that is a candidate for premature removal from the queue
8051 of stalled insns.  This has an effect only during the second scheduling pass,
8052 and only if @option{-fsched-stalled-insns} is used.
8053 @option{-fno-sched-stalled-insns-dep} is equivalent to
8054 @option{-fsched-stalled-insns-dep=0}.
8055 @option{-fsched-stalled-insns-dep} without a value is equivalent to
8056 @option{-fsched-stalled-insns-dep=1}.
8058 @item -fsched2-use-superblocks
8059 @opindex fsched2-use-superblocks
8060 When scheduling after register allocation, use superblock scheduling.
8061 This allows motion across basic block boundaries,
8062 resulting in faster schedules.  This option is experimental, as not all machine
8063 descriptions used by GCC model the CPU closely enough to avoid unreliable
8064 results from the algorithm.
8066 This only makes sense when scheduling after register allocation, i.e.@: with
8067 @option{-fschedule-insns2} or at @option{-O2} or higher.
8069 @item -fsched-group-heuristic
8070 @opindex fsched-group-heuristic
8071 Enable the group heuristic in the scheduler.  This heuristic favors
8072 the instruction that belongs to a schedule group.  This is enabled
8073 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8074 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8076 @item -fsched-critical-path-heuristic
8077 @opindex fsched-critical-path-heuristic
8078 Enable the critical-path heuristic in the scheduler.  This heuristic favors
8079 instructions on the critical path.  This is enabled by default when
8080 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8081 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8083 @item -fsched-spec-insn-heuristic
8084 @opindex fsched-spec-insn-heuristic
8085 Enable the speculative instruction heuristic in the scheduler.  This
8086 heuristic favors speculative instructions with greater dependency weakness.
8087 This is enabled by default when scheduling is enabled, i.e.@:
8088 with @option{-fschedule-insns} or @option{-fschedule-insns2}
8089 or at @option{-O2} or higher.
8091 @item -fsched-rank-heuristic
8092 @opindex fsched-rank-heuristic
8093 Enable the rank heuristic in the scheduler.  This heuristic favors
8094 the instruction belonging to a basic block with greater size or frequency.
8095 This is enabled by default when scheduling is enabled, i.e.@:
8096 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8097 at @option{-O2} or higher.
8099 @item -fsched-last-insn-heuristic
8100 @opindex fsched-last-insn-heuristic
8101 Enable the last-instruction heuristic in the scheduler.  This heuristic
8102 favors the instruction that is less dependent on the last instruction
8103 scheduled.  This is enabled by default when scheduling is enabled,
8104 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8105 at @option{-O2} or higher.
8107 @item -fsched-dep-count-heuristic
8108 @opindex fsched-dep-count-heuristic
8109 Enable the dependent-count heuristic in the scheduler.  This heuristic
8110 favors the instruction that has more instructions depending on it.
8111 This is enabled by default when scheduling is enabled, i.e.@:
8112 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8113 at @option{-O2} or higher.
8115 @item -freschedule-modulo-scheduled-loops
8116 @opindex freschedule-modulo-scheduled-loops
8117 Modulo scheduling is performed before traditional scheduling.  If a loop
8118 is modulo scheduled, later scheduling passes may change its schedule.  
8119 Use this option to control that behavior.
8121 @item -fselective-scheduling
8122 @opindex fselective-scheduling
8123 Schedule instructions using selective scheduling algorithm.  Selective
8124 scheduling runs instead of the first scheduler pass.
8126 @item -fselective-scheduling2
8127 @opindex fselective-scheduling2
8128 Schedule instructions using selective scheduling algorithm.  Selective
8129 scheduling runs instead of the second scheduler pass.
8131 @item -fsel-sched-pipelining
8132 @opindex fsel-sched-pipelining
8133 Enable software pipelining of innermost loops during selective scheduling.
8134 This option has no effect unless one of @option{-fselective-scheduling} or
8135 @option{-fselective-scheduling2} is turned on.
8137 @item -fsel-sched-pipelining-outer-loops
8138 @opindex fsel-sched-pipelining-outer-loops
8139 When pipelining loops during selective scheduling, also pipeline outer loops.
8140 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
8142 @item -fsemantic-interposition
8143 @opindex fsemantic-interposition
8144 Some object formats, like ELF, allow interposing of symbols by the 
8145 dynamic linker.
8146 This means that for symbols exported from the DSO, the compiler cannot perform
8147 interprocedural propagation, inlining and other optimizations in anticipation
8148 that the function or variable in question may change. While this feature is
8149 useful, for example, to rewrite memory allocation functions by a debugging
8150 implementation, it is expensive in the terms of code quality.
8151 With @option{-fno-semantic-interposition} the compiler assumes that 
8152 if interposition happens for functions the overwriting function will have 
8153 precisely the same semantics (and side effects). 
8154 Similarly if interposition happens
8155 for variables, the constructor of the variable will be the same. The flag
8156 has no effect for functions explicitly declared inline 
8157 (where it is never allowed for interposition to change semantics) 
8158 and for symbols explicitly declared weak.
8160 @item -fshrink-wrap
8161 @opindex fshrink-wrap
8162 Emit function prologues only before parts of the function that need it,
8163 rather than at the top of the function.  This flag is enabled by default at
8164 @option{-O} and higher.
8166 @item -fshrink-wrap-separate
8167 @opindex fshrink-wrap-separate
8168 Shrink-wrap separate parts of the prologue and epilogue separately, so that
8169 those parts are only executed when needed.
8170 This option is on by default, but has no effect unless @option{-fshrink-wrap}
8171 is also turned on and the target supports this.
8173 @item -fcaller-saves
8174 @opindex fcaller-saves
8175 Enable allocation of values to registers that are clobbered by
8176 function calls, by emitting extra instructions to save and restore the
8177 registers around such calls.  Such allocation is done only when it
8178 seems to result in better code.
8180 This option is always enabled by default on certain machines, usually
8181 those which have no call-preserved registers to use instead.
8183 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8185 @item -fcombine-stack-adjustments
8186 @opindex fcombine-stack-adjustments
8187 Tracks stack adjustments (pushes and pops) and stack memory references
8188 and then tries to find ways to combine them.
8190 Enabled by default at @option{-O1} and higher.
8192 @item -fipa-ra
8193 @opindex fipa-ra
8194 Use caller save registers for allocation if those registers are not used by
8195 any called function.  In that case it is not necessary to save and restore
8196 them around calls.  This is only possible if called functions are part of
8197 same compilation unit as current function and they are compiled before it.
8199 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}, however the option
8200 is disabled if generated code will be instrumented for profiling
8201 (@option{-p}, or @option{-pg}) or if callee's register usage cannot be known
8202 exactly (this happens on targets that do not expose prologues
8203 and epilogues in RTL).
8205 @item -fconserve-stack
8206 @opindex fconserve-stack
8207 Attempt to minimize stack usage.  The compiler attempts to use less
8208 stack space, even if that makes the program slower.  This option
8209 implies setting the @option{large-stack-frame} parameter to 100
8210 and the @option{large-stack-frame-growth} parameter to 400.
8212 @item -ftree-reassoc
8213 @opindex ftree-reassoc
8214 Perform reassociation on trees.  This flag is enabled by default
8215 at @option{-O} and higher.
8217 @item -fcode-hoisting
8218 @opindex fcode-hoisting
8219 Perform code hoisting.  Code hoisting tries to move the
8220 evaluation of expressions executed on all paths to the function exit
8221 as early as possible.  This is especially useful as a code size
8222 optimization, but it often helps for code speed as well.
8223 This flag is enabled by default at @option{-O2} and higher.
8225 @item -ftree-pre
8226 @opindex ftree-pre
8227 Perform partial redundancy elimination (PRE) on trees.  This flag is
8228 enabled by default at @option{-O2} and @option{-O3}.
8230 @item -ftree-partial-pre
8231 @opindex ftree-partial-pre
8232 Make partial redundancy elimination (PRE) more aggressive.  This flag is
8233 enabled by default at @option{-O3}.
8235 @item -ftree-forwprop
8236 @opindex ftree-forwprop
8237 Perform forward propagation on trees.  This flag is enabled by default
8238 at @option{-O} and higher.
8240 @item -ftree-fre
8241 @opindex ftree-fre
8242 Perform full redundancy elimination (FRE) on trees.  The difference
8243 between FRE and PRE is that FRE only considers expressions
8244 that are computed on all paths leading to the redundant computation.
8245 This analysis is faster than PRE, though it exposes fewer redundancies.
8246 This flag is enabled by default at @option{-O} and higher.
8248 @item -ftree-phiprop
8249 @opindex ftree-phiprop
8250 Perform hoisting of loads from conditional pointers on trees.  This
8251 pass is enabled by default at @option{-O} and higher.
8253 @item -fhoist-adjacent-loads
8254 @opindex fhoist-adjacent-loads
8255 Speculatively hoist loads from both branches of an if-then-else if the
8256 loads are from adjacent locations in the same structure and the target
8257 architecture has a conditional move instruction.  This flag is enabled
8258 by default at @option{-O2} and higher.
8260 @item -ftree-copy-prop
8261 @opindex ftree-copy-prop
8262 Perform copy propagation on trees.  This pass eliminates unnecessary
8263 copy operations.  This flag is enabled by default at @option{-O} and
8264 higher.
8266 @item -fipa-pure-const
8267 @opindex fipa-pure-const
8268 Discover which functions are pure or constant.
8269 Enabled by default at @option{-O} and higher.
8271 @item -fipa-reference
8272 @opindex fipa-reference
8273 Discover which static variables do not escape the
8274 compilation unit.
8275 Enabled by default at @option{-O} and higher.
8277 @item -fipa-pta
8278 @opindex fipa-pta
8279 Perform interprocedural pointer analysis and interprocedural modification
8280 and reference analysis.  This option can cause excessive memory and
8281 compile-time usage on large compilation units.  It is not enabled by
8282 default at any optimization level.
8284 @item -fipa-profile
8285 @opindex fipa-profile
8286 Perform interprocedural profile propagation.  The functions called only from
8287 cold functions are marked as cold. Also functions executed once (such as
8288 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
8289 functions and loop less parts of functions executed once are then optimized for
8290 size.
8291 Enabled by default at @option{-O} and higher.
8293 @item -fipa-cp
8294 @opindex fipa-cp
8295 Perform interprocedural constant propagation.
8296 This optimization analyzes the program to determine when values passed
8297 to functions are constants and then optimizes accordingly.
8298 This optimization can substantially increase performance
8299 if the application has constants passed to functions.
8300 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
8302 @item -fipa-cp-clone
8303 @opindex fipa-cp-clone
8304 Perform function cloning to make interprocedural constant propagation stronger.
8305 When enabled, interprocedural constant propagation performs function cloning
8306 when externally visible function can be called with constant arguments.
8307 Because this optimization can create multiple copies of functions,
8308 it may significantly increase code size
8309 (see @option{--param ipcp-unit-growth=@var{value}}).
8310 This flag is enabled by default at @option{-O3}.
8312 @item -fipa-bit-cp
8313 @opindex -fipa-bit-cp
8314 When enabled, perform interprocedural bitwise constant
8315 propagation. This flag is enabled by default at @option{-O2}. It
8316 requires that @option{-fipa-cp} is enabled.
8318 @item -fipa-vrp
8319 @opindex -fipa-vrp
8320 When enabled, perform interprocedural propagation of value
8321 ranges. This flag is enabled by default at @option{-O2}. It requires
8322 that @option{-fipa-cp} is enabled.
8324 @item -fipa-icf
8325 @opindex fipa-icf
8326 Perform Identical Code Folding for functions and read-only variables.
8327 The optimization reduces code size and may disturb unwind stacks by replacing
8328 a function by equivalent one with a different name. The optimization works
8329 more effectively with link-time optimization enabled.
8331 Nevertheless the behavior is similar to Gold Linker ICF optimization, GCC ICF
8332 works on different levels and thus the optimizations are not same - there are
8333 equivalences that are found only by GCC and equivalences found only by Gold.
8335 This flag is enabled by default at @option{-O2} and @option{-Os}.
8337 @item -fisolate-erroneous-paths-dereference
8338 @opindex fisolate-erroneous-paths-dereference
8339 Detect paths that trigger erroneous or undefined behavior due to
8340 dereferencing a null pointer.  Isolate those paths from the main control
8341 flow and turn the statement with erroneous or undefined behavior into a trap.
8342 This flag is enabled by default at @option{-O2} and higher and depends on
8343 @option{-fdelete-null-pointer-checks} also being enabled.
8345 @item -fisolate-erroneous-paths-attribute
8346 @opindex fisolate-erroneous-paths-attribute
8347 Detect paths that trigger erroneous or undefined behavior due a null value
8348 being used in a way forbidden by a @code{returns_nonnull} or @code{nonnull}
8349 attribute.  Isolate those paths from the main control flow and turn the
8350 statement with erroneous or undefined behavior into a trap.  This is not
8351 currently enabled, but may be enabled by @option{-O2} in the future.
8353 @item -ftree-sink
8354 @opindex ftree-sink
8355 Perform forward store motion on trees.  This flag is
8356 enabled by default at @option{-O} and higher.
8358 @item -ftree-bit-ccp
8359 @opindex ftree-bit-ccp
8360 Perform sparse conditional bit constant propagation on trees and propagate
8361 pointer alignment information.
8362 This pass only operates on local scalar variables and is enabled by default
8363 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
8365 @item -ftree-ccp
8366 @opindex ftree-ccp
8367 Perform sparse conditional constant propagation (CCP) on trees.  This
8368 pass only operates on local scalar variables and is enabled by default
8369 at @option{-O} and higher.
8371 @item -fssa-backprop
8372 @opindex fssa-backprop
8373 Propagate information about uses of a value up the definition chain
8374 in order to simplify the definitions.  For example, this pass strips
8375 sign operations if the sign of a value never matters.  The flag is
8376 enabled by default at @option{-O} and higher.
8378 @item -fssa-phiopt
8379 @opindex fssa-phiopt
8380 Perform pattern matching on SSA PHI nodes to optimize conditional
8381 code.  This pass is enabled by default at @option{-O} and higher.
8383 @item -ftree-switch-conversion
8384 @opindex ftree-switch-conversion
8385 Perform conversion of simple initializations in a switch to
8386 initializations from a scalar array.  This flag is enabled by default
8387 at @option{-O2} and higher.
8389 @item -ftree-tail-merge
8390 @opindex ftree-tail-merge
8391 Look for identical code sequences.  When found, replace one with a jump to the
8392 other.  This optimization is known as tail merging or cross jumping.  This flag
8393 is enabled by default at @option{-O2} and higher.  The compilation time
8394 in this pass can
8395 be limited using @option{max-tail-merge-comparisons} parameter and
8396 @option{max-tail-merge-iterations} parameter.
8398 @item -ftree-dce
8399 @opindex ftree-dce
8400 Perform dead code elimination (DCE) on trees.  This flag is enabled by
8401 default at @option{-O} and higher.
8403 @item -ftree-builtin-call-dce
8404 @opindex ftree-builtin-call-dce
8405 Perform conditional dead code elimination (DCE) for calls to built-in functions
8406 that may set @code{errno} but are otherwise side-effect free.  This flag is
8407 enabled by default at @option{-O2} and higher if @option{-Os} is not also
8408 specified.
8410 @item -ftree-dominator-opts
8411 @opindex ftree-dominator-opts
8412 Perform a variety of simple scalar cleanups (constant/copy
8413 propagation, redundancy elimination, range propagation and expression
8414 simplification) based on a dominator tree traversal.  This also
8415 performs jump threading (to reduce jumps to jumps). This flag is
8416 enabled by default at @option{-O} and higher.
8418 @item -ftree-dse
8419 @opindex ftree-dse
8420 Perform dead store elimination (DSE) on trees.  A dead store is a store into
8421 a memory location that is later overwritten by another store without
8422 any intervening loads.  In this case the earlier store can be deleted.  This
8423 flag is enabled by default at @option{-O} and higher.
8425 @item -ftree-ch
8426 @opindex ftree-ch
8427 Perform loop header copying on trees.  This is beneficial since it increases
8428 effectiveness of code motion optimizations.  It also saves one jump.  This flag
8429 is enabled by default at @option{-O} and higher.  It is not enabled
8430 for @option{-Os}, since it usually increases code size.
8432 @item -ftree-loop-optimize
8433 @opindex ftree-loop-optimize
8434 Perform loop optimizations on trees.  This flag is enabled by default
8435 at @option{-O} and higher.
8437 @item -ftree-loop-linear
8438 @itemx -floop-interchange
8439 @itemx -floop-strip-mine
8440 @itemx -floop-block
8441 @itemx -floop-unroll-and-jam
8442 @opindex ftree-loop-linear
8443 @opindex floop-interchange
8444 @opindex floop-strip-mine
8445 @opindex floop-block
8446 @opindex floop-unroll-and-jam
8447 Perform loop nest optimizations.  Same as
8448 @option{-floop-nest-optimize}.  To use this code transformation, GCC has
8449 to be configured with @option{--with-isl} to enable the Graphite loop
8450 transformation infrastructure.
8452 @item -fgraphite-identity
8453 @opindex fgraphite-identity
8454 Enable the identity transformation for graphite.  For every SCoP we generate
8455 the polyhedral representation and transform it back to gimple.  Using
8456 @option{-fgraphite-identity} we can check the costs or benefits of the
8457 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
8458 are also performed by the code generator isl, like index splitting and
8459 dead code elimination in loops.
8461 @item -floop-nest-optimize
8462 @opindex floop-nest-optimize
8463 Enable the isl based loop nest optimizer.  This is a generic loop nest
8464 optimizer based on the Pluto optimization algorithms.  It calculates a loop
8465 structure optimized for data-locality and parallelism.  This option
8466 is experimental.
8468 @item -floop-parallelize-all
8469 @opindex floop-parallelize-all
8470 Use the Graphite data dependence analysis to identify loops that can
8471 be parallelized.  Parallelize all the loops that can be analyzed to
8472 not contain loop carried dependences without checking that it is
8473 profitable to parallelize the loops.
8475 @item -ftree-coalesce-vars
8476 @opindex ftree-coalesce-vars
8477 While transforming the program out of the SSA representation, attempt to
8478 reduce copying by coalescing versions of different user-defined
8479 variables, instead of just compiler temporaries.  This may severely
8480 limit the ability to debug an optimized program compiled with
8481 @option{-fno-var-tracking-assignments}.  In the negated form, this flag
8482 prevents SSA coalescing of user variables.  This option is enabled by
8483 default if optimization is enabled, and it does very little otherwise.
8485 @item -ftree-loop-if-convert
8486 @opindex ftree-loop-if-convert
8487 Attempt to transform conditional jumps in the innermost loops to
8488 branch-less equivalents.  The intent is to remove control-flow from
8489 the innermost loops in order to improve the ability of the
8490 vectorization pass to handle these loops.  This is enabled by default
8491 if vectorization is enabled.
8493 @item -ftree-loop-distribution
8494 @opindex ftree-loop-distribution
8495 Perform loop distribution.  This flag can improve cache performance on
8496 big loop bodies and allow further loop optimizations, like
8497 parallelization or vectorization, to take place.  For example, the loop
8498 @smallexample
8499 DO I = 1, N
8500   A(I) = B(I) + C
8501   D(I) = E(I) * F
8502 ENDDO
8503 @end smallexample
8504 is transformed to
8505 @smallexample
8506 DO I = 1, N
8507    A(I) = B(I) + C
8508 ENDDO
8509 DO I = 1, N
8510    D(I) = E(I) * F
8511 ENDDO
8512 @end smallexample
8514 @item -ftree-loop-distribute-patterns
8515 @opindex ftree-loop-distribute-patterns
8516 Perform loop distribution of patterns that can be code generated with
8517 calls to a library.  This flag is enabled by default at @option{-O3}.
8519 This pass distributes the initialization loops and generates a call to
8520 memset zero.  For example, the loop
8521 @smallexample
8522 DO I = 1, N
8523   A(I) = 0
8524   B(I) = A(I) + I
8525 ENDDO
8526 @end smallexample
8527 is transformed to
8528 @smallexample
8529 DO I = 1, N
8530    A(I) = 0
8531 ENDDO
8532 DO I = 1, N
8533    B(I) = A(I) + I
8534 ENDDO
8535 @end smallexample
8536 and the initialization loop is transformed into a call to memset zero.
8538 @item -ftree-loop-im
8539 @opindex ftree-loop-im
8540 Perform loop invariant motion on trees.  This pass moves only invariants that
8541 are hard to handle at RTL level (function calls, operations that expand to
8542 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
8543 operands of conditions that are invariant out of the loop, so that we can use
8544 just trivial invariantness analysis in loop unswitching.  The pass also includes
8545 store motion.
8547 @item -ftree-loop-ivcanon
8548 @opindex ftree-loop-ivcanon
8549 Create a canonical counter for number of iterations in loops for which
8550 determining number of iterations requires complicated analysis.  Later
8551 optimizations then may determine the number easily.  Useful especially
8552 in connection with unrolling.
8554 @item -fivopts
8555 @opindex fivopts
8556 Perform induction variable optimizations (strength reduction, induction
8557 variable merging and induction variable elimination) on trees.
8559 @item -ftree-parallelize-loops=n
8560 @opindex ftree-parallelize-loops
8561 Parallelize loops, i.e., split their iteration space to run in n threads.
8562 This is only possible for loops whose iterations are independent
8563 and can be arbitrarily reordered.  The optimization is only
8564 profitable on multiprocessor machines, for loops that are CPU-intensive,
8565 rather than constrained e.g.@: by memory bandwidth.  This option
8566 implies @option{-pthread}, and thus is only supported on targets
8567 that have support for @option{-pthread}.
8569 @item -ftree-pta
8570 @opindex ftree-pta
8571 Perform function-local points-to analysis on trees.  This flag is
8572 enabled by default at @option{-O} and higher.
8574 @item -ftree-sra
8575 @opindex ftree-sra
8576 Perform scalar replacement of aggregates.  This pass replaces structure
8577 references with scalars to prevent committing structures to memory too
8578 early.  This flag is enabled by default at @option{-O} and higher.
8580 @item -fstore-merging
8581 @opindex fstore-merging
8582 Perform merging of narrow stores to consecutive memory addresses.  This pass
8583 merges contiguous stores of immediate values narrower than a word into fewer
8584 wider stores to reduce the number of instructions.  This is enabled by default
8585 at @option{-O2} and higher as well as @option{-Os}.
8587 @item -ftree-ter
8588 @opindex ftree-ter
8589 Perform temporary expression replacement during the SSA->normal phase.  Single
8590 use/single def temporaries are replaced at their use location with their
8591 defining expression.  This results in non-GIMPLE code, but gives the expanders
8592 much more complex trees to work on resulting in better RTL generation.  This is
8593 enabled by default at @option{-O} and higher.
8595 @item -ftree-slsr
8596 @opindex ftree-slsr
8597 Perform straight-line strength reduction on trees.  This recognizes related
8598 expressions involving multiplications and replaces them by less expensive
8599 calculations when possible.  This is enabled by default at @option{-O} and
8600 higher.
8602 @item -ftree-vectorize
8603 @opindex ftree-vectorize
8604 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
8605 and @option{-ftree-slp-vectorize} if not explicitly specified.
8607 @item -ftree-loop-vectorize
8608 @opindex ftree-loop-vectorize
8609 Perform loop vectorization on trees. This flag is enabled by default at
8610 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8612 @item -ftree-slp-vectorize
8613 @opindex ftree-slp-vectorize
8614 Perform basic block vectorization on trees. This flag is enabled by default at
8615 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8617 @item -fvect-cost-model=@var{model}
8618 @opindex fvect-cost-model
8619 Alter the cost model used for vectorization.  The @var{model} argument
8620 should be one of @samp{unlimited}, @samp{dynamic} or @samp{cheap}.
8621 With the @samp{unlimited} model the vectorized code-path is assumed
8622 to be profitable while with the @samp{dynamic} model a runtime check
8623 guards the vectorized code-path to enable it only for iteration
8624 counts that will likely execute faster than when executing the original
8625 scalar loop.  The @samp{cheap} model disables vectorization of
8626 loops where doing so would be cost prohibitive for example due to
8627 required runtime checks for data dependence or alignment but otherwise
8628 is equal to the @samp{dynamic} model.
8629 The default cost model depends on other optimization flags and is
8630 either @samp{dynamic} or @samp{cheap}.
8632 @item -fsimd-cost-model=@var{model}
8633 @opindex fsimd-cost-model
8634 Alter the cost model used for vectorization of loops marked with the OpenMP
8635 or Cilk Plus simd directive.  The @var{model} argument should be one of
8636 @samp{unlimited}, @samp{dynamic}, @samp{cheap}.  All values of @var{model}
8637 have the same meaning as described in @option{-fvect-cost-model} and by
8638 default a cost model defined with @option{-fvect-cost-model} is used.
8640 @item -ftree-vrp
8641 @opindex ftree-vrp
8642 Perform Value Range Propagation on trees.  This is similar to the
8643 constant propagation pass, but instead of values, ranges of values are
8644 propagated.  This allows the optimizers to remove unnecessary range
8645 checks like array bound checks and null pointer checks.  This is
8646 enabled by default at @option{-O2} and higher.  Null pointer check
8647 elimination is only done if @option{-fdelete-null-pointer-checks} is
8648 enabled.
8650 @item -fsplit-paths
8651 @opindex fsplit-paths
8652 Split paths leading to loop backedges.  This can improve dead code
8653 elimination and common subexpression elimination.  This is enabled by
8654 default at @option{-O2} and above.
8656 @item -fsplit-ivs-in-unroller
8657 @opindex fsplit-ivs-in-unroller
8658 Enables expression of values of induction variables in later iterations
8659 of the unrolled loop using the value in the first iteration.  This breaks
8660 long dependency chains, thus improving efficiency of the scheduling passes.
8662 A combination of @option{-fweb} and CSE is often sufficient to obtain the
8663 same effect.  However, that is not reliable in cases where the loop body
8664 is more complicated than a single basic block.  It also does not work at all
8665 on some architectures due to restrictions in the CSE pass.
8667 This optimization is enabled by default.
8669 @item -fvariable-expansion-in-unroller
8670 @opindex fvariable-expansion-in-unroller
8671 With this option, the compiler creates multiple copies of some
8672 local variables when unrolling a loop, which can result in superior code.
8674 @item -fpartial-inlining
8675 @opindex fpartial-inlining
8676 Inline parts of functions.  This option has any effect only
8677 when inlining itself is turned on by the @option{-finline-functions}
8678 or @option{-finline-small-functions} options.
8680 Enabled at level @option{-O2}.
8682 @item -fpredictive-commoning
8683 @opindex fpredictive-commoning
8684 Perform predictive commoning optimization, i.e., reusing computations
8685 (especially memory loads and stores) performed in previous
8686 iterations of loops.
8688 This option is enabled at level @option{-O3}.
8690 @item -fprefetch-loop-arrays
8691 @opindex fprefetch-loop-arrays
8692 If supported by the target machine, generate instructions to prefetch
8693 memory to improve the performance of loops that access large arrays.
8695 This option may generate better or worse code; results are highly
8696 dependent on the structure of loops within the source code.
8698 Disabled at level @option{-Os}.
8700 @item -fno-printf-return-value
8701 @opindex fno-printf-return-value
8702 Do not substitute constants for known return value of formatted output
8703 functions such as @code{sprintf}, @code{snprintf}, @code{vsprintf}, and
8704 @code{vsnprintf} (but not @code{printf} of @code{fprintf}).  This
8705 transformation allows GCC to optimize or even eliminate branches based
8706 on the known return value of these functions called with arguments that
8707 are either constant, or whose values are known to be in a range that
8708 makes determining the exact return value possible.  For example, when
8709 @option{-fprintf-return-value} is in effect, both the branch and the
8710 body of the @code{if} statement (but not the call to @code{snprint})
8711 can be optimized away when @code{i} is a 32-bit or smaller integer
8712 because the return value is guaranteed to be at most 8.
8714 @smallexample
8715 char buf[9];
8716 if (snprintf (buf, "%08x", i) >= sizeof buf)
8717   @dots{}
8718 @end smallexample
8720 The @option{-fprintf-return-value} option relies on other optimizations
8721 and yields best results with @option{-O2}.  It works in tandem with the
8722 @option{-Wformat-overflow} and @option{-Wformat-truncation} options.
8723 The @option{-fprintf-return-value} option is enabled by default.
8725 @item -fno-peephole
8726 @itemx -fno-peephole2
8727 @opindex fno-peephole
8728 @opindex fno-peephole2
8729 Disable any machine-specific peephole optimizations.  The difference
8730 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
8731 are implemented in the compiler; some targets use one, some use the
8732 other, a few use both.
8734 @option{-fpeephole} is enabled by default.
8735 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8737 @item -fno-guess-branch-probability
8738 @opindex fno-guess-branch-probability
8739 Do not guess branch probabilities using heuristics.
8741 GCC uses heuristics to guess branch probabilities if they are
8742 not provided by profiling feedback (@option{-fprofile-arcs}).  These
8743 heuristics are based on the control flow graph.  If some branch probabilities
8744 are specified by @code{__builtin_expect}, then the heuristics are
8745 used to guess branch probabilities for the rest of the control flow graph,
8746 taking the @code{__builtin_expect} info into account.  The interactions
8747 between the heuristics and @code{__builtin_expect} can be complex, and in
8748 some cases, it may be useful to disable the heuristics so that the effects
8749 of @code{__builtin_expect} are easier to understand.
8751 The default is @option{-fguess-branch-probability} at levels
8752 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8754 @item -freorder-blocks
8755 @opindex freorder-blocks
8756 Reorder basic blocks in the compiled function in order to reduce number of
8757 taken branches and improve code locality.
8759 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8761 @item -freorder-blocks-algorithm=@var{algorithm}
8762 @opindex freorder-blocks-algorithm
8763 Use the specified algorithm for basic block reordering.  The
8764 @var{algorithm} argument can be @samp{simple}, which does not increase
8765 code size (except sometimes due to secondary effects like alignment),
8766 or @samp{stc}, the ``software trace cache'' algorithm, which tries to
8767 put all often executed code together, minimizing the number of branches
8768 executed by making extra copies of code.
8770 The default is @samp{simple} at levels @option{-O}, @option{-Os}, and
8771 @samp{stc} at levels @option{-O2}, @option{-O3}.
8773 @item -freorder-blocks-and-partition
8774 @opindex freorder-blocks-and-partition
8775 In addition to reordering basic blocks in the compiled function, in order
8776 to reduce number of taken branches, partitions hot and cold basic blocks
8777 into separate sections of the assembly and @file{.o} files, to improve
8778 paging and cache locality performance.
8780 This optimization is automatically turned off in the presence of
8781 exception handling or unwind tables (on targets using setjump/longjump or target specific scheme), for linkonce sections, for functions with a user-defined
8782 section attribute and on any architecture that does not support named
8783 sections.  When @option{-fsplit-stack} is used this option is not
8784 enabled by default (to avoid linker errors), but may be enabled
8785 explicitly (if using a working linker).
8787 Enabled for x86 at levels @option{-O2}, @option{-O3}.
8789 @item -freorder-functions
8790 @opindex freorder-functions
8791 Reorder functions in the object file in order to
8792 improve code locality.  This is implemented by using special
8793 subsections @code{.text.hot} for most frequently executed functions and
8794 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
8795 the linker so object file format must support named sections and linker must
8796 place them in a reasonable way.
8798 Also profile feedback must be available to make this option effective.  See
8799 @option{-fprofile-arcs} for details.
8801 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8803 @item -fstrict-aliasing
8804 @opindex fstrict-aliasing
8805 Allow the compiler to assume the strictest aliasing rules applicable to
8806 the language being compiled.  For C (and C++), this activates
8807 optimizations based on the type of expressions.  In particular, an
8808 object of one type is assumed never to reside at the same address as an
8809 object of a different type, unless the types are almost the same.  For
8810 example, an @code{unsigned int} can alias an @code{int}, but not a
8811 @code{void*} or a @code{double}.  A character type may alias any other
8812 type.
8814 @anchor{Type-punning}Pay special attention to code like this:
8815 @smallexample
8816 union a_union @{
8817   int i;
8818   double d;
8821 int f() @{
8822   union a_union t;
8823   t.d = 3.0;
8824   return t.i;
8826 @end smallexample
8827 The practice of reading from a different union member than the one most
8828 recently written to (called ``type-punning'') is common.  Even with
8829 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
8830 is accessed through the union type.  So, the code above works as
8831 expected.  @xref{Structures unions enumerations and bit-fields
8832 implementation}.  However, this code might not:
8833 @smallexample
8834 int f() @{
8835   union a_union t;
8836   int* ip;
8837   t.d = 3.0;
8838   ip = &t.i;
8839   return *ip;
8841 @end smallexample
8843 Similarly, access by taking the address, casting the resulting pointer
8844 and dereferencing the result has undefined behavior, even if the cast
8845 uses a union type, e.g.:
8846 @smallexample
8847 int f() @{
8848   double d = 3.0;
8849   return ((union a_union *) &d)->i;
8851 @end smallexample
8853 The @option{-fstrict-aliasing} option is enabled at levels
8854 @option{-O2}, @option{-O3}, @option{-Os}.
8856 @item -falign-functions
8857 @itemx -falign-functions=@var{n}
8858 @opindex falign-functions
8859 Align the start of functions to the next power-of-two greater than
8860 @var{n}, skipping up to @var{n} bytes.  For instance,
8861 @option{-falign-functions=32} aligns functions to the next 32-byte
8862 boundary, but @option{-falign-functions=24} aligns to the next
8863 32-byte boundary only if this can be done by skipping 23 bytes or less.
8865 @option{-fno-align-functions} and @option{-falign-functions=1} are
8866 equivalent and mean that functions are not aligned.
8868 Some assemblers only support this flag when @var{n} is a power of two;
8869 in that case, it is rounded up.
8871 If @var{n} is not specified or is zero, use a machine-dependent default.
8873 Enabled at levels @option{-O2}, @option{-O3}.
8875 @item -flimit-function-alignment
8876 If this option is enabled, the compiler tries to avoid unnecessarily
8877 overaligning functions. It attempts to instruct the assembler to align
8878 by the amount specified by @option{-falign-functions}, but not to
8879 skip more bytes than the size of the function.
8881 @item -falign-labels
8882 @itemx -falign-labels=@var{n}
8883 @opindex falign-labels
8884 Align all branch targets to a power-of-two boundary, skipping up to
8885 @var{n} bytes like @option{-falign-functions}.  This option can easily
8886 make code slower, because it must insert dummy operations for when the
8887 branch target is reached in the usual flow of the code.
8889 @option{-fno-align-labels} and @option{-falign-labels=1} are
8890 equivalent and mean that labels are not aligned.
8892 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
8893 are greater than this value, then their values are used instead.
8895 If @var{n} is not specified or is zero, use a machine-dependent default
8896 which is very likely to be @samp{1}, meaning no alignment.
8898 Enabled at levels @option{-O2}, @option{-O3}.
8900 @item -falign-loops
8901 @itemx -falign-loops=@var{n}
8902 @opindex falign-loops
8903 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
8904 like @option{-falign-functions}.  If the loops are
8905 executed many times, this makes up for any execution of the dummy
8906 operations.
8908 @option{-fno-align-loops} and @option{-falign-loops=1} are
8909 equivalent and mean that loops are not aligned.
8911 If @var{n} is not specified or is zero, use a machine-dependent default.
8913 Enabled at levels @option{-O2}, @option{-O3}.
8915 @item -falign-jumps
8916 @itemx -falign-jumps=@var{n}
8917 @opindex falign-jumps
8918 Align branch targets to a power-of-two boundary, for branch targets
8919 where the targets can only be reached by jumping, skipping up to @var{n}
8920 bytes like @option{-falign-functions}.  In this case, no dummy operations
8921 need be executed.
8923 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
8924 equivalent and mean that loops are not aligned.
8926 If @var{n} is not specified or is zero, use a machine-dependent default.
8928 Enabled at levels @option{-O2}, @option{-O3}.
8930 @item -funit-at-a-time
8931 @opindex funit-at-a-time
8932 This option is left for compatibility reasons. @option{-funit-at-a-time}
8933 has no effect, while @option{-fno-unit-at-a-time} implies
8934 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
8936 Enabled by default.
8938 @item -fno-toplevel-reorder
8939 @opindex fno-toplevel-reorder
8940 Do not reorder top-level functions, variables, and @code{asm}
8941 statements.  Output them in the same order that they appear in the
8942 input file.  When this option is used, unreferenced static variables
8943 are not removed.  This option is intended to support existing code
8944 that relies on a particular ordering.  For new code, it is better to
8945 use attributes when possible.
8947 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
8948 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
8949 targets.
8951 @item -fweb
8952 @opindex fweb
8953 Constructs webs as commonly used for register allocation purposes and assign
8954 each web individual pseudo register.  This allows the register allocation pass
8955 to operate on pseudos directly, but also strengthens several other optimization
8956 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
8957 however, make debugging impossible, since variables no longer stay in a
8958 ``home register''.
8960 Enabled by default with @option{-funroll-loops}.
8962 @item -fwhole-program
8963 @opindex fwhole-program
8964 Assume that the current compilation unit represents the whole program being
8965 compiled.  All public functions and variables with the exception of @code{main}
8966 and those merged by attribute @code{externally_visible} become static functions
8967 and in effect are optimized more aggressively by interprocedural optimizers.
8969 This option should not be used in combination with @option{-flto}.
8970 Instead relying on a linker plugin should provide safer and more precise
8971 information.
8973 @item -flto[=@var{n}]
8974 @opindex flto
8975 This option runs the standard link-time optimizer.  When invoked
8976 with source code, it generates GIMPLE (one of GCC's internal
8977 representations) and writes it to special ELF sections in the object
8978 file.  When the object files are linked together, all the function
8979 bodies are read from these ELF sections and instantiated as if they
8980 had been part of the same translation unit.
8982 To use the link-time optimizer, @option{-flto} and optimization
8983 options should be specified at compile time and during the final link.
8984 It is recommended that you compile all the files participating in the
8985 same link with the same options and also specify those options at
8986 link time.  
8987 For example:
8989 @smallexample
8990 gcc -c -O2 -flto foo.c
8991 gcc -c -O2 -flto bar.c
8992 gcc -o myprog -flto -O2 foo.o bar.o
8993 @end smallexample
8995 The first two invocations to GCC save a bytecode representation
8996 of GIMPLE into special ELF sections inside @file{foo.o} and
8997 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
8998 @file{foo.o} and @file{bar.o}, merges the two files into a single
8999 internal image, and compiles the result as usual.  Since both
9000 @file{foo.o} and @file{bar.o} are merged into a single image, this
9001 causes all the interprocedural analyses and optimizations in GCC to
9002 work across the two files as if they were a single one.  This means,
9003 for example, that the inliner is able to inline functions in
9004 @file{bar.o} into functions in @file{foo.o} and vice-versa.
9006 Another (simpler) way to enable link-time optimization is:
9008 @smallexample
9009 gcc -o myprog -flto -O2 foo.c bar.c
9010 @end smallexample
9012 The above generates bytecode for @file{foo.c} and @file{bar.c},
9013 merges them together into a single GIMPLE representation and optimizes
9014 them as usual to produce @file{myprog}.
9016 The only important thing to keep in mind is that to enable link-time
9017 optimizations you need to use the GCC driver to perform the link step.
9018 GCC then automatically performs link-time optimization if any of the
9019 objects involved were compiled with the @option{-flto} command-line option.  
9020 You generally
9021 should specify the optimization options to be used for link-time
9022 optimization though GCC tries to be clever at guessing an
9023 optimization level to use from the options used at compile time
9024 if you fail to specify one at link time.  You can always override
9025 the automatic decision to do link-time optimization
9026 by passing @option{-fno-lto} to the link command.
9028 To make whole program optimization effective, it is necessary to make
9029 certain whole program assumptions.  The compiler needs to know
9030 what functions and variables can be accessed by libraries and runtime
9031 outside of the link-time optimized unit.  When supported by the linker,
9032 the linker plugin (see @option{-fuse-linker-plugin}) passes information
9033 to the compiler about used and externally visible symbols.  When
9034 the linker plugin is not available, @option{-fwhole-program} should be
9035 used to allow the compiler to make these assumptions, which leads
9036 to more aggressive optimization decisions.
9038 When @option{-fuse-linker-plugin} is not enabled, when a file is
9039 compiled with @option{-flto}, the generated object file is larger than
9040 a regular object file because it contains GIMPLE bytecodes and the usual
9041 final code (see @option{-ffat-lto-objects}.  This means that
9042 object files with LTO information can be linked as normal object
9043 files; if @option{-fno-lto} is passed to the linker, no
9044 interprocedural optimizations are applied.  Note that when
9045 @option{-fno-fat-lto-objects} is enabled the compile stage is faster
9046 but you cannot perform a regular, non-LTO link on them.
9048 Additionally, the optimization flags used to compile individual files
9049 are not necessarily related to those used at link time.  For instance,
9051 @smallexample
9052 gcc -c -O0 -ffat-lto-objects -flto foo.c
9053 gcc -c -O0 -ffat-lto-objects -flto bar.c
9054 gcc -o myprog -O3 foo.o bar.o
9055 @end smallexample
9057 This produces individual object files with unoptimized assembler
9058 code, but the resulting binary @file{myprog} is optimized at
9059 @option{-O3}.  If, instead, the final binary is generated with
9060 @option{-fno-lto}, then @file{myprog} is not optimized.
9062 When producing the final binary, GCC only
9063 applies link-time optimizations to those files that contain bytecode.
9064 Therefore, you can mix and match object files and libraries with
9065 GIMPLE bytecodes and final object code.  GCC automatically selects
9066 which files to optimize in LTO mode and which files to link without
9067 further processing.
9069 There are some code generation flags preserved by GCC when
9070 generating bytecodes, as they need to be used during the final link
9071 stage.  Generally options specified at link time override those
9072 specified at compile time.
9074 If you do not specify an optimization level option @option{-O} at
9075 link time, then GCC uses the highest optimization level 
9076 used when compiling the object files.
9078 Currently, the following options and their settings are taken from
9079 the first object file that explicitly specifies them: 
9080 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
9081 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
9082 and all the @option{-m} target flags.
9084 Certain ABI-changing flags are required to match in all compilation units,
9085 and trying to override this at link time with a conflicting value
9086 is ignored.  This includes options such as @option{-freg-struct-return}
9087 and @option{-fpcc-struct-return}. 
9089 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
9090 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
9091 are passed through to the link stage and merged conservatively for
9092 conflicting translation units.  Specifically
9093 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
9094 precedence; and for example @option{-ffp-contract=off} takes precedence
9095 over @option{-ffp-contract=fast}.  You can override them at link time.
9097 If LTO encounters objects with C linkage declared with incompatible
9098 types in separate translation units to be linked together (undefined
9099 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
9100 issued.  The behavior is still undefined at run time.  Similar
9101 diagnostics may be raised for other languages.
9103 Another feature of LTO is that it is possible to apply interprocedural
9104 optimizations on files written in different languages:
9106 @smallexample
9107 gcc -c -flto foo.c
9108 g++ -c -flto bar.cc
9109 gfortran -c -flto baz.f90
9110 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
9111 @end smallexample
9113 Notice that the final link is done with @command{g++} to get the C++
9114 runtime libraries and @option{-lgfortran} is added to get the Fortran
9115 runtime libraries.  In general, when mixing languages in LTO mode, you
9116 should use the same link command options as when mixing languages in a
9117 regular (non-LTO) compilation.
9119 If object files containing GIMPLE bytecode are stored in a library archive, say
9120 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
9121 are using a linker with plugin support.  To create static libraries suitable
9122 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
9123 and @command{ranlib}; 
9124 to show the symbols of object files with GIMPLE bytecode, use
9125 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
9126 and @command{nm} have been compiled with plugin support.  At link time, use the the
9127 flag @option{-fuse-linker-plugin} to ensure that the library participates in
9128 the LTO optimization process:
9130 @smallexample
9131 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
9132 @end smallexample
9134 With the linker plugin enabled, the linker extracts the needed
9135 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
9136 to make them part of the aggregated GIMPLE image to be optimized.
9138 If you are not using a linker with plugin support and/or do not
9139 enable the linker plugin, then the objects inside @file{libfoo.a}
9140 are extracted and linked as usual, but they do not participate
9141 in the LTO optimization process.  In order to make a static library suitable
9142 for both LTO optimization and usual linkage, compile its object files with
9143 @option{-flto} @option{-ffat-lto-objects}.
9145 Link-time optimizations do not require the presence of the whole program to
9146 operate.  If the program does not require any symbols to be exported, it is
9147 possible to combine @option{-flto} and @option{-fwhole-program} to allow
9148 the interprocedural optimizers to use more aggressive assumptions which may
9149 lead to improved optimization opportunities.
9150 Use of @option{-fwhole-program} is not needed when linker plugin is
9151 active (see @option{-fuse-linker-plugin}).
9153 The current implementation of LTO makes no
9154 attempt to generate bytecode that is portable between different
9155 types of hosts.  The bytecode files are versioned and there is a
9156 strict version check, so bytecode files generated in one version of
9157 GCC do not work with an older or newer version of GCC.
9159 Link-time optimization does not work well with generation of debugging
9160 information.  Combining @option{-flto} with
9161 @option{-g} is currently experimental and expected to produce unexpected
9162 results.
9164 If you specify the optional @var{n}, the optimization and code
9165 generation done at link time is executed in parallel using @var{n}
9166 parallel jobs by utilizing an installed @command{make} program.  The
9167 environment variable @env{MAKE} may be used to override the program
9168 used.  The default value for @var{n} is 1.
9170 You can also specify @option{-flto=jobserver} to use GNU make's
9171 job server mode to determine the number of parallel jobs. This
9172 is useful when the Makefile calling GCC is already executing in parallel.
9173 You must prepend a @samp{+} to the command recipe in the parent Makefile
9174 for this to work.  This option likely only works if @env{MAKE} is
9175 GNU make.
9177 @item -flto-partition=@var{alg}
9178 @opindex flto-partition
9179 Specify the partitioning algorithm used by the link-time optimizer.
9180 The value is either @samp{1to1} to specify a partitioning mirroring
9181 the original source files or @samp{balanced} to specify partitioning
9182 into equally sized chunks (whenever possible) or @samp{max} to create
9183 new partition for every symbol where possible.  Specifying @samp{none}
9184 as an algorithm disables partitioning and streaming completely. 
9185 The default value is @samp{balanced}. While @samp{1to1} can be used
9186 as an workaround for various code ordering issues, the @samp{max}
9187 partitioning is intended for internal testing only.
9188 The value @samp{one} specifies that exactly one partition should be
9189 used while the value @samp{none} bypasses partitioning and executes
9190 the link-time optimization step directly from the WPA phase.
9192 @item -flto-odr-type-merging
9193 @opindex flto-odr-type-merging
9194 Enable streaming of mangled types names of C++ types and their unification
9195 at link time.  This increases size of LTO object files, but enables
9196 diagnostics about One Definition Rule violations.
9198 @item -flto-compression-level=@var{n}
9199 @opindex flto-compression-level
9200 This option specifies the level of compression used for intermediate
9201 language written to LTO object files, and is only meaningful in
9202 conjunction with LTO mode (@option{-flto}).  Valid
9203 values are 0 (no compression) to 9 (maximum compression).  Values
9204 outside this range are clamped to either 0 or 9.  If the option is not
9205 given, a default balanced compression setting is used.
9207 @item -fuse-linker-plugin
9208 @opindex fuse-linker-plugin
9209 Enables the use of a linker plugin during link-time optimization.  This
9210 option relies on plugin support in the linker, which is available in gold
9211 or in GNU ld 2.21 or newer.
9213 This option enables the extraction of object files with GIMPLE bytecode out
9214 of library archives. This improves the quality of optimization by exposing
9215 more code to the link-time optimizer.  This information specifies what
9216 symbols can be accessed externally (by non-LTO object or during dynamic
9217 linking).  Resulting code quality improvements on binaries (and shared
9218 libraries that use hidden visibility) are similar to @option{-fwhole-program}.
9219 See @option{-flto} for a description of the effect of this flag and how to
9220 use it.
9222 This option is enabled by default when LTO support in GCC is enabled
9223 and GCC was configured for use with
9224 a linker supporting plugins (GNU ld 2.21 or newer or gold).
9226 @item -ffat-lto-objects
9227 @opindex ffat-lto-objects
9228 Fat LTO objects are object files that contain both the intermediate language
9229 and the object code. This makes them usable for both LTO linking and normal
9230 linking. This option is effective only when compiling with @option{-flto}
9231 and is ignored at link time.
9233 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
9234 requires the complete toolchain to be aware of LTO. It requires a linker with
9235 linker plugin support for basic functionality.  Additionally,
9236 @command{nm}, @command{ar} and @command{ranlib}
9237 need to support linker plugins to allow a full-featured build environment
9238 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
9239 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
9240 to these tools. With non fat LTO makefiles need to be modified to use them.
9242 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
9243 support.
9245 @item -fcompare-elim
9246 @opindex fcompare-elim
9247 After register allocation and post-register allocation instruction splitting,
9248 identify arithmetic instructions that compute processor flags similar to a
9249 comparison operation based on that arithmetic.  If possible, eliminate the
9250 explicit comparison operation.
9252 This pass only applies to certain targets that cannot explicitly represent
9253 the comparison operation before register allocation is complete.
9255 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9257 @item -fcprop-registers
9258 @opindex fcprop-registers
9259 After register allocation and post-register allocation instruction splitting,
9260 perform a copy-propagation pass to try to reduce scheduling dependencies
9261 and occasionally eliminate the copy.
9263 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9265 @item -fprofile-correction
9266 @opindex fprofile-correction
9267 Profiles collected using an instrumented binary for multi-threaded programs may
9268 be inconsistent due to missed counter updates. When this option is specified,
9269 GCC uses heuristics to correct or smooth out such inconsistencies. By
9270 default, GCC emits an error message when an inconsistent profile is detected.
9272 @item -fprofile-use
9273 @itemx -fprofile-use=@var{path}
9274 @opindex fprofile-use
9275 Enable profile feedback-directed optimizations, 
9276 and the following optimizations
9277 which are generally profitable only with profile feedback available:
9278 @option{-fbranch-probabilities}, @option{-fvpt},
9279 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9280 @option{-ftree-vectorize}, and @option{ftree-loop-distribute-patterns}.
9282 Before you can use this option, you must first generate profiling information.
9283 @xref{Instrumentation Options}, for information about the
9284 @option{-fprofile-generate} option.
9286 By default, GCC emits an error message if the feedback profiles do not
9287 match the source code.  This error can be turned into a warning by using
9288 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
9289 code.
9291 If @var{path} is specified, GCC looks at the @var{path} to find
9292 the profile feedback data files. See @option{-fprofile-dir}.
9294 @item -fauto-profile
9295 @itemx -fauto-profile=@var{path}
9296 @opindex fauto-profile
9297 Enable sampling-based feedback-directed optimizations, 
9298 and the following optimizations
9299 which are generally profitable only with profile feedback available:
9300 @option{-fbranch-probabilities}, @option{-fvpt},
9301 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9302 @option{-ftree-vectorize},
9303 @option{-finline-functions}, @option{-fipa-cp}, @option{-fipa-cp-clone},
9304 @option{-fpredictive-commoning}, @option{-funswitch-loops},
9305 @option{-fgcse-after-reload}, and @option{-ftree-loop-distribute-patterns}.
9307 @var{path} is the name of a file containing AutoFDO profile information.
9308 If omitted, it defaults to @file{fbdata.afdo} in the current directory.
9310 Producing an AutoFDO profile data file requires running your program
9311 with the @command{perf} utility on a supported GNU/Linux target system.
9312 For more information, see @uref{https://perf.wiki.kernel.org/}.
9314 E.g.
9315 @smallexample
9316 perf record -e br_inst_retired:near_taken -b -o perf.data \
9317     -- your_program
9318 @end smallexample
9320 Then use the @command{create_gcov} tool to convert the raw profile data
9321 to a format that can be used by GCC.@  You must also supply the 
9322 unstripped binary for your program to this tool.  
9323 See @uref{https://github.com/google/autofdo}.
9325 E.g.
9326 @smallexample
9327 create_gcov --binary=your_program.unstripped --profile=perf.data \
9328     --gcov=profile.afdo
9329 @end smallexample
9330 @end table
9332 The following options control compiler behavior regarding floating-point 
9333 arithmetic.  These options trade off between speed and
9334 correctness.  All must be specifically enabled.
9336 @table @gcctabopt
9337 @item -ffloat-store
9338 @opindex ffloat-store
9339 Do not store floating-point variables in registers, and inhibit other
9340 options that might change whether a floating-point value is taken from a
9341 register or memory.
9343 @cindex floating-point precision
9344 This option prevents undesirable excess precision on machines such as
9345 the 68000 where the floating registers (of the 68881) keep more
9346 precision than a @code{double} is supposed to have.  Similarly for the
9347 x86 architecture.  For most programs, the excess precision does only
9348 good, but a few programs rely on the precise definition of IEEE floating
9349 point.  Use @option{-ffloat-store} for such programs, after modifying
9350 them to store all pertinent intermediate computations into variables.
9352 @item -fexcess-precision=@var{style}
9353 @opindex fexcess-precision
9354 This option allows further control over excess precision on machines
9355 where floating-point operations occur in a format with more precision or
9356 range than the IEEE standard and interchange floating-point types.  By
9357 default, @option{-fexcess-precision=fast} is in effect; this means that
9358 operations may be carried out in a wider precision than the types specified
9359 in the source if that would result in faster code, and it is unpredictable
9360 when rounding to the types specified in the source code takes place.
9361 When compiling C, if @option{-fexcess-precision=standard} is specified then
9362 excess precision follows the rules specified in ISO C99; in particular,
9363 both casts and assignments cause values to be rounded to their
9364 semantic types (whereas @option{-ffloat-store} only affects
9365 assignments).  This option is enabled by default for C if a strict
9366 conformance option such as @option{-std=c99} is used.
9367 @option{-ffast-math} enables @option{-fexcess-precision=fast} by default
9368 regardless of whether a strict conformance option is used.
9370 @opindex mfpmath
9371 @option{-fexcess-precision=standard} is not implemented for languages
9372 other than C.  On the x86, it has no effect if @option{-mfpmath=sse}
9373 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
9374 semantics apply without excess precision, and in the latter, rounding
9375 is unpredictable.
9377 @item -ffast-math
9378 @opindex ffast-math
9379 Sets the options @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
9380 @option{-ffinite-math-only}, @option{-fno-rounding-math},
9381 @option{-fno-signaling-nans}, @option{-fcx-limited-range} and
9382 @option{-fexcess-precision=fast}.
9384 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
9386 This option is not turned on by any @option{-O} option besides
9387 @option{-Ofast} since it can result in incorrect output for programs
9388 that depend on an exact implementation of IEEE or ISO rules/specifications
9389 for math functions. It may, however, yield faster code for programs
9390 that do not require the guarantees of these specifications.
9392 @item -fno-math-errno
9393 @opindex fno-math-errno
9394 Do not set @code{errno} after calling math functions that are executed
9395 with a single instruction, e.g., @code{sqrt}.  A program that relies on
9396 IEEE exceptions for math error handling may want to use this flag
9397 for speed while maintaining IEEE arithmetic compatibility.
9399 This option is not turned on by any @option{-O} option since
9400 it can result in incorrect output for programs that depend on
9401 an exact implementation of IEEE or ISO rules/specifications for
9402 math functions. It may, however, yield faster code for programs
9403 that do not require the guarantees of these specifications.
9405 The default is @option{-fmath-errno}.
9407 On Darwin systems, the math library never sets @code{errno}.  There is
9408 therefore no reason for the compiler to consider the possibility that
9409 it might, and @option{-fno-math-errno} is the default.
9411 @item -funsafe-math-optimizations
9412 @opindex funsafe-math-optimizations
9414 Allow optimizations for floating-point arithmetic that (a) assume
9415 that arguments and results are valid and (b) may violate IEEE or
9416 ANSI standards.  When used at link time, it may include libraries
9417 or startup files that change the default FPU control word or other
9418 similar optimizations.
9420 This option is not turned on by any @option{-O} option since
9421 it can result in incorrect output for programs that depend on
9422 an exact implementation of IEEE or ISO rules/specifications for
9423 math functions. It may, however, yield faster code for programs
9424 that do not require the guarantees of these specifications.
9425 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
9426 @option{-fassociative-math} and @option{-freciprocal-math}.
9428 The default is @option{-fno-unsafe-math-optimizations}.
9430 @item -fassociative-math
9431 @opindex fassociative-math
9433 Allow re-association of operands in series of floating-point operations.
9434 This violates the ISO C and C++ language standard by possibly changing
9435 computation result.  NOTE: re-ordering may change the sign of zero as
9436 well as ignore NaNs and inhibit or create underflow or overflow (and
9437 thus cannot be used on code that relies on rounding behavior like
9438 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
9439 and thus may not be used when ordered comparisons are required.
9440 This option requires that both @option{-fno-signed-zeros} and
9441 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
9442 much sense with @option{-frounding-math}. For Fortran the option
9443 is automatically enabled when both @option{-fno-signed-zeros} and
9444 @option{-fno-trapping-math} are in effect.
9446 The default is @option{-fno-associative-math}.
9448 @item -freciprocal-math
9449 @opindex freciprocal-math
9451 Allow the reciprocal of a value to be used instead of dividing by
9452 the value if this enables optimizations.  For example @code{x / y}
9453 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
9454 is subject to common subexpression elimination.  Note that this loses
9455 precision and increases the number of flops operating on the value.
9457 The default is @option{-fno-reciprocal-math}.
9459 @item -ffinite-math-only
9460 @opindex ffinite-math-only
9461 Allow optimizations for floating-point arithmetic that assume
9462 that arguments and results are not NaNs or +-Infs.
9464 This option is not turned on by any @option{-O} option since
9465 it can result in incorrect output for programs that depend on
9466 an exact implementation of IEEE or ISO rules/specifications for
9467 math functions. It may, however, yield faster code for programs
9468 that do not require the guarantees of these specifications.
9470 The default is @option{-fno-finite-math-only}.
9472 @item -fno-signed-zeros
9473 @opindex fno-signed-zeros
9474 Allow optimizations for floating-point arithmetic that ignore the
9475 signedness of zero.  IEEE arithmetic specifies the behavior of
9476 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
9477 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
9478 This option implies that the sign of a zero result isn't significant.
9480 The default is @option{-fsigned-zeros}.
9482 @item -fno-trapping-math
9483 @opindex fno-trapping-math
9484 Compile code assuming that floating-point operations cannot generate
9485 user-visible traps.  These traps include division by zero, overflow,
9486 underflow, inexact result and invalid operation.  This option requires
9487 that @option{-fno-signaling-nans} be in effect.  Setting this option may
9488 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
9490 This option should never be turned on by any @option{-O} option since
9491 it can result in incorrect output for programs that depend on
9492 an exact implementation of IEEE or ISO rules/specifications for
9493 math functions.
9495 The default is @option{-ftrapping-math}.
9497 @item -frounding-math
9498 @opindex frounding-math
9499 Disable transformations and optimizations that assume default floating-point
9500 rounding behavior.  This is round-to-zero for all floating point
9501 to integer conversions, and round-to-nearest for all other arithmetic
9502 truncations.  This option should be specified for programs that change
9503 the FP rounding mode dynamically, or that may be executed with a
9504 non-default rounding mode.  This option disables constant folding of
9505 floating-point expressions at compile time (which may be affected by
9506 rounding mode) and arithmetic transformations that are unsafe in the
9507 presence of sign-dependent rounding modes.
9509 The default is @option{-fno-rounding-math}.
9511 This option is experimental and does not currently guarantee to
9512 disable all GCC optimizations that are affected by rounding mode.
9513 Future versions of GCC may provide finer control of this setting
9514 using C99's @code{FENV_ACCESS} pragma.  This command-line option
9515 will be used to specify the default state for @code{FENV_ACCESS}.
9517 @item -fsignaling-nans
9518 @opindex fsignaling-nans
9519 Compile code assuming that IEEE signaling NaNs may generate user-visible
9520 traps during floating-point operations.  Setting this option disables
9521 optimizations that may change the number of exceptions visible with
9522 signaling NaNs.  This option implies @option{-ftrapping-math}.
9524 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
9525 be defined.
9527 The default is @option{-fno-signaling-nans}.
9529 This option is experimental and does not currently guarantee to
9530 disable all GCC optimizations that affect signaling NaN behavior.
9532 @item -fno-fp-int-builtin-inexact
9533 @opindex fno-fp-int-builtin-inexact
9534 Do not allow the built-in functions @code{ceil}, @code{floor},
9535 @code{round} and @code{trunc}, and their @code{float} and @code{long
9536 double} variants, to generate code that raises the ``inexact''
9537 floating-point exception for noninteger arguments.  ISO C99 and C11
9538 allow these functions to raise the ``inexact'' exception, but ISO/IEC
9539 TS 18661-1:2014, the C bindings to IEEE 754-2008, does not allow these
9540 functions to do so.
9542 The default is @option{-ffp-int-builtin-inexact}, allowing the
9543 exception to be raised.  This option does nothing unless
9544 @option{-ftrapping-math} is in effect.
9546 Even if @option{-fno-fp-int-builtin-inexact} is used, if the functions
9547 generate a call to a library function then the ``inexact'' exception
9548 may be raised if the library implementation does not follow TS 18661.
9550 @item -fsingle-precision-constant
9551 @opindex fsingle-precision-constant
9552 Treat floating-point constants as single precision instead of
9553 implicitly converting them to double-precision constants.
9555 @item -fcx-limited-range
9556 @opindex fcx-limited-range
9557 When enabled, this option states that a range reduction step is not
9558 needed when performing complex division.  Also, there is no checking
9559 whether the result of a complex multiplication or division is @code{NaN
9560 + I*NaN}, with an attempt to rescue the situation in that case.  The
9561 default is @option{-fno-cx-limited-range}, but is enabled by
9562 @option{-ffast-math}.
9564 This option controls the default setting of the ISO C99
9565 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
9566 all languages.
9568 @item -fcx-fortran-rules
9569 @opindex fcx-fortran-rules
9570 Complex multiplication and division follow Fortran rules.  Range
9571 reduction is done as part of complex division, but there is no checking
9572 whether the result of a complex multiplication or division is @code{NaN
9573 + I*NaN}, with an attempt to rescue the situation in that case.
9575 The default is @option{-fno-cx-fortran-rules}.
9577 @end table
9579 The following options control optimizations that may improve
9580 performance, but are not enabled by any @option{-O} options.  This
9581 section includes experimental options that may produce broken code.
9583 @table @gcctabopt
9584 @item -fbranch-probabilities
9585 @opindex fbranch-probabilities
9586 After running a program compiled with @option{-fprofile-arcs}
9587 (@pxref{Instrumentation Options}),
9588 you can compile it a second time using
9589 @option{-fbranch-probabilities}, to improve optimizations based on
9590 the number of times each branch was taken.  When a program
9591 compiled with @option{-fprofile-arcs} exits, it saves arc execution
9592 counts to a file called @file{@var{sourcename}.gcda} for each source
9593 file.  The information in this data file is very dependent on the
9594 structure of the generated code, so you must use the same source code
9595 and the same optimization options for both compilations.
9597 With @option{-fbranch-probabilities}, GCC puts a
9598 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
9599 These can be used to improve optimization.  Currently, they are only
9600 used in one place: in @file{reorg.c}, instead of guessing which path a
9601 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
9602 exactly determine which path is taken more often.
9604 @item -fprofile-values
9605 @opindex fprofile-values
9606 If combined with @option{-fprofile-arcs}, it adds code so that some
9607 data about values of expressions in the program is gathered.
9609 With @option{-fbranch-probabilities}, it reads back the data gathered
9610 from profiling values of expressions for usage in optimizations.
9612 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
9614 @item -fprofile-reorder-functions
9615 @opindex fprofile-reorder-functions
9616 Function reordering based on profile instrumentation collects
9617 first time of execution of a function and orders these functions
9618 in ascending order.
9620 Enabled with @option{-fprofile-use}.
9622 @item -fvpt
9623 @opindex fvpt
9624 If combined with @option{-fprofile-arcs}, this option instructs the compiler
9625 to add code to gather information about values of expressions.
9627 With @option{-fbranch-probabilities}, it reads back the data gathered
9628 and actually performs the optimizations based on them.
9629 Currently the optimizations include specialization of division operations
9630 using the knowledge about the value of the denominator.
9632 @item -frename-registers
9633 @opindex frename-registers
9634 Attempt to avoid false dependencies in scheduled code by making use
9635 of registers left over after register allocation.  This optimization
9636 most benefits processors with lots of registers.  Depending on the
9637 debug information format adopted by the target, however, it can
9638 make debugging impossible, since variables no longer stay in
9639 a ``home register''.
9641 Enabled by default with @option{-funroll-loops}.
9643 @item -fschedule-fusion
9644 @opindex fschedule-fusion
9645 Performs a target dependent pass over the instruction stream to schedule
9646 instructions of same type together because target machine can execute them
9647 more efficiently if they are adjacent to each other in the instruction flow.
9649 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9651 @item -ftracer
9652 @opindex ftracer
9653 Perform tail duplication to enlarge superblock size.  This transformation
9654 simplifies the control flow of the function allowing other optimizations to do
9655 a better job.
9657 Enabled with @option{-fprofile-use}.
9659 @item -funroll-loops
9660 @opindex funroll-loops
9661 Unroll loops whose number of iterations can be determined at compile time or
9662 upon entry to the loop.  @option{-funroll-loops} implies
9663 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
9664 It also turns on complete loop peeling (i.e.@: complete removal of loops with
9665 a small constant number of iterations).  This option makes code larger, and may
9666 or may not make it run faster.
9668 Enabled with @option{-fprofile-use}.
9670 @item -funroll-all-loops
9671 @opindex funroll-all-loops
9672 Unroll all loops, even if their number of iterations is uncertain when
9673 the loop is entered.  This usually makes programs run more slowly.
9674 @option{-funroll-all-loops} implies the same options as
9675 @option{-funroll-loops}.
9677 @item -fpeel-loops
9678 @opindex fpeel-loops
9679 Peels loops for which there is enough information that they do not
9680 roll much (from profile feedback or static analysis).  It also turns on
9681 complete loop peeling (i.e.@: complete removal of loops with small constant
9682 number of iterations).
9684 Enabled with @option{-O3} and/or @option{-fprofile-use}.
9686 @item -fmove-loop-invariants
9687 @opindex fmove-loop-invariants
9688 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
9689 at level @option{-O1}
9691 @item -fsplit-loops
9692 @opindex fsplit-loops
9693 Split a loop into two if it contains a condition that's always true
9694 for one side of the iteration space and false for the other.
9696 @item -funswitch-loops
9697 @opindex funswitch-loops
9698 Move branches with loop invariant conditions out of the loop, with duplicates
9699 of the loop on both branches (modified according to result of the condition).
9701 @item -ffunction-sections
9702 @itemx -fdata-sections
9703 @opindex ffunction-sections
9704 @opindex fdata-sections
9705 Place each function or data item into its own section in the output
9706 file if the target supports arbitrary sections.  The name of the
9707 function or the name of the data item determines the section's name
9708 in the output file.
9710 Use these options on systems where the linker can perform optimizations
9711 to improve locality of reference in the instruction space.  Most systems
9712 using the ELF object format and SPARC processors running Solaris 2 have
9713 linkers with such optimizations.  AIX may have these optimizations in
9714 the future.
9716 Only use these options when there are significant benefits from doing
9717 so.  When you specify these options, the assembler and linker
9718 create larger object and executable files and are also slower.
9719 You cannot use @command{gprof} on all systems if you
9720 specify this option, and you may have problems with debugging if
9721 you specify both this option and @option{-g}.
9723 @item -fbranch-target-load-optimize
9724 @opindex fbranch-target-load-optimize
9725 Perform branch target register load optimization before prologue / epilogue
9726 threading.
9727 The use of target registers can typically be exposed only during reload,
9728 thus hoisting loads out of loops and doing inter-block scheduling needs
9729 a separate optimization pass.
9731 @item -fbranch-target-load-optimize2
9732 @opindex fbranch-target-load-optimize2
9733 Perform branch target register load optimization after prologue / epilogue
9734 threading.
9736 @item -fbtr-bb-exclusive
9737 @opindex fbtr-bb-exclusive
9738 When performing branch target register load optimization, don't reuse
9739 branch target registers within any basic block.
9741 @item -fstdarg-opt
9742 @opindex fstdarg-opt
9743 Optimize the prologue of variadic argument functions with respect to usage of
9744 those arguments.
9746 @item -fsection-anchors
9747 @opindex fsection-anchors
9748 Try to reduce the number of symbolic address calculations by using
9749 shared ``anchor'' symbols to address nearby objects.  This transformation
9750 can help to reduce the number of GOT entries and GOT accesses on some
9751 targets.
9753 For example, the implementation of the following function @code{foo}:
9755 @smallexample
9756 static int a, b, c;
9757 int foo (void) @{ return a + b + c; @}
9758 @end smallexample
9760 @noindent
9761 usually calculates the addresses of all three variables, but if you
9762 compile it with @option{-fsection-anchors}, it accesses the variables
9763 from a common anchor point instead.  The effect is similar to the
9764 following pseudocode (which isn't valid C):
9766 @smallexample
9767 int foo (void)
9769   register int *xr = &x;
9770   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
9772 @end smallexample
9774 Not all targets support this option.
9776 @item --param @var{name}=@var{value}
9777 @opindex param
9778 In some places, GCC uses various constants to control the amount of
9779 optimization that is done.  For example, GCC does not inline functions
9780 that contain more than a certain number of instructions.  You can
9781 control some of these constants on the command line using the
9782 @option{--param} option.
9784 The names of specific parameters, and the meaning of the values, are
9785 tied to the internals of the compiler, and are subject to change
9786 without notice in future releases.
9788 In each case, the @var{value} is an integer.  The allowable choices for
9789 @var{name} are:
9791 @table @gcctabopt
9792 @item predictable-branch-outcome
9793 When branch is predicted to be taken with probability lower than this threshold
9794 (in percent), then it is considered well predictable. The default is 10.
9796 @item max-rtl-if-conversion-insns
9797 RTL if-conversion tries to remove conditional branches around a block and
9798 replace them with conditionally executed instructions.  This parameter
9799 gives the maximum number of instructions in a block which should be
9800 considered for if-conversion.  The default is 10, though the compiler will
9801 also use other heuristics to decide whether if-conversion is likely to be
9802 profitable.
9804 @item max-rtl-if-conversion-predictable-cost
9805 @item max-rtl-if-conversion-unpredictable-cost
9806 RTL if-conversion will try to remove conditional branches around a block
9807 and replace them with conditionally executed instructions.  These parameters
9808 give the maximum permissible cost for the sequence that would be generated
9809 by if-conversion depending on whether the branch is statically determined
9810 to be predictable or not.  The units for this parameter are the same as
9811 those for the GCC internal seq_cost metric.  The compiler will try to
9812 provide a reasonable default for this parameter using the BRANCH_COST
9813 target macro.
9815 @item max-crossjump-edges
9816 The maximum number of incoming edges to consider for cross-jumping.
9817 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
9818 the number of edges incoming to each block.  Increasing values mean
9819 more aggressive optimization, making the compilation time increase with
9820 probably small improvement in executable size.
9822 @item min-crossjump-insns
9823 The minimum number of instructions that must be matched at the end
9824 of two blocks before cross-jumping is performed on them.  This
9825 value is ignored in the case where all instructions in the block being
9826 cross-jumped from are matched.  The default value is 5.
9828 @item max-grow-copy-bb-insns
9829 The maximum code size expansion factor when copying basic blocks
9830 instead of jumping.  The expansion is relative to a jump instruction.
9831 The default value is 8.
9833 @item max-goto-duplication-insns
9834 The maximum number of instructions to duplicate to a block that jumps
9835 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
9836 passes, GCC factors computed gotos early in the compilation process,
9837 and unfactors them as late as possible.  Only computed jumps at the
9838 end of a basic blocks with no more than max-goto-duplication-insns are
9839 unfactored.  The default value is 8.
9841 @item max-delay-slot-insn-search
9842 The maximum number of instructions to consider when looking for an
9843 instruction to fill a delay slot.  If more than this arbitrary number of
9844 instructions are searched, the time savings from filling the delay slot
9845 are minimal, so stop searching.  Increasing values mean more
9846 aggressive optimization, making the compilation time increase with probably
9847 small improvement in execution time.
9849 @item max-delay-slot-live-search
9850 When trying to fill delay slots, the maximum number of instructions to
9851 consider when searching for a block with valid live register
9852 information.  Increasing this arbitrarily chosen value means more
9853 aggressive optimization, increasing the compilation time.  This parameter
9854 should be removed when the delay slot code is rewritten to maintain the
9855 control-flow graph.
9857 @item max-gcse-memory
9858 The approximate maximum amount of memory that can be allocated in
9859 order to perform the global common subexpression elimination
9860 optimization.  If more memory than specified is required, the
9861 optimization is not done.
9863 @item max-gcse-insertion-ratio
9864 If the ratio of expression insertions to deletions is larger than this value
9865 for any expression, then RTL PRE inserts or removes the expression and thus
9866 leaves partially redundant computations in the instruction stream.  The default value is 20.
9868 @item max-pending-list-length
9869 The maximum number of pending dependencies scheduling allows
9870 before flushing the current state and starting over.  Large functions
9871 with few branches or calls can create excessively large lists which
9872 needlessly consume memory and resources.
9874 @item max-modulo-backtrack-attempts
9875 The maximum number of backtrack attempts the scheduler should make
9876 when modulo scheduling a loop.  Larger values can exponentially increase
9877 compilation time.
9879 @item max-inline-insns-single
9880 Several parameters control the tree inliner used in GCC@.
9881 This number sets the maximum number of instructions (counted in GCC's
9882 internal representation) in a single function that the tree inliner
9883 considers for inlining.  This only affects functions declared
9884 inline and methods implemented in a class declaration (C++).
9885 The default value is 400.
9887 @item max-inline-insns-auto
9888 When you use @option{-finline-functions} (included in @option{-O3}),
9889 a lot of functions that would otherwise not be considered for inlining
9890 by the compiler are investigated.  To those functions, a different
9891 (more restrictive) limit compared to functions declared inline can
9892 be applied.
9893 The default value is 40.
9895 @item inline-min-speedup
9896 When estimated performance improvement of caller + callee runtime exceeds this
9897 threshold (in percent), the function can be inlined regardless of the limit on
9898 @option{--param max-inline-insns-single} and @option{--param
9899 max-inline-insns-auto}.
9901 @item large-function-insns
9902 The limit specifying really large functions.  For functions larger than this
9903 limit after inlining, inlining is constrained by
9904 @option{--param large-function-growth}.  This parameter is useful primarily
9905 to avoid extreme compilation time caused by non-linear algorithms used by the
9906 back end.
9907 The default value is 2700.
9909 @item large-function-growth
9910 Specifies maximal growth of large function caused by inlining in percents.
9911 The default value is 100 which limits large function growth to 2.0 times
9912 the original size.
9914 @item large-unit-insns
9915 The limit specifying large translation unit.  Growth caused by inlining of
9916 units larger than this limit is limited by @option{--param inline-unit-growth}.
9917 For small units this might be too tight.
9918 For example, consider a unit consisting of function A
9919 that is inline and B that just calls A three times.  If B is small relative to
9920 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
9921 large units consisting of small inlineable functions, however, the overall unit
9922 growth limit is needed to avoid exponential explosion of code size.  Thus for
9923 smaller units, the size is increased to @option{--param large-unit-insns}
9924 before applying @option{--param inline-unit-growth}.  The default is 10000.
9926 @item inline-unit-growth
9927 Specifies maximal overall growth of the compilation unit caused by inlining.
9928 The default value is 20 which limits unit growth to 1.2 times the original
9929 size. Cold functions (either marked cold via an attribute or by profile
9930 feedback) are not accounted into the unit size.
9932 @item ipcp-unit-growth
9933 Specifies maximal overall growth of the compilation unit caused by
9934 interprocedural constant propagation.  The default value is 10 which limits
9935 unit growth to 1.1 times the original size.
9937 @item large-stack-frame
9938 The limit specifying large stack frames.  While inlining the algorithm is trying
9939 to not grow past this limit too much.  The default value is 256 bytes.
9941 @item large-stack-frame-growth
9942 Specifies maximal growth of large stack frames caused by inlining in percents.
9943 The default value is 1000 which limits large stack frame growth to 11 times
9944 the original size.
9946 @item max-inline-insns-recursive
9947 @itemx max-inline-insns-recursive-auto
9948 Specifies the maximum number of instructions an out-of-line copy of a
9949 self-recursive inline
9950 function can grow into by performing recursive inlining.
9952 @option{--param max-inline-insns-recursive} applies to functions
9953 declared inline.
9954 For functions not declared inline, recursive inlining
9955 happens only when @option{-finline-functions} (included in @option{-O3}) is
9956 enabled; @option{--param max-inline-insns-recursive-auto} applies instead.  The
9957 default value is 450.
9959 @item max-inline-recursive-depth
9960 @itemx max-inline-recursive-depth-auto
9961 Specifies the maximum recursion depth used for recursive inlining.
9963 @option{--param max-inline-recursive-depth} applies to functions
9964 declared inline.  For functions not declared inline, recursive inlining
9965 happens only when @option{-finline-functions} (included in @option{-O3}) is
9966 enabled; @option{--param max-inline-recursive-depth-auto} applies instead.  The
9967 default value is 8.
9969 @item min-inline-recursive-probability
9970 Recursive inlining is profitable only for function having deep recursion
9971 in average and can hurt for function having little recursion depth by
9972 increasing the prologue size or complexity of function body to other
9973 optimizers.
9975 When profile feedback is available (see @option{-fprofile-generate}) the actual
9976 recursion depth can be guessed from the probability that function recurses
9977 via a given call expression.  This parameter limits inlining only to call
9978 expressions whose probability exceeds the given threshold (in percents).
9979 The default value is 10.
9981 @item early-inlining-insns
9982 Specify growth that the early inliner can make.  In effect it increases
9983 the amount of inlining for code having a large abstraction penalty.
9984 The default value is 14.
9986 @item max-early-inliner-iterations
9987 Limit of iterations of the early inliner.  This basically bounds
9988 the number of nested indirect calls the early inliner can resolve.
9989 Deeper chains are still handled by late inlining.
9991 @item comdat-sharing-probability
9992 Probability (in percent) that C++ inline function with comdat visibility
9993 are shared across multiple compilation units.  The default value is 20.
9995 @item profile-func-internal-id
9996 A parameter to control whether to use function internal id in profile
9997 database lookup. If the value is 0, the compiler uses an id that
9998 is based on function assembler name and filename, which makes old profile
9999 data more tolerant to source changes such as function reordering etc.
10000 The default value is 0.
10002 @item min-vect-loop-bound
10003 The minimum number of iterations under which loops are not vectorized
10004 when @option{-ftree-vectorize} is used.  The number of iterations after
10005 vectorization needs to be greater than the value specified by this option
10006 to allow vectorization.  The default value is 0.
10008 @item gcse-cost-distance-ratio
10009 Scaling factor in calculation of maximum distance an expression
10010 can be moved by GCSE optimizations.  This is currently supported only in the
10011 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
10012 is with simple expressions, i.e., the expressions that have cost
10013 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
10014 hoisting of simple expressions.  The default value is 10.
10016 @item gcse-unrestricted-cost
10017 Cost, roughly measured as the cost of a single typical machine
10018 instruction, at which GCSE optimizations do not constrain
10019 the distance an expression can travel.  This is currently
10020 supported only in the code hoisting pass.  The lesser the cost,
10021 the more aggressive code hoisting is.  Specifying 0 
10022 allows all expressions to travel unrestricted distances.
10023 The default value is 3.
10025 @item max-hoist-depth
10026 The depth of search in the dominator tree for expressions to hoist.
10027 This is used to avoid quadratic behavior in hoisting algorithm.
10028 The value of 0 does not limit on the search, but may slow down compilation
10029 of huge functions.  The default value is 30.
10031 @item max-tail-merge-comparisons
10032 The maximum amount of similar bbs to compare a bb with.  This is used to
10033 avoid quadratic behavior in tree tail merging.  The default value is 10.
10035 @item max-tail-merge-iterations
10036 The maximum amount of iterations of the pass over the function.  This is used to
10037 limit compilation time in tree tail merging.  The default value is 2.
10039 @item store-merging-allow-unaligned
10040 Allow the store merging pass to introduce unaligned stores if it is legal to
10041 do so.  The default value is 1.
10043 @item max-stores-to-merge
10044 The maximum number of stores to attempt to merge into wider stores in the store
10045 merging pass.  The minimum value is 2 and the default is 64.
10047 @item max-unrolled-insns
10048 The maximum number of instructions that a loop may have to be unrolled.
10049 If a loop is unrolled, this parameter also determines how many times
10050 the loop code is unrolled.
10052 @item max-average-unrolled-insns
10053 The maximum number of instructions biased by probabilities of their execution
10054 that a loop may have to be unrolled.  If a loop is unrolled,
10055 this parameter also determines how many times the loop code is unrolled.
10057 @item max-unroll-times
10058 The maximum number of unrollings of a single loop.
10060 @item max-peeled-insns
10061 The maximum number of instructions that a loop may have to be peeled.
10062 If a loop is peeled, this parameter also determines how many times
10063 the loop code is peeled.
10065 @item max-peel-times
10066 The maximum number of peelings of a single loop.
10068 @item max-peel-branches
10069 The maximum number of branches on the hot path through the peeled sequence.
10071 @item max-completely-peeled-insns
10072 The maximum number of insns of a completely peeled loop.
10074 @item max-completely-peel-times
10075 The maximum number of iterations of a loop to be suitable for complete peeling.
10077 @item max-completely-peel-loop-nest-depth
10078 The maximum depth of a loop nest suitable for complete peeling.
10080 @item max-unswitch-insns
10081 The maximum number of insns of an unswitched loop.
10083 @item max-unswitch-level
10084 The maximum number of branches unswitched in a single loop.
10086 @item max-loop-headers-insns
10087 The maximum number of insns in loop header duplicated by the copy loop headers
10088 pass.
10090 @item lim-expensive
10091 The minimum cost of an expensive expression in the loop invariant motion.
10093 @item iv-consider-all-candidates-bound
10094 Bound on number of candidates for induction variables, below which
10095 all candidates are considered for each use in induction variable
10096 optimizations.  If there are more candidates than this,
10097 only the most relevant ones are considered to avoid quadratic time complexity.
10099 @item iv-max-considered-uses
10100 The induction variable optimizations give up on loops that contain more
10101 induction variable uses.
10103 @item iv-always-prune-cand-set-bound
10104 If the number of candidates in the set is smaller than this value,
10105 always try to remove unnecessary ivs from the set
10106 when adding a new one.
10108 @item avg-loop-niter
10109 Average number of iterations of a loop.
10111 @item dse-max-object-size
10112 Maximum size (in bytes) of objects tracked bytewise by dead store elimination.
10113 Larger values may result in larger compilation times.
10115 @item scev-max-expr-size
10116 Bound on size of expressions used in the scalar evolutions analyzer.
10117 Large expressions slow the analyzer.
10119 @item scev-max-expr-complexity
10120 Bound on the complexity of the expressions in the scalar evolutions analyzer.
10121 Complex expressions slow the analyzer.
10123 @item max-tree-if-conversion-phi-args
10124 Maximum number of arguments in a PHI supported by TREE if conversion
10125 unless the loop is marked with simd pragma.
10127 @item vect-max-version-for-alignment-checks
10128 The maximum number of run-time checks that can be performed when
10129 doing loop versioning for alignment in the vectorizer.
10131 @item vect-max-version-for-alias-checks
10132 The maximum number of run-time checks that can be performed when
10133 doing loop versioning for alias in the vectorizer.
10135 @item vect-max-peeling-for-alignment
10136 The maximum number of loop peels to enhance access alignment
10137 for vectorizer. Value -1 means no limit.
10139 @item max-iterations-to-track
10140 The maximum number of iterations of a loop the brute-force algorithm
10141 for analysis of the number of iterations of the loop tries to evaluate.
10143 @item hot-bb-count-ws-permille
10144 A basic block profile count is considered hot if it contributes to 
10145 the given permillage (i.e. 0...1000) of the entire profiled execution.
10147 @item hot-bb-frequency-fraction
10148 Select fraction of the entry block frequency of executions of basic block in
10149 function given basic block needs to have to be considered hot.
10151 @item max-predicted-iterations
10152 The maximum number of loop iterations we predict statically.  This is useful
10153 in cases where a function contains a single loop with known bound and
10154 another loop with unknown bound.
10155 The known number of iterations is predicted correctly, while
10156 the unknown number of iterations average to roughly 10.  This means that the
10157 loop without bounds appears artificially cold relative to the other one.
10159 @item builtin-expect-probability
10160 Control the probability of the expression having the specified value. This
10161 parameter takes a percentage (i.e. 0 ... 100) as input.
10162 The default probability of 90 is obtained empirically.
10164 @item align-threshold
10166 Select fraction of the maximal frequency of executions of a basic block in
10167 a function to align the basic block.
10169 @item align-loop-iterations
10171 A loop expected to iterate at least the selected number of iterations is
10172 aligned.
10174 @item tracer-dynamic-coverage
10175 @itemx tracer-dynamic-coverage-feedback
10177 This value is used to limit superblock formation once the given percentage of
10178 executed instructions is covered.  This limits unnecessary code size
10179 expansion.
10181 The @option{tracer-dynamic-coverage-feedback} parameter
10182 is used only when profile
10183 feedback is available.  The real profiles (as opposed to statically estimated
10184 ones) are much less balanced allowing the threshold to be larger value.
10186 @item tracer-max-code-growth
10187 Stop tail duplication once code growth has reached given percentage.  This is
10188 a rather artificial limit, as most of the duplicates are eliminated later in
10189 cross jumping, so it may be set to much higher values than is the desired code
10190 growth.
10192 @item tracer-min-branch-ratio
10194 Stop reverse growth when the reverse probability of best edge is less than this
10195 threshold (in percent).
10197 @item tracer-min-branch-probability
10198 @itemx tracer-min-branch-probability-feedback
10200 Stop forward growth if the best edge has probability lower than this
10201 threshold.
10203 Similarly to @option{tracer-dynamic-coverage} two parameters are
10204 provided.  @option{tracer-min-branch-probability-feedback} is used for
10205 compilation with profile feedback and @option{tracer-min-branch-probability}
10206 compilation without.  The value for compilation with profile feedback
10207 needs to be more conservative (higher) in order to make tracer
10208 effective.
10210 @item stack-clash-protection-guard-size
10211 Specify the size of the operating system provided stack guard as
10212 2 raised to @var{num} bytes.  The default value is 12 (4096 bytes).
10213 Acceptable values are between 12 and 30.  Higher values may reduce the
10214 number of explicit probes, but a value larger than the operating system
10215 provided guard will leave code vulnerable to stack clash style attacks.
10217 @item stack-clash-protection-probe-interval
10218 Stack clash protection involves probing stack space as it is allocated.  This
10219 param controls the maximum distance between probes into the stack as 2 raised
10220 to @var{num} bytes.  Acceptable values are between 10 and 16 and defaults to
10221 12.  Higher values may reduce the number of explicit probes, but a value
10222 larger than the operating system provided guard will leave code vulnerable to
10223 stack clash style attacks.
10225 @item max-cse-path-length
10227 The maximum number of basic blocks on path that CSE considers.
10228 The default is 10.
10230 @item max-cse-insns
10231 The maximum number of instructions CSE processes before flushing.
10232 The default is 1000.
10234 @item ggc-min-expand
10236 GCC uses a garbage collector to manage its own memory allocation.  This
10237 parameter specifies the minimum percentage by which the garbage
10238 collector's heap should be allowed to expand between collections.
10239 Tuning this may improve compilation speed; it has no effect on code
10240 generation.
10242 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
10243 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
10244 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
10245 GCC is not able to calculate RAM on a particular platform, the lower
10246 bound of 30% is used.  Setting this parameter and
10247 @option{ggc-min-heapsize} to zero causes a full collection to occur at
10248 every opportunity.  This is extremely slow, but can be useful for
10249 debugging.
10251 @item ggc-min-heapsize
10253 Minimum size of the garbage collector's heap before it begins bothering
10254 to collect garbage.  The first collection occurs after the heap expands
10255 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
10256 tuning this may improve compilation speed, and has no effect on code
10257 generation.
10259 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
10260 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
10261 with a lower bound of 4096 (four megabytes) and an upper bound of
10262 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
10263 particular platform, the lower bound is used.  Setting this parameter
10264 very large effectively disables garbage collection.  Setting this
10265 parameter and @option{ggc-min-expand} to zero causes a full collection
10266 to occur at every opportunity.
10268 @item max-reload-search-insns
10269 The maximum number of instruction reload should look backward for equivalent
10270 register.  Increasing values mean more aggressive optimization, making the
10271 compilation time increase with probably slightly better performance.
10272 The default value is 100.
10274 @item max-cselib-memory-locations
10275 The maximum number of memory locations cselib should take into account.
10276 Increasing values mean more aggressive optimization, making the compilation time
10277 increase with probably slightly better performance.  The default value is 500.
10279 @item max-sched-ready-insns
10280 The maximum number of instructions ready to be issued the scheduler should
10281 consider at any given time during the first scheduling pass.  Increasing
10282 values mean more thorough searches, making the compilation time increase
10283 with probably little benefit.  The default value is 100.
10285 @item max-sched-region-blocks
10286 The maximum number of blocks in a region to be considered for
10287 interblock scheduling.  The default value is 10.
10289 @item max-pipeline-region-blocks
10290 The maximum number of blocks in a region to be considered for
10291 pipelining in the selective scheduler.  The default value is 15.
10293 @item max-sched-region-insns
10294 The maximum number of insns in a region to be considered for
10295 interblock scheduling.  The default value is 100.
10297 @item max-pipeline-region-insns
10298 The maximum number of insns in a region to be considered for
10299 pipelining in the selective scheduler.  The default value is 200.
10301 @item min-spec-prob
10302 The minimum probability (in percents) of reaching a source block
10303 for interblock speculative scheduling.  The default value is 40.
10305 @item max-sched-extend-regions-iters
10306 The maximum number of iterations through CFG to extend regions.
10307 A value of 0 (the default) disables region extensions.
10309 @item max-sched-insn-conflict-delay
10310 The maximum conflict delay for an insn to be considered for speculative motion.
10311 The default value is 3.
10313 @item sched-spec-prob-cutoff
10314 The minimal probability of speculation success (in percents), so that
10315 speculative insns are scheduled.
10316 The default value is 40.
10318 @item sched-state-edge-prob-cutoff
10319 The minimum probability an edge must have for the scheduler to save its
10320 state across it.
10321 The default value is 10.
10323 @item sched-mem-true-dep-cost
10324 Minimal distance (in CPU cycles) between store and load targeting same
10325 memory locations.  The default value is 1.
10327 @item selsched-max-lookahead
10328 The maximum size of the lookahead window of selective scheduling.  It is a
10329 depth of search for available instructions.
10330 The default value is 50.
10332 @item selsched-max-sched-times
10333 The maximum number of times that an instruction is scheduled during
10334 selective scheduling.  This is the limit on the number of iterations
10335 through which the instruction may be pipelined.  The default value is 2.
10337 @item selsched-insns-to-rename
10338 The maximum number of best instructions in the ready list that are considered
10339 for renaming in the selective scheduler.  The default value is 2.
10341 @item sms-min-sc
10342 The minimum value of stage count that swing modulo scheduler
10343 generates.  The default value is 2.
10345 @item max-last-value-rtl
10346 The maximum size measured as number of RTLs that can be recorded in an expression
10347 in combiner for a pseudo register as last known value of that register.  The default
10348 is 10000.
10350 @item max-combine-insns
10351 The maximum number of instructions the RTL combiner tries to combine.
10352 The default value is 2 at @option{-Og} and 4 otherwise.
10354 @item integer-share-limit
10355 Small integer constants can use a shared data structure, reducing the
10356 compiler's memory usage and increasing its speed.  This sets the maximum
10357 value of a shared integer constant.  The default value is 256.
10359 @item ssp-buffer-size
10360 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
10361 protection when @option{-fstack-protection} is used.
10363 @item min-size-for-stack-sharing
10364 The minimum size of variables taking part in stack slot sharing when not
10365 optimizing. The default value is 32.
10367 @item max-jump-thread-duplication-stmts
10368 Maximum number of statements allowed in a block that needs to be
10369 duplicated when threading jumps.
10371 @item max-fields-for-field-sensitive
10372 Maximum number of fields in a structure treated in
10373 a field sensitive manner during pointer analysis.  The default is zero
10374 for @option{-O0} and @option{-O1},
10375 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
10377 @item prefetch-latency
10378 Estimate on average number of instructions that are executed before
10379 prefetch finishes.  The distance prefetched ahead is proportional
10380 to this constant.  Increasing this number may also lead to less
10381 streams being prefetched (see @option{simultaneous-prefetches}).
10383 @item simultaneous-prefetches
10384 Maximum number of prefetches that can run at the same time.
10386 @item l1-cache-line-size
10387 The size of cache line in L1 cache, in bytes.
10389 @item l1-cache-size
10390 The size of L1 cache, in kilobytes.
10392 @item l2-cache-size
10393 The size of L2 cache, in kilobytes.
10395 @item min-insn-to-prefetch-ratio
10396 The minimum ratio between the number of instructions and the
10397 number of prefetches to enable prefetching in a loop.
10399 @item prefetch-min-insn-to-mem-ratio
10400 The minimum ratio between the number of instructions and the
10401 number of memory references to enable prefetching in a loop.
10403 @item use-canonical-types
10404 Whether the compiler should use the ``canonical'' type system.  By
10405 default, this should always be 1, which uses a more efficient internal
10406 mechanism for comparing types in C++ and Objective-C++.  However, if
10407 bugs in the canonical type system are causing compilation failures,
10408 set this value to 0 to disable canonical types.
10410 @item switch-conversion-max-branch-ratio
10411 Switch initialization conversion refuses to create arrays that are
10412 bigger than @option{switch-conversion-max-branch-ratio} times the number of
10413 branches in the switch.
10415 @item max-partial-antic-length
10416 Maximum length of the partial antic set computed during the tree
10417 partial redundancy elimination optimization (@option{-ftree-pre}) when
10418 optimizing at @option{-O3} and above.  For some sorts of source code
10419 the enhanced partial redundancy elimination optimization can run away,
10420 consuming all of the memory available on the host machine.  This
10421 parameter sets a limit on the length of the sets that are computed,
10422 which prevents the runaway behavior.  Setting a value of 0 for
10423 this parameter allows an unlimited set length.
10425 @item sccvn-max-scc-size
10426 Maximum size of a strongly connected component (SCC) during SCCVN
10427 processing.  If this limit is hit, SCCVN processing for the whole
10428 function is not done and optimizations depending on it are
10429 disabled.  The default maximum SCC size is 10000.
10431 @item sccvn-max-alias-queries-per-access
10432 Maximum number of alias-oracle queries we perform when looking for
10433 redundancies for loads and stores.  If this limit is hit the search
10434 is aborted and the load or store is not considered redundant.  The
10435 number of queries is algorithmically limited to the number of
10436 stores on all paths from the load to the function entry.
10437 The default maximum number of queries is 1000.
10439 @item ira-max-loops-num
10440 IRA uses regional register allocation by default.  If a function
10441 contains more loops than the number given by this parameter, only at most
10442 the given number of the most frequently-executed loops form regions
10443 for regional register allocation.  The default value of the
10444 parameter is 100.
10446 @item ira-max-conflict-table-size 
10447 Although IRA uses a sophisticated algorithm to compress the conflict
10448 table, the table can still require excessive amounts of memory for
10449 huge functions.  If the conflict table for a function could be more
10450 than the size in MB given by this parameter, the register allocator
10451 instead uses a faster, simpler, and lower-quality
10452 algorithm that does not require building a pseudo-register conflict table.  
10453 The default value of the parameter is 2000.
10455 @item ira-loop-reserved-regs
10456 IRA can be used to evaluate more accurate register pressure in loops
10457 for decisions to move loop invariants (see @option{-O3}).  The number
10458 of available registers reserved for some other purposes is given
10459 by this parameter.  The default value of the parameter is 2, which is
10460 the minimal number of registers needed by typical instructions.
10461 This value is the best found from numerous experiments.
10463 @item lra-inheritance-ebb-probability-cutoff
10464 LRA tries to reuse values reloaded in registers in subsequent insns.
10465 This optimization is called inheritance.  EBB is used as a region to
10466 do this optimization.  The parameter defines a minimal fall-through
10467 edge probability in percentage used to add BB to inheritance EBB in
10468 LRA.  The default value of the parameter is 40.  The value was chosen
10469 from numerous runs of SPEC2000 on x86-64.
10471 @item loop-invariant-max-bbs-in-loop
10472 Loop invariant motion can be very expensive, both in compilation time and
10473 in amount of needed compile-time memory, with very large loops.  Loops
10474 with more basic blocks than this parameter won't have loop invariant
10475 motion optimization performed on them.  The default value of the
10476 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
10478 @item loop-max-datarefs-for-datadeps
10479 Building data dependencies is expensive for very large loops.  This
10480 parameter limits the number of data references in loops that are
10481 considered for data dependence analysis.  These large loops are no
10482 handled by the optimizations using loop data dependencies.
10483 The default value is 1000.
10485 @item max-vartrack-size
10486 Sets a maximum number of hash table slots to use during variable
10487 tracking dataflow analysis of any function.  If this limit is exceeded
10488 with variable tracking at assignments enabled, analysis for that
10489 function is retried without it, after removing all debug insns from
10490 the function.  If the limit is exceeded even without debug insns, var
10491 tracking analysis is completely disabled for the function.  Setting
10492 the parameter to zero makes it unlimited.
10494 @item max-vartrack-expr-depth
10495 Sets a maximum number of recursion levels when attempting to map
10496 variable names or debug temporaries to value expressions.  This trades
10497 compilation time for more complete debug information.  If this is set too
10498 low, value expressions that are available and could be represented in
10499 debug information may end up not being used; setting this higher may
10500 enable the compiler to find more complex debug expressions, but compile
10501 time and memory use may grow.  The default is 12.
10503 @item min-nondebug-insn-uid
10504 Use uids starting at this parameter for nondebug insns.  The range below
10505 the parameter is reserved exclusively for debug insns created by
10506 @option{-fvar-tracking-assignments}, but debug insns may get
10507 (non-overlapping) uids above it if the reserved range is exhausted.
10509 @item ipa-sra-ptr-growth-factor
10510 IPA-SRA replaces a pointer to an aggregate with one or more new
10511 parameters only when their cumulative size is less or equal to
10512 @option{ipa-sra-ptr-growth-factor} times the size of the original
10513 pointer parameter.
10515 @item sra-max-scalarization-size-Ospeed
10516 @item sra-max-scalarization-size-Osize
10517 The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to
10518 replace scalar parts of aggregates with uses of independent scalar
10519 variables.  These parameters control the maximum size, in storage units,
10520 of aggregate which is considered for replacement when compiling for
10521 speed
10522 (@option{sra-max-scalarization-size-Ospeed}) or size
10523 (@option{sra-max-scalarization-size-Osize}) respectively.
10525 @item tm-max-aggregate-size
10526 When making copies of thread-local variables in a transaction, this
10527 parameter specifies the size in bytes after which variables are
10528 saved with the logging functions as opposed to save/restore code
10529 sequence pairs.  This option only applies when using
10530 @option{-fgnu-tm}.
10532 @item graphite-max-nb-scop-params
10533 To avoid exponential effects in the Graphite loop transforms, the
10534 number of parameters in a Static Control Part (SCoP) is bounded.  The
10535 default value is 10 parameters, a value of zero can be used to lift
10536 the bound.  A variable whose value is unknown at compilation time and
10537 defined outside a SCoP is a parameter of the SCoP.
10539 @item loop-block-tile-size
10540 Loop blocking or strip mining transforms, enabled with
10541 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
10542 loop in the loop nest by a given number of iterations.  The strip
10543 length can be changed using the @option{loop-block-tile-size}
10544 parameter.  The default value is 51 iterations.
10546 @item loop-unroll-jam-size
10547 Specify the unroll factor for the @option{-floop-unroll-and-jam} option.  The 
10548 default value is 4.
10550 @item loop-unroll-jam-depth
10551 Specify the dimension to be unrolled (counting from the most inner loop)
10552 for the  @option{-floop-unroll-and-jam}.  The default value is 2.
10554 @item ipa-cp-value-list-size
10555 IPA-CP attempts to track all possible values and types passed to a function's
10556 parameter in order to propagate them and perform devirtualization.
10557 @option{ipa-cp-value-list-size} is the maximum number of values and types it
10558 stores per one formal parameter of a function.
10560 @item ipa-cp-eval-threshold
10561 IPA-CP calculates its own score of cloning profitability heuristics
10562 and performs those cloning opportunities with scores that exceed
10563 @option{ipa-cp-eval-threshold}.
10565 @item ipa-cp-recursion-penalty
10566 Percentage penalty the recursive functions will receive when they
10567 are evaluated for cloning.
10569 @item ipa-cp-single-call-penalty
10570 Percentage penalty functions containing a single call to another
10571 function will receive when they are evaluated for cloning.
10574 @item ipa-max-agg-items
10575 IPA-CP is also capable to propagate a number of scalar values passed
10576 in an aggregate. @option{ipa-max-agg-items} controls the maximum
10577 number of such values per one parameter.
10579 @item ipa-cp-loop-hint-bonus
10580 When IPA-CP determines that a cloning candidate would make the number
10581 of iterations of a loop known, it adds a bonus of
10582 @option{ipa-cp-loop-hint-bonus} to the profitability score of
10583 the candidate.
10585 @item ipa-cp-array-index-hint-bonus
10586 When IPA-CP determines that a cloning candidate would make the index of
10587 an array access known, it adds a bonus of
10588 @option{ipa-cp-array-index-hint-bonus} to the profitability
10589 score of the candidate.
10591 @item ipa-max-aa-steps
10592 During its analysis of function bodies, IPA-CP employs alias analysis
10593 in order to track values pointed to by function parameters.  In order
10594 not spend too much time analyzing huge functions, it gives up and
10595 consider all memory clobbered after examining
10596 @option{ipa-max-aa-steps} statements modifying memory.
10598 @item lto-partitions
10599 Specify desired number of partitions produced during WHOPR compilation.
10600 The number of partitions should exceed the number of CPUs used for compilation.
10601 The default value is 32.
10603 @item lto-min-partition
10604 Size of minimal partition for WHOPR (in estimated instructions).
10605 This prevents expenses of splitting very small programs into too many
10606 partitions.
10608 @item lto-max-partition
10609 Size of max partition for WHOPR (in estimated instructions).
10610 to provide an upper bound for individual size of partition.
10611 Meant to be used only with balanced partitioning.
10613 @item cxx-max-namespaces-for-diagnostic-help
10614 The maximum number of namespaces to consult for suggestions when C++
10615 name lookup fails for an identifier.  The default is 1000.
10617 @item sink-frequency-threshold
10618 The maximum relative execution frequency (in percents) of the target block
10619 relative to a statement's original block to allow statement sinking of a
10620 statement.  Larger numbers result in more aggressive statement sinking.
10621 The default value is 75.  A small positive adjustment is applied for
10622 statements with memory operands as those are even more profitable so sink.
10624 @item max-stores-to-sink
10625 The maximum number of conditional store pairs that can be sunk.  Set to 0
10626 if either vectorization (@option{-ftree-vectorize}) or if-conversion
10627 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
10629 @item allow-store-data-races
10630 Allow optimizers to introduce new data races on stores.
10631 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10632 at optimization level @option{-Ofast}.
10634 @item case-values-threshold
10635 The smallest number of different values for which it is best to use a
10636 jump-table instead of a tree of conditional branches.  If the value is
10637 0, use the default for the machine.  The default is 0.
10639 @item tree-reassoc-width
10640 Set the maximum number of instructions executed in parallel in
10641 reassociated tree. This parameter overrides target dependent
10642 heuristics used by default if has non zero value.
10644 @item sched-pressure-algorithm
10645 Choose between the two available implementations of
10646 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
10647 and is the more likely to prevent instructions from being reordered.
10648 Algorithm 2 was designed to be a compromise between the relatively
10649 conservative approach taken by algorithm 1 and the rather aggressive
10650 approach taken by the default scheduler.  It relies more heavily on
10651 having a regular register file and accurate register pressure classes.
10652 See @file{haifa-sched.c} in the GCC sources for more details.
10654 The default choice depends on the target.
10656 @item max-slsr-cand-scan
10657 Set the maximum number of existing candidates that are considered when
10658 seeking a basis for a new straight-line strength reduction candidate.
10660 @item asan-globals
10661 Enable buffer overflow detection for global objects.  This kind
10662 of protection is enabled by default if you are using
10663 @option{-fsanitize=address} option.
10664 To disable global objects protection use @option{--param asan-globals=0}.
10666 @item asan-stack
10667 Enable buffer overflow detection for stack objects.  This kind of
10668 protection is enabled by default when using @option{-fsanitize=address}.
10669 To disable stack protection use @option{--param asan-stack=0} option.
10671 @item asan-instrument-reads
10672 Enable buffer overflow detection for memory reads.  This kind of
10673 protection is enabled by default when using @option{-fsanitize=address}.
10674 To disable memory reads protection use
10675 @option{--param asan-instrument-reads=0}.
10677 @item asan-instrument-writes
10678 Enable buffer overflow detection for memory writes.  This kind of
10679 protection is enabled by default when using @option{-fsanitize=address}.
10680 To disable memory writes protection use
10681 @option{--param asan-instrument-writes=0} option.
10683 @item asan-memintrin
10684 Enable detection for built-in functions.  This kind of protection
10685 is enabled by default when using @option{-fsanitize=address}.
10686 To disable built-in functions protection use
10687 @option{--param asan-memintrin=0}.
10689 @item asan-use-after-return
10690 Enable detection of use-after-return.  This kind of protection
10691 is enabled by default when using the @option{-fsanitize=address} option.
10692 To disable it use @option{--param asan-use-after-return=0}.
10694 Note: By default the check is disabled at run time.  To enable it,
10695 add @code{detect_stack_use_after_return=1} to the environment variable
10696 @env{ASAN_OPTIONS}.
10698 @item asan-instrumentation-with-call-threshold
10699 If number of memory accesses in function being instrumented
10700 is greater or equal to this number, use callbacks instead of inline checks.
10701 E.g. to disable inline code use
10702 @option{--param asan-instrumentation-with-call-threshold=0}.
10704 @item use-after-scope-direct-emission-threshold
10705 If the size of a local variable in bytes is smaller or equal to this
10706 number, directly poison (or unpoison) shadow memory instead of using
10707 run-time callbacks.  The default value is 256.
10709 @item chkp-max-ctor-size
10710 Static constructors generated by Pointer Bounds Checker may become very
10711 large and significantly increase compile time at optimization level
10712 @option{-O1} and higher.  This parameter is a maximum number of statements
10713 in a single generated constructor.  Default value is 5000.
10715 @item max-fsm-thread-path-insns
10716 Maximum number of instructions to copy when duplicating blocks on a
10717 finite state automaton jump thread path.  The default is 100.
10719 @item max-fsm-thread-length
10720 Maximum number of basic blocks on a finite state automaton jump thread
10721 path.  The default is 10.
10723 @item max-fsm-thread-paths
10724 Maximum number of new jump thread paths to create for a finite state
10725 automaton.  The default is 50.
10727 @item parloops-chunk-size
10728 Chunk size of omp schedule for loops parallelized by parloops.  The default
10729 is 0.
10731 @item parloops-schedule
10732 Schedule type of omp schedule for loops parallelized by parloops (static,
10733 dynamic, guided, auto, runtime).  The default is static.
10735 @item max-ssa-name-query-depth
10736 Maximum depth of recursion when querying properties of SSA names in things
10737 like fold routines.  One level of recursion corresponds to following a
10738 use-def chain.
10740 @item hsa-gen-debug-stores
10741 Enable emission of special debug stores within HSA kernels which are
10742 then read and reported by libgomp plugin.  Generation of these stores
10743 is disabled by default, use @option{--param hsa-gen-debug-stores=1} to
10744 enable it.
10746 @item max-speculative-devirt-maydefs
10747 The maximum number of may-defs we analyze when looking for a must-def
10748 specifying the dynamic type of an object that invokes a virtual call
10749 we may be able to devirtualize speculatively.
10751 @item max-vrp-switch-assertions
10752 The maximum number of assertions to add along the default edge of a switch
10753 statement during VRP.  The default is 10.
10754 @end table
10755 @end table
10757 @node Instrumentation Options
10758 @section Program Instrumentation Options
10759 @cindex instrumentation options
10760 @cindex program instrumentation options
10761 @cindex run-time error checking options
10762 @cindex profiling options
10763 @cindex options, program instrumentation
10764 @cindex options, run-time error checking
10765 @cindex options, profiling
10767 GCC supports a number of command-line options that control adding
10768 run-time instrumentation to the code it normally generates.  
10769 For example, one purpose of instrumentation is collect profiling
10770 statistics for use in finding program hot spots, code coverage
10771 analysis, or profile-guided optimizations.
10772 Another class of program instrumentation is adding run-time checking 
10773 to detect programming errors like invalid pointer
10774 dereferences or out-of-bounds array accesses, as well as deliberately
10775 hostile attacks such as stack smashing or C++ vtable hijacking.
10776 There is also a general hook which can be used to implement other
10777 forms of tracing or function-level instrumentation for debug or
10778 program analysis purposes.
10780 @table @gcctabopt
10781 @cindex @command{prof}
10782 @item -p
10783 @opindex p
10784 Generate extra code to write profile information suitable for the
10785 analysis program @command{prof}.  You must use this option when compiling
10786 the source files you want data about, and you must also use it when
10787 linking.
10789 @cindex @command{gprof}
10790 @item -pg
10791 @opindex pg
10792 Generate extra code to write profile information suitable for the
10793 analysis program @command{gprof}.  You must use this option when compiling
10794 the source files you want data about, and you must also use it when
10795 linking.
10797 @item -fprofile-arcs
10798 @opindex fprofile-arcs
10799 Add code so that program flow @dfn{arcs} are instrumented.  During
10800 execution the program records how many times each branch and call is
10801 executed and how many times it is taken or returns.  On targets that support
10802 constructors with priority support, profiling properly handles constructors,
10803 destructors and C++ constructors (and destructors) of classes which are used
10804 as a type of a global variable.
10806 When the compiled
10807 program exits it saves this data to a file called
10808 @file{@var{auxname}.gcda} for each source file.  The data may be used for
10809 profile-directed optimizations (@option{-fbranch-probabilities}), or for
10810 test coverage analysis (@option{-ftest-coverage}).  Each object file's
10811 @var{auxname} is generated from the name of the output file, if
10812 explicitly specified and it is not the final executable, otherwise it is
10813 the basename of the source file.  In both cases any suffix is removed
10814 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
10815 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
10816 @xref{Cross-profiling}.
10818 @cindex @command{gcov}
10819 @item --coverage
10820 @opindex coverage
10822 This option is used to compile and link code instrumented for coverage
10823 analysis.  The option is a synonym for @option{-fprofile-arcs}
10824 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
10825 linking).  See the documentation for those options for more details.
10827 @itemize
10829 @item
10830 Compile the source files with @option{-fprofile-arcs} plus optimization
10831 and code generation options.  For test coverage analysis, use the
10832 additional @option{-ftest-coverage} option.  You do not need to profile
10833 every source file in a program.
10835 @item
10836 Compile the source files additionally with @option{-fprofile-abs-path}
10837 to create absolute path names in the @file{.gcno} files.  This allows
10838 @command{gcov} to find the correct sources in projects where compilations
10839 occur with different working directories.
10841 @item
10842 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
10843 (the latter implies the former).
10845 @item
10846 Run the program on a representative workload to generate the arc profile
10847 information.  This may be repeated any number of times.  You can run
10848 concurrent instances of your program, and provided that the file system
10849 supports locking, the data files will be correctly updated.  Also
10850 @code{fork} calls are detected and correctly handled (double counting
10851 will not happen).
10853 @item
10854 For profile-directed optimizations, compile the source files again with
10855 the same optimization and code generation options plus
10856 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
10857 Control Optimization}).
10859 @item
10860 For test coverage analysis, use @command{gcov} to produce human readable
10861 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
10862 @command{gcov} documentation for further information.
10864 @end itemize
10866 With @option{-fprofile-arcs}, for each function of your program GCC
10867 creates a program flow graph, then finds a spanning tree for the graph.
10868 Only arcs that are not on the spanning tree have to be instrumented: the
10869 compiler adds code to count the number of times that these arcs are
10870 executed.  When an arc is the only exit or only entrance to a block, the
10871 instrumentation code can be added to the block; otherwise, a new basic
10872 block must be created to hold the instrumentation code.
10874 @need 2000
10875 @item -ftest-coverage
10876 @opindex ftest-coverage
10877 Produce a notes file that the @command{gcov} code-coverage utility
10878 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
10879 show program coverage.  Each source file's note file is called
10880 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
10881 above for a description of @var{auxname} and instructions on how to
10882 generate test coverage data.  Coverage data matches the source files
10883 more closely if you do not optimize.
10885 @item -fprofile-abs-path
10886 @opindex fprofile-abs-path
10887 Automatically convert relative source file names to absolute path names
10888 in the @file{.gcno} files.  This allows @command{gcov} to find the correct
10889 sources in projects where compilations occur with different working
10890 directories.
10892 @item -fprofile-dir=@var{path}
10893 @opindex fprofile-dir
10895 Set the directory to search for the profile data files in to @var{path}.
10896 This option affects only the profile data generated by
10897 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
10898 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
10899 and its related options.  Both absolute and relative paths can be used.
10900 By default, GCC uses the current directory as @var{path}, thus the
10901 profile data file appears in the same directory as the object file.
10903 @item -fprofile-generate
10904 @itemx -fprofile-generate=@var{path}
10905 @opindex fprofile-generate
10907 Enable options usually used for instrumenting application to produce
10908 profile useful for later recompilation with profile feedback based
10909 optimization.  You must use @option{-fprofile-generate} both when
10910 compiling and when linking your program.
10912 The following options are enabled: @option{-fprofile-arcs}, @option{-fprofile-values}, @option{-fvpt}.
10914 If @var{path} is specified, GCC looks at the @var{path} to find
10915 the profile feedback data files. See @option{-fprofile-dir}.
10917 To optimize the program based on the collected profile information, use
10918 @option{-fprofile-use}.  @xref{Optimize Options}, for more information.
10920 @item -fprofile-update=@var{method}
10921 @opindex fprofile-update
10923 Alter the update method for an application instrumented for profile
10924 feedback based optimization.  The @var{method} argument should be one of
10925 @samp{single}, @samp{atomic} or @samp{prefer-atomic}.
10926 The first one is useful for single-threaded applications,
10927 while the second one prevents profile corruption by emitting thread-safe code.
10929 @strong{Warning:} When an application does not properly join all threads
10930 (or creates an detached thread), a profile file can be still corrupted.
10932 Using @samp{prefer-atomic} would be transformed either to @samp{atomic},
10933 when supported by a target, or to @samp{single} otherwise.  The GCC driver
10934 automatically selects @samp{prefer-atomic} when @option{-pthread}
10935 is present in the command line.
10937 @item -fsanitize=address
10938 @opindex fsanitize=address
10939 Enable AddressSanitizer, a fast memory error detector.
10940 Memory access instructions are instrumented to detect
10941 out-of-bounds and use-after-free bugs.
10942 The option enables @option{-fsanitize-address-use-after-scope}.
10943 See @uref{https://github.com/google/sanitizers/wiki/AddressSanitizer} for
10944 more details.  The run-time behavior can be influenced using the
10945 @env{ASAN_OPTIONS} environment variable.  When set to @code{help=1},
10946 the available options are shown at startup of the instrumented program.  See
10947 @url{https://github.com/google/sanitizers/wiki/AddressSanitizerFlags#run-time-flags}
10948 for a list of supported options.
10949 The option cannot be combined with @option{-fsanitize=thread}
10950 and/or @option{-fcheck-pointer-bounds}.
10952 @item -fsanitize=kernel-address
10953 @opindex fsanitize=kernel-address
10954 Enable AddressSanitizer for Linux kernel.
10955 See @uref{https://github.com/google/kasan/wiki} for more details.
10956 The option cannot be combined with @option{-fcheck-pointer-bounds}.
10958 @item -fsanitize=thread
10959 @opindex fsanitize=thread
10960 Enable ThreadSanitizer, a fast data race detector.
10961 Memory access instructions are instrumented to detect
10962 data race bugs.  See @uref{https://github.com/google/sanitizers/wiki#threadsanitizer} for more
10963 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
10964 environment variable; see
10965 @url{https://github.com/google/sanitizers/wiki/ThreadSanitizerFlags} for a list of
10966 supported options.
10967 The option cannot be combined with @option{-fsanitize=address},
10968 @option{-fsanitize=leak} and/or @option{-fcheck-pointer-bounds}.
10970 Note that sanitized atomic builtins cannot throw exceptions when
10971 operating on invalid memory addresses with non-call exceptions
10972 (@option{-fnon-call-exceptions}).
10974 @item -fsanitize=leak
10975 @opindex fsanitize=leak
10976 Enable LeakSanitizer, a memory leak detector.
10977 This option only matters for linking of executables and
10978 the executable is linked against a library that overrides @code{malloc}
10979 and other allocator functions.  See
10980 @uref{https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer} for more
10981 details.  The run-time behavior can be influenced using the
10982 @env{LSAN_OPTIONS} environment variable.
10983 The option cannot be combined with @option{-fsanitize=thread}.
10985 @item -fsanitize=undefined
10986 @opindex fsanitize=undefined
10987 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
10988 Various computations are instrumented to detect undefined behavior
10989 at runtime.  Current suboptions are:
10991 @table @gcctabopt
10993 @item -fsanitize=shift
10994 @opindex fsanitize=shift
10995 This option enables checking that the result of a shift operation is
10996 not undefined.  Note that what exactly is considered undefined differs
10997 slightly between C and C++, as well as between ISO C90 and C99, etc.
10998 This option has two suboptions, @option{-fsanitize=shift-base} and
10999 @option{-fsanitize=shift-exponent}.
11001 @item -fsanitize=shift-exponent
11002 @opindex fsanitize=shift-exponent
11003 This option enables checking that the second argument of a shift operation
11004 is not negative and is smaller than the precision of the promoted first
11005 argument.
11007 @item -fsanitize=shift-base
11008 @opindex fsanitize=shift-base
11009 If the second argument of a shift operation is within range, check that the
11010 result of a shift operation is not undefined.  Note that what exactly is
11011 considered undefined differs slightly between C and C++, as well as between
11012 ISO C90 and C99, etc.
11014 @item -fsanitize=integer-divide-by-zero
11015 @opindex fsanitize=integer-divide-by-zero
11016 Detect integer division by zero as well as @code{INT_MIN / -1} division.
11018 @item -fsanitize=unreachable
11019 @opindex fsanitize=unreachable
11020 With this option, the compiler turns the @code{__builtin_unreachable}
11021 call into a diagnostics message call instead.  When reaching the
11022 @code{__builtin_unreachable} call, the behavior is undefined.
11024 @item -fsanitize=vla-bound
11025 @opindex fsanitize=vla-bound
11026 This option instructs the compiler to check that the size of a variable
11027 length array is positive.
11029 @item -fsanitize=null
11030 @opindex fsanitize=null
11031 This option enables pointer checking.  Particularly, the application
11032 built with this option turned on will issue an error message when it
11033 tries to dereference a NULL pointer, or if a reference (possibly an
11034 rvalue reference) is bound to a NULL pointer, or if a method is invoked
11035 on an object pointed by a NULL pointer.
11037 @item -fsanitize=return
11038 @opindex fsanitize=return
11039 This option enables return statement checking.  Programs
11040 built with this option turned on will issue an error message
11041 when the end of a non-void function is reached without actually
11042 returning a value.  This option works in C++ only.
11044 @item -fsanitize=signed-integer-overflow
11045 @opindex fsanitize=signed-integer-overflow
11046 This option enables signed integer overflow checking.  We check that
11047 the result of @code{+}, @code{*}, and both unary and binary @code{-}
11048 does not overflow in the signed arithmetics.  Note, integer promotion
11049 rules must be taken into account.  That is, the following is not an
11050 overflow:
11051 @smallexample
11052 signed char a = SCHAR_MAX;
11053 a++;
11054 @end smallexample
11056 @item -fsanitize=bounds
11057 @opindex fsanitize=bounds
11058 This option enables instrumentation of array bounds.  Various out of bounds
11059 accesses are detected.  Flexible array members, flexible array member-like
11060 arrays, and initializers of variables with static storage are not instrumented.
11061 The option cannot be combined with @option{-fcheck-pointer-bounds}.
11063 @item -fsanitize=bounds-strict
11064 @opindex fsanitize=bounds-strict
11065 This option enables strict instrumentation of array bounds.  Most out of bounds
11066 accesses are detected, including flexible array members and flexible array
11067 member-like arrays.  Initializers of variables with static storage are not
11068 instrumented.  The option cannot be combined
11069 with @option{-fcheck-pointer-bounds}.
11071 @item -fsanitize=alignment
11072 @opindex fsanitize=alignment
11074 This option enables checking of alignment of pointers when they are
11075 dereferenced, or when a reference is bound to insufficiently aligned target,
11076 or when a method or constructor is invoked on insufficiently aligned object.
11078 @item -fsanitize=object-size
11079 @opindex fsanitize=object-size
11080 This option enables instrumentation of memory references using the
11081 @code{__builtin_object_size} function.  Various out of bounds pointer
11082 accesses are detected.
11084 @item -fsanitize=float-divide-by-zero
11085 @opindex fsanitize=float-divide-by-zero
11086 Detect floating-point division by zero.  Unlike other similar options,
11087 @option{-fsanitize=float-divide-by-zero} is not enabled by
11088 @option{-fsanitize=undefined}, since floating-point division by zero can
11089 be a legitimate way of obtaining infinities and NaNs.
11091 @item -fsanitize=float-cast-overflow
11092 @opindex fsanitize=float-cast-overflow
11093 This option enables floating-point type to integer conversion checking.
11094 We check that the result of the conversion does not overflow.
11095 Unlike other similar options, @option{-fsanitize=float-cast-overflow} is
11096 not enabled by @option{-fsanitize=undefined}.
11097 This option does not work well with @code{FE_INVALID} exceptions enabled.
11099 @item -fsanitize=nonnull-attribute
11100 @opindex fsanitize=nonnull-attribute
11102 This option enables instrumentation of calls, checking whether null values
11103 are not passed to arguments marked as requiring a non-null value by the
11104 @code{nonnull} function attribute.
11106 @item -fsanitize=returns-nonnull-attribute
11107 @opindex fsanitize=returns-nonnull-attribute
11109 This option enables instrumentation of return statements in functions
11110 marked with @code{returns_nonnull} function attribute, to detect returning
11111 of null values from such functions.
11113 @item -fsanitize=bool
11114 @opindex fsanitize=bool
11116 This option enables instrumentation of loads from bool.  If a value other
11117 than 0/1 is loaded, a run-time error is issued.
11119 @item -fsanitize=enum
11120 @opindex fsanitize=enum
11122 This option enables instrumentation of loads from an enum type.  If
11123 a value outside the range of values for the enum type is loaded,
11124 a run-time error is issued.
11126 @item -fsanitize=vptr
11127 @opindex fsanitize=vptr
11129 This option enables instrumentation of C++ member function calls, member
11130 accesses and some conversions between pointers to base and derived classes,
11131 to verify the referenced object has the correct dynamic type.
11133 @item -fsanitize=pointer-overflow
11134 @opindex fsanitize=pointer-overflow
11136 This option enables instrumentation of pointer arithmetics.  If the pointer
11137 arithmetics overflows, a run-time error is issued.
11139 @end table
11141 While @option{-ftrapv} causes traps for signed overflows to be emitted,
11142 @option{-fsanitize=undefined} gives a diagnostic message.
11143 This currently works only for the C family of languages.
11145 @item -fno-sanitize=all
11146 @opindex fno-sanitize=all
11148 This option disables all previously enabled sanitizers.
11149 @option{-fsanitize=all} is not allowed, as some sanitizers cannot be used
11150 together.
11152 @item -fasan-shadow-offset=@var{number}
11153 @opindex fasan-shadow-offset
11154 This option forces GCC to use custom shadow offset in AddressSanitizer checks.
11155 It is useful for experimenting with different shadow memory layouts in
11156 Kernel AddressSanitizer.
11158 @item -fsanitize-sections=@var{s1},@var{s2},...
11159 @opindex fsanitize-sections
11160 Sanitize global variables in selected user-defined sections.  @var{si} may
11161 contain wildcards.
11163 @item -fsanitize-recover@r{[}=@var{opts}@r{]}
11164 @opindex fsanitize-recover
11165 @opindex fno-sanitize-recover
11166 @option{-fsanitize-recover=} controls error recovery mode for sanitizers
11167 mentioned in comma-separated list of @var{opts}.  Enabling this option
11168 for a sanitizer component causes it to attempt to continue
11169 running the program as if no error happened.  This means multiple
11170 runtime errors can be reported in a single program run, and the exit
11171 code of the program may indicate success even when errors
11172 have been reported.  The @option{-fno-sanitize-recover=} option
11173 can be used to alter
11174 this behavior: only the first detected error is reported
11175 and program then exits with a non-zero exit code.
11177 Currently this feature only works for @option{-fsanitize=undefined} (and its suboptions
11178 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return}),
11179 @option{-fsanitize=float-cast-overflow}, @option{-fsanitize=float-divide-by-zero},
11180 @option{-fsanitize=bounds-strict},
11181 @option{-fsanitize=kernel-address} and @option{-fsanitize=address}.
11182 For these sanitizers error recovery is turned on by default,
11183 except @option{-fsanitize=address}, for which this feature is experimental.
11184 @option{-fsanitize-recover=all} and @option{-fno-sanitize-recover=all} is also
11185 accepted, the former enables recovery for all sanitizers that support it,
11186 the latter disables recovery for all sanitizers that support it.
11188 Even if a recovery mode is turned on the compiler side, it needs to be also
11189 enabled on the runtime library side, otherwise the failures are still fatal.
11190 The runtime library defaults to @code{halt_on_error=0} for
11191 ThreadSanitizer and UndefinedBehaviorSanitizer, while default value for
11192 AddressSanitizer is @code{halt_on_error=1}. This can be overridden through
11193 setting the @code{halt_on_error} flag in the corresponding environment variable.
11195 Syntax without an explicit @var{opts} parameter is deprecated.  It is
11196 equivalent to specifying an @var{opts} list of:
11198 @smallexample
11199 undefined,float-cast-overflow,float-divide-by-zero,bounds-strict
11200 @end smallexample
11202 @item -fsanitize-address-use-after-scope
11203 @opindex fsanitize-address-use-after-scope
11204 Enable sanitization of local variables to detect use-after-scope bugs.
11205 The option sets @option{-fstack-reuse} to @samp{none}.
11207 @item -fsanitize-undefined-trap-on-error
11208 @opindex fsanitize-undefined-trap-on-error
11209 The @option{-fsanitize-undefined-trap-on-error} option instructs the compiler to
11210 report undefined behavior using @code{__builtin_trap} rather than
11211 a @code{libubsan} library routine.  The advantage of this is that the
11212 @code{libubsan} library is not needed and is not linked in, so this
11213 is usable even in freestanding environments.
11215 @item -fsanitize-coverage=trace-pc
11216 @opindex fsanitize-coverage=trace-pc
11217 Enable coverage-guided fuzzing code instrumentation.
11218 Inserts a call to @code{__sanitizer_cov_trace_pc} into every basic block.
11220 @item -fsanitize-coverage=trace-cmp
11221 @opindex fsanitize-coverage=trace-cmp
11222 Enable dataflow guided fuzzing code instrumentation.
11223 Inserts a call to @code{__sanitizer_cov_trace_cmp1},
11224 @code{__sanitizer_cov_trace_cmp2}, @code{__sanitizer_cov_trace_cmp4} or
11225 @code{__sanitizer_cov_trace_cmp8} for integral comparison with both operands
11226 variable or @code{__sanitizer_cov_trace_const_cmp1},
11227 @code{__sanitizer_cov_trace_const_cmp2},
11228 @code{__sanitizer_cov_trace_const_cmp4} or
11229 @code{__sanitizer_cov_trace_const_cmp8} for integral comparison with one
11230 operand constant, @code{__sanitizer_cov_trace_cmpf} or
11231 @code{__sanitizer_cov_trace_cmpd} for float or double comparisons and
11232 @code{__sanitizer_cov_trace_switch} for switch statements.
11234 @item -fbounds-check
11235 @opindex fbounds-check
11236 For front ends that support it, generate additional code to check that
11237 indices used to access arrays are within the declared range.  This is
11238 currently only supported by the Fortran front end, where this option
11239 defaults to false.
11241 @item -fcheck-pointer-bounds
11242 @opindex fcheck-pointer-bounds
11243 @opindex fno-check-pointer-bounds
11244 @cindex Pointer Bounds Checker options
11245 Enable Pointer Bounds Checker instrumentation.  Each memory reference
11246 is instrumented with checks of the pointer used for memory access against
11247 bounds associated with that pointer.  
11249 Currently there
11250 is only an implementation for Intel MPX available, thus x86 GNU/Linux target
11251 and @option{-mmpx} are required to enable this feature.  
11252 MPX-based instrumentation requires
11253 a runtime library to enable MPX in hardware and handle bounds
11254 violation signals.  By default when @option{-fcheck-pointer-bounds}
11255 and @option{-mmpx} options are used to link a program, the GCC driver
11256 links against the @file{libmpx} and @file{libmpxwrappers} libraries.
11257 Bounds checking on calls to dynamic libraries requires a linker
11258 with @option{-z bndplt} support; if GCC was configured with a linker
11259 without support for this option (including the Gold linker and older
11260 versions of ld), a warning is given if you link with @option{-mmpx}
11261 without also specifying @option{-static}, since the overall effectiveness
11262 of the bounds checking protection is reduced.
11263 See also @option{-static-libmpxwrappers}.
11265 MPX-based instrumentation
11266 may be used for debugging and also may be included in production code
11267 to increase program security.  Depending on usage, you may
11268 have different requirements for the runtime library.  The current version
11269 of the MPX runtime library is more oriented for use as a debugging
11270 tool.  MPX runtime library usage implies @option{-lpthread}.  See
11271 also @option{-static-libmpx}.  The runtime library  behavior can be
11272 influenced using various @env{CHKP_RT_*} environment variables.  See
11273 @uref{https://gcc.gnu.org/wiki/Intel%20MPX%20support%20in%20the%20GCC%20compiler}
11274 for more details.
11276 Generated instrumentation may be controlled by various
11277 @option{-fchkp-*} options and by the @code{bnd_variable_size}
11278 structure field attribute (@pxref{Type Attributes}) and
11279 @code{bnd_legacy}, and @code{bnd_instrument} function attributes
11280 (@pxref{Function Attributes}).  GCC also provides a number of built-in
11281 functions for controlling the Pointer Bounds Checker.  @xref{Pointer
11282 Bounds Checker builtins}, for more information.
11284 @item -fchkp-check-incomplete-type
11285 @opindex fchkp-check-incomplete-type
11286 @opindex fno-chkp-check-incomplete-type
11287 Generate pointer bounds checks for variables with incomplete type.
11288 Enabled by default.
11290 @item -fchkp-narrow-bounds
11291 @opindex fchkp-narrow-bounds
11292 @opindex fno-chkp-narrow-bounds
11293 Controls bounds used by Pointer Bounds Checker for pointers to object
11294 fields.  If narrowing is enabled then field bounds are used.  Otherwise
11295 object bounds are used.  See also @option{-fchkp-narrow-to-innermost-array}
11296 and @option{-fchkp-first-field-has-own-bounds}.  Enabled by default.
11298 @item -fchkp-first-field-has-own-bounds
11299 @opindex fchkp-first-field-has-own-bounds
11300 @opindex fno-chkp-first-field-has-own-bounds
11301 Forces Pointer Bounds Checker to use narrowed bounds for the address of the
11302 first field in the structure.  By default a pointer to the first field has
11303 the same bounds as a pointer to the whole structure.
11305 @item -fchkp-flexible-struct-trailing-arrays
11306 @opindex fchkp-flexible-struct-trailing-arrays
11307 @opindex fno-chkp-flexible-struct-trailing-arrays
11308 Forces Pointer Bounds Checker to treat all trailing arrays in structures as
11309 possibly flexible.  By default only array fields with zero length or that are
11310 marked with attribute bnd_variable_size are treated as flexible.
11312 @item -fchkp-narrow-to-innermost-array
11313 @opindex fchkp-narrow-to-innermost-array
11314 @opindex fno-chkp-narrow-to-innermost-array
11315 Forces Pointer Bounds Checker to use bounds of the innermost arrays in
11316 case of nested static array access.  By default this option is disabled and
11317 bounds of the outermost array are used.
11319 @item -fchkp-optimize
11320 @opindex fchkp-optimize
11321 @opindex fno-chkp-optimize
11322 Enables Pointer Bounds Checker optimizations.  Enabled by default at
11323 optimization levels @option{-O}, @option{-O2}, @option{-O3}.
11325 @item -fchkp-use-fast-string-functions
11326 @opindex fchkp-use-fast-string-functions
11327 @opindex fno-chkp-use-fast-string-functions
11328 Enables use of @code{*_nobnd} versions of string functions (not copying bounds)
11329 by Pointer Bounds Checker.  Disabled by default.
11331 @item -fchkp-use-nochk-string-functions
11332 @opindex fchkp-use-nochk-string-functions
11333 @opindex fno-chkp-use-nochk-string-functions
11334 Enables use of @code{*_nochk} versions of string functions (not checking bounds)
11335 by Pointer Bounds Checker.  Disabled by default.
11337 @item -fchkp-use-static-bounds
11338 @opindex fchkp-use-static-bounds
11339 @opindex fno-chkp-use-static-bounds
11340 Allow Pointer Bounds Checker to generate static bounds holding
11341 bounds of static variables.  Enabled by default.
11343 @item -fchkp-use-static-const-bounds
11344 @opindex fchkp-use-static-const-bounds
11345 @opindex fno-chkp-use-static-const-bounds
11346 Use statically-initialized bounds for constant bounds instead of
11347 generating them each time they are required.  By default enabled when
11348 @option{-fchkp-use-static-bounds} is enabled.
11350 @item -fchkp-treat-zero-dynamic-size-as-infinite
11351 @opindex fchkp-treat-zero-dynamic-size-as-infinite
11352 @opindex fno-chkp-treat-zero-dynamic-size-as-infinite
11353 With this option, objects with incomplete type whose
11354 dynamically-obtained size is zero are treated as having infinite size
11355 instead by Pointer Bounds
11356 Checker.  This option may be helpful if a program is linked with a library
11357 missing size information for some symbols.  Disabled by default.
11359 @item -fchkp-check-read
11360 @opindex fchkp-check-read
11361 @opindex fno-chkp-check-read
11362 Instructs Pointer Bounds Checker to generate checks for all read
11363 accesses to memory.  Enabled by default.
11365 @item -fchkp-check-write
11366 @opindex fchkp-check-write
11367 @opindex fno-chkp-check-write
11368 Instructs Pointer Bounds Checker to generate checks for all write
11369 accesses to memory.  Enabled by default.
11371 @item -fchkp-store-bounds
11372 @opindex fchkp-store-bounds
11373 @opindex fno-chkp-store-bounds
11374 Instructs Pointer Bounds Checker to generate bounds stores for
11375 pointer writes.  Enabled by default.
11377 @item -fchkp-instrument-calls
11378 @opindex fchkp-instrument-calls
11379 @opindex fno-chkp-instrument-calls
11380 Instructs Pointer Bounds Checker to pass pointer bounds to calls.
11381 Enabled by default.
11383 @item -fchkp-instrument-marked-only
11384 @opindex fchkp-instrument-marked-only
11385 @opindex fno-chkp-instrument-marked-only
11386 Instructs Pointer Bounds Checker to instrument only functions
11387 marked with the @code{bnd_instrument} attribute
11388 (@pxref{Function Attributes}).  Disabled by default.
11390 @item -fchkp-use-wrappers
11391 @opindex fchkp-use-wrappers
11392 @opindex fno-chkp-use-wrappers
11393 Allows Pointer Bounds Checker to replace calls to built-in functions
11394 with calls to wrapper functions.  When @option{-fchkp-use-wrappers}
11395 is used to link a program, the GCC driver automatically links
11396 against @file{libmpxwrappers}.  See also @option{-static-libmpxwrappers}.
11397 Enabled by default.
11399 @item -fstack-protector
11400 @opindex fstack-protector
11401 Emit extra code to check for buffer overflows, such as stack smashing
11402 attacks.  This is done by adding a guard variable to functions with
11403 vulnerable objects.  This includes functions that call @code{alloca}, and
11404 functions with buffers larger than 8 bytes.  The guards are initialized
11405 when a function is entered and then checked when the function exits.
11406 If a guard check fails, an error message is printed and the program exits.
11408 @item -fstack-protector-all
11409 @opindex fstack-protector-all
11410 Like @option{-fstack-protector} except that all functions are protected.
11412 @item -fstack-protector-strong
11413 @opindex fstack-protector-strong
11414 Like @option{-fstack-protector} but includes additional functions to
11415 be protected --- those that have local array definitions, or have
11416 references to local frame addresses.
11418 @item -fstack-protector-explicit
11419 @opindex fstack-protector-explicit
11420 Like @option{-fstack-protector} but only protects those functions which
11421 have the @code{stack_protect} attribute.
11423 @item -fstack-check
11424 @opindex fstack-check
11425 Generate code to verify that you do not go beyond the boundary of the
11426 stack.  You should specify this flag if you are running in an
11427 environment with multiple threads, but you only rarely need to specify it in
11428 a single-threaded environment since stack overflow is automatically
11429 detected on nearly all systems if there is only one stack.
11431 Note that this switch does not actually cause checking to be done; the
11432 operating system or the language runtime must do that.  The switch causes
11433 generation of code to ensure that they see the stack being extended.
11435 You can additionally specify a string parameter: @samp{no} means no
11436 checking, @samp{generic} means force the use of old-style checking,
11437 @samp{specific} means use the best checking method and is equivalent
11438 to bare @option{-fstack-check}.
11440 Old-style checking is a generic mechanism that requires no specific
11441 target support in the compiler but comes with the following drawbacks:
11443 @enumerate
11444 @item
11445 Modified allocation strategy for large objects: they are always
11446 allocated dynamically if their size exceeds a fixed threshold.  Note this
11447 may change the semantics of some code.
11449 @item
11450 Fixed limit on the size of the static frame of functions: when it is
11451 topped by a particular function, stack checking is not reliable and
11452 a warning is issued by the compiler.
11454 @item
11455 Inefficiency: because of both the modified allocation strategy and the
11456 generic implementation, code performance is hampered.
11457 @end enumerate
11459 Note that old-style stack checking is also the fallback method for
11460 @samp{specific} if no target support has been added in the compiler.
11462 @samp{-fstack-check=} is designed for Ada's needs to detect infinite recursion
11463 and stack overflows.  @samp{specific} is an excellent choice when compiling
11464 Ada code.  It is not generally sufficient to protect against stack-clash
11465 attacks.  To protect against those you want @samp{-fstack-clash-protection}.
11467 @item -fstack-clash-protection
11468 @opindex fstack-clash-protection
11469 Generate code to prevent stack clash style attacks.  When this option is
11470 enabled, the compiler will only allocate one page of stack space at a time
11471 and each page is accessed immediately after allocation.  Thus, it prevents
11472 allocations from jumping over any stack guard page provided by the
11473 operating system.
11475 Most targets do not fully support stack clash protection.  However, on
11476 those targets @option{-fstack-clash-protection} will protect dynamic stack
11477 allocations.  @option{-fstack-clash-protection} may also provide limited
11478 protection for static stack allocations if the target supports
11479 @option{-fstack-check=specific}.
11481 @item -fstack-limit-register=@var{reg}
11482 @itemx -fstack-limit-symbol=@var{sym}
11483 @itemx -fno-stack-limit
11484 @opindex fstack-limit-register
11485 @opindex fstack-limit-symbol
11486 @opindex fno-stack-limit
11487 Generate code to ensure that the stack does not grow beyond a certain value,
11488 either the value of a register or the address of a symbol.  If a larger
11489 stack is required, a signal is raised at run time.  For most targets,
11490 the signal is raised before the stack overruns the boundary, so
11491 it is possible to catch the signal without taking special precautions.
11493 For instance, if the stack starts at absolute address @samp{0x80000000}
11494 and grows downwards, you can use the flags
11495 @option{-fstack-limit-symbol=__stack_limit} and
11496 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11497 of 128KB@.  Note that this may only work with the GNU linker.
11499 You can locally override stack limit checking by using the
11500 @code{no_stack_limit} function attribute (@pxref{Function Attributes}).
11502 @item -fsplit-stack
11503 @opindex fsplit-stack
11504 Generate code to automatically split the stack before it overflows.
11505 The resulting program has a discontiguous stack which can only
11506 overflow if the program is unable to allocate any more memory.  This
11507 is most useful when running threaded programs, as it is no longer
11508 necessary to calculate a good stack size to use for each thread.  This
11509 is currently only implemented for the x86 targets running
11510 GNU/Linux.
11512 When code compiled with @option{-fsplit-stack} calls code compiled
11513 without @option{-fsplit-stack}, there may not be much stack space
11514 available for the latter code to run.  If compiling all code,
11515 including library code, with @option{-fsplit-stack} is not an option,
11516 then the linker can fix up these calls so that the code compiled
11517 without @option{-fsplit-stack} always has a large stack.  Support for
11518 this is implemented in the gold linker in GNU binutils release 2.21
11519 and later.
11521 @item -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]}
11522 @opindex fvtable-verify
11523 This option is only available when compiling C++ code.
11524 It turns on (or off, if using @option{-fvtable-verify=none}) the security
11525 feature that verifies at run time, for every virtual call, that
11526 the vtable pointer through which the call is made is valid for the type of
11527 the object, and has not been corrupted or overwritten.  If an invalid vtable
11528 pointer is detected at run time, an error is reported and execution of the
11529 program is immediately halted.
11531 This option causes run-time data structures to be built at program startup,
11532 which are used for verifying the vtable pointers.  
11533 The options @samp{std} and @samp{preinit}
11534 control the timing of when these data structures are built.  In both cases the
11535 data structures are built before execution reaches @code{main}.  Using
11536 @option{-fvtable-verify=std} causes the data structures to be built after
11537 shared libraries have been loaded and initialized.
11538 @option{-fvtable-verify=preinit} causes them to be built before shared
11539 libraries have been loaded and initialized.
11541 If this option appears multiple times in the command line with different
11542 values specified, @samp{none} takes highest priority over both @samp{std} and
11543 @samp{preinit}; @samp{preinit} takes priority over @samp{std}.
11545 @item -fvtv-debug
11546 @opindex fvtv-debug
11547 When used in conjunction with @option{-fvtable-verify=std} or 
11548 @option{-fvtable-verify=preinit}, causes debug versions of the 
11549 runtime functions for the vtable verification feature to be called.  
11550 This flag also causes the compiler to log information about which 
11551 vtable pointers it finds for each class.
11552 This information is written to a file named @file{vtv_set_ptr_data.log} 
11553 in the directory named by the environment variable @env{VTV_LOGS_DIR} 
11554 if that is defined or the current working directory otherwise.
11556 Note:  This feature @emph{appends} data to the log file. If you want a fresh log
11557 file, be sure to delete any existing one.
11559 @item -fvtv-counts
11560 @opindex fvtv-counts
11561 This is a debugging flag.  When used in conjunction with
11562 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
11563 causes the compiler to keep track of the total number of virtual calls
11564 it encounters and the number of verifications it inserts.  It also
11565 counts the number of calls to certain run-time library functions
11566 that it inserts and logs this information for each compilation unit.
11567 The compiler writes this information to a file named
11568 @file{vtv_count_data.log} in the directory named by the environment
11569 variable @env{VTV_LOGS_DIR} if that is defined or the current working
11570 directory otherwise.  It also counts the size of the vtable pointer sets
11571 for each class, and writes this information to @file{vtv_class_set_sizes.log}
11572 in the same directory.
11574 Note:  This feature @emph{appends} data to the log files.  To get fresh log
11575 files, be sure to delete any existing ones.
11577 @item -finstrument-functions
11578 @opindex finstrument-functions
11579 Generate instrumentation calls for entry and exit to functions.  Just
11580 after function entry and just before function exit, the following
11581 profiling functions are called with the address of the current
11582 function and its call site.  (On some platforms,
11583 @code{__builtin_return_address} does not work beyond the current
11584 function, so the call site information may not be available to the
11585 profiling functions otherwise.)
11587 @smallexample
11588 void __cyg_profile_func_enter (void *this_fn,
11589                                void *call_site);
11590 void __cyg_profile_func_exit  (void *this_fn,
11591                                void *call_site);
11592 @end smallexample
11594 The first argument is the address of the start of the current function,
11595 which may be looked up exactly in the symbol table.
11597 This instrumentation is also done for functions expanded inline in other
11598 functions.  The profiling calls indicate where, conceptually, the
11599 inline function is entered and exited.  This means that addressable
11600 versions of such functions must be available.  If all your uses of a
11601 function are expanded inline, this may mean an additional expansion of
11602 code size.  If you use @code{extern inline} in your C code, an
11603 addressable version of such functions must be provided.  (This is
11604 normally the case anyway, but if you get lucky and the optimizer always
11605 expands the functions inline, you might have gotten away without
11606 providing static copies.)
11608 A function may be given the attribute @code{no_instrument_function}, in
11609 which case this instrumentation is not done.  This can be used, for
11610 example, for the profiling functions listed above, high-priority
11611 interrupt routines, and any functions from which the profiling functions
11612 cannot safely be called (perhaps signal handlers, if the profiling
11613 routines generate output or allocate memory).
11615 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
11616 @opindex finstrument-functions-exclude-file-list
11618 Set the list of functions that are excluded from instrumentation (see
11619 the description of @option{-finstrument-functions}).  If the file that
11620 contains a function definition matches with one of @var{file}, then
11621 that function is not instrumented.  The match is done on substrings:
11622 if the @var{file} parameter is a substring of the file name, it is
11623 considered to be a match.
11625 For example:
11627 @smallexample
11628 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
11629 @end smallexample
11631 @noindent
11632 excludes any inline function defined in files whose pathnames
11633 contain @file{/bits/stl} or @file{include/sys}.
11635 If, for some reason, you want to include letter @samp{,} in one of
11636 @var{sym}, write @samp{\,}. For example,
11637 @option{-finstrument-functions-exclude-file-list='\,\,tmp'}
11638 (note the single quote surrounding the option).
11640 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
11641 @opindex finstrument-functions-exclude-function-list
11643 This is similar to @option{-finstrument-functions-exclude-file-list},
11644 but this option sets the list of function names to be excluded from
11645 instrumentation.  The function name to be matched is its user-visible
11646 name, such as @code{vector<int> blah(const vector<int> &)}, not the
11647 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
11648 match is done on substrings: if the @var{sym} parameter is a substring
11649 of the function name, it is considered to be a match.  For C99 and C++
11650 extended identifiers, the function name must be given in UTF-8, not
11651 using universal character names.
11653 @item -fpatchable-function-entry=@var{N}[,@var{M}]
11654 @opindex fpatchable-function-entry
11655 Generate @var{N} NOPs right at the beginning
11656 of each function, with the function entry point before the @var{M}th NOP.
11657 If @var{M} is omitted, it defaults to @code{0} so the
11658 function entry points to the address just at the first NOP.
11659 The NOP instructions reserve extra space which can be used to patch in
11660 any desired instrumentation at run time, provided that the code segment
11661 is writable.  The amount of space is controllable indirectly via
11662 the number of NOPs; the NOP instruction used corresponds to the instruction
11663 emitted by the internal GCC back-end interface @code{gen_nop}.  This behavior
11664 is target-specific and may also depend on the architecture variant and/or
11665 other compilation options.
11667 For run-time identification, the starting addresses of these areas,
11668 which correspond to their respective function entries minus @var{M},
11669 are additionally collected in the @code{__patchable_function_entries}
11670 section of the resulting binary.
11672 Note that the value of @code{__attribute__ ((patchable_function_entry
11673 (N,M)))} takes precedence over command-line option
11674 @option{-fpatchable-function-entry=N,M}.  This can be used to increase
11675 the area size or to remove it completely on a single function.
11676 If @code{N=0}, no pad location is recorded.
11678 The NOP instructions are inserted at---and maybe before, depending on
11679 @var{M}---the function entry address, even before the prologue.
11681 @end table
11684 @node Preprocessor Options
11685 @section Options Controlling the Preprocessor
11686 @cindex preprocessor options
11687 @cindex options, preprocessor
11689 These options control the C preprocessor, which is run on each C source
11690 file before actual compilation.
11692 If you use the @option{-E} option, nothing is done except preprocessing.
11693 Some of these options make sense only together with @option{-E} because
11694 they cause the preprocessor output to be unsuitable for actual
11695 compilation.
11697 In addition to the options listed here, there are a number of options 
11698 to control search paths for include files documented in 
11699 @ref{Directory Options}.  
11700 Options to control preprocessor diagnostics are listed in 
11701 @ref{Warning Options}.
11703 @table @gcctabopt
11704 @include cppopts.texi
11706 @item -Wp,@var{option}
11707 @opindex Wp
11708 You can use @option{-Wp,@var{option}} to bypass the compiler driver
11709 and pass @var{option} directly through to the preprocessor.  If
11710 @var{option} contains commas, it is split into multiple options at the
11711 commas.  However, many options are modified, translated or interpreted
11712 by the compiler driver before being passed to the preprocessor, and
11713 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
11714 interface is undocumented and subject to change, so whenever possible
11715 you should avoid using @option{-Wp} and let the driver handle the
11716 options instead.
11718 @item -Xpreprocessor @var{option}
11719 @opindex Xpreprocessor
11720 Pass @var{option} as an option to the preprocessor.  You can use this to
11721 supply system-specific preprocessor options that GCC does not 
11722 recognize.
11724 If you want to pass an option that takes an argument, you must use
11725 @option{-Xpreprocessor} twice, once for the option and once for the argument.
11727 @item -no-integrated-cpp
11728 @opindex no-integrated-cpp
11729 Perform preprocessing as a separate pass before compilation.
11730 By default, GCC performs preprocessing as an integrated part of
11731 input tokenization and parsing.
11732 If this option is provided, the appropriate language front end
11733 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
11734 and Objective-C, respectively) is instead invoked twice,
11735 once for preprocessing only and once for actual compilation
11736 of the preprocessed input.
11737 This option may be useful in conjunction with the @option{-B} or
11738 @option{-wrapper} options to specify an alternate preprocessor or
11739 perform additional processing of the program source between
11740 normal preprocessing and compilation.
11742 @end table
11744 @node Assembler Options
11745 @section Passing Options to the Assembler
11747 @c prevent bad page break with this line
11748 You can pass options to the assembler.
11750 @table @gcctabopt
11751 @item -Wa,@var{option}
11752 @opindex Wa
11753 Pass @var{option} as an option to the assembler.  If @var{option}
11754 contains commas, it is split into multiple options at the commas.
11756 @item -Xassembler @var{option}
11757 @opindex Xassembler
11758 Pass @var{option} as an option to the assembler.  You can use this to
11759 supply system-specific assembler options that GCC does not
11760 recognize.
11762 If you want to pass an option that takes an argument, you must use
11763 @option{-Xassembler} twice, once for the option and once for the argument.
11765 @end table
11767 @node Link Options
11768 @section Options for Linking
11769 @cindex link options
11770 @cindex options, linking
11772 These options come into play when the compiler links object files into
11773 an executable output file.  They are meaningless if the compiler is
11774 not doing a link step.
11776 @table @gcctabopt
11777 @cindex file names
11778 @item @var{object-file-name}
11779 A file name that does not end in a special recognized suffix is
11780 considered to name an object file or library.  (Object files are
11781 distinguished from libraries by the linker according to the file
11782 contents.)  If linking is done, these object files are used as input
11783 to the linker.
11785 @item -c
11786 @itemx -S
11787 @itemx -E
11788 @opindex c
11789 @opindex S
11790 @opindex E
11791 If any of these options is used, then the linker is not run, and
11792 object file names should not be used as arguments.  @xref{Overall
11793 Options}.
11795 @item -fuse-ld=bfd
11796 @opindex fuse-ld=bfd
11797 Use the @command{bfd} linker instead of the default linker.
11799 @item -fuse-ld=gold
11800 @opindex fuse-ld=gold
11801 Use the @command{gold} linker instead of the default linker.
11803 @cindex Libraries
11804 @item -l@var{library}
11805 @itemx -l @var{library}
11806 @opindex l
11807 Search the library named @var{library} when linking.  (The second
11808 alternative with the library as a separate argument is only for
11809 POSIX compliance and is not recommended.)
11811 It makes a difference where in the command you write this option; the
11812 linker searches and processes libraries and object files in the order they
11813 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
11814 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
11815 to functions in @samp{z}, those functions may not be loaded.
11817 The linker searches a standard list of directories for the library,
11818 which is actually a file named @file{lib@var{library}.a}.  The linker
11819 then uses this file as if it had been specified precisely by name.
11821 The directories searched include several standard system directories
11822 plus any that you specify with @option{-L}.
11824 Normally the files found this way are library files---archive files
11825 whose members are object files.  The linker handles an archive file by
11826 scanning through it for members which define symbols that have so far
11827 been referenced but not defined.  But if the file that is found is an
11828 ordinary object file, it is linked in the usual fashion.  The only
11829 difference between using an @option{-l} option and specifying a file name
11830 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
11831 and searches several directories.
11833 @item -lobjc
11834 @opindex lobjc
11835 You need this special case of the @option{-l} option in order to
11836 link an Objective-C or Objective-C++ program.
11838 @item -nostartfiles
11839 @opindex nostartfiles
11840 Do not use the standard system startup files when linking.
11841 The standard system libraries are used normally, unless @option{-nostdlib}
11842 or @option{-nodefaultlibs} is used.
11844 @item -nodefaultlibs
11845 @opindex nodefaultlibs
11846 Do not use the standard system libraries when linking.
11847 Only the libraries you specify are passed to the linker, and options
11848 specifying linkage of the system libraries, such as @option{-static-libgcc}
11849 or @option{-shared-libgcc}, are ignored.  
11850 The standard startup files are used normally, unless @option{-nostartfiles}
11851 is used.  
11853 The compiler may generate calls to @code{memcmp},
11854 @code{memset}, @code{memcpy} and @code{memmove}.
11855 These entries are usually resolved by entries in
11856 libc.  These entry points should be supplied through some other
11857 mechanism when this option is specified.
11859 @item -nostdlib
11860 @opindex nostdlib
11861 Do not use the standard system startup files or libraries when linking.
11862 No startup files and only the libraries you specify are passed to
11863 the linker, and options specifying linkage of the system libraries, such as
11864 @option{-static-libgcc} or @option{-shared-libgcc}, are ignored.
11866 The compiler may generate calls to @code{memcmp}, @code{memset},
11867 @code{memcpy} and @code{memmove}.
11868 These entries are usually resolved by entries in
11869 libc.  These entry points should be supplied through some other
11870 mechanism when this option is specified.
11872 @cindex @option{-lgcc}, use with @option{-nostdlib}
11873 @cindex @option{-nostdlib} and unresolved references
11874 @cindex unresolved references and @option{-nostdlib}
11875 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
11876 @cindex @option{-nodefaultlibs} and unresolved references
11877 @cindex unresolved references and @option{-nodefaultlibs}
11878 One of the standard libraries bypassed by @option{-nostdlib} and
11879 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
11880 which GCC uses to overcome shortcomings of particular machines, or special
11881 needs for some languages.
11882 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
11883 Collection (GCC) Internals},
11884 for more discussion of @file{libgcc.a}.)
11885 In most cases, you need @file{libgcc.a} even when you want to avoid
11886 other standard libraries.  In other words, when you specify @option{-nostdlib}
11887 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
11888 This ensures that you have no unresolved references to internal GCC
11889 library subroutines.
11890 (An example of such an internal subroutine is @code{__main}, used to ensure C++
11891 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
11892 GNU Compiler Collection (GCC) Internals}.)
11894 @item -pie
11895 @opindex pie
11896 Produce a dynamically linked position independent executable on targets
11897 that support it.  For predictable results, you must also specify the same
11898 set of options used for compilation (@option{-fpie}, @option{-fPIE},
11899 or model suboptions) when you specify this linker option.
11901 @item -no-pie
11902 @opindex no-pie
11903 Don't produce a dynamically linked position independent executable.
11905 @item -static-pie
11906 @opindex static-pie
11907 Produce a static position independent executable on targets that support
11908 it.  A static position independent executable is similar to a static
11909 executable, but can be loaded at any address without a dynamic linker.
11910 For predictable results, you must also specify the same set of options
11911 used for compilation (@option{-fpie}, @option{-fPIE}, or model
11912 suboptions) when you specify this linker option.
11914 @item -pthread
11915 @opindex pthread
11916 Link with the POSIX threads library.  This option is supported on 
11917 GNU/Linux targets, most other Unix derivatives, and also on 
11918 x86 Cygwin and MinGW targets.  On some targets this option also sets 
11919 flags for the preprocessor, so it should be used consistently for both
11920 compilation and linking.
11922 @item -rdynamic
11923 @opindex rdynamic
11924 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
11925 that support it. This instructs the linker to add all symbols, not
11926 only used ones, to the dynamic symbol table. This option is needed
11927 for some uses of @code{dlopen} or to allow obtaining backtraces
11928 from within a program.
11930 @item -s
11931 @opindex s
11932 Remove all symbol table and relocation information from the executable.
11934 @item -static
11935 @opindex static
11936 On systems that support dynamic linking, this overrides @option{-pie}
11937 and prevents linking with the shared libraries.  On other systems, this
11938 option has no effect.
11940 @item -shared
11941 @opindex shared
11942 Produce a shared object which can then be linked with other objects to
11943 form an executable.  Not all systems support this option.  For predictable
11944 results, you must also specify the same set of options used for compilation
11945 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
11946 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
11947 needs to build supplementary stub code for constructors to work.  On
11948 multi-libbed systems, @samp{gcc -shared} must select the correct support
11949 libraries to link against.  Failing to supply the correct flags may lead
11950 to subtle defects.  Supplying them in cases where they are not necessary
11951 is innocuous.}
11953 @item -shared-libgcc
11954 @itemx -static-libgcc
11955 @opindex shared-libgcc
11956 @opindex static-libgcc
11957 On systems that provide @file{libgcc} as a shared library, these options
11958 force the use of either the shared or static version, respectively.
11959 If no shared version of @file{libgcc} was built when the compiler was
11960 configured, these options have no effect.
11962 There are several situations in which an application should use the
11963 shared @file{libgcc} instead of the static version.  The most common
11964 of these is when the application wishes to throw and catch exceptions
11965 across different shared libraries.  In that case, each of the libraries
11966 as well as the application itself should use the shared @file{libgcc}.
11968 Therefore, the G++ and driver automatically adds @option{-shared-libgcc}
11969  whenever you build a shared library or a main executable, because C++
11970  programs typically use exceptions, so this is the right thing to do.
11972 If, instead, you use the GCC driver to create shared libraries, you may
11973 find that they are not always linked with the shared @file{libgcc}.
11974 If GCC finds, at its configuration time, that you have a non-GNU linker
11975 or a GNU linker that does not support option @option{--eh-frame-hdr},
11976 it links the shared version of @file{libgcc} into shared libraries
11977 by default.  Otherwise, it takes advantage of the linker and optimizes
11978 away the linking with the shared version of @file{libgcc}, linking with
11979 the static version of libgcc by default.  This allows exceptions to
11980 propagate through such shared libraries, without incurring relocation
11981 costs at library load time.
11983 However, if a library or main executable is supposed to throw or catch
11984 exceptions, you must link it using the G++ driver, as appropriate
11985 for the languages used in the program, or using the option
11986 @option{-shared-libgcc}, such that it is linked with the shared
11987 @file{libgcc}.
11989 @item -static-libasan
11990 @opindex static-libasan
11991 When the @option{-fsanitize=address} option is used to link a program,
11992 the GCC driver automatically links against @option{libasan}.  If
11993 @file{libasan} is available as a shared library, and the @option{-static}
11994 option is not used, then this links against the shared version of
11995 @file{libasan}.  The @option{-static-libasan} option directs the GCC
11996 driver to link @file{libasan} statically, without necessarily linking
11997 other libraries statically.
11999 @item -static-libtsan
12000 @opindex static-libtsan
12001 When the @option{-fsanitize=thread} option is used to link a program,
12002 the GCC driver automatically links against @option{libtsan}.  If
12003 @file{libtsan} is available as a shared library, and the @option{-static}
12004 option is not used, then this links against the shared version of
12005 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
12006 driver to link @file{libtsan} statically, without necessarily linking
12007 other libraries statically.
12009 @item -static-liblsan
12010 @opindex static-liblsan
12011 When the @option{-fsanitize=leak} option is used to link a program,
12012 the GCC driver automatically links against @option{liblsan}.  If
12013 @file{liblsan} is available as a shared library, and the @option{-static}
12014 option is not used, then this links against the shared version of
12015 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
12016 driver to link @file{liblsan} statically, without necessarily linking
12017 other libraries statically.
12019 @item -static-libubsan
12020 @opindex static-libubsan
12021 When the @option{-fsanitize=undefined} option is used to link a program,
12022 the GCC driver automatically links against @option{libubsan}.  If
12023 @file{libubsan} is available as a shared library, and the @option{-static}
12024 option is not used, then this links against the shared version of
12025 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
12026 driver to link @file{libubsan} statically, without necessarily linking
12027 other libraries statically.
12029 @item -static-libmpx
12030 @opindex static-libmpx
12031 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are
12032 used to link a program, the GCC driver automatically links against
12033 @file{libmpx}.  If @file{libmpx} is available as a shared library,
12034 and the @option{-static} option is not used, then this links against
12035 the shared version of @file{libmpx}.  The @option{-static-libmpx}
12036 option directs the GCC driver to link @file{libmpx} statically,
12037 without necessarily linking other libraries statically.
12039 @item -static-libmpxwrappers
12040 @opindex static-libmpxwrappers
12041 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are used
12042 to link a program without also using @option{-fno-chkp-use-wrappers}, the
12043 GCC driver automatically links against @file{libmpxwrappers}.  If
12044 @file{libmpxwrappers} is available as a shared library, and the
12045 @option{-static} option is not used, then this links against the shared
12046 version of @file{libmpxwrappers}.  The @option{-static-libmpxwrappers}
12047 option directs the GCC driver to link @file{libmpxwrappers} statically,
12048 without necessarily linking other libraries statically.
12050 @item -static-libstdc++
12051 @opindex static-libstdc++
12052 When the @command{g++} program is used to link a C++ program, it
12053 normally automatically links against @option{libstdc++}.  If
12054 @file{libstdc++} is available as a shared library, and the
12055 @option{-static} option is not used, then this links against the
12056 shared version of @file{libstdc++}.  That is normally fine.  However, it
12057 is sometimes useful to freeze the version of @file{libstdc++} used by
12058 the program without going all the way to a fully static link.  The
12059 @option{-static-libstdc++} option directs the @command{g++} driver to
12060 link @file{libstdc++} statically, without necessarily linking other
12061 libraries statically.
12063 @item -symbolic
12064 @opindex symbolic
12065 Bind references to global symbols when building a shared object.  Warn
12066 about any unresolved references (unless overridden by the link editor
12067 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
12068 this option.
12070 @item -T @var{script}
12071 @opindex T
12072 @cindex linker script
12073 Use @var{script} as the linker script.  This option is supported by most
12074 systems using the GNU linker.  On some targets, such as bare-board
12075 targets without an operating system, the @option{-T} option may be required
12076 when linking to avoid references to undefined symbols.
12078 @item -Xlinker @var{option}
12079 @opindex Xlinker
12080 Pass @var{option} as an option to the linker.  You can use this to
12081 supply system-specific linker options that GCC does not recognize.
12083 If you want to pass an option that takes a separate argument, you must use
12084 @option{-Xlinker} twice, once for the option and once for the argument.
12085 For example, to pass @option{-assert definitions}, you must write
12086 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
12087 @option{-Xlinker "-assert definitions"}, because this passes the entire
12088 string as a single argument, which is not what the linker expects.
12090 When using the GNU linker, it is usually more convenient to pass
12091 arguments to linker options using the @option{@var{option}=@var{value}}
12092 syntax than as separate arguments.  For example, you can specify
12093 @option{-Xlinker -Map=output.map} rather than
12094 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
12095 this syntax for command-line options.
12097 @item -Wl,@var{option}
12098 @opindex Wl
12099 Pass @var{option} as an option to the linker.  If @var{option} contains
12100 commas, it is split into multiple options at the commas.  You can use this
12101 syntax to pass an argument to the option.
12102 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
12103 linker.  When using the GNU linker, you can also get the same effect with
12104 @option{-Wl,-Map=output.map}.
12106 @item -u @var{symbol}
12107 @opindex u
12108 Pretend the symbol @var{symbol} is undefined, to force linking of
12109 library modules to define it.  You can use @option{-u} multiple times with
12110 different symbols to force loading of additional library modules.
12112 @item -z @var{keyword}
12113 @opindex z
12114 @option{-z} is passed directly on to the linker along with the keyword
12115 @var{keyword}. See the section in the documentation of your linker for
12116 permitted values and their meanings.
12117 @end table
12119 @node Directory Options
12120 @section Options for Directory Search
12121 @cindex directory options
12122 @cindex options, directory search
12123 @cindex search path
12125 These options specify directories to search for header files, for
12126 libraries and for parts of the compiler:
12128 @table @gcctabopt
12129 @include cppdiropts.texi
12131 @item -iplugindir=@var{dir}
12132 @opindex iplugindir=
12133 Set the directory to search for plugins that are passed
12134 by @option{-fplugin=@var{name}} instead of
12135 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
12136 to be used by the user, but only passed by the driver.
12138 @item -L@var{dir}
12139 @opindex L
12140 Add directory @var{dir} to the list of directories to be searched
12141 for @option{-l}.
12143 @item -B@var{prefix}
12144 @opindex B
12145 This option specifies where to find the executables, libraries,
12146 include files, and data files of the compiler itself.
12148 The compiler driver program runs one or more of the subprograms
12149 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
12150 @var{prefix} as a prefix for each program it tries to run, both with and
12151 without @samp{@var{machine}/@var{version}/} for the corresponding target
12152 machine and compiler version.
12154 For each subprogram to be run, the compiler driver first tries the
12155 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
12156 is not specified, the driver tries two standard prefixes, 
12157 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
12158 those results in a file name that is found, the unmodified program
12159 name is searched for using the directories specified in your
12160 @env{PATH} environment variable.
12162 The compiler checks to see if the path provided by @option{-B}
12163 refers to a directory, and if necessary it adds a directory
12164 separator character at the end of the path.
12166 @option{-B} prefixes that effectively specify directory names also apply
12167 to libraries in the linker, because the compiler translates these
12168 options into @option{-L} options for the linker.  They also apply to
12169 include files in the preprocessor, because the compiler translates these
12170 options into @option{-isystem} options for the preprocessor.  In this case,
12171 the compiler appends @samp{include} to the prefix.
12173 The runtime support file @file{libgcc.a} can also be searched for using
12174 the @option{-B} prefix, if needed.  If it is not found there, the two
12175 standard prefixes above are tried, and that is all.  The file is left
12176 out of the link if it is not found by those means.
12178 Another way to specify a prefix much like the @option{-B} prefix is to use
12179 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
12180 Variables}.
12182 As a special kludge, if the path provided by @option{-B} is
12183 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
12184 9, then it is replaced by @file{[dir/]include}.  This is to help
12185 with boot-strapping the compiler.
12187 @item -no-canonical-prefixes
12188 @opindex no-canonical-prefixes
12189 Do not expand any symbolic links, resolve references to @samp{/../}
12190 or @samp{/./}, or make the path absolute when generating a relative
12191 prefix.
12193 @item --sysroot=@var{dir}
12194 @opindex sysroot
12195 Use @var{dir} as the logical root directory for headers and libraries.
12196 For example, if the compiler normally searches for headers in
12197 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
12198 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
12200 If you use both this option and the @option{-isysroot} option, then
12201 the @option{--sysroot} option applies to libraries, but the
12202 @option{-isysroot} option applies to header files.
12204 The GNU linker (beginning with version 2.16) has the necessary support
12205 for this option.  If your linker does not support this option, the
12206 header file aspect of @option{--sysroot} still works, but the
12207 library aspect does not.
12209 @item --no-sysroot-suffix
12210 @opindex no-sysroot-suffix
12211 For some targets, a suffix is added to the root directory specified
12212 with @option{--sysroot}, depending on the other options used, so that
12213 headers may for example be found in
12214 @file{@var{dir}/@var{suffix}/usr/include} instead of
12215 @file{@var{dir}/usr/include}.  This option disables the addition of
12216 such a suffix.
12218 @end table
12220 @node Code Gen Options
12221 @section Options for Code Generation Conventions
12222 @cindex code generation conventions
12223 @cindex options, code generation
12224 @cindex run-time options
12226 These machine-independent options control the interface conventions
12227 used in code generation.
12229 Most of them have both positive and negative forms; the negative form
12230 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
12231 one of the forms is listed---the one that is not the default.  You
12232 can figure out the other form by either removing @samp{no-} or adding
12235 @table @gcctabopt
12236 @item -fstack-reuse=@var{reuse-level}
12237 @opindex fstack_reuse
12238 This option controls stack space reuse for user declared local/auto variables
12239 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
12240 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
12241 local variables and temporaries, @samp{named_vars} enables the reuse only for
12242 user defined local variables with names, and @samp{none} disables stack reuse
12243 completely. The default value is @samp{all}. The option is needed when the
12244 program extends the lifetime of a scoped local variable or a compiler generated
12245 temporary beyond the end point defined by the language.  When a lifetime of
12246 a variable ends, and if the variable lives in memory, the optimizing compiler
12247 has the freedom to reuse its stack space with other temporaries or scoped
12248 local variables whose live range does not overlap with it. Legacy code extending
12249 local lifetime is likely to break with the stack reuse optimization.
12251 For example,
12253 @smallexample
12254    int *p;
12255    @{
12256      int local1;
12258      p = &local1;
12259      local1 = 10;
12260      ....
12261    @}
12262    @{
12263       int local2;
12264       local2 = 20;
12265       ...
12266    @}
12268    if (*p == 10)  // out of scope use of local1
12269      @{
12271      @}
12272 @end smallexample
12274 Another example:
12275 @smallexample
12277    struct A
12278    @{
12279        A(int k) : i(k), j(k) @{ @}
12280        int i;
12281        int j;
12282    @};
12284    A *ap;
12286    void foo(const A& ar)
12287    @{
12288       ap = &ar;
12289    @}
12291    void bar()
12292    @{
12293       foo(A(10)); // temp object's lifetime ends when foo returns
12295       @{
12296         A a(20);
12297         ....
12298       @}
12299       ap->i+= 10;  // ap references out of scope temp whose space
12300                    // is reused with a. What is the value of ap->i?
12301    @}
12303 @end smallexample
12305 The lifetime of a compiler generated temporary is well defined by the C++
12306 standard. When a lifetime of a temporary ends, and if the temporary lives
12307 in memory, the optimizing compiler has the freedom to reuse its stack
12308 space with other temporaries or scoped local variables whose live range
12309 does not overlap with it. However some of the legacy code relies on
12310 the behavior of older compilers in which temporaries' stack space is
12311 not reused, the aggressive stack reuse can lead to runtime errors. This
12312 option is used to control the temporary stack reuse optimization.
12314 @item -ftrapv
12315 @opindex ftrapv
12316 This option generates traps for signed overflow on addition, subtraction,
12317 multiplication operations.
12318 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12319 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12320 @option{-fwrapv} being effective.  Note that only active options override, so
12321 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12322 results in @option{-ftrapv} being effective.
12324 @item -fwrapv
12325 @opindex fwrapv
12326 This option instructs the compiler to assume that signed arithmetic
12327 overflow of addition, subtraction and multiplication wraps around
12328 using twos-complement representation.  This flag enables some optimizations
12329 and disables others.
12330 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12331 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12332 @option{-fwrapv} being effective.  Note that only active options override, so
12333 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12334 results in @option{-ftrapv} being effective.
12336 @item -fexceptions
12337 @opindex fexceptions
12338 Enable exception handling.  Generates extra code needed to propagate
12339 exceptions.  For some targets, this implies GCC generates frame
12340 unwind information for all functions, which can produce significant data
12341 size overhead, although it does not affect execution.  If you do not
12342 specify this option, GCC enables it by default for languages like
12343 C++ that normally require exception handling, and disables it for
12344 languages like C that do not normally require it.  However, you may need
12345 to enable this option when compiling C code that needs to interoperate
12346 properly with exception handlers written in C++.  You may also wish to
12347 disable this option if you are compiling older C++ programs that don't
12348 use exception handling.
12350 @item -fnon-call-exceptions
12351 @opindex fnon-call-exceptions
12352 Generate code that allows trapping instructions to throw exceptions.
12353 Note that this requires platform-specific runtime support that does
12354 not exist everywhere.  Moreover, it only allows @emph{trapping}
12355 instructions to throw exceptions, i.e.@: memory references or floating-point
12356 instructions.  It does not allow exceptions to be thrown from
12357 arbitrary signal handlers such as @code{SIGALRM}.
12359 @item -fdelete-dead-exceptions
12360 @opindex fdelete-dead-exceptions
12361 Consider that instructions that may throw exceptions but don't otherwise
12362 contribute to the execution of the program can be optimized away.
12363 This option is enabled by default for the Ada front end, as permitted by
12364 the Ada language specification.
12365 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
12367 @item -funwind-tables
12368 @opindex funwind-tables
12369 Similar to @option{-fexceptions}, except that it just generates any needed
12370 static data, but does not affect the generated code in any other way.
12371 You normally do not need to enable this option; instead, a language processor
12372 that needs this handling enables it on your behalf.
12374 @item -fasynchronous-unwind-tables
12375 @opindex fasynchronous-unwind-tables
12376 Generate unwind table in DWARF format, if supported by target machine.  The
12377 table is exact at each instruction boundary, so it can be used for stack
12378 unwinding from asynchronous events (such as debugger or garbage collector).
12380 @item -fno-gnu-unique
12381 @opindex fno-gnu-unique
12382 On systems with recent GNU assembler and C library, the C++ compiler
12383 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
12384 of template static data members and static local variables in inline
12385 functions are unique even in the presence of @code{RTLD_LOCAL}; this
12386 is necessary to avoid problems with a library used by two different
12387 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
12388 therefore disagreeing with the other one about the binding of the
12389 symbol.  But this causes @code{dlclose} to be ignored for affected
12390 DSOs; if your program relies on reinitialization of a DSO via
12391 @code{dlclose} and @code{dlopen}, you can use
12392 @option{-fno-gnu-unique}.
12394 @item -fpcc-struct-return
12395 @opindex fpcc-struct-return
12396 Return ``short'' @code{struct} and @code{union} values in memory like
12397 longer ones, rather than in registers.  This convention is less
12398 efficient, but it has the advantage of allowing intercallability between
12399 GCC-compiled files and files compiled with other compilers, particularly
12400 the Portable C Compiler (pcc).
12402 The precise convention for returning structures in memory depends
12403 on the target configuration macros.
12405 Short structures and unions are those whose size and alignment match
12406 that of some integer type.
12408 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12409 switch is not binary compatible with code compiled with the
12410 @option{-freg-struct-return} switch.
12411 Use it to conform to a non-default application binary interface.
12413 @item -freg-struct-return
12414 @opindex freg-struct-return
12415 Return @code{struct} and @code{union} values in registers when possible.
12416 This is more efficient for small structures than
12417 @option{-fpcc-struct-return}.
12419 If you specify neither @option{-fpcc-struct-return} nor
12420 @option{-freg-struct-return}, GCC defaults to whichever convention is
12421 standard for the target.  If there is no standard convention, GCC
12422 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12423 the principal compiler.  In those cases, we can choose the standard, and
12424 we chose the more efficient register return alternative.
12426 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12427 switch is not binary compatible with code compiled with the
12428 @option{-fpcc-struct-return} switch.
12429 Use it to conform to a non-default application binary interface.
12431 @item -fshort-enums
12432 @opindex fshort-enums
12433 Allocate to an @code{enum} type only as many bytes as it needs for the
12434 declared range of possible values.  Specifically, the @code{enum} type
12435 is equivalent to the smallest integer type that has enough room.
12437 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12438 code that is not binary compatible with code generated without that switch.
12439 Use it to conform to a non-default application binary interface.
12441 @item -fshort-wchar
12442 @opindex fshort-wchar
12443 Override the underlying type for @code{wchar_t} to be @code{short
12444 unsigned int} instead of the default for the target.  This option is
12445 useful for building programs to run under WINE@.
12447 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12448 code that is not binary compatible with code generated without that switch.
12449 Use it to conform to a non-default application binary interface.
12451 @item -fno-common
12452 @opindex fno-common
12453 @cindex tentative definitions
12454 In C code, this option controls the placement of global variables 
12455 defined without an initializer, known as @dfn{tentative definitions} 
12456 in the C standard.  Tentative definitions are distinct from declarations 
12457 of a variable with the @code{extern} keyword, which do not allocate storage.
12459 Unix C compilers have traditionally allocated storage for
12460 uninitialized global variables in a common block.  This allows the
12461 linker to resolve all tentative definitions of the same variable
12462 in different compilation units to the same object, or to a non-tentative
12463 definition.  
12464 This is the behavior specified by @option{-fcommon}, and is the default for 
12465 GCC on most targets.  
12466 On the other hand, this behavior is not required by ISO
12467 C, and on some targets may carry a speed or code size penalty on
12468 variable references.
12470 The @option{-fno-common} option specifies that the compiler should instead
12471 place uninitialized global variables in the data section of the object file.
12472 This inhibits the merging of tentative definitions by the linker so
12473 you get a multiple-definition error if the same 
12474 variable is defined in more than one compilation unit.
12475 Compiling with @option{-fno-common} is useful on targets for which
12476 it provides better performance, or if you wish to verify that the
12477 program will work on other systems that always treat uninitialized
12478 variable definitions this way.
12480 @item -fno-ident
12481 @opindex fno-ident
12482 Ignore the @code{#ident} directive.
12484 @item -finhibit-size-directive
12485 @opindex finhibit-size-directive
12486 Don't output a @code{.size} assembler directive, or anything else that
12487 would cause trouble if the function is split in the middle, and the
12488 two halves are placed at locations far apart in memory.  This option is
12489 used when compiling @file{crtstuff.c}; you should not need to use it
12490 for anything else.
12492 @item -fverbose-asm
12493 @opindex fverbose-asm
12494 Put extra commentary information in the generated assembly code to
12495 make it more readable.  This option is generally only of use to those
12496 who actually need to read the generated assembly code (perhaps while
12497 debugging the compiler itself).
12499 @option{-fno-verbose-asm}, the default, causes the
12500 extra information to be omitted and is useful when comparing two assembler
12501 files.
12503 The added comments include:
12505 @itemize @bullet
12507 @item
12508 information on the compiler version and command-line options,
12510 @item
12511 the source code lines associated with the assembly instructions,
12512 in the form FILENAME:LINENUMBER:CONTENT OF LINE,
12514 @item
12515 hints on which high-level expressions correspond to
12516 the various assembly instruction operands.
12518 @end itemize
12520 For example, given this C source file:
12522 @smallexample
12523 int test (int n)
12525   int i;
12526   int total = 0;
12528   for (i = 0; i < n; i++)
12529     total += i * i;
12531   return total;
12533 @end smallexample
12535 compiling to (x86_64) assembly via @option{-S} and emitting the result
12536 direct to stdout via @option{-o} @option{-}
12538 @smallexample
12539 gcc -S test.c -fverbose-asm -Os -o -
12540 @end smallexample
12542 gives output similar to this:
12544 @smallexample
12545         .file   "test.c"
12546 # GNU C11 (GCC) version 7.0.0 20160809 (experimental) (x86_64-pc-linux-gnu)
12547   [...snip...]
12548 # options passed:
12549   [...snip...]
12551         .text
12552         .globl  test
12553         .type   test, @@function
12554 test:
12555 .LFB0:
12556         .cfi_startproc
12557 # test.c:4:   int total = 0;
12558         xorl    %eax, %eax      # <retval>
12559 # test.c:6:   for (i = 0; i < n; i++)
12560         xorl    %edx, %edx      # i
12561 .L2:
12562 # test.c:6:   for (i = 0; i < n; i++)
12563         cmpl    %edi, %edx      # n, i
12564         jge     .L5     #,
12565 # test.c:7:     total += i * i;
12566         movl    %edx, %ecx      # i, tmp92
12567         imull   %edx, %ecx      # i, tmp92
12568 # test.c:6:   for (i = 0; i < n; i++)
12569         incl    %edx    # i
12570 # test.c:7:     total += i * i;
12571         addl    %ecx, %eax      # tmp92, <retval>
12572         jmp     .L2     #
12573 .L5:
12574 # test.c:10: @}
12575         ret
12576         .cfi_endproc
12577 .LFE0:
12578         .size   test, .-test
12579         .ident  "GCC: (GNU) 7.0.0 20160809 (experimental)"
12580         .section        .note.GNU-stack,"",@@progbits
12581 @end smallexample
12583 The comments are intended for humans rather than machines and hence the
12584 precise format of the comments is subject to change.
12586 @item -frecord-gcc-switches
12587 @opindex frecord-gcc-switches
12588 This switch causes the command line used to invoke the
12589 compiler to be recorded into the object file that is being created.
12590 This switch is only implemented on some targets and the exact format
12591 of the recording is target and binary file format dependent, but it
12592 usually takes the form of a section containing ASCII text.  This
12593 switch is related to the @option{-fverbose-asm} switch, but that
12594 switch only records information in the assembler output file as
12595 comments, so it never reaches the object file.
12596 See also @option{-grecord-gcc-switches} for another
12597 way of storing compiler options into the object file.
12599 @item -fpic
12600 @opindex fpic
12601 @cindex global offset table
12602 @cindex PIC
12603 Generate position-independent code (PIC) suitable for use in a shared
12604 library, if supported for the target machine.  Such code accesses all
12605 constant addresses through a global offset table (GOT)@.  The dynamic
12606 loader resolves the GOT entries when the program starts (the dynamic
12607 loader is not part of GCC; it is part of the operating system).  If
12608 the GOT size for the linked executable exceeds a machine-specific
12609 maximum size, you get an error message from the linker indicating that
12610 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
12611 instead.  (These maximums are 8k on the SPARC, 28k on AArch64 and 32k
12612 on the m68k and RS/6000.  The x86 has no such limit.)
12614 Position-independent code requires special support, and therefore works
12615 only on certain machines.  For the x86, GCC supports PIC for System V
12616 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
12617 position-independent.
12619 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12620 are defined to 1.
12622 @item -fPIC
12623 @opindex fPIC
12624 If supported for the target machine, emit position-independent code,
12625 suitable for dynamic linking and avoiding any limit on the size of the
12626 global offset table.  This option makes a difference on AArch64, m68k,
12627 PowerPC and SPARC@.
12629 Position-independent code requires special support, and therefore works
12630 only on certain machines.
12632 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12633 are defined to 2.
12635 @item -fpie
12636 @itemx -fPIE
12637 @opindex fpie
12638 @opindex fPIE
12639 These options are similar to @option{-fpic} and @option{-fPIC}, but
12640 generated position independent code can be only linked into executables.
12641 Usually these options are used when @option{-pie} GCC option is
12642 used during linking.
12644 @option{-fpie} and @option{-fPIE} both define the macros
12645 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
12646 for @option{-fpie} and 2 for @option{-fPIE}.
12648 @item -fno-plt
12649 @opindex fno-plt
12650 Do not use the PLT for external function calls in position-independent code.
12651 Instead, load the callee address at call sites from the GOT and branch to it.
12652 This leads to more efficient code by eliminating PLT stubs and exposing
12653 GOT loads to optimizations.  On architectures such as 32-bit x86 where
12654 PLT stubs expect the GOT pointer in a specific register, this gives more
12655 register allocation freedom to the compiler.
12656 Lazy binding requires use of the PLT; 
12657 with @option{-fno-plt} all external symbols are resolved at load time.
12659 Alternatively, the function attribute @code{noplt} can be used to avoid calls
12660 through the PLT for specific external functions.
12662 In position-dependent code, a few targets also convert calls to
12663 functions that are marked to not use the PLT to use the GOT instead.
12665 @item -fno-jump-tables
12666 @opindex fno-jump-tables
12667 Do not use jump tables for switch statements even where it would be
12668 more efficient than other code generation strategies.  This option is
12669 of use in conjunction with @option{-fpic} or @option{-fPIC} for
12670 building code that forms part of a dynamic linker and cannot
12671 reference the address of a jump table.  On some targets, jump tables
12672 do not require a GOT and this option is not needed.
12674 @item -ffixed-@var{reg}
12675 @opindex ffixed
12676 Treat the register named @var{reg} as a fixed register; generated code
12677 should never refer to it (except perhaps as a stack pointer, frame
12678 pointer or in some other fixed role).
12680 @var{reg} must be the name of a register.  The register names accepted
12681 are machine-specific and are defined in the @code{REGISTER_NAMES}
12682 macro in the machine description macro file.
12684 This flag does not have a negative form, because it specifies a
12685 three-way choice.
12687 @item -fcall-used-@var{reg}
12688 @opindex fcall-used
12689 Treat the register named @var{reg} as an allocable register that is
12690 clobbered by function calls.  It may be allocated for temporaries or
12691 variables that do not live across a call.  Functions compiled this way
12692 do not save and restore the register @var{reg}.
12694 It is an error to use this flag with the frame pointer or stack pointer.
12695 Use of this flag for other registers that have fixed pervasive roles in
12696 the machine's execution model produces disastrous results.
12698 This flag does not have a negative form, because it specifies a
12699 three-way choice.
12701 @item -fcall-saved-@var{reg}
12702 @opindex fcall-saved
12703 Treat the register named @var{reg} as an allocable register saved by
12704 functions.  It may be allocated even for temporaries or variables that
12705 live across a call.  Functions compiled this way save and restore
12706 the register @var{reg} if they use it.
12708 It is an error to use this flag with the frame pointer or stack pointer.
12709 Use of this flag for other registers that have fixed pervasive roles in
12710 the machine's execution model produces disastrous results.
12712 A different sort of disaster results from the use of this flag for
12713 a register in which function values may be returned.
12715 This flag does not have a negative form, because it specifies a
12716 three-way choice.
12718 @item -fpack-struct[=@var{n}]
12719 @opindex fpack-struct
12720 Without a value specified, pack all structure members together without
12721 holes.  When a value is specified (which must be a small power of two), pack
12722 structure members according to this value, representing the maximum
12723 alignment (that is, objects with default alignment requirements larger than
12724 this are output potentially unaligned at the next fitting location.
12726 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
12727 code that is not binary compatible with code generated without that switch.
12728 Additionally, it makes the code suboptimal.
12729 Use it to conform to a non-default application binary interface.
12731 @item -fleading-underscore
12732 @opindex fleading-underscore
12733 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
12734 change the way C symbols are represented in the object file.  One use
12735 is to help link with legacy assembly code.
12737 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
12738 generate code that is not binary compatible with code generated without that
12739 switch.  Use it to conform to a non-default application binary interface.
12740 Not all targets provide complete support for this switch.
12742 @item -ftls-model=@var{model}
12743 @opindex ftls-model
12744 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
12745 The @var{model} argument should be one of @samp{global-dynamic},
12746 @samp{local-dynamic}, @samp{initial-exec} or @samp{local-exec}.
12747 Note that the choice is subject to optimization: the compiler may use
12748 a more efficient model for symbols not visible outside of the translation
12749 unit, or if @option{-fpic} is not given on the command line.
12751 The default without @option{-fpic} is @samp{initial-exec}; with
12752 @option{-fpic} the default is @samp{global-dynamic}.
12754 @item -ftrampolines
12755 @opindex ftrampolines
12756 For targets that normally need trampolines for nested functions, always
12757 generate them instead of using descriptors.  Otherwise, for targets that
12758 do not need them, like for example HP-PA or IA-64, do nothing.
12760 A trampoline is a small piece of code that is created at run time on the
12761 stack when the address of a nested function is taken, and is used to call
12762 the nested function indirectly.  Therefore, it requires the stack to be
12763 made executable in order for the program to work properly.
12765 @option{-fno-trampolines} is enabled by default on a language by language
12766 basis to let the compiler avoid generating them, if it computes that this
12767 is safe, and replace them with descriptors.  Descriptors are made up of data
12768 only, but the generated code must be prepared to deal with them.  As of this
12769 writing, @option{-fno-trampolines} is enabled by default only for Ada.
12771 Moreover, code compiled with @option{-ftrampolines} and code compiled with
12772 @option{-fno-trampolines} are not binary compatible if nested functions are
12773 present.  This option must therefore be used on a program-wide basis and be
12774 manipulated with extreme care.
12776 @item -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]}
12777 @opindex fvisibility
12778 Set the default ELF image symbol visibility to the specified option---all
12779 symbols are marked with this unless overridden within the code.
12780 Using this feature can very substantially improve linking and
12781 load times of shared object libraries, produce more optimized
12782 code, provide near-perfect API export and prevent symbol clashes.
12783 It is @strong{strongly} recommended that you use this in any shared objects
12784 you distribute.
12786 Despite the nomenclature, @samp{default} always means public; i.e.,
12787 available to be linked against from outside the shared object.
12788 @samp{protected} and @samp{internal} are pretty useless in real-world
12789 usage so the only other commonly used option is @samp{hidden}.
12790 The default if @option{-fvisibility} isn't specified is
12791 @samp{default}, i.e., make every symbol public.
12793 A good explanation of the benefits offered by ensuring ELF
12794 symbols have the correct visibility is given by ``How To Write
12795 Shared Libraries'' by Ulrich Drepper (which can be found at
12796 @w{@uref{https://www.akkadia.org/drepper/}})---however a superior
12797 solution made possible by this option to marking things hidden when
12798 the default is public is to make the default hidden and mark things
12799 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
12800 and @code{__attribute__ ((visibility("default")))} instead of
12801 @code{__declspec(dllexport)} you get almost identical semantics with
12802 identical syntax.  This is a great boon to those working with
12803 cross-platform projects.
12805 For those adding visibility support to existing code, you may find
12806 @code{#pragma GCC visibility} of use.  This works by you enclosing
12807 the declarations you wish to set visibility for with (for example)
12808 @code{#pragma GCC visibility push(hidden)} and
12809 @code{#pragma GCC visibility pop}.
12810 Bear in mind that symbol visibility should be viewed @strong{as
12811 part of the API interface contract} and thus all new code should
12812 always specify visibility when it is not the default; i.e., declarations
12813 only for use within the local DSO should @strong{always} be marked explicitly
12814 as hidden as so to avoid PLT indirection overheads---making this
12815 abundantly clear also aids readability and self-documentation of the code.
12816 Note that due to ISO C++ specification requirements, @code{operator new} and
12817 @code{operator delete} must always be of default visibility.
12819 Be aware that headers from outside your project, in particular system
12820 headers and headers from any other library you use, may not be
12821 expecting to be compiled with visibility other than the default.  You
12822 may need to explicitly say @code{#pragma GCC visibility push(default)}
12823 before including any such headers.
12825 @code{extern} declarations are not affected by @option{-fvisibility}, so
12826 a lot of code can be recompiled with @option{-fvisibility=hidden} with
12827 no modifications.  However, this means that calls to @code{extern}
12828 functions with no explicit visibility use the PLT, so it is more
12829 effective to use @code{__attribute ((visibility))} and/or
12830 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
12831 declarations should be treated as hidden.
12833 Note that @option{-fvisibility} does affect C++ vague linkage
12834 entities. This means that, for instance, an exception class that is
12835 be thrown between DSOs must be explicitly marked with default
12836 visibility so that the @samp{type_info} nodes are unified between
12837 the DSOs.
12839 An overview of these techniques, their benefits and how to use them
12840 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
12842 @item -fstrict-volatile-bitfields
12843 @opindex fstrict-volatile-bitfields
12844 This option should be used if accesses to volatile bit-fields (or other
12845 structure fields, although the compiler usually honors those types
12846 anyway) should use a single access of the width of the
12847 field's type, aligned to a natural alignment if possible.  For
12848 example, targets with memory-mapped peripheral registers might require
12849 all such accesses to be 16 bits wide; with this flag you can
12850 declare all peripheral bit-fields as @code{unsigned short} (assuming short
12851 is 16 bits on these targets) to force GCC to use 16-bit accesses
12852 instead of, perhaps, a more efficient 32-bit access.
12854 If this option is disabled, the compiler uses the most efficient
12855 instruction.  In the previous example, that might be a 32-bit load
12856 instruction, even though that accesses bytes that do not contain
12857 any portion of the bit-field, or memory-mapped registers unrelated to
12858 the one being updated.
12860 In some cases, such as when the @code{packed} attribute is applied to a 
12861 structure field, it may not be possible to access the field with a single
12862 read or write that is correctly aligned for the target machine.  In this
12863 case GCC falls back to generating multiple accesses rather than code that 
12864 will fault or truncate the result at run time.
12866 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
12867 not allowed to touch non bit-field members.  It is therefore recommended
12868 to define all bits of the field's type as bit-field members.
12870 The default value of this option is determined by the application binary
12871 interface for the target processor.
12873 @item -fsync-libcalls
12874 @opindex fsync-libcalls
12875 This option controls whether any out-of-line instance of the @code{__sync}
12876 family of functions may be used to implement the C++11 @code{__atomic}
12877 family of functions.
12879 The default value of this option is enabled, thus the only useful form
12880 of the option is @option{-fno-sync-libcalls}.  This option is used in
12881 the implementation of the @file{libatomic} runtime library.
12883 @end table
12885 @node Developer Options
12886 @section GCC Developer Options
12887 @cindex developer options
12888 @cindex debugging GCC
12889 @cindex debug dump options
12890 @cindex dump options
12891 @cindex compilation statistics
12893 This section describes command-line options that are primarily of
12894 interest to GCC developers, including options to support compiler
12895 testing and investigation of compiler bugs and compile-time
12896 performance problems.  This includes options that produce debug dumps
12897 at various points in the compilation; that print statistics such as
12898 memory use and execution time; and that print information about GCC's
12899 configuration, such as where it searches for libraries.  You should
12900 rarely need to use any of these options for ordinary compilation and
12901 linking tasks.
12903 @table @gcctabopt
12905 @item -d@var{letters}
12906 @itemx -fdump-rtl-@var{pass}
12907 @itemx -fdump-rtl-@var{pass}=@var{filename}
12908 @opindex d
12909 @opindex fdump-rtl-@var{pass}
12910 Says to make debugging dumps during compilation at times specified by
12911 @var{letters}.  This is used for debugging the RTL-based passes of the
12912 compiler.  The file names for most of the dumps are made by appending
12913 a pass number and a word to the @var{dumpname}, and the files are
12914 created in the directory of the output file.  In case of
12915 @option{=@var{filename}} option, the dump is output on the given file
12916 instead of the pass numbered dump files.  Note that the pass number is
12917 assigned as passes are registered into the pass manager.  Most passes
12918 are registered in the order that they will execute and for these passes
12919 the number corresponds to the pass execution order.  However, passes
12920 registered by plugins, passes specific to compilation targets, or
12921 passes that are otherwise registered after all the other passes are
12922 numbered higher than a pass named "final", even if they are executed
12923 earlier.  @var{dumpname} is generated from the name of the output
12924 file if explicitly specified and not an executable, otherwise it is
12925 the basename of the source file.  
12927 Some @option{-d@var{letters}} switches have different meaning when
12928 @option{-E} is used for preprocessing.  @xref{Preprocessor Options},
12929 for information about preprocessor-specific dump options.
12931 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
12932 @option{-d} option @var{letters}.  Here are the possible
12933 letters for use in @var{pass} and @var{letters}, and their meanings:
12935 @table @gcctabopt
12937 @item -fdump-rtl-alignments
12938 @opindex fdump-rtl-alignments
12939 Dump after branch alignments have been computed.
12941 @item -fdump-rtl-asmcons
12942 @opindex fdump-rtl-asmcons
12943 Dump after fixing rtl statements that have unsatisfied in/out constraints.
12945 @item -fdump-rtl-auto_inc_dec
12946 @opindex fdump-rtl-auto_inc_dec
12947 Dump after auto-inc-dec discovery.  This pass is only run on
12948 architectures that have auto inc or auto dec instructions.
12950 @item -fdump-rtl-barriers
12951 @opindex fdump-rtl-barriers
12952 Dump after cleaning up the barrier instructions.
12954 @item -fdump-rtl-bbpart
12955 @opindex fdump-rtl-bbpart
12956 Dump after partitioning hot and cold basic blocks.
12958 @item -fdump-rtl-bbro
12959 @opindex fdump-rtl-bbro
12960 Dump after block reordering.
12962 @item -fdump-rtl-btl1
12963 @itemx -fdump-rtl-btl2
12964 @opindex fdump-rtl-btl2
12965 @opindex fdump-rtl-btl2
12966 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
12967 after the two branch
12968 target load optimization passes.
12970 @item -fdump-rtl-bypass
12971 @opindex fdump-rtl-bypass
12972 Dump after jump bypassing and control flow optimizations.
12974 @item -fdump-rtl-combine
12975 @opindex fdump-rtl-combine
12976 Dump after the RTL instruction combination pass.
12978 @item -fdump-rtl-compgotos
12979 @opindex fdump-rtl-compgotos
12980 Dump after duplicating the computed gotos.
12982 @item -fdump-rtl-ce1
12983 @itemx -fdump-rtl-ce2
12984 @itemx -fdump-rtl-ce3
12985 @opindex fdump-rtl-ce1
12986 @opindex fdump-rtl-ce2
12987 @opindex fdump-rtl-ce3
12988 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
12989 @option{-fdump-rtl-ce3} enable dumping after the three
12990 if conversion passes.
12992 @item -fdump-rtl-cprop_hardreg
12993 @opindex fdump-rtl-cprop_hardreg
12994 Dump after hard register copy propagation.
12996 @item -fdump-rtl-csa
12997 @opindex fdump-rtl-csa
12998 Dump after combining stack adjustments.
13000 @item -fdump-rtl-cse1
13001 @itemx -fdump-rtl-cse2
13002 @opindex fdump-rtl-cse1
13003 @opindex fdump-rtl-cse2
13004 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
13005 the two common subexpression elimination passes.
13007 @item -fdump-rtl-dce
13008 @opindex fdump-rtl-dce
13009 Dump after the standalone dead code elimination passes.
13011 @item -fdump-rtl-dbr
13012 @opindex fdump-rtl-dbr
13013 Dump after delayed branch scheduling.
13015 @item -fdump-rtl-dce1
13016 @itemx -fdump-rtl-dce2
13017 @opindex fdump-rtl-dce1
13018 @opindex fdump-rtl-dce2
13019 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
13020 the two dead store elimination passes.
13022 @item -fdump-rtl-eh
13023 @opindex fdump-rtl-eh
13024 Dump after finalization of EH handling code.
13026 @item -fdump-rtl-eh_ranges
13027 @opindex fdump-rtl-eh_ranges
13028 Dump after conversion of EH handling range regions.
13030 @item -fdump-rtl-expand
13031 @opindex fdump-rtl-expand
13032 Dump after RTL generation.
13034 @item -fdump-rtl-fwprop1
13035 @itemx -fdump-rtl-fwprop2
13036 @opindex fdump-rtl-fwprop1
13037 @opindex fdump-rtl-fwprop2
13038 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
13039 dumping after the two forward propagation passes.
13041 @item -fdump-rtl-gcse1
13042 @itemx -fdump-rtl-gcse2
13043 @opindex fdump-rtl-gcse1
13044 @opindex fdump-rtl-gcse2
13045 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
13046 after global common subexpression elimination.
13048 @item -fdump-rtl-init-regs
13049 @opindex fdump-rtl-init-regs
13050 Dump after the initialization of the registers.
13052 @item -fdump-rtl-initvals
13053 @opindex fdump-rtl-initvals
13054 Dump after the computation of the initial value sets.
13056 @item -fdump-rtl-into_cfglayout
13057 @opindex fdump-rtl-into_cfglayout
13058 Dump after converting to cfglayout mode.
13060 @item -fdump-rtl-ira
13061 @opindex fdump-rtl-ira
13062 Dump after iterated register allocation.
13064 @item -fdump-rtl-jump
13065 @opindex fdump-rtl-jump
13066 Dump after the second jump optimization.
13068 @item -fdump-rtl-loop2
13069 @opindex fdump-rtl-loop2
13070 @option{-fdump-rtl-loop2} enables dumping after the rtl
13071 loop optimization passes.
13073 @item -fdump-rtl-mach
13074 @opindex fdump-rtl-mach
13075 Dump after performing the machine dependent reorganization pass, if that
13076 pass exists.
13078 @item -fdump-rtl-mode_sw
13079 @opindex fdump-rtl-mode_sw
13080 Dump after removing redundant mode switches.
13082 @item -fdump-rtl-rnreg
13083 @opindex fdump-rtl-rnreg
13084 Dump after register renumbering.
13086 @item -fdump-rtl-outof_cfglayout
13087 @opindex fdump-rtl-outof_cfglayout
13088 Dump after converting from cfglayout mode.
13090 @item -fdump-rtl-peephole2
13091 @opindex fdump-rtl-peephole2
13092 Dump after the peephole pass.
13094 @item -fdump-rtl-postreload
13095 @opindex fdump-rtl-postreload
13096 Dump after post-reload optimizations.
13098 @item -fdump-rtl-pro_and_epilogue
13099 @opindex fdump-rtl-pro_and_epilogue
13100 Dump after generating the function prologues and epilogues.
13102 @item -fdump-rtl-sched1
13103 @itemx -fdump-rtl-sched2
13104 @opindex fdump-rtl-sched1
13105 @opindex fdump-rtl-sched2
13106 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
13107 after the basic block scheduling passes.
13109 @item -fdump-rtl-ree
13110 @opindex fdump-rtl-ree
13111 Dump after sign/zero extension elimination.
13113 @item -fdump-rtl-seqabstr
13114 @opindex fdump-rtl-seqabstr
13115 Dump after common sequence discovery.
13117 @item -fdump-rtl-shorten
13118 @opindex fdump-rtl-shorten
13119 Dump after shortening branches.
13121 @item -fdump-rtl-sibling
13122 @opindex fdump-rtl-sibling
13123 Dump after sibling call optimizations.
13125 @item -fdump-rtl-split1
13126 @itemx -fdump-rtl-split2
13127 @itemx -fdump-rtl-split3
13128 @itemx -fdump-rtl-split4
13129 @itemx -fdump-rtl-split5
13130 @opindex fdump-rtl-split1
13131 @opindex fdump-rtl-split2
13132 @opindex fdump-rtl-split3
13133 @opindex fdump-rtl-split4
13134 @opindex fdump-rtl-split5
13135 These options enable dumping after five rounds of
13136 instruction splitting.
13138 @item -fdump-rtl-sms
13139 @opindex fdump-rtl-sms
13140 Dump after modulo scheduling.  This pass is only run on some
13141 architectures.
13143 @item -fdump-rtl-stack
13144 @opindex fdump-rtl-stack
13145 Dump after conversion from GCC's ``flat register file'' registers to the
13146 x87's stack-like registers.  This pass is only run on x86 variants.
13148 @item -fdump-rtl-subreg1
13149 @itemx -fdump-rtl-subreg2
13150 @opindex fdump-rtl-subreg1
13151 @opindex fdump-rtl-subreg2
13152 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
13153 the two subreg expansion passes.
13155 @item -fdump-rtl-unshare
13156 @opindex fdump-rtl-unshare
13157 Dump after all rtl has been unshared.
13159 @item -fdump-rtl-vartrack
13160 @opindex fdump-rtl-vartrack
13161 Dump after variable tracking.
13163 @item -fdump-rtl-vregs
13164 @opindex fdump-rtl-vregs
13165 Dump after converting virtual registers to hard registers.
13167 @item -fdump-rtl-web
13168 @opindex fdump-rtl-web
13169 Dump after live range splitting.
13171 @item -fdump-rtl-regclass
13172 @itemx -fdump-rtl-subregs_of_mode_init
13173 @itemx -fdump-rtl-subregs_of_mode_finish
13174 @itemx -fdump-rtl-dfinit
13175 @itemx -fdump-rtl-dfinish
13176 @opindex fdump-rtl-regclass
13177 @opindex fdump-rtl-subregs_of_mode_init
13178 @opindex fdump-rtl-subregs_of_mode_finish
13179 @opindex fdump-rtl-dfinit
13180 @opindex fdump-rtl-dfinish
13181 These dumps are defined but always produce empty files.
13183 @item -da
13184 @itemx -fdump-rtl-all
13185 @opindex da
13186 @opindex fdump-rtl-all
13187 Produce all the dumps listed above.
13189 @item -dA
13190 @opindex dA
13191 Annotate the assembler output with miscellaneous debugging information.
13193 @item -dD
13194 @opindex dD
13195 Dump all macro definitions, at the end of preprocessing, in addition to
13196 normal output.
13198 @item -dH
13199 @opindex dH
13200 Produce a core dump whenever an error occurs.
13202 @item -dp
13203 @opindex dp
13204 Annotate the assembler output with a comment indicating which
13205 pattern and alternative is used.  The length of each instruction is
13206 also printed.
13208 @item -dP
13209 @opindex dP
13210 Dump the RTL in the assembler output as a comment before each instruction.
13211 Also turns on @option{-dp} annotation.
13213 @item -dx
13214 @opindex dx
13215 Just generate RTL for a function instead of compiling it.  Usually used
13216 with @option{-fdump-rtl-expand}.
13217 @end table
13219 @item -fdump-noaddr
13220 @opindex fdump-noaddr
13221 When doing debugging dumps, suppress address output.  This makes it more
13222 feasible to use diff on debugging dumps for compiler invocations with
13223 different compiler binaries and/or different
13224 text / bss / data / heap / stack / dso start locations.
13226 @item -freport-bug
13227 @opindex freport-bug
13228 Collect and dump debug information into a temporary file if an
13229 internal compiler error (ICE) occurs.
13231 @item -fdump-unnumbered
13232 @opindex fdump-unnumbered
13233 When doing debugging dumps, suppress instruction numbers and address output.
13234 This makes it more feasible to use diff on debugging dumps for compiler
13235 invocations with different options, in particular with and without
13236 @option{-g}.
13238 @item -fdump-unnumbered-links
13239 @opindex fdump-unnumbered-links
13240 When doing debugging dumps (see @option{-d} option above), suppress
13241 instruction numbers for the links to the previous and next instructions
13242 in a sequence.
13244 @item -fdump-ipa-@var{switch}
13245 @opindex fdump-ipa
13246 Control the dumping at various stages of inter-procedural analysis
13247 language tree to a file.  The file name is generated by appending a
13248 switch specific suffix to the source file name, and the file is created
13249 in the same directory as the output file.  The following dumps are
13250 possible:
13252 @table @samp
13253 @item all
13254 Enables all inter-procedural analysis dumps.
13256 @item cgraph
13257 Dumps information about call-graph optimization, unused function removal,
13258 and inlining decisions.
13260 @item inline
13261 Dump after function inlining.
13263 @end table
13265 @item -fdump-lang-all
13266 @itemx -fdump-lang-@var{switch}
13267 @itemx -fdump-lang-@var{switch}-@var{options}
13268 @itemx -fdump-lang-@var{switch}-@var{options}=@var{filename}
13269 @opindex fdump-lang-all
13270 @opindex fdump-lang
13271 Control the dumping of language-specific information.  The @var{options}
13272 and @var{filename} portions behave as described in the
13273 @option{-fdump-tree} option.  The following @var{switch} values are
13274 accepted:
13276 @table @samp
13277 @item all
13279 Enable all language-specific dumps.
13281 @item class
13282 Dump class hierarchy information.  Virtual table information is emitted
13283 unless '@option{slim}' is specified.  This option is applicable to C++ only.
13285 @item raw
13286 Dump the raw internal tree data.  This option is applicable to C++ only.
13288 @end table
13290 @item -fdump-passes
13291 @opindex fdump-passes
13292 Print on @file{stderr} the list of optimization passes that are turned
13293 on and off by the current command-line options.
13295 @item -fdump-statistics-@var{option}
13296 @opindex fdump-statistics
13297 Enable and control dumping of pass statistics in a separate file.  The
13298 file name is generated by appending a suffix ending in
13299 @samp{.statistics} to the source file name, and the file is created in
13300 the same directory as the output file.  If the @samp{-@var{option}}
13301 form is used, @samp{-stats} causes counters to be summed over the
13302 whole compilation unit while @samp{-details} dumps every event as
13303 the passes generate them.  The default with no option is to sum
13304 counters for each function compiled.
13306 @item -fdump-tree-all
13307 @itemx -fdump-tree-@var{switch}
13308 @itemx -fdump-tree-@var{switch}-@var{options}
13309 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
13310 @opindex fdump-tree-all
13311 @opindex fdump-tree
13312 Control the dumping at various stages of processing the intermediate
13313 language tree to a file.  The file name is generated by appending a
13314 switch-specific suffix to the source file name, and the file is
13315 created in the same directory as the output file. In case of
13316 @option{=@var{filename}} option, the dump is output on the given file
13317 instead of the auto named dump files.  If the @samp{-@var{options}}
13318 form is used, @var{options} is a list of @samp{-} separated options
13319 which control the details of the dump.  Not all options are applicable
13320 to all dumps; those that are not meaningful are ignored.  The
13321 following options are available
13323 @table @samp
13324 @item address
13325 Print the address of each node.  Usually this is not meaningful as it
13326 changes according to the environment and source file.  Its primary use
13327 is for tying up a dump file with a debug environment.
13328 @item asmname
13329 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
13330 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
13331 use working backward from mangled names in the assembly file.
13332 @item slim
13333 When dumping front-end intermediate representations, inhibit dumping
13334 of members of a scope or body of a function merely because that scope
13335 has been reached.  Only dump such items when they are directly reachable
13336 by some other path.
13338 When dumping pretty-printed trees, this option inhibits dumping the
13339 bodies of control structures.
13341 When dumping RTL, print the RTL in slim (condensed) form instead of
13342 the default LISP-like representation.
13343 @item raw
13344 Print a raw representation of the tree.  By default, trees are
13345 pretty-printed into a C-like representation.
13346 @item details
13347 Enable more detailed dumps (not honored by every dump option). Also
13348 include information from the optimization passes.
13349 @item stats
13350 Enable dumping various statistics about the pass (not honored by every dump
13351 option).
13352 @item blocks
13353 Enable showing basic block boundaries (disabled in raw dumps).
13354 @item graph
13355 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
13356 dump a representation of the control flow graph suitable for viewing with
13357 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
13358 the file is pretty-printed as a subgraph, so that GraphViz can render them
13359 all in a single plot.
13361 This option currently only works for RTL dumps, and the RTL is always
13362 dumped in slim form.
13363 @item vops
13364 Enable showing virtual operands for every statement.
13365 @item lineno
13366 Enable showing line numbers for statements.
13367 @item uid
13368 Enable showing the unique ID (@code{DECL_UID}) for each variable.
13369 @item verbose
13370 Enable showing the tree dump for each statement.
13371 @item eh
13372 Enable showing the EH region number holding each statement.
13373 @item scev
13374 Enable showing scalar evolution analysis details.
13375 @item optimized
13376 Enable showing optimization information (only available in certain
13377 passes).
13378 @item missed
13379 Enable showing missed optimization information (only available in certain
13380 passes).
13381 @item note
13382 Enable other detailed optimization information (only available in
13383 certain passes).
13384 @item =@var{filename}
13385 Instead of an auto named dump file, output into the given file
13386 name. The file names @file{stdout} and @file{stderr} are treated
13387 specially and are considered already open standard streams. For
13388 example,
13390 @smallexample
13391 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
13392      -fdump-tree-pre=/dev/stderr file.c
13393 @end smallexample
13395 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
13396 output on to @file{stderr}. If two conflicting dump filenames are
13397 given for the same pass, then the latter option overrides the earlier
13398 one.
13400 @item all
13401 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
13402 and @option{lineno}.
13404 @item optall
13405 Turn on all optimization options, i.e., @option{optimized},
13406 @option{missed}, and @option{note}.
13407 @end table
13409 To determine what tree dumps are available or find the dump for a pass
13410 of interest follow the steps below.
13412 @enumerate
13413 @item
13414 Invoke GCC with @option{-fdump-passes} and in the @file{stderr} output
13415 look for a code that corresponds to the pass you are interested in.
13416 For example, the codes @code{tree-evrp}, @code{tree-vrp1}, and
13417 @code{tree-vrp2} correspond to the three Value Range Propagation passes.
13418 The number at the end distinguishes distinct invocations of the same pass.
13419 @item
13420 To enable the creation of the dump file, append the pass code to
13421 the @option{-fdump-} option prefix and invoke GCC with it.  For example,
13422 to enable the dump from the Early Value Range Propagation pass, invoke
13423 GCC with the @option{-fdump-tree-evrp} option.  Optionally, you may
13424 specify the name of the dump file.  If you don't specify one, GCC
13425 creates as described below.
13426 @item
13427 Find the pass dump in a file whose name is composed of three components
13428 separated by a period: the name of the source file GCC was invoked to
13429 compile, a numeric suffix indicating the pass number followed by the
13430 letter @samp{t} for tree passes (and the letter @samp{r} for RTL passes),
13431 and finally the pass code.  For example, the Early VRP pass dump might
13432 be in a file named @file{myfile.c.038t.evrp} in the current working
13433 directory.  Note that the numeric codes are not stable and may change
13434 from one version of GCC to another.
13435 @end enumerate
13437 @item -fopt-info
13438 @itemx -fopt-info-@var{options}
13439 @itemx -fopt-info-@var{options}=@var{filename}
13440 @opindex fopt-info
13441 Controls optimization dumps from various optimization passes. If the
13442 @samp{-@var{options}} form is used, @var{options} is a list of
13443 @samp{-} separated option keywords to select the dump details and
13444 optimizations.  
13446 The @var{options} can be divided into two groups: options describing the
13447 verbosity of the dump, and options describing which optimizations
13448 should be included. The options from both the groups can be freely
13449 mixed as they are non-overlapping. However, in case of any conflicts,
13450 the later options override the earlier options on the command
13451 line. 
13453 The following options control the dump verbosity:
13455 @table @samp
13456 @item optimized
13457 Print information when an optimization is successfully applied. It is
13458 up to a pass to decide which information is relevant. For example, the
13459 vectorizer passes print the source location of loops which are
13460 successfully vectorized.
13461 @item missed
13462 Print information about missed optimizations. Individual passes
13463 control which information to include in the output. 
13464 @item note
13465 Print verbose information about optimizations, such as certain
13466 transformations, more detailed messages about decisions etc.
13467 @item all
13468 Print detailed optimization information. This includes
13469 @samp{optimized}, @samp{missed}, and @samp{note}.
13470 @end table
13472 One or more of the following option keywords can be used to describe a
13473 group of optimizations:
13475 @table @samp
13476 @item ipa
13477 Enable dumps from all interprocedural optimizations.
13478 @item loop
13479 Enable dumps from all loop optimizations.
13480 @item inline
13481 Enable dumps from all inlining optimizations.
13482 @item omp
13483 Enable dumps from all OMP (Offloading and Multi Processing) optimizations.
13484 @item vec
13485 Enable dumps from all vectorization optimizations.
13486 @item optall
13487 Enable dumps from all optimizations. This is a superset of
13488 the optimization groups listed above.
13489 @end table
13491 If @var{options} is
13492 omitted, it defaults to @samp{optimized-optall}, which means to dump all
13493 info about successful optimizations from all the passes.  
13495 If the @var{filename} is provided, then the dumps from all the
13496 applicable optimizations are concatenated into the @var{filename}.
13497 Otherwise the dump is output onto @file{stderr}. Though multiple
13498 @option{-fopt-info} options are accepted, only one of them can include
13499 a @var{filename}. If other filenames are provided then all but the
13500 first such option are ignored.
13502 Note that the output @var{filename} is overwritten
13503 in case of multiple translation units. If a combined output from
13504 multiple translation units is desired, @file{stderr} should be used
13505 instead.
13507 In the following example, the optimization info is output to
13508 @file{stderr}:
13510 @smallexample
13511 gcc -O3 -fopt-info
13512 @end smallexample
13514 This example:
13515 @smallexample
13516 gcc -O3 -fopt-info-missed=missed.all
13517 @end smallexample
13519 @noindent
13520 outputs missed optimization report from all the passes into
13521 @file{missed.all}, and this one:
13523 @smallexample
13524 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
13525 @end smallexample
13527 @noindent
13528 prints information about missed optimization opportunities from
13529 vectorization passes on @file{stderr}.  
13530 Note that @option{-fopt-info-vec-missed} is equivalent to 
13531 @option{-fopt-info-missed-vec}.  The order of the optimization group
13532 names and message types listed after @option{-fopt-info} does not matter.
13534 As another example,
13535 @smallexample
13536 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
13537 @end smallexample
13539 @noindent
13540 outputs information about missed optimizations as well as
13541 optimized locations from all the inlining passes into
13542 @file{inline.txt}.
13544 Finally, consider:
13546 @smallexample
13547 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
13548 @end smallexample
13550 @noindent
13551 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
13552 in conflict since only one output file is allowed. In this case, only
13553 the first option takes effect and the subsequent options are
13554 ignored. Thus only @file{vec.miss} is produced which contains
13555 dumps from the vectorizer about missed opportunities.
13557 @item -fsched-verbose=@var{n}
13558 @opindex fsched-verbose
13559 On targets that use instruction scheduling, this option controls the
13560 amount of debugging output the scheduler prints to the dump files.
13562 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
13563 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
13564 For @var{n} greater than one, it also output basic block probabilities,
13565 detailed ready list information and unit/insn info.  For @var{n} greater
13566 than two, it includes RTL at abort point, control-flow and regions info.
13567 And for @var{n} over four, @option{-fsched-verbose} also includes
13568 dependence info.
13572 @item -fenable-@var{kind}-@var{pass}
13573 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
13574 @opindex fdisable-
13575 @opindex fenable-
13577 This is a set of options that are used to explicitly disable/enable
13578 optimization passes.  These options are intended for use for debugging GCC.
13579 Compiler users should use regular options for enabling/disabling
13580 passes instead.
13582 @table @gcctabopt
13584 @item -fdisable-ipa-@var{pass}
13585 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
13586 statically invoked in the compiler multiple times, the pass name should be
13587 appended with a sequential number starting from 1.
13589 @item -fdisable-rtl-@var{pass}
13590 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
13591 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
13592 statically invoked in the compiler multiple times, the pass name should be
13593 appended with a sequential number starting from 1.  @var{range-list} is a 
13594 comma-separated list of function ranges or assembler names.  Each range is a number
13595 pair separated by a colon.  The range is inclusive in both ends.  If the range
13596 is trivial, the number pair can be simplified as a single number.  If the
13597 function's call graph node's @var{uid} falls within one of the specified ranges,
13598 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
13599 function header of a dump file, and the pass names can be dumped by using
13600 option @option{-fdump-passes}.
13602 @item -fdisable-tree-@var{pass}
13603 @itemx -fdisable-tree-@var{pass}=@var{range-list}
13604 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
13605 option arguments.
13607 @item -fenable-ipa-@var{pass}
13608 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
13609 statically invoked in the compiler multiple times, the pass name should be
13610 appended with a sequential number starting from 1.
13612 @item -fenable-rtl-@var{pass}
13613 @itemx -fenable-rtl-@var{pass}=@var{range-list}
13614 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
13615 description and examples.
13617 @item -fenable-tree-@var{pass}
13618 @itemx -fenable-tree-@var{pass}=@var{range-list}
13619 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
13620 of option arguments.
13622 @end table
13624 Here are some examples showing uses of these options.
13626 @smallexample
13628 # disable ccp1 for all functions
13629    -fdisable-tree-ccp1
13630 # disable complete unroll for function whose cgraph node uid is 1
13631    -fenable-tree-cunroll=1
13632 # disable gcse2 for functions at the following ranges [1,1],
13633 # [300,400], and [400,1000]
13634 # disable gcse2 for functions foo and foo2
13635    -fdisable-rtl-gcse2=foo,foo2
13636 # disable early inlining
13637    -fdisable-tree-einline
13638 # disable ipa inlining
13639    -fdisable-ipa-inline
13640 # enable tree full unroll
13641    -fenable-tree-unroll
13643 @end smallexample
13645 @item -fchecking
13646 @itemx -fchecking=@var{n}
13647 @opindex fchecking
13648 @opindex fno-checking
13649 Enable internal consistency checking.  The default depends on
13650 the compiler configuration.  @option{-fchecking=2} enables further
13651 internal consistency checking that might affect code generation.
13653 @item -frandom-seed=@var{string}
13654 @opindex frandom-seed
13655 This option provides a seed that GCC uses in place of
13656 random numbers in generating certain symbol names
13657 that have to be different in every compiled file.  It is also used to
13658 place unique stamps in coverage data files and the object files that
13659 produce them.  You can use the @option{-frandom-seed} option to produce
13660 reproducibly identical object files.
13662 The @var{string} can either be a number (decimal, octal or hex) or an
13663 arbitrary string (in which case it's converted to a number by
13664 computing CRC32).
13666 The @var{string} should be different for every file you compile.
13668 @item -save-temps
13669 @itemx -save-temps=cwd
13670 @opindex save-temps
13671 Store the usual ``temporary'' intermediate files permanently; place them
13672 in the current directory and name them based on the source file.  Thus,
13673 compiling @file{foo.c} with @option{-c -save-temps} produces files
13674 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
13675 preprocessed @file{foo.i} output file even though the compiler now
13676 normally uses an integrated preprocessor.
13678 When used in combination with the @option{-x} command-line option,
13679 @option{-save-temps} is sensible enough to avoid over writing an
13680 input source file with the same extension as an intermediate file.
13681 The corresponding intermediate file may be obtained by renaming the
13682 source file before using @option{-save-temps}.
13684 If you invoke GCC in parallel, compiling several different source
13685 files that share a common base name in different subdirectories or the
13686 same source file compiled for multiple output destinations, it is
13687 likely that the different parallel compilers will interfere with each
13688 other, and overwrite the temporary files.  For instance:
13690 @smallexample
13691 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
13692 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
13693 @end smallexample
13695 may result in @file{foo.i} and @file{foo.o} being written to
13696 simultaneously by both compilers.
13698 @item -save-temps=obj
13699 @opindex save-temps=obj
13700 Store the usual ``temporary'' intermediate files permanently.  If the
13701 @option{-o} option is used, the temporary files are based on the
13702 object file.  If the @option{-o} option is not used, the
13703 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
13705 For example:
13707 @smallexample
13708 gcc -save-temps=obj -c foo.c
13709 gcc -save-temps=obj -c bar.c -o dir/xbar.o
13710 gcc -save-temps=obj foobar.c -o dir2/yfoobar
13711 @end smallexample
13713 @noindent
13714 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
13715 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
13716 @file{dir2/yfoobar.o}.
13718 @item -time@r{[}=@var{file}@r{]}
13719 @opindex time
13720 Report the CPU time taken by each subprocess in the compilation
13721 sequence.  For C source files, this is the compiler proper and assembler
13722 (plus the linker if linking is done).
13724 Without the specification of an output file, the output looks like this:
13726 @smallexample
13727 # cc1 0.12 0.01
13728 # as 0.00 0.01
13729 @end smallexample
13731 The first number on each line is the ``user time'', that is time spent
13732 executing the program itself.  The second number is ``system time'',
13733 time spent executing operating system routines on behalf of the program.
13734 Both numbers are in seconds.
13736 With the specification of an output file, the output is appended to the
13737 named file, and it looks like this:
13739 @smallexample
13740 0.12 0.01 cc1 @var{options}
13741 0.00 0.01 as @var{options}
13742 @end smallexample
13744 The ``user time'' and the ``system time'' are moved before the program
13745 name, and the options passed to the program are displayed, so that one
13746 can later tell what file was being compiled, and with which options.
13748 @item -fdump-final-insns@r{[}=@var{file}@r{]}
13749 @opindex fdump-final-insns
13750 Dump the final internal representation (RTL) to @var{file}.  If the
13751 optional argument is omitted (or if @var{file} is @code{.}), the name
13752 of the dump file is determined by appending @code{.gkd} to the
13753 compilation output file name.
13755 @item -fcompare-debug@r{[}=@var{opts}@r{]}
13756 @opindex fcompare-debug
13757 @opindex fno-compare-debug
13758 If no error occurs during compilation, run the compiler a second time,
13759 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
13760 passed to the second compilation.  Dump the final internal
13761 representation in both compilations, and print an error if they differ.
13763 If the equal sign is omitted, the default @option{-gtoggle} is used.
13765 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
13766 and nonzero, implicitly enables @option{-fcompare-debug}.  If
13767 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
13768 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
13769 is used.
13771 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
13772 is equivalent to @option{-fno-compare-debug}, which disables the dumping
13773 of the final representation and the second compilation, preventing even
13774 @env{GCC_COMPARE_DEBUG} from taking effect.
13776 To verify full coverage during @option{-fcompare-debug} testing, set
13777 @env{GCC_COMPARE_DEBUG} to say @option{-fcompare-debug-not-overridden},
13778 which GCC rejects as an invalid option in any actual compilation
13779 (rather than preprocessing, assembly or linking).  To get just a
13780 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
13781 not overridden} will do.
13783 @item -fcompare-debug-second
13784 @opindex fcompare-debug-second
13785 This option is implicitly passed to the compiler for the second
13786 compilation requested by @option{-fcompare-debug}, along with options to
13787 silence warnings, and omitting other options that would cause
13788 side-effect compiler outputs to files or to the standard output.  Dump
13789 files and preserved temporary files are renamed so as to contain the
13790 @code{.gk} additional extension during the second compilation, to avoid
13791 overwriting those generated by the first.
13793 When this option is passed to the compiler driver, it causes the
13794 @emph{first} compilation to be skipped, which makes it useful for little
13795 other than debugging the compiler proper.
13797 @item -gtoggle
13798 @opindex gtoggle
13799 Turn off generation of debug info, if leaving out this option
13800 generates it, or turn it on at level 2 otherwise.  The position of this
13801 argument in the command line does not matter; it takes effect after all
13802 other options are processed, and it does so only once, no matter how
13803 many times it is given.  This is mainly intended to be used with
13804 @option{-fcompare-debug}.
13806 @item -fvar-tracking-assignments-toggle
13807 @opindex fvar-tracking-assignments-toggle
13808 @opindex fno-var-tracking-assignments-toggle
13809 Toggle @option{-fvar-tracking-assignments}, in the same way that
13810 @option{-gtoggle} toggles @option{-g}.
13812 @item -Q
13813 @opindex Q
13814 Makes the compiler print out each function name as it is compiled, and
13815 print some statistics about each pass when it finishes.
13817 @item -ftime-report
13818 @opindex ftime-report
13819 Makes the compiler print some statistics about the time consumed by each
13820 pass when it finishes.
13822 @item -ftime-report-details
13823 @opindex ftime-report-details
13824 Record the time consumed by infrastructure parts separately for each pass.
13826 @item -fira-verbose=@var{n}
13827 @opindex fira-verbose
13828 Control the verbosity of the dump file for the integrated register allocator.
13829 The default value is 5.  If the value @var{n} is greater or equal to 10,
13830 the dump output is sent to stderr using the same format as @var{n} minus 10.
13832 @item -flto-report
13833 @opindex flto-report
13834 Prints a report with internal details on the workings of the link-time
13835 optimizer.  The contents of this report vary from version to version.
13836 It is meant to be useful to GCC developers when processing object
13837 files in LTO mode (via @option{-flto}).
13839 Disabled by default.
13841 @item -flto-report-wpa
13842 @opindex flto-report-wpa
13843 Like @option{-flto-report}, but only print for the WPA phase of Link
13844 Time Optimization.
13846 @item -fmem-report
13847 @opindex fmem-report
13848 Makes the compiler print some statistics about permanent memory
13849 allocation when it finishes.
13851 @item -fmem-report-wpa
13852 @opindex fmem-report-wpa
13853 Makes the compiler print some statistics about permanent memory
13854 allocation for the WPA phase only.
13856 @item -fpre-ipa-mem-report
13857 @opindex fpre-ipa-mem-report
13858 @item -fpost-ipa-mem-report
13859 @opindex fpost-ipa-mem-report
13860 Makes the compiler print some statistics about permanent memory
13861 allocation before or after interprocedural optimization.
13863 @item -fprofile-report
13864 @opindex fprofile-report
13865 Makes the compiler print some statistics about consistency of the
13866 (estimated) profile and effect of individual passes.
13868 @item -fstack-usage
13869 @opindex fstack-usage
13870 Makes the compiler output stack usage information for the program, on a
13871 per-function basis.  The filename for the dump is made by appending
13872 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
13873 the output file, if explicitly specified and it is not an executable,
13874 otherwise it is the basename of the source file.  An entry is made up
13875 of three fields:
13877 @itemize
13878 @item
13879 The name of the function.
13880 @item
13881 A number of bytes.
13882 @item
13883 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
13884 @end itemize
13886 The qualifier @code{static} means that the function manipulates the stack
13887 statically: a fixed number of bytes are allocated for the frame on function
13888 entry and released on function exit; no stack adjustments are otherwise made
13889 in the function.  The second field is this fixed number of bytes.
13891 The qualifier @code{dynamic} means that the function manipulates the stack
13892 dynamically: in addition to the static allocation described above, stack
13893 adjustments are made in the body of the function, for example to push/pop
13894 arguments around function calls.  If the qualifier @code{bounded} is also
13895 present, the amount of these adjustments is bounded at compile time and
13896 the second field is an upper bound of the total amount of stack used by
13897 the function.  If it is not present, the amount of these adjustments is
13898 not bounded at compile time and the second field only represents the
13899 bounded part.
13901 @item -fstats
13902 @opindex fstats
13903 Emit statistics about front-end processing at the end of the compilation.
13904 This option is supported only by the C++ front end, and
13905 the information is generally only useful to the G++ development team.
13907 @item -fdbg-cnt-list
13908 @opindex fdbg-cnt-list
13909 Print the name and the counter upper bound for all debug counters.
13912 @item -fdbg-cnt=@var{counter-value-list}
13913 @opindex fdbg-cnt
13914 Set the internal debug counter upper bound.  @var{counter-value-list}
13915 is a comma-separated list of @var{name}:@var{value} pairs
13916 which sets the upper bound of each debug counter @var{name} to @var{value}.
13917 All debug counters have the initial upper bound of @code{UINT_MAX};
13918 thus @code{dbg_cnt} returns true always unless the upper bound
13919 is set by this option.
13920 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
13921 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
13923 @item -print-file-name=@var{library}
13924 @opindex print-file-name
13925 Print the full absolute name of the library file @var{library} that
13926 would be used when linking---and don't do anything else.  With this
13927 option, GCC does not compile or link anything; it just prints the
13928 file name.
13930 @item -print-multi-directory
13931 @opindex print-multi-directory
13932 Print the directory name corresponding to the multilib selected by any
13933 other switches present in the command line.  This directory is supposed
13934 to exist in @env{GCC_EXEC_PREFIX}.
13936 @item -print-multi-lib
13937 @opindex print-multi-lib
13938 Print the mapping from multilib directory names to compiler switches
13939 that enable them.  The directory name is separated from the switches by
13940 @samp{;}, and each switch starts with an @samp{@@} instead of the
13941 @samp{-}, without spaces between multiple switches.  This is supposed to
13942 ease shell processing.
13944 @item -print-multi-os-directory
13945 @opindex print-multi-os-directory
13946 Print the path to OS libraries for the selected
13947 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
13948 present in the @file{lib} subdirectory and no multilibs are used, this is
13949 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
13950 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
13951 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
13952 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
13954 @item -print-multiarch
13955 @opindex print-multiarch
13956 Print the path to OS libraries for the selected multiarch,
13957 relative to some @file{lib} subdirectory.
13959 @item -print-prog-name=@var{program}
13960 @opindex print-prog-name
13961 Like @option{-print-file-name}, but searches for a program such as @command{cpp}.
13963 @item -print-libgcc-file-name
13964 @opindex print-libgcc-file-name
13965 Same as @option{-print-file-name=libgcc.a}.
13967 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
13968 but you do want to link with @file{libgcc.a}.  You can do:
13970 @smallexample
13971 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
13972 @end smallexample
13974 @item -print-search-dirs
13975 @opindex print-search-dirs
13976 Print the name of the configured installation directory and a list of
13977 program and library directories @command{gcc} searches---and don't do anything else.
13979 This is useful when @command{gcc} prints the error message
13980 @samp{installation problem, cannot exec cpp0: No such file or directory}.
13981 To resolve this you either need to put @file{cpp0} and the other compiler
13982 components where @command{gcc} expects to find them, or you can set the environment
13983 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
13984 Don't forget the trailing @samp{/}.
13985 @xref{Environment Variables}.
13987 @item -print-sysroot
13988 @opindex print-sysroot
13989 Print the target sysroot directory that is used during
13990 compilation.  This is the target sysroot specified either at configure
13991 time or using the @option{--sysroot} option, possibly with an extra
13992 suffix that depends on compilation options.  If no target sysroot is
13993 specified, the option prints nothing.
13995 @item -print-sysroot-headers-suffix
13996 @opindex print-sysroot-headers-suffix
13997 Print the suffix added to the target sysroot when searching for
13998 headers, or give an error if the compiler is not configured with such
13999 a suffix---and don't do anything else.
14001 @item -dumpmachine
14002 @opindex dumpmachine
14003 Print the compiler's target machine (for example,
14004 @samp{i686-pc-linux-gnu})---and don't do anything else.
14006 @item -dumpversion
14007 @opindex dumpversion
14008 Print the compiler version (for example, @code{3.0}, @code{6.3.0} or @code{7})---and don't do
14009 anything else.  This is the compiler version used in filesystem paths,
14010 specs, can be depending on how the compiler has been configured just
14011 a single number (major version), two numbers separated by dot (major and
14012 minor version) or three numbers separated by dots (major, minor and patchlevel
14013 version).
14015 @item -dumpfullversion
14016 @opindex dumpfullversion
14017 Print the full compiler version, always 3 numbers separated by dots,
14018 major, minor and patchlevel version.
14020 @item -dumpspecs
14021 @opindex dumpspecs
14022 Print the compiler's built-in specs---and don't do anything else.  (This
14023 is used when GCC itself is being built.)  @xref{Spec Files}.
14024 @end table
14026 @node Submodel Options
14027 @section Machine-Dependent Options
14028 @cindex submodel options
14029 @cindex specifying hardware config
14030 @cindex hardware models and configurations, specifying
14031 @cindex target-dependent options
14032 @cindex machine-dependent options
14034 Each target machine supported by GCC can have its own options---for
14035 example, to allow you to compile for a particular processor variant or
14036 ABI, or to control optimizations specific to that machine.  By
14037 convention, the names of machine-specific options start with
14038 @samp{-m}.
14040 Some configurations of the compiler also support additional target-specific
14041 options, usually for compatibility with other compilers on the same
14042 platform.
14044 @c This list is ordered alphanumerically by subsection name.
14045 @c It should be the same order and spelling as these options are listed
14046 @c in Machine Dependent Options
14048 @menu
14049 * AArch64 Options::
14050 * Adapteva Epiphany Options::
14051 * ARC Options::
14052 * ARM Options::
14053 * AVR Options::
14054 * Blackfin Options::
14055 * C6X Options::
14056 * CRIS Options::
14057 * CR16 Options::
14058 * Darwin Options::
14059 * DEC Alpha Options::
14060 * FR30 Options::
14061 * FT32 Options::
14062 * FRV Options::
14063 * GNU/Linux Options::
14064 * H8/300 Options::
14065 * HPPA Options::
14066 * IA-64 Options::
14067 * LM32 Options::
14068 * M32C Options::
14069 * M32R/D Options::
14070 * M680x0 Options::
14071 * MCore Options::
14072 * MeP Options::
14073 * MicroBlaze Options::
14074 * MIPS Options::
14075 * MMIX Options::
14076 * MN10300 Options::
14077 * Moxie Options::
14078 * MSP430 Options::
14079 * NDS32 Options::
14080 * Nios II Options::
14081 * Nvidia PTX Options::
14082 * PDP-11 Options::
14083 * picoChip Options::
14084 * PowerPC Options::
14085 * RISC-V Options::
14086 * RL78 Options::
14087 * RS/6000 and PowerPC Options::
14088 * RX Options::
14089 * S/390 and zSeries Options::
14090 * Score Options::
14091 * SH Options::
14092 * Solaris 2 Options::
14093 * SPARC Options::
14094 * SPU Options::
14095 * System V Options::
14096 * TILE-Gx Options::
14097 * TILEPro Options::
14098 * V850 Options::
14099 * VAX Options::
14100 * Visium Options::
14101 * VMS Options::
14102 * VxWorks Options::
14103 * x86 Options::
14104 * x86 Windows Options::
14105 * Xstormy16 Options::
14106 * Xtensa Options::
14107 * zSeries Options::
14108 @end menu
14110 @node AArch64 Options
14111 @subsection AArch64 Options
14112 @cindex AArch64 Options
14114 These options are defined for AArch64 implementations:
14116 @table @gcctabopt
14118 @item -mabi=@var{name}
14119 @opindex mabi
14120 Generate code for the specified data model.  Permissible values
14121 are @samp{ilp32} for SysV-like data model where int, long int and pointers
14122 are 32 bits, and @samp{lp64} for SysV-like data model where int is 32 bits,
14123 but long int and pointers are 64 bits.
14125 The default depends on the specific target configuration.  Note that
14126 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
14127 entire program with the same ABI, and link with a compatible set of libraries.
14129 @item -mbig-endian
14130 @opindex mbig-endian
14131 Generate big-endian code.  This is the default when GCC is configured for an
14132 @samp{aarch64_be-*-*} target.
14134 @item -mgeneral-regs-only
14135 @opindex mgeneral-regs-only
14136 Generate code which uses only the general-purpose registers.  This will prevent
14137 the compiler from using floating-point and Advanced SIMD registers but will not
14138 impose any restrictions on the assembler.
14140 @item -mlittle-endian
14141 @opindex mlittle-endian
14142 Generate little-endian code.  This is the default when GCC is configured for an
14143 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
14145 @item -mcmodel=tiny
14146 @opindex mcmodel=tiny
14147 Generate code for the tiny code model.  The program and its statically defined
14148 symbols must be within 1MB of each other.  Programs can be statically or
14149 dynamically linked.
14151 @item -mcmodel=small
14152 @opindex mcmodel=small
14153 Generate code for the small code model.  The program and its statically defined
14154 symbols must be within 4GB of each other.  Programs can be statically or
14155 dynamically linked.  This is the default code model.
14157 @item -mcmodel=large
14158 @opindex mcmodel=large
14159 Generate code for the large code model.  This makes no assumptions about
14160 addresses and sizes of sections.  Programs can be statically linked only.
14162 @item -mstrict-align
14163 @opindex mstrict-align
14164 Avoid generating memory accesses that may not be aligned on a natural object
14165 boundary as described in the architecture specification.
14167 @item -momit-leaf-frame-pointer
14168 @itemx -mno-omit-leaf-frame-pointer
14169 @opindex momit-leaf-frame-pointer
14170 @opindex mno-omit-leaf-frame-pointer
14171 Omit or keep the frame pointer in leaf functions.  The former behavior is the
14172 default.
14174 @item -mtls-dialect=desc
14175 @opindex mtls-dialect=desc
14176 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
14177 of TLS variables.  This is the default.
14179 @item -mtls-dialect=traditional
14180 @opindex mtls-dialect=traditional
14181 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
14182 of TLS variables.
14184 @item -mtls-size=@var{size}
14185 @opindex mtls-size
14186 Specify bit size of immediate TLS offsets.  Valid values are 12, 24, 32, 48.
14187 This option requires binutils 2.26 or newer.
14189 @item -mfix-cortex-a53-835769
14190 @itemx -mno-fix-cortex-a53-835769
14191 @opindex mfix-cortex-a53-835769
14192 @opindex mno-fix-cortex-a53-835769
14193 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
14194 This involves inserting a NOP instruction between memory instructions and
14195 64-bit integer multiply-accumulate instructions.
14197 @item -mfix-cortex-a53-843419
14198 @itemx -mno-fix-cortex-a53-843419
14199 @opindex mfix-cortex-a53-843419
14200 @opindex mno-fix-cortex-a53-843419
14201 Enable or disable the workaround for the ARM Cortex-A53 erratum number 843419.
14202 This erratum workaround is made at link time and this will only pass the
14203 corresponding flag to the linker.
14205 @item -mlow-precision-recip-sqrt
14206 @item -mno-low-precision-recip-sqrt
14207 @opindex mlow-precision-recip-sqrt
14208 @opindex mno-low-precision-recip-sqrt
14209 Enable or disable the reciprocal square root approximation.
14210 This option only has an effect if @option{-ffast-math} or
14211 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14212 precision of reciprocal square root results to about 16 bits for
14213 single precision and to 32 bits for double precision.
14215 @item -mlow-precision-sqrt
14216 @item -mno-low-precision-sqrt
14217 @opindex -mlow-precision-sqrt
14218 @opindex -mno-low-precision-sqrt
14219 Enable or disable the square root approximation.
14220 This option only has an effect if @option{-ffast-math} or
14221 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14222 precision of square root results to about 16 bits for
14223 single precision and to 32 bits for double precision.
14224 If enabled, it implies @option{-mlow-precision-recip-sqrt}.
14226 @item -mlow-precision-div
14227 @item -mno-low-precision-div
14228 @opindex -mlow-precision-div
14229 @opindex -mno-low-precision-div
14230 Enable or disable the division approximation.
14231 This option only has an effect if @option{-ffast-math} or
14232 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14233 precision of division results to about 16 bits for
14234 single precision and to 32 bits for double precision.
14236 @item -march=@var{name}
14237 @opindex march
14238 Specify the name of the target architecture and, optionally, one or
14239 more feature modifiers.  This option has the form
14240 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}.
14242 The permissible values for @var{arch} are @samp{armv8-a},
14243 @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a} or @var{native}.
14245 The value @samp{armv8.3-a} implies @samp{armv8.2-a} and enables compiler
14246 support for the ARMv8.3-A architecture extensions.
14248 The value @samp{armv8.2-a} implies @samp{armv8.1-a} and enables compiler
14249 support for the ARMv8.2-A architecture extensions.
14251 The value @samp{armv8.1-a} implies @samp{armv8-a} and enables compiler
14252 support for the ARMv8.1-A architecture extension.  In particular, it
14253 enables the @samp{+crc}, @samp{+lse}, and @samp{+rdma} features.
14255 The value @samp{native} is available on native AArch64 GNU/Linux and
14256 causes the compiler to pick the architecture of the host system.  This
14257 option has no effect if the compiler is unable to recognize the
14258 architecture of the host system,
14260 The permissible values for @var{feature} are listed in the sub-section
14261 on @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14262 Feature Modifiers}.  Where conflicting feature modifiers are
14263 specified, the right-most feature is used.
14265 GCC uses @var{name} to determine what kind of instructions it can emit
14266 when generating assembly code.  If @option{-march} is specified
14267 without either of @option{-mtune} or @option{-mcpu} also being
14268 specified, the code is tuned to perform well across a range of target
14269 processors implementing the target architecture.
14271 @item -mtune=@var{name}
14272 @opindex mtune
14273 Specify the name of the target processor for which GCC should tune the
14274 performance of the code.  Permissible values for this option are:
14275 @samp{generic}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
14276 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
14277 @samp{exynos-m1}, @samp{falkor}, @samp{qdf24xx},
14278 @samp{xgene1}, @samp{vulcan}, @samp{thunderx},
14279 @samp{thunderxt88}, @samp{thunderxt88p1}, @samp{thunderxt81},
14280 @samp{thunderxt83}, @samp{thunderx2t99}, @samp{cortex-a57.cortex-a53},
14281 @samp{cortex-a72.cortex-a53}, @samp{cortex-a73.cortex-a35},
14282 @samp{cortex-a73.cortex-a53}, @samp{cortex-a75.cortex-a55},
14283 @samp{native}.
14285 The values @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
14286 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53},
14287 @samp{cortex-a75.cortex-a55} specify that GCC should tune for a
14288 big.LITTLE system.
14290 Additionally on native AArch64 GNU/Linux systems the value
14291 @samp{native} tunes performance to the host system.  This option has no effect
14292 if the compiler is unable to recognize the processor of the host system.
14294 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
14295 are specified, the code is tuned to perform well across a range
14296 of target processors.
14298 This option cannot be suffixed by feature modifiers.
14300 @item -mcpu=@var{name}
14301 @opindex mcpu
14302 Specify the name of the target processor, optionally suffixed by one
14303 or more feature modifiers.  This option has the form
14304 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where
14305 the permissible values for @var{cpu} are the same as those available
14306 for @option{-mtune}.  The permissible values for @var{feature} are
14307 documented in the sub-section on
14308 @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14309 Feature Modifiers}.  Where conflicting feature modifiers are
14310 specified, the right-most feature is used.
14312 GCC uses @var{name} to determine what kind of instructions it can emit when
14313 generating assembly code (as if by @option{-march}) and to determine
14314 the target processor for which to tune for performance (as if
14315 by @option{-mtune}).  Where this option is used in conjunction
14316 with @option{-march} or @option{-mtune}, those options take precedence
14317 over the appropriate part of this option.
14319 @item -moverride=@var{string}
14320 @opindex moverride
14321 Override tuning decisions made by the back-end in response to a
14322 @option{-mtune=} switch.  The syntax, semantics, and accepted values
14323 for @var{string} in this option are not guaranteed to be consistent
14324 across releases.
14326 This option is only intended to be useful when developing GCC.
14328 @item -mpc-relative-literal-loads
14329 @itemx -mno-pc-relative-literal-loads
14330 @opindex mpc-relative-literal-loads
14331 @opindex mno-pc-relative-literal-loads
14332 Enable or disable PC-relative literal loads.  With this option literal pools are
14333 accessed using a single instruction and emitted after each function.  This
14334 limits the maximum size of functions to 1MB.  This is enabled by default for
14335 @option{-mcmodel=tiny}.
14337 @item -msign-return-address=@var{scope}
14338 @opindex msign-return-address
14339 Select the function scope on which return address signing will be applied.
14340 Permissible values are @samp{none}, which disables return address signing,
14341 @samp{non-leaf}, which enables pointer signing for functions which are not leaf
14342 functions, and @samp{all}, which enables pointer signing for all functions.  The
14343 default value is @samp{none}.
14345 @end table
14347 @subsubsection @option{-march} and @option{-mcpu} Feature Modifiers
14348 @anchor{aarch64-feature-modifiers}
14349 @cindex @option{-march} feature modifiers
14350 @cindex @option{-mcpu} feature modifiers
14351 Feature modifiers used with @option{-march} and @option{-mcpu} can be any of
14352 the following and their inverses @option{no@var{feature}}:
14354 @table @samp
14355 @item crc
14356 Enable CRC extension.  This is on by default for
14357 @option{-march=armv8.1-a}.
14358 @item crypto
14359 Enable Crypto extension.  This also enables Advanced SIMD and floating-point
14360 instructions.
14361 @item fp
14362 Enable floating-point instructions.  This is on by default for all possible
14363 values for options @option{-march} and @option{-mcpu}.
14364 @item simd
14365 Enable Advanced SIMD instructions.  This also enables floating-point
14366 instructions.  This is on by default for all possible values for options
14367 @option{-march} and @option{-mcpu}.
14368 @item lse
14369 Enable Large System Extension instructions.  This is on by default for
14370 @option{-march=armv8.1-a}.
14371 @item rdma
14372 Enable Round Double Multiply Accumulate instructions.  This is on by default
14373 for @option{-march=armv8.1-a}.
14374 @item fp16
14375 Enable FP16 extension.  This also enables floating-point instructions.
14376 @item rcpc
14377 Enable the RcPc extension.  This does not change code generation from GCC,
14378 but is passed on to the assembler, enabling inline asm statements to use
14379 instructions from the RcPc extension.
14381 @end table
14383 Feature @option{crypto} implies @option{simd}, which implies @option{fp}.
14384 Conversely, @option{nofp} implies @option{nosimd}, which implies
14385 @option{nocrypto}.
14387 @node Adapteva Epiphany Options
14388 @subsection Adapteva Epiphany Options
14390 These @samp{-m} options are defined for Adapteva Epiphany:
14392 @table @gcctabopt
14393 @item -mhalf-reg-file
14394 @opindex mhalf-reg-file
14395 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
14396 That allows code to run on hardware variants that lack these registers.
14398 @item -mprefer-short-insn-regs
14399 @opindex mprefer-short-insn-regs
14400 Preferentially allocate registers that allow short instruction generation.
14401 This can result in increased instruction count, so this may either reduce or
14402 increase overall code size.
14404 @item -mbranch-cost=@var{num}
14405 @opindex mbranch-cost
14406 Set the cost of branches to roughly @var{num} ``simple'' instructions.
14407 This cost is only a heuristic and is not guaranteed to produce
14408 consistent results across releases.
14410 @item -mcmove
14411 @opindex mcmove
14412 Enable the generation of conditional moves.
14414 @item -mnops=@var{num}
14415 @opindex mnops
14416 Emit @var{num} NOPs before every other generated instruction.
14418 @item -mno-soft-cmpsf
14419 @opindex mno-soft-cmpsf
14420 For single-precision floating-point comparisons, emit an @code{fsub} instruction
14421 and test the flags.  This is faster than a software comparison, but can
14422 get incorrect results in the presence of NaNs, or when two different small
14423 numbers are compared such that their difference is calculated as zero.
14424 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
14425 software comparisons.
14427 @item -mstack-offset=@var{num}
14428 @opindex mstack-offset
14429 Set the offset between the top of the stack and the stack pointer.
14430 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
14431 can be used by leaf functions without stack allocation.
14432 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
14433 Note also that this option changes the ABI; compiling a program with a
14434 different stack offset than the libraries have been compiled with
14435 generally does not work.
14436 This option can be useful if you want to evaluate if a different stack
14437 offset would give you better code, but to actually use a different stack
14438 offset to build working programs, it is recommended to configure the
14439 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
14441 @item -mno-round-nearest
14442 @opindex mno-round-nearest
14443 Make the scheduler assume that the rounding mode has been set to
14444 truncating.  The default is @option{-mround-nearest}.
14446 @item -mlong-calls
14447 @opindex mlong-calls
14448 If not otherwise specified by an attribute, assume all calls might be beyond
14449 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
14450 function address into a register before performing a (otherwise direct) call.
14451 This is the default.
14453 @item -mshort-calls
14454 @opindex short-calls
14455 If not otherwise specified by an attribute, assume all direct calls are
14456 in the range of the @code{b} / @code{bl} instructions, so use these instructions
14457 for direct calls.  The default is @option{-mlong-calls}.
14459 @item -msmall16
14460 @opindex msmall16
14461 Assume addresses can be loaded as 16-bit unsigned values.  This does not
14462 apply to function addresses for which @option{-mlong-calls} semantics
14463 are in effect.
14465 @item -mfp-mode=@var{mode}
14466 @opindex mfp-mode
14467 Set the prevailing mode of the floating-point unit.
14468 This determines the floating-point mode that is provided and expected
14469 at function call and return time.  Making this mode match the mode you
14470 predominantly need at function start can make your programs smaller and
14471 faster by avoiding unnecessary mode switches.
14473 @var{mode} can be set to one the following values:
14475 @table @samp
14476 @item caller
14477 Any mode at function entry is valid, and retained or restored when
14478 the function returns, and when it calls other functions.
14479 This mode is useful for compiling libraries or other compilation units
14480 you might want to incorporate into different programs with different
14481 prevailing FPU modes, and the convenience of being able to use a single
14482 object file outweighs the size and speed overhead for any extra
14483 mode switching that might be needed, compared with what would be needed
14484 with a more specific choice of prevailing FPU mode.
14486 @item truncate
14487 This is the mode used for floating-point calculations with
14488 truncating (i.e.@: round towards zero) rounding mode.  That includes
14489 conversion from floating point to integer.
14491 @item round-nearest
14492 This is the mode used for floating-point calculations with
14493 round-to-nearest-or-even rounding mode.
14495 @item int
14496 This is the mode used to perform integer calculations in the FPU, e.g.@:
14497 integer multiply, or integer multiply-and-accumulate.
14498 @end table
14500 The default is @option{-mfp-mode=caller}
14502 @item -mnosplit-lohi
14503 @itemx -mno-postinc
14504 @itemx -mno-postmodify
14505 @opindex mnosplit-lohi
14506 @opindex mno-postinc
14507 @opindex mno-postmodify
14508 Code generation tweaks that disable, respectively, splitting of 32-bit
14509 loads, generation of post-increment addresses, and generation of
14510 post-modify addresses.  The defaults are @option{msplit-lohi},
14511 @option{-mpost-inc}, and @option{-mpost-modify}.
14513 @item -mnovect-double
14514 @opindex mno-vect-double
14515 Change the preferred SIMD mode to SImode.  The default is
14516 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
14518 @item -max-vect-align=@var{num}
14519 @opindex max-vect-align
14520 The maximum alignment for SIMD vector mode types.
14521 @var{num} may be 4 or 8.  The default is 8.
14522 Note that this is an ABI change, even though many library function
14523 interfaces are unaffected if they don't use SIMD vector modes
14524 in places that affect size and/or alignment of relevant types.
14526 @item -msplit-vecmove-early
14527 @opindex msplit-vecmove-early
14528 Split vector moves into single word moves before reload.  In theory this
14529 can give better register allocation, but so far the reverse seems to be
14530 generally the case.
14532 @item -m1reg-@var{reg}
14533 @opindex m1reg-
14534 Specify a register to hold the constant @minus{}1, which makes loading small negative
14535 constants and certain bitmasks faster.
14536 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
14537 which specify use of that register as a fixed register,
14538 and @samp{none}, which means that no register is used for this
14539 purpose.  The default is @option{-m1reg-none}.
14541 @end table
14543 @node ARC Options
14544 @subsection ARC Options
14545 @cindex ARC options
14547 The following options control the architecture variant for which code
14548 is being compiled:
14550 @c architecture variants
14551 @table @gcctabopt
14553 @item -mbarrel-shifter
14554 @opindex mbarrel-shifter
14555 Generate instructions supported by barrel shifter.  This is the default
14556 unless @option{-mcpu=ARC601} or @samp{-mcpu=ARCEM} is in effect.
14558 @item -mcpu=@var{cpu}
14559 @opindex mcpu
14560 Set architecture type, register usage, and instruction scheduling
14561 parameters for @var{cpu}.  There are also shortcut alias options
14562 available for backward compatibility and convenience.  Supported
14563 values for @var{cpu} are
14565 @table @samp
14566 @opindex mA6
14567 @opindex mARC600
14568 @item arc600
14569 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
14571 @item arc601
14572 @opindex mARC601
14573 Compile for ARC601.  Alias: @option{-mARC601}.
14575 @item arc700
14576 @opindex mA7
14577 @opindex mARC700
14578 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
14579 This is the default when configured with @option{--with-cpu=arc700}@.
14581 @item arcem
14582 Compile for ARC EM.
14584 @item archs
14585 Compile for ARC HS.
14587 @item em
14588 Compile for ARC EM CPU with no hardware extensions.
14590 @item em4
14591 Compile for ARC EM4 CPU.
14593 @item em4_dmips
14594 Compile for ARC EM4 DMIPS CPU.
14596 @item em4_fpus
14597 Compile for ARC EM4 DMIPS CPU with the single-precision floating-point
14598 extension.
14600 @item em4_fpuda
14601 Compile for ARC EM4 DMIPS CPU with single-precision floating-point and
14602 double assist instructions.
14604 @item hs
14605 Compile for ARC HS CPU with no hardware extensions except the atomic
14606 instructions.
14608 @item hs34
14609 Compile for ARC HS34 CPU.
14611 @item hs38
14612 Compile for ARC HS38 CPU.
14614 @item hs38_linux
14615 Compile for ARC HS38 CPU with all hardware extensions on.
14617 @item arc600_norm
14618 Compile for ARC 600 CPU with @code{norm} instructions enabled.
14620 @item arc600_mul32x16
14621 Compile for ARC 600 CPU with @code{norm} and 32x16-bit multiply 
14622 instructions enabled.
14624 @item arc600_mul64
14625 Compile for ARC 600 CPU with @code{norm} and @code{mul64}-family 
14626 instructions enabled.
14628 @item arc601_norm
14629 Compile for ARC 601 CPU with @code{norm} instructions enabled.
14631 @item arc601_mul32x16
14632 Compile for ARC 601 CPU with @code{norm} and 32x16-bit multiply
14633 instructions enabled.
14635 @item arc601_mul64
14636 Compile for ARC 601 CPU with @code{norm} and @code{mul64}-family
14637 instructions enabled.
14639 @item nps400
14640 Compile for ARC 700 on NPS400 chip.
14642 @end table
14644 @item -mdpfp
14645 @opindex mdpfp
14646 @itemx -mdpfp-compact
14647 @opindex mdpfp-compact
14648 Generate double-precision FPX instructions, tuned for the compact
14649 implementation.
14651 @item -mdpfp-fast
14652 @opindex mdpfp-fast
14653 Generate double-precision FPX instructions, tuned for the fast
14654 implementation.
14656 @item -mno-dpfp-lrsr
14657 @opindex mno-dpfp-lrsr
14658 Disable @code{lr} and @code{sr} instructions from using FPX extension
14659 aux registers.
14661 @item -mea
14662 @opindex mea
14663 Generate extended arithmetic instructions.  Currently only
14664 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
14665 supported.  This is always enabled for @option{-mcpu=ARC700}.
14667 @item -mno-mpy
14668 @opindex mno-mpy
14669 Do not generate @code{mpy}-family instructions for ARC700.  This option is
14670 deprecated.
14672 @item -mmul32x16
14673 @opindex mmul32x16
14674 Generate 32x16-bit multiply and multiply-accumulate instructions.
14676 @item -mmul64
14677 @opindex mmul64
14678 Generate @code{mul64} and @code{mulu64} instructions.  
14679 Only valid for @option{-mcpu=ARC600}.
14681 @item -mnorm
14682 @opindex mnorm
14683 Generate @code{norm} instructions.  This is the default if @option{-mcpu=ARC700}
14684 is in effect.
14686 @item -mspfp
14687 @opindex mspfp
14688 @itemx -mspfp-compact
14689 @opindex mspfp-compact
14690 Generate single-precision FPX instructions, tuned for the compact
14691 implementation.
14693 @item -mspfp-fast
14694 @opindex mspfp-fast
14695 Generate single-precision FPX instructions, tuned for the fast
14696 implementation.
14698 @item -msimd
14699 @opindex msimd
14700 Enable generation of ARC SIMD instructions via target-specific
14701 builtins.  Only valid for @option{-mcpu=ARC700}.
14703 @item -msoft-float
14704 @opindex msoft-float
14705 This option ignored; it is provided for compatibility purposes only.
14706 Software floating-point code is emitted by default, and this default
14707 can overridden by FPX options; @option{-mspfp}, @option{-mspfp-compact}, or
14708 @option{-mspfp-fast} for single precision, and @option{-mdpfp},
14709 @option{-mdpfp-compact}, or @option{-mdpfp-fast} for double precision.
14711 @item -mswap
14712 @opindex mswap
14713 Generate @code{swap} instructions.
14715 @item -matomic
14716 @opindex matomic
14717 This enables use of the locked load/store conditional extension to implement
14718 atomic memory built-in functions.  Not available for ARC 6xx or ARC
14719 EM cores.
14721 @item -mdiv-rem
14722 @opindex mdiv-rem
14723 Enable @code{div} and @code{rem} instructions for ARCv2 cores.
14725 @item -mcode-density
14726 @opindex mcode-density
14727 Enable code density instructions for ARC EM.  
14728 This option is on by default for ARC HS.
14730 @item -mll64
14731 @opindex mll64
14732 Enable double load/store operations for ARC HS cores.
14734 @item -mtp-regno=@var{regno}
14735 @opindex mtp-regno
14736 Specify thread pointer register number.
14738 @item -mmpy-option=@var{multo}
14739 @opindex mmpy-option
14740 Compile ARCv2 code with a multiplier design option.  You can specify 
14741 the option using either a string or numeric value for @var{multo}.  
14742 @samp{wlh1} is the default value.  The recognized values are:
14744 @table @samp
14745 @item 0
14746 @itemx none
14747 No multiplier available.
14749 @item 1
14750 @itemx w
14751 16x16 multiplier, fully pipelined.
14752 The following instructions are enabled: @code{mpyw} and @code{mpyuw}.
14754 @item 2
14755 @itemx wlh1
14756 32x32 multiplier, fully
14757 pipelined (1 stage).  The following instructions are additionally
14758 enabled: @code{mpy}, @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14760 @item 3
14761 @itemx wlh2
14762 32x32 multiplier, fully pipelined
14763 (2 stages).  The following instructions are additionally enabled: @code{mpy},
14764 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14766 @item 4
14767 @itemx wlh3
14768 Two 16x16 multipliers, blocking,
14769 sequential.  The following instructions are additionally enabled: @code{mpy},
14770 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14772 @item 5
14773 @itemx wlh4
14774 One 16x16 multiplier, blocking,
14775 sequential.  The following instructions are additionally enabled: @code{mpy},
14776 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14778 @item 6
14779 @itemx wlh5
14780 One 32x4 multiplier, blocking,
14781 sequential.  The following instructions are additionally enabled: @code{mpy},
14782 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14784 @item 7
14785 @itemx plus_dmpy
14786 ARC HS SIMD support.
14788 @item 8
14789 @itemx plus_macd
14790 ARC HS SIMD support.
14792 @item 9
14793 @itemx plus_qmacw
14794 ARC HS SIMD support.
14796 @end table
14798 This option is only available for ARCv2 cores@.
14800 @item -mfpu=@var{fpu}
14801 @opindex mfpu
14802 Enables support for specific floating-point hardware extensions for ARCv2
14803 cores.  Supported values for @var{fpu} are:
14805 @table @samp
14807 @item fpus
14808 Enables support for single-precision floating-point hardware
14809 extensions@.
14811 @item fpud
14812 Enables support for double-precision floating-point hardware
14813 extensions.  The single-precision floating-point extension is also
14814 enabled.  Not available for ARC EM@.
14816 @item fpuda
14817 Enables support for double-precision floating-point hardware
14818 extensions using double-precision assist instructions.  The single-precision
14819 floating-point extension is also enabled.  This option is
14820 only available for ARC EM@.
14822 @item fpuda_div
14823 Enables support for double-precision floating-point hardware
14824 extensions using double-precision assist instructions.
14825 The single-precision floating-point, square-root, and divide 
14826 extensions are also enabled.  This option is
14827 only available for ARC EM@.
14829 @item fpuda_fma
14830 Enables support for double-precision floating-point hardware
14831 extensions using double-precision assist instructions.
14832 The single-precision floating-point and fused multiply and add 
14833 hardware extensions are also enabled.  This option is
14834 only available for ARC EM@.
14836 @item fpuda_all
14837 Enables support for double-precision floating-point hardware
14838 extensions using double-precision assist instructions.
14839 All single-precision floating-point hardware extensions are also
14840 enabled.  This option is only available for ARC EM@.
14842 @item fpus_div
14843 Enables support for single-precision floating-point, square-root and divide 
14844 hardware extensions@.
14846 @item fpud_div
14847 Enables support for double-precision floating-point, square-root and divide 
14848 hardware extensions.  This option
14849 includes option @samp{fpus_div}. Not available for ARC EM@.
14851 @item fpus_fma
14852 Enables support for single-precision floating-point and 
14853 fused multiply and add hardware extensions@.
14855 @item fpud_fma
14856 Enables support for double-precision floating-point and 
14857 fused multiply and add hardware extensions.  This option
14858 includes option @samp{fpus_fma}.  Not available for ARC EM@.
14860 @item fpus_all
14861 Enables support for all single-precision floating-point hardware
14862 extensions@.
14864 @item fpud_all
14865 Enables support for all single- and double-precision floating-point
14866 hardware extensions.  Not available for ARC EM@.
14868 @end table
14870 @item -mirq-ctrl-saved=@var{register-range}, @var{blink}, @var{lp_count}
14871 @opindex mirq-ctrl-saved
14872 Specifies general-purposes registers that the processor automatically
14873 saves/restores on interrupt entry and exit.  @var{register-range} is
14874 specified as two registers separated by a dash.  The register range
14875 always starts with @code{r0}, the upper limit is @code{fp} register.
14876 @var{blink} and @var{lp_count} are optional.  This option is only
14877 valid for ARC EM and ARC HS cores.
14879 @item -mrgf-banked-regs=@var{number}
14880 @opindex mrgf-banked-regs
14881 Specifies the number of registers replicated in second register bank
14882 on entry to fast interrupt.  Fast interrupts are interrupts with the
14883 highest priority level P0.  These interrupts save only PC and STATUS32
14884 registers to avoid memory transactions during interrupt entry and exit
14885 sequences.  Use this option when you are using fast interrupts in an
14886 ARC V2 family processor.  Permitted values are 4, 8, 16, and 32.
14888 @item -mlpc-width=@var{width}
14889 @opindex mlpc-width
14890 Specify the width of the @code{lp_count} register.  Valid values for
14891 @var{width} are 8, 16, 20, 24, 28 and 32 bits.  The default width is
14892 fixed to 32 bits.  If the width is less than 32, the compiler does not
14893 attempt to transform loops in your program to use the zero-delay loop
14894 mechanism unless it is known that the @code{lp_count} register can
14895 hold the required loop-counter value.  Depending on the width
14896 specified, the compiler and run-time library might continue to use the
14897 loop mechanism for various needs.  This option defines macro
14898 @code{__ARC_LPC_WIDTH__} with the value of @var{width}.
14900 @end table
14902 The following options are passed through to the assembler, and also
14903 define preprocessor macro symbols.
14905 @c Flags used by the assembler, but for which we define preprocessor
14906 @c macro symbols as well.
14907 @table @gcctabopt
14908 @item -mdsp-packa
14909 @opindex mdsp-packa
14910 Passed down to the assembler to enable the DSP Pack A extensions.
14911 Also sets the preprocessor symbol @code{__Xdsp_packa}.  This option is
14912 deprecated.
14914 @item -mdvbf
14915 @opindex mdvbf
14916 Passed down to the assembler to enable the dual Viterbi butterfly
14917 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.  This
14918 option is deprecated.
14920 @c ARC700 4.10 extension instruction
14921 @item -mlock
14922 @opindex mlock
14923 Passed down to the assembler to enable the locked load/store
14924 conditional extension.  Also sets the preprocessor symbol
14925 @code{__Xlock}.
14927 @item -mmac-d16
14928 @opindex mmac-d16
14929 Passed down to the assembler.  Also sets the preprocessor symbol
14930 @code{__Xxmac_d16}.  This option is deprecated.
14932 @item -mmac-24
14933 @opindex mmac-24
14934 Passed down to the assembler.  Also sets the preprocessor symbol
14935 @code{__Xxmac_24}.  This option is deprecated.
14937 @c ARC700 4.10 extension instruction
14938 @item -mrtsc
14939 @opindex mrtsc
14940 Passed down to the assembler to enable the 64-bit time-stamp counter
14941 extension instruction.  Also sets the preprocessor symbol
14942 @code{__Xrtsc}.  This option is deprecated.
14944 @c ARC700 4.10 extension instruction
14945 @item -mswape
14946 @opindex mswape
14947 Passed down to the assembler to enable the swap byte ordering
14948 extension instruction.  Also sets the preprocessor symbol
14949 @code{__Xswape}.
14951 @item -mtelephony
14952 @opindex mtelephony
14953 Passed down to the assembler to enable dual- and single-operand
14954 instructions for telephony.  Also sets the preprocessor symbol
14955 @code{__Xtelephony}.  This option is deprecated.
14957 @item -mxy
14958 @opindex mxy
14959 Passed down to the assembler to enable the XY memory extension.  Also
14960 sets the preprocessor symbol @code{__Xxy}.
14962 @end table
14964 The following options control how the assembly code is annotated:
14966 @c Assembly annotation options
14967 @table @gcctabopt
14968 @item -misize
14969 @opindex misize
14970 Annotate assembler instructions with estimated addresses.
14972 @item -mannotate-align
14973 @opindex mannotate-align
14974 Explain what alignment considerations lead to the decision to make an
14975 instruction short or long.
14977 @end table
14979 The following options are passed through to the linker:
14981 @c options passed through to the linker
14982 @table @gcctabopt
14983 @item -marclinux
14984 @opindex marclinux
14985 Passed through to the linker, to specify use of the @code{arclinux} emulation.
14986 This option is enabled by default in tool chains built for
14987 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
14988 when profiling is not requested.
14990 @item -marclinux_prof
14991 @opindex marclinux_prof
14992 Passed through to the linker, to specify use of the
14993 @code{arclinux_prof} emulation.  This option is enabled by default in
14994 tool chains built for @w{@code{arc-linux-uclibc}} and
14995 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
14997 @end table
14999 The following options control the semantics of generated code:
15001 @c semantically relevant code generation options
15002 @table @gcctabopt
15003 @item -mlong-calls
15004 @opindex mlong-calls
15005 Generate calls as register indirect calls, thus providing access
15006 to the full 32-bit address range.
15008 @item -mmedium-calls
15009 @opindex mmedium-calls
15010 Don't use less than 25-bit addressing range for calls, which is the
15011 offset available for an unconditional branch-and-link
15012 instruction.  Conditional execution of function calls is suppressed, to
15013 allow use of the 25-bit range, rather than the 21-bit range with
15014 conditional branch-and-link.  This is the default for tool chains built
15015 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
15017 @item -G @var{num}
15018 @opindex G
15019 Put definitions of externally-visible data in a small data section if
15020 that data is no bigger than @var{num} bytes.  The default value of
15021 @var{num} is 4 for any ARC configuration, or 8 when we have double
15022 load/store operations.
15024 @item -mno-sdata
15025 @opindex mno-sdata
15026 Do not generate sdata references.  This is the default for tool chains
15027 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
15028 targets.
15030 @item -mvolatile-cache
15031 @opindex mvolatile-cache
15032 Use ordinarily cached memory accesses for volatile references.  This is the
15033 default.
15035 @item -mno-volatile-cache
15036 @opindex mno-volatile-cache
15037 Enable cache bypass for volatile references.
15039 @end table
15041 The following options fine tune code generation:
15042 @c code generation tuning options
15043 @table @gcctabopt
15044 @item -malign-call
15045 @opindex malign-call
15046 Do alignment optimizations for call instructions.
15048 @item -mauto-modify-reg
15049 @opindex mauto-modify-reg
15050 Enable the use of pre/post modify with register displacement.
15052 @item -mbbit-peephole
15053 @opindex mbbit-peephole
15054 Enable bbit peephole2.
15056 @item -mno-brcc
15057 @opindex mno-brcc
15058 This option disables a target-specific pass in @file{arc_reorg} to
15059 generate compare-and-branch (@code{br@var{cc}}) instructions.  
15060 It has no effect on
15061 generation of these instructions driven by the combiner pass.
15063 @item -mcase-vector-pcrel
15064 @opindex mcase-vector-pcrel
15065 Use PC-relative switch case tables to enable case table shortening.
15066 This is the default for @option{-Os}.
15068 @item -mcompact-casesi
15069 @opindex mcompact-casesi
15070 Enable compact @code{casesi} pattern.  This is the default for @option{-Os},
15071 and only available for ARCv1 cores.
15073 @item -mno-cond-exec
15074 @opindex mno-cond-exec
15075 Disable the ARCompact-specific pass to generate conditional 
15076 execution instructions.
15078 Due to delay slot scheduling and interactions between operand numbers,
15079 literal sizes, instruction lengths, and the support for conditional execution,
15080 the target-independent pass to generate conditional execution is often lacking,
15081 so the ARC port has kept a special pass around that tries to find more
15082 conditional execution generation opportunities after register allocation,
15083 branch shortening, and delay slot scheduling have been done.  This pass
15084 generally, but not always, improves performance and code size, at the cost of
15085 extra compilation time, which is why there is an option to switch it off.
15086 If you have a problem with call instructions exceeding their allowable
15087 offset range because they are conditionalized, you should consider using
15088 @option{-mmedium-calls} instead.
15090 @item -mearly-cbranchsi
15091 @opindex mearly-cbranchsi
15092 Enable pre-reload use of the @code{cbranchsi} pattern.
15094 @item -mexpand-adddi
15095 @opindex mexpand-adddi
15096 Expand @code{adddi3} and @code{subdi3} at RTL generation time into
15097 @code{add.f}, @code{adc} etc.  This option is deprecated.
15099 @item -mindexed-loads
15100 @opindex mindexed-loads
15101 Enable the use of indexed loads.  This can be problematic because some
15102 optimizers then assume that indexed stores exist, which is not
15103 the case.
15105 @opindex mlra
15106 Enable Local Register Allocation.  This is still experimental for ARC,
15107 so by default the compiler uses standard reload
15108 (i.e. @option{-mno-lra}).
15110 @item -mlra-priority-none
15111 @opindex mlra-priority-none
15112 Don't indicate any priority for target registers.
15114 @item -mlra-priority-compact
15115 @opindex mlra-priority-compact
15116 Indicate target register priority for r0..r3 / r12..r15.
15118 @item -mlra-priority-noncompact
15119 @opindex mlra-priority-noncompact
15120 Reduce target register priority for r0..r3 / r12..r15.
15122 @item -mno-millicode
15123 @opindex mno-millicode
15124 When optimizing for size (using @option{-Os}), prologues and epilogues
15125 that have to save or restore a large number of registers are often
15126 shortened by using call to a special function in libgcc; this is
15127 referred to as a @emph{millicode} call.  As these calls can pose
15128 performance issues, and/or cause linking issues when linking in a
15129 nonstandard way, this option is provided to turn off millicode call
15130 generation.
15132 @item -mmixed-code
15133 @opindex mmixed-code
15134 Tweak register allocation to help 16-bit instruction generation.
15135 This generally has the effect of decreasing the average instruction size
15136 while increasing the instruction count.
15138 @item -mq-class
15139 @opindex mq-class
15140 Enable @samp{q} instruction alternatives.
15141 This is the default for @option{-Os}.
15143 @item -mRcq
15144 @opindex mRcq
15145 Enable @samp{Rcq} constraint handling.  
15146 Most short code generation depends on this.
15147 This is the default.
15149 @item -mRcw
15150 @opindex mRcw
15151 Enable @samp{Rcw} constraint handling.  
15152 Most ccfsm condexec mostly depends on this.
15153 This is the default.
15155 @item -msize-level=@var{level}
15156 @opindex msize-level
15157 Fine-tune size optimization with regards to instruction lengths and alignment.
15158 The recognized values for @var{level} are:
15159 @table @samp
15160 @item 0
15161 No size optimization.  This level is deprecated and treated like @samp{1}.
15163 @item 1
15164 Short instructions are used opportunistically.
15166 @item 2
15167 In addition, alignment of loops and of code after barriers are dropped.
15169 @item 3
15170 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
15172 @end table
15174 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
15175 the behavior when this is not set is equivalent to level @samp{1}.
15177 @item -mtune=@var{cpu}
15178 @opindex mtune
15179 Set instruction scheduling parameters for @var{cpu}, overriding any implied
15180 by @option{-mcpu=}.
15182 Supported values for @var{cpu} are
15184 @table @samp
15185 @item ARC600
15186 Tune for ARC600 CPU.
15188 @item ARC601
15189 Tune for ARC601 CPU.
15191 @item ARC700
15192 Tune for ARC700 CPU with standard multiplier block.
15194 @item ARC700-xmac
15195 Tune for ARC700 CPU with XMAC block.
15197 @item ARC725D
15198 Tune for ARC725D CPU.
15200 @item ARC750D
15201 Tune for ARC750D CPU.
15203 @end table
15205 @item -mmultcost=@var{num}
15206 @opindex mmultcost
15207 Cost to assume for a multiply instruction, with @samp{4} being equal to a
15208 normal instruction.
15210 @item -munalign-prob-threshold=@var{probability}
15211 @opindex munalign-prob-threshold
15212 Set probability threshold for unaligning branches.
15213 When tuning for @samp{ARC700} and optimizing for speed, branches without
15214 filled delay slot are preferably emitted unaligned and long, unless
15215 profiling indicates that the probability for the branch to be taken
15216 is below @var{probability}.  @xref{Cross-profiling}.
15217 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
15219 @end table
15221 The following options are maintained for backward compatibility, but
15222 are now deprecated and will be removed in a future release:
15224 @c Deprecated options
15225 @table @gcctabopt
15227 @item -margonaut
15228 @opindex margonaut
15229 Obsolete FPX.
15231 @item -mbig-endian
15232 @opindex mbig-endian
15233 @itemx -EB
15234 @opindex EB
15235 Compile code for big-endian targets.  Use of these options is now
15236 deprecated.  Big-endian code is supported by configuring GCC to build
15237 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets,
15238 for which big endian is the default.
15240 @item -mlittle-endian
15241 @opindex mlittle-endian
15242 @itemx -EL
15243 @opindex EL
15244 Compile code for little-endian targets.  Use of these options is now
15245 deprecated.  Little-endian code is supported by configuring GCC to build 
15246 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets,
15247 for which little endian is the default.
15249 @item -mbarrel_shifter
15250 @opindex mbarrel_shifter
15251 Replaced by @option{-mbarrel-shifter}.
15253 @item -mdpfp_compact
15254 @opindex mdpfp_compact
15255 Replaced by @option{-mdpfp-compact}.
15257 @item -mdpfp_fast
15258 @opindex mdpfp_fast
15259 Replaced by @option{-mdpfp-fast}.
15261 @item -mdsp_packa
15262 @opindex mdsp_packa
15263 Replaced by @option{-mdsp-packa}.
15265 @item -mEA
15266 @opindex mEA
15267 Replaced by @option{-mea}.
15269 @item -mmac_24
15270 @opindex mmac_24
15271 Replaced by @option{-mmac-24}.
15273 @item -mmac_d16
15274 @opindex mmac_d16
15275 Replaced by @option{-mmac-d16}.
15277 @item -mspfp_compact
15278 @opindex mspfp_compact
15279 Replaced by @option{-mspfp-compact}.
15281 @item -mspfp_fast
15282 @opindex mspfp_fast
15283 Replaced by @option{-mspfp-fast}.
15285 @item -mtune=@var{cpu}
15286 @opindex mtune
15287 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
15288 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
15289 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively.
15291 @item -multcost=@var{num}
15292 @opindex multcost
15293 Replaced by @option{-mmultcost}.
15295 @end table
15297 @node ARM Options
15298 @subsection ARM Options
15299 @cindex ARM options
15301 These @samp{-m} options are defined for the ARM port:
15303 @table @gcctabopt
15304 @item -mabi=@var{name}
15305 @opindex mabi
15306 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
15307 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
15309 @item -mapcs-frame
15310 @opindex mapcs-frame
15311 Generate a stack frame that is compliant with the ARM Procedure Call
15312 Standard for all functions, even if this is not strictly necessary for
15313 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
15314 with this option causes the stack frames not to be generated for
15315 leaf functions.  The default is @option{-mno-apcs-frame}.
15316 This option is deprecated.
15318 @item -mapcs
15319 @opindex mapcs
15320 This is a synonym for @option{-mapcs-frame} and is deprecated.
15322 @ignore
15323 @c not currently implemented
15324 @item -mapcs-stack-check
15325 @opindex mapcs-stack-check
15326 Generate code to check the amount of stack space available upon entry to
15327 every function (that actually uses some stack space).  If there is
15328 insufficient space available then either the function
15329 @code{__rt_stkovf_split_small} or @code{__rt_stkovf_split_big} is
15330 called, depending upon the amount of stack space required.  The runtime
15331 system is required to provide these functions.  The default is
15332 @option{-mno-apcs-stack-check}, since this produces smaller code.
15334 @c not currently implemented
15335 @item -mapcs-reentrant
15336 @opindex mapcs-reentrant
15337 Generate reentrant, position-independent code.  The default is
15338 @option{-mno-apcs-reentrant}.
15339 @end ignore
15341 @item -mthumb-interwork
15342 @opindex mthumb-interwork
15343 Generate code that supports calling between the ARM and Thumb
15344 instruction sets.  Without this option, on pre-v5 architectures, the
15345 two instruction sets cannot be reliably used inside one program.  The
15346 default is @option{-mno-thumb-interwork}, since slightly larger code
15347 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
15348 configurations this option is meaningless.
15350 @item -mno-sched-prolog
15351 @opindex mno-sched-prolog
15352 Prevent the reordering of instructions in the function prologue, or the
15353 merging of those instruction with the instructions in the function's
15354 body.  This means that all functions start with a recognizable set
15355 of instructions (or in fact one of a choice from a small set of
15356 different function prologues), and this information can be used to
15357 locate the start of functions inside an executable piece of code.  The
15358 default is @option{-msched-prolog}.
15360 @item -mfloat-abi=@var{name}
15361 @opindex mfloat-abi
15362 Specifies which floating-point ABI to use.  Permissible values
15363 are: @samp{soft}, @samp{softfp} and @samp{hard}.
15365 Specifying @samp{soft} causes GCC to generate output containing
15366 library calls for floating-point operations.
15367 @samp{softfp} allows the generation of code using hardware floating-point
15368 instructions, but still uses the soft-float calling conventions.
15369 @samp{hard} allows generation of floating-point instructions
15370 and uses FPU-specific calling conventions.
15372 The default depends on the specific target configuration.  Note that
15373 the hard-float and soft-float ABIs are not link-compatible; you must
15374 compile your entire program with the same ABI, and link with a
15375 compatible set of libraries.
15377 @item -mlittle-endian
15378 @opindex mlittle-endian
15379 Generate code for a processor running in little-endian mode.  This is
15380 the default for all standard configurations.
15382 @item -mbig-endian
15383 @opindex mbig-endian
15384 Generate code for a processor running in big-endian mode; the default is
15385 to compile code for a little-endian processor.
15387 @item -mbe8
15388 @itemx -mbe32
15389 @opindex mbe8
15390 When linking a big-endian image select between BE8 and BE32 formats.
15391 The option has no effect for little-endian images and is ignored.  The
15392 default is dependent on the selected target architecture.  For ARMv6
15393 and later architectures the default is BE8, for older architectures
15394 the default is BE32.  BE32 format has been deprecated by ARM.
15396 @item -march=@var{name}@r{[}+extension@dots{}@r{]}
15397 @opindex march
15398 This specifies the name of the target ARM architecture.  GCC uses this
15399 name to determine what kind of instructions it can emit when generating
15400 assembly code.  This option can be used in conjunction with or instead
15401 of the @option{-mcpu=} option.
15403 Permissible names are:
15404 @samp{armv4t},
15405 @samp{armv5t}, @samp{armv5te},
15406 @samp{armv6}, @samp{armv6j}, @samp{armv6k}, @samp{armv6kz}, @samp{armv6t2},
15407 @samp{armv6z}, @samp{armv6zk},
15408 @samp{armv7}, @samp{armv7-a}, @samp{armv7ve}, 
15409 @samp{armv8-a}, @samp{armv8.1-a}, @samp{armv8.2-a},
15410 @samp{armv7-r},
15411 @samp{armv8-r},
15412 @samp{armv6-m}, @samp{armv6s-m},
15413 @samp{armv7-m}, @samp{armv7e-m},
15414 @samp{armv8-m.base}, @samp{armv8-m.main},
15415 @samp{iwmmxt} and @samp{iwmmxt2}.
15417 Additionally, the following architectures, which lack support for the
15418 Thumb exection state, are recognized but support is deprecated:
15419 @samp{armv2}, @samp{armv2a}, @samp{armv3}, @samp{armv3m},
15420 @samp{armv4}, @samp{armv5} and @samp{armv5e}.
15422 Many of the architectures support extensions.  These can be added by
15423 appending @samp{+@var{extension}} to the architecture name.  Extension
15424 options are processed in order and capabilities accumulate.  An extension
15425 will also enable any necessary base extensions
15426 upon which it depends.  For example, the @samp{+crypto} extension
15427 will always enable the @samp{+simd} extension.  The exception to the
15428 additive construction is for extensions that are prefixed with
15429 @samp{+no@dots{}}: these extensions disable the specified option and
15430 any other extensions that may depend on the presence of that
15431 extension.
15433 For example, @samp{-march=armv7-a+simd+nofp+vfpv4} is equivalent to
15434 writing @samp{-march=armv7-a+vfpv4} since the @samp{+simd} option is
15435 entirely disabled by the @samp{+nofp} option that follows it.
15437 Most extension names are generically named, but have an effect that is
15438 dependent upon the architecture to which it is applied.  For example,
15439 the @samp{+simd} option can be applied to both @samp{armv7-a} and
15440 @samp{armv8-a} architectures, but will enable the original ARMv7
15441 Advanced SIMD (Neon) extensions for @samp{armv7-a} and the ARMv8-a
15442 variant for @samp{armv8-a}.
15444 The table below lists the supported extensions for each architecture.
15445 Architectures not mentioned do not support any extensions.
15447 @table @samp
15448 @item  armv5e
15449 @itemx armv5te
15450 @itemx armv6
15451 @itemx armv6j
15452 @itemx armv6k
15453 @itemx armv6kz
15454 @itemx armv6t2
15455 @itemx armv6z
15456 @itemx armv6zk
15457 @table @samp
15458 @item +fp
15459 The VFPv2 floating-point instructions.  The extension @samp{+vfpv2} can be
15460 used as an alias for this extension.
15462 @item +nofp
15463 Disable the floating-point instructions.
15464 @end table
15466 @item armv7
15467 The common subset of the ARMv7-A, ARMv7-R and ARMv7-M architectures.
15468 @table @samp
15469 @item +fp
15470 The VFPv3 floating-point instructions, with 16 double-precision
15471 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
15472 for this extension.  Note that floating-point is not supported by the
15473 base ARMv7-M architecture, but is compatible with both the ARMv7-A and
15474 ARMv7-R architectures.
15476 @item +nofp
15477 Disable the floating-point instructions.
15478 @end table
15480 @item armv7-a
15481 @table @samp
15482 @item +fp
15483 The VFPv3 floating-point instructions, with 16 double-precision
15484 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
15485 for this extension.
15487 @item +simd
15488 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
15489 The extensions @samp{+neon} and @samp{+neon-vfpv3} can be used as aliases
15490 for this extension.
15492 @item +vfpv3
15493 The VFPv3 floating-point instructions, with 32 double-precision
15494 registers.
15496 @item +vfpv3-d16-fp16
15497 The VFPv3 floating-point instructions, with 16 double-precision
15498 registers and the half-precision floating-point conversion operations.
15500 @item +vfpv3-fp16
15501 The VFPv3 floating-point instructions, with 32 double-precision
15502 registers and the half-precision floating-point conversion operations.
15504 @item +vfpv4-d16
15505 The VFPv4 floating-point instructions, with 16 double-precision
15506 registers.
15508 @item +vfpv4
15509 The VFPv4 floating-point instructions, with 32 double-precision
15510 registers.
15512 @item +neon-fp16
15513 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
15514 the half-precision floating-point conversion operations.
15516 @item +neon-vfpv4
15517 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.
15519 @item +nosimd
15520 Disable the Advanced SIMD instructions (does not disable floating point).
15522 @item +nofp
15523 Disable the floating-point and Advanced SIMD instructions.
15524 @end table
15526 @item armv7ve
15527 The extended version of the ARMv7-A architecture with support for
15528 virtualization.
15529 @table @samp
15530 @item +fp
15531 The VFPv4 floating-point instructions, with 16 double-precision registers.
15532 The extension @samp{+vfpv4-d16} can be used as an alias for this extension.
15534 @item +simd
15535 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.  The
15536 extension @samp{+neon-vfpv4} can be used as an alias for this extension.
15538 @item +vfpv3-d16
15539 The VFPv3 floating-point instructions, with 16 double-precision
15540 registers.
15542 @item +vfpv3
15543 The VFPv3 floating-point instructions, with 32 double-precision
15544 registers.
15546 @item +vfpv3-d16-fp16
15547 The VFPv3 floating-point instructions, with 16 double-precision
15548 registers and the half-precision floating-point conversion operations.
15550 @item +vfpv3-fp16
15551 The VFPv3 floating-point instructions, with 32 double-precision
15552 registers and the half-precision floating-point conversion operations.
15554 @item +vfpv4-d16
15555 The VFPv4 floating-point instructions, with 16 double-precision
15556 registers.
15558 @item +vfpv4
15559 The VFPv4 floating-point instructions, with 32 double-precision
15560 registers.
15562 @item +neon
15563 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
15564 The extension @samp{+neon-vfpv3} can be used as an alias for this extension.
15566 @item +neon-fp16
15567 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
15568 the half-precision floating-point conversion operations.
15570 @item +nosimd
15571 Disable the Advanced SIMD instructions (does not disable floating point).
15573 @item +nofp
15574 Disable the floating-point and Advanced SIMD instructions.
15575 @end table
15577 @item armv8-a
15578 @table @samp
15579 @item +crc
15580 The Cyclic Redundancy Check (CRC) instructions.
15581 @item +simd
15582 The ARMv8 Advanced SIMD and floating-point instructions.
15583 @item +crypto
15584 The cryptographic instructions.
15585 @item +nocrypto
15586 Disable the cryptographic isntructions.
15587 @item +nofp
15588 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15589 @end table
15591 @item armv8.1-a
15592 @table @samp
15593 @item +simd
15594 The ARMv8.1 Advanced SIMD and floating-point instructions.
15596 @item +crypto
15597 The cryptographic instructions.  This also enables the Advanced SIMD and
15598 floating-point instructions.
15600 @item +nocrypto
15601 Disable the cryptographic isntructions.
15603 @item +nofp
15604 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15605 @end table
15607 @item armv8.2-a
15608 @table @samp
15609 @item +fp16
15610 The half-precision floating-point data processing instructions.
15611 This also enables the Advanced SIMD and floating-point instructions.
15613 @item +simd
15614 The ARMv8.1 Advanced SIMD and floating-point instructions.
15616 @item +crypto
15617 The cryptographic instructions.  This also enables the Advanced SIMD and
15618 floating-point instructions.
15620 @item +nocrypto
15621 Disable the cryptographic extension.
15623 @item +nofp
15624 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15625 @end table
15627 @item armv7-r
15628 @table @samp
15629 @item +fp.sp
15630 The single-precision VFPv3 floating-point instructions.  The extension
15631 @samp{+vfpv3xd} can be used as an alias for this extension.
15633 @item +fp
15634 The VFPv3 floating-point instructions with 16 double-precision registers.
15635 The extension +vfpv3-d16 can be used as an alias for this extension.
15637 @item +nofp
15638 Disable the floating-point extension.
15640 @item +idiv
15641 The ARM-state integer division instructions.
15643 @item +noidiv
15644 Disable the ARM-state integer division extension.
15645 @end table
15647 @item armv7e-m
15648 @table @samp
15649 @item +fp
15650 The single-precision VFPv4 floating-point instructions.
15652 @item +fpv5
15653 The single-precision FPv5 floating-point instructions.
15655 @item +fp.dp
15656 The single- and double-precision FPv5 floating-point instructions.
15658 @item +nofp
15659 Disable the floating-point extensions.
15660 @end table
15662 @item  armv8-m.main
15663 @table @samp
15664 @item +dsp
15665 The DSP instructions.
15667 @item +nodsp
15668 Disable the DSP extension.
15670 @item +fp
15671 The single-precision floating-point instructions.
15673 @item +fp.dp
15674 The single- and double-precision floating-point instructions.
15676 @item +nofp
15677 Disable the floating-point extension.
15678 @end table
15680 @item armv8-r
15681 @table @samp
15682 @item +crc
15683 The Cyclic Redundancy Check (CRC) instructions.
15684 @item +fp.sp
15685 The single-precision FPv5 floating-point instructions.
15686 @item +simd
15687 The ARMv8 Advanced SIMD and floating-point instructions.
15688 @item +crypto
15689 The cryptographic instructions.
15690 @item +nocrypto
15691 Disable the cryptographic isntructions.
15692 @item +nofp
15693 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15694 @end table
15696 @end table
15698 @option{-march=native} causes the compiler to auto-detect the architecture
15699 of the build computer.  At present, this feature is only supported on
15700 GNU/Linux, and not all architectures are recognized.  If the auto-detect
15701 is unsuccessful the option has no effect.
15703 @item -mtune=@var{name}
15704 @opindex mtune
15705 This option specifies the name of the target ARM processor for
15706 which GCC should tune the performance of the code.
15707 For some ARM implementations better performance can be obtained by using
15708 this option.
15709 Permissible names are: @samp{arm2}, @samp{arm250},
15710 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
15711 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
15712 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
15713 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
15714 @samp{arm720},
15715 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
15716 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
15717 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
15718 @samp{strongarm1110},
15719 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
15720 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
15721 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
15722 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
15723 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
15724 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
15725 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
15726 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8},
15727 @samp{cortex-a9}, @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a17},
15728 @samp{cortex-a32}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
15729 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
15730 @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7},
15731 @samp{cortex-r8}, @samp{cortex-r52},
15732 @samp{cortex-m33},
15733 @samp{cortex-m23},
15734 @samp{cortex-m7},
15735 @samp{cortex-m4},
15736 @samp{cortex-m3},
15737 @samp{cortex-m1},
15738 @samp{cortex-m0},
15739 @samp{cortex-m0plus},
15740 @samp{cortex-m1.small-multiply},
15741 @samp{cortex-m0.small-multiply},
15742 @samp{cortex-m0plus.small-multiply},
15743 @samp{exynos-m1},
15744 @samp{marvell-pj4},
15745 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
15746 @samp{fa526}, @samp{fa626},
15747 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te},
15748 @samp{xgene1}.
15750 Additionally, this option can specify that GCC should tune the performance
15751 of the code for a big.LITTLE system.  Permissible names are:
15752 @samp{cortex-a15.cortex-a7}, @samp{cortex-a17.cortex-a7},
15753 @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
15754 @samp{cortex-a72.cortex-a35}, @samp{cortex-a73.cortex-a53},
15755 @samp{cortex-a75.cortex-a55}.
15757 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
15758 performance for a blend of processors within architecture @var{arch}.
15759 The aim is to generate code that run well on the current most popular
15760 processors, balancing between optimizations that benefit some CPUs in the
15761 range, and avoiding performance pitfalls of other CPUs.  The effects of
15762 this option may change in future GCC versions as CPU models come and go.
15764 @option{-mtune} permits the same extension options as @option{-mcpu}, but
15765 the extension options do not affect the tuning of the generated code.
15767 @option{-mtune=native} causes the compiler to auto-detect the CPU
15768 of the build computer.  At present, this feature is only supported on
15769 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
15770 unsuccessful the option has no effect.
15772 @item -mcpu=@var{name}@r{[}+extension@dots{}@r{]}
15773 @opindex mcpu
15774 This specifies the name of the target ARM processor.  GCC uses this name
15775 to derive the name of the target ARM architecture (as if specified
15776 by @option{-march}) and the ARM processor type for which to tune for
15777 performance (as if specified by @option{-mtune}).  Where this option
15778 is used in conjunction with @option{-march} or @option{-mtune},
15779 those options take precedence over the appropriate part of this option.
15781 Many of the supported CPUs implement optional architectural
15782 extensions.  Where this is so the architectural extensions are
15783 normally enabled by default.  If implementations that lack the
15784 extension exist, then the extension syntax can be used to disable
15785 those extensions that have been omitted.  For floating-point and
15786 Advanced SIMD (Neon) instructions, the settings of the options
15787 @option{-mfloat-abi} and @option{-mfpu} must also be considered:
15788 floating-point and Advanced SIMD instructions will only be used if
15789 @option{-mfloat-abi} is not set to @samp{soft}; and any setting of
15790 @option{-mfpu} other than @samp{auto} will override the available
15791 floating-point and SIMD extension instructions.
15793 For example, @samp{cortex-a9} can be found in three major
15794 configurations: integer only, with just a floating-point unit or with
15795 floating-point and Advanced SIMD.  The default is to enable all the
15796 instructions, but the extensions @samp{+nosimd} and @samp{+nofp} can
15797 be used to disable just the SIMD or both the SIMD and floating-point
15798 instructions respectively.
15800 Permissible names for this option are the same as those for
15801 @option{-mtune}.
15803 The following extension options are common to the listed CPUs:
15805 @table @samp
15806 @item  +nofp
15807 Disables the floating-point instructions on @samp{arm9e},
15808 @samp{arm946e-s}, @samp{arm966e-s}, @samp{arm968e-s}, @samp{arm10e},
15809 @samp{arm1020e}, @samp{arm1022e}, @samp{arm926ej-s},
15810 @samp{arm1026ej-s}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-r8},
15811 @samp{cortex-m4}, @samp{cortex-m7} and @samp{cortex-m33}.
15812 Disables the floating-point and SIMD instructions on
15813 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7},
15814 @samp{cortex-a8}, @samp{cortex-a9}, @samp{cortex-a12},
15815 @samp{cortex-a15}, @samp{cortex-a17}, @samp{cortex-a15.cortex-a7},
15816 @samp{cortex-a17.cortex-a7}, @samp{cortex-a32}, @samp{cortex-a35},
15817 @samp{cortex-a53} and @samp{cortex-a55}.
15819 @item +nofp.dp
15820 Disables the double-precision component of the floating-point instructions
15821 on @samp{cortex-r5}, @samp{cortex-r52} and @samp{cortex-m7}.
15823 @item +nosimd
15824 Disables the SIMD (but not floating-point) instructions on
15825 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}
15826 and @samp{cortex-a9}.
15828 @item +crypto
15829 Enables the cryptographic instructions on @samp{cortex-a32},
15830 @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55}, @samp{cortex-a57},
15831 @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75}, @samp{exynos-m1},
15832 @samp{xgene1}, @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
15833 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53} and
15834 @samp{cortex-a75.cortex-a55}.
15835 @end table
15837 Additionally the @samp{generic-armv7-a} pseudo target defaults to
15838 VFPv3 with 16 double-precision registers.  It supports the following
15839 extension options: @samp{vfpv3-d16}, @samp{vfpv3},
15840 @samp{vfpv3-d16-fp16}, @samp{vfpv3-fp16}, @samp{vfpv4-d16},
15841 @samp{vfpv4}, @samp{neon}, @samp{neon-vfpv3}, @samp{neon-fp16},
15842 @samp{neon-vfpv4}.  The meanings are the same as for the extensions to
15843 @option{-march=armv7-a}.
15845 @option{-mcpu=generic-@var{arch}} is also permissible, and is
15846 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
15847 See @option{-mtune} for more information.
15849 @option{-mcpu=native} causes the compiler to auto-detect the CPU
15850 of the build computer.  At present, this feature is only supported on
15851 GNU/Linux, and not all architectures are recognized.  If the auto-detect
15852 is unsuccessful the option has no effect.
15854 @item -mfpu=@var{name}
15855 @opindex mfpu
15856 This specifies what floating-point hardware (or hardware emulation) is
15857 available on the target.  Permissible names are: @samp{auto}, @samp{vfpv2},
15858 @samp{vfpv3},
15859 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
15860 @samp{vfpv3xd-fp16}, @samp{neon-vfpv3}, @samp{neon-fp16}, @samp{vfpv4},
15861 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
15862 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
15863 @samp{fp-armv8}, @samp{neon-fp-armv8} and @samp{crypto-neon-fp-armv8}.
15864 Note that @samp{neon} is an alias for @samp{neon-vfpv3} and @samp{vfp}
15865 is an alias for @samp{vfpv2}.
15867 The setting @samp{auto} is the default and is special.  It causes the
15868 compiler to select the floating-point and Advanced SIMD instructions
15869 based on the settings of @option{-mcpu} and @option{-march}.
15871 If the selected floating-point hardware includes the NEON extension
15872 (e.g. @option{-mfpu=neon}), note that floating-point
15873 operations are not generated by GCC's auto-vectorization pass unless
15874 @option{-funsafe-math-optimizations} is also specified.  This is
15875 because NEON hardware does not fully implement the IEEE 754 standard for
15876 floating-point arithmetic (in particular denormal values are treated as
15877 zero), so the use of NEON instructions may lead to a loss of precision.
15879 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}).
15881 @item -mfp16-format=@var{name}
15882 @opindex mfp16-format
15883 Specify the format of the @code{__fp16} half-precision floating-point type.
15884 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
15885 the default is @samp{none}, in which case the @code{__fp16} type is not
15886 defined.  @xref{Half-Precision}, for more information.
15888 @item -mstructure-size-boundary=@var{n}
15889 @opindex mstructure-size-boundary
15890 The sizes of all structures and unions are rounded up to a multiple
15891 of the number of bits set by this option.  Permissible values are 8, 32
15892 and 64.  The default value varies for different toolchains.  For the COFF
15893 targeted toolchain the default value is 8.  A value of 64 is only allowed
15894 if the underlying ABI supports it.
15896 Specifying a larger number can produce faster, more efficient code, but
15897 can also increase the size of the program.  Different values are potentially
15898 incompatible.  Code compiled with one value cannot necessarily expect to
15899 work with code or libraries compiled with another value, if they exchange
15900 information using structures or unions.
15902 This option is deprecated.
15904 @item -mabort-on-noreturn
15905 @opindex mabort-on-noreturn
15906 Generate a call to the function @code{abort} at the end of a
15907 @code{noreturn} function.  It is executed if the function tries to
15908 return.
15910 @item -mlong-calls
15911 @itemx -mno-long-calls
15912 @opindex mlong-calls
15913 @opindex mno-long-calls
15914 Tells the compiler to perform function calls by first loading the
15915 address of the function into a register and then performing a subroutine
15916 call on this register.  This switch is needed if the target function
15917 lies outside of the 64-megabyte addressing range of the offset-based
15918 version of subroutine call instruction.
15920 Even if this switch is enabled, not all function calls are turned
15921 into long calls.  The heuristic is that static functions, functions
15922 that have the @code{short_call} attribute, functions that are inside
15923 the scope of a @code{#pragma no_long_calls} directive, and functions whose
15924 definitions have already been compiled within the current compilation
15925 unit are not turned into long calls.  The exceptions to this rule are
15926 that weak function definitions, functions with the @code{long_call}
15927 attribute or the @code{section} attribute, and functions that are within
15928 the scope of a @code{#pragma long_calls} directive are always
15929 turned into long calls.
15931 This feature is not enabled by default.  Specifying
15932 @option{-mno-long-calls} restores the default behavior, as does
15933 placing the function calls within the scope of a @code{#pragma
15934 long_calls_off} directive.  Note these switches have no effect on how
15935 the compiler generates code to handle function calls via function
15936 pointers.
15938 @item -msingle-pic-base
15939 @opindex msingle-pic-base
15940 Treat the register used for PIC addressing as read-only, rather than
15941 loading it in the prologue for each function.  The runtime system is
15942 responsible for initializing this register with an appropriate value
15943 before execution begins.
15945 @item -mpic-register=@var{reg}
15946 @opindex mpic-register
15947 Specify the register to be used for PIC addressing.
15948 For standard PIC base case, the default is any suitable register
15949 determined by compiler.  For single PIC base case, the default is
15950 @samp{R9} if target is EABI based or stack-checking is enabled,
15951 otherwise the default is @samp{R10}.
15953 @item -mpic-data-is-text-relative
15954 @opindex mpic-data-is-text-relative
15955 Assume that the displacement between the text and data segments is fixed
15956 at static link time.  This permits using PC-relative addressing
15957 operations to access data known to be in the data segment.  For
15958 non-VxWorks RTP targets, this option is enabled by default.  When
15959 disabled on such targets, it will enable @option{-msingle-pic-base} by
15960 default.
15962 @item -mpoke-function-name
15963 @opindex mpoke-function-name
15964 Write the name of each function into the text section, directly
15965 preceding the function prologue.  The generated code is similar to this:
15967 @smallexample
15968      t0
15969          .ascii "arm_poke_function_name", 0
15970          .align
15971      t1
15972          .word 0xff000000 + (t1 - t0)
15973      arm_poke_function_name
15974          mov     ip, sp
15975          stmfd   sp!, @{fp, ip, lr, pc@}
15976          sub     fp, ip, #4
15977 @end smallexample
15979 When performing a stack backtrace, code can inspect the value of
15980 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
15981 location @code{pc - 12} and the top 8 bits are set, then we know that
15982 there is a function name embedded immediately preceding this location
15983 and has length @code{((pc[-3]) & 0xff000000)}.
15985 @item -mthumb
15986 @itemx -marm
15987 @opindex marm
15988 @opindex mthumb
15990 Select between generating code that executes in ARM and Thumb
15991 states.  The default for most configurations is to generate code
15992 that executes in ARM state, but the default can be changed by
15993 configuring GCC with the @option{--with-mode=}@var{state}
15994 configure option.
15996 You can also override the ARM and Thumb mode for each function
15997 by using the @code{target("thumb")} and @code{target("arm")} function attributes
15998 (@pxref{ARM Function Attributes}) or pragmas (@pxref{Function Specific Option Pragmas}).
16000 @item -mtpcs-frame
16001 @opindex mtpcs-frame
16002 Generate a stack frame that is compliant with the Thumb Procedure Call
16003 Standard for all non-leaf functions.  (A leaf function is one that does
16004 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
16006 @item -mtpcs-leaf-frame
16007 @opindex mtpcs-leaf-frame
16008 Generate a stack frame that is compliant with the Thumb Procedure Call
16009 Standard for all leaf functions.  (A leaf function is one that does
16010 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
16012 @item -mcallee-super-interworking
16013 @opindex mcallee-super-interworking
16014 Gives all externally visible functions in the file being compiled an ARM
16015 instruction set header which switches to Thumb mode before executing the
16016 rest of the function.  This allows these functions to be called from
16017 non-interworking code.  This option is not valid in AAPCS configurations
16018 because interworking is enabled by default.
16020 @item -mcaller-super-interworking
16021 @opindex mcaller-super-interworking
16022 Allows calls via function pointers (including virtual functions) to
16023 execute correctly regardless of whether the target code has been
16024 compiled for interworking or not.  There is a small overhead in the cost
16025 of executing a function pointer if this option is enabled.  This option
16026 is not valid in AAPCS configurations because interworking is enabled
16027 by default.
16029 @item -mtp=@var{name}
16030 @opindex mtp
16031 Specify the access model for the thread local storage pointer.  The valid
16032 models are @samp{soft}, which generates calls to @code{__aeabi_read_tp},
16033 @samp{cp15}, which fetches the thread pointer from @code{cp15} directly
16034 (supported in the arm6k architecture), and @samp{auto}, which uses the
16035 best available method for the selected processor.  The default setting is
16036 @samp{auto}.
16038 @item -mtls-dialect=@var{dialect}
16039 @opindex mtls-dialect
16040 Specify the dialect to use for accessing thread local storage.  Two
16041 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
16042 @samp{gnu} dialect selects the original GNU scheme for supporting
16043 local and global dynamic TLS models.  The @samp{gnu2} dialect
16044 selects the GNU descriptor scheme, which provides better performance
16045 for shared libraries.  The GNU descriptor scheme is compatible with
16046 the original scheme, but does require new assembler, linker and
16047 library support.  Initial and local exec TLS models are unaffected by
16048 this option and always use the original scheme.
16050 @item -mword-relocations
16051 @opindex mword-relocations
16052 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
16053 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
16054 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
16055 is specified.
16057 @item -mfix-cortex-m3-ldrd
16058 @opindex mfix-cortex-m3-ldrd
16059 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
16060 with overlapping destination and base registers are used.  This option avoids
16061 generating these instructions.  This option is enabled by default when
16062 @option{-mcpu=cortex-m3} is specified.
16064 @item -munaligned-access
16065 @itemx -mno-unaligned-access
16066 @opindex munaligned-access
16067 @opindex mno-unaligned-access
16068 Enables (or disables) reading and writing of 16- and 32- bit values
16069 from addresses that are not 16- or 32- bit aligned.  By default
16070 unaligned access is disabled for all pre-ARMv6, all ARMv6-M and for
16071 ARMv8-M Baseline architectures, and enabled for all other
16072 architectures.  If unaligned access is not enabled then words in packed
16073 data structures are accessed a byte at a time.
16075 The ARM attribute @code{Tag_CPU_unaligned_access} is set in the
16076 generated object file to either true or false, depending upon the
16077 setting of this option.  If unaligned access is enabled then the
16078 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} is also
16079 defined.
16081 @item -mneon-for-64bits
16082 @opindex mneon-for-64bits
16083 Enables using Neon to handle scalar 64-bits operations. This is
16084 disabled by default since the cost of moving data from core registers
16085 to Neon is high.
16087 @item -mslow-flash-data
16088 @opindex mslow-flash-data
16089 Assume loading data from flash is slower than fetching instruction.
16090 Therefore literal load is minimized for better performance.
16091 This option is only supported when compiling for ARMv7 M-profile and
16092 off by default.
16094 @item -masm-syntax-unified
16095 @opindex masm-syntax-unified
16096 Assume inline assembler is using unified asm syntax.  The default is
16097 currently off which implies divided syntax.  This option has no impact
16098 on Thumb2. However, this may change in future releases of GCC.
16099 Divided syntax should be considered deprecated.
16101 @item -mrestrict-it
16102 @opindex mrestrict-it
16103 Restricts generation of IT blocks to conform to the rules of ARMv8.
16104 IT blocks can only contain a single 16-bit instruction from a select
16105 set of instructions. This option is on by default for ARMv8 Thumb mode.
16107 @item -mprint-tune-info
16108 @opindex mprint-tune-info
16109 Print CPU tuning information as comment in assembler file.  This is
16110 an option used only for regression testing of the compiler and not
16111 intended for ordinary use in compiling code.  This option is disabled
16112 by default.
16114 @item -mpure-code
16115 @opindex mpure-code
16116 Do not allow constant data to be placed in code sections.
16117 Additionally, when compiling for ELF object format give all text sections the
16118 ELF processor-specific section attribute @code{SHF_ARM_PURECODE}.  This option
16119 is only available when generating non-pic code for M-profile targets with the
16120 MOVT instruction.
16122 @item -mcmse
16123 @opindex mcmse
16124 Generate secure code as per the "ARMv8-M Security Extensions: Requirements on
16125 Development Tools Engineering Specification", which can be found on
16126 @url{http://infocenter.arm.com/help/topic/com.arm.doc.ecm0359818/ECM0359818_armv8m_security_extensions_reqs_on_dev_tools_1_0.pdf}.
16127 @end table
16129 @node AVR Options
16130 @subsection AVR Options
16131 @cindex AVR Options
16133 These options are defined for AVR implementations:
16135 @table @gcctabopt
16136 @item -mmcu=@var{mcu}
16137 @opindex mmcu
16138 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
16140 The default for this option is@tie{}@samp{avr2}.
16142 GCC supports the following AVR devices and ISAs:
16144 @include avr-mmcu.texi
16146 @item -mabsdata
16147 @opindex mabsdata
16149 Assume that all data in static storage can be accessed by LDS / STS
16150 instructions.  This option has only an effect on reduced Tiny devices like
16151 ATtiny40.  See also the @code{absdata}
16152 @ref{AVR Variable Attributes,variable attribute}.
16154 @item -maccumulate-args
16155 @opindex maccumulate-args
16156 Accumulate outgoing function arguments and acquire/release the needed
16157 stack space for outgoing function arguments once in function
16158 prologue/epilogue.  Without this option, outgoing arguments are pushed
16159 before calling a function and popped afterwards.
16161 Popping the arguments after the function call can be expensive on
16162 AVR so that accumulating the stack space might lead to smaller
16163 executables because arguments need not be removed from the
16164 stack after such a function call.
16166 This option can lead to reduced code size for functions that perform
16167 several calls to functions that get their arguments on the stack like
16168 calls to printf-like functions.
16170 @item -mbranch-cost=@var{cost}
16171 @opindex mbranch-cost
16172 Set the branch costs for conditional branch instructions to
16173 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
16174 integers. The default branch cost is 0.
16176 @item -mcall-prologues
16177 @opindex mcall-prologues
16178 Functions prologues/epilogues are expanded as calls to appropriate
16179 subroutines.  Code size is smaller.
16181 @item -mgas-isr-prologues
16182 @opindex mgas-isr-prologues
16183 Interrupt service routines (ISRs) may use the @code{__gcc_isr} pseudo
16184 instruction supported by GNU Binutils.
16185 If this option is on, the feature can still be disabled for individual
16186 ISRs by means of the @ref{AVR Function Attributes,,@code{no_gccisr}}
16187 function attribute.  This feature is activated per default
16188 if optimization is on (but not with @option{-Og}, @pxref{Optimize Options}),
16189 and if GNU Binutils support @w{@uref{https://sourceware.org/PR21683,PR21683}}.
16191 @item -mint8
16192 @opindex mint8
16193 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
16194 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
16195 and @code{long long} is 4 bytes.  Please note that this option does not
16196 conform to the C standards, but it results in smaller code
16197 size.
16199 @item -mn-flash=@var{num}
16200 @opindex mn-flash
16201 Assume that the flash memory has a size of 
16202 @var{num} times 64@tie{}KiB.
16204 @item -mno-interrupts
16205 @opindex mno-interrupts
16206 Generated code is not compatible with hardware interrupts.
16207 Code size is smaller.
16209 @item -mrelax
16210 @opindex mrelax
16211 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
16212 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
16213 Setting @option{-mrelax} just adds the @option{--mlink-relax} option to
16214 the assembler's command line and the @option{--relax} option to the
16215 linker's command line.
16217 Jump relaxing is performed by the linker because jump offsets are not
16218 known before code is located. Therefore, the assembler code generated by the
16219 compiler is the same, but the instructions in the executable may
16220 differ from instructions in the assembler code.
16222 Relaxing must be turned on if linker stubs are needed, see the
16223 section on @code{EIND} and linker stubs below.
16225 @item -mrmw
16226 @opindex mrmw
16227 Assume that the device supports the Read-Modify-Write
16228 instructions @code{XCH}, @code{LAC}, @code{LAS} and @code{LAT}.
16230 @item -mshort-calls
16231 @opindex mshort-calls
16233 Assume that @code{RJMP} and @code{RCALL} can target the whole
16234 program memory.
16236 This option is used internally for multilib selection.  It is
16237 not an optimization option, and you don't need to set it by hand.
16239 @item -msp8
16240 @opindex msp8
16241 Treat the stack pointer register as an 8-bit register,
16242 i.e.@: assume the high byte of the stack pointer is zero.
16243 In general, you don't need to set this option by hand.
16245 This option is used internally by the compiler to select and
16246 build multilibs for architectures @code{avr2} and @code{avr25}.
16247 These architectures mix devices with and without @code{SPH}.
16248 For any setting other than @option{-mmcu=avr2} or @option{-mmcu=avr25}
16249 the compiler driver adds or removes this option from the compiler
16250 proper's command line, because the compiler then knows if the device
16251 or architecture has an 8-bit stack pointer and thus no @code{SPH}
16252 register or not.
16254 @item -mstrict-X
16255 @opindex mstrict-X
16256 Use address register @code{X} in a way proposed by the hardware.  This means
16257 that @code{X} is only used in indirect, post-increment or
16258 pre-decrement addressing.
16260 Without this option, the @code{X} register may be used in the same way
16261 as @code{Y} or @code{Z} which then is emulated by additional
16262 instructions.  
16263 For example, loading a value with @code{X+const} addressing with a
16264 small non-negative @code{const < 64} to a register @var{Rn} is
16265 performed as
16267 @example
16268 adiw r26, const   ; X += const
16269 ld   @var{Rn}, X        ; @var{Rn} = *X
16270 sbiw r26, const   ; X -= const
16271 @end example
16273 @item -mtiny-stack
16274 @opindex mtiny-stack
16275 Only change the lower 8@tie{}bits of the stack pointer.
16277 @item -mfract-convert-truncate
16278 @opindex mfract-convert-truncate
16279 Allow to use truncation instead of rounding towards zero for fractional fixed-point types.
16281 @item -nodevicelib
16282 @opindex nodevicelib
16283 Don't link against AVR-LibC's device specific library @code{lib<mcu>.a}.
16285 @item -Waddr-space-convert
16286 @opindex Waddr-space-convert
16287 Warn about conversions between address spaces in the case where the
16288 resulting address space is not contained in the incoming address space.
16290 @item -Wmisspelled-isr
16291 @opindex Wmisspelled-isr
16292 Warn if the ISR is misspelled, i.e. without __vector prefix.
16293 Enabled by default.
16294 @end table
16296 @subsubsection @code{EIND} and Devices with More Than 128 Ki Bytes of Flash
16297 @cindex @code{EIND}
16298 Pointers in the implementation are 16@tie{}bits wide.
16299 The address of a function or label is represented as word address so
16300 that indirect jumps and calls can target any code address in the
16301 range of 64@tie{}Ki words.
16303 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
16304 bytes of program memory space, there is a special function register called
16305 @code{EIND} that serves as most significant part of the target address
16306 when @code{EICALL} or @code{EIJMP} instructions are used.
16308 Indirect jumps and calls on these devices are handled as follows by
16309 the compiler and are subject to some limitations:
16311 @itemize @bullet
16313 @item
16314 The compiler never sets @code{EIND}.
16316 @item
16317 The compiler uses @code{EIND} implicitly in @code{EICALL}/@code{EIJMP}
16318 instructions or might read @code{EIND} directly in order to emulate an
16319 indirect call/jump by means of a @code{RET} instruction.
16321 @item
16322 The compiler assumes that @code{EIND} never changes during the startup
16323 code or during the application. In particular, @code{EIND} is not
16324 saved/restored in function or interrupt service routine
16325 prologue/epilogue.
16327 @item
16328 For indirect calls to functions and computed goto, the linker
16329 generates @emph{stubs}. Stubs are jump pads sometimes also called
16330 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
16331 The stub contains a direct jump to the desired address.
16333 @item
16334 Linker relaxation must be turned on so that the linker generates
16335 the stubs correctly in all situations. See the compiler option
16336 @option{-mrelax} and the linker option @option{--relax}.
16337 There are corner cases where the linker is supposed to generate stubs
16338 but aborts without relaxation and without a helpful error message.
16340 @item
16341 The default linker script is arranged for code with @code{EIND = 0}.
16342 If code is supposed to work for a setup with @code{EIND != 0}, a custom
16343 linker script has to be used in order to place the sections whose
16344 name start with @code{.trampolines} into the segment where @code{EIND}
16345 points to.
16347 @item
16348 The startup code from libgcc never sets @code{EIND}.
16349 Notice that startup code is a blend of code from libgcc and AVR-LibC.
16350 For the impact of AVR-LibC on @code{EIND}, see the
16351 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
16353 @item
16354 It is legitimate for user-specific startup code to set up @code{EIND}
16355 early, for example by means of initialization code located in
16356 section @code{.init3}. Such code runs prior to general startup code
16357 that initializes RAM and calls constructors, but after the bit
16358 of startup code from AVR-LibC that sets @code{EIND} to the segment
16359 where the vector table is located.
16360 @example
16361 #include <avr/io.h>
16363 static void
16364 __attribute__((section(".init3"),naked,used,no_instrument_function))
16365 init3_set_eind (void)
16367   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
16368                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
16370 @end example
16372 @noindent
16373 The @code{__trampolines_start} symbol is defined in the linker script.
16375 @item
16376 Stubs are generated automatically by the linker if
16377 the following two conditions are met:
16378 @itemize @minus
16380 @item The address of a label is taken by means of the @code{gs} modifier
16381 (short for @emph{generate stubs}) like so:
16382 @example
16383 LDI r24, lo8(gs(@var{func}))
16384 LDI r25, hi8(gs(@var{func}))
16385 @end example
16386 @item The final location of that label is in a code segment
16387 @emph{outside} the segment where the stubs are located.
16388 @end itemize
16390 @item
16391 The compiler emits such @code{gs} modifiers for code labels in the
16392 following situations:
16393 @itemize @minus
16394 @item Taking address of a function or code label.
16395 @item Computed goto.
16396 @item If prologue-save function is used, see @option{-mcall-prologues}
16397 command-line option.
16398 @item Switch/case dispatch tables. If you do not want such dispatch
16399 tables you can specify the @option{-fno-jump-tables} command-line option.
16400 @item C and C++ constructors/destructors called during startup/shutdown.
16401 @item If the tools hit a @code{gs()} modifier explained above.
16402 @end itemize
16404 @item
16405 Jumping to non-symbolic addresses like so is @emph{not} supported:
16407 @example
16408 int main (void)
16410     /* Call function at word address 0x2 */
16411     return ((int(*)(void)) 0x2)();
16413 @end example
16415 Instead, a stub has to be set up, i.e.@: the function has to be called
16416 through a symbol (@code{func_4} in the example):
16418 @example
16419 int main (void)
16421     extern int func_4 (void);
16423     /* Call function at byte address 0x4 */
16424     return func_4();
16426 @end example
16428 and the application be linked with @option{-Wl,--defsym,func_4=0x4}.
16429 Alternatively, @code{func_4} can be defined in the linker script.
16430 @end itemize
16432 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
16433 @cindex @code{RAMPD}
16434 @cindex @code{RAMPX}
16435 @cindex @code{RAMPY}
16436 @cindex @code{RAMPZ}
16437 Some AVR devices support memories larger than the 64@tie{}KiB range
16438 that can be accessed with 16-bit pointers.  To access memory locations
16439 outside this 64@tie{}KiB range, the content of a @code{RAMP}
16440 register is used as high part of the address:
16441 The @code{X}, @code{Y}, @code{Z} address register is concatenated
16442 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
16443 register, respectively, to get a wide address. Similarly,
16444 @code{RAMPD} is used together with direct addressing.
16446 @itemize
16447 @item
16448 The startup code initializes the @code{RAMP} special function
16449 registers with zero.
16451 @item
16452 If a @ref{AVR Named Address Spaces,named address space} other than
16453 generic or @code{__flash} is used, then @code{RAMPZ} is set
16454 as needed before the operation.
16456 @item
16457 If the device supports RAM larger than 64@tie{}KiB and the compiler
16458 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
16459 is reset to zero after the operation.
16461 @item
16462 If the device comes with a specific @code{RAMP} register, the ISR
16463 prologue/epilogue saves/restores that SFR and initializes it with
16464 zero in case the ISR code might (implicitly) use it.
16466 @item
16467 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
16468 If you use inline assembler to read from locations outside the
16469 16-bit address range and change one of the @code{RAMP} registers,
16470 you must reset it to zero after the access.
16472 @end itemize
16474 @subsubsection AVR Built-in Macros
16476 GCC defines several built-in macros so that the user code can test
16477 for the presence or absence of features.  Almost any of the following
16478 built-in macros are deduced from device capabilities and thus
16479 triggered by the @option{-mmcu=} command-line option.
16481 For even more AVR-specific built-in macros see
16482 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
16484 @table @code
16486 @item __AVR_ARCH__
16487 Build-in macro that resolves to a decimal number that identifies the
16488 architecture and depends on the @option{-mmcu=@var{mcu}} option.
16489 Possible values are:
16491 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
16492 @code{4}, @code{5}, @code{51}, @code{6}
16494 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3}, @code{avr31},
16495 @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51}, @code{avr6},
16497 respectively and
16499 @code{100},
16500 @code{102}, @code{103}, @code{104},
16501 @code{105}, @code{106}, @code{107}
16503 for @var{mcu}=@code{avrtiny},
16504 @code{avrxmega2}, @code{avrxmega3}, @code{avrxmega4},
16505 @code{avrxmega5}, @code{avrxmega6}, @code{avrxmega7}, respectively.
16506 If @var{mcu} specifies a device, this built-in macro is set
16507 accordingly. For example, with @option{-mmcu=atmega8} the macro is
16508 defined to @code{4}.
16510 @item __AVR_@var{Device}__
16511 Setting @option{-mmcu=@var{device}} defines this built-in macro which reflects
16512 the device's name. For example, @option{-mmcu=atmega8} defines the
16513 built-in macro @code{__AVR_ATmega8__}, @option{-mmcu=attiny261a} defines
16514 @code{__AVR_ATtiny261A__}, etc.
16516 The built-in macros' names follow
16517 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
16518 the device name as from the AVR user manual. The difference between
16519 @var{Device} in the built-in macro and @var{device} in
16520 @option{-mmcu=@var{device}} is that the latter is always lowercase.
16522 If @var{device} is not a device but only a core architecture like
16523 @samp{avr51}, this macro is not defined.
16525 @item __AVR_DEVICE_NAME__
16526 Setting @option{-mmcu=@var{device}} defines this built-in macro to
16527 the device's name. For example, with @option{-mmcu=atmega8} the macro
16528 is defined to @code{atmega8}.
16530 If @var{device} is not a device but only a core architecture like
16531 @samp{avr51}, this macro is not defined.
16533 @item __AVR_XMEGA__
16534 The device / architecture belongs to the XMEGA family of devices.
16536 @item __AVR_HAVE_ELPM__
16537 The device has the @code{ELPM} instruction.
16539 @item __AVR_HAVE_ELPMX__
16540 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
16541 R@var{n},Z+} instructions.
16543 @item __AVR_HAVE_MOVW__
16544 The device has the @code{MOVW} instruction to perform 16-bit
16545 register-register moves.
16547 @item __AVR_HAVE_LPMX__
16548 The device has the @code{LPM R@var{n},Z} and
16549 @code{LPM R@var{n},Z+} instructions.
16551 @item __AVR_HAVE_MUL__
16552 The device has a hardware multiplier. 
16554 @item __AVR_HAVE_JMP_CALL__
16555 The device has the @code{JMP} and @code{CALL} instructions.
16556 This is the case for devices with more than 8@tie{}KiB of program
16557 memory.
16559 @item __AVR_HAVE_EIJMP_EICALL__
16560 @itemx __AVR_3_BYTE_PC__
16561 The device has the @code{EIJMP} and @code{EICALL} instructions.
16562 This is the case for devices with more than 128@tie{}KiB of program memory.
16563 This also means that the program counter
16564 (PC) is 3@tie{}bytes wide.
16566 @item __AVR_2_BYTE_PC__
16567 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
16568 with up to 128@tie{}KiB of program memory.
16570 @item __AVR_HAVE_8BIT_SP__
16571 @itemx __AVR_HAVE_16BIT_SP__
16572 The stack pointer (SP) register is treated as 8-bit respectively
16573 16-bit register by the compiler.
16574 The definition of these macros is affected by @option{-mtiny-stack}.
16576 @item __AVR_HAVE_SPH__
16577 @itemx __AVR_SP8__
16578 The device has the SPH (high part of stack pointer) special function
16579 register or has an 8-bit stack pointer, respectively.
16580 The definition of these macros is affected by @option{-mmcu=} and
16581 in the cases of @option{-mmcu=avr2} and @option{-mmcu=avr25} also
16582 by @option{-msp8}.
16584 @item __AVR_HAVE_RAMPD__
16585 @itemx __AVR_HAVE_RAMPX__
16586 @itemx __AVR_HAVE_RAMPY__
16587 @itemx __AVR_HAVE_RAMPZ__
16588 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
16589 @code{RAMPZ} special function register, respectively.
16591 @item __NO_INTERRUPTS__
16592 This macro reflects the @option{-mno-interrupts} command-line option.
16594 @item __AVR_ERRATA_SKIP__
16595 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
16596 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
16597 instructions because of a hardware erratum.  Skip instructions are
16598 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
16599 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
16600 set.
16602 @item __AVR_ISA_RMW__
16603 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
16605 @item __AVR_SFR_OFFSET__=@var{offset}
16606 Instructions that can address I/O special function registers directly
16607 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
16608 address as if addressed by an instruction to access RAM like @code{LD}
16609 or @code{STS}. This offset depends on the device architecture and has
16610 to be subtracted from the RAM address in order to get the
16611 respective I/O@tie{}address.
16613 @item __AVR_SHORT_CALLS__
16614 The @option{-mshort-calls} command line option is set.
16616 @item __AVR_PM_BASE_ADDRESS__=@var{addr}
16617 Some devices support reading from flash memory by means of @code{LD*}
16618 instructions.  The flash memory is seen in the data address space
16619 at an offset of @code{__AVR_PM_BASE_ADDRESS__}.  If this macro
16620 is not defined, this feature is not available.  If defined,
16621 the address space is linear and there is no need to put
16622 @code{.rodata} into RAM.  This is handled by the default linker
16623 description file, and is currently available for
16624 @code{avrtiny} and @code{avrxmega3}.  Even more convenient,
16625 there is no need to use address spaces like @code{__flash} or
16626 features like attribute @code{progmem} and @code{pgm_read_*}.
16628 @item __WITH_AVRLIBC__
16629 The compiler is configured to be used together with AVR-Libc.
16630 See the @option{--with-avrlibc} configure option.
16632 @end table
16634 @node Blackfin Options
16635 @subsection Blackfin Options
16636 @cindex Blackfin Options
16638 @table @gcctabopt
16639 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
16640 @opindex mcpu=
16641 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
16642 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
16643 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
16644 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
16645 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
16646 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
16647 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
16648 @samp{bf561}, @samp{bf592}.
16650 The optional @var{sirevision} specifies the silicon revision of the target
16651 Blackfin processor.  Any workarounds available for the targeted silicon revision
16652 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
16653 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
16654 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
16655 hexadecimal digits representing the major and minor numbers in the silicon
16656 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
16657 is not defined.  If @var{sirevision} is @samp{any}, the
16658 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
16659 If this optional @var{sirevision} is not used, GCC assumes the latest known
16660 silicon revision of the targeted Blackfin processor.
16662 GCC defines a preprocessor macro for the specified @var{cpu}.
16663 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
16664 provided by libgloss to be linked in if @option{-msim} is not given.
16666 Without this option, @samp{bf532} is used as the processor by default.
16668 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
16669 only the preprocessor macro is defined.
16671 @item -msim
16672 @opindex msim
16673 Specifies that the program will be run on the simulator.  This causes
16674 the simulator BSP provided by libgloss to be linked in.  This option
16675 has effect only for @samp{bfin-elf} toolchain.
16676 Certain other options, such as @option{-mid-shared-library} and
16677 @option{-mfdpic}, imply @option{-msim}.
16679 @item -momit-leaf-frame-pointer
16680 @opindex momit-leaf-frame-pointer
16681 Don't keep the frame pointer in a register for leaf functions.  This
16682 avoids the instructions to save, set up and restore frame pointers and
16683 makes an extra register available in leaf functions.  The option
16684 @option{-fomit-frame-pointer} removes the frame pointer for all functions,
16685 which might make debugging harder.
16687 @item -mspecld-anomaly
16688 @opindex mspecld-anomaly
16689 When enabled, the compiler ensures that the generated code does not
16690 contain speculative loads after jump instructions. If this option is used,
16691 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
16693 @item -mno-specld-anomaly
16694 @opindex mno-specld-anomaly
16695 Don't generate extra code to prevent speculative loads from occurring.
16697 @item -mcsync-anomaly
16698 @opindex mcsync-anomaly
16699 When enabled, the compiler ensures that the generated code does not
16700 contain CSYNC or SSYNC instructions too soon after conditional branches.
16701 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
16703 @item -mno-csync-anomaly
16704 @opindex mno-csync-anomaly
16705 Don't generate extra code to prevent CSYNC or SSYNC instructions from
16706 occurring too soon after a conditional branch.
16708 @item -mlow-64k
16709 @opindex mlow-64k
16710 When enabled, the compiler is free to take advantage of the knowledge that
16711 the entire program fits into the low 64k of memory.
16713 @item -mno-low-64k
16714 @opindex mno-low-64k
16715 Assume that the program is arbitrarily large.  This is the default.
16717 @item -mstack-check-l1
16718 @opindex mstack-check-l1
16719 Do stack checking using information placed into L1 scratchpad memory by the
16720 uClinux kernel.
16722 @item -mid-shared-library
16723 @opindex mid-shared-library
16724 Generate code that supports shared libraries via the library ID method.
16725 This allows for execute in place and shared libraries in an environment
16726 without virtual memory management.  This option implies @option{-fPIC}.
16727 With a @samp{bfin-elf} target, this option implies @option{-msim}.
16729 @item -mno-id-shared-library
16730 @opindex mno-id-shared-library
16731 Generate code that doesn't assume ID-based shared libraries are being used.
16732 This is the default.
16734 @item -mleaf-id-shared-library
16735 @opindex mleaf-id-shared-library
16736 Generate code that supports shared libraries via the library ID method,
16737 but assumes that this library or executable won't link against any other
16738 ID shared libraries.  That allows the compiler to use faster code for jumps
16739 and calls.
16741 @item -mno-leaf-id-shared-library
16742 @opindex mno-leaf-id-shared-library
16743 Do not assume that the code being compiled won't link against any ID shared
16744 libraries.  Slower code is generated for jump and call insns.
16746 @item -mshared-library-id=n
16747 @opindex mshared-library-id
16748 Specifies the identification number of the ID-based shared library being
16749 compiled.  Specifying a value of 0 generates more compact code; specifying
16750 other values forces the allocation of that number to the current
16751 library but is no more space- or time-efficient than omitting this option.
16753 @item -msep-data
16754 @opindex msep-data
16755 Generate code that allows the data segment to be located in a different
16756 area of memory from the text segment.  This allows for execute in place in
16757 an environment without virtual memory management by eliminating relocations
16758 against the text section.
16760 @item -mno-sep-data
16761 @opindex mno-sep-data
16762 Generate code that assumes that the data segment follows the text segment.
16763 This is the default.
16765 @item -mlong-calls
16766 @itemx -mno-long-calls
16767 @opindex mlong-calls
16768 @opindex mno-long-calls
16769 Tells the compiler to perform function calls by first loading the
16770 address of the function into a register and then performing a subroutine
16771 call on this register.  This switch is needed if the target function
16772 lies outside of the 24-bit addressing range of the offset-based
16773 version of subroutine call instruction.
16775 This feature is not enabled by default.  Specifying
16776 @option{-mno-long-calls} restores the default behavior.  Note these
16777 switches have no effect on how the compiler generates code to handle
16778 function calls via function pointers.
16780 @item -mfast-fp
16781 @opindex mfast-fp
16782 Link with the fast floating-point library. This library relaxes some of
16783 the IEEE floating-point standard's rules for checking inputs against
16784 Not-a-Number (NAN), in the interest of performance.
16786 @item -minline-plt
16787 @opindex minline-plt
16788 Enable inlining of PLT entries in function calls to functions that are
16789 not known to bind locally.  It has no effect without @option{-mfdpic}.
16791 @item -mmulticore
16792 @opindex mmulticore
16793 Build a standalone application for multicore Blackfin processors. 
16794 This option causes proper start files and link scripts supporting 
16795 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
16796 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
16798 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
16799 selects the one-application-per-core programming model.  Without
16800 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
16801 programming model is used. In this model, the main function of Core B
16802 should be named as @code{coreb_main}.
16804 If this option is not used, the single-core application programming
16805 model is used.
16807 @item -mcorea
16808 @opindex mcorea
16809 Build a standalone application for Core A of BF561 when using
16810 the one-application-per-core programming model. Proper start files
16811 and link scripts are used to support Core A, and the macro
16812 @code{__BFIN_COREA} is defined.
16813 This option can only be used in conjunction with @option{-mmulticore}.
16815 @item -mcoreb
16816 @opindex mcoreb
16817 Build a standalone application for Core B of BF561 when using
16818 the one-application-per-core programming model. Proper start files
16819 and link scripts are used to support Core B, and the macro
16820 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
16821 should be used instead of @code{main}. 
16822 This option can only be used in conjunction with @option{-mmulticore}.
16824 @item -msdram
16825 @opindex msdram
16826 Build a standalone application for SDRAM. Proper start files and
16827 link scripts are used to put the application into SDRAM, and the macro
16828 @code{__BFIN_SDRAM} is defined.
16829 The loader should initialize SDRAM before loading the application.
16831 @item -micplb
16832 @opindex micplb
16833 Assume that ICPLBs are enabled at run time.  This has an effect on certain
16834 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
16835 are enabled; for standalone applications the default is off.
16836 @end table
16838 @node C6X Options
16839 @subsection C6X Options
16840 @cindex C6X Options
16842 @table @gcctabopt
16843 @item -march=@var{name}
16844 @opindex march
16845 This specifies the name of the target architecture.  GCC uses this
16846 name to determine what kind of instructions it can emit when generating
16847 assembly code.  Permissible names are: @samp{c62x},
16848 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
16850 @item -mbig-endian
16851 @opindex mbig-endian
16852 Generate code for a big-endian target.
16854 @item -mlittle-endian
16855 @opindex mlittle-endian
16856 Generate code for a little-endian target.  This is the default.
16858 @item -msim
16859 @opindex msim
16860 Choose startup files and linker script suitable for the simulator.
16862 @item -msdata=default
16863 @opindex msdata=default
16864 Put small global and static data in the @code{.neardata} section,
16865 which is pointed to by register @code{B14}.  Put small uninitialized
16866 global and static data in the @code{.bss} section, which is adjacent
16867 to the @code{.neardata} section.  Put small read-only data into the
16868 @code{.rodata} section.  The corresponding sections used for large
16869 pieces of data are @code{.fardata}, @code{.far} and @code{.const}.
16871 @item -msdata=all
16872 @opindex msdata=all
16873 Put all data, not just small objects, into the sections reserved for
16874 small data, and use addressing relative to the @code{B14} register to
16875 access them.
16877 @item -msdata=none
16878 @opindex msdata=none
16879 Make no use of the sections reserved for small data, and use absolute
16880 addresses to access all data.  Put all initialized global and static
16881 data in the @code{.fardata} section, and all uninitialized data in the
16882 @code{.far} section.  Put all constant data into the @code{.const}
16883 section.
16884 @end table
16886 @node CRIS Options
16887 @subsection CRIS Options
16888 @cindex CRIS Options
16890 These options are defined specifically for the CRIS ports.
16892 @table @gcctabopt
16893 @item -march=@var{architecture-type}
16894 @itemx -mcpu=@var{architecture-type}
16895 @opindex march
16896 @opindex mcpu
16897 Generate code for the specified architecture.  The choices for
16898 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
16899 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
16900 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
16901 @samp{v10}.
16903 @item -mtune=@var{architecture-type}
16904 @opindex mtune
16905 Tune to @var{architecture-type} everything applicable about the generated
16906 code, except for the ABI and the set of available instructions.  The
16907 choices for @var{architecture-type} are the same as for
16908 @option{-march=@var{architecture-type}}.
16910 @item -mmax-stack-frame=@var{n}
16911 @opindex mmax-stack-frame
16912 Warn when the stack frame of a function exceeds @var{n} bytes.
16914 @item -metrax4
16915 @itemx -metrax100
16916 @opindex metrax4
16917 @opindex metrax100
16918 The options @option{-metrax4} and @option{-metrax100} are synonyms for
16919 @option{-march=v3} and @option{-march=v8} respectively.
16921 @item -mmul-bug-workaround
16922 @itemx -mno-mul-bug-workaround
16923 @opindex mmul-bug-workaround
16924 @opindex mno-mul-bug-workaround
16925 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
16926 models where it applies.  This option is active by default.
16928 @item -mpdebug
16929 @opindex mpdebug
16930 Enable CRIS-specific verbose debug-related information in the assembly
16931 code.  This option also has the effect of turning off the @samp{#NO_APP}
16932 formatted-code indicator to the assembler at the beginning of the
16933 assembly file.
16935 @item -mcc-init
16936 @opindex mcc-init
16937 Do not use condition-code results from previous instruction; always emit
16938 compare and test instructions before use of condition codes.
16940 @item -mno-side-effects
16941 @opindex mno-side-effects
16942 Do not emit instructions with side effects in addressing modes other than
16943 post-increment.
16945 @item -mstack-align
16946 @itemx -mno-stack-align
16947 @itemx -mdata-align
16948 @itemx -mno-data-align
16949 @itemx -mconst-align
16950 @itemx -mno-const-align
16951 @opindex mstack-align
16952 @opindex mno-stack-align
16953 @opindex mdata-align
16954 @opindex mno-data-align
16955 @opindex mconst-align
16956 @opindex mno-const-align
16957 These options (@samp{no-} options) arrange (eliminate arrangements) for the
16958 stack frame, individual data and constants to be aligned for the maximum
16959 single data access size for the chosen CPU model.  The default is to
16960 arrange for 32-bit alignment.  ABI details such as structure layout are
16961 not affected by these options.
16963 @item -m32-bit
16964 @itemx -m16-bit
16965 @itemx -m8-bit
16966 @opindex m32-bit
16967 @opindex m16-bit
16968 @opindex m8-bit
16969 Similar to the stack- data- and const-align options above, these options
16970 arrange for stack frame, writable data and constants to all be 32-bit,
16971 16-bit or 8-bit aligned.  The default is 32-bit alignment.
16973 @item -mno-prologue-epilogue
16974 @itemx -mprologue-epilogue
16975 @opindex mno-prologue-epilogue
16976 @opindex mprologue-epilogue
16977 With @option{-mno-prologue-epilogue}, the normal function prologue and
16978 epilogue which set up the stack frame are omitted and no return
16979 instructions or return sequences are generated in the code.  Use this
16980 option only together with visual inspection of the compiled code: no
16981 warnings or errors are generated when call-saved registers must be saved,
16982 or storage for local variables needs to be allocated.
16984 @item -mno-gotplt
16985 @itemx -mgotplt
16986 @opindex mno-gotplt
16987 @opindex mgotplt
16988 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
16989 instruction sequences that load addresses for functions from the PLT part
16990 of the GOT rather than (traditional on other architectures) calls to the
16991 PLT@.  The default is @option{-mgotplt}.
16993 @item -melf
16994 @opindex melf
16995 Legacy no-op option only recognized with the cris-axis-elf and
16996 cris-axis-linux-gnu targets.
16998 @item -mlinux
16999 @opindex mlinux
17000 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
17002 @item -sim
17003 @opindex sim
17004 This option, recognized for the cris-axis-elf, arranges
17005 to link with input-output functions from a simulator library.  Code,
17006 initialized data and zero-initialized data are allocated consecutively.
17008 @item -sim2
17009 @opindex sim2
17010 Like @option{-sim}, but pass linker options to locate initialized data at
17011 0x40000000 and zero-initialized data at 0x80000000.
17012 @end table
17014 @node CR16 Options
17015 @subsection CR16 Options
17016 @cindex CR16 Options
17018 These options are defined specifically for the CR16 ports.
17020 @table @gcctabopt
17022 @item -mmac
17023 @opindex mmac
17024 Enable the use of multiply-accumulate instructions. Disabled by default.
17026 @item -mcr16cplus
17027 @itemx -mcr16c
17028 @opindex mcr16cplus
17029 @opindex mcr16c
17030 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
17031 is default.
17033 @item -msim
17034 @opindex msim
17035 Links the library libsim.a which is in compatible with simulator. Applicable
17036 to ELF compiler only.
17038 @item -mint32
17039 @opindex mint32
17040 Choose integer type as 32-bit wide.
17042 @item -mbit-ops
17043 @opindex mbit-ops
17044 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
17046 @item -mdata-model=@var{model}
17047 @opindex mdata-model
17048 Choose a data model. The choices for @var{model} are @samp{near},
17049 @samp{far} or @samp{medium}. @samp{medium} is default.
17050 However, @samp{far} is not valid with @option{-mcr16c}, as the
17051 CR16C architecture does not support the far data model.
17052 @end table
17054 @node Darwin Options
17055 @subsection Darwin Options
17056 @cindex Darwin options
17058 These options are defined for all architectures running the Darwin operating
17059 system.
17061 FSF GCC on Darwin does not create ``fat'' object files; it creates
17062 an object file for the single architecture that GCC was built to
17063 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
17064 @option{-arch} options are used; it does so by running the compiler or
17065 linker multiple times and joining the results together with
17066 @file{lipo}.
17068 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
17069 @samp{i686}) is determined by the flags that specify the ISA
17070 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
17071 @option{-force_cpusubtype_ALL} option can be used to override this.
17073 The Darwin tools vary in their behavior when presented with an ISA
17074 mismatch.  The assembler, @file{as}, only permits instructions to
17075 be used that are valid for the subtype of the file it is generating,
17076 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
17077 The linker for shared libraries, @file{/usr/bin/libtool}, fails
17078 and prints an error if asked to create a shared library with a less
17079 restrictive subtype than its input files (for instance, trying to put
17080 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
17081 for executables, @command{ld}, quietly gives the executable the most
17082 restrictive subtype of any of its input files.
17084 @table @gcctabopt
17085 @item -F@var{dir}
17086 @opindex F
17087 Add the framework directory @var{dir} to the head of the list of
17088 directories to be searched for header files.  These directories are
17089 interleaved with those specified by @option{-I} options and are
17090 scanned in a left-to-right order.
17092 A framework directory is a directory with frameworks in it.  A
17093 framework is a directory with a @file{Headers} and/or
17094 @file{PrivateHeaders} directory contained directly in it that ends
17095 in @file{.framework}.  The name of a framework is the name of this
17096 directory excluding the @file{.framework}.  Headers associated with
17097 the framework are found in one of those two directories, with
17098 @file{Headers} being searched first.  A subframework is a framework
17099 directory that is in a framework's @file{Frameworks} directory.
17100 Includes of subframework headers can only appear in a header of a
17101 framework that contains the subframework, or in a sibling subframework
17102 header.  Two subframeworks are siblings if they occur in the same
17103 framework.  A subframework should not have the same name as a
17104 framework; a warning is issued if this is violated.  Currently a
17105 subframework cannot have subframeworks; in the future, the mechanism
17106 may be extended to support this.  The standard frameworks can be found
17107 in @file{/System/Library/Frameworks} and
17108 @file{/Library/Frameworks}.  An example include looks like
17109 @code{#include <Framework/header.h>}, where @file{Framework} denotes
17110 the name of the framework and @file{header.h} is found in the
17111 @file{PrivateHeaders} or @file{Headers} directory.
17113 @item -iframework@var{dir}
17114 @opindex iframework
17115 Like @option{-F} except the directory is a treated as a system
17116 directory.  The main difference between this @option{-iframework} and
17117 @option{-F} is that with @option{-iframework} the compiler does not
17118 warn about constructs contained within header files found via
17119 @var{dir}.  This option is valid only for the C family of languages.
17121 @item -gused
17122 @opindex gused
17123 Emit debugging information for symbols that are used.  For stabs
17124 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
17125 This is by default ON@.
17127 @item -gfull
17128 @opindex gfull
17129 Emit debugging information for all symbols and types.
17131 @item -mmacosx-version-min=@var{version}
17132 The earliest version of MacOS X that this executable will run on
17133 is @var{version}.  Typical values of @var{version} include @code{10.1},
17134 @code{10.2}, and @code{10.3.9}.
17136 If the compiler was built to use the system's headers by default,
17137 then the default for this option is the system version on which the
17138 compiler is running, otherwise the default is to make choices that
17139 are compatible with as many systems and code bases as possible.
17141 @item -mkernel
17142 @opindex mkernel
17143 Enable kernel development mode.  The @option{-mkernel} option sets
17144 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
17145 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
17146 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
17147 applicable.  This mode also sets @option{-mno-altivec},
17148 @option{-msoft-float}, @option{-fno-builtin} and
17149 @option{-mlong-branch} for PowerPC targets.
17151 @item -mone-byte-bool
17152 @opindex mone-byte-bool
17153 Override the defaults for @code{bool} so that @code{sizeof(bool)==1}.
17154 By default @code{sizeof(bool)} is @code{4} when compiling for
17155 Darwin/PowerPC and @code{1} when compiling for Darwin/x86, so this
17156 option has no effect on x86.
17158 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
17159 to generate code that is not binary compatible with code generated
17160 without that switch.  Using this switch may require recompiling all
17161 other modules in a program, including system libraries.  Use this
17162 switch to conform to a non-default data model.
17164 @item -mfix-and-continue
17165 @itemx -ffix-and-continue
17166 @itemx -findirect-data
17167 @opindex mfix-and-continue
17168 @opindex ffix-and-continue
17169 @opindex findirect-data
17170 Generate code suitable for fast turnaround development, such as to
17171 allow GDB to dynamically load @file{.o} files into already-running
17172 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
17173 are provided for backwards compatibility.
17175 @item -all_load
17176 @opindex all_load
17177 Loads all members of static archive libraries.
17178 See man ld(1) for more information.
17180 @item -arch_errors_fatal
17181 @opindex arch_errors_fatal
17182 Cause the errors having to do with files that have the wrong architecture
17183 to be fatal.
17185 @item -bind_at_load
17186 @opindex bind_at_load
17187 Causes the output file to be marked such that the dynamic linker will
17188 bind all undefined references when the file is loaded or launched.
17190 @item -bundle
17191 @opindex bundle
17192 Produce a Mach-o bundle format file.
17193 See man ld(1) for more information.
17195 @item -bundle_loader @var{executable}
17196 @opindex bundle_loader
17197 This option specifies the @var{executable} that will load the build
17198 output file being linked.  See man ld(1) for more information.
17200 @item -dynamiclib
17201 @opindex dynamiclib
17202 When passed this option, GCC produces a dynamic library instead of
17203 an executable when linking, using the Darwin @file{libtool} command.
17205 @item -force_cpusubtype_ALL
17206 @opindex force_cpusubtype_ALL
17207 This causes GCC's output file to have the @samp{ALL} subtype, instead of
17208 one controlled by the @option{-mcpu} or @option{-march} option.
17210 @item -allowable_client  @var{client_name}
17211 @itemx -client_name
17212 @itemx -compatibility_version
17213 @itemx -current_version
17214 @itemx -dead_strip
17215 @itemx -dependency-file
17216 @itemx -dylib_file
17217 @itemx -dylinker_install_name
17218 @itemx -dynamic
17219 @itemx -exported_symbols_list
17220 @itemx -filelist
17221 @need 800
17222 @itemx -flat_namespace
17223 @itemx -force_flat_namespace
17224 @itemx -headerpad_max_install_names
17225 @itemx -image_base
17226 @itemx -init
17227 @itemx -install_name
17228 @itemx -keep_private_externs
17229 @itemx -multi_module
17230 @itemx -multiply_defined
17231 @itemx -multiply_defined_unused
17232 @need 800
17233 @itemx -noall_load
17234 @itemx -no_dead_strip_inits_and_terms
17235 @itemx -nofixprebinding
17236 @itemx -nomultidefs
17237 @itemx -noprebind
17238 @itemx -noseglinkedit
17239 @itemx -pagezero_size
17240 @itemx -prebind
17241 @itemx -prebind_all_twolevel_modules
17242 @itemx -private_bundle
17243 @need 800
17244 @itemx -read_only_relocs
17245 @itemx -sectalign
17246 @itemx -sectobjectsymbols
17247 @itemx -whyload
17248 @itemx -seg1addr
17249 @itemx -sectcreate
17250 @itemx -sectobjectsymbols
17251 @itemx -sectorder
17252 @itemx -segaddr
17253 @itemx -segs_read_only_addr
17254 @need 800
17255 @itemx -segs_read_write_addr
17256 @itemx -seg_addr_table
17257 @itemx -seg_addr_table_filename
17258 @itemx -seglinkedit
17259 @itemx -segprot
17260 @itemx -segs_read_only_addr
17261 @itemx -segs_read_write_addr
17262 @itemx -single_module
17263 @itemx -static
17264 @itemx -sub_library
17265 @need 800
17266 @itemx -sub_umbrella
17267 @itemx -twolevel_namespace
17268 @itemx -umbrella
17269 @itemx -undefined
17270 @itemx -unexported_symbols_list
17271 @itemx -weak_reference_mismatches
17272 @itemx -whatsloaded
17273 @opindex allowable_client
17274 @opindex client_name
17275 @opindex compatibility_version
17276 @opindex current_version
17277 @opindex dead_strip
17278 @opindex dependency-file
17279 @opindex dylib_file
17280 @opindex dylinker_install_name
17281 @opindex dynamic
17282 @opindex exported_symbols_list
17283 @opindex filelist
17284 @opindex flat_namespace
17285 @opindex force_flat_namespace
17286 @opindex headerpad_max_install_names
17287 @opindex image_base
17288 @opindex init
17289 @opindex install_name
17290 @opindex keep_private_externs
17291 @opindex multi_module
17292 @opindex multiply_defined
17293 @opindex multiply_defined_unused
17294 @opindex noall_load
17295 @opindex no_dead_strip_inits_and_terms
17296 @opindex nofixprebinding
17297 @opindex nomultidefs
17298 @opindex noprebind
17299 @opindex noseglinkedit
17300 @opindex pagezero_size
17301 @opindex prebind
17302 @opindex prebind_all_twolevel_modules
17303 @opindex private_bundle
17304 @opindex read_only_relocs
17305 @opindex sectalign
17306 @opindex sectobjectsymbols
17307 @opindex whyload
17308 @opindex seg1addr
17309 @opindex sectcreate
17310 @opindex sectobjectsymbols
17311 @opindex sectorder
17312 @opindex segaddr
17313 @opindex segs_read_only_addr
17314 @opindex segs_read_write_addr
17315 @opindex seg_addr_table
17316 @opindex seg_addr_table_filename
17317 @opindex seglinkedit
17318 @opindex segprot
17319 @opindex segs_read_only_addr
17320 @opindex segs_read_write_addr
17321 @opindex single_module
17322 @opindex static
17323 @opindex sub_library
17324 @opindex sub_umbrella
17325 @opindex twolevel_namespace
17326 @opindex umbrella
17327 @opindex undefined
17328 @opindex unexported_symbols_list
17329 @opindex weak_reference_mismatches
17330 @opindex whatsloaded
17331 These options are passed to the Darwin linker.  The Darwin linker man page
17332 describes them in detail.
17333 @end table
17335 @node DEC Alpha Options
17336 @subsection DEC Alpha Options
17338 These @samp{-m} options are defined for the DEC Alpha implementations:
17340 @table @gcctabopt
17341 @item -mno-soft-float
17342 @itemx -msoft-float
17343 @opindex mno-soft-float
17344 @opindex msoft-float
17345 Use (do not use) the hardware floating-point instructions for
17346 floating-point operations.  When @option{-msoft-float} is specified,
17347 functions in @file{libgcc.a} are used to perform floating-point
17348 operations.  Unless they are replaced by routines that emulate the
17349 floating-point operations, or compiled in such a way as to call such
17350 emulations routines, these routines issue floating-point
17351 operations.   If you are compiling for an Alpha without floating-point
17352 operations, you must ensure that the library is built so as not to call
17353 them.
17355 Note that Alpha implementations without floating-point operations are
17356 required to have floating-point registers.
17358 @item -mfp-reg
17359 @itemx -mno-fp-regs
17360 @opindex mfp-reg
17361 @opindex mno-fp-regs
17362 Generate code that uses (does not use) the floating-point register set.
17363 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
17364 register set is not used, floating-point operands are passed in integer
17365 registers as if they were integers and floating-point results are passed
17366 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
17367 so any function with a floating-point argument or return value called by code
17368 compiled with @option{-mno-fp-regs} must also be compiled with that
17369 option.
17371 A typical use of this option is building a kernel that does not use,
17372 and hence need not save and restore, any floating-point registers.
17374 @item -mieee
17375 @opindex mieee
17376 The Alpha architecture implements floating-point hardware optimized for
17377 maximum performance.  It is mostly compliant with the IEEE floating-point
17378 standard.  However, for full compliance, software assistance is
17379 required.  This option generates code fully IEEE-compliant code
17380 @emph{except} that the @var{inexact-flag} is not maintained (see below).
17381 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
17382 defined during compilation.  The resulting code is less efficient but is
17383 able to correctly support denormalized numbers and exceptional IEEE
17384 values such as not-a-number and plus/minus infinity.  Other Alpha
17385 compilers call this option @option{-ieee_with_no_inexact}.
17387 @item -mieee-with-inexact
17388 @opindex mieee-with-inexact
17389 This is like @option{-mieee} except the generated code also maintains
17390 the IEEE @var{inexact-flag}.  Turning on this option causes the
17391 generated code to implement fully-compliant IEEE math.  In addition to
17392 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
17393 macro.  On some Alpha implementations the resulting code may execute
17394 significantly slower than the code generated by default.  Since there is
17395 very little code that depends on the @var{inexact-flag}, you should
17396 normally not specify this option.  Other Alpha compilers call this
17397 option @option{-ieee_with_inexact}.
17399 @item -mfp-trap-mode=@var{trap-mode}
17400 @opindex mfp-trap-mode
17401 This option controls what floating-point related traps are enabled.
17402 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
17403 The trap mode can be set to one of four values:
17405 @table @samp
17406 @item n
17407 This is the default (normal) setting.  The only traps that are enabled
17408 are the ones that cannot be disabled in software (e.g., division by zero
17409 trap).
17411 @item u
17412 In addition to the traps enabled by @samp{n}, underflow traps are enabled
17413 as well.
17415 @item su
17416 Like @samp{u}, but the instructions are marked to be safe for software
17417 completion (see Alpha architecture manual for details).
17419 @item sui
17420 Like @samp{su}, but inexact traps are enabled as well.
17421 @end table
17423 @item -mfp-rounding-mode=@var{rounding-mode}
17424 @opindex mfp-rounding-mode
17425 Selects the IEEE rounding mode.  Other Alpha compilers call this option
17426 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
17429 @table @samp
17430 @item n
17431 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
17432 the nearest machine number or towards the even machine number in case
17433 of a tie.
17435 @item m
17436 Round towards minus infinity.
17438 @item c
17439 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
17441 @item d
17442 Dynamic rounding mode.  A field in the floating-point control register
17443 (@var{fpcr}, see Alpha architecture reference manual) controls the
17444 rounding mode in effect.  The C library initializes this register for
17445 rounding towards plus infinity.  Thus, unless your program modifies the
17446 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
17447 @end table
17449 @item -mtrap-precision=@var{trap-precision}
17450 @opindex mtrap-precision
17451 In the Alpha architecture, floating-point traps are imprecise.  This
17452 means without software assistance it is impossible to recover from a
17453 floating trap and program execution normally needs to be terminated.
17454 GCC can generate code that can assist operating system trap handlers
17455 in determining the exact location that caused a floating-point trap.
17456 Depending on the requirements of an application, different levels of
17457 precisions can be selected:
17459 @table @samp
17460 @item p
17461 Program precision.  This option is the default and means a trap handler
17462 can only identify which program caused a floating-point exception.
17464 @item f
17465 Function precision.  The trap handler can determine the function that
17466 caused a floating-point exception.
17468 @item i
17469 Instruction precision.  The trap handler can determine the exact
17470 instruction that caused a floating-point exception.
17471 @end table
17473 Other Alpha compilers provide the equivalent options called
17474 @option{-scope_safe} and @option{-resumption_safe}.
17476 @item -mieee-conformant
17477 @opindex mieee-conformant
17478 This option marks the generated code as IEEE conformant.  You must not
17479 use this option unless you also specify @option{-mtrap-precision=i} and either
17480 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
17481 is to emit the line @samp{.eflag 48} in the function prologue of the
17482 generated assembly file.
17484 @item -mbuild-constants
17485 @opindex mbuild-constants
17486 Normally GCC examines a 32- or 64-bit integer constant to
17487 see if it can construct it from smaller constants in two or three
17488 instructions.  If it cannot, it outputs the constant as a literal and
17489 generates code to load it from the data segment at run time.
17491 Use this option to require GCC to construct @emph{all} integer constants
17492 using code, even if it takes more instructions (the maximum is six).
17494 You typically use this option to build a shared library dynamic
17495 loader.  Itself a shared library, it must relocate itself in memory
17496 before it can find the variables and constants in its own data segment.
17498 @item -mbwx
17499 @itemx -mno-bwx
17500 @itemx -mcix
17501 @itemx -mno-cix
17502 @itemx -mfix
17503 @itemx -mno-fix
17504 @itemx -mmax
17505 @itemx -mno-max
17506 @opindex mbwx
17507 @opindex mno-bwx
17508 @opindex mcix
17509 @opindex mno-cix
17510 @opindex mfix
17511 @opindex mno-fix
17512 @opindex mmax
17513 @opindex mno-max
17514 Indicate whether GCC should generate code to use the optional BWX,
17515 CIX, FIX and MAX instruction sets.  The default is to use the instruction
17516 sets supported by the CPU type specified via @option{-mcpu=} option or that
17517 of the CPU on which GCC was built if none is specified.
17519 @item -mfloat-vax
17520 @itemx -mfloat-ieee
17521 @opindex mfloat-vax
17522 @opindex mfloat-ieee
17523 Generate code that uses (does not use) VAX F and G floating-point
17524 arithmetic instead of IEEE single and double precision.
17526 @item -mexplicit-relocs
17527 @itemx -mno-explicit-relocs
17528 @opindex mexplicit-relocs
17529 @opindex mno-explicit-relocs
17530 Older Alpha assemblers provided no way to generate symbol relocations
17531 except via assembler macros.  Use of these macros does not allow
17532 optimal instruction scheduling.  GNU binutils as of version 2.12
17533 supports a new syntax that allows the compiler to explicitly mark
17534 which relocations should apply to which instructions.  This option
17535 is mostly useful for debugging, as GCC detects the capabilities of
17536 the assembler when it is built and sets the default accordingly.
17538 @item -msmall-data
17539 @itemx -mlarge-data
17540 @opindex msmall-data
17541 @opindex mlarge-data
17542 When @option{-mexplicit-relocs} is in effect, static data is
17543 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
17544 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
17545 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
17546 16-bit relocations off of the @code{$gp} register.  This limits the
17547 size of the small data area to 64KB, but allows the variables to be
17548 directly accessed via a single instruction.
17550 The default is @option{-mlarge-data}.  With this option the data area
17551 is limited to just below 2GB@.  Programs that require more than 2GB of
17552 data must use @code{malloc} or @code{mmap} to allocate the data in the
17553 heap instead of in the program's data segment.
17555 When generating code for shared libraries, @option{-fpic} implies
17556 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
17558 @item -msmall-text
17559 @itemx -mlarge-text
17560 @opindex msmall-text
17561 @opindex mlarge-text
17562 When @option{-msmall-text} is used, the compiler assumes that the
17563 code of the entire program (or shared library) fits in 4MB, and is
17564 thus reachable with a branch instruction.  When @option{-msmall-data}
17565 is used, the compiler can assume that all local symbols share the
17566 same @code{$gp} value, and thus reduce the number of instructions
17567 required for a function call from 4 to 1.
17569 The default is @option{-mlarge-text}.
17571 @item -mcpu=@var{cpu_type}
17572 @opindex mcpu
17573 Set the instruction set and instruction scheduling parameters for
17574 machine type @var{cpu_type}.  You can specify either the @samp{EV}
17575 style name or the corresponding chip number.  GCC supports scheduling
17576 parameters for the EV4, EV5 and EV6 family of processors and
17577 chooses the default values for the instruction set from the processor
17578 you specify.  If you do not specify a processor type, GCC defaults
17579 to the processor on which the compiler was built.
17581 Supported values for @var{cpu_type} are
17583 @table @samp
17584 @item ev4
17585 @itemx ev45
17586 @itemx 21064
17587 Schedules as an EV4 and has no instruction set extensions.
17589 @item ev5
17590 @itemx 21164
17591 Schedules as an EV5 and has no instruction set extensions.
17593 @item ev56
17594 @itemx 21164a
17595 Schedules as an EV5 and supports the BWX extension.
17597 @item pca56
17598 @itemx 21164pc
17599 @itemx 21164PC
17600 Schedules as an EV5 and supports the BWX and MAX extensions.
17602 @item ev6
17603 @itemx 21264
17604 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
17606 @item ev67
17607 @itemx 21264a
17608 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
17609 @end table
17611 Native toolchains also support the value @samp{native},
17612 which selects the best architecture option for the host processor.
17613 @option{-mcpu=native} has no effect if GCC does not recognize
17614 the processor.
17616 @item -mtune=@var{cpu_type}
17617 @opindex mtune
17618 Set only the instruction scheduling parameters for machine type
17619 @var{cpu_type}.  The instruction set is not changed.
17621 Native toolchains also support the value @samp{native},
17622 which selects the best architecture option for the host processor.
17623 @option{-mtune=native} has no effect if GCC does not recognize
17624 the processor.
17626 @item -mmemory-latency=@var{time}
17627 @opindex mmemory-latency
17628 Sets the latency the scheduler should assume for typical memory
17629 references as seen by the application.  This number is highly
17630 dependent on the memory access patterns used by the application
17631 and the size of the external cache on the machine.
17633 Valid options for @var{time} are
17635 @table @samp
17636 @item @var{number}
17637 A decimal number representing clock cycles.
17639 @item L1
17640 @itemx L2
17641 @itemx L3
17642 @itemx main
17643 The compiler contains estimates of the number of clock cycles for
17644 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
17645 (also called Dcache, Scache, and Bcache), as well as to main memory.
17646 Note that L3 is only valid for EV5.
17648 @end table
17649 @end table
17651 @node FR30 Options
17652 @subsection FR30 Options
17653 @cindex FR30 Options
17655 These options are defined specifically for the FR30 port.
17657 @table @gcctabopt
17659 @item -msmall-model
17660 @opindex msmall-model
17661 Use the small address space model.  This can produce smaller code, but
17662 it does assume that all symbolic values and addresses fit into a
17663 20-bit range.
17665 @item -mno-lsim
17666 @opindex mno-lsim
17667 Assume that runtime support has been provided and so there is no need
17668 to include the simulator library (@file{libsim.a}) on the linker
17669 command line.
17671 @end table
17673 @node FT32 Options
17674 @subsection FT32 Options
17675 @cindex FT32 Options
17677 These options are defined specifically for the FT32 port.
17679 @table @gcctabopt
17681 @item -msim
17682 @opindex msim
17683 Specifies that the program will be run on the simulator.  This causes
17684 an alternate runtime startup and library to be linked.
17685 You must not use this option when generating programs that will run on
17686 real hardware; you must provide your own runtime library for whatever
17687 I/O functions are needed.
17689 @item -mlra
17690 @opindex mlra
17691 Enable Local Register Allocation.  This is still experimental for FT32,
17692 so by default the compiler uses standard reload.
17694 @item -mnodiv
17695 @opindex mnodiv
17696 Do not use div and mod instructions.
17698 @end table
17700 @node FRV Options
17701 @subsection FRV Options
17702 @cindex FRV Options
17704 @table @gcctabopt
17705 @item -mgpr-32
17706 @opindex mgpr-32
17708 Only use the first 32 general-purpose registers.
17710 @item -mgpr-64
17711 @opindex mgpr-64
17713 Use all 64 general-purpose registers.
17715 @item -mfpr-32
17716 @opindex mfpr-32
17718 Use only the first 32 floating-point registers.
17720 @item -mfpr-64
17721 @opindex mfpr-64
17723 Use all 64 floating-point registers.
17725 @item -mhard-float
17726 @opindex mhard-float
17728 Use hardware instructions for floating-point operations.
17730 @item -msoft-float
17731 @opindex msoft-float
17733 Use library routines for floating-point operations.
17735 @item -malloc-cc
17736 @opindex malloc-cc
17738 Dynamically allocate condition code registers.
17740 @item -mfixed-cc
17741 @opindex mfixed-cc
17743 Do not try to dynamically allocate condition code registers, only
17744 use @code{icc0} and @code{fcc0}.
17746 @item -mdword
17747 @opindex mdword
17749 Change ABI to use double word insns.
17751 @item -mno-dword
17752 @opindex mno-dword
17754 Do not use double word instructions.
17756 @item -mdouble
17757 @opindex mdouble
17759 Use floating-point double instructions.
17761 @item -mno-double
17762 @opindex mno-double
17764 Do not use floating-point double instructions.
17766 @item -mmedia
17767 @opindex mmedia
17769 Use media instructions.
17771 @item -mno-media
17772 @opindex mno-media
17774 Do not use media instructions.
17776 @item -mmuladd
17777 @opindex mmuladd
17779 Use multiply and add/subtract instructions.
17781 @item -mno-muladd
17782 @opindex mno-muladd
17784 Do not use multiply and add/subtract instructions.
17786 @item -mfdpic
17787 @opindex mfdpic
17789 Select the FDPIC ABI, which uses function descriptors to represent
17790 pointers to functions.  Without any PIC/PIE-related options, it
17791 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
17792 assumes GOT entries and small data are within a 12-bit range from the
17793 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
17794 are computed with 32 bits.
17795 With a @samp{bfin-elf} target, this option implies @option{-msim}.
17797 @item -minline-plt
17798 @opindex minline-plt
17800 Enable inlining of PLT entries in function calls to functions that are
17801 not known to bind locally.  It has no effect without @option{-mfdpic}.
17802 It's enabled by default if optimizing for speed and compiling for
17803 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
17804 optimization option such as @option{-O3} or above is present in the
17805 command line.
17807 @item -mTLS
17808 @opindex mTLS
17810 Assume a large TLS segment when generating thread-local code.
17812 @item -mtls
17813 @opindex mtls
17815 Do not assume a large TLS segment when generating thread-local code.
17817 @item -mgprel-ro
17818 @opindex mgprel-ro
17820 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
17821 that is known to be in read-only sections.  It's enabled by default,
17822 except for @option{-fpic} or @option{-fpie}: even though it may help
17823 make the global offset table smaller, it trades 1 instruction for 4.
17824 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
17825 one of which may be shared by multiple symbols, and it avoids the need
17826 for a GOT entry for the referenced symbol, so it's more likely to be a
17827 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
17829 @item -multilib-library-pic
17830 @opindex multilib-library-pic
17832 Link with the (library, not FD) pic libraries.  It's implied by
17833 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
17834 @option{-fpic} without @option{-mfdpic}.  You should never have to use
17835 it explicitly.
17837 @item -mlinked-fp
17838 @opindex mlinked-fp
17840 Follow the EABI requirement of always creating a frame pointer whenever
17841 a stack frame is allocated.  This option is enabled by default and can
17842 be disabled with @option{-mno-linked-fp}.
17844 @item -mlong-calls
17845 @opindex mlong-calls
17847 Use indirect addressing to call functions outside the current
17848 compilation unit.  This allows the functions to be placed anywhere
17849 within the 32-bit address space.
17851 @item -malign-labels
17852 @opindex malign-labels
17854 Try to align labels to an 8-byte boundary by inserting NOPs into the
17855 previous packet.  This option only has an effect when VLIW packing
17856 is enabled.  It doesn't create new packets; it merely adds NOPs to
17857 existing ones.
17859 @item -mlibrary-pic
17860 @opindex mlibrary-pic
17862 Generate position-independent EABI code.
17864 @item -macc-4
17865 @opindex macc-4
17867 Use only the first four media accumulator registers.
17869 @item -macc-8
17870 @opindex macc-8
17872 Use all eight media accumulator registers.
17874 @item -mpack
17875 @opindex mpack
17877 Pack VLIW instructions.
17879 @item -mno-pack
17880 @opindex mno-pack
17882 Do not pack VLIW instructions.
17884 @item -mno-eflags
17885 @opindex mno-eflags
17887 Do not mark ABI switches in e_flags.
17889 @item -mcond-move
17890 @opindex mcond-move
17892 Enable the use of conditional-move instructions (default).
17894 This switch is mainly for debugging the compiler and will likely be removed
17895 in a future version.
17897 @item -mno-cond-move
17898 @opindex mno-cond-move
17900 Disable the use of conditional-move instructions.
17902 This switch is mainly for debugging the compiler and will likely be removed
17903 in a future version.
17905 @item -mscc
17906 @opindex mscc
17908 Enable the use of conditional set instructions (default).
17910 This switch is mainly for debugging the compiler and will likely be removed
17911 in a future version.
17913 @item -mno-scc
17914 @opindex mno-scc
17916 Disable the use of conditional set instructions.
17918 This switch is mainly for debugging the compiler and will likely be removed
17919 in a future version.
17921 @item -mcond-exec
17922 @opindex mcond-exec
17924 Enable the use of conditional execution (default).
17926 This switch is mainly for debugging the compiler and will likely be removed
17927 in a future version.
17929 @item -mno-cond-exec
17930 @opindex mno-cond-exec
17932 Disable the use of conditional execution.
17934 This switch is mainly for debugging the compiler and will likely be removed
17935 in a future version.
17937 @item -mvliw-branch
17938 @opindex mvliw-branch
17940 Run a pass to pack branches into VLIW instructions (default).
17942 This switch is mainly for debugging the compiler and will likely be removed
17943 in a future version.
17945 @item -mno-vliw-branch
17946 @opindex mno-vliw-branch
17948 Do not run a pass to pack branches into VLIW instructions.
17950 This switch is mainly for debugging the compiler and will likely be removed
17951 in a future version.
17953 @item -mmulti-cond-exec
17954 @opindex mmulti-cond-exec
17956 Enable optimization of @code{&&} and @code{||} in conditional execution
17957 (default).
17959 This switch is mainly for debugging the compiler and will likely be removed
17960 in a future version.
17962 @item -mno-multi-cond-exec
17963 @opindex mno-multi-cond-exec
17965 Disable optimization of @code{&&} and @code{||} in conditional execution.
17967 This switch is mainly for debugging the compiler and will likely be removed
17968 in a future version.
17970 @item -mnested-cond-exec
17971 @opindex mnested-cond-exec
17973 Enable nested conditional execution optimizations (default).
17975 This switch is mainly for debugging the compiler and will likely be removed
17976 in a future version.
17978 @item -mno-nested-cond-exec
17979 @opindex mno-nested-cond-exec
17981 Disable nested conditional execution optimizations.
17983 This switch is mainly for debugging the compiler and will likely be removed
17984 in a future version.
17986 @item -moptimize-membar
17987 @opindex moptimize-membar
17989 This switch removes redundant @code{membar} instructions from the
17990 compiler-generated code.  It is enabled by default.
17992 @item -mno-optimize-membar
17993 @opindex mno-optimize-membar
17995 This switch disables the automatic removal of redundant @code{membar}
17996 instructions from the generated code.
17998 @item -mtomcat-stats
17999 @opindex mtomcat-stats
18001 Cause gas to print out tomcat statistics.
18003 @item -mcpu=@var{cpu}
18004 @opindex mcpu
18006 Select the processor type for which to generate code.  Possible values are
18007 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
18008 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
18010 @end table
18012 @node GNU/Linux Options
18013 @subsection GNU/Linux Options
18015 These @samp{-m} options are defined for GNU/Linux targets:
18017 @table @gcctabopt
18018 @item -mglibc
18019 @opindex mglibc
18020 Use the GNU C library.  This is the default except
18021 on @samp{*-*-linux-*uclibc*}, @samp{*-*-linux-*musl*} and
18022 @samp{*-*-linux-*android*} targets.
18024 @item -muclibc
18025 @opindex muclibc
18026 Use uClibc C library.  This is the default on
18027 @samp{*-*-linux-*uclibc*} targets.
18029 @item -mmusl
18030 @opindex mmusl
18031 Use the musl C library.  This is the default on
18032 @samp{*-*-linux-*musl*} targets.
18034 @item -mbionic
18035 @opindex mbionic
18036 Use Bionic C library.  This is the default on
18037 @samp{*-*-linux-*android*} targets.
18039 @item -mandroid
18040 @opindex mandroid
18041 Compile code compatible with Android platform.  This is the default on
18042 @samp{*-*-linux-*android*} targets.
18044 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
18045 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
18046 this option makes the GCC driver pass Android-specific options to the linker.
18047 Finally, this option causes the preprocessor macro @code{__ANDROID__}
18048 to be defined.
18050 @item -tno-android-cc
18051 @opindex tno-android-cc
18052 Disable compilation effects of @option{-mandroid}, i.e., do not enable
18053 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
18054 @option{-fno-rtti} by default.
18056 @item -tno-android-ld
18057 @opindex tno-android-ld
18058 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
18059 linking options to the linker.
18061 @end table
18063 @node H8/300 Options
18064 @subsection H8/300 Options
18066 These @samp{-m} options are defined for the H8/300 implementations:
18068 @table @gcctabopt
18069 @item -mrelax
18070 @opindex mrelax
18071 Shorten some address references at link time, when possible; uses the
18072 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
18073 ld, Using ld}, for a fuller description.
18075 @item -mh
18076 @opindex mh
18077 Generate code for the H8/300H@.
18079 @item -ms
18080 @opindex ms
18081 Generate code for the H8S@.
18083 @item -mn
18084 @opindex mn
18085 Generate code for the H8S and H8/300H in the normal mode.  This switch
18086 must be used either with @option{-mh} or @option{-ms}.
18088 @item -ms2600
18089 @opindex ms2600
18090 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
18092 @item -mexr
18093 @opindex mexr
18094 Extended registers are stored on stack before execution of function
18095 with monitor attribute. Default option is @option{-mexr}.
18096 This option is valid only for H8S targets.
18098 @item -mno-exr
18099 @opindex mno-exr
18100 Extended registers are not stored on stack before execution of function 
18101 with monitor attribute. Default option is @option{-mno-exr}. 
18102 This option is valid only for H8S targets.
18104 @item -mint32
18105 @opindex mint32
18106 Make @code{int} data 32 bits by default.
18108 @item -malign-300
18109 @opindex malign-300
18110 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
18111 The default for the H8/300H and H8S is to align longs and floats on
18112 4-byte boundaries.
18113 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
18114 This option has no effect on the H8/300.
18115 @end table
18117 @node HPPA Options
18118 @subsection HPPA Options
18119 @cindex HPPA Options
18121 These @samp{-m} options are defined for the HPPA family of computers:
18123 @table @gcctabopt
18124 @item -march=@var{architecture-type}
18125 @opindex march
18126 Generate code for the specified architecture.  The choices for
18127 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
18128 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
18129 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
18130 architecture option for your machine.  Code compiled for lower numbered
18131 architectures runs on higher numbered architectures, but not the
18132 other way around.
18134 @item -mpa-risc-1-0
18135 @itemx -mpa-risc-1-1
18136 @itemx -mpa-risc-2-0
18137 @opindex mpa-risc-1-0
18138 @opindex mpa-risc-1-1
18139 @opindex mpa-risc-2-0
18140 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
18142 @item -mcaller-copies
18143 @opindex mcaller-copies
18144 The caller copies function arguments passed by hidden reference.  This
18145 option should be used with care as it is not compatible with the default
18146 32-bit runtime.  However, only aggregates larger than eight bytes are
18147 passed by hidden reference and the option provides better compatibility
18148 with OpenMP.
18150 @item -mjump-in-delay
18151 @opindex mjump-in-delay
18152 This option is ignored and provided for compatibility purposes only.
18154 @item -mdisable-fpregs
18155 @opindex mdisable-fpregs
18156 Prevent floating-point registers from being used in any manner.  This is
18157 necessary for compiling kernels that perform lazy context switching of
18158 floating-point registers.  If you use this option and attempt to perform
18159 floating-point operations, the compiler aborts.
18161 @item -mdisable-indexing
18162 @opindex mdisable-indexing
18163 Prevent the compiler from using indexing address modes.  This avoids some
18164 rather obscure problems when compiling MIG generated code under MACH@.
18166 @item -mno-space-regs
18167 @opindex mno-space-regs
18168 Generate code that assumes the target has no space registers.  This allows
18169 GCC to generate faster indirect calls and use unscaled index address modes.
18171 Such code is suitable for level 0 PA systems and kernels.
18173 @item -mfast-indirect-calls
18174 @opindex mfast-indirect-calls
18175 Generate code that assumes calls never cross space boundaries.  This
18176 allows GCC to emit code that performs faster indirect calls.
18178 This option does not work in the presence of shared libraries or nested
18179 functions.
18181 @item -mfixed-range=@var{register-range}
18182 @opindex mfixed-range
18183 Generate code treating the given register range as fixed registers.
18184 A fixed register is one that the register allocator cannot use.  This is
18185 useful when compiling kernel code.  A register range is specified as
18186 two registers separated by a dash.  Multiple register ranges can be
18187 specified separated by a comma.
18189 @item -mlong-load-store
18190 @opindex mlong-load-store
18191 Generate 3-instruction load and store sequences as sometimes required by
18192 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
18193 the HP compilers.
18195 @item -mportable-runtime
18196 @opindex mportable-runtime
18197 Use the portable calling conventions proposed by HP for ELF systems.
18199 @item -mgas
18200 @opindex mgas
18201 Enable the use of assembler directives only GAS understands.
18203 @item -mschedule=@var{cpu-type}
18204 @opindex mschedule
18205 Schedule code according to the constraints for the machine type
18206 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
18207 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
18208 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
18209 proper scheduling option for your machine.  The default scheduling is
18210 @samp{8000}.
18212 @item -mlinker-opt
18213 @opindex mlinker-opt
18214 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
18215 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
18216 linkers in which they give bogus error messages when linking some programs.
18218 @item -msoft-float
18219 @opindex msoft-float
18220 Generate output containing library calls for floating point.
18221 @strong{Warning:} the requisite libraries are not available for all HPPA
18222 targets.  Normally the facilities of the machine's usual C compiler are
18223 used, but this cannot be done directly in cross-compilation.  You must make
18224 your own arrangements to provide suitable library functions for
18225 cross-compilation.
18227 @option{-msoft-float} changes the calling convention in the output file;
18228 therefore, it is only useful if you compile @emph{all} of a program with
18229 this option.  In particular, you need to compile @file{libgcc.a}, the
18230 library that comes with GCC, with @option{-msoft-float} in order for
18231 this to work.
18233 @item -msio
18234 @opindex msio
18235 Generate the predefine, @code{_SIO}, for server IO@.  The default is
18236 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
18237 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
18238 options are available under HP-UX and HI-UX@.
18240 @item -mgnu-ld
18241 @opindex mgnu-ld
18242 Use options specific to GNU @command{ld}.
18243 This passes @option{-shared} to @command{ld} when
18244 building a shared library.  It is the default when GCC is configured,
18245 explicitly or implicitly, with the GNU linker.  This option does not
18246 affect which @command{ld} is called; it only changes what parameters
18247 are passed to that @command{ld}.
18248 The @command{ld} that is called is determined by the
18249 @option{--with-ld} configure option, GCC's program search path, and
18250 finally by the user's @env{PATH}.  The linker used by GCC can be printed
18251 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
18252 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
18254 @item -mhp-ld
18255 @opindex mhp-ld
18256 Use options specific to HP @command{ld}.
18257 This passes @option{-b} to @command{ld} when building
18258 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
18259 links.  It is the default when GCC is configured, explicitly or
18260 implicitly, with the HP linker.  This option does not affect
18261 which @command{ld} is called; it only changes what parameters are passed to that
18262 @command{ld}.
18263 The @command{ld} that is called is determined by the @option{--with-ld}
18264 configure option, GCC's program search path, and finally by the user's
18265 @env{PATH}.  The linker used by GCC can be printed using @samp{which
18266 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
18267 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
18269 @item -mlong-calls
18270 @opindex mno-long-calls
18271 Generate code that uses long call sequences.  This ensures that a call
18272 is always able to reach linker generated stubs.  The default is to generate
18273 long calls only when the distance from the call site to the beginning
18274 of the function or translation unit, as the case may be, exceeds a
18275 predefined limit set by the branch type being used.  The limits for
18276 normal calls are 7,600,000 and 240,000 bytes, respectively for the
18277 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
18278 240,000 bytes.
18280 Distances are measured from the beginning of functions when using the
18281 @option{-ffunction-sections} option, or when using the @option{-mgas}
18282 and @option{-mno-portable-runtime} options together under HP-UX with
18283 the SOM linker.
18285 It is normally not desirable to use this option as it degrades
18286 performance.  However, it may be useful in large applications,
18287 particularly when partial linking is used to build the application.
18289 The types of long calls used depends on the capabilities of the
18290 assembler and linker, and the type of code being generated.  The
18291 impact on systems that support long absolute calls, and long pic
18292 symbol-difference or pc-relative calls should be relatively small.
18293 However, an indirect call is used on 32-bit ELF systems in pic code
18294 and it is quite long.
18296 @item -munix=@var{unix-std}
18297 @opindex march
18298 Generate compiler predefines and select a startfile for the specified
18299 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
18300 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
18301 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
18302 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
18303 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
18304 and later.
18306 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
18307 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
18308 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
18309 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
18310 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
18311 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
18313 It is @emph{important} to note that this option changes the interfaces
18314 for various library routines.  It also affects the operational behavior
18315 of the C library.  Thus, @emph{extreme} care is needed in using this
18316 option.
18318 Library code that is intended to operate with more than one UNIX
18319 standard must test, set and restore the variable @code{__xpg4_extended_mask}
18320 as appropriate.  Most GNU software doesn't provide this capability.
18322 @item -nolibdld
18323 @opindex nolibdld
18324 Suppress the generation of link options to search libdld.sl when the
18325 @option{-static} option is specified on HP-UX 10 and later.
18327 @item -static
18328 @opindex static
18329 The HP-UX implementation of setlocale in libc has a dependency on
18330 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
18331 when the @option{-static} option is specified, special link options
18332 are needed to resolve this dependency.
18334 On HP-UX 10 and later, the GCC driver adds the necessary options to
18335 link with libdld.sl when the @option{-static} option is specified.
18336 This causes the resulting binary to be dynamic.  On the 64-bit port,
18337 the linkers generate dynamic binaries by default in any case.  The
18338 @option{-nolibdld} option can be used to prevent the GCC driver from
18339 adding these link options.
18341 @item -threads
18342 @opindex threads
18343 Add support for multithreading with the @dfn{dce thread} library
18344 under HP-UX@.  This option sets flags for both the preprocessor and
18345 linker.
18346 @end table
18348 @node IA-64 Options
18349 @subsection IA-64 Options
18350 @cindex IA-64 Options
18352 These are the @samp{-m} options defined for the Intel IA-64 architecture.
18354 @table @gcctabopt
18355 @item -mbig-endian
18356 @opindex mbig-endian
18357 Generate code for a big-endian target.  This is the default for HP-UX@.
18359 @item -mlittle-endian
18360 @opindex mlittle-endian
18361 Generate code for a little-endian target.  This is the default for AIX5
18362 and GNU/Linux.
18364 @item -mgnu-as
18365 @itemx -mno-gnu-as
18366 @opindex mgnu-as
18367 @opindex mno-gnu-as
18368 Generate (or don't) code for the GNU assembler.  This is the default.
18369 @c Also, this is the default if the configure option @option{--with-gnu-as}
18370 @c is used.
18372 @item -mgnu-ld
18373 @itemx -mno-gnu-ld
18374 @opindex mgnu-ld
18375 @opindex mno-gnu-ld
18376 Generate (or don't) code for the GNU linker.  This is the default.
18377 @c Also, this is the default if the configure option @option{--with-gnu-ld}
18378 @c is used.
18380 @item -mno-pic
18381 @opindex mno-pic
18382 Generate code that does not use a global pointer register.  The result
18383 is not position independent code, and violates the IA-64 ABI@.
18385 @item -mvolatile-asm-stop
18386 @itemx -mno-volatile-asm-stop
18387 @opindex mvolatile-asm-stop
18388 @opindex mno-volatile-asm-stop
18389 Generate (or don't) a stop bit immediately before and after volatile asm
18390 statements.
18392 @item -mregister-names
18393 @itemx -mno-register-names
18394 @opindex mregister-names
18395 @opindex mno-register-names
18396 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
18397 the stacked registers.  This may make assembler output more readable.
18399 @item -mno-sdata
18400 @itemx -msdata
18401 @opindex mno-sdata
18402 @opindex msdata
18403 Disable (or enable) optimizations that use the small data section.  This may
18404 be useful for working around optimizer bugs.
18406 @item -mconstant-gp
18407 @opindex mconstant-gp
18408 Generate code that uses a single constant global pointer value.  This is
18409 useful when compiling kernel code.
18411 @item -mauto-pic
18412 @opindex mauto-pic
18413 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
18414 This is useful when compiling firmware code.
18416 @item -minline-float-divide-min-latency
18417 @opindex minline-float-divide-min-latency
18418 Generate code for inline divides of floating-point values
18419 using the minimum latency algorithm.
18421 @item -minline-float-divide-max-throughput
18422 @opindex minline-float-divide-max-throughput
18423 Generate code for inline divides of floating-point values
18424 using the maximum throughput algorithm.
18426 @item -mno-inline-float-divide
18427 @opindex mno-inline-float-divide
18428 Do not generate inline code for divides of floating-point values.
18430 @item -minline-int-divide-min-latency
18431 @opindex minline-int-divide-min-latency
18432 Generate code for inline divides of integer values
18433 using the minimum latency algorithm.
18435 @item -minline-int-divide-max-throughput
18436 @opindex minline-int-divide-max-throughput
18437 Generate code for inline divides of integer values
18438 using the maximum throughput algorithm.
18440 @item -mno-inline-int-divide
18441 @opindex mno-inline-int-divide
18442 Do not generate inline code for divides of integer values.
18444 @item -minline-sqrt-min-latency
18445 @opindex minline-sqrt-min-latency
18446 Generate code for inline square roots
18447 using the minimum latency algorithm.
18449 @item -minline-sqrt-max-throughput
18450 @opindex minline-sqrt-max-throughput
18451 Generate code for inline square roots
18452 using the maximum throughput algorithm.
18454 @item -mno-inline-sqrt
18455 @opindex mno-inline-sqrt
18456 Do not generate inline code for @code{sqrt}.
18458 @item -mfused-madd
18459 @itemx -mno-fused-madd
18460 @opindex mfused-madd
18461 @opindex mno-fused-madd
18462 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
18463 instructions.  The default is to use these instructions.
18465 @item -mno-dwarf2-asm
18466 @itemx -mdwarf2-asm
18467 @opindex mno-dwarf2-asm
18468 @opindex mdwarf2-asm
18469 Don't (or do) generate assembler code for the DWARF line number debugging
18470 info.  This may be useful when not using the GNU assembler.
18472 @item -mearly-stop-bits
18473 @itemx -mno-early-stop-bits
18474 @opindex mearly-stop-bits
18475 @opindex mno-early-stop-bits
18476 Allow stop bits to be placed earlier than immediately preceding the
18477 instruction that triggered the stop bit.  This can improve instruction
18478 scheduling, but does not always do so.
18480 @item -mfixed-range=@var{register-range}
18481 @opindex mfixed-range
18482 Generate code treating the given register range as fixed registers.
18483 A fixed register is one that the register allocator cannot use.  This is
18484 useful when compiling kernel code.  A register range is specified as
18485 two registers separated by a dash.  Multiple register ranges can be
18486 specified separated by a comma.
18488 @item -mtls-size=@var{tls-size}
18489 @opindex mtls-size
18490 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
18493 @item -mtune=@var{cpu-type}
18494 @opindex mtune
18495 Tune the instruction scheduling for a particular CPU, Valid values are
18496 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
18497 and @samp{mckinley}.
18499 @item -milp32
18500 @itemx -mlp64
18501 @opindex milp32
18502 @opindex mlp64
18503 Generate code for a 32-bit or 64-bit environment.
18504 The 32-bit environment sets int, long and pointer to 32 bits.
18505 The 64-bit environment sets int to 32 bits and long and pointer
18506 to 64 bits.  These are HP-UX specific flags.
18508 @item -mno-sched-br-data-spec
18509 @itemx -msched-br-data-spec
18510 @opindex mno-sched-br-data-spec
18511 @opindex msched-br-data-spec
18512 (Dis/En)able data speculative scheduling before reload.
18513 This results in generation of @code{ld.a} instructions and
18514 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
18515 The default setting is disabled.
18517 @item -msched-ar-data-spec
18518 @itemx -mno-sched-ar-data-spec
18519 @opindex msched-ar-data-spec
18520 @opindex mno-sched-ar-data-spec
18521 (En/Dis)able data speculative scheduling after reload.
18522 This results in generation of @code{ld.a} instructions and
18523 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
18524 The default setting is enabled.
18526 @item -mno-sched-control-spec
18527 @itemx -msched-control-spec
18528 @opindex mno-sched-control-spec
18529 @opindex msched-control-spec
18530 (Dis/En)able control speculative scheduling.  This feature is
18531 available only during region scheduling (i.e.@: before reload).
18532 This results in generation of the @code{ld.s} instructions and
18533 the corresponding check instructions @code{chk.s}.
18534 The default setting is disabled.
18536 @item -msched-br-in-data-spec
18537 @itemx -mno-sched-br-in-data-spec
18538 @opindex msched-br-in-data-spec
18539 @opindex mno-sched-br-in-data-spec
18540 (En/Dis)able speculative scheduling of the instructions that
18541 are dependent on the data speculative loads before reload.
18542 This is effective only with @option{-msched-br-data-spec} enabled.
18543 The default setting is enabled.
18545 @item -msched-ar-in-data-spec
18546 @itemx -mno-sched-ar-in-data-spec
18547 @opindex msched-ar-in-data-spec
18548 @opindex mno-sched-ar-in-data-spec
18549 (En/Dis)able speculative scheduling of the instructions that
18550 are dependent on the data speculative loads after reload.
18551 This is effective only with @option{-msched-ar-data-spec} enabled.
18552 The default setting is enabled.
18554 @item -msched-in-control-spec
18555 @itemx -mno-sched-in-control-spec
18556 @opindex msched-in-control-spec
18557 @opindex mno-sched-in-control-spec
18558 (En/Dis)able speculative scheduling of the instructions that
18559 are dependent on the control speculative loads.
18560 This is effective only with @option{-msched-control-spec} enabled.
18561 The default setting is enabled.
18563 @item -mno-sched-prefer-non-data-spec-insns
18564 @itemx -msched-prefer-non-data-spec-insns
18565 @opindex mno-sched-prefer-non-data-spec-insns
18566 @opindex msched-prefer-non-data-spec-insns
18567 If enabled, data-speculative instructions are chosen for schedule
18568 only if there are no other choices at the moment.  This makes
18569 the use of the data speculation much more conservative.
18570 The default setting is disabled.
18572 @item -mno-sched-prefer-non-control-spec-insns
18573 @itemx -msched-prefer-non-control-spec-insns
18574 @opindex mno-sched-prefer-non-control-spec-insns
18575 @opindex msched-prefer-non-control-spec-insns
18576 If enabled, control-speculative instructions are chosen for schedule
18577 only if there are no other choices at the moment.  This makes
18578 the use of the control speculation much more conservative.
18579 The default setting is disabled.
18581 @item -mno-sched-count-spec-in-critical-path
18582 @itemx -msched-count-spec-in-critical-path
18583 @opindex mno-sched-count-spec-in-critical-path
18584 @opindex msched-count-spec-in-critical-path
18585 If enabled, speculative dependencies are considered during
18586 computation of the instructions priorities.  This makes the use of the
18587 speculation a bit more conservative.
18588 The default setting is disabled.
18590 @item -msched-spec-ldc
18591 @opindex msched-spec-ldc
18592 Use a simple data speculation check.  This option is on by default.
18594 @item -msched-control-spec-ldc
18595 @opindex msched-spec-ldc
18596 Use a simple check for control speculation.  This option is on by default.
18598 @item -msched-stop-bits-after-every-cycle
18599 @opindex msched-stop-bits-after-every-cycle
18600 Place a stop bit after every cycle when scheduling.  This option is on
18601 by default.
18603 @item -msched-fp-mem-deps-zero-cost
18604 @opindex msched-fp-mem-deps-zero-cost
18605 Assume that floating-point stores and loads are not likely to cause a conflict
18606 when placed into the same instruction group.  This option is disabled by
18607 default.
18609 @item -msel-sched-dont-check-control-spec
18610 @opindex msel-sched-dont-check-control-spec
18611 Generate checks for control speculation in selective scheduling.
18612 This flag is disabled by default.
18614 @item -msched-max-memory-insns=@var{max-insns}
18615 @opindex msched-max-memory-insns
18616 Limit on the number of memory insns per instruction group, giving lower
18617 priority to subsequent memory insns attempting to schedule in the same
18618 instruction group. Frequently useful to prevent cache bank conflicts.
18619 The default value is 1.
18621 @item -msched-max-memory-insns-hard-limit
18622 @opindex msched-max-memory-insns-hard-limit
18623 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
18624 disallowing more than that number in an instruction group.
18625 Otherwise, the limit is ``soft'', meaning that non-memory operations
18626 are preferred when the limit is reached, but memory operations may still
18627 be scheduled.
18629 @end table
18631 @node LM32 Options
18632 @subsection LM32 Options
18633 @cindex LM32 options
18635 These @option{-m} options are defined for the LatticeMico32 architecture:
18637 @table @gcctabopt
18638 @item -mbarrel-shift-enabled
18639 @opindex mbarrel-shift-enabled
18640 Enable barrel-shift instructions.
18642 @item -mdivide-enabled
18643 @opindex mdivide-enabled
18644 Enable divide and modulus instructions.
18646 @item -mmultiply-enabled
18647 @opindex multiply-enabled
18648 Enable multiply instructions.
18650 @item -msign-extend-enabled
18651 @opindex msign-extend-enabled
18652 Enable sign extend instructions.
18654 @item -muser-enabled
18655 @opindex muser-enabled
18656 Enable user-defined instructions.
18658 @end table
18660 @node M32C Options
18661 @subsection M32C Options
18662 @cindex M32C options
18664 @table @gcctabopt
18665 @item -mcpu=@var{name}
18666 @opindex mcpu=
18667 Select the CPU for which code is generated.  @var{name} may be one of
18668 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
18669 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
18670 the M32C/80 series.
18672 @item -msim
18673 @opindex msim
18674 Specifies that the program will be run on the simulator.  This causes
18675 an alternate runtime library to be linked in which supports, for
18676 example, file I/O@.  You must not use this option when generating
18677 programs that will run on real hardware; you must provide your own
18678 runtime library for whatever I/O functions are needed.
18680 @item -memregs=@var{number}
18681 @opindex memregs=
18682 Specifies the number of memory-based pseudo-registers GCC uses
18683 during code generation.  These pseudo-registers are used like real
18684 registers, so there is a tradeoff between GCC's ability to fit the
18685 code into available registers, and the performance penalty of using
18686 memory instead of registers.  Note that all modules in a program must
18687 be compiled with the same value for this option.  Because of that, you
18688 must not use this option with GCC's default runtime libraries.
18690 @end table
18692 @node M32R/D Options
18693 @subsection M32R/D Options
18694 @cindex M32R/D options
18696 These @option{-m} options are defined for Renesas M32R/D architectures:
18698 @table @gcctabopt
18699 @item -m32r2
18700 @opindex m32r2
18701 Generate code for the M32R/2@.
18703 @item -m32rx
18704 @opindex m32rx
18705 Generate code for the M32R/X@.
18707 @item -m32r
18708 @opindex m32r
18709 Generate code for the M32R@.  This is the default.
18711 @item -mmodel=small
18712 @opindex mmodel=small
18713 Assume all objects live in the lower 16MB of memory (so that their addresses
18714 can be loaded with the @code{ld24} instruction), and assume all subroutines
18715 are reachable with the @code{bl} instruction.
18716 This is the default.
18718 The addressability of a particular object can be set with the
18719 @code{model} attribute.
18721 @item -mmodel=medium
18722 @opindex mmodel=medium
18723 Assume objects may be anywhere in the 32-bit address space (the compiler
18724 generates @code{seth/add3} instructions to load their addresses), and
18725 assume all subroutines are reachable with the @code{bl} instruction.
18727 @item -mmodel=large
18728 @opindex mmodel=large
18729 Assume objects may be anywhere in the 32-bit address space (the compiler
18730 generates @code{seth/add3} instructions to load their addresses), and
18731 assume subroutines may not be reachable with the @code{bl} instruction
18732 (the compiler generates the much slower @code{seth/add3/jl}
18733 instruction sequence).
18735 @item -msdata=none
18736 @opindex msdata=none
18737 Disable use of the small data area.  Variables are put into
18738 one of @code{.data}, @code{.bss}, or @code{.rodata} (unless the
18739 @code{section} attribute has been specified).
18740 This is the default.
18742 The small data area consists of sections @code{.sdata} and @code{.sbss}.
18743 Objects may be explicitly put in the small data area with the
18744 @code{section} attribute using one of these sections.
18746 @item -msdata=sdata
18747 @opindex msdata=sdata
18748 Put small global and static data in the small data area, but do not
18749 generate special code to reference them.
18751 @item -msdata=use
18752 @opindex msdata=use
18753 Put small global and static data in the small data area, and generate
18754 special instructions to reference them.
18756 @item -G @var{num}
18757 @opindex G
18758 @cindex smaller data references
18759 Put global and static objects less than or equal to @var{num} bytes
18760 into the small data or BSS sections instead of the normal data or BSS
18761 sections.  The default value of @var{num} is 8.
18762 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
18763 for this option to have any effect.
18765 All modules should be compiled with the same @option{-G @var{num}} value.
18766 Compiling with different values of @var{num} may or may not work; if it
18767 doesn't the linker gives an error message---incorrect code is not
18768 generated.
18770 @item -mdebug
18771 @opindex mdebug
18772 Makes the M32R-specific code in the compiler display some statistics
18773 that might help in debugging programs.
18775 @item -malign-loops
18776 @opindex malign-loops
18777 Align all loops to a 32-byte boundary.
18779 @item -mno-align-loops
18780 @opindex mno-align-loops
18781 Do not enforce a 32-byte alignment for loops.  This is the default.
18783 @item -missue-rate=@var{number}
18784 @opindex missue-rate=@var{number}
18785 Issue @var{number} instructions per cycle.  @var{number} can only be 1
18786 or 2.
18788 @item -mbranch-cost=@var{number}
18789 @opindex mbranch-cost=@var{number}
18790 @var{number} can only be 1 or 2.  If it is 1 then branches are
18791 preferred over conditional code, if it is 2, then the opposite applies.
18793 @item -mflush-trap=@var{number}
18794 @opindex mflush-trap=@var{number}
18795 Specifies the trap number to use to flush the cache.  The default is
18796 12.  Valid numbers are between 0 and 15 inclusive.
18798 @item -mno-flush-trap
18799 @opindex mno-flush-trap
18800 Specifies that the cache cannot be flushed by using a trap.
18802 @item -mflush-func=@var{name}
18803 @opindex mflush-func=@var{name}
18804 Specifies the name of the operating system function to call to flush
18805 the cache.  The default is @samp{_flush_cache}, but a function call
18806 is only used if a trap is not available.
18808 @item -mno-flush-func
18809 @opindex mno-flush-func
18810 Indicates that there is no OS function for flushing the cache.
18812 @end table
18814 @node M680x0 Options
18815 @subsection M680x0 Options
18816 @cindex M680x0 options
18818 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
18819 The default settings depend on which architecture was selected when
18820 the compiler was configured; the defaults for the most common choices
18821 are given below.
18823 @table @gcctabopt
18824 @item -march=@var{arch}
18825 @opindex march
18826 Generate code for a specific M680x0 or ColdFire instruction set
18827 architecture.  Permissible values of @var{arch} for M680x0
18828 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
18829 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
18830 architectures are selected according to Freescale's ISA classification
18831 and the permissible values are: @samp{isaa}, @samp{isaaplus},
18832 @samp{isab} and @samp{isac}.
18834 GCC defines a macro @code{__mcf@var{arch}__} whenever it is generating
18835 code for a ColdFire target.  The @var{arch} in this macro is one of the
18836 @option{-march} arguments given above.
18838 When used together, @option{-march} and @option{-mtune} select code
18839 that runs on a family of similar processors but that is optimized
18840 for a particular microarchitecture.
18842 @item -mcpu=@var{cpu}
18843 @opindex mcpu
18844 Generate code for a specific M680x0 or ColdFire processor.
18845 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
18846 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
18847 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
18848 below, which also classifies the CPUs into families:
18850 @multitable @columnfractions 0.20 0.80
18851 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
18852 @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}
18853 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
18854 @item @samp{5206e} @tab @samp{5206e}
18855 @item @samp{5208} @tab @samp{5207} @samp{5208}
18856 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
18857 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
18858 @item @samp{5216} @tab @samp{5214} @samp{5216}
18859 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
18860 @item @samp{5225} @tab @samp{5224} @samp{5225}
18861 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
18862 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
18863 @item @samp{5249} @tab @samp{5249}
18864 @item @samp{5250} @tab @samp{5250}
18865 @item @samp{5271} @tab @samp{5270} @samp{5271}
18866 @item @samp{5272} @tab @samp{5272}
18867 @item @samp{5275} @tab @samp{5274} @samp{5275}
18868 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
18869 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
18870 @item @samp{5307} @tab @samp{5307}
18871 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
18872 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
18873 @item @samp{5407} @tab @samp{5407}
18874 @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}
18875 @end multitable
18877 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
18878 @var{arch} is compatible with @var{cpu}.  Other combinations of
18879 @option{-mcpu} and @option{-march} are rejected.
18881 GCC defines the macro @code{__mcf_cpu_@var{cpu}} when ColdFire target
18882 @var{cpu} is selected.  It also defines @code{__mcf_family_@var{family}},
18883 where the value of @var{family} is given by the table above.
18885 @item -mtune=@var{tune}
18886 @opindex mtune
18887 Tune the code for a particular microarchitecture within the
18888 constraints set by @option{-march} and @option{-mcpu}.
18889 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
18890 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
18891 and @samp{cpu32}.  The ColdFire microarchitectures
18892 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
18894 You can also use @option{-mtune=68020-40} for code that needs
18895 to run relatively well on 68020, 68030 and 68040 targets.
18896 @option{-mtune=68020-60} is similar but includes 68060 targets
18897 as well.  These two options select the same tuning decisions as
18898 @option{-m68020-40} and @option{-m68020-60} respectively.
18900 GCC defines the macros @code{__mc@var{arch}} and @code{__mc@var{arch}__}
18901 when tuning for 680x0 architecture @var{arch}.  It also defines
18902 @code{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
18903 option is used.  If GCC is tuning for a range of architectures,
18904 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
18905 it defines the macros for every architecture in the range.
18907 GCC also defines the macro @code{__m@var{uarch}__} when tuning for
18908 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
18909 of the arguments given above.
18911 @item -m68000
18912 @itemx -mc68000
18913 @opindex m68000
18914 @opindex mc68000
18915 Generate output for a 68000.  This is the default
18916 when the compiler is configured for 68000-based systems.
18917 It is equivalent to @option{-march=68000}.
18919 Use this option for microcontrollers with a 68000 or EC000 core,
18920 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
18922 @item -m68010
18923 @opindex m68010
18924 Generate output for a 68010.  This is the default
18925 when the compiler is configured for 68010-based systems.
18926 It is equivalent to @option{-march=68010}.
18928 @item -m68020
18929 @itemx -mc68020
18930 @opindex m68020
18931 @opindex mc68020
18932 Generate output for a 68020.  This is the default
18933 when the compiler is configured for 68020-based systems.
18934 It is equivalent to @option{-march=68020}.
18936 @item -m68030
18937 @opindex m68030
18938 Generate output for a 68030.  This is the default when the compiler is
18939 configured for 68030-based systems.  It is equivalent to
18940 @option{-march=68030}.
18942 @item -m68040
18943 @opindex m68040
18944 Generate output for a 68040.  This is the default when the compiler is
18945 configured for 68040-based systems.  It is equivalent to
18946 @option{-march=68040}.
18948 This option inhibits the use of 68881/68882 instructions that have to be
18949 emulated by software on the 68040.  Use this option if your 68040 does not
18950 have code to emulate those instructions.
18952 @item -m68060
18953 @opindex m68060
18954 Generate output for a 68060.  This is the default when the compiler is
18955 configured for 68060-based systems.  It is equivalent to
18956 @option{-march=68060}.
18958 This option inhibits the use of 68020 and 68881/68882 instructions that
18959 have to be emulated by software on the 68060.  Use this option if your 68060
18960 does not have code to emulate those instructions.
18962 @item -mcpu32
18963 @opindex mcpu32
18964 Generate output for a CPU32.  This is the default
18965 when the compiler is configured for CPU32-based systems.
18966 It is equivalent to @option{-march=cpu32}.
18968 Use this option for microcontrollers with a
18969 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
18970 68336, 68340, 68341, 68349 and 68360.
18972 @item -m5200
18973 @opindex m5200
18974 Generate output for a 520X ColdFire CPU@.  This is the default
18975 when the compiler is configured for 520X-based systems.
18976 It is equivalent to @option{-mcpu=5206}, and is now deprecated
18977 in favor of that option.
18979 Use this option for microcontroller with a 5200 core, including
18980 the MCF5202, MCF5203, MCF5204 and MCF5206.
18982 @item -m5206e
18983 @opindex m5206e
18984 Generate output for a 5206e ColdFire CPU@.  The option is now
18985 deprecated in favor of the equivalent @option{-mcpu=5206e}.
18987 @item -m528x
18988 @opindex m528x
18989 Generate output for a member of the ColdFire 528X family.
18990 The option is now deprecated in favor of the equivalent
18991 @option{-mcpu=528x}.
18993 @item -m5307
18994 @opindex m5307
18995 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
18996 in favor of the equivalent @option{-mcpu=5307}.
18998 @item -m5407
18999 @opindex m5407
19000 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
19001 in favor of the equivalent @option{-mcpu=5407}.
19003 @item -mcfv4e
19004 @opindex mcfv4e
19005 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
19006 This includes use of hardware floating-point instructions.
19007 The option is equivalent to @option{-mcpu=547x}, and is now
19008 deprecated in favor of that option.
19010 @item -m68020-40
19011 @opindex m68020-40
19012 Generate output for a 68040, without using any of the new instructions.
19013 This results in code that can run relatively efficiently on either a
19014 68020/68881 or a 68030 or a 68040.  The generated code does use the
19015 68881 instructions that are emulated on the 68040.
19017 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
19019 @item -m68020-60
19020 @opindex m68020-60
19021 Generate output for a 68060, without using any of the new instructions.
19022 This results in code that can run relatively efficiently on either a
19023 68020/68881 or a 68030 or a 68040.  The generated code does use the
19024 68881 instructions that are emulated on the 68060.
19026 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
19028 @item -mhard-float
19029 @itemx -m68881
19030 @opindex mhard-float
19031 @opindex m68881
19032 Generate floating-point instructions.  This is the default for 68020
19033 and above, and for ColdFire devices that have an FPU@.  It defines the
19034 macro @code{__HAVE_68881__} on M680x0 targets and @code{__mcffpu__}
19035 on ColdFire targets.
19037 @item -msoft-float
19038 @opindex msoft-float
19039 Do not generate floating-point instructions; use library calls instead.
19040 This is the default for 68000, 68010, and 68832 targets.  It is also
19041 the default for ColdFire devices that have no FPU.
19043 @item -mdiv
19044 @itemx -mno-div
19045 @opindex mdiv
19046 @opindex mno-div
19047 Generate (do not generate) ColdFire hardware divide and remainder
19048 instructions.  If @option{-march} is used without @option{-mcpu},
19049 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
19050 architectures.  Otherwise, the default is taken from the target CPU
19051 (either the default CPU, or the one specified by @option{-mcpu}).  For
19052 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
19053 @option{-mcpu=5206e}.
19055 GCC defines the macro @code{__mcfhwdiv__} when this option is enabled.
19057 @item -mshort
19058 @opindex mshort
19059 Consider type @code{int} to be 16 bits wide, like @code{short int}.
19060 Additionally, parameters passed on the stack are also aligned to a
19061 16-bit boundary even on targets whose API mandates promotion to 32-bit.
19063 @item -mno-short
19064 @opindex mno-short
19065 Do not consider type @code{int} to be 16 bits wide.  This is the default.
19067 @item -mnobitfield
19068 @itemx -mno-bitfield
19069 @opindex mnobitfield
19070 @opindex mno-bitfield
19071 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
19072 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
19074 @item -mbitfield
19075 @opindex mbitfield
19076 Do use the bit-field instructions.  The @option{-m68020} option implies
19077 @option{-mbitfield}.  This is the default if you use a configuration
19078 designed for a 68020.
19080 @item -mrtd
19081 @opindex mrtd
19082 Use a different function-calling convention, in which functions
19083 that take a fixed number of arguments return with the @code{rtd}
19084 instruction, which pops their arguments while returning.  This
19085 saves one instruction in the caller since there is no need to pop
19086 the arguments there.
19088 This calling convention is incompatible with the one normally
19089 used on Unix, so you cannot use it if you need to call libraries
19090 compiled with the Unix compiler.
19092 Also, you must provide function prototypes for all functions that
19093 take variable numbers of arguments (including @code{printf});
19094 otherwise incorrect code is generated for calls to those
19095 functions.
19097 In addition, seriously incorrect code results if you call a
19098 function with too many arguments.  (Normally, extra arguments are
19099 harmlessly ignored.)
19101 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
19102 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
19104 @item -mno-rtd
19105 @opindex mno-rtd
19106 Do not use the calling conventions selected by @option{-mrtd}.
19107 This is the default.
19109 @item -malign-int
19110 @itemx -mno-align-int
19111 @opindex malign-int
19112 @opindex mno-align-int
19113 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
19114 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
19115 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
19116 Aligning variables on 32-bit boundaries produces code that runs somewhat
19117 faster on processors with 32-bit busses at the expense of more memory.
19119 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
19120 aligns structures containing the above types differently than
19121 most published application binary interface specifications for the m68k.
19123 @item -mpcrel
19124 @opindex mpcrel
19125 Use the pc-relative addressing mode of the 68000 directly, instead of
19126 using a global offset table.  At present, this option implies @option{-fpic},
19127 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
19128 not presently supported with @option{-mpcrel}, though this could be supported for
19129 68020 and higher processors.
19131 @item -mno-strict-align
19132 @itemx -mstrict-align
19133 @opindex mno-strict-align
19134 @opindex mstrict-align
19135 Do not (do) assume that unaligned memory references are handled by
19136 the system.
19138 @item -msep-data
19139 Generate code that allows the data segment to be located in a different
19140 area of memory from the text segment.  This allows for execute-in-place in
19141 an environment without virtual memory management.  This option implies
19142 @option{-fPIC}.
19144 @item -mno-sep-data
19145 Generate code that assumes that the data segment follows the text segment.
19146 This is the default.
19148 @item -mid-shared-library
19149 Generate code that supports shared libraries via the library ID method.
19150 This allows for execute-in-place and shared libraries in an environment
19151 without virtual memory management.  This option implies @option{-fPIC}.
19153 @item -mno-id-shared-library
19154 Generate code that doesn't assume ID-based shared libraries are being used.
19155 This is the default.
19157 @item -mshared-library-id=n
19158 Specifies the identification number of the ID-based shared library being
19159 compiled.  Specifying a value of 0 generates more compact code; specifying
19160 other values forces the allocation of that number to the current
19161 library, but is no more space- or time-efficient than omitting this option.
19163 @item -mxgot
19164 @itemx -mno-xgot
19165 @opindex mxgot
19166 @opindex mno-xgot
19167 When generating position-independent code for ColdFire, generate code
19168 that works if the GOT has more than 8192 entries.  This code is
19169 larger and slower than code generated without this option.  On M680x0
19170 processors, this option is not needed; @option{-fPIC} suffices.
19172 GCC normally uses a single instruction to load values from the GOT@.
19173 While this is relatively efficient, it only works if the GOT
19174 is smaller than about 64k.  Anything larger causes the linker
19175 to report an error such as:
19177 @cindex relocation truncated to fit (ColdFire)
19178 @smallexample
19179 relocation truncated to fit: R_68K_GOT16O foobar
19180 @end smallexample
19182 If this happens, you should recompile your code with @option{-mxgot}.
19183 It should then work with very large GOTs.  However, code generated with
19184 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
19185 the value of a global symbol.
19187 Note that some linkers, including newer versions of the GNU linker,
19188 can create multiple GOTs and sort GOT entries.  If you have such a linker,
19189 you should only need to use @option{-mxgot} when compiling a single
19190 object file that accesses more than 8192 GOT entries.  Very few do.
19192 These options have no effect unless GCC is generating
19193 position-independent code.
19195 @item -mlong-jump-table-offsets
19196 @opindex mlong-jump-table-offsets
19197 Use 32-bit offsets in @code{switch} tables.  The default is to use
19198 16-bit offsets.
19200 @end table
19202 @node MCore Options
19203 @subsection MCore Options
19204 @cindex MCore options
19206 These are the @samp{-m} options defined for the Motorola M*Core
19207 processors.
19209 @table @gcctabopt
19211 @item -mhardlit
19212 @itemx -mno-hardlit
19213 @opindex mhardlit
19214 @opindex mno-hardlit
19215 Inline constants into the code stream if it can be done in two
19216 instructions or less.
19218 @item -mdiv
19219 @itemx -mno-div
19220 @opindex mdiv
19221 @opindex mno-div
19222 Use the divide instruction.  (Enabled by default).
19224 @item -mrelax-immediate
19225 @itemx -mno-relax-immediate
19226 @opindex mrelax-immediate
19227 @opindex mno-relax-immediate
19228 Allow arbitrary-sized immediates in bit operations.
19230 @item -mwide-bitfields
19231 @itemx -mno-wide-bitfields
19232 @opindex mwide-bitfields
19233 @opindex mno-wide-bitfields
19234 Always treat bit-fields as @code{int}-sized.
19236 @item -m4byte-functions
19237 @itemx -mno-4byte-functions
19238 @opindex m4byte-functions
19239 @opindex mno-4byte-functions
19240 Force all functions to be aligned to a 4-byte boundary.
19242 @item -mcallgraph-data
19243 @itemx -mno-callgraph-data
19244 @opindex mcallgraph-data
19245 @opindex mno-callgraph-data
19246 Emit callgraph information.
19248 @item -mslow-bytes
19249 @itemx -mno-slow-bytes
19250 @opindex mslow-bytes
19251 @opindex mno-slow-bytes
19252 Prefer word access when reading byte quantities.
19254 @item -mlittle-endian
19255 @itemx -mbig-endian
19256 @opindex mlittle-endian
19257 @opindex mbig-endian
19258 Generate code for a little-endian target.
19260 @item -m210
19261 @itemx -m340
19262 @opindex m210
19263 @opindex m340
19264 Generate code for the 210 processor.
19266 @item -mno-lsim
19267 @opindex mno-lsim
19268 Assume that runtime support has been provided and so omit the
19269 simulator library (@file{libsim.a)} from the linker command line.
19271 @item -mstack-increment=@var{size}
19272 @opindex mstack-increment
19273 Set the maximum amount for a single stack increment operation.  Large
19274 values can increase the speed of programs that contain functions
19275 that need a large amount of stack space, but they can also trigger a
19276 segmentation fault if the stack is extended too much.  The default
19277 value is 0x1000.
19279 @end table
19281 @node MeP Options
19282 @subsection MeP Options
19283 @cindex MeP options
19285 @table @gcctabopt
19287 @item -mabsdiff
19288 @opindex mabsdiff
19289 Enables the @code{abs} instruction, which is the absolute difference
19290 between two registers.
19292 @item -mall-opts
19293 @opindex mall-opts
19294 Enables all the optional instructions---average, multiply, divide, bit
19295 operations, leading zero, absolute difference, min/max, clip, and
19296 saturation.
19299 @item -maverage
19300 @opindex maverage
19301 Enables the @code{ave} instruction, which computes the average of two
19302 registers.
19304 @item -mbased=@var{n}
19305 @opindex mbased=
19306 Variables of size @var{n} bytes or smaller are placed in the
19307 @code{.based} section by default.  Based variables use the @code{$tp}
19308 register as a base register, and there is a 128-byte limit to the
19309 @code{.based} section.
19311 @item -mbitops
19312 @opindex mbitops
19313 Enables the bit operation instructions---bit test (@code{btstm}), set
19314 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
19315 test-and-set (@code{tas}).
19317 @item -mc=@var{name}
19318 @opindex mc=
19319 Selects which section constant data is placed in.  @var{name} may
19320 be @samp{tiny}, @samp{near}, or @samp{far}.
19322 @item -mclip
19323 @opindex mclip
19324 Enables the @code{clip} instruction.  Note that @option{-mclip} is not
19325 useful unless you also provide @option{-mminmax}.
19327 @item -mconfig=@var{name}
19328 @opindex mconfig=
19329 Selects one of the built-in core configurations.  Each MeP chip has
19330 one or more modules in it; each module has a core CPU and a variety of
19331 coprocessors, optional instructions, and peripherals.  The
19332 @code{MeP-Integrator} tool, not part of GCC, provides these
19333 configurations through this option; using this option is the same as
19334 using all the corresponding command-line options.  The default
19335 configuration is @samp{default}.
19337 @item -mcop
19338 @opindex mcop
19339 Enables the coprocessor instructions.  By default, this is a 32-bit
19340 coprocessor.  Note that the coprocessor is normally enabled via the
19341 @option{-mconfig=} option.
19343 @item -mcop32
19344 @opindex mcop32
19345 Enables the 32-bit coprocessor's instructions.
19347 @item -mcop64
19348 @opindex mcop64
19349 Enables the 64-bit coprocessor's instructions.
19351 @item -mivc2
19352 @opindex mivc2
19353 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
19355 @item -mdc
19356 @opindex mdc
19357 Causes constant variables to be placed in the @code{.near} section.
19359 @item -mdiv
19360 @opindex mdiv
19361 Enables the @code{div} and @code{divu} instructions.
19363 @item -meb
19364 @opindex meb
19365 Generate big-endian code.
19367 @item -mel
19368 @opindex mel
19369 Generate little-endian code.
19371 @item -mio-volatile
19372 @opindex mio-volatile
19373 Tells the compiler that any variable marked with the @code{io}
19374 attribute is to be considered volatile.
19376 @item -ml
19377 @opindex ml
19378 Causes variables to be assigned to the @code{.far} section by default.
19380 @item -mleadz
19381 @opindex mleadz
19382 Enables the @code{leadz} (leading zero) instruction.
19384 @item -mm
19385 @opindex mm
19386 Causes variables to be assigned to the @code{.near} section by default.
19388 @item -mminmax
19389 @opindex mminmax
19390 Enables the @code{min} and @code{max} instructions.
19392 @item -mmult
19393 @opindex mmult
19394 Enables the multiplication and multiply-accumulate instructions.
19396 @item -mno-opts
19397 @opindex mno-opts
19398 Disables all the optional instructions enabled by @option{-mall-opts}.
19400 @item -mrepeat
19401 @opindex mrepeat
19402 Enables the @code{repeat} and @code{erepeat} instructions, used for
19403 low-overhead looping.
19405 @item -ms
19406 @opindex ms
19407 Causes all variables to default to the @code{.tiny} section.  Note
19408 that there is a 65536-byte limit to this section.  Accesses to these
19409 variables use the @code{%gp} base register.
19411 @item -msatur
19412 @opindex msatur
19413 Enables the saturation instructions.  Note that the compiler does not
19414 currently generate these itself, but this option is included for
19415 compatibility with other tools, like @code{as}.
19417 @item -msdram
19418 @opindex msdram
19419 Link the SDRAM-based runtime instead of the default ROM-based runtime.
19421 @item -msim
19422 @opindex msim
19423 Link the simulator run-time libraries.
19425 @item -msimnovec
19426 @opindex msimnovec
19427 Link the simulator runtime libraries, excluding built-in support
19428 for reset and exception vectors and tables.
19430 @item -mtf
19431 @opindex mtf
19432 Causes all functions to default to the @code{.far} section.  Without
19433 this option, functions default to the @code{.near} section.
19435 @item -mtiny=@var{n}
19436 @opindex mtiny=
19437 Variables that are @var{n} bytes or smaller are allocated to the
19438 @code{.tiny} section.  These variables use the @code{$gp} base
19439 register.  The default for this option is 4, but note that there's a
19440 65536-byte limit to the @code{.tiny} section.
19442 @end table
19444 @node MicroBlaze Options
19445 @subsection MicroBlaze Options
19446 @cindex MicroBlaze Options
19448 @table @gcctabopt
19450 @item -msoft-float
19451 @opindex msoft-float
19452 Use software emulation for floating point (default).
19454 @item -mhard-float
19455 @opindex mhard-float
19456 Use hardware floating-point instructions.
19458 @item -mmemcpy
19459 @opindex mmemcpy
19460 Do not optimize block moves, use @code{memcpy}.
19462 @item -mno-clearbss
19463 @opindex mno-clearbss
19464 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
19466 @item -mcpu=@var{cpu-type}
19467 @opindex mcpu=
19468 Use features of, and schedule code for, the given CPU.
19469 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
19470 where @var{X} is a major version, @var{YY} is the minor version, and
19471 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
19472 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
19474 @item -mxl-soft-mul
19475 @opindex mxl-soft-mul
19476 Use software multiply emulation (default).
19478 @item -mxl-soft-div
19479 @opindex mxl-soft-div
19480 Use software emulation for divides (default).
19482 @item -mxl-barrel-shift
19483 @opindex mxl-barrel-shift
19484 Use the hardware barrel shifter.
19486 @item -mxl-pattern-compare
19487 @opindex mxl-pattern-compare
19488 Use pattern compare instructions.
19490 @item -msmall-divides
19491 @opindex msmall-divides
19492 Use table lookup optimization for small signed integer divisions.
19494 @item -mxl-stack-check
19495 @opindex mxl-stack-check
19496 This option is deprecated.  Use @option{-fstack-check} instead.
19498 @item -mxl-gp-opt
19499 @opindex mxl-gp-opt
19500 Use GP-relative @code{.sdata}/@code{.sbss} sections.
19502 @item -mxl-multiply-high
19503 @opindex mxl-multiply-high
19504 Use multiply high instructions for high part of 32x32 multiply.
19506 @item -mxl-float-convert
19507 @opindex mxl-float-convert
19508 Use hardware floating-point conversion instructions.
19510 @item -mxl-float-sqrt
19511 @opindex mxl-float-sqrt
19512 Use hardware floating-point square root instruction.
19514 @item -mbig-endian
19515 @opindex mbig-endian
19516 Generate code for a big-endian target.
19518 @item -mlittle-endian
19519 @opindex mlittle-endian
19520 Generate code for a little-endian target.
19522 @item -mxl-reorder
19523 @opindex mxl-reorder
19524 Use reorder instructions (swap and byte reversed load/store).
19526 @item -mxl-mode-@var{app-model}
19527 Select application model @var{app-model}.  Valid models are
19528 @table @samp
19529 @item executable
19530 normal executable (default), uses startup code @file{crt0.o}.
19532 @item xmdstub
19533 for use with Xilinx Microprocessor Debugger (XMD) based
19534 software intrusive debug agent called xmdstub. This uses startup file
19535 @file{crt1.o} and sets the start address of the program to 0x800.
19537 @item bootstrap
19538 for applications that are loaded using a bootloader.
19539 This model uses startup file @file{crt2.o} which does not contain a processor
19540 reset vector handler. This is suitable for transferring control on a
19541 processor reset to the bootloader rather than the application.
19543 @item novectors
19544 for applications that do not require any of the
19545 MicroBlaze vectors. This option may be useful for applications running
19546 within a monitoring application. This model uses @file{crt3.o} as a startup file.
19547 @end table
19549 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
19550 @option{-mxl-mode-@var{app-model}}.
19552 @end table
19554 @node MIPS Options
19555 @subsection MIPS Options
19556 @cindex MIPS options
19558 @table @gcctabopt
19560 @item -EB
19561 @opindex EB
19562 Generate big-endian code.
19564 @item -EL
19565 @opindex EL
19566 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
19567 configurations.
19569 @item -march=@var{arch}
19570 @opindex march
19571 Generate code that runs on @var{arch}, which can be the name of a
19572 generic MIPS ISA, or the name of a particular processor.
19573 The ISA names are:
19574 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
19575 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5},
19576 @samp{mips32r6}, @samp{mips64}, @samp{mips64r2}, @samp{mips64r3},
19577 @samp{mips64r5} and @samp{mips64r6}.
19578 The processor names are:
19579 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
19580 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
19581 @samp{5kc}, @samp{5kf},
19582 @samp{20kc},
19583 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
19584 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
19585 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
19586 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
19587 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
19588 @samp{i6400},
19589 @samp{interaptiv},
19590 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
19591 @samp{m4k},
19592 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
19593 @samp{m5100}, @samp{m5101},
19594 @samp{octeon}, @samp{octeon+}, @samp{octeon2}, @samp{octeon3},
19595 @samp{orion},
19596 @samp{p5600},
19597 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
19598 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
19599 @samp{rm7000}, @samp{rm9000},
19600 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
19601 @samp{sb1},
19602 @samp{sr71000},
19603 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
19604 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
19605 @samp{xlr} and @samp{xlp}.
19606 The special value @samp{from-abi} selects the
19607 most compatible architecture for the selected ABI (that is,
19608 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
19610 The native Linux/GNU toolchain also supports the value @samp{native},
19611 which selects the best architecture option for the host processor.
19612 @option{-march=native} has no effect if GCC does not recognize
19613 the processor.
19615 In processor names, a final @samp{000} can be abbreviated as @samp{k}
19616 (for example, @option{-march=r2k}).  Prefixes are optional, and
19617 @samp{vr} may be written @samp{r}.
19619 Names of the form @samp{@var{n}f2_1} refer to processors with
19620 FPUs clocked at half the rate of the core, names of the form
19621 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
19622 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
19623 processors with FPUs clocked a ratio of 3:2 with respect to the core.
19624 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
19625 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
19626 accepted as synonyms for @samp{@var{n}f1_1}.
19628 GCC defines two macros based on the value of this option.  The first
19629 is @code{_MIPS_ARCH}, which gives the name of target architecture, as
19630 a string.  The second has the form @code{_MIPS_ARCH_@var{foo}},
19631 where @var{foo} is the capitalized value of @code{_MIPS_ARCH}@.
19632 For example, @option{-march=r2000} sets @code{_MIPS_ARCH}
19633 to @code{"r2000"} and defines the macro @code{_MIPS_ARCH_R2000}.
19635 Note that the @code{_MIPS_ARCH} macro uses the processor names given
19636 above.  In other words, it has the full prefix and does not
19637 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
19638 the macro names the resolved architecture (either @code{"mips1"} or
19639 @code{"mips3"}).  It names the default architecture when no
19640 @option{-march} option is given.
19642 @item -mtune=@var{arch}
19643 @opindex mtune
19644 Optimize for @var{arch}.  Among other things, this option controls
19645 the way instructions are scheduled, and the perceived cost of arithmetic
19646 operations.  The list of @var{arch} values is the same as for
19647 @option{-march}.
19649 When this option is not used, GCC optimizes for the processor
19650 specified by @option{-march}.  By using @option{-march} and
19651 @option{-mtune} together, it is possible to generate code that
19652 runs on a family of processors, but optimize the code for one
19653 particular member of that family.
19655 @option{-mtune} defines the macros @code{_MIPS_TUNE} and
19656 @code{_MIPS_TUNE_@var{foo}}, which work in the same way as the
19657 @option{-march} ones described above.
19659 @item -mips1
19660 @opindex mips1
19661 Equivalent to @option{-march=mips1}.
19663 @item -mips2
19664 @opindex mips2
19665 Equivalent to @option{-march=mips2}.
19667 @item -mips3
19668 @opindex mips3
19669 Equivalent to @option{-march=mips3}.
19671 @item -mips4
19672 @opindex mips4
19673 Equivalent to @option{-march=mips4}.
19675 @item -mips32
19676 @opindex mips32
19677 Equivalent to @option{-march=mips32}.
19679 @item -mips32r3
19680 @opindex mips32r3
19681 Equivalent to @option{-march=mips32r3}.
19683 @item -mips32r5
19684 @opindex mips32r5
19685 Equivalent to @option{-march=mips32r5}.
19687 @item -mips32r6
19688 @opindex mips32r6
19689 Equivalent to @option{-march=mips32r6}.
19691 @item -mips64
19692 @opindex mips64
19693 Equivalent to @option{-march=mips64}.
19695 @item -mips64r2
19696 @opindex mips64r2
19697 Equivalent to @option{-march=mips64r2}.
19699 @item -mips64r3
19700 @opindex mips64r3
19701 Equivalent to @option{-march=mips64r3}.
19703 @item -mips64r5
19704 @opindex mips64r5
19705 Equivalent to @option{-march=mips64r5}.
19707 @item -mips64r6
19708 @opindex mips64r6
19709 Equivalent to @option{-march=mips64r6}.
19711 @item -mips16
19712 @itemx -mno-mips16
19713 @opindex mips16
19714 @opindex mno-mips16
19715 Generate (do not generate) MIPS16 code.  If GCC is targeting a
19716 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
19718 MIPS16 code generation can also be controlled on a per-function basis
19719 by means of @code{mips16} and @code{nomips16} attributes.
19720 @xref{Function Attributes}, for more information.
19722 @item -mflip-mips16
19723 @opindex mflip-mips16
19724 Generate MIPS16 code on alternating functions.  This option is provided
19725 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
19726 not intended for ordinary use in compiling user code.
19728 @item -minterlink-compressed
19729 @item -mno-interlink-compressed
19730 @opindex minterlink-compressed
19731 @opindex mno-interlink-compressed
19732 Require (do not require) that code using the standard (uncompressed) MIPS ISA
19733 be link-compatible with MIPS16 and microMIPS code, and vice versa.
19735 For example, code using the standard ISA encoding cannot jump directly
19736 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
19737 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
19738 knows that the target of the jump is not compressed.
19740 @item -minterlink-mips16
19741 @itemx -mno-interlink-mips16
19742 @opindex minterlink-mips16
19743 @opindex mno-interlink-mips16
19744 Aliases of @option{-minterlink-compressed} and
19745 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
19746 and are retained for backwards compatibility.
19748 @item -mabi=32
19749 @itemx -mabi=o64
19750 @itemx -mabi=n32
19751 @itemx -mabi=64
19752 @itemx -mabi=eabi
19753 @opindex mabi=32
19754 @opindex mabi=o64
19755 @opindex mabi=n32
19756 @opindex mabi=64
19757 @opindex mabi=eabi
19758 Generate code for the given ABI@.
19760 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
19761 generates 64-bit code when you select a 64-bit architecture, but you
19762 can use @option{-mgp32} to get 32-bit code instead.
19764 For information about the O64 ABI, see
19765 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
19767 GCC supports a variant of the o32 ABI in which floating-point registers
19768 are 64 rather than 32 bits wide.  You can select this combination with
19769 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
19770 and @code{mfhc1} instructions and is therefore only supported for
19771 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
19773 The register assignments for arguments and return values remain the
19774 same, but each scalar value is passed in a single 64-bit register
19775 rather than a pair of 32-bit registers.  For example, scalar
19776 floating-point values are returned in @samp{$f0} only, not a
19777 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
19778 remains the same in that the even-numbered double-precision registers
19779 are saved.
19781 Two additional variants of the o32 ABI are supported to enable
19782 a transition from 32-bit to 64-bit registers.  These are FPXX
19783 (@option{-mfpxx}) and FP64A (@option{-mfp64} @option{-mno-odd-spreg}).
19784 The FPXX extension mandates that all code must execute correctly
19785 when run using 32-bit or 64-bit registers.  The code can be interlinked
19786 with either FP32 or FP64, but not both.
19787 The FP64A extension is similar to the FP64 extension but forbids the
19788 use of odd-numbered single-precision registers.  This can be used
19789 in conjunction with the @code{FRE} mode of FPUs in MIPS32R5
19790 processors and allows both FP32 and FP64A code to interlink and
19791 run in the same process without changing FPU modes.
19793 @item -mabicalls
19794 @itemx -mno-abicalls
19795 @opindex mabicalls
19796 @opindex mno-abicalls
19797 Generate (do not generate) code that is suitable for SVR4-style
19798 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
19799 systems.
19801 @item -mshared
19802 @itemx -mno-shared
19803 Generate (do not generate) code that is fully position-independent,
19804 and that can therefore be linked into shared libraries.  This option
19805 only affects @option{-mabicalls}.
19807 All @option{-mabicalls} code has traditionally been position-independent,
19808 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
19809 as an extension, the GNU toolchain allows executables to use absolute
19810 accesses for locally-binding symbols.  It can also use shorter GP
19811 initialization sequences and generate direct calls to locally-defined
19812 functions.  This mode is selected by @option{-mno-shared}.
19814 @option{-mno-shared} depends on binutils 2.16 or higher and generates
19815 objects that can only be linked by the GNU linker.  However, the option
19816 does not affect the ABI of the final executable; it only affects the ABI
19817 of relocatable objects.  Using @option{-mno-shared} generally makes
19818 executables both smaller and quicker.
19820 @option{-mshared} is the default.
19822 @item -mplt
19823 @itemx -mno-plt
19824 @opindex mplt
19825 @opindex mno-plt
19826 Assume (do not assume) that the static and dynamic linkers
19827 support PLTs and copy relocations.  This option only affects
19828 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
19829 has no effect without @option{-msym32}.
19831 You can make @option{-mplt} the default by configuring
19832 GCC with @option{--with-mips-plt}.  The default is
19833 @option{-mno-plt} otherwise.
19835 @item -mxgot
19836 @itemx -mno-xgot
19837 @opindex mxgot
19838 @opindex mno-xgot
19839 Lift (do not lift) the usual restrictions on the size of the global
19840 offset table.
19842 GCC normally uses a single instruction to load values from the GOT@.
19843 While this is relatively efficient, it only works if the GOT
19844 is smaller than about 64k.  Anything larger causes the linker
19845 to report an error such as:
19847 @cindex relocation truncated to fit (MIPS)
19848 @smallexample
19849 relocation truncated to fit: R_MIPS_GOT16 foobar
19850 @end smallexample
19852 If this happens, you should recompile your code with @option{-mxgot}.
19853 This works with very large GOTs, although the code is also
19854 less efficient, since it takes three instructions to fetch the
19855 value of a global symbol.
19857 Note that some linkers can create multiple GOTs.  If you have such a
19858 linker, you should only need to use @option{-mxgot} when a single object
19859 file accesses more than 64k's worth of GOT entries.  Very few do.
19861 These options have no effect unless GCC is generating position
19862 independent code.
19864 @item -mgp32
19865 @opindex mgp32
19866 Assume that general-purpose registers are 32 bits wide.
19868 @item -mgp64
19869 @opindex mgp64
19870 Assume that general-purpose registers are 64 bits wide.
19872 @item -mfp32
19873 @opindex mfp32
19874 Assume that floating-point registers are 32 bits wide.
19876 @item -mfp64
19877 @opindex mfp64
19878 Assume that floating-point registers are 64 bits wide.
19880 @item -mfpxx
19881 @opindex mfpxx
19882 Do not assume the width of floating-point registers.
19884 @item -mhard-float
19885 @opindex mhard-float
19886 Use floating-point coprocessor instructions.
19888 @item -msoft-float
19889 @opindex msoft-float
19890 Do not use floating-point coprocessor instructions.  Implement
19891 floating-point calculations using library calls instead.
19893 @item -mno-float
19894 @opindex mno-float
19895 Equivalent to @option{-msoft-float}, but additionally asserts that the
19896 program being compiled does not perform any floating-point operations.
19897 This option is presently supported only by some bare-metal MIPS
19898 configurations, where it may select a special set of libraries
19899 that lack all floating-point support (including, for example, the
19900 floating-point @code{printf} formats).  
19901 If code compiled with @option{-mno-float} accidentally contains
19902 floating-point operations, it is likely to suffer a link-time
19903 or run-time failure.
19905 @item -msingle-float
19906 @opindex msingle-float
19907 Assume that the floating-point coprocessor only supports single-precision
19908 operations.
19910 @item -mdouble-float
19911 @opindex mdouble-float
19912 Assume that the floating-point coprocessor supports double-precision
19913 operations.  This is the default.
19915 @item -modd-spreg
19916 @itemx -mno-odd-spreg
19917 @opindex modd-spreg
19918 @opindex mno-odd-spreg
19919 Enable the use of odd-numbered single-precision floating-point registers
19920 for the o32 ABI.  This is the default for processors that are known to
19921 support these registers.  When using the o32 FPXX ABI, @option{-mno-odd-spreg}
19922 is set by default.
19924 @item -mabs=2008
19925 @itemx -mabs=legacy
19926 @opindex mabs=2008
19927 @opindex mabs=legacy
19928 These options control the treatment of the special not-a-number (NaN)
19929 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
19930 @code{neg.@i{fmt}} machine instructions.
19932 By default or when @option{-mabs=legacy} is used the legacy
19933 treatment is selected.  In this case these instructions are considered
19934 arithmetic and avoided where correct operation is required and the
19935 input operand might be a NaN.  A longer sequence of instructions that
19936 manipulate the sign bit of floating-point datum manually is used
19937 instead unless the @option{-ffinite-math-only} option has also been
19938 specified.
19940 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
19941 this case these instructions are considered non-arithmetic and therefore
19942 operating correctly in all cases, including in particular where the
19943 input operand is a NaN.  These instructions are therefore always used
19944 for the respective operations.
19946 @item -mnan=2008
19947 @itemx -mnan=legacy
19948 @opindex mnan=2008
19949 @opindex mnan=legacy
19950 These options control the encoding of the special not-a-number (NaN)
19951 IEEE 754 floating-point data.
19953 The @option{-mnan=legacy} option selects the legacy encoding.  In this
19954 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
19955 significand field being 0, whereas signaling NaNs (sNaNs) are denoted
19956 by the first bit of their trailing significand field being 1.
19958 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
19959 this case qNaNs are denoted by the first bit of their trailing
19960 significand field being 1, whereas sNaNs are denoted by the first bit of
19961 their trailing significand field being 0.
19963 The default is @option{-mnan=legacy} unless GCC has been configured with
19964 @option{--with-nan=2008}.
19966 @item -mllsc
19967 @itemx -mno-llsc
19968 @opindex mllsc
19969 @opindex mno-llsc
19970 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
19971 implement atomic memory built-in functions.  When neither option is
19972 specified, GCC uses the instructions if the target architecture
19973 supports them.
19975 @option{-mllsc} is useful if the runtime environment can emulate the
19976 instructions and @option{-mno-llsc} can be useful when compiling for
19977 nonstandard ISAs.  You can make either option the default by
19978 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
19979 respectively.  @option{--with-llsc} is the default for some
19980 configurations; see the installation documentation for details.
19982 @item -mdsp
19983 @itemx -mno-dsp
19984 @opindex mdsp
19985 @opindex mno-dsp
19986 Use (do not use) revision 1 of the MIPS DSP ASE@.
19987 @xref{MIPS DSP Built-in Functions}.  This option defines the
19988 preprocessor macro @code{__mips_dsp}.  It also defines
19989 @code{__mips_dsp_rev} to 1.
19991 @item -mdspr2
19992 @itemx -mno-dspr2
19993 @opindex mdspr2
19994 @opindex mno-dspr2
19995 Use (do not use) revision 2 of the MIPS DSP ASE@.
19996 @xref{MIPS DSP Built-in Functions}.  This option defines the
19997 preprocessor macros @code{__mips_dsp} and @code{__mips_dspr2}.
19998 It also defines @code{__mips_dsp_rev} to 2.
20000 @item -msmartmips
20001 @itemx -mno-smartmips
20002 @opindex msmartmips
20003 @opindex mno-smartmips
20004 Use (do not use) the MIPS SmartMIPS ASE.
20006 @item -mpaired-single
20007 @itemx -mno-paired-single
20008 @opindex mpaired-single
20009 @opindex mno-paired-single
20010 Use (do not use) paired-single floating-point instructions.
20011 @xref{MIPS Paired-Single Support}.  This option requires
20012 hardware floating-point support to be enabled.
20014 @item -mdmx
20015 @itemx -mno-mdmx
20016 @opindex mdmx
20017 @opindex mno-mdmx
20018 Use (do not use) MIPS Digital Media Extension instructions.
20019 This option can only be used when generating 64-bit code and requires
20020 hardware floating-point support to be enabled.
20022 @item -mips3d
20023 @itemx -mno-mips3d
20024 @opindex mips3d
20025 @opindex mno-mips3d
20026 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
20027 The option @option{-mips3d} implies @option{-mpaired-single}.
20029 @item -mmicromips
20030 @itemx -mno-micromips
20031 @opindex mmicromips
20032 @opindex mno-mmicromips
20033 Generate (do not generate) microMIPS code.
20035 MicroMIPS code generation can also be controlled on a per-function basis
20036 by means of @code{micromips} and @code{nomicromips} attributes.
20037 @xref{Function Attributes}, for more information.
20039 @item -mmt
20040 @itemx -mno-mt
20041 @opindex mmt
20042 @opindex mno-mt
20043 Use (do not use) MT Multithreading instructions.
20045 @item -mmcu
20046 @itemx -mno-mcu
20047 @opindex mmcu
20048 @opindex mno-mcu
20049 Use (do not use) the MIPS MCU ASE instructions.
20051 @item -meva
20052 @itemx -mno-eva
20053 @opindex meva
20054 @opindex mno-eva
20055 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
20057 @item -mvirt
20058 @itemx -mno-virt
20059 @opindex mvirt
20060 @opindex mno-virt
20061 Use (do not use) the MIPS Virtualization (VZ) instructions.
20063 @item -mxpa
20064 @itemx -mno-xpa
20065 @opindex mxpa
20066 @opindex mno-xpa
20067 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
20069 @item -mlong64
20070 @opindex mlong64
20071 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
20072 an explanation of the default and the way that the pointer size is
20073 determined.
20075 @item -mlong32
20076 @opindex mlong32
20077 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
20079 The default size of @code{int}s, @code{long}s and pointers depends on
20080 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
20081 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
20082 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
20083 or the same size as integer registers, whichever is smaller.
20085 @item -msym32
20086 @itemx -mno-sym32
20087 @opindex msym32
20088 @opindex mno-sym32
20089 Assume (do not assume) that all symbols have 32-bit values, regardless
20090 of the selected ABI@.  This option is useful in combination with
20091 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
20092 to generate shorter and faster references to symbolic addresses.
20094 @item -G @var{num}
20095 @opindex G
20096 Put definitions of externally-visible data in a small data section
20097 if that data is no bigger than @var{num} bytes.  GCC can then generate
20098 more efficient accesses to the data; see @option{-mgpopt} for details.
20100 The default @option{-G} option depends on the configuration.
20102 @item -mlocal-sdata
20103 @itemx -mno-local-sdata
20104 @opindex mlocal-sdata
20105 @opindex mno-local-sdata
20106 Extend (do not extend) the @option{-G} behavior to local data too,
20107 such as to static variables in C@.  @option{-mlocal-sdata} is the
20108 default for all configurations.
20110 If the linker complains that an application is using too much small data,
20111 you might want to try rebuilding the less performance-critical parts with
20112 @option{-mno-local-sdata}.  You might also want to build large
20113 libraries with @option{-mno-local-sdata}, so that the libraries leave
20114 more room for the main program.
20116 @item -mextern-sdata
20117 @itemx -mno-extern-sdata
20118 @opindex mextern-sdata
20119 @opindex mno-extern-sdata
20120 Assume (do not assume) that externally-defined data is in
20121 a small data section if the size of that data is within the @option{-G} limit.
20122 @option{-mextern-sdata} is the default for all configurations.
20124 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
20125 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
20126 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
20127 is placed in a small data section.  If @var{Var} is defined by another
20128 module, you must either compile that module with a high-enough
20129 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
20130 definition.  If @var{Var} is common, you must link the application
20131 with a high-enough @option{-G} setting.
20133 The easiest way of satisfying these restrictions is to compile
20134 and link every module with the same @option{-G} option.  However,
20135 you may wish to build a library that supports several different
20136 small data limits.  You can do this by compiling the library with
20137 the highest supported @option{-G} setting and additionally using
20138 @option{-mno-extern-sdata} to stop the library from making assumptions
20139 about externally-defined data.
20141 @item -mgpopt
20142 @itemx -mno-gpopt
20143 @opindex mgpopt
20144 @opindex mno-gpopt
20145 Use (do not use) GP-relative accesses for symbols that are known to be
20146 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
20147 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
20148 configurations.
20150 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
20151 might not hold the value of @code{_gp}.  For example, if the code is
20152 part of a library that might be used in a boot monitor, programs that
20153 call boot monitor routines pass an unknown value in @code{$gp}.
20154 (In such situations, the boot monitor itself is usually compiled
20155 with @option{-G0}.)
20157 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
20158 @option{-mno-extern-sdata}.
20160 @item -membedded-data
20161 @itemx -mno-embedded-data
20162 @opindex membedded-data
20163 @opindex mno-embedded-data
20164 Allocate variables to the read-only data section first if possible, then
20165 next in the small data section if possible, otherwise in data.  This gives
20166 slightly slower code than the default, but reduces the amount of RAM required
20167 when executing, and thus may be preferred for some embedded systems.
20169 @item -muninit-const-in-rodata
20170 @itemx -mno-uninit-const-in-rodata
20171 @opindex muninit-const-in-rodata
20172 @opindex mno-uninit-const-in-rodata
20173 Put uninitialized @code{const} variables in the read-only data section.
20174 This option is only meaningful in conjunction with @option{-membedded-data}.
20176 @item -mcode-readable=@var{setting}
20177 @opindex mcode-readable
20178 Specify whether GCC may generate code that reads from executable sections.
20179 There are three possible settings:
20181 @table @gcctabopt
20182 @item -mcode-readable=yes
20183 Instructions may freely access executable sections.  This is the
20184 default setting.
20186 @item -mcode-readable=pcrel
20187 MIPS16 PC-relative load instructions can access executable sections,
20188 but other instructions must not do so.  This option is useful on 4KSc
20189 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
20190 It is also useful on processors that can be configured to have a dual
20191 instruction/data SRAM interface and that, like the M4K, automatically
20192 redirect PC-relative loads to the instruction RAM.
20194 @item -mcode-readable=no
20195 Instructions must not access executable sections.  This option can be
20196 useful on targets that are configured to have a dual instruction/data
20197 SRAM interface but that (unlike the M4K) do not automatically redirect
20198 PC-relative loads to the instruction RAM.
20199 @end table
20201 @item -msplit-addresses
20202 @itemx -mno-split-addresses
20203 @opindex msplit-addresses
20204 @opindex mno-split-addresses
20205 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
20206 relocation operators.  This option has been superseded by
20207 @option{-mexplicit-relocs} but is retained for backwards compatibility.
20209 @item -mexplicit-relocs
20210 @itemx -mno-explicit-relocs
20211 @opindex mexplicit-relocs
20212 @opindex mno-explicit-relocs
20213 Use (do not use) assembler relocation operators when dealing with symbolic
20214 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
20215 is to use assembler macros instead.
20217 @option{-mexplicit-relocs} is the default if GCC was configured
20218 to use an assembler that supports relocation operators.
20220 @item -mcheck-zero-division
20221 @itemx -mno-check-zero-division
20222 @opindex mcheck-zero-division
20223 @opindex mno-check-zero-division
20224 Trap (do not trap) on integer division by zero.
20226 The default is @option{-mcheck-zero-division}.
20228 @item -mdivide-traps
20229 @itemx -mdivide-breaks
20230 @opindex mdivide-traps
20231 @opindex mdivide-breaks
20232 MIPS systems check for division by zero by generating either a
20233 conditional trap or a break instruction.  Using traps results in
20234 smaller code, but is only supported on MIPS II and later.  Also, some
20235 versions of the Linux kernel have a bug that prevents trap from
20236 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
20237 allow conditional traps on architectures that support them and
20238 @option{-mdivide-breaks} to force the use of breaks.
20240 The default is usually @option{-mdivide-traps}, but this can be
20241 overridden at configure time using @option{--with-divide=breaks}.
20242 Divide-by-zero checks can be completely disabled using
20243 @option{-mno-check-zero-division}.
20245 @item -mload-store-pairs
20246 @itemx -mno-load-store-pairs
20247 @opindex mload-store-pairs
20248 @opindex mno-load-store-pairs
20249 Enable (disable) an optimization that pairs consecutive load or store
20250 instructions to enable load/store bonding.  This option is enabled by
20251 default but only takes effect when the selected architecture is known
20252 to support bonding.
20254 @item -mmemcpy
20255 @itemx -mno-memcpy
20256 @opindex mmemcpy
20257 @opindex mno-memcpy
20258 Force (do not force) the use of @code{memcpy} for non-trivial block
20259 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
20260 most constant-sized copies.
20262 @item -mlong-calls
20263 @itemx -mno-long-calls
20264 @opindex mlong-calls
20265 @opindex mno-long-calls
20266 Disable (do not disable) use of the @code{jal} instruction.  Calling
20267 functions using @code{jal} is more efficient but requires the caller
20268 and callee to be in the same 256 megabyte segment.
20270 This option has no effect on abicalls code.  The default is
20271 @option{-mno-long-calls}.
20273 @item -mmad
20274 @itemx -mno-mad
20275 @opindex mmad
20276 @opindex mno-mad
20277 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
20278 instructions, as provided by the R4650 ISA@.
20280 @item -mimadd
20281 @itemx -mno-imadd
20282 @opindex mimadd
20283 @opindex mno-imadd
20284 Enable (disable) use of the @code{madd} and @code{msub} integer
20285 instructions.  The default is @option{-mimadd} on architectures
20286 that support @code{madd} and @code{msub} except for the 74k 
20287 architecture where it was found to generate slower code.
20289 @item -mfused-madd
20290 @itemx -mno-fused-madd
20291 @opindex mfused-madd
20292 @opindex mno-fused-madd
20293 Enable (disable) use of the floating-point multiply-accumulate
20294 instructions, when they are available.  The default is
20295 @option{-mfused-madd}.
20297 On the R8000 CPU when multiply-accumulate instructions are used,
20298 the intermediate product is calculated to infinite precision
20299 and is not subject to the FCSR Flush to Zero bit.  This may be
20300 undesirable in some circumstances.  On other processors the result
20301 is numerically identical to the equivalent computation using
20302 separate multiply, add, subtract and negate instructions.
20304 @item -nocpp
20305 @opindex nocpp
20306 Tell the MIPS assembler to not run its preprocessor over user
20307 assembler files (with a @samp{.s} suffix) when assembling them.
20309 @item -mfix-24k
20310 @item -mno-fix-24k
20311 @opindex mfix-24k
20312 @opindex mno-fix-24k
20313 Work around the 24K E48 (lost data on stores during refill) errata.
20314 The workarounds are implemented by the assembler rather than by GCC@.
20316 @item -mfix-r4000
20317 @itemx -mno-fix-r4000
20318 @opindex mfix-r4000
20319 @opindex mno-fix-r4000
20320 Work around certain R4000 CPU errata:
20321 @itemize @minus
20322 @item
20323 A double-word or a variable shift may give an incorrect result if executed
20324 immediately after starting an integer division.
20325 @item
20326 A double-word or a variable shift may give an incorrect result if executed
20327 while an integer multiplication is in progress.
20328 @item
20329 An integer division may give an incorrect result if started in a delay slot
20330 of a taken branch or a jump.
20331 @end itemize
20333 @item -mfix-r4400
20334 @itemx -mno-fix-r4400
20335 @opindex mfix-r4400
20336 @opindex mno-fix-r4400
20337 Work around certain R4400 CPU errata:
20338 @itemize @minus
20339 @item
20340 A double-word or a variable shift may give an incorrect result if executed
20341 immediately after starting an integer division.
20342 @end itemize
20344 @item -mfix-r10000
20345 @itemx -mno-fix-r10000
20346 @opindex mfix-r10000
20347 @opindex mno-fix-r10000
20348 Work around certain R10000 errata:
20349 @itemize @minus
20350 @item
20351 @code{ll}/@code{sc} sequences may not behave atomically on revisions
20352 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
20353 @end itemize
20355 This option can only be used if the target architecture supports
20356 branch-likely instructions.  @option{-mfix-r10000} is the default when
20357 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
20358 otherwise.
20360 @item -mfix-rm7000
20361 @itemx -mno-fix-rm7000
20362 @opindex mfix-rm7000
20363 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
20364 workarounds are implemented by the assembler rather than by GCC@.
20366 @item -mfix-vr4120
20367 @itemx -mno-fix-vr4120
20368 @opindex mfix-vr4120
20369 Work around certain VR4120 errata:
20370 @itemize @minus
20371 @item
20372 @code{dmultu} does not always produce the correct result.
20373 @item
20374 @code{div} and @code{ddiv} do not always produce the correct result if one
20375 of the operands is negative.
20376 @end itemize
20377 The workarounds for the division errata rely on special functions in
20378 @file{libgcc.a}.  At present, these functions are only provided by
20379 the @code{mips64vr*-elf} configurations.
20381 Other VR4120 errata require a NOP to be inserted between certain pairs of
20382 instructions.  These errata are handled by the assembler, not by GCC itself.
20384 @item -mfix-vr4130
20385 @opindex mfix-vr4130
20386 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
20387 workarounds are implemented by the assembler rather than by GCC,
20388 although GCC avoids using @code{mflo} and @code{mfhi} if the
20389 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
20390 instructions are available instead.
20392 @item -mfix-sb1
20393 @itemx -mno-fix-sb1
20394 @opindex mfix-sb1
20395 Work around certain SB-1 CPU core errata.
20396 (This flag currently works around the SB-1 revision 2
20397 ``F1'' and ``F2'' floating-point errata.)
20399 @item -mr10k-cache-barrier=@var{setting}
20400 @opindex mr10k-cache-barrier
20401 Specify whether GCC should insert cache barriers to avoid the
20402 side-effects of speculation on R10K processors.
20404 In common with many processors, the R10K tries to predict the outcome
20405 of a conditional branch and speculatively executes instructions from
20406 the ``taken'' branch.  It later aborts these instructions if the
20407 predicted outcome is wrong.  However, on the R10K, even aborted
20408 instructions can have side effects.
20410 This problem only affects kernel stores and, depending on the system,
20411 kernel loads.  As an example, a speculatively-executed store may load
20412 the target memory into cache and mark the cache line as dirty, even if
20413 the store itself is later aborted.  If a DMA operation writes to the
20414 same area of memory before the ``dirty'' line is flushed, the cached
20415 data overwrites the DMA-ed data.  See the R10K processor manual
20416 for a full description, including other potential problems.
20418 One workaround is to insert cache barrier instructions before every memory
20419 access that might be speculatively executed and that might have side
20420 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
20421 controls GCC's implementation of this workaround.  It assumes that
20422 aborted accesses to any byte in the following regions does not have
20423 side effects:
20425 @enumerate
20426 @item
20427 the memory occupied by the current function's stack frame;
20429 @item
20430 the memory occupied by an incoming stack argument;
20432 @item
20433 the memory occupied by an object with a link-time-constant address.
20434 @end enumerate
20436 It is the kernel's responsibility to ensure that speculative
20437 accesses to these regions are indeed safe.
20439 If the input program contains a function declaration such as:
20441 @smallexample
20442 void foo (void);
20443 @end smallexample
20445 then the implementation of @code{foo} must allow @code{j foo} and
20446 @code{jal foo} to be executed speculatively.  GCC honors this
20447 restriction for functions it compiles itself.  It expects non-GCC
20448 functions (such as hand-written assembly code) to do the same.
20450 The option has three forms:
20452 @table @gcctabopt
20453 @item -mr10k-cache-barrier=load-store
20454 Insert a cache barrier before a load or store that might be
20455 speculatively executed and that might have side effects even
20456 if aborted.
20458 @item -mr10k-cache-barrier=store
20459 Insert a cache barrier before a store that might be speculatively
20460 executed and that might have side effects even if aborted.
20462 @item -mr10k-cache-barrier=none
20463 Disable the insertion of cache barriers.  This is the default setting.
20464 @end table
20466 @item -mflush-func=@var{func}
20467 @itemx -mno-flush-func
20468 @opindex mflush-func
20469 Specifies the function to call to flush the I and D caches, or to not
20470 call any such function.  If called, the function must take the same
20471 arguments as the common @code{_flush_func}, that is, the address of the
20472 memory range for which the cache is being flushed, the size of the
20473 memory range, and the number 3 (to flush both caches).  The default
20474 depends on the target GCC was configured for, but commonly is either
20475 @code{_flush_func} or @code{__cpu_flush}.
20477 @item mbranch-cost=@var{num}
20478 @opindex mbranch-cost
20479 Set the cost of branches to roughly @var{num} ``simple'' instructions.
20480 This cost is only a heuristic and is not guaranteed to produce
20481 consistent results across releases.  A zero cost redundantly selects
20482 the default, which is based on the @option{-mtune} setting.
20484 @item -mbranch-likely
20485 @itemx -mno-branch-likely
20486 @opindex mbranch-likely
20487 @opindex mno-branch-likely
20488 Enable or disable use of Branch Likely instructions, regardless of the
20489 default for the selected architecture.  By default, Branch Likely
20490 instructions may be generated if they are supported by the selected
20491 architecture.  An exception is for the MIPS32 and MIPS64 architectures
20492 and processors that implement those architectures; for those, Branch
20493 Likely instructions are not be generated by default because the MIPS32
20494 and MIPS64 architectures specifically deprecate their use.
20496 @item -mcompact-branches=never
20497 @itemx -mcompact-branches=optimal
20498 @itemx -mcompact-branches=always
20499 @opindex mcompact-branches=never
20500 @opindex mcompact-branches=optimal
20501 @opindex mcompact-branches=always
20502 These options control which form of branches will be generated.  The
20503 default is @option{-mcompact-branches=optimal}.
20505 The @option{-mcompact-branches=never} option ensures that compact branch
20506 instructions will never be generated.
20508 The @option{-mcompact-branches=always} option ensures that a compact
20509 branch instruction will be generated if available.  If a compact branch
20510 instruction is not available, a delay slot form of the branch will be
20511 used instead.
20513 This option is supported from MIPS Release 6 onwards.
20515 The @option{-mcompact-branches=optimal} option will cause a delay slot
20516 branch to be used if one is available in the current ISA and the delay
20517 slot is successfully filled.  If the delay slot is not filled, a compact
20518 branch will be chosen if one is available.
20520 @item -mfp-exceptions
20521 @itemx -mno-fp-exceptions
20522 @opindex mfp-exceptions
20523 Specifies whether FP exceptions are enabled.  This affects how
20524 FP instructions are scheduled for some processors.
20525 The default is that FP exceptions are
20526 enabled.
20528 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
20529 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
20530 FP pipe.
20532 @item -mvr4130-align
20533 @itemx -mno-vr4130-align
20534 @opindex mvr4130-align
20535 The VR4130 pipeline is two-way superscalar, but can only issue two
20536 instructions together if the first one is 8-byte aligned.  When this
20537 option is enabled, GCC aligns pairs of instructions that it
20538 thinks should execute in parallel.
20540 This option only has an effect when optimizing for the VR4130.
20541 It normally makes code faster, but at the expense of making it bigger.
20542 It is enabled by default at optimization level @option{-O3}.
20544 @item -msynci
20545 @itemx -mno-synci
20546 @opindex msynci
20547 Enable (disable) generation of @code{synci} instructions on
20548 architectures that support it.  The @code{synci} instructions (if
20549 enabled) are generated when @code{__builtin___clear_cache} is
20550 compiled.
20552 This option defaults to @option{-mno-synci}, but the default can be
20553 overridden by configuring GCC with @option{--with-synci}.
20555 When compiling code for single processor systems, it is generally safe
20556 to use @code{synci}.  However, on many multi-core (SMP) systems, it
20557 does not invalidate the instruction caches on all cores and may lead
20558 to undefined behavior.
20560 @item -mrelax-pic-calls
20561 @itemx -mno-relax-pic-calls
20562 @opindex mrelax-pic-calls
20563 Try to turn PIC calls that are normally dispatched via register
20564 @code{$25} into direct calls.  This is only possible if the linker can
20565 resolve the destination at link time and if the destination is within
20566 range for a direct call.
20568 @option{-mrelax-pic-calls} is the default if GCC was configured to use
20569 an assembler and a linker that support the @code{.reloc} assembly
20570 directive and @option{-mexplicit-relocs} is in effect.  With
20571 @option{-mno-explicit-relocs}, this optimization can be performed by the
20572 assembler and the linker alone without help from the compiler.
20574 @item -mmcount-ra-address
20575 @itemx -mno-mcount-ra-address
20576 @opindex mmcount-ra-address
20577 @opindex mno-mcount-ra-address
20578 Emit (do not emit) code that allows @code{_mcount} to modify the
20579 calling function's return address.  When enabled, this option extends
20580 the usual @code{_mcount} interface with a new @var{ra-address}
20581 parameter, which has type @code{intptr_t *} and is passed in register
20582 @code{$12}.  @code{_mcount} can then modify the return address by
20583 doing both of the following:
20584 @itemize
20585 @item
20586 Returning the new address in register @code{$31}.
20587 @item
20588 Storing the new address in @code{*@var{ra-address}},
20589 if @var{ra-address} is nonnull.
20590 @end itemize
20592 The default is @option{-mno-mcount-ra-address}.
20594 @item -mframe-header-opt
20595 @itemx -mno-frame-header-opt
20596 @opindex mframe-header-opt
20597 Enable (disable) frame header optimization in the o32 ABI.  When using the
20598 o32 ABI, calling functions will allocate 16 bytes on the stack for the called
20599 function to write out register arguments.  When enabled, this optimization
20600 will suppress the allocation of the frame header if it can be determined that
20601 it is unused.
20603 This optimization is off by default at all optimization levels.
20605 @item -mlxc1-sxc1
20606 @itemx -mno-lxc1-sxc1
20607 @opindex mlxc1-sxc1
20608 When applicable, enable (disable) the generation of @code{lwxc1},
20609 @code{swxc1}, @code{ldxc1}, @code{sdxc1} instructions.  Enabled by default.
20611 @item -mmadd4
20612 @itemx -mno-madd4
20613 @opindex mmadd4
20614 When applicable, enable (disable) the generation of 4-operand @code{madd.s},
20615 @code{madd.d} and related instructions.  Enabled by default.
20617 @end table
20619 @node MMIX Options
20620 @subsection MMIX Options
20621 @cindex MMIX Options
20623 These options are defined for the MMIX:
20625 @table @gcctabopt
20626 @item -mlibfuncs
20627 @itemx -mno-libfuncs
20628 @opindex mlibfuncs
20629 @opindex mno-libfuncs
20630 Specify that intrinsic library functions are being compiled, passing all
20631 values in registers, no matter the size.
20633 @item -mepsilon
20634 @itemx -mno-epsilon
20635 @opindex mepsilon
20636 @opindex mno-epsilon
20637 Generate floating-point comparison instructions that compare with respect
20638 to the @code{rE} epsilon register.
20640 @item -mabi=mmixware
20641 @itemx -mabi=gnu
20642 @opindex mabi=mmixware
20643 @opindex mabi=gnu
20644 Generate code that passes function parameters and return values that (in
20645 the called function) are seen as registers @code{$0} and up, as opposed to
20646 the GNU ABI which uses global registers @code{$231} and up.
20648 @item -mzero-extend
20649 @itemx -mno-zero-extend
20650 @opindex mzero-extend
20651 @opindex mno-zero-extend
20652 When reading data from memory in sizes shorter than 64 bits, use (do not
20653 use) zero-extending load instructions by default, rather than
20654 sign-extending ones.
20656 @item -mknuthdiv
20657 @itemx -mno-knuthdiv
20658 @opindex mknuthdiv
20659 @opindex mno-knuthdiv
20660 Make the result of a division yielding a remainder have the same sign as
20661 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
20662 remainder follows the sign of the dividend.  Both methods are
20663 arithmetically valid, the latter being almost exclusively used.
20665 @item -mtoplevel-symbols
20666 @itemx -mno-toplevel-symbols
20667 @opindex mtoplevel-symbols
20668 @opindex mno-toplevel-symbols
20669 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
20670 code can be used with the @code{PREFIX} assembly directive.
20672 @item -melf
20673 @opindex melf
20674 Generate an executable in the ELF format, rather than the default
20675 @samp{mmo} format used by the @command{mmix} simulator.
20677 @item -mbranch-predict
20678 @itemx -mno-branch-predict
20679 @opindex mbranch-predict
20680 @opindex mno-branch-predict
20681 Use (do not use) the probable-branch instructions, when static branch
20682 prediction indicates a probable branch.
20684 @item -mbase-addresses
20685 @itemx -mno-base-addresses
20686 @opindex mbase-addresses
20687 @opindex mno-base-addresses
20688 Generate (do not generate) code that uses @emph{base addresses}.  Using a
20689 base address automatically generates a request (handled by the assembler
20690 and the linker) for a constant to be set up in a global register.  The
20691 register is used for one or more base address requests within the range 0
20692 to 255 from the value held in the register.  The generally leads to short
20693 and fast code, but the number of different data items that can be
20694 addressed is limited.  This means that a program that uses lots of static
20695 data may require @option{-mno-base-addresses}.
20697 @item -msingle-exit
20698 @itemx -mno-single-exit
20699 @opindex msingle-exit
20700 @opindex mno-single-exit
20701 Force (do not force) generated code to have a single exit point in each
20702 function.
20703 @end table
20705 @node MN10300 Options
20706 @subsection MN10300 Options
20707 @cindex MN10300 options
20709 These @option{-m} options are defined for Matsushita MN10300 architectures:
20711 @table @gcctabopt
20712 @item -mmult-bug
20713 @opindex mmult-bug
20714 Generate code to avoid bugs in the multiply instructions for the MN10300
20715 processors.  This is the default.
20717 @item -mno-mult-bug
20718 @opindex mno-mult-bug
20719 Do not generate code to avoid bugs in the multiply instructions for the
20720 MN10300 processors.
20722 @item -mam33
20723 @opindex mam33
20724 Generate code using features specific to the AM33 processor.
20726 @item -mno-am33
20727 @opindex mno-am33
20728 Do not generate code using features specific to the AM33 processor.  This
20729 is the default.
20731 @item -mam33-2
20732 @opindex mam33-2
20733 Generate code using features specific to the AM33/2.0 processor.
20735 @item -mam34
20736 @opindex mam34
20737 Generate code using features specific to the AM34 processor.
20739 @item -mtune=@var{cpu-type}
20740 @opindex mtune
20741 Use the timing characteristics of the indicated CPU type when
20742 scheduling instructions.  This does not change the targeted processor
20743 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
20744 @samp{am33-2} or @samp{am34}.
20746 @item -mreturn-pointer-on-d0
20747 @opindex mreturn-pointer-on-d0
20748 When generating a function that returns a pointer, return the pointer
20749 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
20750 only in @code{a0}, and attempts to call such functions without a prototype
20751 result in errors.  Note that this option is on by default; use
20752 @option{-mno-return-pointer-on-d0} to disable it.
20754 @item -mno-crt0
20755 @opindex mno-crt0
20756 Do not link in the C run-time initialization object file.
20758 @item -mrelax
20759 @opindex mrelax
20760 Indicate to the linker that it should perform a relaxation optimization pass
20761 to shorten branches, calls and absolute memory addresses.  This option only
20762 has an effect when used on the command line for the final link step.
20764 This option makes symbolic debugging impossible.
20766 @item -mliw
20767 @opindex mliw
20768 Allow the compiler to generate @emph{Long Instruction Word}
20769 instructions if the target is the @samp{AM33} or later.  This is the
20770 default.  This option defines the preprocessor macro @code{__LIW__}.
20772 @item -mnoliw
20773 @opindex mnoliw
20774 Do not allow the compiler to generate @emph{Long Instruction Word}
20775 instructions.  This option defines the preprocessor macro
20776 @code{__NO_LIW__}.
20778 @item -msetlb
20779 @opindex msetlb
20780 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
20781 instructions if the target is the @samp{AM33} or later.  This is the
20782 default.  This option defines the preprocessor macro @code{__SETLB__}.
20784 @item -mnosetlb
20785 @opindex mnosetlb
20786 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
20787 instructions.  This option defines the preprocessor macro
20788 @code{__NO_SETLB__}.
20790 @end table
20792 @node Moxie Options
20793 @subsection Moxie Options
20794 @cindex Moxie Options
20796 @table @gcctabopt
20798 @item -meb
20799 @opindex meb
20800 Generate big-endian code.  This is the default for @samp{moxie-*-*}
20801 configurations.
20803 @item -mel
20804 @opindex mel
20805 Generate little-endian code.
20807 @item -mmul.x
20808 @opindex mmul.x
20809 Generate mul.x and umul.x instructions.  This is the default for
20810 @samp{moxiebox-*-*} configurations.
20812 @item -mno-crt0
20813 @opindex mno-crt0
20814 Do not link in the C run-time initialization object file.
20816 @end table
20818 @node MSP430 Options
20819 @subsection MSP430 Options
20820 @cindex MSP430 Options
20822 These options are defined for the MSP430:
20824 @table @gcctabopt
20826 @item -masm-hex
20827 @opindex masm-hex
20828 Force assembly output to always use hex constants.  Normally such
20829 constants are signed decimals, but this option is available for
20830 testsuite and/or aesthetic purposes.
20832 @item -mmcu=
20833 @opindex mmcu=
20834 Select the MCU to target.  This is used to create a C preprocessor
20835 symbol based upon the MCU name, converted to upper case and pre- and
20836 post-fixed with @samp{__}.  This in turn is used by the
20837 @file{msp430.h} header file to select an MCU-specific supplementary
20838 header file.
20840 The option also sets the ISA to use.  If the MCU name is one that is
20841 known to only support the 430 ISA then that is selected, otherwise the
20842 430X ISA is selected.  A generic MCU name of @samp{msp430} can also be
20843 used to select the 430 ISA.  Similarly the generic @samp{msp430x} MCU
20844 name selects the 430X ISA.
20846 In addition an MCU-specific linker script is added to the linker
20847 command line.  The script's name is the name of the MCU with
20848 @file{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the @command{gcc}
20849 command line defines the C preprocessor symbol @code{__XXX__} and
20850 cause the linker to search for a script called @file{xxx.ld}.
20852 This option is also passed on to the assembler.
20854 @item -mwarn-mcu
20855 @itemx -mno-warn-mcu
20856 @opindex mwarn-mcu
20857 @opindex mno-warn-mcu
20858 This option enables or disables warnings about conflicts between the
20859 MCU name specified by the @option{-mmcu} option and the ISA set by the
20860 @option{-mcpu} option and/or the hardware multiply support set by the
20861 @option{-mhwmult} option.  It also toggles warnings about unrecognized
20862 MCU names.  This option is on by default.
20864 @item -mcpu=
20865 @opindex mcpu=
20866 Specifies the ISA to use.  Accepted values are @samp{msp430},
20867 @samp{msp430x} and @samp{msp430xv2}.  This option is deprecated.  The
20868 @option{-mmcu=} option should be used to select the ISA.
20870 @item -msim
20871 @opindex msim
20872 Link to the simulator runtime libraries and linker script.  Overrides
20873 any scripts that would be selected by the @option{-mmcu=} option.
20875 @item -mlarge
20876 @opindex mlarge
20877 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
20879 @item -msmall
20880 @opindex msmall
20881 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
20883 @item -mrelax
20884 @opindex mrelax
20885 This option is passed to the assembler and linker, and allows the
20886 linker to perform certain optimizations that cannot be done until
20887 the final link.
20889 @item mhwmult=
20890 @opindex mhwmult=
20891 Describes the type of hardware multiply supported by the target.
20892 Accepted values are @samp{none} for no hardware multiply, @samp{16bit}
20893 for the original 16-bit-only multiply supported by early MCUs.
20894 @samp{32bit} for the 16/32-bit multiply supported by later MCUs and
20895 @samp{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
20896 A value of @samp{auto} can also be given.  This tells GCC to deduce
20897 the hardware multiply support based upon the MCU name provided by the
20898 @option{-mmcu} option.  If no @option{-mmcu} option is specified or if
20899 the MCU name is not recognized then no hardware multiply support is
20900 assumed.  @code{auto} is the default setting.
20902 Hardware multiplies are normally performed by calling a library
20903 routine.  This saves space in the generated code.  When compiling at
20904 @option{-O3} or higher however the hardware multiplier is invoked
20905 inline.  This makes for bigger, but faster code.
20907 The hardware multiply routines disable interrupts whilst running and
20908 restore the previous interrupt state when they finish.  This makes
20909 them safe to use inside interrupt handlers as well as in normal code.
20911 @item -minrt
20912 @opindex minrt
20913 Enable the use of a minimum runtime environment - no static
20914 initializers or constructors.  This is intended for memory-constrained
20915 devices.  The compiler includes special symbols in some objects
20916 that tell the linker and runtime which code fragments are required.
20918 @item -mcode-region=
20919 @itemx -mdata-region=
20920 @opindex mcode-region
20921 @opindex mdata-region
20922 These options tell the compiler where to place functions and data that
20923 do not have one of the @code{lower}, @code{upper}, @code{either} or
20924 @code{section} attributes.  Possible values are @code{lower},
20925 @code{upper}, @code{either} or @code{any}.  The first three behave
20926 like the corresponding attribute.  The fourth possible value -
20927 @code{any} - is the default.  It leaves placement entirely up to the
20928 linker script and how it assigns the standard sections
20929 (@code{.text}, @code{.data}, etc) to the memory regions.
20931 @item -msilicon-errata=
20932 @opindex msilicon-errata
20933 This option passes on a request to assembler to enable the fixes for
20934 the named silicon errata.
20936 @item -msilicon-errata-warn=
20937 @opindex msilicon-errata-warn
20938 This option passes on a request to the assembler to enable warning
20939 messages when a silicon errata might need to be applied.
20941 @end table
20943 @node NDS32 Options
20944 @subsection NDS32 Options
20945 @cindex NDS32 Options
20947 These options are defined for NDS32 implementations:
20949 @table @gcctabopt
20951 @item -mbig-endian
20952 @opindex mbig-endian
20953 Generate code in big-endian mode.
20955 @item -mlittle-endian
20956 @opindex mlittle-endian
20957 Generate code in little-endian mode.
20959 @item -mreduced-regs
20960 @opindex mreduced-regs
20961 Use reduced-set registers for register allocation.
20963 @item -mfull-regs
20964 @opindex mfull-regs
20965 Use full-set registers for register allocation.
20967 @item -mcmov
20968 @opindex mcmov
20969 Generate conditional move instructions.
20971 @item -mno-cmov
20972 @opindex mno-cmov
20973 Do not generate conditional move instructions.
20975 @item -mperf-ext
20976 @opindex mperf-ext
20977 Generate performance extension instructions.
20979 @item -mno-perf-ext
20980 @opindex mno-perf-ext
20981 Do not generate performance extension instructions.
20983 @item -mv3push
20984 @opindex mv3push
20985 Generate v3 push25/pop25 instructions.
20987 @item -mno-v3push
20988 @opindex mno-v3push
20989 Do not generate v3 push25/pop25 instructions.
20991 @item -m16-bit
20992 @opindex m16-bit
20993 Generate 16-bit instructions.
20995 @item -mno-16-bit
20996 @opindex mno-16-bit
20997 Do not generate 16-bit instructions.
20999 @item -misr-vector-size=@var{num}
21000 @opindex misr-vector-size
21001 Specify the size of each interrupt vector, which must be 4 or 16.
21003 @item -mcache-block-size=@var{num}
21004 @opindex mcache-block-size
21005 Specify the size of each cache block,
21006 which must be a power of 2 between 4 and 512.
21008 @item -march=@var{arch}
21009 @opindex march
21010 Specify the name of the target architecture.
21012 @item -mcmodel=@var{code-model}
21013 @opindex mcmodel
21014 Set the code model to one of
21015 @table @asis
21016 @item @samp{small}
21017 All the data and read-only data segments must be within 512KB addressing space.
21018 The text segment must be within 16MB addressing space.
21019 @item @samp{medium}
21020 The data segment must be within 512KB while the read-only data segment can be
21021 within 4GB addressing space.  The text segment should be still within 16MB
21022 addressing space.
21023 @item @samp{large}
21024 All the text and data segments can be within 4GB addressing space.
21025 @end table
21027 @item -mctor-dtor
21028 @opindex mctor-dtor
21029 Enable constructor/destructor feature.
21031 @item -mrelax
21032 @opindex mrelax
21033 Guide linker to relax instructions.
21035 @end table
21037 @node Nios II Options
21038 @subsection Nios II Options
21039 @cindex Nios II options
21040 @cindex Altera Nios II options
21042 These are the options defined for the Altera Nios II processor.
21044 @table @gcctabopt
21046 @item -G @var{num}
21047 @opindex G
21048 @cindex smaller data references
21049 Put global and static objects less than or equal to @var{num} bytes
21050 into the small data or BSS sections instead of the normal data or BSS
21051 sections.  The default value of @var{num} is 8.
21053 @item -mgpopt=@var{option}
21054 @item -mgpopt
21055 @itemx -mno-gpopt
21056 @opindex mgpopt
21057 @opindex mno-gpopt
21058 Generate (do not generate) GP-relative accesses.  The following 
21059 @var{option} names are recognized:
21061 @table @samp
21063 @item none
21064 Do not generate GP-relative accesses.
21066 @item local
21067 Generate GP-relative accesses for small data objects that are not 
21068 external, weak, or uninitialized common symbols.  
21069 Also use GP-relative addressing for objects that
21070 have been explicitly placed in a small data section via a @code{section}
21071 attribute.
21073 @item global
21074 As for @samp{local}, but also generate GP-relative accesses for
21075 small data objects that are external, weak, or common.  If you use this option,
21076 you must ensure that all parts of your program (including libraries) are
21077 compiled with the same @option{-G} setting.
21079 @item data
21080 Generate GP-relative accesses for all data objects in the program.  If you
21081 use this option, the entire data and BSS segments
21082 of your program must fit in 64K of memory and you must use an appropriate
21083 linker script to allocate them within the addressable range of the
21084 global pointer.
21086 @item all
21087 Generate GP-relative addresses for function pointers as well as data
21088 pointers.  If you use this option, the entire text, data, and BSS segments
21089 of your program must fit in 64K of memory and you must use an appropriate
21090 linker script to allocate them within the addressable range of the
21091 global pointer.
21093 @end table
21095 @option{-mgpopt} is equivalent to @option{-mgpopt=local}, and
21096 @option{-mno-gpopt} is equivalent to @option{-mgpopt=none}.
21098 The default is @option{-mgpopt} except when @option{-fpic} or
21099 @option{-fPIC} is specified to generate position-independent code.
21100 Note that the Nios II ABI does not permit GP-relative accesses from
21101 shared libraries.
21103 You may need to specify @option{-mno-gpopt} explicitly when building
21104 programs that include large amounts of small data, including large
21105 GOT data sections.  In this case, the 16-bit offset for GP-relative
21106 addressing may not be large enough to allow access to the entire 
21107 small data section.
21109 @item -mel
21110 @itemx -meb
21111 @opindex mel
21112 @opindex meb
21113 Generate little-endian (default) or big-endian (experimental) code,
21114 respectively.
21116 @item -march=@var{arch}
21117 @opindex march
21118 This specifies the name of the target Nios II architecture.  GCC uses this
21119 name to determine what kind of instructions it can emit when generating
21120 assembly code.  Permissible names are: @samp{r1}, @samp{r2}.
21122 The preprocessor macro @code{__nios2_arch__} is available to programs,
21123 with value 1 or 2, indicating the targeted ISA level.
21125 @item -mbypass-cache
21126 @itemx -mno-bypass-cache
21127 @opindex mno-bypass-cache
21128 @opindex mbypass-cache
21129 Force all load and store instructions to always bypass cache by 
21130 using I/O variants of the instructions. The default is not to
21131 bypass the cache.
21133 @item -mno-cache-volatile 
21134 @itemx -mcache-volatile       
21135 @opindex mcache-volatile 
21136 @opindex mno-cache-volatile
21137 Volatile memory access bypass the cache using the I/O variants of 
21138 the load and store instructions. The default is not to bypass the cache.
21140 @item -mno-fast-sw-div
21141 @itemx -mfast-sw-div
21142 @opindex mno-fast-sw-div
21143 @opindex mfast-sw-div
21144 Do not use table-based fast divide for small numbers. The default 
21145 is to use the fast divide at @option{-O3} and above.
21147 @item -mno-hw-mul
21148 @itemx -mhw-mul
21149 @itemx -mno-hw-mulx
21150 @itemx -mhw-mulx
21151 @itemx -mno-hw-div
21152 @itemx -mhw-div
21153 @opindex mno-hw-mul
21154 @opindex mhw-mul
21155 @opindex mno-hw-mulx
21156 @opindex mhw-mulx
21157 @opindex mno-hw-div
21158 @opindex mhw-div
21159 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
21160 instructions by the compiler. The default is to emit @code{mul}
21161 and not emit @code{div} and @code{mulx}.
21163 @item -mbmx
21164 @itemx -mno-bmx
21165 @itemx -mcdx
21166 @itemx -mno-cdx
21167 Enable or disable generation of Nios II R2 BMX (bit manipulation) and
21168 CDX (code density) instructions.  Enabling these instructions also
21169 requires @option{-march=r2}.  Since these instructions are optional
21170 extensions to the R2 architecture, the default is not to emit them.
21172 @item -mcustom-@var{insn}=@var{N}
21173 @itemx -mno-custom-@var{insn}
21174 @opindex mcustom-@var{insn}
21175 @opindex mno-custom-@var{insn}
21176 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
21177 custom instruction with encoding @var{N} when generating code that uses 
21178 @var{insn}.  For example, @option{-mcustom-fadds=253} generates custom
21179 instruction 253 for single-precision floating-point add operations instead
21180 of the default behavior of using a library call.
21182 The following values of @var{insn} are supported.  Except as otherwise
21183 noted, floating-point operations are expected to be implemented with
21184 normal IEEE 754 semantics and correspond directly to the C operators or the
21185 equivalent GCC built-in functions (@pxref{Other Builtins}).
21187 Single-precision floating point:
21188 @table @asis
21190 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
21191 Binary arithmetic operations.
21193 @item @samp{fnegs}
21194 Unary negation.
21196 @item @samp{fabss}
21197 Unary absolute value.
21199 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
21200 Comparison operations.
21202 @item @samp{fmins}, @samp{fmaxs}
21203 Floating-point minimum and maximum.  These instructions are only
21204 generated if @option{-ffinite-math-only} is specified.
21206 @item @samp{fsqrts}
21207 Unary square root operation.
21209 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
21210 Floating-point trigonometric and exponential functions.  These instructions
21211 are only generated if @option{-funsafe-math-optimizations} is also specified.
21213 @end table
21215 Double-precision floating point:
21216 @table @asis
21218 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
21219 Binary arithmetic operations.
21221 @item @samp{fnegd}
21222 Unary negation.
21224 @item @samp{fabsd}
21225 Unary absolute value.
21227 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
21228 Comparison operations.
21230 @item @samp{fmind}, @samp{fmaxd}
21231 Double-precision minimum and maximum.  These instructions are only
21232 generated if @option{-ffinite-math-only} is specified.
21234 @item @samp{fsqrtd}
21235 Unary square root operation.
21237 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
21238 Double-precision trigonometric and exponential functions.  These instructions
21239 are only generated if @option{-funsafe-math-optimizations} is also specified.
21241 @end table
21243 Conversions:
21244 @table @asis
21245 @item @samp{fextsd}
21246 Conversion from single precision to double precision.
21248 @item @samp{ftruncds}
21249 Conversion from double precision to single precision.
21251 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
21252 Conversion from floating point to signed or unsigned integer types, with
21253 truncation towards zero.
21255 @item @samp{round}
21256 Conversion from single-precision floating point to signed integer,
21257 rounding to the nearest integer and ties away from zero.
21258 This corresponds to the @code{__builtin_lroundf} function when
21259 @option{-fno-math-errno} is used.
21261 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
21262 Conversion from signed or unsigned integer types to floating-point types.
21264 @end table
21266 In addition, all of the following transfer instructions for internal
21267 registers X and Y must be provided to use any of the double-precision
21268 floating-point instructions.  Custom instructions taking two
21269 double-precision source operands expect the first operand in the
21270 64-bit register X.  The other operand (or only operand of a unary
21271 operation) is given to the custom arithmetic instruction with the
21272 least significant half in source register @var{src1} and the most
21273 significant half in @var{src2}.  A custom instruction that returns a
21274 double-precision result returns the most significant 32 bits in the
21275 destination register and the other half in 32-bit register Y.  
21276 GCC automatically generates the necessary code sequences to write
21277 register X and/or read register Y when double-precision floating-point
21278 instructions are used.
21280 @table @asis
21282 @item @samp{fwrx}
21283 Write @var{src1} into the least significant half of X and @var{src2} into
21284 the most significant half of X.
21286 @item @samp{fwry}
21287 Write @var{src1} into Y.
21289 @item @samp{frdxhi}, @samp{frdxlo}
21290 Read the most or least (respectively) significant half of X and store it in
21291 @var{dest}.
21293 @item @samp{frdy}
21294 Read the value of Y and store it into @var{dest}.
21295 @end table
21297 Note that you can gain more local control over generation of Nios II custom
21298 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
21299 and @code{target("no-custom-@var{insn}")} function attributes
21300 (@pxref{Function Attributes})
21301 or pragmas (@pxref{Function Specific Option Pragmas}).
21303 @item -mcustom-fpu-cfg=@var{name}
21304 @opindex mcustom-fpu-cfg
21306 This option enables a predefined, named set of custom instruction encodings
21307 (see @option{-mcustom-@var{insn}} above).  
21308 Currently, the following sets are defined:
21310 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
21311 @gccoptlist{-mcustom-fmuls=252 @gol
21312 -mcustom-fadds=253 @gol
21313 -mcustom-fsubs=254 @gol
21314 -fsingle-precision-constant}
21316 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
21317 @gccoptlist{-mcustom-fmuls=252 @gol
21318 -mcustom-fadds=253 @gol
21319 -mcustom-fsubs=254 @gol
21320 -mcustom-fdivs=255 @gol
21321 -fsingle-precision-constant}
21323 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
21324 @gccoptlist{-mcustom-floatus=243 @gol
21325 -mcustom-fixsi=244 @gol
21326 -mcustom-floatis=245 @gol
21327 -mcustom-fcmpgts=246 @gol
21328 -mcustom-fcmples=249 @gol
21329 -mcustom-fcmpeqs=250 @gol
21330 -mcustom-fcmpnes=251 @gol
21331 -mcustom-fmuls=252 @gol
21332 -mcustom-fadds=253 @gol
21333 -mcustom-fsubs=254 @gol
21334 -mcustom-fdivs=255 @gol
21335 -fsingle-precision-constant}
21337 Custom instruction assignments given by individual
21338 @option{-mcustom-@var{insn}=} options override those given by
21339 @option{-mcustom-fpu-cfg=}, regardless of the
21340 order of the options on the command line.
21342 Note that you can gain more local control over selection of a FPU
21343 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
21344 function attribute (@pxref{Function Attributes})
21345 or pragma (@pxref{Function Specific Option Pragmas}).
21347 @end table
21349 These additional @samp{-m} options are available for the Altera Nios II
21350 ELF (bare-metal) target:
21352 @table @gcctabopt
21354 @item -mhal
21355 @opindex mhal
21356 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
21357 startup and termination code, and is typically used in conjunction with
21358 @option{-msys-crt0=} to specify the location of the alternate startup code
21359 provided by the HAL BSP.
21361 @item -msmallc
21362 @opindex msmallc
21363 Link with a limited version of the C library, @option{-lsmallc}, rather than
21364 Newlib.
21366 @item -msys-crt0=@var{startfile}
21367 @opindex msys-crt0
21368 @var{startfile} is the file name of the startfile (crt0) to use 
21369 when linking.  This option is only useful in conjunction with @option{-mhal}.
21371 @item -msys-lib=@var{systemlib}
21372 @opindex msys-lib
21373 @var{systemlib} is the library name of the library that provides
21374 low-level system calls required by the C library,
21375 e.g. @code{read} and @code{write}.
21376 This option is typically used to link with a library provided by a HAL BSP.
21378 @end table
21380 @node Nvidia PTX Options
21381 @subsection Nvidia PTX Options
21382 @cindex Nvidia PTX options
21383 @cindex nvptx options
21385 These options are defined for Nvidia PTX:
21387 @table @gcctabopt
21389 @item -m32
21390 @itemx -m64
21391 @opindex m32
21392 @opindex m64
21393 Generate code for 32-bit or 64-bit ABI.
21395 @item -mmainkernel
21396 @opindex mmainkernel
21397 Link in code for a __main kernel.  This is for stand-alone instead of
21398 offloading execution.
21400 @item -moptimize
21401 @opindex moptimize
21402 Apply partitioned execution optimizations.  This is the default when any
21403 level of optimization is selected.
21405 @item -msoft-stack
21406 @opindex msoft-stack
21407 Generate code that does not use @code{.local} memory
21408 directly for stack storage. Instead, a per-warp stack pointer is
21409 maintained explicitly. This enables variable-length stack allocation (with
21410 variable-length arrays or @code{alloca}), and when global memory is used for
21411 underlying storage, makes it possible to access automatic variables from other
21412 threads, or with atomic instructions. This code generation variant is used
21413 for OpenMP offloading, but the option is exposed on its own for the purpose
21414 of testing the compiler; to generate code suitable for linking into programs
21415 using OpenMP offloading, use option @option{-mgomp}.
21417 @item -muniform-simt
21418 @opindex muniform-simt
21419 Switch to code generation variant that allows to execute all threads in each
21420 warp, while maintaining memory state and side effects as if only one thread
21421 in each warp was active outside of OpenMP SIMD regions.  All atomic operations
21422 and calls to runtime (malloc, free, vprintf) are conditionally executed (iff
21423 current lane index equals the master lane index), and the register being
21424 assigned is copied via a shuffle instruction from the master lane.  Outside of
21425 SIMD regions lane 0 is the master; inside, each thread sees itself as the
21426 master.  Shared memory array @code{int __nvptx_uni[]} stores all-zeros or
21427 all-ones bitmasks for each warp, indicating current mode (0 outside of SIMD
21428 regions).  Each thread can bitwise-and the bitmask at position @code{tid.y}
21429 with current lane index to compute the master lane index.
21431 @item -mgomp
21432 @opindex mgomp
21433 Generate code for use in OpenMP offloading: enables @option{-msoft-stack} and
21434 @option{-muniform-simt} options, and selects corresponding multilib variant.
21436 @end table
21438 @node PDP-11 Options
21439 @subsection PDP-11 Options
21440 @cindex PDP-11 Options
21442 These options are defined for the PDP-11:
21444 @table @gcctabopt
21445 @item -mfpu
21446 @opindex mfpu
21447 Use hardware FPP floating point.  This is the default.  (FIS floating
21448 point on the PDP-11/40 is not supported.)
21450 @item -msoft-float
21451 @opindex msoft-float
21452 Do not use hardware floating point.
21454 @item -mac0
21455 @opindex mac0
21456 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
21458 @item -mno-ac0
21459 @opindex mno-ac0
21460 Return floating-point results in memory.  This is the default.
21462 @item -m40
21463 @opindex m40
21464 Generate code for a PDP-11/40.
21466 @item -m45
21467 @opindex m45
21468 Generate code for a PDP-11/45.  This is the default.
21470 @item -m10
21471 @opindex m10
21472 Generate code for a PDP-11/10.
21474 @item -mbcopy-builtin
21475 @opindex mbcopy-builtin
21476 Use inline @code{movmemhi} patterns for copying memory.  This is the
21477 default.
21479 @item -mbcopy
21480 @opindex mbcopy
21481 Do not use inline @code{movmemhi} patterns for copying memory.
21483 @item -mint16
21484 @itemx -mno-int32
21485 @opindex mint16
21486 @opindex mno-int32
21487 Use 16-bit @code{int}.  This is the default.
21489 @item -mint32
21490 @itemx -mno-int16
21491 @opindex mint32
21492 @opindex mno-int16
21493 Use 32-bit @code{int}.
21495 @item -mfloat64
21496 @itemx -mno-float32
21497 @opindex mfloat64
21498 @opindex mno-float32
21499 Use 64-bit @code{float}.  This is the default.
21501 @item -mfloat32
21502 @itemx -mno-float64
21503 @opindex mfloat32
21504 @opindex mno-float64
21505 Use 32-bit @code{float}.
21507 @item -mabshi
21508 @opindex mabshi
21509 Use @code{abshi2} pattern.  This is the default.
21511 @item -mno-abshi
21512 @opindex mno-abshi
21513 Do not use @code{abshi2} pattern.
21515 @item -mbranch-expensive
21516 @opindex mbranch-expensive
21517 Pretend that branches are expensive.  This is for experimenting with
21518 code generation only.
21520 @item -mbranch-cheap
21521 @opindex mbranch-cheap
21522 Do not pretend that branches are expensive.  This is the default.
21524 @item -munix-asm
21525 @opindex munix-asm
21526 Use Unix assembler syntax.  This is the default when configured for
21527 @samp{pdp11-*-bsd}.
21529 @item -mdec-asm
21530 @opindex mdec-asm
21531 Use DEC assembler syntax.  This is the default when configured for any
21532 PDP-11 target other than @samp{pdp11-*-bsd}.
21533 @end table
21535 @node picoChip Options
21536 @subsection picoChip Options
21537 @cindex picoChip options
21539 These @samp{-m} options are defined for picoChip implementations:
21541 @table @gcctabopt
21543 @item -mae=@var{ae_type}
21544 @opindex mcpu
21545 Set the instruction set, register set, and instruction scheduling
21546 parameters for array element type @var{ae_type}.  Supported values
21547 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
21549 @option{-mae=ANY} selects a completely generic AE type.  Code
21550 generated with this option runs on any of the other AE types.  The
21551 code is not as efficient as it would be if compiled for a specific
21552 AE type, and some types of operation (e.g., multiplication) do not
21553 work properly on all types of AE.
21555 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
21556 for compiled code, and is the default.
21558 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
21559 option may suffer from poor performance of byte (char) manipulation,
21560 since the DSP AE does not provide hardware support for byte load/stores.
21562 @item -msymbol-as-address
21563 Enable the compiler to directly use a symbol name as an address in a
21564 load/store instruction, without first loading it into a
21565 register.  Typically, the use of this option generates larger
21566 programs, which run faster than when the option isn't used.  However, the
21567 results vary from program to program, so it is left as a user option,
21568 rather than being permanently enabled.
21570 @item -mno-inefficient-warnings
21571 Disables warnings about the generation of inefficient code.  These
21572 warnings can be generated, for example, when compiling code that
21573 performs byte-level memory operations on the MAC AE type.  The MAC AE has
21574 no hardware support for byte-level memory operations, so all byte
21575 load/stores must be synthesized from word load/store operations.  This is
21576 inefficient and a warning is generated to indicate
21577 that you should rewrite the code to avoid byte operations, or to target
21578 an AE type that has the necessary hardware support.  This option disables
21579 these warnings.
21581 @end table
21583 @node PowerPC Options
21584 @subsection PowerPC Options
21585 @cindex PowerPC options
21587 These are listed under @xref{RS/6000 and PowerPC Options}.
21589 @node RISC-V Options
21590 @subsection RISC-V Options
21591 @cindex RISC-V Options
21593 These command-line options are defined for RISC-V targets:
21595 @table @gcctabopt
21596 @item -mbranch-cost=@var{n}
21597 @opindex mbranch-cost
21598 Set the cost of branches to roughly @var{n} instructions.
21600 @item -mmemcpy
21601 @itemx -mno-memcpy
21602 @opindex mmemcpy
21603 Don't optimize block moves.
21605 @item -mplt
21606 @itemx -mno-plt
21607 @opindex plt
21608 When generating PIC code, allow the use of PLTs. Ignored for non-PIC.
21610 @item -mabi=@var{ABI-string}
21611 @opindex mabi
21612 Specify integer and floating-point calling convention.  This defaults to the
21613 natural calling convention: e.g.@ LP64 for RV64I, ILP32 for RV32I, LP64D for
21614 RV64G.
21616 @item -mfdiv
21617 @itemx -mno-fdiv
21618 @opindex mfdiv
21619 Use hardware floating-point divide and square root instructions.  This requires
21620 the F or D extensions for floating-point registers.
21622 @item -mdiv
21623 @itemx -mno-div
21624 @opindex mdiv
21625 Use hardware instructions for integer division.  This requires the M extension.
21627 @item -march=@var{ISA-string}
21628 @opindex march
21629 Generate code for given RISC-V ISA (e.g.@ @samp{rv64im}).  ISA strings must be
21630 lower-case.  Examples include @samp{rv64i}, @samp{rv32g}, and @samp{rv32imaf}.
21632 @item -mtune=@var{processor-string}
21633 @opindex mtune
21634 Optimize the output for the given processor, specified by microarchitecture
21635 name.
21637 @item -msmall-data-limit=@var{n}
21638 @opindex msmall-data-limit
21639 Put global and static data smaller than @var{n} bytes into a special section
21640 (on some targets).
21642 @item -msave-restore
21643 @itemx -mno-save-restore
21644 @opindex msave-restore
21645 Use smaller but slower prologue and epilogue code.
21647 @item -mstrict-align
21648 @itemx -mno-strict-align
21649 @opindex mstrict-align
21650 Do not generate unaligned memory accesses.
21652 @item -mcmodel=@var{code-model}
21653 @opindex mcmodel
21654 Specify the code model.
21656 @end table
21658 @node RL78 Options
21659 @subsection RL78 Options
21660 @cindex RL78 Options
21662 @table @gcctabopt
21664 @item -msim
21665 @opindex msim
21666 Links in additional target libraries to support operation within a
21667 simulator.
21669 @item -mmul=none
21670 @itemx -mmul=g10
21671 @itemx -mmul=g13
21672 @itemx -mmul=g14
21673 @itemx -mmul=rl78
21674 @opindex mmul
21675 Specifies the type of hardware multiplication and division support to
21676 be used.  The simplest is @code{none}, which uses software for both
21677 multiplication and division.  This is the default.  The @code{g13}
21678 value is for the hardware multiply/divide peripheral found on the
21679 RL78/G13 (S2 core) targets.  The @code{g14} value selects the use of
21680 the multiplication and division instructions supported by the RL78/G14
21681 (S3 core) parts.  The value @code{rl78} is an alias for @code{g14} and
21682 the value @code{mg10} is an alias for @code{none}.
21684 In addition a C preprocessor macro is defined, based upon the setting
21685 of this option.  Possible values are: @code{__RL78_MUL_NONE__},
21686 @code{__RL78_MUL_G13__} or @code{__RL78_MUL_G14__}.
21688 @item -mcpu=g10
21689 @itemx -mcpu=g13
21690 @itemx -mcpu=g14
21691 @itemx -mcpu=rl78
21692 @opindex mcpu
21693 Specifies the RL78 core to target.  The default is the G14 core, also
21694 known as an S3 core or just RL78.  The G13 or S2 core does not have
21695 multiply or divide instructions, instead it uses a hardware peripheral
21696 for these operations.  The G10 or S1 core does not have register
21697 banks, so it uses a different calling convention.
21699 If this option is set it also selects the type of hardware multiply
21700 support to use, unless this is overridden by an explicit
21701 @option{-mmul=none} option on the command line.  Thus specifying
21702 @option{-mcpu=g13} enables the use of the G13 hardware multiply
21703 peripheral and specifying @option{-mcpu=g10} disables the use of
21704 hardware multiplications altogether.
21706 Note, although the RL78/G14 core is the default target, specifying
21707 @option{-mcpu=g14} or @option{-mcpu=rl78} on the command line does
21708 change the behavior of the toolchain since it also enables G14
21709 hardware multiply support.  If these options are not specified on the
21710 command line then software multiplication routines will be used even
21711 though the code targets the RL78 core.  This is for backwards
21712 compatibility with older toolchains which did not have hardware
21713 multiply and divide support.
21715 In addition a C preprocessor macro is defined, based upon the setting
21716 of this option.  Possible values are: @code{__RL78_G10__},
21717 @code{__RL78_G13__} or @code{__RL78_G14__}.
21719 @item -mg10
21720 @itemx -mg13
21721 @itemx -mg14
21722 @itemx -mrl78
21723 @opindex mg10
21724 @opindex mg13
21725 @opindex mg14
21726 @opindex mrl78
21727 These are aliases for the corresponding @option{-mcpu=} option.  They
21728 are provided for backwards compatibility.
21730 @item -mallregs
21731 @opindex mallregs
21732 Allow the compiler to use all of the available registers.  By default
21733 registers @code{r24..r31} are reserved for use in interrupt handlers.
21734 With this option enabled these registers can be used in ordinary
21735 functions as well.
21737 @item -m64bit-doubles
21738 @itemx -m32bit-doubles
21739 @opindex m64bit-doubles
21740 @opindex m32bit-doubles
21741 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
21742 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
21743 @option{-m32bit-doubles}.
21745 @item -msave-mduc-in-interrupts
21746 @item -mno-save-mduc-in-interrupts
21747 @opindex msave-mduc-in-interrupts
21748 @opindex mno-save-mduc-in-interrupts
21749 Specifies that interrupt handler functions should preserve the
21750 MDUC registers.  This is only necessary if normal code might use
21751 the MDUC registers, for example because it performs multiplication
21752 and division operations.  The default is to ignore the MDUC registers
21753 as this makes the interrupt handlers faster.  The target option -mg13
21754 needs to be passed for this to work as this feature is only available
21755 on the G13 target (S2 core).  The MDUC registers will only be saved
21756 if the interrupt handler performs a multiplication or division
21757 operation or it calls another function.
21759 @end table
21761 @node RS/6000 and PowerPC Options
21762 @subsection IBM RS/6000 and PowerPC Options
21763 @cindex RS/6000 and PowerPC Options
21764 @cindex IBM RS/6000 and PowerPC Options
21766 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
21767 @table @gcctabopt
21768 @item -mpowerpc-gpopt
21769 @itemx -mno-powerpc-gpopt
21770 @itemx -mpowerpc-gfxopt
21771 @itemx -mno-powerpc-gfxopt
21772 @need 800
21773 @itemx -mpowerpc64
21774 @itemx -mno-powerpc64
21775 @itemx -mmfcrf
21776 @itemx -mno-mfcrf
21777 @itemx -mpopcntb
21778 @itemx -mno-popcntb
21779 @itemx -mpopcntd
21780 @itemx -mno-popcntd
21781 @itemx -mfprnd
21782 @itemx -mno-fprnd
21783 @need 800
21784 @itemx -mcmpb
21785 @itemx -mno-cmpb
21786 @itemx -mmfpgpr
21787 @itemx -mno-mfpgpr
21788 @itemx -mhard-dfp
21789 @itemx -mno-hard-dfp
21790 @opindex mpowerpc-gpopt
21791 @opindex mno-powerpc-gpopt
21792 @opindex mpowerpc-gfxopt
21793 @opindex mno-powerpc-gfxopt
21794 @opindex mpowerpc64
21795 @opindex mno-powerpc64
21796 @opindex mmfcrf
21797 @opindex mno-mfcrf
21798 @opindex mpopcntb
21799 @opindex mno-popcntb
21800 @opindex mpopcntd
21801 @opindex mno-popcntd
21802 @opindex mfprnd
21803 @opindex mno-fprnd
21804 @opindex mcmpb
21805 @opindex mno-cmpb
21806 @opindex mmfpgpr
21807 @opindex mno-mfpgpr
21808 @opindex mhard-dfp
21809 @opindex mno-hard-dfp
21810 You use these options to specify which instructions are available on the
21811 processor you are using.  The default value of these options is
21812 determined when configuring GCC@.  Specifying the
21813 @option{-mcpu=@var{cpu_type}} overrides the specification of these
21814 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
21815 rather than the options listed above.
21817 Specifying @option{-mpowerpc-gpopt} allows
21818 GCC to use the optional PowerPC architecture instructions in the
21819 General Purpose group, including floating-point square root.  Specifying
21820 @option{-mpowerpc-gfxopt} allows GCC to
21821 use the optional PowerPC architecture instructions in the Graphics
21822 group, including floating-point select.
21824 The @option{-mmfcrf} option allows GCC to generate the move from
21825 condition register field instruction implemented on the POWER4
21826 processor and other processors that support the PowerPC V2.01
21827 architecture.
21828 The @option{-mpopcntb} option allows GCC to generate the popcount and
21829 double-precision FP reciprocal estimate instruction implemented on the
21830 POWER5 processor and other processors that support the PowerPC V2.02
21831 architecture.
21832 The @option{-mpopcntd} option allows GCC to generate the popcount
21833 instruction implemented on the POWER7 processor and other processors
21834 that support the PowerPC V2.06 architecture.
21835 The @option{-mfprnd} option allows GCC to generate the FP round to
21836 integer instructions implemented on the POWER5+ processor and other
21837 processors that support the PowerPC V2.03 architecture.
21838 The @option{-mcmpb} option allows GCC to generate the compare bytes
21839 instruction implemented on the POWER6 processor and other processors
21840 that support the PowerPC V2.05 architecture.
21841 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
21842 general-purpose register instructions implemented on the POWER6X
21843 processor and other processors that support the extended PowerPC V2.05
21844 architecture.
21845 The @option{-mhard-dfp} option allows GCC to generate the decimal
21846 floating-point instructions implemented on some POWER processors.
21848 The @option{-mpowerpc64} option allows GCC to generate the additional
21849 64-bit instructions that are found in the full PowerPC64 architecture
21850 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
21851 @option{-mno-powerpc64}.
21853 @item -mcpu=@var{cpu_type}
21854 @opindex mcpu
21855 Set architecture type, register usage, and
21856 instruction scheduling parameters for machine type @var{cpu_type}.
21857 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
21858 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
21859 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
21860 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
21861 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
21862 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
21863 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
21864 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
21865 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
21866 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8},
21867 @samp{power9}, @samp{powerpc}, @samp{powerpc64}, @samp{powerpc64le},
21868 and @samp{rs64}.
21870 @option{-mcpu=powerpc}, @option{-mcpu=powerpc64}, and
21871 @option{-mcpu=powerpc64le} specify pure 32-bit PowerPC (either
21872 endian), 64-bit big endian PowerPC and 64-bit little endian PowerPC
21873 architecture machine types, with an appropriate, generic processor
21874 model assumed for scheduling purposes.
21876 The other options specify a specific processor.  Code generated under
21877 those options runs best on that processor, and may not run at all on
21878 others.
21880 The @option{-mcpu} options automatically enable or disable the
21881 following options:
21883 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
21884 -mpopcntb -mpopcntd  -mpowerpc64 @gol
21885 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
21886 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
21887 -mcrypto -mdirect-move -mhtm -mpower8-fusion -mpower8-vector @gol
21888 -mquad-memory -mquad-memory-atomic -mfloat128 -mfloat128-hardware}
21890 The particular options set for any particular CPU varies between
21891 compiler versions, depending on what setting seems to produce optimal
21892 code for that CPU; it doesn't necessarily reflect the actual hardware's
21893 capabilities.  If you wish to set an individual option to a particular
21894 value, you may specify it after the @option{-mcpu} option, like
21895 @option{-mcpu=970 -mno-altivec}.
21897 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
21898 not enabled or disabled by the @option{-mcpu} option at present because
21899 AIX does not have full support for these options.  You may still
21900 enable or disable them individually if you're sure it'll work in your
21901 environment.
21903 @item -mtune=@var{cpu_type}
21904 @opindex mtune
21905 Set the instruction scheduling parameters for machine type
21906 @var{cpu_type}, but do not set the architecture type or register usage,
21907 as @option{-mcpu=@var{cpu_type}} does.  The same
21908 values for @var{cpu_type} are used for @option{-mtune} as for
21909 @option{-mcpu}.  If both are specified, the code generated uses the
21910 architecture and registers set by @option{-mcpu}, but the
21911 scheduling parameters set by @option{-mtune}.
21913 @item -mcmodel=small
21914 @opindex mcmodel=small
21915 Generate PowerPC64 code for the small model: The TOC is limited to
21916 64k.
21918 @item -mcmodel=medium
21919 @opindex mcmodel=medium
21920 Generate PowerPC64 code for the medium model: The TOC and other static
21921 data may be up to a total of 4G in size.  This is the default for 64-bit
21922 Linux.
21924 @item -mcmodel=large
21925 @opindex mcmodel=large
21926 Generate PowerPC64 code for the large model: The TOC may be up to 4G
21927 in size.  Other data and code is only limited by the 64-bit address
21928 space.
21930 @item -maltivec
21931 @itemx -mno-altivec
21932 @opindex maltivec
21933 @opindex mno-altivec
21934 Generate code that uses (does not use) AltiVec instructions, and also
21935 enable the use of built-in functions that allow more direct access to
21936 the AltiVec instruction set.  You may also need to set
21937 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
21938 enhancements.
21940 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
21941 @option{-maltivec=be}, the element order for AltiVec intrinsics such
21942 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} 
21943 match array element order corresponding to the endianness of the
21944 target.  That is, element zero identifies the leftmost element in a
21945 vector register when targeting a big-endian platform, and identifies
21946 the rightmost element in a vector register when targeting a
21947 little-endian platform.
21949 @item -maltivec=be
21950 @opindex maltivec=be
21951 Generate AltiVec instructions using big-endian element order,
21952 regardless of whether the target is big- or little-endian.  This is
21953 the default when targeting a big-endian platform.
21955 The element order is used to interpret element numbers in AltiVec
21956 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
21957 @code{vec_insert}.  By default, these match array element order
21958 corresponding to the endianness for the target.
21960 @item -maltivec=le
21961 @opindex maltivec=le
21962 Generate AltiVec instructions using little-endian element order,
21963 regardless of whether the target is big- or little-endian.  This is
21964 the default when targeting a little-endian platform.  This option is
21965 currently ignored when targeting a big-endian platform.
21967 The element order is used to interpret element numbers in AltiVec
21968 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
21969 @code{vec_insert}.  By default, these match array element order
21970 corresponding to the endianness for the target.
21972 @item -mvrsave
21973 @itemx -mno-vrsave
21974 @opindex mvrsave
21975 @opindex mno-vrsave
21976 Generate VRSAVE instructions when generating AltiVec code.
21978 @item -msecure-plt
21979 @opindex msecure-plt
21980 Generate code that allows @command{ld} and @command{ld.so}
21981 to build executables and shared
21982 libraries with non-executable @code{.plt} and @code{.got} sections.
21983 This is a PowerPC
21984 32-bit SYSV ABI option.
21986 @item -mbss-plt
21987 @opindex mbss-plt
21988 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
21989 fills in, and
21990 requires @code{.plt} and @code{.got}
21991 sections that are both writable and executable.
21992 This is a PowerPC 32-bit SYSV ABI option.
21994 @item -misel
21995 @itemx -mno-isel
21996 @opindex misel
21997 @opindex mno-isel
21998 This switch enables or disables the generation of ISEL instructions.
22000 @item -misel=@var{yes/no}
22001 This switch has been deprecated.  Use @option{-misel} and
22002 @option{-mno-isel} instead.
22004 @item -mspe
22005 @itemx -mno-spe
22006 @opindex mspe
22007 @opindex mno-spe
22008 This switch enables or disables the generation of SPE simd
22009 instructions.
22011 @item -mpaired
22012 @itemx -mno-paired
22013 @opindex mpaired
22014 @opindex mno-paired
22015 This switch enables or disables the generation of PAIRED simd
22016 instructions.
22018 @item -mspe=@var{yes/no}
22019 This option has been deprecated.  Use @option{-mspe} and
22020 @option{-mno-spe} instead.
22022 @item -mvsx
22023 @itemx -mno-vsx
22024 @opindex mvsx
22025 @opindex mno-vsx
22026 Generate code that uses (does not use) vector/scalar (VSX)
22027 instructions, and also enable the use of built-in functions that allow
22028 more direct access to the VSX instruction set.
22030 @item -mcrypto
22031 @itemx -mno-crypto
22032 @opindex mcrypto
22033 @opindex mno-crypto
22034 Enable the use (disable) of the built-in functions that allow direct
22035 access to the cryptographic instructions that were added in version
22036 2.07 of the PowerPC ISA.
22038 @item -mdirect-move
22039 @itemx -mno-direct-move
22040 @opindex mdirect-move
22041 @opindex mno-direct-move
22042 Generate code that uses (does not use) the instructions to move data
22043 between the general purpose registers and the vector/scalar (VSX)
22044 registers that were added in version 2.07 of the PowerPC ISA.
22046 @item -mhtm
22047 @itemx -mno-htm
22048 @opindex mhtm
22049 @opindex mno-htm
22050 Enable (disable) the use of the built-in functions that allow direct
22051 access to the Hardware Transactional Memory (HTM) instructions that
22052 were added in version 2.07 of the PowerPC ISA.
22054 @item -mpower8-fusion
22055 @itemx -mno-power8-fusion
22056 @opindex mpower8-fusion
22057 @opindex mno-power8-fusion
22058 Generate code that keeps (does not keeps) some integer operations
22059 adjacent so that the instructions can be fused together on power8 and
22060 later processors.
22062 @item -mpower8-vector
22063 @itemx -mno-power8-vector
22064 @opindex mpower8-vector
22065 @opindex mno-power8-vector
22066 Generate code that uses (does not use) the vector and scalar
22067 instructions that were added in version 2.07 of the PowerPC ISA.  Also
22068 enable the use of built-in functions that allow more direct access to
22069 the vector instructions.
22071 @item -mquad-memory
22072 @itemx -mno-quad-memory
22073 @opindex mquad-memory
22074 @opindex mno-quad-memory
22075 Generate code that uses (does not use) the non-atomic quad word memory
22076 instructions.  The @option{-mquad-memory} option requires use of
22077 64-bit mode.
22079 @item -mquad-memory-atomic
22080 @itemx -mno-quad-memory-atomic
22081 @opindex mquad-memory-atomic
22082 @opindex mno-quad-memory-atomic
22083 Generate code that uses (does not use) the atomic quad word memory
22084 instructions.  The @option{-mquad-memory-atomic} option requires use of
22085 64-bit mode.
22087 @item -mfloat128
22088 @itemx -mno-float128
22089 @opindex mfloat128
22090 @opindex mno-float128
22091 Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point
22092 and use either software emulation for IEEE 128-bit floating point or
22093 hardware instructions.
22095 The VSX instruction set (@option{-mvsx}, @option{-mcpu=power7},
22096 @option{-mcpu=power8}), or @option{-mcpu=power9} must be enabled to
22097 use the IEEE 128-bit floating point support.  The IEEE 128-bit
22098 floating point support only works on PowerPC Linux systems.
22100 The default for @option{-mfloat128} is enabled on PowerPC Linux
22101 systems using the VSX instruction set, and disabled on other systems.
22103 If you use the ISA 3.0 instruction set (@option{-mpower9-vector} or
22104 @option{-mcpu=power9}) on a 64-bit system, the IEEE 128-bit floating
22105 point support will also enable the generation of ISA 3.0 IEEE 128-bit
22106 floating point instructions.  Otherwise, if you do not specify to
22107 generate ISA 3.0 instructions or you are targeting a 32-bit big endian
22108 system, IEEE 128-bit floating point will be done with software
22109 emulation.
22111 @item -mfloat128-hardware
22112 @itemx -mno-float128-hardware
22113 @opindex mfloat128-hardware
22114 @opindex mno-float128-hardware
22115 Enable/disable using ISA 3.0 hardware instructions to support the
22116 @var{__float128} data type.
22118 The default for @option{-mfloat128-hardware} is enabled on PowerPC
22119 Linux systems using the ISA 3.0 instruction set, and disabled on other
22120 systems.
22122 @item -mfloat-gprs=@var{yes/single/double/no}
22123 @itemx -mfloat-gprs
22124 @opindex mfloat-gprs
22125 This switch enables or disables the generation of floating-point
22126 operations on the general-purpose registers for architectures that
22127 support it.
22129 The argument @samp{yes} or @samp{single} enables the use of
22130 single-precision floating-point operations.
22132 The argument @samp{double} enables the use of single and
22133 double-precision floating-point operations.
22135 The argument @samp{no} disables floating-point operations on the
22136 general-purpose registers.
22138 This option is currently only available on the MPC854x.
22140 @item -m32
22141 @itemx -m64
22142 @opindex m32
22143 @opindex m64
22144 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
22145 targets (including GNU/Linux).  The 32-bit environment sets int, long
22146 and pointer to 32 bits and generates code that runs on any PowerPC
22147 variant.  The 64-bit environment sets int to 32 bits and long and
22148 pointer to 64 bits, and generates code for PowerPC64, as for
22149 @option{-mpowerpc64}.
22151 @item -mfull-toc
22152 @itemx -mno-fp-in-toc
22153 @itemx -mno-sum-in-toc
22154 @itemx -mminimal-toc
22155 @opindex mfull-toc
22156 @opindex mno-fp-in-toc
22157 @opindex mno-sum-in-toc
22158 @opindex mminimal-toc
22159 Modify generation of the TOC (Table Of Contents), which is created for
22160 every executable file.  The @option{-mfull-toc} option is selected by
22161 default.  In that case, GCC allocates at least one TOC entry for
22162 each unique non-automatic variable reference in your program.  GCC
22163 also places floating-point constants in the TOC@.  However, only
22164 16,384 entries are available in the TOC@.
22166 If you receive a linker error message that saying you have overflowed
22167 the available TOC space, you can reduce the amount of TOC space used
22168 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
22169 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
22170 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
22171 generate code to calculate the sum of an address and a constant at
22172 run time instead of putting that sum into the TOC@.  You may specify one
22173 or both of these options.  Each causes GCC to produce very slightly
22174 slower and larger code at the expense of conserving TOC space.
22176 If you still run out of space in the TOC even when you specify both of
22177 these options, specify @option{-mminimal-toc} instead.  This option causes
22178 GCC to make only one TOC entry for every file.  When you specify this
22179 option, GCC produces code that is slower and larger but which
22180 uses extremely little TOC space.  You may wish to use this option
22181 only on files that contain less frequently-executed code.
22183 @item -maix64
22184 @itemx -maix32
22185 @opindex maix64
22186 @opindex maix32
22187 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
22188 @code{long} type, and the infrastructure needed to support them.
22189 Specifying @option{-maix64} implies @option{-mpowerpc64},
22190 while @option{-maix32} disables the 64-bit ABI and
22191 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
22193 @item -mxl-compat
22194 @itemx -mno-xl-compat
22195 @opindex mxl-compat
22196 @opindex mno-xl-compat
22197 Produce code that conforms more closely to IBM XL compiler semantics
22198 when using AIX-compatible ABI@.  Pass floating-point arguments to
22199 prototyped functions beyond the register save area (RSA) on the stack
22200 in addition to argument FPRs.  Do not assume that most significant
22201 double in 128-bit long double value is properly rounded when comparing
22202 values and converting to double.  Use XL symbol names for long double
22203 support routines.
22205 The AIX calling convention was extended but not initially documented to
22206 handle an obscure K&R C case of calling a function that takes the
22207 address of its arguments with fewer arguments than declared.  IBM XL
22208 compilers access floating-point arguments that do not fit in the
22209 RSA from the stack when a subroutine is compiled without
22210 optimization.  Because always storing floating-point arguments on the
22211 stack is inefficient and rarely needed, this option is not enabled by
22212 default and only is necessary when calling subroutines compiled by IBM
22213 XL compilers without optimization.
22215 @item -mpe
22216 @opindex mpe
22217 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
22218 application written to use message passing with special startup code to
22219 enable the application to run.  The system must have PE installed in the
22220 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
22221 must be overridden with the @option{-specs=} option to specify the
22222 appropriate directory location.  The Parallel Environment does not
22223 support threads, so the @option{-mpe} option and the @option{-pthread}
22224 option are incompatible.
22226 @item -malign-natural
22227 @itemx -malign-power
22228 @opindex malign-natural
22229 @opindex malign-power
22230 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
22231 @option{-malign-natural} overrides the ABI-defined alignment of larger
22232 types, such as floating-point doubles, on their natural size-based boundary.
22233 The option @option{-malign-power} instructs GCC to follow the ABI-specified
22234 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
22236 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
22237 is not supported.
22239 @item -msoft-float
22240 @itemx -mhard-float
22241 @opindex msoft-float
22242 @opindex mhard-float
22243 Generate code that does not use (uses) the floating-point register set.
22244 Software floating-point emulation is provided if you use the
22245 @option{-msoft-float} option, and pass the option to GCC when linking.
22247 @item -msingle-float
22248 @itemx -mdouble-float
22249 @opindex msingle-float
22250 @opindex mdouble-float
22251 Generate code for single- or double-precision floating-point operations.
22252 @option{-mdouble-float} implies @option{-msingle-float}.
22254 @item -msimple-fpu
22255 @opindex msimple-fpu
22256 Do not generate @code{sqrt} and @code{div} instructions for hardware
22257 floating-point unit.
22259 @item -mfpu=@var{name}
22260 @opindex mfpu
22261 Specify type of floating-point unit.  Valid values for @var{name} are
22262 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
22263 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
22264 @samp{sp_full} (equivalent to @option{-msingle-float}),
22265 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
22267 @item -mxilinx-fpu
22268 @opindex mxilinx-fpu
22269 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
22271 @item -mmultiple
22272 @itemx -mno-multiple
22273 @opindex mmultiple
22274 @opindex mno-multiple
22275 Generate code that uses (does not use) the load multiple word
22276 instructions and the store multiple word instructions.  These
22277 instructions are generated by default on POWER systems, and not
22278 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
22279 PowerPC systems, since those instructions do not work when the
22280 processor is in little-endian mode.  The exceptions are PPC740 and
22281 PPC750 which permit these instructions in little-endian mode.
22283 @item -mstring
22284 @itemx -mno-string
22285 @opindex mstring
22286 @opindex mno-string
22287 Generate code that uses (does not use) the load string instructions
22288 and the store string word instructions to save multiple registers and
22289 do small block moves.  These instructions are generated by default on
22290 POWER systems, and not generated on PowerPC systems.  Do not use
22291 @option{-mstring} on little-endian PowerPC systems, since those
22292 instructions do not work when the processor is in little-endian mode.
22293 The exceptions are PPC740 and PPC750 which permit these instructions
22294 in little-endian mode.
22296 @item -mupdate
22297 @itemx -mno-update
22298 @opindex mupdate
22299 @opindex mno-update
22300 Generate code that uses (does not use) the load or store instructions
22301 that update the base register to the address of the calculated memory
22302 location.  These instructions are generated by default.  If you use
22303 @option{-mno-update}, there is a small window between the time that the
22304 stack pointer is updated and the address of the previous frame is
22305 stored, which means code that walks the stack frame across interrupts or
22306 signals may get corrupted data.
22308 @item -mavoid-indexed-addresses
22309 @itemx -mno-avoid-indexed-addresses
22310 @opindex mavoid-indexed-addresses
22311 @opindex mno-avoid-indexed-addresses
22312 Generate code that tries to avoid (not avoid) the use of indexed load
22313 or store instructions. These instructions can incur a performance
22314 penalty on Power6 processors in certain situations, such as when
22315 stepping through large arrays that cross a 16M boundary.  This option
22316 is enabled by default when targeting Power6 and disabled otherwise.
22318 @item -mfused-madd
22319 @itemx -mno-fused-madd
22320 @opindex mfused-madd
22321 @opindex mno-fused-madd
22322 Generate code that uses (does not use) the floating-point multiply and
22323 accumulate instructions.  These instructions are generated by default
22324 if hardware floating point is used.  The machine-dependent
22325 @option{-mfused-madd} option is now mapped to the machine-independent
22326 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
22327 mapped to @option{-ffp-contract=off}.
22329 @item -mmulhw
22330 @itemx -mno-mulhw
22331 @opindex mmulhw
22332 @opindex mno-mulhw
22333 Generate code that uses (does not use) the half-word multiply and
22334 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
22335 These instructions are generated by default when targeting those
22336 processors.
22338 @item -mdlmzb
22339 @itemx -mno-dlmzb
22340 @opindex mdlmzb
22341 @opindex mno-dlmzb
22342 Generate code that uses (does not use) the string-search @samp{dlmzb}
22343 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
22344 generated by default when targeting those processors.
22346 @item -mno-bit-align
22347 @itemx -mbit-align
22348 @opindex mno-bit-align
22349 @opindex mbit-align
22350 On System V.4 and embedded PowerPC systems do not (do) force structures
22351 and unions that contain bit-fields to be aligned to the base type of the
22352 bit-field.
22354 For example, by default a structure containing nothing but 8
22355 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
22356 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
22357 the structure is aligned to a 1-byte boundary and is 1 byte in
22358 size.
22360 @item -mno-strict-align
22361 @itemx -mstrict-align
22362 @opindex mno-strict-align
22363 @opindex mstrict-align
22364 On System V.4 and embedded PowerPC systems do not (do) assume that
22365 unaligned memory references are handled by the system.
22367 @item -mrelocatable
22368 @itemx -mno-relocatable
22369 @opindex mrelocatable
22370 @opindex mno-relocatable
22371 Generate code that allows (does not allow) a static executable to be
22372 relocated to a different address at run time.  A simple embedded
22373 PowerPC system loader should relocate the entire contents of
22374 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
22375 a table of 32-bit addresses generated by this option.  For this to
22376 work, all objects linked together must be compiled with
22377 @option{-mrelocatable} or @option{-mrelocatable-lib}.
22378 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
22380 @item -mrelocatable-lib
22381 @itemx -mno-relocatable-lib
22382 @opindex mrelocatable-lib
22383 @opindex mno-relocatable-lib
22384 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
22385 @code{.fixup} section to allow static executables to be relocated at
22386 run time, but @option{-mrelocatable-lib} does not use the smaller stack
22387 alignment of @option{-mrelocatable}.  Objects compiled with
22388 @option{-mrelocatable-lib} may be linked with objects compiled with
22389 any combination of the @option{-mrelocatable} options.
22391 @item -mno-toc
22392 @itemx -mtoc
22393 @opindex mno-toc
22394 @opindex mtoc
22395 On System V.4 and embedded PowerPC systems do not (do) assume that
22396 register 2 contains a pointer to a global area pointing to the addresses
22397 used in the program.
22399 @item -mlittle
22400 @itemx -mlittle-endian
22401 @opindex mlittle
22402 @opindex mlittle-endian
22403 On System V.4 and embedded PowerPC systems compile code for the
22404 processor in little-endian mode.  The @option{-mlittle-endian} option is
22405 the same as @option{-mlittle}.
22407 @item -mbig
22408 @itemx -mbig-endian
22409 @opindex mbig
22410 @opindex mbig-endian
22411 On System V.4 and embedded PowerPC systems compile code for the
22412 processor in big-endian mode.  The @option{-mbig-endian} option is
22413 the same as @option{-mbig}.
22415 @item -mdynamic-no-pic
22416 @opindex mdynamic-no-pic
22417 On Darwin and Mac OS X systems, compile code so that it is not
22418 relocatable, but that its external references are relocatable.  The
22419 resulting code is suitable for applications, but not shared
22420 libraries.
22422 @item -msingle-pic-base
22423 @opindex msingle-pic-base
22424 Treat the register used for PIC addressing as read-only, rather than
22425 loading it in the prologue for each function.  The runtime system is
22426 responsible for initializing this register with an appropriate value
22427 before execution begins.
22429 @item -mprioritize-restricted-insns=@var{priority}
22430 @opindex mprioritize-restricted-insns
22431 This option controls the priority that is assigned to
22432 dispatch-slot restricted instructions during the second scheduling
22433 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
22434 or @samp{2} to assign no, highest, or second-highest (respectively) 
22435 priority to dispatch-slot restricted
22436 instructions.
22438 @item -msched-costly-dep=@var{dependence_type}
22439 @opindex msched-costly-dep
22440 This option controls which dependences are considered costly
22441 by the target during instruction scheduling.  The argument
22442 @var{dependence_type} takes one of the following values:
22444 @table @asis
22445 @item @samp{no}
22446 No dependence is costly.
22448 @item @samp{all}
22449 All dependences are costly.
22451 @item @samp{true_store_to_load}
22452 A true dependence from store to load is costly.
22454 @item @samp{store_to_load}
22455 Any dependence from store to load is costly.
22457 @item @var{number}
22458 Any dependence for which the latency is greater than or equal to 
22459 @var{number} is costly.
22460 @end table
22462 @item -minsert-sched-nops=@var{scheme}
22463 @opindex minsert-sched-nops
22464 This option controls which NOP insertion scheme is used during
22465 the second scheduling pass.  The argument @var{scheme} takes one of the
22466 following values:
22468 @table @asis
22469 @item @samp{no}
22470 Don't insert NOPs.
22472 @item @samp{pad}
22473 Pad with NOPs any dispatch group that has vacant issue slots,
22474 according to the scheduler's grouping.
22476 @item @samp{regroup_exact}
22477 Insert NOPs to force costly dependent insns into
22478 separate groups.  Insert exactly as many NOPs as needed to force an insn
22479 to a new group, according to the estimated processor grouping.
22481 @item @var{number}
22482 Insert NOPs to force costly dependent insns into
22483 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
22484 @end table
22486 @item -mcall-sysv
22487 @opindex mcall-sysv
22488 On System V.4 and embedded PowerPC systems compile code using calling
22489 conventions that adhere to the March 1995 draft of the System V
22490 Application Binary Interface, PowerPC processor supplement.  This is the
22491 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
22493 @item -mcall-sysv-eabi
22494 @itemx -mcall-eabi
22495 @opindex mcall-sysv-eabi
22496 @opindex mcall-eabi
22497 Specify both @option{-mcall-sysv} and @option{-meabi} options.
22499 @item -mcall-sysv-noeabi
22500 @opindex mcall-sysv-noeabi
22501 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
22503 @item -mcall-aixdesc
22504 @opindex m
22505 On System V.4 and embedded PowerPC systems compile code for the AIX
22506 operating system.
22508 @item -mcall-linux
22509 @opindex mcall-linux
22510 On System V.4 and embedded PowerPC systems compile code for the
22511 Linux-based GNU system.
22513 @item -mcall-freebsd
22514 @opindex mcall-freebsd
22515 On System V.4 and embedded PowerPC systems compile code for the
22516 FreeBSD operating system.
22518 @item -mcall-netbsd
22519 @opindex mcall-netbsd
22520 On System V.4 and embedded PowerPC systems compile code for the
22521 NetBSD operating system.
22523 @item -mcall-openbsd
22524 @opindex mcall-netbsd
22525 On System V.4 and embedded PowerPC systems compile code for the
22526 OpenBSD operating system.
22528 @item -maix-struct-return
22529 @opindex maix-struct-return
22530 Return all structures in memory (as specified by the AIX ABI)@.
22532 @item -msvr4-struct-return
22533 @opindex msvr4-struct-return
22534 Return structures smaller than 8 bytes in registers (as specified by the
22535 SVR4 ABI)@.
22537 @item -mabi=@var{abi-type}
22538 @opindex mabi
22539 Extend the current ABI with a particular extension, or remove such extension.
22540 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
22541 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
22542 @samp{elfv1}, @samp{elfv2}@.
22544 @item -mabi=spe
22545 @opindex mabi=spe
22546 Extend the current ABI with SPE ABI extensions.  This does not change
22547 the default ABI, instead it adds the SPE ABI extensions to the current
22548 ABI@.
22550 @item -mabi=no-spe
22551 @opindex mabi=no-spe
22552 Disable Book-E SPE ABI extensions for the current ABI@.
22554 @item -mabi=ibmlongdouble
22555 @opindex mabi=ibmlongdouble
22556 Change the current ABI to use IBM extended-precision long double.
22557 This is a PowerPC 32-bit SYSV ABI option.
22559 @item -mabi=ieeelongdouble
22560 @opindex mabi=ieeelongdouble
22561 Change the current ABI to use IEEE extended-precision long double.
22562 This is a PowerPC 32-bit Linux ABI option.
22564 @item -mabi=elfv1
22565 @opindex mabi=elfv1
22566 Change the current ABI to use the ELFv1 ABI.
22567 This is the default ABI for big-endian PowerPC 64-bit Linux.
22568 Overriding the default ABI requires special system support and is
22569 likely to fail in spectacular ways.
22571 @item -mabi=elfv2
22572 @opindex mabi=elfv2
22573 Change the current ABI to use the ELFv2 ABI.
22574 This is the default ABI for little-endian PowerPC 64-bit Linux.
22575 Overriding the default ABI requires special system support and is
22576 likely to fail in spectacular ways.
22578 @item -mgnu-attribute
22579 @itemx -mno-gnu-attribute
22580 @opindex mgnu-attribute
22581 @opindex mno-gnu-attribute
22582 Emit .gnu_attribute assembly directives to set tag/value pairs in a
22583 .gnu.attributes section that specify ABI variations in function
22584 parameters or return values.
22586 @item -mprototype
22587 @itemx -mno-prototype
22588 @opindex mprototype
22589 @opindex mno-prototype
22590 On System V.4 and embedded PowerPC systems assume that all calls to
22591 variable argument functions are properly prototyped.  Otherwise, the
22592 compiler must insert an instruction before every non-prototyped call to
22593 set or clear bit 6 of the condition code register (@code{CR}) to
22594 indicate whether floating-point values are passed in the floating-point
22595 registers in case the function takes variable arguments.  With
22596 @option{-mprototype}, only calls to prototyped variable argument functions
22597 set or clear the bit.
22599 @item -msim
22600 @opindex msim
22601 On embedded PowerPC systems, assume that the startup module is called
22602 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
22603 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
22604 configurations.
22606 @item -mmvme
22607 @opindex mmvme
22608 On embedded PowerPC systems, assume that the startup module is called
22609 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
22610 @file{libc.a}.
22612 @item -mads
22613 @opindex mads
22614 On embedded PowerPC systems, assume that the startup module is called
22615 @file{crt0.o} and the standard C libraries are @file{libads.a} and
22616 @file{libc.a}.
22618 @item -myellowknife
22619 @opindex myellowknife
22620 On embedded PowerPC systems, assume that the startup module is called
22621 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
22622 @file{libc.a}.
22624 @item -mvxworks
22625 @opindex mvxworks
22626 On System V.4 and embedded PowerPC systems, specify that you are
22627 compiling for a VxWorks system.
22629 @item -memb
22630 @opindex memb
22631 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
22632 header to indicate that @samp{eabi} extended relocations are used.
22634 @item -meabi
22635 @itemx -mno-eabi
22636 @opindex meabi
22637 @opindex mno-eabi
22638 On System V.4 and embedded PowerPC systems do (do not) adhere to the
22639 Embedded Applications Binary Interface (EABI), which is a set of
22640 modifications to the System V.4 specifications.  Selecting @option{-meabi}
22641 means that the stack is aligned to an 8-byte boundary, a function
22642 @code{__eabi} is called from @code{main} to set up the EABI
22643 environment, and the @option{-msdata} option can use both @code{r2} and
22644 @code{r13} to point to two separate small data areas.  Selecting
22645 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
22646 no EABI initialization function is called from @code{main}, and the
22647 @option{-msdata} option only uses @code{r13} to point to a single
22648 small data area.  The @option{-meabi} option is on by default if you
22649 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
22651 @item -msdata=eabi
22652 @opindex msdata=eabi
22653 On System V.4 and embedded PowerPC systems, put small initialized
22654 @code{const} global and static data in the @code{.sdata2} section, which
22655 is pointed to by register @code{r2}.  Put small initialized
22656 non-@code{const} global and static data in the @code{.sdata} section,
22657 which is pointed to by register @code{r13}.  Put small uninitialized
22658 global and static data in the @code{.sbss} section, which is adjacent to
22659 the @code{.sdata} section.  The @option{-msdata=eabi} option is
22660 incompatible with the @option{-mrelocatable} option.  The
22661 @option{-msdata=eabi} option also sets the @option{-memb} option.
22663 @item -msdata=sysv
22664 @opindex msdata=sysv
22665 On System V.4 and embedded PowerPC systems, put small global and static
22666 data in the @code{.sdata} section, which is pointed to by register
22667 @code{r13}.  Put small uninitialized global and static data in the
22668 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
22669 The @option{-msdata=sysv} option is incompatible with the
22670 @option{-mrelocatable} option.
22672 @item -msdata=default
22673 @itemx -msdata
22674 @opindex msdata=default
22675 @opindex msdata
22676 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
22677 compile code the same as @option{-msdata=eabi}, otherwise compile code the
22678 same as @option{-msdata=sysv}.
22680 @item -msdata=data
22681 @opindex msdata=data
22682 On System V.4 and embedded PowerPC systems, put small global
22683 data in the @code{.sdata} section.  Put small uninitialized global
22684 data in the @code{.sbss} section.  Do not use register @code{r13}
22685 to address small data however.  This is the default behavior unless
22686 other @option{-msdata} options are used.
22688 @item -msdata=none
22689 @itemx -mno-sdata
22690 @opindex msdata=none
22691 @opindex mno-sdata
22692 On embedded PowerPC systems, put all initialized global and static data
22693 in the @code{.data} section, and all uninitialized data in the
22694 @code{.bss} section.
22696 @item -mblock-move-inline-limit=@var{num}
22697 @opindex mblock-move-inline-limit
22698 Inline all block moves (such as calls to @code{memcpy} or structure
22699 copies) less than or equal to @var{num} bytes.  The minimum value for
22700 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
22701 targets.  The default value is target-specific.
22703 @item -G @var{num}
22704 @opindex G
22705 @cindex smaller data references (PowerPC)
22706 @cindex .sdata/.sdata2 references (PowerPC)
22707 On embedded PowerPC systems, put global and static items less than or
22708 equal to @var{num} bytes into the small data or BSS sections instead of
22709 the normal data or BSS section.  By default, @var{num} is 8.  The
22710 @option{-G @var{num}} switch is also passed to the linker.
22711 All modules should be compiled with the same @option{-G @var{num}} value.
22713 @item -mregnames
22714 @itemx -mno-regnames
22715 @opindex mregnames
22716 @opindex mno-regnames
22717 On System V.4 and embedded PowerPC systems do (do not) emit register
22718 names in the assembly language output using symbolic forms.
22720 @item -mlongcall
22721 @itemx -mno-longcall
22722 @opindex mlongcall
22723 @opindex mno-longcall
22724 By default assume that all calls are far away so that a longer and more
22725 expensive calling sequence is required.  This is required for calls
22726 farther than 32 megabytes (33,554,432 bytes) from the current location.
22727 A short call is generated if the compiler knows
22728 the call cannot be that far away.  This setting can be overridden by
22729 the @code{shortcall} function attribute, or by @code{#pragma
22730 longcall(0)}.
22732 Some linkers are capable of detecting out-of-range calls and generating
22733 glue code on the fly.  On these systems, long calls are unnecessary and
22734 generate slower code.  As of this writing, the AIX linker can do this,
22735 as can the GNU linker for PowerPC/64.  It is planned to add this feature
22736 to the GNU linker for 32-bit PowerPC systems as well.
22738 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
22739 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
22740 addresses represent the callee and the branch island.  The
22741 Darwin/PPC linker prefers the first address and generates a @code{bl
22742 callee} if the PPC @code{bl} instruction reaches the callee directly;
22743 otherwise, the linker generates @code{bl L42} to call the branch
22744 island.  The branch island is appended to the body of the
22745 calling function; it computes the full 32-bit address of the callee
22746 and jumps to it.
22748 On Mach-O (Darwin) systems, this option directs the compiler emit to
22749 the glue for every direct call, and the Darwin linker decides whether
22750 to use or discard it.
22752 In the future, GCC may ignore all longcall specifications
22753 when the linker is known to generate glue.
22755 @item -mtls-markers
22756 @itemx -mno-tls-markers
22757 @opindex mtls-markers
22758 @opindex mno-tls-markers
22759 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
22760 specifying the function argument.  The relocation allows the linker to
22761 reliably associate function call with argument setup instructions for
22762 TLS optimization, which in turn allows GCC to better schedule the
22763 sequence.
22765 @item -mrecip
22766 @itemx -mno-recip
22767 @opindex mrecip
22768 This option enables use of the reciprocal estimate and
22769 reciprocal square root estimate instructions with additional
22770 Newton-Raphson steps to increase precision instead of doing a divide or
22771 square root and divide for floating-point arguments.  You should use
22772 the @option{-ffast-math} option when using @option{-mrecip} (or at
22773 least @option{-funsafe-math-optimizations},
22774 @option{-ffinite-math-only}, @option{-freciprocal-math} and
22775 @option{-fno-trapping-math}).  Note that while the throughput of the
22776 sequence is generally higher than the throughput of the non-reciprocal
22777 instruction, the precision of the sequence can be decreased by up to 2
22778 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
22779 roots.
22781 @item -mrecip=@var{opt}
22782 @opindex mrecip=opt
22783 This option controls which reciprocal estimate instructions
22784 may be used.  @var{opt} is a comma-separated list of options, which may
22785 be preceded by a @code{!} to invert the option:
22787 @table @samp
22789 @item all
22790 Enable all estimate instructions.
22792 @item default 
22793 Enable the default instructions, equivalent to @option{-mrecip}.
22795 @item none 
22796 Disable all estimate instructions, equivalent to @option{-mno-recip}.
22798 @item div 
22799 Enable the reciprocal approximation instructions for both 
22800 single and double precision.
22802 @item divf 
22803 Enable the single-precision reciprocal approximation instructions.
22805 @item divd 
22806 Enable the double-precision reciprocal approximation instructions.
22808 @item rsqrt 
22809 Enable the reciprocal square root approximation instructions for both
22810 single and double precision.
22812 @item rsqrtf 
22813 Enable the single-precision reciprocal square root approximation instructions.
22815 @item rsqrtd 
22816 Enable the double-precision reciprocal square root approximation instructions.
22818 @end table
22820 So, for example, @option{-mrecip=all,!rsqrtd} enables
22821 all of the reciprocal estimate instructions, except for the
22822 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
22823 which handle the double-precision reciprocal square root calculations.
22825 @item -mrecip-precision
22826 @itemx -mno-recip-precision
22827 @opindex mrecip-precision
22828 Assume (do not assume) that the reciprocal estimate instructions
22829 provide higher-precision estimates than is mandated by the PowerPC
22830 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
22831 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
22832 The double-precision square root estimate instructions are not generated by
22833 default on low-precision machines, since they do not provide an
22834 estimate that converges after three steps.
22836 @item -mveclibabi=@var{type}
22837 @opindex mveclibabi
22838 Specifies the ABI type to use for vectorizing intrinsics using an
22839 external library.  The only type supported at present is @samp{mass},
22840 which specifies to use IBM's Mathematical Acceleration Subsystem
22841 (MASS) libraries for vectorizing intrinsics using external libraries.
22842 GCC currently emits calls to @code{acosd2}, @code{acosf4},
22843 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
22844 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
22845 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
22846 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
22847 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
22848 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
22849 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
22850 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
22851 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
22852 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
22853 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
22854 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
22855 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
22856 for power7.  Both @option{-ftree-vectorize} and
22857 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
22858 libraries must be specified at link time.
22860 @item -mfriz
22861 @itemx -mno-friz
22862 @opindex mfriz
22863 Generate (do not generate) the @code{friz} instruction when the
22864 @option{-funsafe-math-optimizations} option is used to optimize
22865 rounding of floating-point values to 64-bit integer and back to floating
22866 point.  The @code{friz} instruction does not return the same value if
22867 the floating-point number is too large to fit in an integer.
22869 @item -mpointers-to-nested-functions
22870 @itemx -mno-pointers-to-nested-functions
22871 @opindex mpointers-to-nested-functions
22872 Generate (do not generate) code to load up the static chain register
22873 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
22874 systems where a function pointer points to a 3-word descriptor giving
22875 the function address, TOC value to be loaded in register @code{r2}, and
22876 static chain value to be loaded in register @code{r11}.  The
22877 @option{-mpointers-to-nested-functions} is on by default.  You cannot
22878 call through pointers to nested functions or pointers
22879 to functions compiled in other languages that use the static chain if
22880 you use @option{-mno-pointers-to-nested-functions}.
22882 @item -msave-toc-indirect
22883 @itemx -mno-save-toc-indirect
22884 @opindex msave-toc-indirect
22885 Generate (do not generate) code to save the TOC value in the reserved
22886 stack location in the function prologue if the function calls through
22887 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
22888 saved in the prologue, it is saved just before the call through the
22889 pointer.  The @option{-mno-save-toc-indirect} option is the default.
22891 @item -mcompat-align-parm
22892 @itemx -mno-compat-align-parm
22893 @opindex mcompat-align-parm
22894 Generate (do not generate) code to pass structure parameters with a
22895 maximum alignment of 64 bits, for compatibility with older versions
22896 of GCC.
22898 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
22899 structure parameter on a 128-bit boundary when that structure contained
22900 a member requiring 128-bit alignment.  This is corrected in more
22901 recent versions of GCC.  This option may be used to generate code
22902 that is compatible with functions compiled with older versions of
22903 GCC.
22905 The @option{-mno-compat-align-parm} option is the default.
22907 @item -mstack-protector-guard=@var{guard}
22908 @itemx -mstack-protector-guard-reg=@var{reg}
22909 @itemx -mstack-protector-guard-offset=@var{offset}
22910 @itemx -mstack-protector-guard-symbol=@var{symbol}
22911 @opindex mstack-protector-guard
22912 @opindex mstack-protector-guard-reg
22913 @opindex mstack-protector-guard-offset
22914 @opindex mstack-protector-guard-symbol
22915 Generate stack protection code using canary at @var{guard}.  Supported
22916 locations are @samp{global} for global canary or @samp{tls} for per-thread
22917 canary in the TLS block (the default with GNU libc version 2.4 or later).
22919 With the latter choice the options
22920 @option{-mstack-protector-guard-reg=@var{reg}} and
22921 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
22922 which register to use as base register for reading the canary, and from what
22923 offset from that base register. The default for those is as specified in the
22924 relevant ABI.  @option{-mstack-protector-guard-symbol=@var{symbol}} overrides
22925 the offset with a symbol reference to a canary in the TLS block.
22926 @end table
22928 @node RX Options
22929 @subsection RX Options
22930 @cindex RX Options
22932 These command-line options are defined for RX targets:
22934 @table @gcctabopt
22935 @item -m64bit-doubles
22936 @itemx -m32bit-doubles
22937 @opindex m64bit-doubles
22938 @opindex m32bit-doubles
22939 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
22940 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
22941 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
22942 works on 32-bit values, which is why the default is
22943 @option{-m32bit-doubles}.
22945 @item -fpu
22946 @itemx -nofpu
22947 @opindex fpu
22948 @opindex nofpu
22949 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
22950 floating-point hardware.  The default is enabled for the RX600
22951 series and disabled for the RX200 series.
22953 Floating-point instructions are only generated for 32-bit floating-point 
22954 values, however, so the FPU hardware is not used for doubles if the
22955 @option{-m64bit-doubles} option is used.
22957 @emph{Note} If the @option{-fpu} option is enabled then
22958 @option{-funsafe-math-optimizations} is also enabled automatically.
22959 This is because the RX FPU instructions are themselves unsafe.
22961 @item -mcpu=@var{name}
22962 @opindex mcpu
22963 Selects the type of RX CPU to be targeted.  Currently three types are
22964 supported, the generic @samp{RX600} and @samp{RX200} series hardware and
22965 the specific @samp{RX610} CPU.  The default is @samp{RX600}.
22967 The only difference between @samp{RX600} and @samp{RX610} is that the
22968 @samp{RX610} does not support the @code{MVTIPL} instruction.
22970 The @samp{RX200} series does not have a hardware floating-point unit
22971 and so @option{-nofpu} is enabled by default when this type is
22972 selected.
22974 @item -mbig-endian-data
22975 @itemx -mlittle-endian-data
22976 @opindex mbig-endian-data
22977 @opindex mlittle-endian-data
22978 Store data (but not code) in the big-endian format.  The default is
22979 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
22980 format.
22982 @item -msmall-data-limit=@var{N}
22983 @opindex msmall-data-limit
22984 Specifies the maximum size in bytes of global and static variables
22985 which can be placed into the small data area.  Using the small data
22986 area can lead to smaller and faster code, but the size of area is
22987 limited and it is up to the programmer to ensure that the area does
22988 not overflow.  Also when the small data area is used one of the RX's
22989 registers (usually @code{r13}) is reserved for use pointing to this
22990 area, so it is no longer available for use by the compiler.  This
22991 could result in slower and/or larger code if variables are pushed onto
22992 the stack instead of being held in this register.
22994 Note, common variables (variables that have not been initialized) and
22995 constants are not placed into the small data area as they are assigned
22996 to other sections in the output executable.
22998 The default value is zero, which disables this feature.  Note, this
22999 feature is not enabled by default with higher optimization levels
23000 (@option{-O2} etc) because of the potentially detrimental effects of
23001 reserving a register.  It is up to the programmer to experiment and
23002 discover whether this feature is of benefit to their program.  See the
23003 description of the @option{-mpid} option for a description of how the
23004 actual register to hold the small data area pointer is chosen.
23006 @item -msim
23007 @itemx -mno-sim
23008 @opindex msim
23009 @opindex mno-sim
23010 Use the simulator runtime.  The default is to use the libgloss
23011 board-specific runtime.
23013 @item -mas100-syntax
23014 @itemx -mno-as100-syntax
23015 @opindex mas100-syntax
23016 @opindex mno-as100-syntax
23017 When generating assembler output use a syntax that is compatible with
23018 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
23019 assembler, but it has some restrictions so it is not generated by default.
23021 @item -mmax-constant-size=@var{N}
23022 @opindex mmax-constant-size
23023 Specifies the maximum size, in bytes, of a constant that can be used as
23024 an operand in a RX instruction.  Although the RX instruction set does
23025 allow constants of up to 4 bytes in length to be used in instructions,
23026 a longer value equates to a longer instruction.  Thus in some
23027 circumstances it can be beneficial to restrict the size of constants
23028 that are used in instructions.  Constants that are too big are instead
23029 placed into a constant pool and referenced via register indirection.
23031 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
23032 or 4 means that constants of any size are allowed.
23034 @item -mrelax
23035 @opindex mrelax
23036 Enable linker relaxation.  Linker relaxation is a process whereby the
23037 linker attempts to reduce the size of a program by finding shorter
23038 versions of various instructions.  Disabled by default.
23040 @item -mint-register=@var{N}
23041 @opindex mint-register
23042 Specify the number of registers to reserve for fast interrupt handler
23043 functions.  The value @var{N} can be between 0 and 4.  A value of 1
23044 means that register @code{r13} is reserved for the exclusive use
23045 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
23046 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
23047 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
23048 A value of 0, the default, does not reserve any registers.
23050 @item -msave-acc-in-interrupts
23051 @opindex msave-acc-in-interrupts
23052 Specifies that interrupt handler functions should preserve the
23053 accumulator register.  This is only necessary if normal code might use
23054 the accumulator register, for example because it performs 64-bit
23055 multiplications.  The default is to ignore the accumulator as this
23056 makes the interrupt handlers faster.
23058 @item -mpid
23059 @itemx -mno-pid
23060 @opindex mpid
23061 @opindex mno-pid
23062 Enables the generation of position independent data.  When enabled any
23063 access to constant data is done via an offset from a base address
23064 held in a register.  This allows the location of constant data to be
23065 determined at run time without requiring the executable to be
23066 relocated, which is a benefit to embedded applications with tight
23067 memory constraints.  Data that can be modified is not affected by this
23068 option.
23070 Note, using this feature reserves a register, usually @code{r13}, for
23071 the constant data base address.  This can result in slower and/or
23072 larger code, especially in complicated functions.
23074 The actual register chosen to hold the constant data base address
23075 depends upon whether the @option{-msmall-data-limit} and/or the
23076 @option{-mint-register} command-line options are enabled.  Starting
23077 with register @code{r13} and proceeding downwards, registers are
23078 allocated first to satisfy the requirements of @option{-mint-register},
23079 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
23080 is possible for the small data area register to be @code{r8} if both
23081 @option{-mint-register=4} and @option{-mpid} are specified on the
23082 command line.
23084 By default this feature is not enabled.  The default can be restored
23085 via the @option{-mno-pid} command-line option.
23087 @item -mno-warn-multiple-fast-interrupts
23088 @itemx -mwarn-multiple-fast-interrupts
23089 @opindex mno-warn-multiple-fast-interrupts
23090 @opindex mwarn-multiple-fast-interrupts
23091 Prevents GCC from issuing a warning message if it finds more than one
23092 fast interrupt handler when it is compiling a file.  The default is to
23093 issue a warning for each extra fast interrupt handler found, as the RX
23094 only supports one such interrupt.
23096 @item -mallow-string-insns
23097 @itemx -mno-allow-string-insns
23098 @opindex mallow-string-insns
23099 @opindex mno-allow-string-insns
23100 Enables or disables the use of the string manipulation instructions
23101 @code{SMOVF}, @code{SCMPU}, @code{SMOVB}, @code{SMOVU}, @code{SUNTIL}
23102 @code{SWHILE} and also the @code{RMPA} instruction.  These
23103 instructions may prefetch data, which is not safe to do if accessing
23104 an I/O register.  (See section 12.2.7 of the RX62N Group User's Manual
23105 for more information).
23107 The default is to allow these instructions, but it is not possible for
23108 GCC to reliably detect all circumstances where a string instruction
23109 might be used to access an I/O register, so their use cannot be
23110 disabled automatically.  Instead it is reliant upon the programmer to
23111 use the @option{-mno-allow-string-insns} option if their program
23112 accesses I/O space.
23114 When the instructions are enabled GCC defines the C preprocessor
23115 symbol @code{__RX_ALLOW_STRING_INSNS__}, otherwise it defines the
23116 symbol @code{__RX_DISALLOW_STRING_INSNS__}.
23118 @item -mjsr
23119 @itemx -mno-jsr
23120 @opindex mjsr
23121 @opindex mno-jsr
23122 Use only (or not only) @code{JSR} instructions to access functions.
23123 This option can be used when code size exceeds the range of @code{BSR}
23124 instructions.  Note that @option{-mno-jsr} does not mean to not use
23125 @code{JSR} but instead means that any type of branch may be used.
23126 @end table
23128 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
23129 has special significance to the RX port when used with the
23130 @code{interrupt} function attribute.  This attribute indicates a
23131 function intended to process fast interrupts.  GCC ensures
23132 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
23133 and/or @code{r13} and only provided that the normal use of the
23134 corresponding registers have been restricted via the
23135 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
23136 options.
23138 @node S/390 and zSeries Options
23139 @subsection S/390 and zSeries Options
23140 @cindex S/390 and zSeries Options
23142 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
23144 @table @gcctabopt
23145 @item -mhard-float
23146 @itemx -msoft-float
23147 @opindex mhard-float
23148 @opindex msoft-float
23149 Use (do not use) the hardware floating-point instructions and registers
23150 for floating-point operations.  When @option{-msoft-float} is specified,
23151 functions in @file{libgcc.a} are used to perform floating-point
23152 operations.  When @option{-mhard-float} is specified, the compiler
23153 generates IEEE floating-point instructions.  This is the default.
23155 @item -mhard-dfp
23156 @itemx -mno-hard-dfp
23157 @opindex mhard-dfp
23158 @opindex mno-hard-dfp
23159 Use (do not use) the hardware decimal-floating-point instructions for
23160 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
23161 specified, functions in @file{libgcc.a} are used to perform
23162 decimal-floating-point operations.  When @option{-mhard-dfp} is
23163 specified, the compiler generates decimal-floating-point hardware
23164 instructions.  This is the default for @option{-march=z9-ec} or higher.
23166 @item -mlong-double-64
23167 @itemx -mlong-double-128
23168 @opindex mlong-double-64
23169 @opindex mlong-double-128
23170 These switches control the size of @code{long double} type. A size
23171 of 64 bits makes the @code{long double} type equivalent to the @code{double}
23172 type. This is the default.
23174 @item -mbackchain
23175 @itemx -mno-backchain
23176 @opindex mbackchain
23177 @opindex mno-backchain
23178 Store (do not store) the address of the caller's frame as backchain pointer
23179 into the callee's stack frame.
23180 A backchain may be needed to allow debugging using tools that do not understand
23181 DWARF call frame information.
23182 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
23183 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
23184 the backchain is placed into the topmost word of the 96/160 byte register
23185 save area.
23187 In general, code compiled with @option{-mbackchain} is call-compatible with
23188 code compiled with @option{-mmo-backchain}; however, use of the backchain
23189 for debugging purposes usually requires that the whole binary is built with
23190 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
23191 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
23192 to build a linux kernel use @option{-msoft-float}.
23194 The default is to not maintain the backchain.
23196 @item -mpacked-stack
23197 @itemx -mno-packed-stack
23198 @opindex mpacked-stack
23199 @opindex mno-packed-stack
23200 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
23201 specified, the compiler uses the all fields of the 96/160 byte register save
23202 area only for their default purpose; unused fields still take up stack space.
23203 When @option{-mpacked-stack} is specified, register save slots are densely
23204 packed at the top of the register save area; unused space is reused for other
23205 purposes, allowing for more efficient use of the available stack space.
23206 However, when @option{-mbackchain} is also in effect, the topmost word of
23207 the save area is always used to store the backchain, and the return address
23208 register is always saved two words below the backchain.
23210 As long as the stack frame backchain is not used, code generated with
23211 @option{-mpacked-stack} is call-compatible with code generated with
23212 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
23213 S/390 or zSeries generated code that uses the stack frame backchain at run
23214 time, not just for debugging purposes.  Such code is not call-compatible
23215 with code compiled with @option{-mpacked-stack}.  Also, note that the
23216 combination of @option{-mbackchain},
23217 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
23218 to build a linux kernel use @option{-msoft-float}.
23220 The default is to not use the packed stack layout.
23222 @item -msmall-exec
23223 @itemx -mno-small-exec
23224 @opindex msmall-exec
23225 @opindex mno-small-exec
23226 Generate (or do not generate) code using the @code{bras} instruction
23227 to do subroutine calls.
23228 This only works reliably if the total executable size does not
23229 exceed 64k.  The default is to use the @code{basr} instruction instead,
23230 which does not have this limitation.
23232 @item -m64
23233 @itemx -m31
23234 @opindex m64
23235 @opindex m31
23236 When @option{-m31} is specified, generate code compliant to the
23237 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
23238 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
23239 particular to generate 64-bit instructions.  For the @samp{s390}
23240 targets, the default is @option{-m31}, while the @samp{s390x}
23241 targets default to @option{-m64}.
23243 @item -mzarch
23244 @itemx -mesa
23245 @opindex mzarch
23246 @opindex mesa
23247 When @option{-mzarch} is specified, generate code using the
23248 instructions available on z/Architecture.
23249 When @option{-mesa} is specified, generate code using the
23250 instructions available on ESA/390.  Note that @option{-mesa} is
23251 not possible with @option{-m64}.
23252 When generating code compliant to the GNU/Linux for S/390 ABI,
23253 the default is @option{-mesa}.  When generating code compliant
23254 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
23256 @item -mhtm
23257 @itemx -mno-htm
23258 @opindex mhtm
23259 @opindex mno-htm
23260 The @option{-mhtm} option enables a set of builtins making use of
23261 instructions available with the transactional execution facility
23262 introduced with the IBM zEnterprise EC12 machine generation
23263 @ref{S/390 System z Built-in Functions}.
23264 @option{-mhtm} is enabled by default when using @option{-march=zEC12}.
23266 @item -mvx
23267 @itemx -mno-vx
23268 @opindex mvx
23269 @opindex mno-vx
23270 When @option{-mvx} is specified, generate code using the instructions
23271 available with the vector extension facility introduced with the IBM
23272 z13 machine generation.
23273 This option changes the ABI for some vector type values with regard to
23274 alignment and calling conventions.  In case vector type values are
23275 being used in an ABI-relevant context a GAS @samp{.gnu_attribute}
23276 command will be added to mark the resulting binary with the ABI used.
23277 @option{-mvx} is enabled by default when using @option{-march=z13}.
23279 @item -mzvector
23280 @itemx -mno-zvector
23281 @opindex mzvector
23282 @opindex mno-zvector
23283 The @option{-mzvector} option enables vector language extensions and
23284 builtins using instructions available with the vector extension
23285 facility introduced with the IBM z13 machine generation.
23286 This option adds support for @samp{vector} to be used as a keyword to
23287 define vector type variables and arguments.  @samp{vector} is only
23288 available when GNU extensions are enabled.  It will not be expanded
23289 when requesting strict standard compliance e.g. with @option{-std=c99}.
23290 In addition to the GCC low-level builtins @option{-mzvector} enables
23291 a set of builtins added for compatibility with AltiVec-style
23292 implementations like Power and Cell.  In order to make use of these
23293 builtins the header file @file{vecintrin.h} needs to be included.
23294 @option{-mzvector} is disabled by default.
23296 @item -mmvcle
23297 @itemx -mno-mvcle
23298 @opindex mmvcle
23299 @opindex mno-mvcle
23300 Generate (or do not generate) code using the @code{mvcle} instruction
23301 to perform block moves.  When @option{-mno-mvcle} is specified,
23302 use a @code{mvc} loop instead.  This is the default unless optimizing for
23303 size.
23305 @item -mdebug
23306 @itemx -mno-debug
23307 @opindex mdebug
23308 @opindex mno-debug
23309 Print (or do not print) additional debug information when compiling.
23310 The default is to not print debug information.
23312 @item -march=@var{cpu-type}
23313 @opindex march
23314 Generate code that runs on @var{cpu-type}, which is the name of a
23315 system representing a certain processor type.  Possible values for
23316 @var{cpu-type} are @samp{z900}/@samp{arch5}, @samp{z990}/@samp{arch6},
23317 @samp{z9-109}, @samp{z9-ec}/@samp{arch7}, @samp{z10}/@samp{arch8},
23318 @samp{z196}/@samp{arch9}, @samp{zEC12}, @samp{z13}/@samp{arch11}, and
23319 @samp{native}.
23321 The default is @option{-march=z900}.  @samp{g5}/@samp{arch3} and
23322 @samp{g6} are deprecated and will be removed with future releases.
23324 Specifying @samp{native} as cpu type can be used to select the best
23325 architecture option for the host processor.
23326 @option{-march=native} has no effect if GCC does not recognize the
23327 processor.
23329 @item -mtune=@var{cpu-type}
23330 @opindex mtune
23331 Tune to @var{cpu-type} everything applicable about the generated code,
23332 except for the ABI and the set of available instructions.
23333 The list of @var{cpu-type} values is the same as for @option{-march}.
23334 The default is the value used for @option{-march}.
23336 @item -mtpf-trace
23337 @itemx -mno-tpf-trace
23338 @opindex mtpf-trace
23339 @opindex mno-tpf-trace
23340 Generate code that adds (does not add) in TPF OS specific branches to trace
23341 routines in the operating system.  This option is off by default, even
23342 when compiling for the TPF OS@.
23344 @item -mfused-madd
23345 @itemx -mno-fused-madd
23346 @opindex mfused-madd
23347 @opindex mno-fused-madd
23348 Generate code that uses (does not use) the floating-point multiply and
23349 accumulate instructions.  These instructions are generated by default if
23350 hardware floating point is used.
23352 @item -mwarn-framesize=@var{framesize}
23353 @opindex mwarn-framesize
23354 Emit a warning if the current function exceeds the given frame size.  Because
23355 this is a compile-time check it doesn't need to be a real problem when the program
23356 runs.  It is intended to identify functions that most probably cause
23357 a stack overflow.  It is useful to be used in an environment with limited stack
23358 size e.g.@: the linux kernel.
23360 @item -mwarn-dynamicstack
23361 @opindex mwarn-dynamicstack
23362 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
23363 arrays.  This is generally a bad idea with a limited stack size.
23365 @item -mstack-guard=@var{stack-guard}
23366 @itemx -mstack-size=@var{stack-size}
23367 @opindex mstack-guard
23368 @opindex mstack-size
23369 If these options are provided the S/390 back end emits additional instructions in
23370 the function prologue that trigger a trap if the stack size is @var{stack-guard}
23371 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
23372 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
23373 the frame size of the compiled function is chosen.
23374 These options are intended to be used to help debugging stack overflow problems.
23375 The additionally emitted code causes only little overhead and hence can also be
23376 used in production-like systems without greater performance degradation.  The given
23377 values have to be exact powers of 2 and @var{stack-size} has to be greater than
23378 @var{stack-guard} without exceeding 64k.
23379 In order to be efficient the extra code makes the assumption that the stack starts
23380 at an address aligned to the value given by @var{stack-size}.
23381 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
23383 @item -mhotpatch=@var{pre-halfwords},@var{post-halfwords}
23384 @opindex mhotpatch
23385 If the hotpatch option is enabled, a ``hot-patching'' function
23386 prologue is generated for all functions in the compilation unit.
23387 The funtion label is prepended with the given number of two-byte
23388 NOP instructions (@var{pre-halfwords}, maximum 1000000).  After
23389 the label, 2 * @var{post-halfwords} bytes are appended, using the
23390 largest NOP like instructions the architecture allows (maximum
23391 1000000).
23393 If both arguments are zero, hotpatching is disabled.
23395 This option can be overridden for individual functions with the
23396 @code{hotpatch} attribute.
23397 @end table
23399 @node Score Options
23400 @subsection Score Options
23401 @cindex Score Options
23403 These options are defined for Score implementations:
23405 @table @gcctabopt
23406 @item -meb
23407 @opindex meb
23408 Compile code for big-endian mode.  This is the default.
23410 @item -mel
23411 @opindex mel
23412 Compile code for little-endian mode.
23414 @item -mnhwloop
23415 @opindex mnhwloop
23416 Disable generation of @code{bcnz} instructions.
23418 @item -muls
23419 @opindex muls
23420 Enable generation of unaligned load and store instructions.
23422 @item -mmac
23423 @opindex mmac
23424 Enable the use of multiply-accumulate instructions. Disabled by default.
23426 @item -mscore5
23427 @opindex mscore5
23428 Specify the SCORE5 as the target architecture.
23430 @item -mscore5u
23431 @opindex mscore5u
23432 Specify the SCORE5U of the target architecture.
23434 @item -mscore7
23435 @opindex mscore7
23436 Specify the SCORE7 as the target architecture. This is the default.
23438 @item -mscore7d
23439 @opindex mscore7d
23440 Specify the SCORE7D as the target architecture.
23441 @end table
23443 @node SH Options
23444 @subsection SH Options
23446 These @samp{-m} options are defined for the SH implementations:
23448 @table @gcctabopt
23449 @item -m1
23450 @opindex m1
23451 Generate code for the SH1.
23453 @item -m2
23454 @opindex m2
23455 Generate code for the SH2.
23457 @item -m2e
23458 Generate code for the SH2e.
23460 @item -m2a-nofpu
23461 @opindex m2a-nofpu
23462 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
23463 that the floating-point unit is not used.
23465 @item -m2a-single-only
23466 @opindex m2a-single-only
23467 Generate code for the SH2a-FPU, in such a way that no double-precision
23468 floating-point operations are used.
23470 @item -m2a-single
23471 @opindex m2a-single
23472 Generate code for the SH2a-FPU assuming the floating-point unit is in
23473 single-precision mode by default.
23475 @item -m2a
23476 @opindex m2a
23477 Generate code for the SH2a-FPU assuming the floating-point unit is in
23478 double-precision mode by default.
23480 @item -m3
23481 @opindex m3
23482 Generate code for the SH3.
23484 @item -m3e
23485 @opindex m3e
23486 Generate code for the SH3e.
23488 @item -m4-nofpu
23489 @opindex m4-nofpu
23490 Generate code for the SH4 without a floating-point unit.
23492 @item -m4-single-only
23493 @opindex m4-single-only
23494 Generate code for the SH4 with a floating-point unit that only
23495 supports single-precision arithmetic.
23497 @item -m4-single
23498 @opindex m4-single
23499 Generate code for the SH4 assuming the floating-point unit is in
23500 single-precision mode by default.
23502 @item -m4
23503 @opindex m4
23504 Generate code for the SH4.
23506 @item -m4-100
23507 @opindex m4-100
23508 Generate code for SH4-100.
23510 @item -m4-100-nofpu
23511 @opindex m4-100-nofpu
23512 Generate code for SH4-100 in such a way that the
23513 floating-point unit is not used.
23515 @item -m4-100-single
23516 @opindex m4-100-single
23517 Generate code for SH4-100 assuming the floating-point unit is in
23518 single-precision mode by default.
23520 @item -m4-100-single-only
23521 @opindex m4-100-single-only
23522 Generate code for SH4-100 in such a way that no double-precision
23523 floating-point operations are used.
23525 @item -m4-200
23526 @opindex m4-200
23527 Generate code for SH4-200.
23529 @item -m4-200-nofpu
23530 @opindex m4-200-nofpu
23531 Generate code for SH4-200 without in such a way that the
23532 floating-point unit is not used.
23534 @item -m4-200-single
23535 @opindex m4-200-single
23536 Generate code for SH4-200 assuming the floating-point unit is in
23537 single-precision mode by default.
23539 @item -m4-200-single-only
23540 @opindex m4-200-single-only
23541 Generate code for SH4-200 in such a way that no double-precision
23542 floating-point operations are used.
23544 @item -m4-300
23545 @opindex m4-300
23546 Generate code for SH4-300.
23548 @item -m4-300-nofpu
23549 @opindex m4-300-nofpu
23550 Generate code for SH4-300 without in such a way that the
23551 floating-point unit is not used.
23553 @item -m4-300-single
23554 @opindex m4-300-single
23555 Generate code for SH4-300 in such a way that no double-precision
23556 floating-point operations are used.
23558 @item -m4-300-single-only
23559 @opindex m4-300-single-only
23560 Generate code for SH4-300 in such a way that no double-precision
23561 floating-point operations are used.
23563 @item -m4-340
23564 @opindex m4-340
23565 Generate code for SH4-340 (no MMU, no FPU).
23567 @item -m4-500
23568 @opindex m4-500
23569 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
23570 assembler.
23572 @item -m4a-nofpu
23573 @opindex m4a-nofpu
23574 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
23575 floating-point unit is not used.
23577 @item -m4a-single-only
23578 @opindex m4a-single-only
23579 Generate code for the SH4a, in such a way that no double-precision
23580 floating-point operations are used.
23582 @item -m4a-single
23583 @opindex m4a-single
23584 Generate code for the SH4a assuming the floating-point unit is in
23585 single-precision mode by default.
23587 @item -m4a
23588 @opindex m4a
23589 Generate code for the SH4a.
23591 @item -m4al
23592 @opindex m4al
23593 Same as @option{-m4a-nofpu}, except that it implicitly passes
23594 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
23595 instructions at the moment.
23597 @item -mb
23598 @opindex mb
23599 Compile code for the processor in big-endian mode.
23601 @item -ml
23602 @opindex ml
23603 Compile code for the processor in little-endian mode.
23605 @item -mdalign
23606 @opindex mdalign
23607 Align doubles at 64-bit boundaries.  Note that this changes the calling
23608 conventions, and thus some functions from the standard C library do
23609 not work unless you recompile it first with @option{-mdalign}.
23611 @item -mrelax
23612 @opindex mrelax
23613 Shorten some address references at link time, when possible; uses the
23614 linker option @option{-relax}.
23616 @item -mbigtable
23617 @opindex mbigtable
23618 Use 32-bit offsets in @code{switch} tables.  The default is to use
23619 16-bit offsets.
23621 @item -mbitops
23622 @opindex mbitops
23623 Enable the use of bit manipulation instructions on SH2A.
23625 @item -mfmovd
23626 @opindex mfmovd
23627 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
23628 alignment constraints.
23630 @item -mrenesas
23631 @opindex mrenesas
23632 Comply with the calling conventions defined by Renesas.
23634 @item -mno-renesas
23635 @opindex mno-renesas
23636 Comply with the calling conventions defined for GCC before the Renesas
23637 conventions were available.  This option is the default for all
23638 targets of the SH toolchain.
23640 @item -mnomacsave
23641 @opindex mnomacsave
23642 Mark the @code{MAC} register as call-clobbered, even if
23643 @option{-mrenesas} is given.
23645 @item -mieee
23646 @itemx -mno-ieee
23647 @opindex mieee
23648 @opindex mno-ieee
23649 Control the IEEE compliance of floating-point comparisons, which affects the
23650 handling of cases where the result of a comparison is unordered.  By default
23651 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
23652 enabled @option{-mno-ieee} is implicitly set, which results in faster
23653 floating-point greater-equal and less-equal comparisons.  The implicit settings
23654 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
23656 @item -minline-ic_invalidate
23657 @opindex minline-ic_invalidate
23658 Inline code to invalidate instruction cache entries after setting up
23659 nested function trampolines.
23660 This option has no effect if @option{-musermode} is in effect and the selected
23661 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
23662 instruction.
23663 If the selected code generation option does not allow the use of the @code{icbi}
23664 instruction, and @option{-musermode} is not in effect, the inlined code
23665 manipulates the instruction cache address array directly with an associative
23666 write.  This not only requires privileged mode at run time, but it also
23667 fails if the cache line had been mapped via the TLB and has become unmapped.
23669 @item -misize
23670 @opindex misize
23671 Dump instruction size and location in the assembly code.
23673 @item -mpadstruct
23674 @opindex mpadstruct
23675 This option is deprecated.  It pads structures to multiple of 4 bytes,
23676 which is incompatible with the SH ABI@.
23678 @item -matomic-model=@var{model}
23679 @opindex matomic-model=@var{model}
23680 Sets the model of atomic operations and additional parameters as a comma
23681 separated list.  For details on the atomic built-in functions see
23682 @ref{__atomic Builtins}.  The following models and parameters are supported:
23684 @table @samp
23686 @item none
23687 Disable compiler generated atomic sequences and emit library calls for atomic
23688 operations.  This is the default if the target is not @code{sh*-*-linux*}.
23690 @item soft-gusa
23691 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
23692 built-in functions.  The generated atomic sequences require additional support
23693 from the interrupt/exception handling code of the system and are only suitable
23694 for SH3* and SH4* single-core systems.  This option is enabled by default when
23695 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
23696 this option also partially utilizes the hardware atomic instructions
23697 @code{movli.l} and @code{movco.l} to create more efficient code, unless
23698 @samp{strict} is specified.  
23700 @item soft-tcb
23701 Generate software atomic sequences that use a variable in the thread control
23702 block.  This is a variation of the gUSA sequences which can also be used on
23703 SH1* and SH2* targets.  The generated atomic sequences require additional
23704 support from the interrupt/exception handling code of the system and are only
23705 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
23706 parameter has to be specified as well.
23708 @item soft-imask
23709 Generate software atomic sequences that temporarily disable interrupts by
23710 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
23711 in privileged mode and is only suitable for single-core systems.  Additional
23712 support from the interrupt/exception handling code of the system is not
23713 required.  This model is enabled by default when the target is
23714 @code{sh*-*-linux*} and SH1* or SH2*.
23716 @item hard-llcs
23717 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
23718 instructions only.  This is only available on SH4A and is suitable for
23719 multi-core systems.  Since the hardware instructions support only 32 bit atomic
23720 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
23721 Code compiled with this option is also compatible with other software
23722 atomic model interrupt/exception handling systems if executed on an SH4A
23723 system.  Additional support from the interrupt/exception handling code of the
23724 system is not required for this model.
23726 @item gbr-offset=
23727 This parameter specifies the offset in bytes of the variable in the thread
23728 control block structure that should be used by the generated atomic sequences
23729 when the @samp{soft-tcb} model has been selected.  For other models this
23730 parameter is ignored.  The specified value must be an integer multiple of four
23731 and in the range 0-1020.
23733 @item strict
23734 This parameter prevents mixed usage of multiple atomic models, even if they
23735 are compatible, and makes the compiler generate atomic sequences of the
23736 specified model only.
23738 @end table
23740 @item -mtas
23741 @opindex mtas
23742 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
23743 Notice that depending on the particular hardware and software configuration
23744 this can degrade overall performance due to the operand cache line flushes
23745 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
23746 processors the @code{tas.b} instruction must be used with caution since it
23747 can result in data corruption for certain cache configurations.
23749 @item -mprefergot
23750 @opindex mprefergot
23751 When generating position-independent code, emit function calls using
23752 the Global Offset Table instead of the Procedure Linkage Table.
23754 @item -musermode
23755 @itemx -mno-usermode
23756 @opindex musermode
23757 @opindex mno-usermode
23758 Don't allow (allow) the compiler generating privileged mode code.  Specifying
23759 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
23760 inlined code would not work in user mode.  @option{-musermode} is the default
23761 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
23762 @option{-musermode} has no effect, since there is no user mode.
23764 @item -multcost=@var{number}
23765 @opindex multcost=@var{number}
23766 Set the cost to assume for a multiply insn.
23768 @item -mdiv=@var{strategy}
23769 @opindex mdiv=@var{strategy}
23770 Set the division strategy to be used for integer division operations.
23771 @var{strategy} can be one of: 
23773 @table @samp
23775 @item call-div1
23776 Calls a library function that uses the single-step division instruction
23777 @code{div1} to perform the operation.  Division by zero calculates an
23778 unspecified result and does not trap.  This is the default except for SH4,
23779 SH2A and SHcompact.
23781 @item call-fp
23782 Calls a library function that performs the operation in double precision
23783 floating point.  Division by zero causes a floating-point exception.  This is
23784 the default for SHcompact with FPU.  Specifying this for targets that do not
23785 have a double precision FPU defaults to @code{call-div1}.
23787 @item call-table
23788 Calls a library function that uses a lookup table for small divisors and
23789 the @code{div1} instruction with case distinction for larger divisors.  Division
23790 by zero calculates an unspecified result and does not trap.  This is the default
23791 for SH4.  Specifying this for targets that do not have dynamic shift
23792 instructions defaults to @code{call-div1}.
23794 @end table
23796 When a division strategy has not been specified the default strategy is
23797 selected based on the current target.  For SH2A the default strategy is to
23798 use the @code{divs} and @code{divu} instructions instead of library function
23799 calls.
23801 @item -maccumulate-outgoing-args
23802 @opindex maccumulate-outgoing-args
23803 Reserve space once for outgoing arguments in the function prologue rather
23804 than around each call.  Generally beneficial for performance and size.  Also
23805 needed for unwinding to avoid changing the stack frame around conditional code.
23807 @item -mdivsi3_libfunc=@var{name}
23808 @opindex mdivsi3_libfunc=@var{name}
23809 Set the name of the library function used for 32-bit signed division to
23810 @var{name}.
23811 This only affects the name used in the @samp{call} division strategies, and
23812 the compiler still expects the same sets of input/output/clobbered registers as
23813 if this option were not present.
23815 @item -mfixed-range=@var{register-range}
23816 @opindex mfixed-range
23817 Generate code treating the given register range as fixed registers.
23818 A fixed register is one that the register allocator can not use.  This is
23819 useful when compiling kernel code.  A register range is specified as
23820 two registers separated by a dash.  Multiple register ranges can be
23821 specified separated by a comma.
23823 @item -mbranch-cost=@var{num}
23824 @opindex mbranch-cost=@var{num}
23825 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
23826 make the compiler try to generate more branch-free code if possible.  
23827 If not specified the value is selected depending on the processor type that
23828 is being compiled for.
23830 @item -mzdcbranch
23831 @itemx -mno-zdcbranch
23832 @opindex mzdcbranch
23833 @opindex mno-zdcbranch
23834 Assume (do not assume) that zero displacement conditional branch instructions
23835 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
23836 compiler prefers zero displacement branch code sequences.  This is
23837 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
23838 disabled by specifying @option{-mno-zdcbranch}.
23840 @item -mcbranch-force-delay-slot
23841 @opindex mcbranch-force-delay-slot
23842 Force the usage of delay slots for conditional branches, which stuffs the delay
23843 slot with a @code{nop} if a suitable instruction cannot be found.  By default
23844 this option is disabled.  It can be enabled to work around hardware bugs as
23845 found in the original SH7055.
23847 @item -mfused-madd
23848 @itemx -mno-fused-madd
23849 @opindex mfused-madd
23850 @opindex mno-fused-madd
23851 Generate code that uses (does not use) the floating-point multiply and
23852 accumulate instructions.  These instructions are generated by default
23853 if hardware floating point is used.  The machine-dependent
23854 @option{-mfused-madd} option is now mapped to the machine-independent
23855 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
23856 mapped to @option{-ffp-contract=off}.
23858 @item -mfsca
23859 @itemx -mno-fsca
23860 @opindex mfsca
23861 @opindex mno-fsca
23862 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
23863 and cosine approximations.  The option @option{-mfsca} must be used in
23864 combination with @option{-funsafe-math-optimizations}.  It is enabled by default
23865 when generating code for SH4A.  Using @option{-mno-fsca} disables sine and cosine
23866 approximations even if @option{-funsafe-math-optimizations} is in effect.
23868 @item -mfsrra
23869 @itemx -mno-fsrra
23870 @opindex mfsrra
23871 @opindex mno-fsrra
23872 Allow or disallow the compiler to emit the @code{fsrra} instruction for
23873 reciprocal square root approximations.  The option @option{-mfsrra} must be used
23874 in combination with @option{-funsafe-math-optimizations} and
23875 @option{-ffinite-math-only}.  It is enabled by default when generating code for
23876 SH4A.  Using @option{-mno-fsrra} disables reciprocal square root approximations
23877 even if @option{-funsafe-math-optimizations} and @option{-ffinite-math-only} are
23878 in effect.
23880 @item -mpretend-cmove
23881 @opindex mpretend-cmove
23882 Prefer zero-displacement conditional branches for conditional move instruction
23883 patterns.  This can result in faster code on the SH4 processor.
23885 @item -mfdpic
23886 @opindex fdpic
23887 Generate code using the FDPIC ABI.
23889 @end table
23891 @node Solaris 2 Options
23892 @subsection Solaris 2 Options
23893 @cindex Solaris 2 options
23895 These @samp{-m} options are supported on Solaris 2:
23897 @table @gcctabopt
23898 @item -mclear-hwcap
23899 @opindex mclear-hwcap
23900 @option{-mclear-hwcap} tells the compiler to remove the hardware
23901 capabilities generated by the Solaris assembler.  This is only necessary
23902 when object files use ISA extensions not supported by the current
23903 machine, but check at runtime whether or not to use them.
23905 @item -mimpure-text
23906 @opindex mimpure-text
23907 @option{-mimpure-text}, used in addition to @option{-shared}, tells
23908 the compiler to not pass @option{-z text} to the linker when linking a
23909 shared object.  Using this option, you can link position-dependent
23910 code into a shared object.
23912 @option{-mimpure-text} suppresses the ``relocations remain against
23913 allocatable but non-writable sections'' linker error message.
23914 However, the necessary relocations trigger copy-on-write, and the
23915 shared object is not actually shared across processes.  Instead of
23916 using @option{-mimpure-text}, you should compile all source code with
23917 @option{-fpic} or @option{-fPIC}.
23919 @end table
23921 These switches are supported in addition to the above on Solaris 2:
23923 @table @gcctabopt
23924 @item -pthreads
23925 @opindex pthreads
23926 This is a synonym for @option{-pthread}.
23927 @end table
23929 @node SPARC Options
23930 @subsection SPARC Options
23931 @cindex SPARC options
23933 These @samp{-m} options are supported on the SPARC:
23935 @table @gcctabopt
23936 @item -mno-app-regs
23937 @itemx -mapp-regs
23938 @opindex mno-app-regs
23939 @opindex mapp-regs
23940 Specify @option{-mapp-regs} to generate output using the global registers
23941 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
23942 global register 1, each global register 2 through 4 is then treated as an
23943 allocable register that is clobbered by function calls.  This is the default.
23945 To be fully SVR4 ABI-compliant at the cost of some performance loss,
23946 specify @option{-mno-app-regs}.  You should compile libraries and system
23947 software with this option.
23949 @item -mflat
23950 @itemx -mno-flat
23951 @opindex mflat
23952 @opindex mno-flat
23953 With @option{-mflat}, the compiler does not generate save/restore instructions
23954 and uses a ``flat'' or single register window model.  This model is compatible
23955 with the regular register window model.  The local registers and the input
23956 registers (0--5) are still treated as ``call-saved'' registers and are
23957 saved on the stack as needed.
23959 With @option{-mno-flat} (the default), the compiler generates save/restore
23960 instructions (except for leaf functions).  This is the normal operating mode.
23962 @item -mfpu
23963 @itemx -mhard-float
23964 @opindex mfpu
23965 @opindex mhard-float
23966 Generate output containing floating-point instructions.  This is the
23967 default.
23969 @item -mno-fpu
23970 @itemx -msoft-float
23971 @opindex mno-fpu
23972 @opindex msoft-float
23973 Generate output containing library calls for floating point.
23974 @strong{Warning:} the requisite libraries are not available for all SPARC
23975 targets.  Normally the facilities of the machine's usual C compiler are
23976 used, but this cannot be done directly in cross-compilation.  You must make
23977 your own arrangements to provide suitable library functions for
23978 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
23979 @samp{sparclite-*-*} do provide software floating-point support.
23981 @option{-msoft-float} changes the calling convention in the output file;
23982 therefore, it is only useful if you compile @emph{all} of a program with
23983 this option.  In particular, you need to compile @file{libgcc.a}, the
23984 library that comes with GCC, with @option{-msoft-float} in order for
23985 this to work.
23987 @item -mhard-quad-float
23988 @opindex mhard-quad-float
23989 Generate output containing quad-word (long double) floating-point
23990 instructions.
23992 @item -msoft-quad-float
23993 @opindex msoft-quad-float
23994 Generate output containing library calls for quad-word (long double)
23995 floating-point instructions.  The functions called are those specified
23996 in the SPARC ABI@.  This is the default.
23998 As of this writing, there are no SPARC implementations that have hardware
23999 support for the quad-word floating-point instructions.  They all invoke
24000 a trap handler for one of these instructions, and then the trap handler
24001 emulates the effect of the instruction.  Because of the trap handler overhead,
24002 this is much slower than calling the ABI library routines.  Thus the
24003 @option{-msoft-quad-float} option is the default.
24005 @item -mno-unaligned-doubles
24006 @itemx -munaligned-doubles
24007 @opindex mno-unaligned-doubles
24008 @opindex munaligned-doubles
24009 Assume that doubles have 8-byte alignment.  This is the default.
24011 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
24012 alignment only if they are contained in another type, or if they have an
24013 absolute address.  Otherwise, it assumes they have 4-byte alignment.
24014 Specifying this option avoids some rare compatibility problems with code
24015 generated by other compilers.  It is not the default because it results
24016 in a performance loss, especially for floating-point code.
24018 @item -muser-mode
24019 @itemx -mno-user-mode
24020 @opindex muser-mode
24021 @opindex mno-user-mode
24022 Do not generate code that can only run in supervisor mode.  This is relevant
24023 only for the @code{casa} instruction emitted for the LEON3 processor.  This
24024 is the default.
24026 @item -mfaster-structs
24027 @itemx -mno-faster-structs
24028 @opindex mfaster-structs
24029 @opindex mno-faster-structs
24030 With @option{-mfaster-structs}, the compiler assumes that structures
24031 should have 8-byte alignment.  This enables the use of pairs of
24032 @code{ldd} and @code{std} instructions for copies in structure
24033 assignment, in place of twice as many @code{ld} and @code{st} pairs.
24034 However, the use of this changed alignment directly violates the SPARC
24035 ABI@.  Thus, it's intended only for use on targets where the developer
24036 acknowledges that their resulting code is not directly in line with
24037 the rules of the ABI@.
24039 @item -mstd-struct-return
24040 @itemx -mno-std-struct-return
24041 @opindex mstd-struct-return
24042 @opindex mno-std-struct-return
24043 With @option{-mstd-struct-return}, the compiler generates checking code
24044 in functions returning structures or unions to detect size mismatches
24045 between the two sides of function calls, as per the 32-bit ABI@.
24047 The default is @option{-mno-std-struct-return}.  This option has no effect
24048 in 64-bit mode.
24050 @item -mlra
24051 @itemx -mno-lra
24052 @opindex mlra
24053 @opindex mno-lra
24054 Enable Local Register Allocation.  This is the default for SPARC since GCC 7
24055 so @option{-mno-lra} needs to be passed to get old Reload.
24057 @item -mcpu=@var{cpu_type}
24058 @opindex mcpu
24059 Set the instruction set, register set, and instruction scheduling parameters
24060 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
24061 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
24062 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
24063 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
24064 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
24065 @samp{niagara3}, @samp{niagara4}, @samp{niagara7} and @samp{m8}.
24067 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
24068 which selects the best architecture option for the host processor.
24069 @option{-mcpu=native} has no effect if GCC does not recognize
24070 the processor.
24072 Default instruction scheduling parameters are used for values that select
24073 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
24074 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
24076 Here is a list of each supported architecture and their supported
24077 implementations.
24079 @table @asis
24080 @item v7
24081 cypress, leon3v7
24083 @item v8
24084 supersparc, hypersparc, leon, leon3
24086 @item sparclite
24087 f930, f934, sparclite86x
24089 @item sparclet
24090 tsc701
24092 @item v9
24093 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4,
24094 niagara7, m8
24095 @end table
24097 By default (unless configured otherwise), GCC generates code for the V7
24098 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
24099 additionally optimizes it for the Cypress CY7C602 chip, as used in the
24100 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
24101 SPARCStation 1, 2, IPX etc.
24103 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
24104 architecture.  The only difference from V7 code is that the compiler emits
24105 the integer multiply and integer divide instructions which exist in SPARC-V8
24106 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
24107 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
24108 2000 series.
24110 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
24111 the SPARC architecture.  This adds the integer multiply, integer divide step
24112 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
24113 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
24114 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
24115 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
24116 MB86934 chip, which is the more recent SPARClite with FPU@.
24118 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
24119 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
24120 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
24121 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
24122 optimizes it for the TEMIC SPARClet chip.
24124 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
24125 architecture.  This adds 64-bit integer and floating-point move instructions,
24126 3 additional floating-point condition code registers and conditional move
24127 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
24128 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
24129 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
24130 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
24131 @option{-mcpu=niagara}, the compiler additionally optimizes it for
24132 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
24133 additionally optimizes it for Sun UltraSPARC T2 chips. With
24134 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
24135 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
24136 additionally optimizes it for Sun UltraSPARC T4 chips.  With
24137 @option{-mcpu=niagara7}, the compiler additionally optimizes it for
24138 Oracle SPARC M7 chips.  With @option{-mcpu=m8}, the compiler
24139 additionally optimizes it for Oracle M8 chips.
24141 @item -mtune=@var{cpu_type}
24142 @opindex mtune
24143 Set the instruction scheduling parameters for machine type
24144 @var{cpu_type}, but do not set the instruction set or register set that the
24145 option @option{-mcpu=@var{cpu_type}} does.
24147 The same values for @option{-mcpu=@var{cpu_type}} can be used for
24148 @option{-mtune=@var{cpu_type}}, but the only useful values are those
24149 that select a particular CPU implementation.  Those are
24150 @samp{cypress}, @samp{supersparc}, @samp{hypersparc}, @samp{leon},
24151 @samp{leon3}, @samp{leon3v7}, @samp{f930}, @samp{f934},
24152 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
24153 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3},
24154 @samp{niagara4}, @samp{niagara7} and @samp{m8}.  With native Solaris
24155 and GNU/Linux toolchains, @samp{native} can also be used.
24157 @item -mv8plus
24158 @itemx -mno-v8plus
24159 @opindex mv8plus
24160 @opindex mno-v8plus
24161 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
24162 difference from the V8 ABI is that the global and out registers are
24163 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
24164 mode for all SPARC-V9 processors.
24166 @item -mvis
24167 @itemx -mno-vis
24168 @opindex mvis
24169 @opindex mno-vis
24170 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
24171 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
24173 @item -mvis2
24174 @itemx -mno-vis2
24175 @opindex mvis2
24176 @opindex mno-vis2
24177 With @option{-mvis2}, GCC generates code that takes advantage of
24178 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
24179 default is @option{-mvis2} when targeting a cpu that supports such
24180 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
24181 also sets @option{-mvis}.
24183 @item -mvis3
24184 @itemx -mno-vis3
24185 @opindex mvis3
24186 @opindex mno-vis3
24187 With @option{-mvis3}, GCC generates code that takes advantage of
24188 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
24189 default is @option{-mvis3} when targeting a cpu that supports such
24190 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
24191 also sets @option{-mvis2} and @option{-mvis}.
24193 @item -mvis4
24194 @itemx -mno-vis4
24195 @opindex mvis4
24196 @opindex mno-vis4
24197 With @option{-mvis4}, GCC generates code that takes advantage of
24198 version 4.0 of the UltraSPARC Visual Instruction Set extensions.  The
24199 default is @option{-mvis4} when targeting a cpu that supports such
24200 instructions, such as niagara-7 and later.  Setting @option{-mvis4}
24201 also sets @option{-mvis3}, @option{-mvis2} and @option{-mvis}.
24203 @item -mvis4b
24204 @itemx -mno-vis4b
24205 @opindex mvis4b
24206 @opindex mno-vis4b
24207 With @option{-mvis4b}, GCC generates code that takes advantage of
24208 version 4.0 of the UltraSPARC Visual Instruction Set extensions, plus
24209 the additional VIS instructions introduced in the Oracle SPARC
24210 Architecture 2017.  The default is @option{-mvis4b} when targeting a
24211 cpu that supports such instructions, such as m8 and later.  Setting
24212 @option{-mvis4b} also sets @option{-mvis4}, @option{-mvis3},
24213 @option{-mvis2} and @option{-mvis}.
24215 @item -mcbcond
24216 @itemx -mno-cbcond
24217 @opindex mcbcond
24218 @opindex mno-cbcond
24219 With @option{-mcbcond}, GCC generates code that takes advantage of the UltraSPARC
24220 Compare-and-Branch-on-Condition instructions.  The default is @option{-mcbcond}
24221 when targeting a CPU that supports such instructions, such as Niagara-4 and
24222 later.
24224 @item -mfmaf
24225 @itemx -mno-fmaf
24226 @opindex mfmaf
24227 @opindex mno-fmaf
24228 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
24229 Fused Multiply-Add Floating-point instructions.  The default is @option{-mfmaf}
24230 when targeting a CPU that supports such instructions, such as Niagara-3 and
24231 later.
24233 @item -mfsmuld
24234 @itemx -mno-fsmuld
24235 @opindex mfsmuld
24236 @opindex mno-fsmuld
24237 With @option{-mfsmuld}, GCC generates code that takes advantage of the
24238 Floating-point Multiply Single to Double (FsMULd) instruction.  The default is
24239 @option{-mfsmuld} when targeting a CPU supporting the architecture versions V8
24240 or V9 with FPU except @option{-mcpu=leon}.
24242 @item -mpopc
24243 @itemx -mno-popc
24244 @opindex mpopc
24245 @opindex mno-popc
24246 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
24247 Population Count instruction.  The default is @option{-mpopc}
24248 when targeting a CPU that supports such an instruction, such as Niagara-2 and
24249 later.
24251 @item -msubxc
24252 @itemx -mno-subxc
24253 @opindex msubxc
24254 @opindex mno-subxc
24255 With @option{-msubxc}, GCC generates code that takes advantage of the UltraSPARC
24256 Subtract-Extended-with-Carry instruction.  The default is @option{-msubxc}
24257 when targeting a CPU that supports such an instruction, such as Niagara-7 and
24258 later.
24260 @item -mfix-at697f
24261 @opindex mfix-at697f
24262 Enable the documented workaround for the single erratum of the Atmel AT697F
24263 processor (which corresponds to erratum #13 of the AT697E processor).
24265 @item -mfix-ut699
24266 @opindex mfix-ut699
24267 Enable the documented workarounds for the floating-point errata and the data
24268 cache nullify errata of the UT699 processor.
24270 @item -mfix-ut700
24271 @opindex mfix-ut700
24272 Enable the documented workaround for the back-to-back store errata of
24273 the UT699E/UT700 processor.
24275 @item -mfix-gr712rc
24276 @opindex mfix-gr712rc
24277 Enable the documented workaround for the back-to-back store errata of
24278 the GR712RC processor.
24279 @end table
24281 These @samp{-m} options are supported in addition to the above
24282 on SPARC-V9 processors in 64-bit environments:
24284 @table @gcctabopt
24285 @item -m32
24286 @itemx -m64
24287 @opindex m32
24288 @opindex m64
24289 Generate code for a 32-bit or 64-bit environment.
24290 The 32-bit environment sets int, long and pointer to 32 bits.
24291 The 64-bit environment sets int to 32 bits and long and pointer
24292 to 64 bits.
24294 @item -mcmodel=@var{which}
24295 @opindex mcmodel
24296 Set the code model to one of
24298 @table @samp
24299 @item medlow
24300 The Medium/Low code model: 64-bit addresses, programs
24301 must be linked in the low 32 bits of memory.  Programs can be statically
24302 or dynamically linked.
24304 @item medmid
24305 The Medium/Middle code model: 64-bit addresses, programs
24306 must be linked in the low 44 bits of memory, the text and data segments must
24307 be less than 2GB in size and the data segment must be located within 2GB of
24308 the text segment.
24310 @item medany
24311 The Medium/Anywhere code model: 64-bit addresses, programs
24312 may be linked anywhere in memory, the text and data segments must be less
24313 than 2GB in size and the data segment must be located within 2GB of the
24314 text segment.
24316 @item embmedany
24317 The Medium/Anywhere code model for embedded systems:
24318 64-bit addresses, the text and data segments must be less than 2GB in
24319 size, both starting anywhere in memory (determined at link time).  The
24320 global register %g4 points to the base of the data segment.  Programs
24321 are statically linked and PIC is not supported.
24322 @end table
24324 @item -mmemory-model=@var{mem-model}
24325 @opindex mmemory-model
24326 Set the memory model in force on the processor to one of
24328 @table @samp
24329 @item default
24330 The default memory model for the processor and operating system.
24332 @item rmo
24333 Relaxed Memory Order
24335 @item pso
24336 Partial Store Order
24338 @item tso
24339 Total Store Order
24341 @item sc
24342 Sequential Consistency
24343 @end table
24345 These memory models are formally defined in Appendix D of the SPARC-V9
24346 architecture manual, as set in the processor's @code{PSTATE.MM} field.
24348 @item -mstack-bias
24349 @itemx -mno-stack-bias
24350 @opindex mstack-bias
24351 @opindex mno-stack-bias
24352 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
24353 frame pointer if present, are offset by @minus{}2047 which must be added back
24354 when making stack frame references.  This is the default in 64-bit mode.
24355 Otherwise, assume no such offset is present.
24356 @end table
24358 @node SPU Options
24359 @subsection SPU Options
24360 @cindex SPU options
24362 These @samp{-m} options are supported on the SPU:
24364 @table @gcctabopt
24365 @item -mwarn-reloc
24366 @itemx -merror-reloc
24367 @opindex mwarn-reloc
24368 @opindex merror-reloc
24370 The loader for SPU does not handle dynamic relocations.  By default, GCC
24371 gives an error when it generates code that requires a dynamic
24372 relocation.  @option{-mno-error-reloc} disables the error,
24373 @option{-mwarn-reloc} generates a warning instead.
24375 @item -msafe-dma
24376 @itemx -munsafe-dma
24377 @opindex msafe-dma
24378 @opindex munsafe-dma
24380 Instructions that initiate or test completion of DMA must not be
24381 reordered with respect to loads and stores of the memory that is being
24382 accessed.
24383 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
24384 memory accesses, but that can lead to inefficient code in places where the
24385 memory is known to not change.  Rather than mark the memory as volatile,
24386 you can use @option{-msafe-dma} to tell the compiler to treat
24387 the DMA instructions as potentially affecting all memory.  
24389 @item -mbranch-hints
24390 @opindex mbranch-hints
24392 By default, GCC generates a branch hint instruction to avoid
24393 pipeline stalls for always-taken or probably-taken branches.  A hint
24394 is not generated closer than 8 instructions away from its branch.
24395 There is little reason to disable them, except for debugging purposes,
24396 or to make an object a little bit smaller.
24398 @item -msmall-mem
24399 @itemx -mlarge-mem
24400 @opindex msmall-mem
24401 @opindex mlarge-mem
24403 By default, GCC generates code assuming that addresses are never larger
24404 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
24405 a full 32-bit address.
24407 @item -mstdmain
24408 @opindex mstdmain
24410 By default, GCC links against startup code that assumes the SPU-style
24411 main function interface (which has an unconventional parameter list).
24412 With @option{-mstdmain}, GCC links your program against startup
24413 code that assumes a C99-style interface to @code{main}, including a
24414 local copy of @code{argv} strings.
24416 @item -mfixed-range=@var{register-range}
24417 @opindex mfixed-range
24418 Generate code treating the given register range as fixed registers.
24419 A fixed register is one that the register allocator cannot use.  This is
24420 useful when compiling kernel code.  A register range is specified as
24421 two registers separated by a dash.  Multiple register ranges can be
24422 specified separated by a comma.
24424 @item -mea32
24425 @itemx -mea64
24426 @opindex mea32
24427 @opindex mea64
24428 Compile code assuming that pointers to the PPU address space accessed
24429 via the @code{__ea} named address space qualifier are either 32 or 64
24430 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
24431 all object code in an executable must be compiled with the same setting.
24433 @item -maddress-space-conversion
24434 @itemx -mno-address-space-conversion
24435 @opindex maddress-space-conversion
24436 @opindex mno-address-space-conversion
24437 Allow/disallow treating the @code{__ea} address space as superset
24438 of the generic address space.  This enables explicit type casts
24439 between @code{__ea} and generic pointer as well as implicit
24440 conversions of generic pointers to @code{__ea} pointers.  The
24441 default is to allow address space pointer conversions.
24443 @item -mcache-size=@var{cache-size}
24444 @opindex mcache-size
24445 This option controls the version of libgcc that the compiler links to an
24446 executable and selects a software-managed cache for accessing variables
24447 in the @code{__ea} address space with a particular cache size.  Possible
24448 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
24449 and @samp{128}.  The default cache size is 64KB.
24451 @item -matomic-updates
24452 @itemx -mno-atomic-updates
24453 @opindex matomic-updates
24454 @opindex mno-atomic-updates
24455 This option controls the version of libgcc that the compiler links to an
24456 executable and selects whether atomic updates to the software-managed
24457 cache of PPU-side variables are used.  If you use atomic updates, changes
24458 to a PPU variable from SPU code using the @code{__ea} named address space
24459 qualifier do not interfere with changes to other PPU variables residing
24460 in the same cache line from PPU code.  If you do not use atomic updates,
24461 such interference may occur; however, writing back cache lines is
24462 more efficient.  The default behavior is to use atomic updates.
24464 @item -mdual-nops
24465 @itemx -mdual-nops=@var{n}
24466 @opindex mdual-nops
24467 By default, GCC inserts NOPs to increase dual issue when it expects
24468 it to increase performance.  @var{n} can be a value from 0 to 10.  A
24469 smaller @var{n} inserts fewer NOPs.  10 is the default, 0 is the
24470 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
24472 @item -mhint-max-nops=@var{n}
24473 @opindex mhint-max-nops
24474 Maximum number of NOPs to insert for a branch hint.  A branch hint must
24475 be at least 8 instructions away from the branch it is affecting.  GCC
24476 inserts up to @var{n} NOPs to enforce this, otherwise it does not
24477 generate the branch hint.
24479 @item -mhint-max-distance=@var{n}
24480 @opindex mhint-max-distance
24481 The encoding of the branch hint instruction limits the hint to be within
24482 256 instructions of the branch it is affecting.  By default, GCC makes
24483 sure it is within 125.
24485 @item -msafe-hints
24486 @opindex msafe-hints
24487 Work around a hardware bug that causes the SPU to stall indefinitely.
24488 By default, GCC inserts the @code{hbrp} instruction to make sure
24489 this stall won't happen.
24491 @end table
24493 @node System V Options
24494 @subsection Options for System V
24496 These additional options are available on System V Release 4 for
24497 compatibility with other compilers on those systems:
24499 @table @gcctabopt
24500 @item -G
24501 @opindex G
24502 Create a shared object.
24503 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
24505 @item -Qy
24506 @opindex Qy
24507 Identify the versions of each tool used by the compiler, in a
24508 @code{.ident} assembler directive in the output.
24510 @item -Qn
24511 @opindex Qn
24512 Refrain from adding @code{.ident} directives to the output file (this is
24513 the default).
24515 @item -YP,@var{dirs}
24516 @opindex YP
24517 Search the directories @var{dirs}, and no others, for libraries
24518 specified with @option{-l}.
24520 @item -Ym,@var{dir}
24521 @opindex Ym
24522 Look in the directory @var{dir} to find the M4 preprocessor.
24523 The assembler uses this option.
24524 @c This is supposed to go with a -Yd for predefined M4 macro files, but
24525 @c the generic assembler that comes with Solaris takes just -Ym.
24526 @end table
24528 @node TILE-Gx Options
24529 @subsection TILE-Gx Options
24530 @cindex TILE-Gx options
24532 These @samp{-m} options are supported on the TILE-Gx:
24534 @table @gcctabopt
24535 @item -mcmodel=small
24536 @opindex mcmodel=small
24537 Generate code for the small model.  The distance for direct calls is
24538 limited to 500M in either direction.  PC-relative addresses are 32
24539 bits.  Absolute addresses support the full address range.
24541 @item -mcmodel=large
24542 @opindex mcmodel=large
24543 Generate code for the large model.  There is no limitation on call
24544 distance, pc-relative addresses, or absolute addresses.
24546 @item -mcpu=@var{name}
24547 @opindex mcpu
24548 Selects the type of CPU to be targeted.  Currently the only supported
24549 type is @samp{tilegx}.
24551 @item -m32
24552 @itemx -m64
24553 @opindex m32
24554 @opindex m64
24555 Generate code for a 32-bit or 64-bit environment.  The 32-bit
24556 environment sets int, long, and pointer to 32 bits.  The 64-bit
24557 environment sets int to 32 bits and long and pointer to 64 bits.
24559 @item -mbig-endian
24560 @itemx -mlittle-endian
24561 @opindex mbig-endian
24562 @opindex mlittle-endian
24563 Generate code in big/little endian mode, respectively.
24564 @end table
24566 @node TILEPro Options
24567 @subsection TILEPro Options
24568 @cindex TILEPro options
24570 These @samp{-m} options are supported on the TILEPro:
24572 @table @gcctabopt
24573 @item -mcpu=@var{name}
24574 @opindex mcpu
24575 Selects the type of CPU to be targeted.  Currently the only supported
24576 type is @samp{tilepro}.
24578 @item -m32
24579 @opindex m32
24580 Generate code for a 32-bit environment, which sets int, long, and
24581 pointer to 32 bits.  This is the only supported behavior so the flag
24582 is essentially ignored.
24583 @end table
24585 @node V850 Options
24586 @subsection V850 Options
24587 @cindex V850 Options
24589 These @samp{-m} options are defined for V850 implementations:
24591 @table @gcctabopt
24592 @item -mlong-calls
24593 @itemx -mno-long-calls
24594 @opindex mlong-calls
24595 @opindex mno-long-calls
24596 Treat all calls as being far away (near).  If calls are assumed to be
24597 far away, the compiler always loads the function's address into a
24598 register, and calls indirect through the pointer.
24600 @item -mno-ep
24601 @itemx -mep
24602 @opindex mno-ep
24603 @opindex mep
24604 Do not optimize (do optimize) basic blocks that use the same index
24605 pointer 4 or more times to copy pointer into the @code{ep} register, and
24606 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
24607 option is on by default if you optimize.
24609 @item -mno-prolog-function
24610 @itemx -mprolog-function
24611 @opindex mno-prolog-function
24612 @opindex mprolog-function
24613 Do not use (do use) external functions to save and restore registers
24614 at the prologue and epilogue of a function.  The external functions
24615 are slower, but use less code space if more than one function saves
24616 the same number of registers.  The @option{-mprolog-function} option
24617 is on by default if you optimize.
24619 @item -mspace
24620 @opindex mspace
24621 Try to make the code as small as possible.  At present, this just turns
24622 on the @option{-mep} and @option{-mprolog-function} options.
24624 @item -mtda=@var{n}
24625 @opindex mtda
24626 Put static or global variables whose size is @var{n} bytes or less into
24627 the tiny data area that register @code{ep} points to.  The tiny data
24628 area can hold up to 256 bytes in total (128 bytes for byte references).
24630 @item -msda=@var{n}
24631 @opindex msda
24632 Put static or global variables whose size is @var{n} bytes or less into
24633 the small data area that register @code{gp} points to.  The small data
24634 area can hold up to 64 kilobytes.
24636 @item -mzda=@var{n}
24637 @opindex mzda
24638 Put static or global variables whose size is @var{n} bytes or less into
24639 the first 32 kilobytes of memory.
24641 @item -mv850
24642 @opindex mv850
24643 Specify that the target processor is the V850.
24645 @item -mv850e3v5
24646 @opindex mv850e3v5
24647 Specify that the target processor is the V850E3V5.  The preprocessor
24648 constant @code{__v850e3v5__} is defined if this option is used.
24650 @item -mv850e2v4
24651 @opindex mv850e2v4
24652 Specify that the target processor is the V850E3V5.  This is an alias for
24653 the @option{-mv850e3v5} option.
24655 @item -mv850e2v3
24656 @opindex mv850e2v3
24657 Specify that the target processor is the V850E2V3.  The preprocessor
24658 constant @code{__v850e2v3__} is defined if this option is used.
24660 @item -mv850e2
24661 @opindex mv850e2
24662 Specify that the target processor is the V850E2.  The preprocessor
24663 constant @code{__v850e2__} is defined if this option is used.
24665 @item -mv850e1
24666 @opindex mv850e1
24667 Specify that the target processor is the V850E1.  The preprocessor
24668 constants @code{__v850e1__} and @code{__v850e__} are defined if
24669 this option is used.
24671 @item -mv850es
24672 @opindex mv850es
24673 Specify that the target processor is the V850ES.  This is an alias for
24674 the @option{-mv850e1} option.
24676 @item -mv850e
24677 @opindex mv850e
24678 Specify that the target processor is the V850E@.  The preprocessor
24679 constant @code{__v850e__} is defined if this option is used.
24681 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
24682 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
24683 are defined then a default target processor is chosen and the
24684 relevant @samp{__v850*__} preprocessor constant is defined.
24686 The preprocessor constants @code{__v850} and @code{__v851__} are always
24687 defined, regardless of which processor variant is the target.
24689 @item -mdisable-callt
24690 @itemx -mno-disable-callt
24691 @opindex mdisable-callt
24692 @opindex mno-disable-callt
24693 This option suppresses generation of the @code{CALLT} instruction for the
24694 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
24695 architecture.
24697 This option is enabled by default when the RH850 ABI is
24698 in use (see @option{-mrh850-abi}), and disabled by default when the
24699 GCC ABI is in use.  If @code{CALLT} instructions are being generated
24700 then the C preprocessor symbol @code{__V850_CALLT__} is defined.
24702 @item -mrelax
24703 @itemx -mno-relax
24704 @opindex mrelax
24705 @opindex mno-relax
24706 Pass on (or do not pass on) the @option{-mrelax} command-line option
24707 to the assembler.
24709 @item -mlong-jumps
24710 @itemx -mno-long-jumps
24711 @opindex mlong-jumps
24712 @opindex mno-long-jumps
24713 Disable (or re-enable) the generation of PC-relative jump instructions.
24715 @item -msoft-float
24716 @itemx -mhard-float
24717 @opindex msoft-float
24718 @opindex mhard-float
24719 Disable (or re-enable) the generation of hardware floating point
24720 instructions.  This option is only significant when the target
24721 architecture is @samp{V850E2V3} or higher.  If hardware floating point
24722 instructions are being generated then the C preprocessor symbol
24723 @code{__FPU_OK__} is defined, otherwise the symbol
24724 @code{__NO_FPU__} is defined.
24726 @item -mloop
24727 @opindex mloop
24728 Enables the use of the e3v5 LOOP instruction.  The use of this
24729 instruction is not enabled by default when the e3v5 architecture is
24730 selected because its use is still experimental.
24732 @item -mrh850-abi
24733 @itemx -mghs
24734 @opindex mrh850-abi
24735 @opindex mghs
24736 Enables support for the RH850 version of the V850 ABI.  This is the
24737 default.  With this version of the ABI the following rules apply:
24739 @itemize
24740 @item
24741 Integer sized structures and unions are returned via a memory pointer
24742 rather than a register.
24744 @item
24745 Large structures and unions (more than 8 bytes in size) are passed by
24746 value.
24748 @item
24749 Functions are aligned to 16-bit boundaries.
24751 @item
24752 The @option{-m8byte-align} command-line option is supported.
24754 @item
24755 The @option{-mdisable-callt} command-line option is enabled by
24756 default.  The @option{-mno-disable-callt} command-line option is not
24757 supported.
24758 @end itemize
24760 When this version of the ABI is enabled the C preprocessor symbol
24761 @code{__V850_RH850_ABI__} is defined.
24763 @item -mgcc-abi
24764 @opindex mgcc-abi
24765 Enables support for the old GCC version of the V850 ABI.  With this
24766 version of the ABI the following rules apply:
24768 @itemize
24769 @item
24770 Integer sized structures and unions are returned in register @code{r10}.
24772 @item
24773 Large structures and unions (more than 8 bytes in size) are passed by
24774 reference.
24776 @item
24777 Functions are aligned to 32-bit boundaries, unless optimizing for
24778 size.
24780 @item
24781 The @option{-m8byte-align} command-line option is not supported.
24783 @item
24784 The @option{-mdisable-callt} command-line option is supported but not
24785 enabled by default.
24786 @end itemize
24788 When this version of the ABI is enabled the C preprocessor symbol
24789 @code{__V850_GCC_ABI__} is defined.
24791 @item -m8byte-align
24792 @itemx -mno-8byte-align
24793 @opindex m8byte-align
24794 @opindex mno-8byte-align
24795 Enables support for @code{double} and @code{long long} types to be
24796 aligned on 8-byte boundaries.  The default is to restrict the
24797 alignment of all objects to at most 4-bytes.  When
24798 @option{-m8byte-align} is in effect the C preprocessor symbol
24799 @code{__V850_8BYTE_ALIGN__} is defined.
24801 @item -mbig-switch
24802 @opindex mbig-switch
24803 Generate code suitable for big switch tables.  Use this option only if
24804 the assembler/linker complain about out of range branches within a switch
24805 table.
24807 @item -mapp-regs
24808 @opindex mapp-regs
24809 This option causes r2 and r5 to be used in the code generated by
24810 the compiler.  This setting is the default.
24812 @item -mno-app-regs
24813 @opindex mno-app-regs
24814 This option causes r2 and r5 to be treated as fixed registers.
24816 @end table
24818 @node VAX Options
24819 @subsection VAX Options
24820 @cindex VAX options
24822 These @samp{-m} options are defined for the VAX:
24824 @table @gcctabopt
24825 @item -munix
24826 @opindex munix
24827 Do not output certain jump instructions (@code{aobleq} and so on)
24828 that the Unix assembler for the VAX cannot handle across long
24829 ranges.
24831 @item -mgnu
24832 @opindex mgnu
24833 Do output those jump instructions, on the assumption that the
24834 GNU assembler is being used.
24836 @item -mg
24837 @opindex mg
24838 Output code for G-format floating-point numbers instead of D-format.
24839 @end table
24841 @node Visium Options
24842 @subsection Visium Options
24843 @cindex Visium options
24845 @table @gcctabopt
24847 @item -mdebug
24848 @opindex mdebug
24849 A program which performs file I/O and is destined to run on an MCM target
24850 should be linked with this option.  It causes the libraries libc.a and
24851 libdebug.a to be linked.  The program should be run on the target under
24852 the control of the GDB remote debugging stub.
24854 @item -msim
24855 @opindex msim
24856 A program which performs file I/O and is destined to run on the simulator
24857 should be linked with option.  This causes libraries libc.a and libsim.a to
24858 be linked.
24860 @item -mfpu
24861 @itemx -mhard-float
24862 @opindex mfpu
24863 @opindex mhard-float
24864 Generate code containing floating-point instructions.  This is the
24865 default.
24867 @item -mno-fpu
24868 @itemx -msoft-float
24869 @opindex mno-fpu
24870 @opindex msoft-float
24871 Generate code containing library calls for floating-point.
24873 @option{-msoft-float} changes the calling convention in the output file;
24874 therefore, it is only useful if you compile @emph{all} of a program with
24875 this option.  In particular, you need to compile @file{libgcc.a}, the
24876 library that comes with GCC, with @option{-msoft-float} in order for
24877 this to work.
24879 @item -mcpu=@var{cpu_type}
24880 @opindex mcpu
24881 Set the instruction set, register set, and instruction scheduling parameters
24882 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
24883 @samp{mcm}, @samp{gr5} and @samp{gr6}.
24885 @samp{mcm} is a synonym of @samp{gr5} present for backward compatibility.
24887 By default (unless configured otherwise), GCC generates code for the GR5
24888 variant of the Visium architecture.  
24890 With @option{-mcpu=gr6}, GCC generates code for the GR6 variant of the Visium
24891 architecture.  The only difference from GR5 code is that the compiler will
24892 generate block move instructions.
24894 @item -mtune=@var{cpu_type}
24895 @opindex mtune
24896 Set the instruction scheduling parameters for machine type @var{cpu_type},
24897 but do not set the instruction set or register set that the option
24898 @option{-mcpu=@var{cpu_type}} would.
24900 @item -msv-mode
24901 @opindex msv-mode
24902 Generate code for the supervisor mode, where there are no restrictions on
24903 the access to general registers.  This is the default.
24905 @item -muser-mode
24906 @opindex muser-mode
24907 Generate code for the user mode, where the access to some general registers
24908 is forbidden: on the GR5, registers r24 to r31 cannot be accessed in this
24909 mode; on the GR6, only registers r29 to r31 are affected.
24910 @end table
24912 @node VMS Options
24913 @subsection VMS Options
24915 These @samp{-m} options are defined for the VMS implementations:
24917 @table @gcctabopt
24918 @item -mvms-return-codes
24919 @opindex mvms-return-codes
24920 Return VMS condition codes from @code{main}. The default is to return POSIX-style
24921 condition (e.g.@ error) codes.
24923 @item -mdebug-main=@var{prefix}
24924 @opindex mdebug-main=@var{prefix}
24925 Flag the first routine whose name starts with @var{prefix} as the main
24926 routine for the debugger.
24928 @item -mmalloc64
24929 @opindex mmalloc64
24930 Default to 64-bit memory allocation routines.
24932 @item -mpointer-size=@var{size}
24933 @opindex mpointer-size=@var{size}
24934 Set the default size of pointers. Possible options for @var{size} are
24935 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
24936 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
24937 The later option disables @code{pragma pointer_size}.
24938 @end table
24940 @node VxWorks Options
24941 @subsection VxWorks Options
24942 @cindex VxWorks Options
24944 The options in this section are defined for all VxWorks targets.
24945 Options specific to the target hardware are listed with the other
24946 options for that target.
24948 @table @gcctabopt
24949 @item -mrtp
24950 @opindex mrtp
24951 GCC can generate code for both VxWorks kernels and real time processes
24952 (RTPs).  This option switches from the former to the latter.  It also
24953 defines the preprocessor macro @code{__RTP__}.
24955 @item -non-static
24956 @opindex non-static
24957 Link an RTP executable against shared libraries rather than static
24958 libraries.  The options @option{-static} and @option{-shared} can
24959 also be used for RTPs (@pxref{Link Options}); @option{-static}
24960 is the default.
24962 @item -Bstatic
24963 @itemx -Bdynamic
24964 @opindex Bstatic
24965 @opindex Bdynamic
24966 These options are passed down to the linker.  They are defined for
24967 compatibility with Diab.
24969 @item -Xbind-lazy
24970 @opindex Xbind-lazy
24971 Enable lazy binding of function calls.  This option is equivalent to
24972 @option{-Wl,-z,now} and is defined for compatibility with Diab.
24974 @item -Xbind-now
24975 @opindex Xbind-now
24976 Disable lazy binding of function calls.  This option is the default and
24977 is defined for compatibility with Diab.
24978 @end table
24980 @node x86 Options
24981 @subsection x86 Options
24982 @cindex x86 Options
24984 These @samp{-m} options are defined for the x86 family of computers.
24986 @table @gcctabopt
24988 @item -march=@var{cpu-type}
24989 @opindex march
24990 Generate instructions for the machine type @var{cpu-type}.  In contrast to
24991 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
24992 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
24993 to generate code that may not run at all on processors other than the one
24994 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
24995 @option{-mtune=@var{cpu-type}}.
24997 The choices for @var{cpu-type} are:
24999 @table @samp
25000 @item native
25001 This selects the CPU to generate code for at compilation time by determining
25002 the processor type of the compiling machine.  Using @option{-march=native}
25003 enables all instruction subsets supported by the local machine (hence
25004 the result might not run on different machines).  Using @option{-mtune=native}
25005 produces code optimized for the local machine under the constraints
25006 of the selected instruction set.  
25008 @item i386
25009 Original Intel i386 CPU@.
25011 @item i486
25012 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
25014 @item i586
25015 @itemx pentium
25016 Intel Pentium CPU with no MMX support.
25018 @item lakemont
25019 Intel Lakemont MCU, based on Intel Pentium CPU.
25021 @item pentium-mmx
25022 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
25024 @item pentiumpro
25025 Intel Pentium Pro CPU@.
25027 @item i686
25028 When used with @option{-march}, the Pentium Pro
25029 instruction set is used, so the code runs on all i686 family chips.
25030 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
25032 @item pentium2
25033 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
25034 support.
25036 @item pentium3
25037 @itemx pentium3m
25038 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
25039 set support.
25041 @item pentium-m
25042 Intel Pentium M; low-power version of Intel Pentium III CPU
25043 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
25045 @item pentium4
25046 @itemx pentium4m
25047 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
25049 @item prescott
25050 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
25051 set support.
25053 @item nocona
25054 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
25055 SSE2 and SSE3 instruction set support.
25057 @item core2
25058 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
25059 instruction set support.
25061 @item nehalem
25062 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
25063 SSE4.1, SSE4.2 and POPCNT instruction set support.
25065 @item westmere
25066 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
25067 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
25069 @item sandybridge
25070 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
25071 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
25073 @item ivybridge
25074 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
25075 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
25076 instruction set support.
25078 @item haswell
25079 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
25080 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25081 BMI, BMI2 and F16C instruction set support.
25083 @item broadwell
25084 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
25085 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25086 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
25088 @item skylake
25089 Intel Skylake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
25090 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25091 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC and
25092 XSAVES instruction set support.
25094 @item bonnell
25095 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
25096 instruction set support.
25098 @item silvermont
25099 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
25100 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
25102 @item knl
25103 Intel Knight's Landing CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
25104 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25105 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER and
25106 AVX512CD instruction set support.
25108 @item knm
25109 Intel Knights Mill CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
25110 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25111 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER, AVX512CD,
25112 AVX5124VNNIW, AVX5124FMAPS and AVX512VPOPCNTDQ instruction set support.
25114 @item skylake-avx512
25115 Intel Skylake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
25116 SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25117 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F,
25118 AVX512VL, AVX512BW, AVX512DQ and AVX512CD instruction set support.
25120 @item k6
25121 AMD K6 CPU with MMX instruction set support.
25123 @item k6-2
25124 @itemx k6-3
25125 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
25127 @item athlon
25128 @itemx athlon-tbird
25129 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
25130 support.
25132 @item athlon-4
25133 @itemx athlon-xp
25134 @itemx athlon-mp
25135 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
25136 instruction set support.
25138 @item k8
25139 @itemx opteron
25140 @itemx athlon64
25141 @itemx athlon-fx
25142 Processors based on the AMD K8 core with x86-64 instruction set support,
25143 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
25144 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
25145 instruction set extensions.)
25147 @item k8-sse3
25148 @itemx opteron-sse3
25149 @itemx athlon64-sse3
25150 Improved versions of AMD K8 cores with SSE3 instruction set support.
25152 @item amdfam10
25153 @itemx barcelona
25154 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
25155 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
25156 instruction set extensions.)
25158 @item bdver1
25159 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
25160 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
25161 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
25162 @item bdver2
25163 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
25164 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
25165 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
25166 extensions.)
25167 @item bdver3
25168 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
25169 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
25170 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
25171 64-bit instruction set extensions.
25172 @item bdver4
25173 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
25174 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
25175 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
25176 SSE4.2, ABM and 64-bit instruction set extensions.
25178 @item znver1
25179 AMD Family 17h core based CPUs with x86-64 instruction set support.  (This
25180 supersets BMI, BMI2, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX,
25181 SHA, CLZERO, AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3,
25182 SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, and 64-bit
25183 instruction set extensions.
25185 @item btver1
25186 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
25187 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
25188 instruction set extensions.)
25190 @item btver2
25191 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
25192 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
25193 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
25195 @item winchip-c6
25196 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
25197 set support.
25199 @item winchip2
25200 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
25201 instruction set support.
25203 @item c3
25204 VIA C3 CPU with MMX and 3DNow!@: instruction set support.
25205 (No scheduling is implemented for this chip.)
25207 @item c3-2
25208 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
25209 (No scheduling is implemented for this chip.)
25211 @item c7
25212 VIA C7 (Esther) CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
25213 (No scheduling is implemented for this chip.)
25215 @item samuel-2
25216 VIA Eden Samuel 2 CPU with MMX and 3DNow!@: instruction set support.
25217 (No scheduling is implemented for this chip.)
25219 @item nehemiah
25220 VIA Eden Nehemiah CPU with MMX and SSE instruction set support.
25221 (No scheduling is implemented for this chip.)
25223 @item esther
25224 VIA Eden Esther CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
25225 (No scheduling is implemented for this chip.)
25227 @item eden-x2
25228 VIA Eden X2 CPU with x86-64, MMX, SSE, SSE2 and SSE3 instruction set support.
25229 (No scheduling is implemented for this chip.)
25231 @item eden-x4
25232 VIA Eden X4 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2,
25233 AVX and AVX2 instruction set support.
25234 (No scheduling is implemented for this chip.)
25236 @item nano
25237 Generic VIA Nano CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
25238 instruction set support.
25239 (No scheduling is implemented for this chip.)
25241 @item nano-1000
25242 VIA Nano 1xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
25243 instruction set support.
25244 (No scheduling is implemented for this chip.)
25246 @item nano-2000
25247 VIA Nano 2xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
25248 instruction set support.
25249 (No scheduling is implemented for this chip.)
25251 @item nano-3000
25252 VIA Nano 3xxx CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
25253 instruction set support.
25254 (No scheduling is implemented for this chip.)
25256 @item nano-x2
25257 VIA Nano Dual Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
25258 instruction set support.
25259 (No scheduling is implemented for this chip.)
25261 @item nano-x4
25262 VIA Nano Quad Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
25263 instruction set support.
25264 (No scheduling is implemented for this chip.)
25266 @item geode
25267 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
25268 @end table
25270 @item -mtune=@var{cpu-type}
25271 @opindex mtune
25272 Tune to @var{cpu-type} everything applicable about the generated code, except
25273 for the ABI and the set of available instructions.  
25274 While picking a specific @var{cpu-type} schedules things appropriately
25275 for that particular chip, the compiler does not generate any code that
25276 cannot run on the default machine type unless you use a
25277 @option{-march=@var{cpu-type}} option.
25278 For example, if GCC is configured for i686-pc-linux-gnu
25279 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
25280 but still runs on i686 machines.
25282 The choices for @var{cpu-type} are the same as for @option{-march}.
25283 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
25285 @table @samp
25286 @item generic
25287 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
25288 If you know the CPU on which your code will run, then you should use
25289 the corresponding @option{-mtune} or @option{-march} option instead of
25290 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
25291 of your application will have, then you should use this option.
25293 As new processors are deployed in the marketplace, the behavior of this
25294 option will change.  Therefore, if you upgrade to a newer version of
25295 GCC, code generation controlled by this option will change to reflect
25296 the processors
25297 that are most common at the time that version of GCC is released.
25299 There is no @option{-march=generic} option because @option{-march}
25300 indicates the instruction set the compiler can use, and there is no
25301 generic instruction set applicable to all processors.  In contrast,
25302 @option{-mtune} indicates the processor (or, in this case, collection of
25303 processors) for which the code is optimized.
25305 @item intel
25306 Produce code optimized for the most current Intel processors, which are
25307 Haswell and Silvermont for this version of GCC.  If you know the CPU
25308 on which your code will run, then you should use the corresponding
25309 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
25310 But, if you want your application performs better on both Haswell and
25311 Silvermont, then you should use this option.
25313 As new Intel processors are deployed in the marketplace, the behavior of
25314 this option will change.  Therefore, if you upgrade to a newer version of
25315 GCC, code generation controlled by this option will change to reflect
25316 the most current Intel processors at the time that version of GCC is
25317 released.
25319 There is no @option{-march=intel} option because @option{-march} indicates
25320 the instruction set the compiler can use, and there is no common
25321 instruction set applicable to all processors.  In contrast,
25322 @option{-mtune} indicates the processor (or, in this case, collection of
25323 processors) for which the code is optimized.
25324 @end table
25326 @item -mcpu=@var{cpu-type}
25327 @opindex mcpu
25328 A deprecated synonym for @option{-mtune}.
25330 @item -mfpmath=@var{unit}
25331 @opindex mfpmath
25332 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
25333 for @var{unit} are:
25335 @table @samp
25336 @item 387
25337 Use the standard 387 floating-point coprocessor present on the majority of chips and
25338 emulated otherwise.  Code compiled with this option runs almost everywhere.
25339 The temporary results are computed in 80-bit precision instead of the precision
25340 specified by the type, resulting in slightly different results compared to most
25341 of other chips.  See @option{-ffloat-store} for more detailed description.
25343 This is the default choice for non-Darwin x86-32 targets.
25345 @item sse
25346 Use scalar floating-point instructions present in the SSE instruction set.
25347 This instruction set is supported by Pentium III and newer chips,
25348 and in the AMD line
25349 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
25350 instruction set supports only single-precision arithmetic, thus the double and
25351 extended-precision arithmetic are still done using 387.  A later version, present
25352 only in Pentium 4 and AMD x86-64 chips, supports double-precision
25353 arithmetic too.
25355 For the x86-32 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
25356 or @option{-msse2} switches to enable SSE extensions and make this option
25357 effective.  For the x86-64 compiler, these extensions are enabled by default.
25359 The resulting code should be considerably faster in the majority of cases and avoid
25360 the numerical instability problems of 387 code, but may break some existing
25361 code that expects temporaries to be 80 bits.
25363 This is the default choice for the x86-64 compiler, Darwin x86-32 targets,
25364 and the default choice for x86-32 targets with the SSE2 instruction set
25365 when @option{-ffast-math} is enabled.
25367 @item sse,387
25368 @itemx sse+387
25369 @itemx both
25370 Attempt to utilize both instruction sets at once.  This effectively doubles the
25371 amount of available registers, and on chips with separate execution units for
25372 387 and SSE the execution resources too.  Use this option with care, as it is
25373 still experimental, because the GCC register allocator does not model separate
25374 functional units well, resulting in unstable performance.
25375 @end table
25377 @item -masm=@var{dialect}
25378 @opindex masm=@var{dialect}
25379 Output assembly instructions using selected @var{dialect}.  Also affects
25380 which dialect is used for basic @code{asm} (@pxref{Basic Asm}) and
25381 extended @code{asm} (@pxref{Extended Asm}). Supported choices (in dialect
25382 order) are @samp{att} or @samp{intel}. The default is @samp{att}. Darwin does
25383 not support @samp{intel}.
25385 @item -mieee-fp
25386 @itemx -mno-ieee-fp
25387 @opindex mieee-fp
25388 @opindex mno-ieee-fp
25389 Control whether or not the compiler uses IEEE floating-point
25390 comparisons.  These correctly handle the case where the result of a
25391 comparison is unordered.
25393 @item -m80387
25394 @item -mhard-float
25395 @opindex 80387
25396 @opindex mhard-float
25397 Generate output containing 80387 instructions for floating point.
25399 @item -mno-80387
25400 @item -msoft-float
25401 @opindex no-80387
25402 @opindex msoft-float
25403 Generate output containing library calls for floating point.
25405 @strong{Warning:} the requisite libraries are not part of GCC@.
25406 Normally the facilities of the machine's usual C compiler are used, but
25407 this cannot be done directly in cross-compilation.  You must make your
25408 own arrangements to provide suitable library functions for
25409 cross-compilation.
25411 On machines where a function returns floating-point results in the 80387
25412 register stack, some floating-point opcodes may be emitted even if
25413 @option{-msoft-float} is used.
25415 @item -mno-fp-ret-in-387
25416 @opindex mno-fp-ret-in-387
25417 Do not use the FPU registers for return values of functions.
25419 The usual calling convention has functions return values of types
25420 @code{float} and @code{double} in an FPU register, even if there
25421 is no FPU@.  The idea is that the operating system should emulate
25422 an FPU@.
25424 The option @option{-mno-fp-ret-in-387} causes such values to be returned
25425 in ordinary CPU registers instead.
25427 @item -mno-fancy-math-387
25428 @opindex mno-fancy-math-387
25429 Some 387 emulators do not support the @code{sin}, @code{cos} and
25430 @code{sqrt} instructions for the 387.  Specify this option to avoid
25431 generating those instructions.  This option is the default on
25432 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
25433 indicates that the target CPU always has an FPU and so the
25434 instruction does not need emulation.  These
25435 instructions are not generated unless you also use the
25436 @option{-funsafe-math-optimizations} switch.
25438 @item -malign-double
25439 @itemx -mno-align-double
25440 @opindex malign-double
25441 @opindex mno-align-double
25442 Control whether GCC aligns @code{double}, @code{long double}, and
25443 @code{long long} variables on a two-word boundary or a one-word
25444 boundary.  Aligning @code{double} variables on a two-word boundary
25445 produces code that runs somewhat faster on a Pentium at the
25446 expense of more memory.
25448 On x86-64, @option{-malign-double} is enabled by default.
25450 @strong{Warning:} if you use the @option{-malign-double} switch,
25451 structures containing the above types are aligned differently than
25452 the published application binary interface specifications for the x86-32
25453 and are not binary compatible with structures in code compiled
25454 without that switch.
25456 @item -m96bit-long-double
25457 @itemx -m128bit-long-double
25458 @opindex m96bit-long-double
25459 @opindex m128bit-long-double
25460 These switches control the size of @code{long double} type.  The x86-32
25461 application binary interface specifies the size to be 96 bits,
25462 so @option{-m96bit-long-double} is the default in 32-bit mode.
25464 Modern architectures (Pentium and newer) prefer @code{long double}
25465 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
25466 conforming to the ABI, this is not possible.  So specifying
25467 @option{-m128bit-long-double} aligns @code{long double}
25468 to a 16-byte boundary by padding the @code{long double} with an additional
25469 32-bit zero.
25471 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
25472 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
25474 Notice that neither of these options enable any extra precision over the x87
25475 standard of 80 bits for a @code{long double}.
25477 @strong{Warning:} if you override the default value for your target ABI, this
25478 changes the size of 
25479 structures and arrays containing @code{long double} variables,
25480 as well as modifying the function calling convention for functions taking
25481 @code{long double}.  Hence they are not binary-compatible
25482 with code compiled without that switch.
25484 @item -mlong-double-64
25485 @itemx -mlong-double-80
25486 @itemx -mlong-double-128
25487 @opindex mlong-double-64
25488 @opindex mlong-double-80
25489 @opindex mlong-double-128
25490 These switches control the size of @code{long double} type. A size
25491 of 64 bits makes the @code{long double} type equivalent to the @code{double}
25492 type. This is the default for 32-bit Bionic C library.  A size
25493 of 128 bits makes the @code{long double} type equivalent to the
25494 @code{__float128} type. This is the default for 64-bit Bionic C library.
25496 @strong{Warning:} if you override the default value for your target ABI, this
25497 changes the size of
25498 structures and arrays containing @code{long double} variables,
25499 as well as modifying the function calling convention for functions taking
25500 @code{long double}.  Hence they are not binary-compatible
25501 with code compiled without that switch.
25503 @item -malign-data=@var{type}
25504 @opindex malign-data
25505 Control how GCC aligns variables.  Supported values for @var{type} are
25506 @samp{compat} uses increased alignment value compatible uses GCC 4.8
25507 and earlier, @samp{abi} uses alignment value as specified by the
25508 psABI, and @samp{cacheline} uses increased alignment value to match
25509 the cache line size.  @samp{compat} is the default.
25511 @item -mlarge-data-threshold=@var{threshold}
25512 @opindex mlarge-data-threshold
25513 When @option{-mcmodel=medium} is specified, data objects larger than
25514 @var{threshold} are placed in the large data section.  This value must be the
25515 same across all objects linked into the binary, and defaults to 65535.
25517 @item -mrtd
25518 @opindex mrtd
25519 Use a different function-calling convention, in which functions that
25520 take a fixed number of arguments return with the @code{ret @var{num}}
25521 instruction, which pops their arguments while returning.  This saves one
25522 instruction in the caller since there is no need to pop the arguments
25523 there.
25525 You can specify that an individual function is called with this calling
25526 sequence with the function attribute @code{stdcall}.  You can also
25527 override the @option{-mrtd} option by using the function attribute
25528 @code{cdecl}.  @xref{Function Attributes}.
25530 @strong{Warning:} this calling convention is incompatible with the one
25531 normally used on Unix, so you cannot use it if you need to call
25532 libraries compiled with the Unix compiler.
25534 Also, you must provide function prototypes for all functions that
25535 take variable numbers of arguments (including @code{printf});
25536 otherwise incorrect code is generated for calls to those
25537 functions.
25539 In addition, seriously incorrect code results if you call a
25540 function with too many arguments.  (Normally, extra arguments are
25541 harmlessly ignored.)
25543 @item -mregparm=@var{num}
25544 @opindex mregparm
25545 Control how many registers are used to pass integer arguments.  By
25546 default, no registers are used to pass arguments, and at most 3
25547 registers can be used.  You can control this behavior for a specific
25548 function by using the function attribute @code{regparm}.
25549 @xref{Function Attributes}.
25551 @strong{Warning:} if you use this switch, and
25552 @var{num} is nonzero, then you must build all modules with the same
25553 value, including any libraries.  This includes the system libraries and
25554 startup modules.
25556 @item -msseregparm
25557 @opindex msseregparm
25558 Use SSE register passing conventions for float and double arguments
25559 and return values.  You can control this behavior for a specific
25560 function by using the function attribute @code{sseregparm}.
25561 @xref{Function Attributes}.
25563 @strong{Warning:} if you use this switch then you must build all
25564 modules with the same value, including any libraries.  This includes
25565 the system libraries and startup modules.
25567 @item -mvect8-ret-in-mem
25568 @opindex mvect8-ret-in-mem
25569 Return 8-byte vectors in memory instead of MMX registers.  This is the
25570 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
25571 Studio compilers until version 12.  Later compiler versions (starting
25572 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
25573 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
25574 you need to remain compatible with existing code produced by those
25575 previous compiler versions or older versions of GCC@.
25577 @item -mpc32
25578 @itemx -mpc64
25579 @itemx -mpc80
25580 @opindex mpc32
25581 @opindex mpc64
25582 @opindex mpc80
25584 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
25585 is specified, the significands of results of floating-point operations are
25586 rounded to 24 bits (single precision); @option{-mpc64} rounds the
25587 significands of results of floating-point operations to 53 bits (double
25588 precision) and @option{-mpc80} rounds the significands of results of
25589 floating-point operations to 64 bits (extended double precision), which is
25590 the default.  When this option is used, floating-point operations in higher
25591 precisions are not available to the programmer without setting the FPU
25592 control word explicitly.
25594 Setting the rounding of floating-point operations to less than the default
25595 80 bits can speed some programs by 2% or more.  Note that some mathematical
25596 libraries assume that extended-precision (80-bit) floating-point operations
25597 are enabled by default; routines in such libraries could suffer significant
25598 loss of accuracy, typically through so-called ``catastrophic cancellation'',
25599 when this option is used to set the precision to less than extended precision.
25601 @item -mstackrealign
25602 @opindex mstackrealign
25603 Realign the stack at entry.  On the x86, the @option{-mstackrealign}
25604 option generates an alternate prologue and epilogue that realigns the
25605 run-time stack if necessary.  This supports mixing legacy codes that keep
25606 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
25607 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
25608 applicable to individual functions.
25610 @item -mpreferred-stack-boundary=@var{num}
25611 @opindex mpreferred-stack-boundary
25612 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
25613 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
25614 the default is 4 (16 bytes or 128 bits).
25616 @strong{Warning:} When generating code for the x86-64 architecture with
25617 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
25618 used to keep the stack boundary aligned to 8 byte boundary.  Since
25619 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
25620 intended to be used in controlled environment where stack space is
25621 important limitation.  This option leads to wrong code when functions
25622 compiled with 16 byte stack alignment (such as functions from a standard
25623 library) are called with misaligned stack.  In this case, SSE
25624 instructions may lead to misaligned memory access traps.  In addition,
25625 variable arguments are handled incorrectly for 16 byte aligned
25626 objects (including x87 long double and __int128), leading to wrong
25627 results.  You must build all modules with
25628 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
25629 includes the system libraries and startup modules.
25631 @item -mincoming-stack-boundary=@var{num}
25632 @opindex mincoming-stack-boundary
25633 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
25634 boundary.  If @option{-mincoming-stack-boundary} is not specified,
25635 the one specified by @option{-mpreferred-stack-boundary} is used.
25637 On Pentium and Pentium Pro, @code{double} and @code{long double} values
25638 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
25639 suffer significant run time performance penalties.  On Pentium III, the
25640 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
25641 properly if it is not 16-byte aligned.
25643 To ensure proper alignment of this values on the stack, the stack boundary
25644 must be as aligned as that required by any value stored on the stack.
25645 Further, every function must be generated such that it keeps the stack
25646 aligned.  Thus calling a function compiled with a higher preferred
25647 stack boundary from a function compiled with a lower preferred stack
25648 boundary most likely misaligns the stack.  It is recommended that
25649 libraries that use callbacks always use the default setting.
25651 This extra alignment does consume extra stack space, and generally
25652 increases code size.  Code that is sensitive to stack space usage, such
25653 as embedded systems and operating system kernels, may want to reduce the
25654 preferred alignment to @option{-mpreferred-stack-boundary=2}.
25656 @need 200
25657 @item -mmmx
25658 @opindex mmmx
25659 @need 200
25660 @itemx -msse
25661 @opindex msse
25662 @need 200
25663 @itemx -msse2
25664 @opindex msse2
25665 @need 200
25666 @itemx -msse3
25667 @opindex msse3
25668 @need 200
25669 @itemx -mssse3
25670 @opindex mssse3
25671 @need 200
25672 @itemx -msse4
25673 @opindex msse4
25674 @need 200
25675 @itemx -msse4a
25676 @opindex msse4a
25677 @need 200
25678 @itemx -msse4.1
25679 @opindex msse4.1
25680 @need 200
25681 @itemx -msse4.2
25682 @opindex msse4.2
25683 @need 200
25684 @itemx -mavx
25685 @opindex mavx
25686 @need 200
25687 @itemx -mavx2
25688 @opindex mavx2
25689 @need 200
25690 @itemx -mavx512f
25691 @opindex mavx512f
25692 @need 200
25693 @itemx -mavx512pf
25694 @opindex mavx512pf
25695 @need 200
25696 @itemx -mavx512er
25697 @opindex mavx512er
25698 @need 200
25699 @itemx -mavx512cd
25700 @opindex mavx512cd
25701 @need 200
25702 @itemx -mavx512vl
25703 @opindex mavx512vl
25704 @need 200
25705 @itemx -mavx512bw
25706 @opindex mavx512bw
25707 @need 200
25708 @itemx -mavx512dq
25709 @opindex mavx512dq
25710 @need 200
25711 @itemx -mavx512ifma
25712 @opindex mavx512ifma
25713 @need 200
25714 @itemx -mavx512vbmi
25715 @opindex mavx512vbmi
25716 @need 200
25717 @itemx -msha
25718 @opindex msha
25719 @need 200
25720 @itemx -maes
25721 @opindex maes
25722 @need 200
25723 @itemx -mpclmul
25724 @opindex mpclmul
25725 @need 200
25726 @itemx -mclfushopt
25727 @opindex mclfushopt
25728 @need 200
25729 @itemx -mfsgsbase
25730 @opindex mfsgsbase
25731 @need 200
25732 @itemx -mrdrnd
25733 @opindex mrdrnd
25734 @need 200
25735 @itemx -mf16c
25736 @opindex mf16c
25737 @need 200
25738 @itemx -mfma
25739 @opindex mfma
25740 @need 200
25741 @itemx -mfma4
25742 @opindex mfma4
25743 @need 200
25744 @itemx -mprefetchwt1
25745 @opindex mprefetchwt1
25746 @need 200
25747 @itemx -mxop
25748 @opindex mxop
25749 @need 200
25750 @itemx -mlwp
25751 @opindex mlwp
25752 @need 200
25753 @itemx -m3dnow
25754 @opindex m3dnow
25755 @need 200
25756 @itemx -m3dnowa
25757 @opindex m3dnowa
25758 @need 200
25759 @itemx -mpopcnt
25760 @opindex mpopcnt
25761 @need 200
25762 @itemx -mabm
25763 @opindex mabm
25764 @need 200
25765 @itemx -mbmi
25766 @opindex mbmi
25767 @need 200
25768 @itemx -mbmi2
25769 @need 200
25770 @itemx -mlzcnt
25771 @opindex mlzcnt
25772 @need 200
25773 @itemx -mfxsr
25774 @opindex mfxsr
25775 @need 200
25776 @itemx -mxsave
25777 @opindex mxsave
25778 @need 200
25779 @itemx -mxsaveopt
25780 @opindex mxsaveopt
25781 @need 200
25782 @itemx -mxsavec
25783 @opindex mxsavec
25784 @need 200
25785 @itemx -mxsaves
25786 @opindex mxsaves
25787 @need 200
25788 @itemx -mrtm
25789 @opindex mrtm
25790 @need 200
25791 @itemx -mtbm
25792 @opindex mtbm
25793 @need 200
25794 @itemx -mmpx
25795 @opindex mmpx
25796 @need 200
25797 @itemx -mmwaitx
25798 @opindex mmwaitx
25799 @need 200
25800 @itemx -mclzero
25801 @opindex mclzero
25802 @itemx -mpku
25803 @opindex mpku
25804 These switches enable the use of instructions in the MMX, SSE,
25805 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
25806 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
25807 AVX512VL, AVX512BW, AVX512DQ, AVX512IFMA AVX512VBMI, BMI, BMI2, FXSR,
25808 XSAVE, XSAVEOPT, LZCNT, RTM, MPX, MWAITX, PKU, 3DNow!@: or enhanced 3DNow!@:
25809 extended instruction sets.  Each has a corresponding @option{-mno-} option
25810 to disable use of these instructions.
25812 These extensions are also available as built-in functions: see
25813 @ref{x86 Built-in Functions}, for details of the functions enabled and
25814 disabled by these switches.
25816 To generate SSE/SSE2 instructions automatically from floating-point
25817 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
25819 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
25820 generates new AVX instructions or AVX equivalence for all SSEx instructions
25821 when needed.
25823 These options enable GCC to use these extended instructions in
25824 generated code, even without @option{-mfpmath=sse}.  Applications that
25825 perform run-time CPU detection must compile separate files for each
25826 supported architecture, using the appropriate flags.  In particular,
25827 the file containing the CPU detection code should be compiled without
25828 these options.
25830 @item -mdump-tune-features
25831 @opindex mdump-tune-features
25832 This option instructs GCC to dump the names of the x86 performance 
25833 tuning features and default settings. The names can be used in 
25834 @option{-mtune-ctrl=@var{feature-list}}.
25836 @item -mtune-ctrl=@var{feature-list}
25837 @opindex mtune-ctrl=@var{feature-list}
25838 This option is used to do fine grain control of x86 code generation features.
25839 @var{feature-list} is a comma separated list of @var{feature} names. See also
25840 @option{-mdump-tune-features}. When specified, the @var{feature} is turned
25841 on if it is not preceded with @samp{^}, otherwise, it is turned off. 
25842 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
25843 developers. Using it may lead to code paths not covered by testing and can
25844 potentially result in compiler ICEs or runtime errors.
25846 @item -mno-default
25847 @opindex mno-default
25848 This option instructs GCC to turn off all tunable features. See also 
25849 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
25851 @item -mcld
25852 @opindex mcld
25853 This option instructs GCC to emit a @code{cld} instruction in the prologue
25854 of functions that use string instructions.  String instructions depend on
25855 the DF flag to select between autoincrement or autodecrement mode.  While the
25856 ABI specifies the DF flag to be cleared on function entry, some operating
25857 systems violate this specification by not clearing the DF flag in their
25858 exception dispatchers.  The exception handler can be invoked with the DF flag
25859 set, which leads to wrong direction mode when string instructions are used.
25860 This option can be enabled by default on 32-bit x86 targets by configuring
25861 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
25862 instructions can be suppressed with the @option{-mno-cld} compiler option
25863 in this case.
25865 @item -mvzeroupper
25866 @opindex mvzeroupper
25867 This option instructs GCC to emit a @code{vzeroupper} instruction
25868 before a transfer of control flow out of the function to minimize
25869 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
25870 intrinsics.
25872 @item -mprefer-avx128
25873 @opindex mprefer-avx128
25874 This option instructs GCC to use 128-bit AVX instructions instead of
25875 256-bit AVX instructions in the auto-vectorizer.
25877 @item -mprefer-avx256
25878 @opindex mprefer-avx256
25879 This option instructs GCC to use 256-bit AVX instructions instead of
25880 512-bit AVX instructions in the auto-vectorizer.
25882 @item -mcx16
25883 @opindex mcx16
25884 This option enables GCC to generate @code{CMPXCHG16B} instructions in 64-bit
25885 code to implement compare-and-exchange operations on 16-byte aligned 128-bit
25886 objects.  This is useful for atomic updates of data structures exceeding one
25887 machine word in size.  The compiler uses this instruction to implement
25888 @ref{__sync Builtins}.  However, for @ref{__atomic Builtins} operating on
25889 128-bit integers, a library call is always used.
25891 @item -msahf
25892 @opindex msahf
25893 This option enables generation of @code{SAHF} instructions in 64-bit code.
25894 Early Intel Pentium 4 CPUs with Intel 64 support,
25895 prior to the introduction of Pentium 4 G1 step in December 2005,
25896 lacked the @code{LAHF} and @code{SAHF} instructions
25897 which are supported by AMD64.
25898 These are load and store instructions, respectively, for certain status flags.
25899 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
25900 @code{drem}, and @code{remainder} built-in functions;
25901 see @ref{Other Builtins} for details.
25903 @item -mmovbe
25904 @opindex mmovbe
25905 This option enables use of the @code{movbe} instruction to implement
25906 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
25908 @item -mcrc32
25909 @opindex mcrc32
25910 This option enables built-in functions @code{__builtin_ia32_crc32qi},
25911 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
25912 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
25914 @item -mrecip
25915 @opindex mrecip
25916 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
25917 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
25918 with an additional Newton-Raphson step
25919 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
25920 (and their vectorized
25921 variants) for single-precision floating-point arguments.  These instructions
25922 are generated only when @option{-funsafe-math-optimizations} is enabled
25923 together with @option{-ffinite-math-only} and @option{-fno-trapping-math}.
25924 Note that while the throughput of the sequence is higher than the throughput
25925 of the non-reciprocal instruction, the precision of the sequence can be
25926 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
25928 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
25929 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
25930 combination), and doesn't need @option{-mrecip}.
25932 Also note that GCC emits the above sequence with additional Newton-Raphson step
25933 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
25934 already with @option{-ffast-math} (or the above option combination), and
25935 doesn't need @option{-mrecip}.
25937 @item -mrecip=@var{opt}
25938 @opindex mrecip=opt
25939 This option controls which reciprocal estimate instructions
25940 may be used.  @var{opt} is a comma-separated list of options, which may
25941 be preceded by a @samp{!} to invert the option:
25943 @table @samp
25944 @item all
25945 Enable all estimate instructions.
25947 @item default
25948 Enable the default instructions, equivalent to @option{-mrecip}.
25950 @item none
25951 Disable all estimate instructions, equivalent to @option{-mno-recip}.
25953 @item div
25954 Enable the approximation for scalar division.
25956 @item vec-div
25957 Enable the approximation for vectorized division.
25959 @item sqrt
25960 Enable the approximation for scalar square root.
25962 @item vec-sqrt
25963 Enable the approximation for vectorized square root.
25964 @end table
25966 So, for example, @option{-mrecip=all,!sqrt} enables
25967 all of the reciprocal approximations, except for square root.
25969 @item -mveclibabi=@var{type}
25970 @opindex mveclibabi
25971 Specifies the ABI type to use for vectorizing intrinsics using an
25972 external library.  Supported values for @var{type} are @samp{svml} 
25973 for the Intel short
25974 vector math library and @samp{acml} for the AMD math core library.
25975 To use this option, both @option{-ftree-vectorize} and
25976 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
25977 ABI-compatible library must be specified at link time.
25979 GCC currently emits calls to @code{vmldExp2},
25980 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
25981 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
25982 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
25983 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
25984 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
25985 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
25986 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
25987 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
25988 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
25989 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
25990 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
25991 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
25992 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
25993 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
25994 when @option{-mveclibabi=acml} is used.  
25996 @item -mabi=@var{name}
25997 @opindex mabi
25998 Generate code for the specified calling convention.  Permissible values
25999 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
26000 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
26001 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
26002 You can control this behavior for specific functions by
26003 using the function attributes @code{ms_abi} and @code{sysv_abi}.
26004 @xref{Function Attributes}.
26006 @item -mcall-ms2sysv-xlogues
26007 @opindex mcall-ms2sysv-xlogues
26008 @opindex mno-call-ms2sysv-xlogues
26009 Due to differences in 64-bit ABIs, any Microsoft ABI function that calls a
26010 System V ABI function must consider RSI, RDI and XMM6-15 as clobbered.  By
26011 default, the code for saving and restoring these registers is emitted inline,
26012 resulting in fairly lengthy prologues and epilogues.  Using
26013 @option{-mcall-ms2sysv-xlogues} emits prologues and epilogues that
26014 use stubs in the static portion of libgcc to perform these saves and restores,
26015 thus reducing function size at the cost of a few extra instructions.
26017 @item -mtls-dialect=@var{type}
26018 @opindex mtls-dialect
26019 Generate code to access thread-local storage using the @samp{gnu} or
26020 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
26021 @samp{gnu2} is more efficient, but it may add compile- and run-time
26022 requirements that cannot be satisfied on all systems.
26024 @item -mpush-args
26025 @itemx -mno-push-args
26026 @opindex mpush-args
26027 @opindex mno-push-args
26028 Use PUSH operations to store outgoing parameters.  This method is shorter
26029 and usually equally fast as method using SUB/MOV operations and is enabled
26030 by default.  In some cases disabling it may improve performance because of
26031 improved scheduling and reduced dependencies.
26033 @item -maccumulate-outgoing-args
26034 @opindex maccumulate-outgoing-args
26035 If enabled, the maximum amount of space required for outgoing arguments is
26036 computed in the function prologue.  This is faster on most modern CPUs
26037 because of reduced dependencies, improved scheduling and reduced stack usage
26038 when the preferred stack boundary is not equal to 2.  The drawback is a notable
26039 increase in code size.  This switch implies @option{-mno-push-args}.
26041 @item -mthreads
26042 @opindex mthreads
26043 Support thread-safe exception handling on MinGW.  Programs that rely
26044 on thread-safe exception handling must compile and link all code with the
26045 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
26046 @option{-D_MT}; when linking, it links in a special thread helper library
26047 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
26049 @item -mms-bitfields
26050 @itemx -mno-ms-bitfields
26051 @opindex mms-bitfields
26052 @opindex mno-ms-bitfields
26054 Enable/disable bit-field layout compatible with the native Microsoft
26055 Windows compiler.  
26057 If @code{packed} is used on a structure, or if bit-fields are used,
26058 it may be that the Microsoft ABI lays out the structure differently
26059 than the way GCC normally does.  Particularly when moving packed
26060 data between functions compiled with GCC and the native Microsoft compiler
26061 (either via function call or as data in a file), it may be necessary to access
26062 either format.
26064 This option is enabled by default for Microsoft Windows
26065 targets.  This behavior can also be controlled locally by use of variable
26066 or type attributes.  For more information, see @ref{x86 Variable Attributes}
26067 and @ref{x86 Type Attributes}.
26069 The Microsoft structure layout algorithm is fairly simple with the exception
26070 of the bit-field packing.  
26071 The padding and alignment of members of structures and whether a bit-field 
26072 can straddle a storage-unit boundary are determine by these rules:
26074 @enumerate
26075 @item Structure members are stored sequentially in the order in which they are
26076 declared: the first member has the lowest memory address and the last member
26077 the highest.
26079 @item Every data object has an alignment requirement.  The alignment requirement
26080 for all data except structures, unions, and arrays is either the size of the
26081 object or the current packing size (specified with either the
26082 @code{aligned} attribute or the @code{pack} pragma),
26083 whichever is less.  For structures, unions, and arrays,
26084 the alignment requirement is the largest alignment requirement of its members.
26085 Every object is allocated an offset so that:
26087 @smallexample
26088 offset % alignment_requirement == 0
26089 @end smallexample
26091 @item Adjacent bit-fields are packed into the same 1-, 2-, or 4-byte allocation
26092 unit if the integral types are the same size and if the next bit-field fits
26093 into the current allocation unit without crossing the boundary imposed by the
26094 common alignment requirements of the bit-fields.
26095 @end enumerate
26097 MSVC interprets zero-length bit-fields in the following ways:
26099 @enumerate
26100 @item If a zero-length bit-field is inserted between two bit-fields that
26101 are normally coalesced, the bit-fields are not coalesced.
26103 For example:
26105 @smallexample
26106 struct
26107  @{
26108    unsigned long bf_1 : 12;
26109    unsigned long : 0;
26110    unsigned long bf_2 : 12;
26111  @} t1;
26112 @end smallexample
26114 @noindent
26115 The size of @code{t1} is 8 bytes with the zero-length bit-field.  If the
26116 zero-length bit-field were removed, @code{t1}'s size would be 4 bytes.
26118 @item If a zero-length bit-field is inserted after a bit-field, @code{foo}, and the
26119 alignment of the zero-length bit-field is greater than the member that follows it,
26120 @code{bar}, @code{bar} is aligned as the type of the zero-length bit-field.
26122 For example:
26124 @smallexample
26125 struct
26126  @{
26127    char foo : 4;
26128    short : 0;
26129    char bar;
26130  @} t2;
26132 struct
26133  @{
26134    char foo : 4;
26135    short : 0;
26136    double bar;
26137  @} t3;
26138 @end smallexample
26140 @noindent
26141 For @code{t2}, @code{bar} is placed at offset 2, rather than offset 1.
26142 Accordingly, the size of @code{t2} is 4.  For @code{t3}, the zero-length
26143 bit-field does not affect the alignment of @code{bar} or, as a result, the size
26144 of the structure.
26146 Taking this into account, it is important to note the following:
26148 @enumerate
26149 @item If a zero-length bit-field follows a normal bit-field, the type of the
26150 zero-length bit-field may affect the alignment of the structure as whole. For
26151 example, @code{t2} has a size of 4 bytes, since the zero-length bit-field follows a
26152 normal bit-field, and is of type short.
26154 @item Even if a zero-length bit-field is not followed by a normal bit-field, it may
26155 still affect the alignment of the structure:
26157 @smallexample
26158 struct
26159  @{
26160    char foo : 6;
26161    long : 0;
26162  @} t4;
26163 @end smallexample
26165 @noindent
26166 Here, @code{t4} takes up 4 bytes.
26167 @end enumerate
26169 @item Zero-length bit-fields following non-bit-field members are ignored:
26171 @smallexample
26172 struct
26173  @{
26174    char foo;
26175    long : 0;
26176    char bar;
26177  @} t5;
26178 @end smallexample
26180 @noindent
26181 Here, @code{t5} takes up 2 bytes.
26182 @end enumerate
26185 @item -mno-align-stringops
26186 @opindex mno-align-stringops
26187 Do not align the destination of inlined string operations.  This switch reduces
26188 code size and improves performance in case the destination is already aligned,
26189 but GCC doesn't know about it.
26191 @item -minline-all-stringops
26192 @opindex minline-all-stringops
26193 By default GCC inlines string operations only when the destination is 
26194 known to be aligned to least a 4-byte boundary.  
26195 This enables more inlining and increases code
26196 size, but may improve performance of code that depends on fast
26197 @code{memcpy}, @code{strlen},
26198 and @code{memset} for short lengths.
26200 @item -minline-stringops-dynamically
26201 @opindex minline-stringops-dynamically
26202 For string operations of unknown size, use run-time checks with
26203 inline code for small blocks and a library call for large blocks.
26205 @item -mstringop-strategy=@var{alg}
26206 @opindex mstringop-strategy=@var{alg}
26207 Override the internal decision heuristic for the particular algorithm to use
26208 for inlining string operations.  The allowed values for @var{alg} are:
26210 @table @samp
26211 @item rep_byte
26212 @itemx rep_4byte
26213 @itemx rep_8byte
26214 Expand using i386 @code{rep} prefix of the specified size.
26216 @item byte_loop
26217 @itemx loop
26218 @itemx unrolled_loop
26219 Expand into an inline loop.
26221 @item libcall
26222 Always use a library call.
26223 @end table
26225 @item -mmemcpy-strategy=@var{strategy}
26226 @opindex mmemcpy-strategy=@var{strategy}
26227 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
26228 should be inlined and what inline algorithm to use when the expected size
26229 of the copy operation is known. @var{strategy} 
26230 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
26231 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
26232 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
26233 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
26234 in the list must be specified in increasing order.  The minimal byte size for 
26235 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
26236 preceding range.
26238 @item -mmemset-strategy=@var{strategy}
26239 @opindex mmemset-strategy=@var{strategy}
26240 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
26241 @code{__builtin_memset} expansion.
26243 @item -momit-leaf-frame-pointer
26244 @opindex momit-leaf-frame-pointer
26245 Don't keep the frame pointer in a register for leaf functions.  This
26246 avoids the instructions to save, set up, and restore frame pointers and
26247 makes an extra register available in leaf functions.  The option
26248 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
26249 which might make debugging harder.
26251 @item -mtls-direct-seg-refs
26252 @itemx -mno-tls-direct-seg-refs
26253 @opindex mtls-direct-seg-refs
26254 Controls whether TLS variables may be accessed with offsets from the
26255 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
26256 or whether the thread base pointer must be added.  Whether or not this
26257 is valid depends on the operating system, and whether it maps the
26258 segment to cover the entire TLS area.
26260 For systems that use the GNU C Library, the default is on.
26262 @item -msse2avx
26263 @itemx -mno-sse2avx
26264 @opindex msse2avx
26265 Specify that the assembler should encode SSE instructions with VEX
26266 prefix.  The option @option{-mavx} turns this on by default.
26268 @item -mfentry
26269 @itemx -mno-fentry
26270 @opindex mfentry
26271 If profiling is active (@option{-pg}), put the profiling
26272 counter call before the prologue.
26273 Note: On x86 architectures the attribute @code{ms_hook_prologue}
26274 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
26276 @item -mrecord-mcount
26277 @itemx -mno-record-mcount
26278 @opindex mrecord-mcount
26279 If profiling is active (@option{-pg}), generate a __mcount_loc section
26280 that contains pointers to each profiling call. This is useful for
26281 automatically patching and out calls.
26283 @item -mnop-mcount
26284 @itemx -mno-nop-mcount
26285 @opindex mnop-mcount
26286 If profiling is active (@option{-pg}), generate the calls to
26287 the profiling functions as NOPs. This is useful when they
26288 should be patched in later dynamically. This is likely only
26289 useful together with @option{-mrecord-mcount}.
26291 @item -mskip-rax-setup
26292 @itemx -mno-skip-rax-setup
26293 @opindex mskip-rax-setup
26294 When generating code for the x86-64 architecture with SSE extensions
26295 disabled, @option{-mskip-rax-setup} can be used to skip setting up RAX
26296 register when there are no variable arguments passed in vector registers.
26298 @strong{Warning:} Since RAX register is used to avoid unnecessarily
26299 saving vector registers on stack when passing variable arguments, the
26300 impacts of this option are callees may waste some stack space,
26301 misbehave or jump to a random location.  GCC 4.4 or newer don't have
26302 those issues, regardless the RAX register value.
26304 @item -m8bit-idiv
26305 @itemx -mno-8bit-idiv
26306 @opindex m8bit-idiv
26307 On some processors, like Intel Atom, 8-bit unsigned integer divide is
26308 much faster than 32-bit/64-bit integer divide.  This option generates a
26309 run-time check.  If both dividend and divisor are within range of 0
26310 to 255, 8-bit unsigned integer divide is used instead of
26311 32-bit/64-bit integer divide.
26313 @item -mavx256-split-unaligned-load
26314 @itemx -mavx256-split-unaligned-store
26315 @opindex mavx256-split-unaligned-load
26316 @opindex mavx256-split-unaligned-store
26317 Split 32-byte AVX unaligned load and store.
26319 @item -mstack-protector-guard=@var{guard}
26320 @itemx -mstack-protector-guard-reg=@var{reg}
26321 @itemx -mstack-protector-guard-offset=@var{offset}
26322 @opindex mstack-protector-guard
26323 @opindex mstack-protector-guard-reg
26324 @opindex mstack-protector-guard-offset
26325 Generate stack protection code using canary at @var{guard}.  Supported
26326 locations are @samp{global} for global canary or @samp{tls} for per-thread
26327 canary in the TLS block (the default).  This option has effect only when
26328 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
26330 With the latter choice the options
26331 @option{-mstack-protector-guard-reg=@var{reg}} and
26332 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
26333 which segment register (@code{%fs} or @code{%gs}) to use as base register
26334 for reading the canary, and from what offset from that base register.
26335 The default for those is as specified in the relevant ABI.
26337 @item -mmitigate-rop
26338 @opindex mmitigate-rop
26339 Try to avoid generating code sequences that contain unintended return
26340 opcodes, to mitigate against certain forms of attack. At the moment,
26341 this option is limited in what it can do and should not be relied
26342 on to provide serious protection.
26344 @item -mgeneral-regs-only
26345 @opindex mgeneral-regs-only
26346 Generate code that uses only the general-purpose registers.  This
26347 prevents the compiler from using floating-point, vector, mask and bound
26348 registers.
26350 @end table
26352 These @samp{-m} switches are supported in addition to the above
26353 on x86-64 processors in 64-bit environments.
26355 @table @gcctabopt
26356 @item -m32
26357 @itemx -m64
26358 @itemx -mx32
26359 @itemx -m16
26360 @itemx -miamcu
26361 @opindex m32
26362 @opindex m64
26363 @opindex mx32
26364 @opindex m16
26365 @opindex miamcu
26366 Generate code for a 16-bit, 32-bit or 64-bit environment.
26367 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
26368 to 32 bits, and
26369 generates code that runs on any i386 system.
26371 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
26372 types to 64 bits, and generates code for the x86-64 architecture.
26373 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
26374 and @option{-mdynamic-no-pic} options.
26376 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
26377 to 32 bits, and
26378 generates code for the x86-64 architecture.
26380 The @option{-m16} option is the same as @option{-m32}, except for that
26381 it outputs the @code{.code16gcc} assembly directive at the beginning of
26382 the assembly output so that the binary can run in 16-bit mode.
26384 The @option{-miamcu} option generates code which conforms to Intel MCU
26385 psABI.  It requires the @option{-m32} option to be turned on.
26387 @item -mno-red-zone
26388 @opindex mno-red-zone
26389 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
26390 by the x86-64 ABI; it is a 128-byte area beyond the location of the
26391 stack pointer that is not modified by signal or interrupt handlers
26392 and therefore can be used for temporary data without adjusting the stack
26393 pointer.  The flag @option{-mno-red-zone} disables this red zone.
26395 @item -mcmodel=small
26396 @opindex mcmodel=small
26397 Generate code for the small code model: the program and its symbols must
26398 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
26399 Programs can be statically or dynamically linked.  This is the default
26400 code model.
26402 @item -mcmodel=kernel
26403 @opindex mcmodel=kernel
26404 Generate code for the kernel code model.  The kernel runs in the
26405 negative 2 GB of the address space.
26406 This model has to be used for Linux kernel code.
26408 @item -mcmodel=medium
26409 @opindex mcmodel=medium
26410 Generate code for the medium model: the program is linked in the lower 2
26411 GB of the address space.  Small symbols are also placed there.  Symbols
26412 with sizes larger than @option{-mlarge-data-threshold} are put into
26413 large data or BSS sections and can be located above 2GB.  Programs can
26414 be statically or dynamically linked.
26416 @item -mcmodel=large
26417 @opindex mcmodel=large
26418 Generate code for the large model.  This model makes no assumptions
26419 about addresses and sizes of sections.
26421 @item -maddress-mode=long
26422 @opindex maddress-mode=long
26423 Generate code for long address mode.  This is only supported for 64-bit
26424 and x32 environments.  It is the default address mode for 64-bit
26425 environments.
26427 @item -maddress-mode=short
26428 @opindex maddress-mode=short
26429 Generate code for short address mode.  This is only supported for 32-bit
26430 and x32 environments.  It is the default address mode for 32-bit and
26431 x32 environments.
26432 @end table
26434 @node x86 Windows Options
26435 @subsection x86 Windows Options
26436 @cindex x86 Windows Options
26437 @cindex Windows Options for x86
26439 These additional options are available for Microsoft Windows targets:
26441 @table @gcctabopt
26442 @item -mconsole
26443 @opindex mconsole
26444 This option
26445 specifies that a console application is to be generated, by
26446 instructing the linker to set the PE header subsystem type
26447 required for console applications.
26448 This option is available for Cygwin and MinGW targets and is
26449 enabled by default on those targets.
26451 @item -mdll
26452 @opindex mdll
26453 This option is available for Cygwin and MinGW targets.  It
26454 specifies that a DLL---a dynamic link library---is to be
26455 generated, enabling the selection of the required runtime
26456 startup object and entry point.
26458 @item -mnop-fun-dllimport
26459 @opindex mnop-fun-dllimport
26460 This option is available for Cygwin and MinGW targets.  It
26461 specifies that the @code{dllimport} attribute should be ignored.
26463 @item -mthread
26464 @opindex mthread
26465 This option is available for MinGW targets. It specifies
26466 that MinGW-specific thread support is to be used.
26468 @item -municode
26469 @opindex municode
26470 This option is available for MinGW-w64 targets.  It causes
26471 the @code{UNICODE} preprocessor macro to be predefined, and
26472 chooses Unicode-capable runtime startup code.
26474 @item -mwin32
26475 @opindex mwin32
26476 This option is available for Cygwin and MinGW targets.  It
26477 specifies that the typical Microsoft Windows predefined macros are to
26478 be set in the pre-processor, but does not influence the choice
26479 of runtime library/startup code.
26481 @item -mwindows
26482 @opindex mwindows
26483 This option is available for Cygwin and MinGW targets.  It
26484 specifies that a GUI application is to be generated by
26485 instructing the linker to set the PE header subsystem type
26486 appropriately.
26488 @item -fno-set-stack-executable
26489 @opindex fno-set-stack-executable
26490 This option is available for MinGW targets. It specifies that
26491 the executable flag for the stack used by nested functions isn't
26492 set. This is necessary for binaries running in kernel mode of
26493 Microsoft Windows, as there the User32 API, which is used to set executable
26494 privileges, isn't available.
26496 @item -fwritable-relocated-rdata
26497 @opindex fno-writable-relocated-rdata
26498 This option is available for MinGW and Cygwin targets.  It specifies
26499 that relocated-data in read-only section is put into the @code{.data}
26500 section.  This is a necessary for older runtimes not supporting
26501 modification of @code{.rdata} sections for pseudo-relocation.
26503 @item -mpe-aligned-commons
26504 @opindex mpe-aligned-commons
26505 This option is available for Cygwin and MinGW targets.  It
26506 specifies that the GNU extension to the PE file format that
26507 permits the correct alignment of COMMON variables should be
26508 used when generating code.  It is enabled by default if
26509 GCC detects that the target assembler found during configuration
26510 supports the feature.
26511 @end table
26513 See also under @ref{x86 Options} for standard options.
26515 @node Xstormy16 Options
26516 @subsection Xstormy16 Options
26517 @cindex Xstormy16 Options
26519 These options are defined for Xstormy16:
26521 @table @gcctabopt
26522 @item -msim
26523 @opindex msim
26524 Choose startup files and linker script suitable for the simulator.
26525 @end table
26527 @node Xtensa Options
26528 @subsection Xtensa Options
26529 @cindex Xtensa Options
26531 These options are supported for Xtensa targets:
26533 @table @gcctabopt
26534 @item -mconst16
26535 @itemx -mno-const16
26536 @opindex mconst16
26537 @opindex mno-const16
26538 Enable or disable use of @code{CONST16} instructions for loading
26539 constant values.  The @code{CONST16} instruction is currently not a
26540 standard option from Tensilica.  When enabled, @code{CONST16}
26541 instructions are always used in place of the standard @code{L32R}
26542 instructions.  The use of @code{CONST16} is enabled by default only if
26543 the @code{L32R} instruction is not available.
26545 @item -mfused-madd
26546 @itemx -mno-fused-madd
26547 @opindex mfused-madd
26548 @opindex mno-fused-madd
26549 Enable or disable use of fused multiply/add and multiply/subtract
26550 instructions in the floating-point option.  This has no effect if the
26551 floating-point option is not also enabled.  Disabling fused multiply/add
26552 and multiply/subtract instructions forces the compiler to use separate
26553 instructions for the multiply and add/subtract operations.  This may be
26554 desirable in some cases where strict IEEE 754-compliant results are
26555 required: the fused multiply add/subtract instructions do not round the
26556 intermediate result, thereby producing results with @emph{more} bits of
26557 precision than specified by the IEEE standard.  Disabling fused multiply
26558 add/subtract instructions also ensures that the program output is not
26559 sensitive to the compiler's ability to combine multiply and add/subtract
26560 operations.
26562 @item -mserialize-volatile
26563 @itemx -mno-serialize-volatile
26564 @opindex mserialize-volatile
26565 @opindex mno-serialize-volatile
26566 When this option is enabled, GCC inserts @code{MEMW} instructions before
26567 @code{volatile} memory references to guarantee sequential consistency.
26568 The default is @option{-mserialize-volatile}.  Use
26569 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
26571 @item -mforce-no-pic
26572 @opindex mforce-no-pic
26573 For targets, like GNU/Linux, where all user-mode Xtensa code must be
26574 position-independent code (PIC), this option disables PIC for compiling
26575 kernel code.
26577 @item -mtext-section-literals
26578 @itemx -mno-text-section-literals
26579 @opindex mtext-section-literals
26580 @opindex mno-text-section-literals
26581 These options control the treatment of literal pools.  The default is
26582 @option{-mno-text-section-literals}, which places literals in a separate
26583 section in the output file.  This allows the literal pool to be placed
26584 in a data RAM/ROM, and it also allows the linker to combine literal
26585 pools from separate object files to remove redundant literals and
26586 improve code size.  With @option{-mtext-section-literals}, the literals
26587 are interspersed in the text section in order to keep them as close as
26588 possible to their references.  This may be necessary for large assembly
26589 files.  Literals for each function are placed right before that function.
26591 @item -mauto-litpools
26592 @itemx -mno-auto-litpools
26593 @opindex mauto-litpools
26594 @opindex mno-auto-litpools
26595 These options control the treatment of literal pools.  The default is
26596 @option{-mno-auto-litpools}, which places literals in a separate
26597 section in the output file unless @option{-mtext-section-literals} is
26598 used.  With @option{-mauto-litpools} the literals are interspersed in
26599 the text section by the assembler.  Compiler does not produce explicit
26600 @code{.literal} directives and loads literals into registers with
26601 @code{MOVI} instructions instead of @code{L32R} to let the assembler
26602 do relaxation and place literals as necessary.  This option allows
26603 assembler to create several literal pools per function and assemble
26604 very big functions, which may not be possible with
26605 @option{-mtext-section-literals}.
26607 @item -mtarget-align
26608 @itemx -mno-target-align
26609 @opindex mtarget-align
26610 @opindex mno-target-align
26611 When this option is enabled, GCC instructs the assembler to
26612 automatically align instructions to reduce branch penalties at the
26613 expense of some code density.  The assembler attempts to widen density
26614 instructions to align branch targets and the instructions following call
26615 instructions.  If there are not enough preceding safe density
26616 instructions to align a target, no widening is performed.  The
26617 default is @option{-mtarget-align}.  These options do not affect the
26618 treatment of auto-aligned instructions like @code{LOOP}, which the
26619 assembler always aligns, either by widening density instructions or
26620 by inserting NOP instructions.
26622 @item -mlongcalls
26623 @itemx -mno-longcalls
26624 @opindex mlongcalls
26625 @opindex mno-longcalls
26626 When this option is enabled, GCC instructs the assembler to translate
26627 direct calls to indirect calls unless it can determine that the target
26628 of a direct call is in the range allowed by the call instruction.  This
26629 translation typically occurs for calls to functions in other source
26630 files.  Specifically, the assembler translates a direct @code{CALL}
26631 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
26632 The default is @option{-mno-longcalls}.  This option should be used in
26633 programs where the call target can potentially be out of range.  This
26634 option is implemented in the assembler, not the compiler, so the
26635 assembly code generated by GCC still shows direct call
26636 instructions---look at the disassembled object code to see the actual
26637 instructions.  Note that the assembler uses an indirect call for
26638 every cross-file call, not just those that really are out of range.
26639 @end table
26641 @node zSeries Options
26642 @subsection zSeries Options
26643 @cindex zSeries options
26645 These are listed under @xref{S/390 and zSeries Options}.
26648 @c man end
26650 @node Spec Files
26651 @section Specifying Subprocesses and the Switches to Pass to Them
26652 @cindex Spec Files
26654 @command{gcc} is a driver program.  It performs its job by invoking a
26655 sequence of other programs to do the work of compiling, assembling and
26656 linking.  GCC interprets its command-line parameters and uses these to
26657 deduce which programs it should invoke, and which command-line options
26658 it ought to place on their command lines.  This behavior is controlled
26659 by @dfn{spec strings}.  In most cases there is one spec string for each
26660 program that GCC can invoke, but a few programs have multiple spec
26661 strings to control their behavior.  The spec strings built into GCC can
26662 be overridden by using the @option{-specs=} command-line switch to specify
26663 a spec file.
26665 @dfn{Spec files} are plain-text files that are used to construct spec
26666 strings.  They consist of a sequence of directives separated by blank
26667 lines.  The type of directive is determined by the first non-whitespace
26668 character on the line, which can be one of the following:
26670 @table @code
26671 @item %@var{command}
26672 Issues a @var{command} to the spec file processor.  The commands that can
26673 appear here are:
26675 @table @code
26676 @item %include <@var{file}>
26677 @cindex @code{%include}
26678 Search for @var{file} and insert its text at the current point in the
26679 specs file.
26681 @item %include_noerr <@var{file}>
26682 @cindex @code{%include_noerr}
26683 Just like @samp{%include}, but do not generate an error message if the include
26684 file cannot be found.
26686 @item %rename @var{old_name} @var{new_name}
26687 @cindex @code{%rename}
26688 Rename the spec string @var{old_name} to @var{new_name}.
26690 @end table
26692 @item *[@var{spec_name}]:
26693 This tells the compiler to create, override or delete the named spec
26694 string.  All lines after this directive up to the next directive or
26695 blank line are considered to be the text for the spec string.  If this
26696 results in an empty string then the spec is deleted.  (Or, if the
26697 spec did not exist, then nothing happens.)  Otherwise, if the spec
26698 does not currently exist a new spec is created.  If the spec does
26699 exist then its contents are overridden by the text of this
26700 directive, unless the first character of that text is the @samp{+}
26701 character, in which case the text is appended to the spec.
26703 @item [@var{suffix}]:
26704 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
26705 and up to the next directive or blank line are considered to make up the
26706 spec string for the indicated suffix.  When the compiler encounters an
26707 input file with the named suffix, it processes the spec string in
26708 order to work out how to compile that file.  For example:
26710 @smallexample
26711 .ZZ:
26712 z-compile -input %i
26713 @end smallexample
26715 This says that any input file whose name ends in @samp{.ZZ} should be
26716 passed to the program @samp{z-compile}, which should be invoked with the
26717 command-line switch @option{-input} and with the result of performing the
26718 @samp{%i} substitution.  (See below.)
26720 As an alternative to providing a spec string, the text following a
26721 suffix directive can be one of the following:
26723 @table @code
26724 @item @@@var{language}
26725 This says that the suffix is an alias for a known @var{language}.  This is
26726 similar to using the @option{-x} command-line switch to GCC to specify a
26727 language explicitly.  For example:
26729 @smallexample
26730 .ZZ:
26731 @@c++
26732 @end smallexample
26734 Says that .ZZ files are, in fact, C++ source files.
26736 @item #@var{name}
26737 This causes an error messages saying:
26739 @smallexample
26740 @var{name} compiler not installed on this system.
26741 @end smallexample
26742 @end table
26744 GCC already has an extensive list of suffixes built into it.
26745 This directive adds an entry to the end of the list of suffixes, but
26746 since the list is searched from the end backwards, it is effectively
26747 possible to override earlier entries using this technique.
26749 @end table
26751 GCC has the following spec strings built into it.  Spec files can
26752 override these strings or create their own.  Note that individual
26753 targets can also add their own spec strings to this list.
26755 @smallexample
26756 asm          Options to pass to the assembler
26757 asm_final    Options to pass to the assembler post-processor
26758 cpp          Options to pass to the C preprocessor
26759 cc1          Options to pass to the C compiler
26760 cc1plus      Options to pass to the C++ compiler
26761 endfile      Object files to include at the end of the link
26762 link         Options to pass to the linker
26763 lib          Libraries to include on the command line to the linker
26764 libgcc       Decides which GCC support library to pass to the linker
26765 linker       Sets the name of the linker
26766 predefines   Defines to be passed to the C preprocessor
26767 signed_char  Defines to pass to CPP to say whether @code{char} is signed
26768              by default
26769 startfile    Object files to include at the start of the link
26770 @end smallexample
26772 Here is a small example of a spec file:
26774 @smallexample
26775 %rename lib                 old_lib
26777 *lib:
26778 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
26779 @end smallexample
26781 This example renames the spec called @samp{lib} to @samp{old_lib} and
26782 then overrides the previous definition of @samp{lib} with a new one.
26783 The new definition adds in some extra command-line options before
26784 including the text of the old definition.
26786 @dfn{Spec strings} are a list of command-line options to be passed to their
26787 corresponding program.  In addition, the spec strings can contain
26788 @samp{%}-prefixed sequences to substitute variable text or to
26789 conditionally insert text into the command line.  Using these constructs
26790 it is possible to generate quite complex command lines.
26792 Here is a table of all defined @samp{%}-sequences for spec
26793 strings.  Note that spaces are not generated automatically around the
26794 results of expanding these sequences.  Therefore you can concatenate them
26795 together or combine them with constant text in a single argument.
26797 @table @code
26798 @item %%
26799 Substitute one @samp{%} into the program name or argument.
26801 @item %i
26802 Substitute the name of the input file being processed.
26804 @item %b
26805 Substitute the basename of the input file being processed.
26806 This is the substring up to (and not including) the last period
26807 and not including the directory.
26809 @item %B
26810 This is the same as @samp{%b}, but include the file suffix (text after
26811 the last period).
26813 @item %d
26814 Marks the argument containing or following the @samp{%d} as a
26815 temporary file name, so that that file is deleted if GCC exits
26816 successfully.  Unlike @samp{%g}, this contributes no text to the
26817 argument.
26819 @item %g@var{suffix}
26820 Substitute a file name that has suffix @var{suffix} and is chosen
26821 once per compilation, and mark the argument in the same way as
26822 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
26823 name is now chosen in a way that is hard to predict even when previously
26824 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
26825 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
26826 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
26827 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
26828 was simply substituted with a file name chosen once per compilation,
26829 without regard to any appended suffix (which was therefore treated
26830 just like ordinary text), making such attacks more likely to succeed.
26832 @item %u@var{suffix}
26833 Like @samp{%g}, but generates a new temporary file name
26834 each time it appears instead of once per compilation.
26836 @item %U@var{suffix}
26837 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
26838 new one if there is no such last file name.  In the absence of any
26839 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
26840 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
26841 involves the generation of two distinct file names, one
26842 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
26843 simply substituted with a file name chosen for the previous @samp{%u},
26844 without regard to any appended suffix.
26846 @item %j@var{suffix}
26847 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
26848 writable, and if @option{-save-temps} is not used; 
26849 otherwise, substitute the name
26850 of a temporary file, just like @samp{%u}.  This temporary file is not
26851 meant for communication between processes, but rather as a junk
26852 disposal mechanism.
26854 @item %|@var{suffix}
26855 @itemx %m@var{suffix}
26856 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
26857 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
26858 all.  These are the two most common ways to instruct a program that it
26859 should read from standard input or write to standard output.  If you
26860 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
26861 construct: see for example @file{f/lang-specs.h}.
26863 @item %.@var{SUFFIX}
26864 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
26865 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
26866 terminated by the next space or %.
26868 @item %w
26869 Marks the argument containing or following the @samp{%w} as the
26870 designated output file of this compilation.  This puts the argument
26871 into the sequence of arguments that @samp{%o} substitutes.
26873 @item %o
26874 Substitutes the names of all the output files, with spaces
26875 automatically placed around them.  You should write spaces
26876 around the @samp{%o} as well or the results are undefined.
26877 @samp{%o} is for use in the specs for running the linker.
26878 Input files whose names have no recognized suffix are not compiled
26879 at all, but they are included among the output files, so they are
26880 linked.
26882 @item %O
26883 Substitutes the suffix for object files.  Note that this is
26884 handled specially when it immediately follows @samp{%g, %u, or %U},
26885 because of the need for those to form complete file names.  The
26886 handling is such that @samp{%O} is treated exactly as if it had already
26887 been substituted, except that @samp{%g, %u, and %U} do not currently
26888 support additional @var{suffix} characters following @samp{%O} as they do
26889 following, for example, @samp{.o}.
26891 @item %p
26892 Substitutes the standard macro predefinitions for the
26893 current target machine.  Use this when running @command{cpp}.
26895 @item %P
26896 Like @samp{%p}, but puts @samp{__} before and after the name of each
26897 predefined macro, except for macros that start with @samp{__} or with
26898 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
26901 @item %I
26902 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
26903 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
26904 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
26905 and @option{-imultilib} as necessary.
26907 @item %s
26908 Current argument is the name of a library or startup file of some sort.
26909 Search for that file in a standard list of directories and substitute
26910 the full name found.  The current working directory is included in the
26911 list of directories scanned.
26913 @item %T
26914 Current argument is the name of a linker script.  Search for that file
26915 in the current list of directories to scan for libraries. If the file
26916 is located insert a @option{--script} option into the command line
26917 followed by the full path name found.  If the file is not found then
26918 generate an error message.  Note: the current working directory is not
26919 searched.
26921 @item %e@var{str}
26922 Print @var{str} as an error message.  @var{str} is terminated by a newline.
26923 Use this when inconsistent options are detected.
26925 @item %(@var{name})
26926 Substitute the contents of spec string @var{name} at this point.
26928 @item %x@{@var{option}@}
26929 Accumulate an option for @samp{%X}.
26931 @item %X
26932 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
26933 spec string.
26935 @item %Y
26936 Output the accumulated assembler options specified by @option{-Wa}.
26938 @item %Z
26939 Output the accumulated preprocessor options specified by @option{-Wp}.
26941 @item %a
26942 Process the @code{asm} spec.  This is used to compute the
26943 switches to be passed to the assembler.
26945 @item %A
26946 Process the @code{asm_final} spec.  This is a spec string for
26947 passing switches to an assembler post-processor, if such a program is
26948 needed.
26950 @item %l
26951 Process the @code{link} spec.  This is the spec for computing the
26952 command line passed to the linker.  Typically it makes use of the
26953 @samp{%L %G %S %D and %E} sequences.
26955 @item %D
26956 Dump out a @option{-L} option for each directory that GCC believes might
26957 contain startup files.  If the target supports multilibs then the
26958 current multilib directory is prepended to each of these paths.
26960 @item %L
26961 Process the @code{lib} spec.  This is a spec string for deciding which
26962 libraries are included on the command line to the linker.
26964 @item %G
26965 Process the @code{libgcc} spec.  This is a spec string for deciding
26966 which GCC support library is included on the command line to the linker.
26968 @item %S
26969 Process the @code{startfile} spec.  This is a spec for deciding which
26970 object files are the first ones passed to the linker.  Typically
26971 this might be a file named @file{crt0.o}.
26973 @item %E
26974 Process the @code{endfile} spec.  This is a spec string that specifies
26975 the last object files that are passed to the linker.
26977 @item %C
26978 Process the @code{cpp} spec.  This is used to construct the arguments
26979 to be passed to the C preprocessor.
26981 @item %1
26982 Process the @code{cc1} spec.  This is used to construct the options to be
26983 passed to the actual C compiler (@command{cc1}).
26985 @item %2
26986 Process the @code{cc1plus} spec.  This is used to construct the options to be
26987 passed to the actual C++ compiler (@command{cc1plus}).
26989 @item %*
26990 Substitute the variable part of a matched option.  See below.
26991 Note that each comma in the substituted string is replaced by
26992 a single space.
26994 @item %<S
26995 Remove all occurrences of @code{-S} from the command line.  Note---this
26996 command is position dependent.  @samp{%} commands in the spec string
26997 before this one see @code{-S}, @samp{%} commands in the spec string
26998 after this one do not.
27000 @item %:@var{function}(@var{args})
27001 Call the named function @var{function}, passing it @var{args}.
27002 @var{args} is first processed as a nested spec string, then split
27003 into an argument vector in the usual fashion.  The function returns
27004 a string which is processed as if it had appeared literally as part
27005 of the current spec.
27007 The following built-in spec functions are provided:
27009 @table @code
27010 @item @code{getenv}
27011 The @code{getenv} spec function takes two arguments: an environment
27012 variable name and a string.  If the environment variable is not
27013 defined, a fatal error is issued.  Otherwise, the return value is the
27014 value of the environment variable concatenated with the string.  For
27015 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
27017 @smallexample
27018 %:getenv(TOPDIR /include)
27019 @end smallexample
27021 expands to @file{/path/to/top/include}.
27023 @item @code{if-exists}
27024 The @code{if-exists} spec function takes one argument, an absolute
27025 pathname to a file.  If the file exists, @code{if-exists} returns the
27026 pathname.  Here is a small example of its usage:
27028 @smallexample
27029 *startfile:
27030 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
27031 @end smallexample
27033 @item @code{if-exists-else}
27034 The @code{if-exists-else} spec function is similar to the @code{if-exists}
27035 spec function, except that it takes two arguments.  The first argument is
27036 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
27037 returns the pathname.  If it does not exist, it returns the second argument.
27038 This way, @code{if-exists-else} can be used to select one file or another,
27039 based on the existence of the first.  Here is a small example of its usage:
27041 @smallexample
27042 *startfile:
27043 crt0%O%s %:if-exists(crti%O%s) \
27044 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
27045 @end smallexample
27047 @item @code{replace-outfile}
27048 The @code{replace-outfile} spec function takes two arguments.  It looks for the
27049 first argument in the outfiles array and replaces it with the second argument.  Here
27050 is a small example of its usage:
27052 @smallexample
27053 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
27054 @end smallexample
27056 @item @code{remove-outfile}
27057 The @code{remove-outfile} spec function takes one argument.  It looks for the
27058 first argument in the outfiles array and removes it.  Here is a small example
27059 its usage:
27061 @smallexample
27062 %:remove-outfile(-lm)
27063 @end smallexample
27065 @item @code{pass-through-libs}
27066 The @code{pass-through-libs} spec function takes any number of arguments.  It
27067 finds any @option{-l} options and any non-options ending in @file{.a} (which it
27068 assumes are the names of linker input library archive files) and returns a
27069 result containing all the found arguments each prepended by
27070 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
27071 intended to be passed to the LTO linker plugin.
27073 @smallexample
27074 %:pass-through-libs(%G %L %G)
27075 @end smallexample
27077 @item @code{print-asm-header}
27078 The @code{print-asm-header} function takes no arguments and simply
27079 prints a banner like:
27081 @smallexample
27082 Assembler options
27083 =================
27085 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
27086 @end smallexample
27088 It is used to separate compiler options from assembler options
27089 in the @option{--target-help} output.
27090 @end table
27092 @item %@{S@}
27093 Substitutes the @code{-S} switch, if that switch is given to GCC@.
27094 If that switch is not specified, this substitutes nothing.  Note that
27095 the leading dash is omitted when specifying this option, and it is
27096 automatically inserted if the substitution is performed.  Thus the spec
27097 string @samp{%@{foo@}} matches the command-line option @option{-foo}
27098 and outputs the command-line option @option{-foo}.
27100 @item %W@{S@}
27101 Like %@{@code{S}@} but mark last argument supplied within as a file to be
27102 deleted on failure.
27104 @item %@{S*@}
27105 Substitutes all the switches specified to GCC whose names start
27106 with @code{-S}, but which also take an argument.  This is used for
27107 switches like @option{-o}, @option{-D}, @option{-I}, etc.
27108 GCC considers @option{-o foo} as being
27109 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
27110 text, including the space.  Thus two arguments are generated.
27112 @item %@{S*&T*@}
27113 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
27114 (the order of @code{S} and @code{T} in the spec is not significant).
27115 There can be any number of ampersand-separated variables; for each the
27116 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
27118 @item %@{S:X@}
27119 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
27121 @item %@{!S:X@}
27122 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
27124 @item %@{S*:X@}
27125 Substitutes @code{X} if one or more switches whose names start with
27126 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
27127 once, no matter how many such switches appeared.  However, if @code{%*}
27128 appears somewhere in @code{X}, then @code{X} is substituted once
27129 for each matching switch, with the @code{%*} replaced by the part of
27130 that switch matching the @code{*}.
27132 If @code{%*} appears as the last part of a spec sequence then a space
27133 is added after the end of the last substitution.  If there is more
27134 text in the sequence, however, then a space is not generated.  This
27135 allows the @code{%*} substitution to be used as part of a larger
27136 string.  For example, a spec string like this:
27138 @smallexample
27139 %@{mcu=*:--script=%*/memory.ld@}
27140 @end smallexample
27142 @noindent
27143 when matching an option like @option{-mcu=newchip} produces:
27145 @smallexample
27146 --script=newchip/memory.ld
27147 @end smallexample
27149 @item %@{.S:X@}
27150 Substitutes @code{X}, if processing a file with suffix @code{S}.
27152 @item %@{!.S:X@}
27153 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
27155 @item %@{,S:X@}
27156 Substitutes @code{X}, if processing a file for language @code{S}.
27158 @item %@{!,S:X@}
27159 Substitutes @code{X}, if not processing a file for language @code{S}.
27161 @item %@{S|P:X@}
27162 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
27163 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
27164 @code{*} sequences as well, although they have a stronger binding than
27165 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
27166 alternatives must be starred, and only the first matching alternative
27167 is substituted.
27169 For example, a spec string like this:
27171 @smallexample
27172 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
27173 @end smallexample
27175 @noindent
27176 outputs the following command-line options from the following input
27177 command-line options:
27179 @smallexample
27180 fred.c        -foo -baz
27181 jim.d         -bar -boggle
27182 -d fred.c     -foo -baz -boggle
27183 -d jim.d      -bar -baz -boggle
27184 @end smallexample
27186 @item %@{S:X; T:Y; :D@}
27188 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
27189 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
27190 be as many clauses as you need.  This may be combined with @code{.},
27191 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
27194 @end table
27196 The switch matching text @code{S} in a @samp{%@{S@}}, @samp{%@{S:X@}}
27197 or similar construct can use a backslash to ignore the special meaning
27198 of the character following it, thus allowing literal matching of a
27199 character that is otherwise specially treated.  For example,
27200 @samp{%@{std=iso9899\:1999:X@}} substitutes @code{X} if the
27201 @option{-std=iso9899:1999} option is given.
27203 The conditional text @code{X} in a @samp{%@{S:X@}} or similar
27204 construct may contain other nested @samp{%} constructs or spaces, or
27205 even newlines.  They are processed as usual, as described above.
27206 Trailing white space in @code{X} is ignored.  White space may also
27207 appear anywhere on the left side of the colon in these constructs,
27208 except between @code{.} or @code{*} and the corresponding word.
27210 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
27211 handled specifically in these constructs.  If another value of
27212 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
27213 @option{-W} switch is found later in the command line, the earlier
27214 switch value is ignored, except with @{@code{S}*@} where @code{S} is
27215 just one letter, which passes all matching options.
27217 The character @samp{|} at the beginning of the predicate text is used to
27218 indicate that a command should be piped to the following command, but
27219 only if @option{-pipe} is specified.
27221 It is built into GCC which switches take arguments and which do not.
27222 (You might think it would be useful to generalize this to allow each
27223 compiler's spec to say which switches take arguments.  But this cannot
27224 be done in a consistent fashion.  GCC cannot even decide which input
27225 files have been specified without knowing which switches take arguments,
27226 and it must know which input files to compile in order to tell which
27227 compilers to run).
27229 GCC also knows implicitly that arguments starting in @option{-l} are to be
27230 treated as compiler output files, and passed to the linker in their
27231 proper position among the other output files.
27233 @node Environment Variables
27234 @section Environment Variables Affecting GCC
27235 @cindex environment variables
27237 @c man begin ENVIRONMENT
27238 This section describes several environment variables that affect how GCC
27239 operates.  Some of them work by specifying directories or prefixes to use
27240 when searching for various kinds of files.  Some are used to specify other
27241 aspects of the compilation environment.
27243 Note that you can also specify places to search using options such as
27244 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
27245 take precedence over places specified using environment variables, which
27246 in turn take precedence over those specified by the configuration of GCC@.
27247 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
27248 GNU Compiler Collection (GCC) Internals}.
27250 @table @env
27251 @item LANG
27252 @itemx LC_CTYPE
27253 @c @itemx LC_COLLATE
27254 @itemx LC_MESSAGES
27255 @c @itemx LC_MONETARY
27256 @c @itemx LC_NUMERIC
27257 @c @itemx LC_TIME
27258 @itemx LC_ALL
27259 @findex LANG
27260 @findex LC_CTYPE
27261 @c @findex LC_COLLATE
27262 @findex LC_MESSAGES
27263 @c @findex LC_MONETARY
27264 @c @findex LC_NUMERIC
27265 @c @findex LC_TIME
27266 @findex LC_ALL
27267 @cindex locale
27268 These environment variables control the way that GCC uses
27269 localization information which allows GCC to work with different
27270 national conventions.  GCC inspects the locale categories
27271 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
27272 so.  These locale categories can be set to any value supported by your
27273 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
27274 Kingdom encoded in UTF-8.
27276 The @env{LC_CTYPE} environment variable specifies character
27277 classification.  GCC uses it to determine the character boundaries in
27278 a string; this is needed for some multibyte encodings that contain quote
27279 and escape characters that are otherwise interpreted as a string
27280 end or escape.
27282 The @env{LC_MESSAGES} environment variable specifies the language to
27283 use in diagnostic messages.
27285 If the @env{LC_ALL} environment variable is set, it overrides the value
27286 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
27287 and @env{LC_MESSAGES} default to the value of the @env{LANG}
27288 environment variable.  If none of these variables are set, GCC
27289 defaults to traditional C English behavior.
27291 @item TMPDIR
27292 @findex TMPDIR
27293 If @env{TMPDIR} is set, it specifies the directory to use for temporary
27294 files.  GCC uses temporary files to hold the output of one stage of
27295 compilation which is to be used as input to the next stage: for example,
27296 the output of the preprocessor, which is the input to the compiler
27297 proper.
27299 @item GCC_COMPARE_DEBUG
27300 @findex GCC_COMPARE_DEBUG
27301 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
27302 @option{-fcompare-debug} to the compiler driver.  See the documentation
27303 of this option for more details.
27305 @item GCC_EXEC_PREFIX
27306 @findex GCC_EXEC_PREFIX
27307 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
27308 names of the subprograms executed by the compiler.  No slash is added
27309 when this prefix is combined with the name of a subprogram, but you can
27310 specify a prefix that ends with a slash if you wish.
27312 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
27313 an appropriate prefix to use based on the pathname it is invoked with.
27315 If GCC cannot find the subprogram using the specified prefix, it
27316 tries looking in the usual places for the subprogram.
27318 The default value of @env{GCC_EXEC_PREFIX} is
27319 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
27320 the installed compiler. In many cases @var{prefix} is the value
27321 of @code{prefix} when you ran the @file{configure} script.
27323 Other prefixes specified with @option{-B} take precedence over this prefix.
27325 This prefix is also used for finding files such as @file{crt0.o} that are
27326 used for linking.
27328 In addition, the prefix is used in an unusual way in finding the
27329 directories to search for header files.  For each of the standard
27330 directories whose name normally begins with @samp{/usr/local/lib/gcc}
27331 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
27332 replacing that beginning with the specified prefix to produce an
27333 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
27334 @file{foo/bar} just before it searches the standard directory 
27335 @file{/usr/local/lib/bar}.
27336 If a standard directory begins with the configured
27337 @var{prefix} then the value of @var{prefix} is replaced by
27338 @env{GCC_EXEC_PREFIX} when looking for header files.
27340 @item COMPILER_PATH
27341 @findex COMPILER_PATH
27342 The value of @env{COMPILER_PATH} is a colon-separated list of
27343 directories, much like @env{PATH}.  GCC tries the directories thus
27344 specified when searching for subprograms, if it cannot find the
27345 subprograms using @env{GCC_EXEC_PREFIX}.
27347 @item LIBRARY_PATH
27348 @findex LIBRARY_PATH
27349 The value of @env{LIBRARY_PATH} is a colon-separated list of
27350 directories, much like @env{PATH}.  When configured as a native compiler,
27351 GCC tries the directories thus specified when searching for special
27352 linker files, if it cannot find them using @env{GCC_EXEC_PREFIX}.  Linking
27353 using GCC also uses these directories when searching for ordinary
27354 libraries for the @option{-l} option (but directories specified with
27355 @option{-L} come first).
27357 @item LANG
27358 @findex LANG
27359 @cindex locale definition
27360 This variable is used to pass locale information to the compiler.  One way in
27361 which this information is used is to determine the character set to be used
27362 when character literals, string literals and comments are parsed in C and C++.
27363 When the compiler is configured to allow multibyte characters,
27364 the following values for @env{LANG} are recognized:
27366 @table @samp
27367 @item C-JIS
27368 Recognize JIS characters.
27369 @item C-SJIS
27370 Recognize SJIS characters.
27371 @item C-EUCJP
27372 Recognize EUCJP characters.
27373 @end table
27375 If @env{LANG} is not defined, or if it has some other value, then the
27376 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
27377 recognize and translate multibyte characters.
27378 @end table
27380 @noindent
27381 Some additional environment variables affect the behavior of the
27382 preprocessor.
27384 @include cppenv.texi
27386 @c man end
27388 @node Precompiled Headers
27389 @section Using Precompiled Headers
27390 @cindex precompiled headers
27391 @cindex speed of compilation
27393 Often large projects have many header files that are included in every
27394 source file.  The time the compiler takes to process these header files
27395 over and over again can account for nearly all of the time required to
27396 build the project.  To make builds faster, GCC allows you to
27397 @dfn{precompile} a header file.
27399 To create a precompiled header file, simply compile it as you would any
27400 other file, if necessary using the @option{-x} option to make the driver
27401 treat it as a C or C++ header file.  You may want to use a
27402 tool like @command{make} to keep the precompiled header up-to-date when
27403 the headers it contains change.
27405 A precompiled header file is searched for when @code{#include} is
27406 seen in the compilation.  As it searches for the included file
27407 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
27408 compiler looks for a precompiled header in each directory just before it
27409 looks for the include file in that directory.  The name searched for is
27410 the name specified in the @code{#include} with @samp{.gch} appended.  If
27411 the precompiled header file cannot be used, it is ignored.
27413 For instance, if you have @code{#include "all.h"}, and you have
27414 @file{all.h.gch} in the same directory as @file{all.h}, then the
27415 precompiled header file is used if possible, and the original
27416 header is used otherwise.
27418 Alternatively, you might decide to put the precompiled header file in a
27419 directory and use @option{-I} to ensure that directory is searched
27420 before (or instead of) the directory containing the original header.
27421 Then, if you want to check that the precompiled header file is always
27422 used, you can put a file of the same name as the original header in this
27423 directory containing an @code{#error} command.
27425 This also works with @option{-include}.  So yet another way to use
27426 precompiled headers, good for projects not designed with precompiled
27427 header files in mind, is to simply take most of the header files used by
27428 a project, include them from another header file, precompile that header
27429 file, and @option{-include} the precompiled header.  If the header files
27430 have guards against multiple inclusion, they are skipped because
27431 they've already been included (in the precompiled header).
27433 If you need to precompile the same header file for different
27434 languages, targets, or compiler options, you can instead make a
27435 @emph{directory} named like @file{all.h.gch}, and put each precompiled
27436 header in the directory, perhaps using @option{-o}.  It doesn't matter
27437 what you call the files in the directory; every precompiled header in
27438 the directory is considered.  The first precompiled header
27439 encountered in the directory that is valid for this compilation is
27440 used; they're searched in no particular order.
27442 There are many other possibilities, limited only by your imagination,
27443 good sense, and the constraints of your build system.
27445 A precompiled header file can be used only when these conditions apply:
27447 @itemize
27448 @item
27449 Only one precompiled header can be used in a particular compilation.
27451 @item
27452 A precompiled header cannot be used once the first C token is seen.  You
27453 can have preprocessor directives before a precompiled header; you cannot
27454 include a precompiled header from inside another header.
27456 @item
27457 The precompiled header file must be produced for the same language as
27458 the current compilation.  You cannot use a C precompiled header for a C++
27459 compilation.
27461 @item
27462 The precompiled header file must have been produced by the same compiler
27463 binary as the current compilation is using.
27465 @item
27466 Any macros defined before the precompiled header is included must
27467 either be defined in the same way as when the precompiled header was
27468 generated, or must not affect the precompiled header, which usually
27469 means that they don't appear in the precompiled header at all.
27471 The @option{-D} option is one way to define a macro before a
27472 precompiled header is included; using a @code{#define} can also do it.
27473 There are also some options that define macros implicitly, like
27474 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
27475 defined this way.
27477 @item If debugging information is output when using the precompiled
27478 header, using @option{-g} or similar, the same kind of debugging information
27479 must have been output when building the precompiled header.  However,
27480 a precompiled header built using @option{-g} can be used in a compilation
27481 when no debugging information is being output.
27483 @item The same @option{-m} options must generally be used when building
27484 and using the precompiled header.  @xref{Submodel Options},
27485 for any cases where this rule is relaxed.
27487 @item Each of the following options must be the same when building and using
27488 the precompiled header:
27490 @gccoptlist{-fexceptions}
27492 @item
27493 Some other command-line options starting with @option{-f},
27494 @option{-p}, or @option{-O} must be defined in the same way as when
27495 the precompiled header was generated.  At present, it's not clear
27496 which options are safe to change and which are not; the safest choice
27497 is to use exactly the same options when generating and using the
27498 precompiled header.  The following are known to be safe:
27500 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
27501 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
27502 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
27503 -pedantic-errors}
27505 @end itemize
27507 For all of these except the last, the compiler automatically
27508 ignores the precompiled header if the conditions aren't met.  If you
27509 find an option combination that doesn't work and doesn't cause the
27510 precompiled header to be ignored, please consider filing a bug report,
27511 see @ref{Bugs}.
27513 If you do use differing options when generating and using the
27514 precompiled header, the actual behavior is a mixture of the
27515 behavior for the options.  For instance, if you use @option{-g} to
27516 generate the precompiled header but not when using it, you may or may
27517 not get debugging information for routines in the precompiled header.