[SFN] introduce statement frontier notes, still disabled
[official-gcc.git] / gcc / doc / invoke.texi
blob189b3e438fff9753cd5c86f4d6af27ec48510e77
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), dbx(1)
49 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
50 @file{ld}, @file{binutils} and @file{gdb}.
51 @c man end
52 @c man begin BUGS
53 For instructions on reporting bugs, see
54 @w{@value{BUGURL}}.
55 @c man end
56 @c man begin AUTHOR
57 See the Info entry for @command{gcc}, or
58 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
59 for contributors to GCC@.
60 @c man end
61 @end ignore
63 @node Invoking GCC
64 @chapter GCC Command Options
65 @cindex GCC command options
66 @cindex command options
67 @cindex options, GCC command
69 @c man begin DESCRIPTION
70 When you invoke GCC, it normally does preprocessing, compilation,
71 assembly and linking.  The ``overall options'' allow you to stop this
72 process at an intermediate stage.  For example, the @option{-c} option
73 says not to run the linker.  Then the output consists of object files
74 output by the assembler.
75 @xref{Overall Options,,Options Controlling the Kind of Output}.
77 Other options are passed on to one or more stages of processing.  Some options
78 control the preprocessor and others the compiler itself.  Yet other
79 options control the assembler and linker; most of these are not
80 documented here, since you rarely need to use any of them.
82 @cindex C compilation options
83 Most of the command-line options that you can use with GCC are useful
84 for C programs; when an option is only useful with another language
85 (usually C++), the explanation says so explicitly.  If the description
86 for a particular option does not mention a source language, you can use
87 that option with all supported languages.
89 @cindex cross compiling
90 @cindex specifying machine version
91 @cindex specifying compiler version and target machine
92 @cindex compiler version, specifying
93 @cindex target machine, specifying
94 The usual way to run GCC is to run the executable called @command{gcc}, or
95 @command{@var{machine}-gcc} when cross-compiling, or
96 @command{@var{machine}-gcc-@var{version}} to run a specific version of GCC.
97 When you compile C++ programs, you should invoke GCC as @command{g++} 
98 instead.  @xref{Invoking G++,,Compiling C++ Programs}, 
99 for information about the differences in behavior between @command{gcc} 
100 and @code{g++} when compiling C++ programs.
102 @cindex grouping options
103 @cindex options, grouping
104 The @command{gcc} program accepts options and file names as operands.  Many
105 options have multi-letter names; therefore multiple single-letter options
106 may @emph{not} be grouped: @option{-dv} is very different from @w{@samp{-d
107 -v}}.
109 @cindex order of options
110 @cindex options, order
111 You can mix options and other arguments.  For the most part, the order
112 you use doesn't matter.  Order does matter when you use several
113 options of the same kind; for example, if you specify @option{-L} more
114 than once, the directories are searched in the order specified.  Also,
115 the placement of the @option{-l} option is significant.
117 Many options have long names starting with @samp{-f} or with
118 @samp{-W}---for example,
119 @option{-fmove-loop-invariants}, @option{-Wformat} and so on.  Most of
120 these have both positive and negative forms; the negative form of
121 @option{-ffoo} is @option{-fno-foo}.  This manual documents
122 only one of these two forms, whichever one is not the default.
124 @c man end
126 @xref{Option Index}, for an index to GCC's options.
128 @menu
129 * Option Summary::      Brief list of all options, without explanations.
130 * Overall Options::     Controlling the kind of output:
131                         an executable, object files, assembler files,
132                         or preprocessed source.
133 * Invoking G++::        Compiling C++ programs.
134 * C Dialect Options::   Controlling the variant of C language compiled.
135 * C++ Dialect Options:: Variations on C++.
136 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
137                         and Objective-C++.
138 * Diagnostic Message Formatting Options:: Controlling how diagnostics should
139                         be formatted.
140 * Warning Options::     How picky should the compiler be?
141 * Debugging Options::   Producing debuggable code.
142 * Optimize Options::    How much optimization?
143 * Instrumentation Options:: Enabling profiling and extra run-time error checking.
144 * Preprocessor Options:: Controlling header files and macro definitions.
145                          Also, getting dependency information for Make.
146 * Assembler Options::   Passing options to the assembler.
147 * Link Options::        Specifying libraries and so on.
148 * Directory Options::   Where to find header files and libraries.
149                         Where to find the compiler executable files.
150 * Code Gen Options::    Specifying conventions for function calls, data layout
151                         and register usage.
152 * Developer Options::   Printing GCC configuration info, statistics, and
153                         debugging dumps.
154 * Submodel Options::    Target-specific options, such as compiling for a
155                         specific processor variant.
156 * Spec Files::          How to pass switches to sub-processes.
157 * Environment Variables:: Env vars that affect GCC.
158 * Precompiled Headers:: Compiling a header once, and using it many times.
159 @end menu
161 @c man begin OPTIONS
163 @node Option Summary
164 @section Option Summary
166 Here is a summary of all the options, grouped by type.  Explanations are
167 in the following sections.
169 @table @emph
170 @item Overall Options
171 @xref{Overall Options,,Options Controlling the Kind of Output}.
172 @gccoptlist{-c  -S  -E  -o @var{file}  -x @var{language}  @gol
173 -v  -###  --help@r{[}=@var{class}@r{[},@dots{}@r{]]}  --target-help  --version @gol
174 -pass-exit-codes  -pipe  -specs=@var{file}  -wrapper  @gol
175 @@@var{file}  -fplugin=@var{file}  -fplugin-arg-@var{name}=@var{arg}  @gol
176 -fdump-ada-spec@r{[}-slim@r{]}  -fada-spec-parent=@var{unit}  -fdump-go-spec=@var{file}}
178 @item C Language Options
179 @xref{C Dialect Options,,Options Controlling C Dialect}.
180 @gccoptlist{-ansi  -std=@var{standard}  -fgnu89-inline @gol
181 -fpermitted-flt-eval-methods=@var{standard} @gol
182 -aux-info @var{filename}  -fallow-parameterless-variadic-functions @gol
183 -fno-asm  -fno-builtin  -fno-builtin-@var{function}  -fgimple@gol
184 -fhosted  -ffreestanding  -fopenacc  -fopenmp  -fopenmp-simd @gol
185 -fms-extensions  -fplan9-extensions  -fsso-struct=@var{endianness} @gol
186 -fallow-single-precision  -fcond-mismatch  -flax-vector-conversions @gol
187 -fsigned-bitfields  -fsigned-char @gol
188 -funsigned-bitfields  -funsigned-char}
190 @item C++ Language Options
191 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
192 @gccoptlist{-fabi-version=@var{n}  -fno-access-control @gol
193 -faligned-new=@var{n}  -fargs-in-order=@var{n}  -fcheck-new @gol
194 -fconstexpr-depth=@var{n}  -fconstexpr-loop-limit=@var{n} @gol
195 -ffriend-injection @gol
196 -fno-elide-constructors @gol
197 -fno-enforce-eh-specs @gol
198 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
199 -fno-implicit-templates @gol
200 -fno-implicit-inline-templates @gol
201 -fno-implement-inlines  -fms-extensions @gol
202 -fnew-inheriting-ctors @gol
203 -fnew-ttp-matching @gol
204 -fno-nonansi-builtins  -fnothrow-opt  -fno-operator-names @gol
205 -fno-optional-diags  -fpermissive @gol
206 -fno-pretty-templates @gol
207 -frepo  -fno-rtti  -fsized-deallocation @gol
208 -ftemplate-backtrace-limit=@var{n} @gol
209 -ftemplate-depth=@var{n} @gol
210 -fno-threadsafe-statics  -fuse-cxa-atexit @gol
211 -fno-weak  -nostdinc++ @gol
212 -fvisibility-inlines-hidden @gol
213 -fvisibility-ms-compat @gol
214 -fext-numeric-literals @gol
215 -Wabi=@var{n}  -Wabi-tag  -Wconversion-null  -Wctor-dtor-privacy @gol
216 -Wdelete-non-virtual-dtor  -Wliteral-suffix  -Wmultiple-inheritance @gol
217 -Wnamespaces  -Wnarrowing @gol
218 -Wnoexcept  -Wnoexcept-type  -Wclass-memaccess @gol
219 -Wnon-virtual-dtor  -Wreorder  -Wregister @gol
220 -Weffc++  -Wstrict-null-sentinel  -Wtemplates @gol
221 -Wno-non-template-friend  -Wold-style-cast @gol
222 -Woverloaded-virtual  -Wno-pmf-conversions @gol
223 -Wsign-promo  -Wvirtual-inheritance}
225 @item Objective-C and Objective-C++ Language Options
226 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
227 Objective-C and Objective-C++ Dialects}.
228 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
229 -fgnu-runtime  -fnext-runtime @gol
230 -fno-nil-receivers @gol
231 -fobjc-abi-version=@var{n} @gol
232 -fobjc-call-cxx-cdtors @gol
233 -fobjc-direct-dispatch @gol
234 -fobjc-exceptions @gol
235 -fobjc-gc @gol
236 -fobjc-nilcheck @gol
237 -fobjc-std=objc1 @gol
238 -fno-local-ivars @gol
239 -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]} @gol
240 -freplace-objc-classes @gol
241 -fzero-link @gol
242 -gen-decls @gol
243 -Wassign-intercept @gol
244 -Wno-protocol  -Wselector @gol
245 -Wstrict-selector-match @gol
246 -Wundeclared-selector}
248 @item Diagnostic Message Formatting Options
249 @xref{Diagnostic Message Formatting Options,,Options to Control Diagnostic Messages Formatting}.
250 @gccoptlist{-fmessage-length=@var{n}  @gol
251 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
252 -fdiagnostics-color=@r{[}auto@r{|}never@r{|}always@r{]}  @gol
253 -fno-diagnostics-show-option  -fno-diagnostics-show-caret @gol
254 -fdiagnostics-parseable-fixits  -fdiagnostics-generate-patch @gol
255 -fdiagnostics-show-template-tree -fno-elide-type @gol
256 -fno-show-column}
258 @item Warning Options
259 @xref{Warning Options,,Options to Request or Suppress Warnings}.
260 @gccoptlist{-fsyntax-only  -fmax-errors=@var{n}  -Wpedantic @gol
261 -pedantic-errors @gol
262 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  @gol
263 -Walloc-zero  -Walloc-size-larger-than=@var{n}
264 -Walloca  -Walloca-larger-than=@var{n} @gol
265 -Wno-aggressive-loop-optimizations  -Warray-bounds  -Warray-bounds=@var{n} @gol
266 -Wno-attributes  -Wbool-compare  -Wbool-operation @gol
267 -Wno-builtin-declaration-mismatch @gol
268 -Wno-builtin-macro-redefined  -Wc90-c99-compat  -Wc99-c11-compat @gol
269 -Wc++-compat  -Wc++11-compat  -Wc++14-compat  @gol
270 -Wcast-align  -Wcast-align=strict  -Wcast-qual  @gol
271 -Wchar-subscripts  -Wchkp  -Wcatch-value  -Wcatch-value=@var{n} @gol
272 -Wclobbered  -Wcomment  -Wconditionally-supported @gol
273 -Wconversion  -Wcoverage-mismatch  -Wno-cpp  -Wdangling-else  -Wdate-time @gol
274 -Wdelete-incomplete @gol
275 -Wno-deprecated  -Wno-deprecated-declarations  -Wno-designated-init @gol
276 -Wdisabled-optimization @gol
277 -Wno-discarded-qualifiers  -Wno-discarded-array-qualifiers @gol
278 -Wno-div-by-zero  -Wdouble-promotion @gol
279 -Wduplicated-branches  -Wduplicated-cond @gol
280 -Wempty-body  -Wenum-compare  -Wno-endif-labels  -Wexpansion-to-defined @gol
281 -Werror  -Werror=*  -Wextra-semi  -Wfatal-errors @gol
282 -Wfloat-equal  -Wformat  -Wformat=2 @gol
283 -Wno-format-contains-nul  -Wno-format-extra-args  @gol
284 -Wformat-nonliteral -Wformat-overflow=@var{n} @gol
285 -Wformat-security  -Wformat-signedness  -Wformat-truncation=@var{n} @gol
286 -Wformat-y2k  -Wframe-address @gol
287 -Wframe-larger-than=@var{len}  -Wno-free-nonheap-object  -Wjump-misses-init @gol
288 -Wif-not-aligned @gol
289 -Wignored-qualifiers  -Wignored-attributes  -Wincompatible-pointer-types @gol
290 -Wimplicit  -Wimplicit-fallthrough  -Wimplicit-fallthrough=@var{n} @gol
291 -Wimplicit-function-declaration  -Wimplicit-int @gol
292 -Winit-self  -Winline  -Wno-int-conversion  -Wint-in-bool-context @gol
293 -Wno-int-to-pointer-cast  -Winvalid-memory-model  -Wno-invalid-offsetof @gol
294 -Winvalid-pch  -Wlarger-than=@var{len} @gol
295 -Wlogical-op  -Wlogical-not-parentheses  -Wlong-long @gol
296 -Wmain  -Wmaybe-uninitialized  -Wmemset-elt-size  -Wmemset-transposed-args @gol
297 -Wmisleading-indentation  -Wmissing-braces @gol
298 -Wmissing-field-initializers  -Wmissing-include-dirs @gol
299 -Wno-multichar  -Wmultistatement-macros  -Wnonnull  -Wnonnull-compare @gol
300 -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]} @gol
301 -Wnull-dereference  -Wodr  -Wno-overflow  -Wopenmp-simd  @gol
302 -Woverride-init-side-effects  -Woverlength-strings @gol
303 -Wpacked  -Wpacked-bitfield-compat -Wpacked-not-aligned -Wpadded @gol
304 -Wparentheses  -Wno-pedantic-ms-format @gol
305 -Wplacement-new  -Wplacement-new=@var{n} @gol
306 -Wpointer-arith  -Wpointer-compare  -Wno-pointer-to-int-cast @gol
307 -Wno-pragmas  -Wredundant-decls  -Wrestrict  -Wno-return-local-addr @gol
308 -Wreturn-type  -Wsequence-point  -Wshadow  -Wno-shadow-ivar @gol
309 -Wshadow=global,  -Wshadow=local,  -Wshadow=compatible-local @gol
310 -Wshift-overflow  -Wshift-overflow=@var{n} @gol
311 -Wshift-count-negative  -Wshift-count-overflow  -Wshift-negative-value @gol
312 -Wsign-compare  -Wsign-conversion  -Wfloat-conversion @gol
313 -Wno-scalar-storage-order  -Wsizeof-pointer-div @gol
314 -Wsizeof-pointer-memaccess  -Wsizeof-array-argument @gol
315 -Wstack-protector  -Wstack-usage=@var{len}  -Wstrict-aliasing @gol
316 -Wstrict-aliasing=n  -Wstrict-overflow  -Wstrict-overflow=@var{n} @gol
317 -Wstringop-overflow=@var{n} -Wstringop-truncation @gol
318 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{|}malloc@r{]} @gol
319 -Wsuggest-final-types @gol  -Wsuggest-final-methods  -Wsuggest-override @gol
320 -Wmissing-format-attribute  -Wsubobject-linkage @gol
321 -Wswitch  -Wswitch-bool  -Wswitch-default  -Wswitch-enum @gol
322 -Wswitch-unreachable  -Wsync-nand @gol
323 -Wsystem-headers  -Wtautological-compare  -Wtrampolines  -Wtrigraphs @gol
324 -Wtype-limits  -Wundef @gol
325 -Wuninitialized  -Wunknown-pragmas  -Wunsafe-loop-optimizations @gol
326 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
327 -Wunused-label  -Wunused-local-typedefs  -Wunused-macros @gol
328 -Wunused-parameter  -Wno-unused-result @gol
329 -Wunused-value  -Wunused-variable @gol
330 -Wunused-const-variable  -Wunused-const-variable=@var{n} @gol
331 -Wunused-but-set-parameter  -Wunused-but-set-variable @gol
332 -Wuseless-cast  -Wvariadic-macros  -Wvector-operation-performance @gol
333 -Wvla  -Wvla-larger-than=@var{n}  -Wvolatile-register-var  -Wwrite-strings @gol
334 -Wzero-as-null-pointer-constant  -Whsa}
336 @item C and Objective-C-only Warning Options
337 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
338 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
339 -Wold-style-declaration  -Wold-style-definition @gol
340 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
341 -Wdeclaration-after-statement  -Wpointer-sign}
343 @item Debugging Options
344 @xref{Debugging Options,,Options for Debugging Your Program}.
345 @gccoptlist{-g  -g@var{level}  -gdwarf  -gdwarf-@var{version} @gol
346 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
347 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
348 -gcolumn-info  -gno-column-info @gol
349 -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 -fcf-protection==@r{[}full@r{|}branch@r{|}return@r{|}none@r{]} @gol
465 -fstack-protector  -fstack-protector-all  -fstack-protector-strong @gol
466 -fstack-protector-explicit  -fstack-check @gol
467 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
468 -fno-stack-limit  -fsplit-stack @gol
469 -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]} @gol
470 -fvtv-counts  -fvtv-debug @gol
471 -finstrument-functions @gol
472 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
473 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}}
475 @item Preprocessor Options
476 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
477 @gccoptlist{-A@var{question}=@var{answer} @gol
478 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
479 -C  -CC  -D@var{macro}@r{[}=@var{defn}@r{]} @gol
480 -dD  -dI  -dM  -dN  -dU @gol
481 -fdebug-cpp  -fdirectives-only  -fdollars-in-identifiers  @gol
482 -fexec-charset=@var{charset}  -fextended-identifiers  @gol
483 -finput-charset=@var{charset}  -fno-canonical-system-headers @gol
484 -fpch-deps  -fpch-preprocess  -fpreprocessed @gol
485 -ftabstop=@var{width}  -ftrack-macro-expansion  @gol
486 -fwide-exec-charset=@var{charset}  -fworking-directory @gol
487 -H  -imacros @var{file}  -include @var{file} @gol
488 -M  -MD  -MF  -MG  -MM  -MMD  -MP  -MQ  -MT @gol
489 -no-integrated-cpp  -P  -pthread  -remap @gol
490 -traditional  -traditional-cpp  -trigraphs @gol
491 -U@var{macro}  -undef  @gol
492 -Wp,@var{option}  -Xpreprocessor @var{option}}
494 @item Assembler Options
495 @xref{Assembler Options,,Passing Options to the Assembler}.
496 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
498 @item Linker Options
499 @xref{Link Options,,Options for Linking}.
500 @gccoptlist{@var{object-file-name}  -fuse-ld=@var{linker}  -l@var{library} @gol
501 -nostartfiles  -nodefaultlibs  -nostdlib  -pie  -pthread  -rdynamic @gol
502 -s  -static -static-pie -static-libgcc  -static-libstdc++ @gol
503 -static-libasan  -static-libtsan  -static-liblsan  -static-libubsan @gol
504 -static-libmpx  -static-libmpxwrappers @gol
505 -shared  -shared-libgcc  -symbolic @gol
506 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
507 -u @var{symbol}  -z @var{keyword}}
509 @item Directory Options
510 @xref{Directory Options,,Options for Directory Search}.
511 @gccoptlist{-B@var{prefix}  -I@var{dir}  -I- @gol
512 -idirafter @var{dir} @gol
513 -imacros @var{file}  -imultilib @var{dir} @gol
514 -iplugindir=@var{dir}  -iprefix @var{file} @gol
515 -iquote @var{dir}  -isysroot @var{dir}  -isystem @var{dir} @gol
516 -iwithprefix @var{dir}  -iwithprefixbefore @var{dir}  @gol
517 -L@var{dir}  -no-canonical-prefixes  --no-sysroot-suffix @gol
518 -nostdinc  -nostdinc++  --sysroot=@var{dir}}
520 @item Code Generation Options
521 @xref{Code Gen Options,,Options for Code Generation Conventions}.
522 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
523 -ffixed-@var{reg}  -fexceptions @gol
524 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
525 -fasynchronous-unwind-tables @gol
526 -fno-gnu-unique @gol
527 -finhibit-size-directive  -fno-common  -fno-ident @gol
528 -fpcc-struct-return  -fpic  -fPIC  -fpie  -fPIE  -fno-plt @gol
529 -fno-jump-tables @gol
530 -frecord-gcc-switches @gol
531 -freg-struct-return  -fshort-enums  -fshort-wchar @gol
532 -fverbose-asm  -fpack-struct[=@var{n}]  @gol
533 -fleading-underscore  -ftls-model=@var{model} @gol
534 -fstack-reuse=@var{reuse_level} @gol
535 -ftrampolines  -ftrapv  -fwrapv @gol
536 -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]} @gol
537 -fstrict-volatile-bitfields  -fsync-libcalls}
539 @item Developer Options
540 @xref{Developer Options,,GCC Developer Options}.
541 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
542 -dumpfullversion  -fchecking  -fchecking=@var{n}  -fdbg-cnt-list @gol
543 -fdbg-cnt=@var{counter-value-list} @gol
544 -fdisable-ipa-@var{pass_name} @gol
545 -fdisable-rtl-@var{pass_name} @gol
546 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
547 -fdisable-tree-@var{pass_name} @gol
548 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
549 -fdump-noaddr  -fdump-unnumbered  -fdump-unnumbered-links @gol
550 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
551 -fdump-final-insns@r{[}=@var{file}@r{]}
552 -fdump-ipa-all  -fdump-ipa-cgraph  -fdump-ipa-inline @gol
553 -fdump-lang-all @gol
554 -fdump-lang-@var{switch} @gol
555 -fdump-lang-@var{switch}-@var{options} @gol
556 -fdump-lang-@var{switch}-@var{options}=@var{filename} @gol
557 -fdump-passes @gol
558 -fdump-rtl-@var{pass}  -fdump-rtl-@var{pass}=@var{filename} @gol
559 -fdump-statistics @gol
560 -fdump-tree-all @gol
561 -fdump-tree-@var{switch} @gol
562 -fdump-tree-@var{switch}-@var{options} @gol
563 -fdump-tree-@var{switch}-@var{options}=@var{filename} @gol
564 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
565 -fenable-@var{kind}-@var{pass} @gol
566 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
567 -fira-verbose=@var{n} @gol
568 -flto-report  -flto-report-wpa  -fmem-report-wpa @gol
569 -fmem-report  -fpre-ipa-mem-report  -fpost-ipa-mem-report @gol
570 -fopt-info  -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
571 -fprofile-report @gol
572 -frandom-seed=@var{string}  -fsched-verbose=@var{n} @gol
573 -fsel-sched-verbose  -fsel-sched-dump-cfg  -fsel-sched-pipelining-verbose @gol
574 -fstats  -fstack-usage  -ftime-report  -ftime-report-details @gol
575 -fvar-tracking-assignments-toggle  -gtoggle @gol
576 -print-file-name=@var{library}  -print-libgcc-file-name @gol
577 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
578 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
579 -print-sysroot  -print-sysroot-headers-suffix @gol
580 -save-temps  -save-temps=cwd  -save-temps=obj  -time@r{[}=@var{file}@r{]}}
582 @item Machine-Dependent Options
583 @xref{Submodel Options,,Machine-Dependent Options}.
584 @c This list is ordered alphanumerically by subsection name.
585 @c Try and put the significant identifier (CPU or system) first,
586 @c so users have a clue at guessing where the ones they want will be.
588 @emph{AArch64 Options}
589 @gccoptlist{-mabi=@var{name}  -mbig-endian  -mlittle-endian @gol
590 -mgeneral-regs-only @gol
591 -mcmodel=tiny  -mcmodel=small  -mcmodel=large @gol
592 -mstrict-align @gol
593 -momit-leaf-frame-pointer @gol
594 -mtls-dialect=desc  -mtls-dialect=traditional @gol
595 -mtls-size=@var{size} @gol
596 -mfix-cortex-a53-835769  -mfix-cortex-a53-843419 @gol
597 -mlow-precision-recip-sqrt  -mlow-precision-sqrt  -mlow-precision-div @gol
598 -mpc-relative-literal-loads @gol
599 -msign-return-address=@var{scope} @gol
600 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}  -moverride=@var{string}}
602 @emph{Adapteva Epiphany Options}
603 @gccoptlist{-mhalf-reg-file  -mprefer-short-insn-regs @gol
604 -mbranch-cost=@var{num}  -mcmove  -mnops=@var{num}  -msoft-cmpsf @gol
605 -msplit-lohi  -mpost-inc  -mpost-modify  -mstack-offset=@var{num} @gol
606 -mround-nearest  -mlong-calls  -mshort-calls  -msmall16 @gol
607 -mfp-mode=@var{mode}  -mvect-double  -max-vect-align=@var{num} @gol
608 -msplit-vecmove-early  -m1reg-@var{reg}}
610 @emph{ARC Options}
611 @gccoptlist{-mbarrel-shifter @gol
612 -mcpu=@var{cpu}  -mA6  -mARC600  -mA7  -mARC700 @gol
613 -mdpfp  -mdpfp-compact  -mdpfp-fast  -mno-dpfp-lrsr @gol
614 -mea  -mno-mpy  -mmul32x16  -mmul64  -matomic @gol
615 -mnorm  -mspfp  -mspfp-compact  -mspfp-fast  -msimd  -msoft-float  -mswap @gol
616 -mcrc  -mdsp-packa  -mdvbf  -mlock  -mmac-d16  -mmac-24  -mrtsc  -mswape @gol
617 -mtelephony  -mxy  -misize  -mannotate-align  -marclinux  -marclinux_prof @gol
618 -mlong-calls  -mmedium-calls  -msdata -mirq-ctrl-saved @gol
619 -mrgf-banked-regs -mlpc-width=@var{width} -G @var{num} @gol
620 -mvolatile-cache  -mtp-regno=@var{regno} @gol
621 -malign-call  -mauto-modify-reg  -mbbit-peephole  -mno-brcc @gol
622 -mcase-vector-pcrel  -mcompact-casesi  -mno-cond-exec  -mearly-cbranchsi @gol
623 -mexpand-adddi  -mindexed-loads  -mlra  -mlra-priority-none @gol
624 -mlra-priority-compact mlra-priority-noncompact  -mno-millicode @gol
625 -mmixed-code  -mq-class  -mRcq  -mRcw  -msize-level=@var{level} @gol
626 -mtune=@var{cpu}  -mmultcost=@var{num} @gol
627 -munalign-prob-threshold=@var{probability}  -mmpy-option=@var{multo} @gol
628 -mdiv-rem  -mcode-density  -mll64  -mfpu=@var{fpu}}
630 @emph{ARM Options}
631 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
632 -mabi=@var{name} @gol
633 -mapcs-stack-check  -mno-apcs-stack-check @gol
634 -mapcs-reentrant  -mno-apcs-reentrant @gol
635 -msched-prolog  -mno-sched-prolog @gol
636 -mlittle-endian  -mbig-endian @gol
637 -mbe8 -mbe32 @gol
638 -mfloat-abi=@var{name} @gol
639 -mfp16-format=@var{name}
640 -mthumb-interwork  -mno-thumb-interwork @gol
641 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
642 -mtune=@var{name}  -mprint-tune-info @gol
643 -mstructure-size-boundary=@var{n} @gol
644 -mabort-on-noreturn @gol
645 -mlong-calls  -mno-long-calls @gol
646 -msingle-pic-base  -mno-single-pic-base @gol
647 -mpic-register=@var{reg} @gol
648 -mnop-fun-dllimport @gol
649 -mpoke-function-name @gol
650 -mthumb  -marm @gol
651 -mtpcs-frame  -mtpcs-leaf-frame @gol
652 -mcaller-super-interworking  -mcallee-super-interworking @gol
653 -mtp=@var{name}  -mtls-dialect=@var{dialect} @gol
654 -mword-relocations @gol
655 -mfix-cortex-m3-ldrd @gol
656 -munaligned-access @gol
657 -mneon-for-64bits @gol
658 -mslow-flash-data @gol
659 -masm-syntax-unified @gol
660 -mrestrict-it @gol
661 -mpure-code @gol
662 -mcmse}
664 @emph{AVR Options}
665 @gccoptlist{-mmcu=@var{mcu}  -mabsdata  -maccumulate-args @gol
666 -mbranch-cost=@var{cost} @gol
667 -mcall-prologues  -mgas-isr-prologues  -mint8 @gol
668 -mn_flash=@var{size}  -mno-interrupts @gol
669 -mrelax  -mrmw  -mstrict-X  -mtiny-stack  -mfract-convert-truncate @gol
670 -mshort-calls  -nodevicelib @gol
671 -Waddr-space-convert  -Wmisspelled-isr}
673 @emph{Blackfin Options}
674 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
675 -msim  -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
676 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
677 -mlow-64k  -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
678 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
679 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
680 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
681 -mfast-fp  -minline-plt  -mmulticore  -mcorea  -mcoreb  -msdram @gol
682 -micplb}
684 @emph{C6X Options}
685 @gccoptlist{-mbig-endian  -mlittle-endian  -march=@var{cpu} @gol
686 -msim  -msdata=@var{sdata-type}}
688 @emph{CRIS Options}
689 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
690 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
691 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
692 -mstack-align  -mdata-align  -mconst-align @gol
693 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
694 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
695 -mmul-bug-workaround  -mno-mul-bug-workaround}
697 @emph{CR16 Options}
698 @gccoptlist{-mmac @gol
699 -mcr16cplus  -mcr16c @gol
700 -msim  -mint32  -mbit-ops
701 -mdata-model=@var{model}}
703 @emph{Darwin Options}
704 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
705 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
706 -client_name  -compatibility_version  -current_version @gol
707 -dead_strip @gol
708 -dependency-file  -dylib_file  -dylinker_install_name @gol
709 -dynamic  -dynamiclib  -exported_symbols_list @gol
710 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
711 -force_flat_namespace  -headerpad_max_install_names @gol
712 -iframework @gol
713 -image_base  -init  -install_name  -keep_private_externs @gol
714 -multi_module  -multiply_defined  -multiply_defined_unused @gol
715 -noall_load   -no_dead_strip_inits_and_terms @gol
716 -nofixprebinding  -nomultidefs  -noprebind  -noseglinkedit @gol
717 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
718 -private_bundle  -read_only_relocs  -sectalign @gol
719 -sectobjectsymbols  -whyload  -seg1addr @gol
720 -sectcreate  -sectobjectsymbols  -sectorder @gol
721 -segaddr  -segs_read_only_addr  -segs_read_write_addr @gol
722 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
723 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
724 -single_module  -static  -sub_library  -sub_umbrella @gol
725 -twolevel_namespace  -umbrella  -undefined @gol
726 -unexported_symbols_list  -weak_reference_mismatches @gol
727 -whatsloaded  -F  -gused  -gfull  -mmacosx-version-min=@var{version} @gol
728 -mkernel  -mone-byte-bool}
730 @emph{DEC Alpha Options}
731 @gccoptlist{-mno-fp-regs  -msoft-float @gol
732 -mieee  -mieee-with-inexact  -mieee-conformant @gol
733 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
734 -mtrap-precision=@var{mode}  -mbuild-constants @gol
735 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
736 -mbwx  -mmax  -mfix  -mcix @gol
737 -mfloat-vax  -mfloat-ieee @gol
738 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
739 -msmall-text  -mlarge-text @gol
740 -mmemory-latency=@var{time}}
742 @emph{FR30 Options}
743 @gccoptlist{-msmall-model  -mno-lsim}
745 @emph{FT32 Options}
746 @gccoptlist{-msim  -mlra  -mnodiv  -mft32b  -mcompress  -mnopm}
748 @emph{FRV Options}
749 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
750 -mhard-float  -msoft-float @gol
751 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
752 -mdouble  -mno-double @gol
753 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
754 -mfdpic  -minline-plt  -mgprel-ro  -multilib-library-pic @gol
755 -mlinked-fp  -mlong-calls  -malign-labels @gol
756 -mlibrary-pic  -macc-4  -macc-8 @gol
757 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
758 -moptimize-membar  -mno-optimize-membar @gol
759 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
760 -mvliw-branch  -mno-vliw-branch @gol
761 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
762 -mno-nested-cond-exec  -mtomcat-stats @gol
763 -mTLS  -mtls @gol
764 -mcpu=@var{cpu}}
766 @emph{GNU/Linux Options}
767 @gccoptlist{-mglibc  -muclibc  -mmusl  -mbionic  -mandroid @gol
768 -tno-android-cc  -tno-android-ld}
770 @emph{H8/300 Options}
771 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr  -mno-exr  -mint32  -malign-300}
773 @emph{HPPA Options}
774 @gccoptlist{-march=@var{architecture-type} @gol
775 -mcaller-copies  -mdisable-fpregs  -mdisable-indexing @gol
776 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
777 -mfixed-range=@var{register-range} @gol
778 -mjump-in-delay  -mlinker-opt  -mlong-calls @gol
779 -mlong-load-store  -mno-disable-fpregs @gol
780 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
781 -mno-jump-in-delay  -mno-long-load-store @gol
782 -mno-portable-runtime  -mno-soft-float @gol
783 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
784 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
785 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
786 -munix=@var{unix-std}  -nolibdld  -static  -threads}
788 @emph{IA-64 Options}
789 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
790 -mvolatile-asm-stop  -mregister-names  -msdata  -mno-sdata @gol
791 -mconstant-gp  -mauto-pic  -mfused-madd @gol
792 -minline-float-divide-min-latency @gol
793 -minline-float-divide-max-throughput @gol
794 -mno-inline-float-divide @gol
795 -minline-int-divide-min-latency @gol
796 -minline-int-divide-max-throughput  @gol
797 -mno-inline-int-divide @gol
798 -minline-sqrt-min-latency  -minline-sqrt-max-throughput @gol
799 -mno-inline-sqrt @gol
800 -mdwarf2-asm  -mearly-stop-bits @gol
801 -mfixed-range=@var{register-range}  -mtls-size=@var{tls-size} @gol
802 -mtune=@var{cpu-type}  -milp32  -mlp64 @gol
803 -msched-br-data-spec  -msched-ar-data-spec  -msched-control-spec @gol
804 -msched-br-in-data-spec  -msched-ar-in-data-spec  -msched-in-control-spec @gol
805 -msched-spec-ldc  -msched-spec-control-ldc @gol
806 -msched-prefer-non-data-spec-insns  -msched-prefer-non-control-spec-insns @gol
807 -msched-stop-bits-after-every-cycle  -msched-count-spec-in-critical-path @gol
808 -msel-sched-dont-check-control-spec  -msched-fp-mem-deps-zero-cost @gol
809 -msched-max-memory-insns-hard-limit  -msched-max-memory-insns=@var{max-insns}}
811 @emph{LM32 Options}
812 @gccoptlist{-mbarrel-shift-enabled  -mdivide-enabled  -mmultiply-enabled @gol
813 -msign-extend-enabled  -muser-enabled}
815 @emph{M32R/D Options}
816 @gccoptlist{-m32r2  -m32rx  -m32r @gol
817 -mdebug @gol
818 -malign-loops  -mno-align-loops @gol
819 -missue-rate=@var{number} @gol
820 -mbranch-cost=@var{number} @gol
821 -mmodel=@var{code-size-model-type} @gol
822 -msdata=@var{sdata-type} @gol
823 -mno-flush-func  -mflush-func=@var{name} @gol
824 -mno-flush-trap  -mflush-trap=@var{number} @gol
825 -G @var{num}}
827 @emph{M32C Options}
828 @gccoptlist{-mcpu=@var{cpu}  -msim  -memregs=@var{number}}
830 @emph{M680x0 Options}
831 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune} @gol
832 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
833 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
834 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
835 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
836 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
837 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
838 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
839 -mxgot  -mno-xgot  -mlong-jump-table-offsets}
841 @emph{MCore Options}
842 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
843 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
844 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
845 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
846 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
848 @emph{MeP Options}
849 @gccoptlist{-mabsdiff  -mall-opts  -maverage  -mbased=@var{n}  -mbitops @gol
850 -mc=@var{n}  -mclip  -mconfig=@var{name}  -mcop  -mcop32  -mcop64  -mivc2 @gol
851 -mdc  -mdiv  -meb  -mel  -mio-volatile  -ml  -mleadz  -mm  -mminmax @gol
852 -mmult  -mno-opts  -mrepeat  -ms  -msatur  -msdram  -msim  -msimnovec  -mtf @gol
853 -mtiny=@var{n}}
855 @emph{MicroBlaze Options}
856 @gccoptlist{-msoft-float  -mhard-float  -msmall-divides  -mcpu=@var{cpu} @gol
857 -mmemcpy  -mxl-soft-mul  -mxl-soft-div  -mxl-barrel-shift @gol
858 -mxl-pattern-compare  -mxl-stack-check  -mxl-gp-opt  -mno-clearbss @gol
859 -mxl-multiply-high  -mxl-float-convert  -mxl-float-sqrt @gol
860 -mbig-endian  -mlittle-endian  -mxl-reorder  -mxl-mode-@var{app-model}}
862 @emph{MIPS Options}
863 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
864 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips32r3  -mips32r5 @gol
865 -mips32r6  -mips64  -mips64r2  -mips64r3  -mips64r5  -mips64r6 @gol
866 -mips16  -mno-mips16  -mflip-mips16 @gol
867 -minterlink-compressed  -mno-interlink-compressed @gol
868 -minterlink-mips16  -mno-interlink-mips16 @gol
869 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
870 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
871 -mgp32  -mgp64  -mfp32  -mfpxx  -mfp64  -mhard-float  -msoft-float @gol
872 -mno-float  -msingle-float  -mdouble-float @gol
873 -modd-spreg  -mno-odd-spreg @gol
874 -mabs=@var{mode}  -mnan=@var{encoding} @gol
875 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
876 -mmcu  -mmno-mcu @gol
877 -meva  -mno-eva @gol
878 -mvirt  -mno-virt @gol
879 -mxpa  -mno-xpa @gol
880 -mmicromips  -mno-micromips @gol
881 -mmsa  -mno-msa @gol
882 -mfpu=@var{fpu-type} @gol
883 -msmartmips  -mno-smartmips @gol
884 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
885 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
886 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
887 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
888 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
889 -membedded-data  -mno-embedded-data @gol
890 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
891 -mcode-readable=@var{setting} @gol
892 -msplit-addresses  -mno-split-addresses @gol
893 -mexplicit-relocs  -mno-explicit-relocs @gol
894 -mcheck-zero-division  -mno-check-zero-division @gol
895 -mdivide-traps  -mdivide-breaks @gol
896 -mload-store-pairs  -mno-load-store-pairs @gol
897 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
898 -mmad  -mno-mad  -mimadd  -mno-imadd  -mfused-madd  -mno-fused-madd  -nocpp @gol
899 -mfix-24k  -mno-fix-24k @gol
900 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
901 -mfix-r10000  -mno-fix-r10000  -mfix-rm7000  -mno-fix-rm7000 @gol
902 -mfix-vr4120  -mno-fix-vr4120 @gol
903 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
904 -mflush-func=@var{func}  -mno-flush-func @gol
905 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
906 -mcompact-branches=@var{policy} @gol
907 -mfp-exceptions  -mno-fp-exceptions @gol
908 -mvr4130-align  -mno-vr4130-align  -msynci  -mno-synci @gol
909 -mlxc1-sxc1 -mno-lxc1-sxc1 -mmadd4 -mno-madd4 @gol
910 -mrelax-pic-calls  -mno-relax-pic-calls  -mmcount-ra-address @gol
911 -mframe-header-opt  -mno-frame-header-opt}
913 @emph{MMIX Options}
914 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
915 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
916 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
917 -mno-base-addresses  -msingle-exit  -mno-single-exit}
919 @emph{MN10300 Options}
920 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
921 -mno-am33  -mam33  -mam33-2  -mam34 @gol
922 -mtune=@var{cpu-type} @gol
923 -mreturn-pointer-on-d0 @gol
924 -mno-crt0  -mrelax  -mliw  -msetlb}
926 @emph{Moxie Options}
927 @gccoptlist{-meb  -mel  -mmul.x  -mno-crt0}
929 @emph{MSP430 Options}
930 @gccoptlist{-msim  -masm-hex  -mmcu=  -mcpu=  -mlarge  -msmall  -mrelax @gol
931 -mwarn-mcu @gol
932 -mcode-region=  -mdata-region= @gol
933 -msilicon-errata=  -msilicon-errata-warn= @gol
934 -mhwmult=  -minrt}
936 @emph{NDS32 Options}
937 @gccoptlist{-mbig-endian  -mlittle-endian @gol
938 -mreduced-regs  -mfull-regs @gol
939 -mcmov  -mno-cmov @gol
940 -mperf-ext  -mno-perf-ext @gol
941 -mv3push  -mno-v3push @gol
942 -m16bit  -mno-16bit @gol
943 -misr-vector-size=@var{num} @gol
944 -mcache-block-size=@var{num} @gol
945 -march=@var{arch} @gol
946 -mcmodel=@var{code-model} @gol
947 -mctor-dtor  -mrelax}
949 @emph{Nios II Options}
950 @gccoptlist{-G @var{num}  -mgpopt=@var{option}  -mgpopt  -mno-gpopt @gol
951 -mgprel-sec=@var{regexp} -mr0rel-sec=@var{regexp} @gol
952 -mel  -meb @gol
953 -mno-bypass-cache  -mbypass-cache @gol
954 -mno-cache-volatile  -mcache-volatile @gol
955 -mno-fast-sw-div  -mfast-sw-div @gol
956 -mhw-mul  -mno-hw-mul  -mhw-mulx  -mno-hw-mulx  -mno-hw-div  -mhw-div @gol
957 -mcustom-@var{insn}=@var{N}  -mno-custom-@var{insn} @gol
958 -mcustom-fpu-cfg=@var{name} @gol
959 -mhal  -msmallc  -msys-crt0=@var{name}  -msys-lib=@var{name} @gol
960 -march=@var{arch}  -mbmx  -mno-bmx  -mcdx  -mno-cdx}
962 @emph{Nvidia PTX Options}
963 @gccoptlist{-m32  -m64  -mmainkernel  -moptimize}
965 @emph{PDP-11 Options}
966 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
967 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
968 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
969 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
970 -mbranch-expensive  -mbranch-cheap @gol
971 -munix-asm  -mdec-asm}
973 @emph{picoChip Options}
974 @gccoptlist{-mae=@var{ae_type}  -mvliw-lookahead=@var{N} @gol
975 -msymbol-as-address  -mno-inefficient-warnings}
977 @emph{PowerPC Options}
978 See RS/6000 and PowerPC Options.
980 @emph{RISC-V Options}
981 @gccoptlist{-mbranch-cost=@var{N-instruction} @gol
982 -mplt  -mno-plt @gol
983 -mabi=@var{ABI-string} @gol
984 -mfdiv  -mno-fdiv @gol
985 -mdiv  -mno-div @gol
986 -march=@var{ISA-string} @gol
987 -mtune=@var{processor-string} @gol
988 -msmall-data-limit=@var{N-bytes} @gol
989 -msave-restore  -mno-save-restore @gol
990 -mstrict-align -mno-strict-align @gol
991 -mcmodel=medlow -mcmodel=medany @gol
992 -mexplicit-relocs  -mno-explicit-relocs @gol}
994 @emph{RL78 Options}
995 @gccoptlist{-msim  -mmul=none  -mmul=g13  -mmul=g14  -mallregs @gol
996 -mcpu=g10  -mcpu=g13  -mcpu=g14  -mg10  -mg13  -mg14 @gol
997 -m64bit-doubles  -m32bit-doubles  -msave-mduc-in-interrupts}
999 @emph{RS/6000 and PowerPC Options}
1000 @gccoptlist{-mcpu=@var{cpu-type} @gol
1001 -mtune=@var{cpu-type} @gol
1002 -mcmodel=@var{code-model} @gol
1003 -mpowerpc64 @gol
1004 -maltivec  -mno-altivec @gol
1005 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
1006 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
1007 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mpopcntd  -mno-popcntd @gol
1008 -mfprnd  -mno-fprnd @gol
1009 -mcmpb  -mno-cmpb  -mmfpgpr  -mno-mfpgpr  -mhard-dfp  -mno-hard-dfp @gol
1010 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
1011 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
1012 -malign-power  -malign-natural @gol
1013 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
1014 -msingle-float  -mdouble-float  -msimple-fpu @gol
1015 -mstring  -mno-string  -mupdate  -mno-update @gol
1016 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
1017 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
1018 -mstrict-align  -mno-strict-align  -mrelocatable @gol
1019 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
1020 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
1021 -mdynamic-no-pic  -maltivec  -mswdiv  -msingle-pic-base @gol
1022 -mprioritize-restricted-insns=@var{priority} @gol
1023 -msched-costly-dep=@var{dependence_type} @gol
1024 -minsert-sched-nops=@var{scheme} @gol
1025 -mcall-sysv  -mcall-netbsd @gol
1026 -maix-struct-return  -msvr4-struct-return @gol
1027 -mabi=@var{abi-type}  -msecure-plt  -mbss-plt @gol
1028 -mblock-move-inline-limit=@var{num} @gol
1029 -misel  -mno-isel @gol
1030 -misel=yes  -misel=no @gol
1031 -mspe  -mno-spe @gol
1032 -mspe=yes  -mspe=no @gol
1033 -mpaired @gol
1034 -mvrsave  -mno-vrsave @gol
1035 -mmulhw  -mno-mulhw @gol
1036 -mdlmzb  -mno-dlmzb @gol
1037 -mfloat-gprs=yes  -mfloat-gprs=no  -mfloat-gprs=single  -mfloat-gprs=double @gol
1038 -mprototype  -mno-prototype @gol
1039 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
1040 -msdata=@var{opt}  -mvxworks  -G @var{num} @gol
1041 -mrecip  -mrecip=@var{opt}  -mno-recip  -mrecip-precision @gol
1042 -mno-recip-precision @gol
1043 -mveclibabi=@var{type}  -mfriz  -mno-friz @gol
1044 -mpointers-to-nested-functions  -mno-pointers-to-nested-functions @gol
1045 -msave-toc-indirect  -mno-save-toc-indirect @gol
1046 -mpower8-fusion  -mno-mpower8-fusion  -mpower8-vector  -mno-power8-vector @gol
1047 -mcrypto  -mno-crypto  -mhtm  -mno-htm  -mdirect-move  -mno-direct-move @gol
1048 -mquad-memory  -mno-quad-memory @gol
1049 -mquad-memory-atomic  -mno-quad-memory-atomic @gol
1050 -mcompat-align-parm  -mno-compat-align-parm @gol
1051 -mfloat128  -mno-float128  -mfloat128-hardware  -mno-float128-hardware @gol
1052 -mgnu-attribute  -mno-gnu-attribute @gol
1053 -mstack-protector-guard=@var{guard} -mstack-protector-guard-reg=@var{reg} @gol
1054 -mstack-protector-guard-offset=@var{offset}}
1056 @emph{RX Options}
1057 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
1058 -mcpu=@gol
1059 -mbig-endian-data  -mlittle-endian-data @gol
1060 -msmall-data @gol
1061 -msim  -mno-sim@gol
1062 -mas100-syntax  -mno-as100-syntax@gol
1063 -mrelax@gol
1064 -mmax-constant-size=@gol
1065 -mint-register=@gol
1066 -mpid@gol
1067 -mallow-string-insns  -mno-allow-string-insns@gol
1068 -mjsr@gol
1069 -mno-warn-multiple-fast-interrupts@gol
1070 -msave-acc-in-interrupts}
1072 @emph{S/390 and zSeries Options}
1073 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1074 -mhard-float  -msoft-float  -mhard-dfp  -mno-hard-dfp @gol
1075 -mlong-double-64  -mlong-double-128 @gol
1076 -mbackchain  -mno-backchain  -mpacked-stack  -mno-packed-stack @gol
1077 -msmall-exec  -mno-small-exec  -mmvcle  -mno-mvcle @gol
1078 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
1079 -mhtm  -mvx  -mzvector @gol
1080 -mtpf-trace  -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
1081 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size  -mstack-guard @gol
1082 -mhotpatch=@var{halfwords},@var{halfwords}}
1084 @emph{Score Options}
1085 @gccoptlist{-meb  -mel @gol
1086 -mnhwloop @gol
1087 -muls @gol
1088 -mmac @gol
1089 -mscore5  -mscore5u  -mscore7  -mscore7d}
1091 @emph{SH Options}
1092 @gccoptlist{-m1  -m2  -m2e @gol
1093 -m2a-nofpu  -m2a-single-only  -m2a-single  -m2a @gol
1094 -m3  -m3e @gol
1095 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
1096 -m4a-nofpu  -m4a-single-only  -m4a-single  -m4a  -m4al @gol
1097 -mb  -ml  -mdalign  -mrelax @gol
1098 -mbigtable  -mfmovd  -mrenesas  -mno-renesas  -mnomacsave @gol
1099 -mieee  -mno-ieee  -mbitops  -misize  -minline-ic_invalidate  -mpadstruct @gol
1100 -mprefergot  -musermode  -multcost=@var{number}  -mdiv=@var{strategy} @gol
1101 -mdivsi3_libfunc=@var{name}  -mfixed-range=@var{register-range} @gol
1102 -maccumulate-outgoing-args @gol
1103 -matomic-model=@var{atomic-model} @gol
1104 -mbranch-cost=@var{num}  -mzdcbranch  -mno-zdcbranch @gol
1105 -mcbranch-force-delay-slot @gol
1106 -mfused-madd  -mno-fused-madd  -mfsca  -mno-fsca  -mfsrra  -mno-fsrra @gol
1107 -mpretend-cmove  -mtas}
1109 @emph{Solaris 2 Options}
1110 @gccoptlist{-mclear-hwcap  -mno-clear-hwcap  -mimpure-text  -mno-impure-text @gol
1111 -pthreads}
1113 @emph{SPARC Options}
1114 @gccoptlist{-mcpu=@var{cpu-type} @gol
1115 -mtune=@var{cpu-type} @gol
1116 -mcmodel=@var{code-model} @gol
1117 -mmemory-model=@var{mem-model} @gol
1118 -m32  -m64  -mapp-regs  -mno-app-regs @gol
1119 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
1120 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1121 -mhard-quad-float  -msoft-quad-float @gol
1122 -mstack-bias  -mno-stack-bias @gol
1123 -mstd-struct-return  -mno-std-struct-return @gol
1124 -munaligned-doubles  -mno-unaligned-doubles @gol
1125 -muser-mode  -mno-user-mode @gol
1126 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
1127 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
1128 -mvis4 -mno-vis4 -mvis4b -mno-vis4b @gol
1129 -mcbcond  -mno-cbcond  -mfmaf  -mno-fmaf  -mfsmuld  -mno-fsmuld  @gol
1130 -mpopc  -mno-popc  -msubxc  -mno-subxc @gol
1131 -mfix-at697f  -mfix-ut699  -mfix-ut700  -mfix-gr712rc @gol
1132 -mlra  -mno-lra}
1134 @emph{SPU Options}
1135 @gccoptlist{-mwarn-reloc  -merror-reloc @gol
1136 -msafe-dma  -munsafe-dma @gol
1137 -mbranch-hints @gol
1138 -msmall-mem  -mlarge-mem  -mstdmain @gol
1139 -mfixed-range=@var{register-range} @gol
1140 -mea32  -mea64 @gol
1141 -maddress-space-conversion  -mno-address-space-conversion @gol
1142 -mcache-size=@var{cache-size} @gol
1143 -matomic-updates  -mno-atomic-updates}
1145 @emph{System V Options}
1146 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
1148 @emph{TILE-Gx Options}
1149 @gccoptlist{-mcpu=CPU  -m32  -m64  -mbig-endian  -mlittle-endian @gol
1150 -mcmodel=@var{code-model}}
1152 @emph{TILEPro Options}
1153 @gccoptlist{-mcpu=@var{cpu}  -m32}
1155 @emph{V850 Options}
1156 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
1157 -mprolog-function  -mno-prolog-function  -mspace @gol
1158 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
1159 -mapp-regs  -mno-app-regs @gol
1160 -mdisable-callt  -mno-disable-callt @gol
1161 -mv850e2v3  -mv850e2  -mv850e1  -mv850es @gol
1162 -mv850e  -mv850  -mv850e3v5 @gol
1163 -mloop @gol
1164 -mrelax @gol
1165 -mlong-jumps @gol
1166 -msoft-float @gol
1167 -mhard-float @gol
1168 -mgcc-abi @gol
1169 -mrh850-abi @gol
1170 -mbig-switch}
1172 @emph{VAX Options}
1173 @gccoptlist{-mg  -mgnu  -munix}
1175 @emph{Visium Options}
1176 @gccoptlist{-mdebug  -msim  -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1177 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type}  -msv-mode  -muser-mode}
1179 @emph{VMS Options}
1180 @gccoptlist{-mvms-return-codes  -mdebug-main=@var{prefix}  -mmalloc64 @gol
1181 -mpointer-size=@var{size}}
1183 @emph{VxWorks Options}
1184 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1185 -Xbind-lazy  -Xbind-now}
1187 @emph{x86 Options}
1188 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1189 -mtune-ctrl=@var{feature-list}  -mdump-tune-features  -mno-default @gol
1190 -mfpmath=@var{unit} @gol
1191 -masm=@var{dialect}  -mno-fancy-math-387 @gol
1192 -mno-fp-ret-in-387  -m80387  -mhard-float  -msoft-float @gol
1193 -mno-wide-multiply  -mrtd  -malign-double @gol
1194 -mpreferred-stack-boundary=@var{num} @gol
1195 -mincoming-stack-boundary=@var{num} @gol
1196 -mcld  -mcx16  -msahf  -mmovbe  -mcrc32 @gol
1197 -mrecip  -mrecip=@var{opt} @gol
1198 -mvzeroupper  -mprefer-avx128 -mprefer-vector-width=@var{opt} @gol
1199 -mmmx  -msse  -msse2  -msse3  -mssse3  -msse4.1  -msse4.2  -msse4  -mavx @gol
1200 -mavx2  -mavx512f  -mavx512pf  -mavx512er  -mavx512cd  -mavx512vl @gol
1201 -mavx512bw  -mavx512dq  -mavx512ifma  -mavx512vbmi  -msha  -maes @gol
1202 -mpclmul  -mfsgsbase  -mrdrnd  -mf16c  -mfma @gol
1203 -mprefetchwt1  -mclflushopt  -mxsavec  -mxsaves @gol
1204 -msse4a  -m3dnow  -m3dnowa  -mpopcnt  -mabm  -mbmi  -mtbm  -mfma4  -mxop @gol
1205 -mlzcnt  -mbmi2  -mfxsr  -mxsave  -mxsaveopt  -mrtm  -mlwp  -mmpx  @gol
1206 -mmwaitx  -mclzero  -mpku  -mthreads -mgfni @gol
1207 -mcet -mibt -mshstk -mforce-indirect-call -mavx512vbmi2 @gol
1208 -mms-bitfields  -mno-align-stringops  -minline-all-stringops @gol
1209 -minline-stringops-dynamically  -mstringop-strategy=@var{alg} @gol
1210 -mmemcpy-strategy=@var{strategy}  -mmemset-strategy=@var{strategy} @gol
1211 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
1212 -m96bit-long-double  -mlong-double-64  -mlong-double-80  -mlong-double-128 @gol
1213 -mregparm=@var{num}  -msseregparm @gol
1214 -mveclibabi=@var{type}  -mvect8-ret-in-mem @gol
1215 -mpc32  -mpc64  -mpc80  -mstackrealign @gol
1216 -momit-leaf-frame-pointer  -mno-red-zone  -mno-tls-direct-seg-refs @gol
1217 -mcmodel=@var{code-model}  -mabi=@var{name}  -maddress-mode=@var{mode} @gol
1218 -m32  -m64  -mx32  -m16  -miamcu  -mlarge-data-threshold=@var{num} @gol
1219 -msse2avx  -mfentry  -mrecord-mcount  -mnop-mcount  -m8bit-idiv @gol
1220 -mavx256-split-unaligned-load  -mavx256-split-unaligned-store @gol
1221 -malign-data=@var{type}  -mstack-protector-guard=@var{guard} @gol
1222 -mstack-protector-guard-reg=@var{reg} @gol
1223 -mstack-protector-guard-offset=@var{offset} @gol
1224 -mstack-protector-guard-symbol=@var{symbol} -mmitigate-rop @gol
1225 -mgeneral-regs-only  -mcall-ms2sysv-xlogues}
1227 @emph{x86 Windows Options}
1228 @gccoptlist{-mconsole  -mcygwin  -mno-cygwin  -mdll @gol
1229 -mnop-fun-dllimport  -mthread @gol
1230 -municode  -mwin32  -mwindows  -fno-set-stack-executable}
1232 @emph{Xstormy16 Options}
1233 @gccoptlist{-msim}
1235 @emph{Xtensa Options}
1236 @gccoptlist{-mconst16  -mno-const16 @gol
1237 -mfused-madd  -mno-fused-madd @gol
1238 -mforce-no-pic @gol
1239 -mserialize-volatile  -mno-serialize-volatile @gol
1240 -mtext-section-literals  -mno-text-section-literals @gol
1241 -mauto-litpools  -mno-auto-litpools @gol
1242 -mtarget-align  -mno-target-align @gol
1243 -mlongcalls  -mno-longcalls}
1245 @emph{zSeries Options}
1246 See S/390 and zSeries Options.
1247 @end table
1250 @node Overall Options
1251 @section Options Controlling the Kind of Output
1253 Compilation can involve up to four stages: preprocessing, compilation
1254 proper, assembly and linking, always in that order.  GCC is capable of
1255 preprocessing and compiling several files either into several
1256 assembler input files, or into one assembler input file; then each
1257 assembler input file produces an object file, and linking combines all
1258 the object files (those newly compiled, and those specified as input)
1259 into an executable file.
1261 @cindex file name suffix
1262 For any given input file, the file name suffix determines what kind of
1263 compilation is done:
1265 @table @gcctabopt
1266 @item @var{file}.c
1267 C source code that must be preprocessed.
1269 @item @var{file}.i
1270 C source code that should not be preprocessed.
1272 @item @var{file}.ii
1273 C++ source code that should not be preprocessed.
1275 @item @var{file}.m
1276 Objective-C source code.  Note that you must link with the @file{libobjc}
1277 library to make an Objective-C program work.
1279 @item @var{file}.mi
1280 Objective-C source code that should not be preprocessed.
1282 @item @var{file}.mm
1283 @itemx @var{file}.M
1284 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1285 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1286 to a literal capital M@.
1288 @item @var{file}.mii
1289 Objective-C++ source code that should not be preprocessed.
1291 @item @var{file}.h
1292 C, C++, Objective-C or Objective-C++ header file to be turned into a
1293 precompiled header (default), or C, C++ header file to be turned into an
1294 Ada spec (via the @option{-fdump-ada-spec} switch).
1296 @item @var{file}.cc
1297 @itemx @var{file}.cp
1298 @itemx @var{file}.cxx
1299 @itemx @var{file}.cpp
1300 @itemx @var{file}.CPP
1301 @itemx @var{file}.c++
1302 @itemx @var{file}.C
1303 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1304 the last two letters must both be literally @samp{x}.  Likewise,
1305 @samp{.C} refers to a literal capital C@.
1307 @item @var{file}.mm
1308 @itemx @var{file}.M
1309 Objective-C++ source code that must be preprocessed.
1311 @item @var{file}.mii
1312 Objective-C++ source code that should not be preprocessed.
1314 @item @var{file}.hh
1315 @itemx @var{file}.H
1316 @itemx @var{file}.hp
1317 @itemx @var{file}.hxx
1318 @itemx @var{file}.hpp
1319 @itemx @var{file}.HPP
1320 @itemx @var{file}.h++
1321 @itemx @var{file}.tcc
1322 C++ header file to be turned into a precompiled header or Ada spec.
1324 @item @var{file}.f
1325 @itemx @var{file}.for
1326 @itemx @var{file}.ftn
1327 Fixed form Fortran source code that should not be preprocessed.
1329 @item @var{file}.F
1330 @itemx @var{file}.FOR
1331 @itemx @var{file}.fpp
1332 @itemx @var{file}.FPP
1333 @itemx @var{file}.FTN
1334 Fixed form Fortran source code that must be preprocessed (with the traditional
1335 preprocessor).
1337 @item @var{file}.f90
1338 @itemx @var{file}.f95
1339 @itemx @var{file}.f03
1340 @itemx @var{file}.f08
1341 Free form Fortran source code that should not be preprocessed.
1343 @item @var{file}.F90
1344 @itemx @var{file}.F95
1345 @itemx @var{file}.F03
1346 @itemx @var{file}.F08
1347 Free form Fortran source code that must be preprocessed (with the
1348 traditional preprocessor).
1350 @item @var{file}.go
1351 Go source code.
1353 @item @var{file}.brig
1354 BRIG files (binary representation of HSAIL).
1356 @item @var{file}.ads
1357 Ada source code file that contains a library unit declaration (a
1358 declaration of a package, subprogram, or generic, or a generic
1359 instantiation), or a library unit renaming declaration (a package,
1360 generic, or subprogram renaming declaration).  Such files are also
1361 called @dfn{specs}.
1363 @item @var{file}.adb
1364 Ada source code file containing a library unit body (a subprogram or
1365 package body).  Such files are also called @dfn{bodies}.
1367 @c GCC also knows about some suffixes for languages not yet included:
1368 @c Pascal:
1369 @c @var{file}.p
1370 @c @var{file}.pas
1371 @c Ratfor:
1372 @c @var{file}.r
1374 @item @var{file}.s
1375 Assembler code.
1377 @item @var{file}.S
1378 @itemx @var{file}.sx
1379 Assembler code that must be preprocessed.
1381 @item @var{other}
1382 An object file to be fed straight into linking.
1383 Any file name with no recognized suffix is treated this way.
1384 @end table
1386 @opindex x
1387 You can specify the input language explicitly with the @option{-x} option:
1389 @table @gcctabopt
1390 @item -x @var{language}
1391 Specify explicitly the @var{language} for the following input files
1392 (rather than letting the compiler choose a default based on the file
1393 name suffix).  This option applies to all following input files until
1394 the next @option{-x} option.  Possible values for @var{language} are:
1395 @smallexample
1396 c  c-header  cpp-output
1397 c++  c++-header  c++-cpp-output
1398 objective-c  objective-c-header  objective-c-cpp-output
1399 objective-c++ objective-c++-header objective-c++-cpp-output
1400 assembler  assembler-with-cpp
1402 f77  f77-cpp-input f95  f95-cpp-input
1404 brig
1405 @end smallexample
1407 @item -x none
1408 Turn off any specification of a language, so that subsequent files are
1409 handled according to their file name suffixes (as they are if @option{-x}
1410 has not been used at all).
1411 @end table
1413 If you only want some of the stages of compilation, you can use
1414 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1415 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1416 @command{gcc} is to stop.  Note that some combinations (for example,
1417 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1419 @table @gcctabopt
1420 @item -c
1421 @opindex c
1422 Compile or assemble the source files, but do not link.  The linking
1423 stage simply is not done.  The ultimate output is in the form of an
1424 object file for each source file.
1426 By default, the object file name for a source file is made by replacing
1427 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1429 Unrecognized input files, not requiring compilation or assembly, are
1430 ignored.
1432 @item -S
1433 @opindex S
1434 Stop after the stage of compilation proper; do not assemble.  The output
1435 is in the form of an assembler code file for each non-assembler input
1436 file specified.
1438 By default, the assembler file name for a source file is made by
1439 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1441 Input files that don't require compilation are ignored.
1443 @item -E
1444 @opindex E
1445 Stop after the preprocessing stage; do not run the compiler proper.  The
1446 output is in the form of preprocessed source code, which is sent to the
1447 standard output.
1449 Input files that don't require preprocessing are ignored.
1451 @cindex output file option
1452 @item -o @var{file}
1453 @opindex o
1454 Place output in file @var{file}.  This applies to whatever
1455 sort of output is being produced, whether it be an executable file,
1456 an object file, an assembler file or preprocessed C code.
1458 If @option{-o} is not specified, the default is to put an executable
1459 file in @file{a.out}, the object file for
1460 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1461 assembler file in @file{@var{source}.s}, a precompiled header file in
1462 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1463 standard output.
1465 @item -v
1466 @opindex v
1467 Print (on standard error output) the commands executed to run the stages
1468 of compilation.  Also print the version number of the compiler driver
1469 program and of the preprocessor and the compiler proper.
1471 @item -###
1472 @opindex ###
1473 Like @option{-v} except the commands are not executed and arguments
1474 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1475 This is useful for shell scripts to capture the driver-generated command lines.
1477 @item --help
1478 @opindex help
1479 Print (on the standard output) a description of the command-line options
1480 understood by @command{gcc}.  If the @option{-v} option is also specified
1481 then @option{--help} is also passed on to the various processes
1482 invoked by @command{gcc}, so that they can display the command-line options
1483 they accept.  If the @option{-Wextra} option has also been specified
1484 (prior to the @option{--help} option), then command-line options that
1485 have no documentation associated with them are also displayed.
1487 @item --target-help
1488 @opindex target-help
1489 Print (on the standard output) a description of target-specific command-line
1490 options for each tool.  For some targets extra target-specific
1491 information may also be printed.
1493 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1494 Print (on the standard output) a description of the command-line
1495 options understood by the compiler that fit into all specified classes
1496 and qualifiers.  These are the supported classes:
1498 @table @asis
1499 @item @samp{optimizers}
1500 Display all of the optimization options supported by the
1501 compiler.
1503 @item @samp{warnings}
1504 Display all of the options controlling warning messages
1505 produced by the compiler.
1507 @item @samp{target}
1508 Display target-specific options.  Unlike the
1509 @option{--target-help} option however, target-specific options of the
1510 linker and assembler are not displayed.  This is because those
1511 tools do not currently support the extended @option{--help=} syntax.
1513 @item @samp{params}
1514 Display the values recognized by the @option{--param}
1515 option.
1517 @item @var{language}
1518 Display the options supported for @var{language}, where
1519 @var{language} is the name of one of the languages supported in this
1520 version of GCC@.
1522 @item @samp{common}
1523 Display the options that are common to all languages.
1524 @end table
1526 These are the supported qualifiers:
1528 @table @asis
1529 @item @samp{undocumented}
1530 Display only those options that are undocumented.
1532 @item @samp{joined}
1533 Display options taking an argument that appears after an equal
1534 sign in the same continuous piece of text, such as:
1535 @samp{--help=target}.
1537 @item @samp{separate}
1538 Display options taking an argument that appears as a separate word
1539 following the original option, such as: @samp{-o output-file}.
1540 @end table
1542 Thus for example to display all the undocumented target-specific
1543 switches supported by the compiler, use:
1545 @smallexample
1546 --help=target,undocumented
1547 @end smallexample
1549 The sense of a qualifier can be inverted by prefixing it with the
1550 @samp{^} character, so for example to display all binary warning
1551 options (i.e., ones that are either on or off and that do not take an
1552 argument) that have a description, use:
1554 @smallexample
1555 --help=warnings,^joined,^undocumented
1556 @end smallexample
1558 The argument to @option{--help=} should not consist solely of inverted
1559 qualifiers.
1561 Combining several classes is possible, although this usually
1562 restricts the output so much that there is nothing to display.  One
1563 case where it does work, however, is when one of the classes is
1564 @var{target}.  For example, to display all the target-specific
1565 optimization options, use:
1567 @smallexample
1568 --help=target,optimizers
1569 @end smallexample
1571 The @option{--help=} option can be repeated on the command line.  Each
1572 successive use displays its requested class of options, skipping
1573 those that have already been displayed.
1575 If the @option{-Q} option appears on the command line before the
1576 @option{--help=} option, then the descriptive text displayed by
1577 @option{--help=} is changed.  Instead of describing the displayed
1578 options, an indication is given as to whether the option is enabled,
1579 disabled or set to a specific value (assuming that the compiler
1580 knows this at the point where the @option{--help=} option is used).
1582 Here is a truncated example from the ARM port of @command{gcc}:
1584 @smallexample
1585   % gcc -Q -mabi=2 --help=target -c
1586   The following options are target specific:
1587   -mabi=                                2
1588   -mabort-on-noreturn                   [disabled]
1589   -mapcs                                [disabled]
1590 @end smallexample
1592 The output is sensitive to the effects of previous command-line
1593 options, so for example it is possible to find out which optimizations
1594 are enabled at @option{-O2} by using:
1596 @smallexample
1597 -Q -O2 --help=optimizers
1598 @end smallexample
1600 Alternatively you can discover which binary optimizations are enabled
1601 by @option{-O3} by using:
1603 @smallexample
1604 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1605 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1606 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1607 @end smallexample
1609 @item --version
1610 @opindex version
1611 Display the version number and copyrights of the invoked GCC@.
1613 @item -pass-exit-codes
1614 @opindex pass-exit-codes
1615 Normally the @command{gcc} program exits with the code of 1 if any
1616 phase of the compiler returns a non-success return code.  If you specify
1617 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1618 the numerically highest error produced by any phase returning an error
1619 indication.  The C, C++, and Fortran front ends return 4 if an internal
1620 compiler error is encountered.
1622 @item -pipe
1623 @opindex pipe
1624 Use pipes rather than temporary files for communication between the
1625 various stages of compilation.  This fails to work on some systems where
1626 the assembler is unable to read from a pipe; but the GNU assembler has
1627 no trouble.
1629 @item -specs=@var{file}
1630 @opindex specs
1631 Process @var{file} after the compiler reads in the standard @file{specs}
1632 file, in order to override the defaults which the @command{gcc} driver
1633 program uses when determining what switches to pass to @command{cc1},
1634 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
1635 @option{-specs=@var{file}} can be specified on the command line, and they
1636 are processed in order, from left to right.  @xref{Spec Files}, for
1637 information about the format of the @var{file}.
1639 @item -wrapper
1640 @opindex wrapper
1641 Invoke all subcommands under a wrapper program.  The name of the
1642 wrapper program and its parameters are passed as a comma separated
1643 list.
1645 @smallexample
1646 gcc -c t.c -wrapper gdb,--args
1647 @end smallexample
1649 @noindent
1650 This invokes all subprograms of @command{gcc} under
1651 @samp{gdb --args}, thus the invocation of @command{cc1} is
1652 @samp{gdb --args cc1 @dots{}}.
1654 @item -fplugin=@var{name}.so
1655 @opindex fplugin
1656 Load the plugin code in file @var{name}.so, assumed to be a
1657 shared object to be dlopen'd by the compiler.  The base name of
1658 the shared object file is used to identify the plugin for the
1659 purposes of argument parsing (See
1660 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1661 Each plugin should define the callback functions specified in the
1662 Plugins API.
1664 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1665 @opindex fplugin-arg
1666 Define an argument called @var{key} with a value of @var{value}
1667 for the plugin called @var{name}.
1669 @item -fdump-ada-spec@r{[}-slim@r{]}
1670 @opindex fdump-ada-spec
1671 For C and C++ source and include files, generate corresponding Ada specs.
1672 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1673 GNAT User's Guide}, which provides detailed documentation on this feature.
1675 @item -fada-spec-parent=@var{unit}
1676 @opindex fada-spec-parent
1677 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1678 Ada specs as child units of parent @var{unit}.
1680 @item -fdump-go-spec=@var{file}
1681 @opindex fdump-go-spec
1682 For input files in any language, generate corresponding Go
1683 declarations in @var{file}.  This generates Go @code{const},
1684 @code{type}, @code{var}, and @code{func} declarations which may be a
1685 useful way to start writing a Go interface to code written in some
1686 other language.
1688 @include @value{srcdir}/../libiberty/at-file.texi
1689 @end table
1691 @node Invoking G++
1692 @section Compiling C++ Programs
1694 @cindex suffixes for C++ source
1695 @cindex C++ source file suffixes
1696 C++ source files conventionally use one of the suffixes @samp{.C},
1697 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1698 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1699 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1700 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1701 files with these names and compiles them as C++ programs even if you
1702 call the compiler the same way as for compiling C programs (usually
1703 with the name @command{gcc}).
1705 @findex g++
1706 @findex c++
1707 However, the use of @command{gcc} does not add the C++ library.
1708 @command{g++} is a program that calls GCC and automatically specifies linking
1709 against the C++ library.  It treats @samp{.c},
1710 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1711 files unless @option{-x} is used.  This program is also useful when
1712 precompiling a C header file with a @samp{.h} extension for use in C++
1713 compilations.  On many systems, @command{g++} is also installed with
1714 the name @command{c++}.
1716 @cindex invoking @command{g++}
1717 When you compile C++ programs, you may specify many of the same
1718 command-line options that you use for compiling programs in any
1719 language; or command-line options meaningful for C and related
1720 languages; or options that are meaningful only for C++ programs.
1721 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1722 explanations of options for languages related to C@.
1723 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1724 explanations of options that are meaningful only for C++ programs.
1726 @node C Dialect Options
1727 @section Options Controlling C Dialect
1728 @cindex dialect options
1729 @cindex language dialect options
1730 @cindex options, dialect
1732 The following options control the dialect of C (or languages derived
1733 from C, such as C++, Objective-C and Objective-C++) that the compiler
1734 accepts:
1736 @table @gcctabopt
1737 @cindex ANSI support
1738 @cindex ISO support
1739 @item -ansi
1740 @opindex ansi
1741 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1742 equivalent to @option{-std=c++98}.
1744 This turns off certain features of GCC that are incompatible with ISO
1745 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1746 such as the @code{asm} and @code{typeof} keywords, and
1747 predefined macros such as @code{unix} and @code{vax} that identify the
1748 type of system you are using.  It also enables the undesirable and
1749 rarely used ISO trigraph feature.  For the C compiler,
1750 it disables recognition of C++ style @samp{//} comments as well as
1751 the @code{inline} keyword.
1753 The alternate keywords @code{__asm__}, @code{__extension__},
1754 @code{__inline__} and @code{__typeof__} continue to work despite
1755 @option{-ansi}.  You would not want to use them in an ISO C program, of
1756 course, but it is useful to put them in header files that might be included
1757 in compilations done with @option{-ansi}.  Alternate predefined macros
1758 such as @code{__unix__} and @code{__vax__} are also available, with or
1759 without @option{-ansi}.
1761 The @option{-ansi} option does not cause non-ISO programs to be
1762 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1763 addition to @option{-ansi}.  @xref{Warning Options}.
1765 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1766 option is used.  Some header files may notice this macro and refrain
1767 from declaring certain functions or defining certain macros that the
1768 ISO standard doesn't call for; this is to avoid interfering with any
1769 programs that might use these names for other things.
1771 Functions that are normally built in but do not have semantics
1772 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1773 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1774 built-in functions provided by GCC}, for details of the functions
1775 affected.
1777 @item -std=
1778 @opindex std
1779 Determine the language standard. @xref{Standards,,Language Standards
1780 Supported by GCC}, for details of these standard versions.  This option
1781 is currently only supported when compiling C or C++.
1783 The compiler can accept several base standards, such as @samp{c90} or
1784 @samp{c++98}, and GNU dialects of those standards, such as
1785 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1786 compiler accepts all programs following that standard plus those
1787 using GNU extensions that do not contradict it.  For example,
1788 @option{-std=c90} turns off certain features of GCC that are
1789 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1790 keywords, but not other GNU extensions that do not have a meaning in
1791 ISO C90, such as omitting the middle term of a @code{?:}
1792 expression. On the other hand, when a GNU dialect of a standard is
1793 specified, all features supported by the compiler are enabled, even when
1794 those features change the meaning of the base standard.  As a result, some
1795 strict-conforming programs may be rejected.  The particular standard
1796 is used by @option{-Wpedantic} to identify which features are GNU
1797 extensions given that version of the standard. For example
1798 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1799 comments, while @option{-std=gnu99 -Wpedantic} does not.
1801 A value for this option must be provided; possible values are
1803 @table @samp
1804 @item c90
1805 @itemx c89
1806 @itemx iso9899:1990
1807 Support all ISO C90 programs (certain GNU extensions that conflict
1808 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1810 @item iso9899:199409
1811 ISO C90 as modified in amendment 1.
1813 @item c99
1814 @itemx c9x
1815 @itemx iso9899:1999
1816 @itemx iso9899:199x
1817 ISO C99.  This standard is substantially completely supported, modulo
1818 bugs and floating-point issues
1819 (mainly but not entirely relating to optional C99 features from
1820 Annexes F and G).  See
1821 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1822 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1824 @item c11
1825 @itemx c1x
1826 @itemx iso9899:2011
1827 ISO C11, the 2011 revision of the ISO C standard.  This standard is
1828 substantially completely supported, modulo bugs, floating-point issues
1829 (mainly but not entirely relating to optional C11 features from
1830 Annexes F and G) and the optional Annexes K (Bounds-checking
1831 interfaces) and L (Analyzability).  The name @samp{c1x} is deprecated.
1833 @item c17
1834 @itemx c18
1835 @itemx iso9899:2017
1836 @itemx iso9899:2018
1837 ISO C17, the 2017 revision of the ISO C standard (expected to be
1838 published in 2018).  This standard is
1839 same as C11 except for corrections of defects (all of which are also
1840 applied with @option{-std=c11}) and a new value of
1841 @code{__STDC_VERSION__}, and so is supported to the same extent as C11.
1843 @item gnu90
1844 @itemx gnu89
1845 GNU dialect of ISO C90 (including some C99 features).
1847 @item gnu99
1848 @itemx gnu9x
1849 GNU dialect of ISO C99.  The name @samp{gnu9x} is deprecated.
1851 @item gnu11
1852 @itemx gnu1x
1853 GNU dialect of ISO C11.
1854 The name @samp{gnu1x} is deprecated.
1856 @item gnu17
1857 @itemx gnu18
1858 GNU dialect of ISO C17.  This is the default for C code.
1860 @item c++98
1861 @itemx c++03
1862 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1863 additional defect reports. Same as @option{-ansi} for C++ code.
1865 @item gnu++98
1866 @itemx gnu++03
1867 GNU dialect of @option{-std=c++98}.
1869 @item c++11
1870 @itemx c++0x
1871 The 2011 ISO C++ standard plus amendments.
1872 The name @samp{c++0x} is deprecated.
1874 @item gnu++11
1875 @itemx gnu++0x
1876 GNU dialect of @option{-std=c++11}.
1877 The name @samp{gnu++0x} is deprecated.
1879 @item c++14
1880 @itemx c++1y
1881 The 2014 ISO C++ standard plus amendments.
1882 The name @samp{c++1y} is deprecated.
1884 @item gnu++14
1885 @itemx gnu++1y
1886 GNU dialect of @option{-std=c++14}.
1887 This is the default for C++ code.
1888 The name @samp{gnu++1y} is deprecated.
1890 @item c++17
1891 @itemx c++1z
1892 The 2017 ISO C++ standard plus amendments.
1893 The name @samp{c++1z} is deprecated.
1895 @item gnu++17
1896 @itemx gnu++1z
1897 GNU dialect of @option{-std=c++17}.
1898 The name @samp{gnu++1z} is deprecated.
1900 @item c++2a
1901 The next revision of the ISO C++ standard, tentatively planned for
1902 2020.  Support is highly experimental, and will almost certainly
1903 change in incompatible ways in future releases.
1905 @item gnu++2a
1906 GNU dialect of @option{-std=c++2a}.  Support is highly experimental,
1907 and will almost certainly change in incompatible ways in future
1908 releases.
1909 @end table
1911 @item -fgnu89-inline
1912 @opindex fgnu89-inline
1913 The option @option{-fgnu89-inline} tells GCC to use the traditional
1914 GNU semantics for @code{inline} functions when in C99 mode.
1915 @xref{Inline,,An Inline Function is As Fast As a Macro}.
1916 Using this option is roughly equivalent to adding the
1917 @code{gnu_inline} function attribute to all inline functions
1918 (@pxref{Function Attributes}).
1920 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1921 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1922 specifies the default behavior).
1923 This option is not supported in @option{-std=c90} or
1924 @option{-std=gnu90} mode.
1926 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1927 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1928 in effect for @code{inline} functions.  @xref{Common Predefined
1929 Macros,,,cpp,The C Preprocessor}.
1931 @item -fpermitted-flt-eval-methods=@var{style}
1932 @opindex fpermitted-flt-eval-methods
1933 @opindex fpermitted-flt-eval-methods=c11
1934 @opindex fpermitted-flt-eval-methods=ts-18661-3
1935 ISO/IEC TS 18661-3 defines new permissible values for
1936 @code{FLT_EVAL_METHOD} that indicate that operations and constants with
1937 a semantic type that is an interchange or extended format should be
1938 evaluated to the precision and range of that type.  These new values are
1939 a superset of those permitted under C99/C11, which does not specify the
1940 meaning of other positive values of @code{FLT_EVAL_METHOD}.  As such, code
1941 conforming to C11 may not have been written expecting the possibility of
1942 the new values.
1944 @option{-fpermitted-flt-eval-methods} specifies whether the compiler
1945 should allow only the values of @code{FLT_EVAL_METHOD} specified in C99/C11,
1946 or the extended set of values specified in ISO/IEC TS 18661-3.
1948 @var{style} is either @code{c11} or @code{ts-18661-3} as appropriate.
1950 The default when in a standards compliant mode (@option{-std=c11} or similar)
1951 is @option{-fpermitted-flt-eval-methods=c11}.  The default when in a GNU
1952 dialect (@option{-std=gnu11} or similar) is
1953 @option{-fpermitted-flt-eval-methods=ts-18661-3}.
1955 @item -aux-info @var{filename}
1956 @opindex aux-info
1957 Output to the given filename prototyped declarations for all functions
1958 declared and/or defined in a translation unit, including those in header
1959 files.  This option is silently ignored in any language other than C@.
1961 Besides declarations, the file indicates, in comments, the origin of
1962 each declaration (source file and line), whether the declaration was
1963 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1964 @samp{O} for old, respectively, in the first character after the line
1965 number and the colon), and whether it came from a declaration or a
1966 definition (@samp{C} or @samp{F}, respectively, in the following
1967 character).  In the case of function definitions, a K&R-style list of
1968 arguments followed by their declarations is also provided, inside
1969 comments, after the declaration.
1971 @item -fallow-parameterless-variadic-functions
1972 @opindex fallow-parameterless-variadic-functions
1973 Accept variadic functions without named parameters.
1975 Although it is possible to define such a function, this is not very
1976 useful as it is not possible to read the arguments.  This is only
1977 supported for C as this construct is allowed by C++.
1979 @item -fno-asm
1980 @opindex fno-asm
1981 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1982 keyword, so that code can use these words as identifiers.  You can use
1983 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1984 instead.  @option{-ansi} implies @option{-fno-asm}.
1986 In C++, this switch only affects the @code{typeof} keyword, since
1987 @code{asm} and @code{inline} are standard keywords.  You may want to
1988 use the @option{-fno-gnu-keywords} flag instead, which has the same
1989 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1990 switch only affects the @code{asm} and @code{typeof} keywords, since
1991 @code{inline} is a standard keyword in ISO C99.
1993 @item -fno-builtin
1994 @itemx -fno-builtin-@var{function}
1995 @opindex fno-builtin
1996 @cindex built-in functions
1997 Don't recognize built-in functions that do not begin with
1998 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1999 functions provided by GCC}, for details of the functions affected,
2000 including those which are not built-in functions when @option{-ansi} or
2001 @option{-std} options for strict ISO C conformance are used because they
2002 do not have an ISO standard meaning.
2004 GCC normally generates special code to handle certain built-in functions
2005 more efficiently; for instance, calls to @code{alloca} may become single
2006 instructions which adjust the stack directly, and calls to @code{memcpy}
2007 may become inline copy loops.  The resulting code is often both smaller
2008 and faster, but since the function calls no longer appear as such, you
2009 cannot set a breakpoint on those calls, nor can you change the behavior
2010 of the functions by linking with a different library.  In addition,
2011 when a function is recognized as a built-in function, GCC may use
2012 information about that function to warn about problems with calls to
2013 that function, or to generate more efficient code, even if the
2014 resulting code still contains calls to that function.  For example,
2015 warnings are given with @option{-Wformat} for bad calls to
2016 @code{printf} when @code{printf} is built in and @code{strlen} is
2017 known not to modify global memory.
2019 With the @option{-fno-builtin-@var{function}} option
2020 only the built-in function @var{function} is
2021 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
2022 function is named that is not built-in in this version of GCC, this
2023 option is ignored.  There is no corresponding
2024 @option{-fbuiltin-@var{function}} option; if you wish to enable
2025 built-in functions selectively when using @option{-fno-builtin} or
2026 @option{-ffreestanding}, you may define macros such as:
2028 @smallexample
2029 #define abs(n)          __builtin_abs ((n))
2030 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
2031 @end smallexample
2033 @item -fgimple
2034 @opindex fgimple
2036 Enable parsing of function definitions marked with @code{__GIMPLE}.
2037 This is an experimental feature that allows unit testing of GIMPLE
2038 passes.
2040 @item -fhosted
2041 @opindex fhosted
2042 @cindex hosted environment
2044 Assert that compilation targets a hosted environment.  This implies
2045 @option{-fbuiltin}.  A hosted environment is one in which the
2046 entire standard library is available, and in which @code{main} has a return
2047 type of @code{int}.  Examples are nearly everything except a kernel.
2048 This is equivalent to @option{-fno-freestanding}.
2050 @item -ffreestanding
2051 @opindex ffreestanding
2052 @cindex hosted environment
2054 Assert that compilation targets a freestanding environment.  This
2055 implies @option{-fno-builtin}.  A freestanding environment
2056 is one in which the standard library may not exist, and program startup may
2057 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
2058 This is equivalent to @option{-fno-hosted}.
2060 @xref{Standards,,Language Standards Supported by GCC}, for details of
2061 freestanding and hosted environments.
2063 @item -fopenacc
2064 @opindex fopenacc
2065 @cindex OpenACC accelerator programming
2066 Enable handling of OpenACC directives @code{#pragma acc} in C/C++ and
2067 @code{!$acc} in Fortran.  When @option{-fopenacc} is specified, the
2068 compiler generates accelerated code according to the OpenACC Application
2069 Programming Interface v2.0 @w{@uref{https://www.openacc.org}}.  This option
2070 implies @option{-pthread}, and thus is only supported on targets that
2071 have support for @option{-pthread}.
2073 @item -fopenacc-dim=@var{geom}
2074 @opindex fopenacc-dim
2075 @cindex OpenACC accelerator programming
2076 Specify default compute dimensions for parallel offload regions that do
2077 not explicitly specify.  The @var{geom} value is a triple of
2078 ':'-separated sizes, in order 'gang', 'worker' and, 'vector'.  A size
2079 can be omitted, to use a target-specific default value.
2081 @item -fopenmp
2082 @opindex fopenmp
2083 @cindex OpenMP parallel
2084 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
2085 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
2086 compiler generates parallel code according to the OpenMP Application
2087 Program Interface v4.5 @w{@uref{http://www.openmp.org/}}.  This option
2088 implies @option{-pthread}, and thus is only supported on targets that
2089 have support for @option{-pthread}. @option{-fopenmp} implies
2090 @option{-fopenmp-simd}.
2092 @item -fopenmp-simd
2093 @opindex fopenmp-simd
2094 @cindex OpenMP SIMD
2095 @cindex SIMD
2096 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
2097 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
2098 are ignored.
2100 @item -fgnu-tm
2101 @opindex fgnu-tm
2102 When the option @option{-fgnu-tm} is specified, the compiler
2103 generates code for the Linux variant of Intel's current Transactional
2104 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
2105 an experimental feature whose interface may change in future versions
2106 of GCC, as the official specification changes.  Please note that not
2107 all architectures are supported for this feature.
2109 For more information on GCC's support for transactional memory,
2110 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
2111 Transactional Memory Library}.
2113 Note that the transactional memory feature is not supported with
2114 non-call exceptions (@option{-fnon-call-exceptions}).
2116 @item -fms-extensions
2117 @opindex fms-extensions
2118 Accept some non-standard constructs used in Microsoft header files.
2120 In C++ code, this allows member names in structures to be similar
2121 to previous types declarations.
2123 @smallexample
2124 typedef int UOW;
2125 struct ABC @{
2126   UOW UOW;
2128 @end smallexample
2130 Some cases of unnamed fields in structures and unions are only
2131 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
2132 fields within structs/unions}, for details.
2134 Note that this option is off for all targets but x86 
2135 targets using ms-abi.
2137 @item -fplan9-extensions
2138 @opindex fplan9-extensions
2139 Accept some non-standard constructs used in Plan 9 code.
2141 This enables @option{-fms-extensions}, permits passing pointers to
2142 structures with anonymous fields to functions that expect pointers to
2143 elements of the type of the field, and permits referring to anonymous
2144 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
2145 struct/union fields within structs/unions}, for details.  This is only
2146 supported for C, not C++.
2148 @item -fcond-mismatch
2149 @opindex fcond-mismatch
2150 Allow conditional expressions with mismatched types in the second and
2151 third arguments.  The value of such an expression is void.  This option
2152 is not supported for C++.
2154 @item -flax-vector-conversions
2155 @opindex flax-vector-conversions
2156 Allow implicit conversions between vectors with differing numbers of
2157 elements and/or incompatible element types.  This option should not be
2158 used for new code.
2160 @item -funsigned-char
2161 @opindex funsigned-char
2162 Let the type @code{char} be unsigned, like @code{unsigned char}.
2164 Each kind of machine has a default for what @code{char} should
2165 be.  It is either like @code{unsigned char} by default or like
2166 @code{signed char} by default.
2168 Ideally, a portable program should always use @code{signed char} or
2169 @code{unsigned char} when it depends on the signedness of an object.
2170 But many programs have been written to use plain @code{char} and
2171 expect it to be signed, or expect it to be unsigned, depending on the
2172 machines they were written for.  This option, and its inverse, let you
2173 make such a program work with the opposite default.
2175 The type @code{char} is always a distinct type from each of
2176 @code{signed char} or @code{unsigned char}, even though its behavior
2177 is always just like one of those two.
2179 @item -fsigned-char
2180 @opindex fsigned-char
2181 Let the type @code{char} be signed, like @code{signed char}.
2183 Note that this is equivalent to @option{-fno-unsigned-char}, which is
2184 the negative form of @option{-funsigned-char}.  Likewise, the option
2185 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
2187 @item -fsigned-bitfields
2188 @itemx -funsigned-bitfields
2189 @itemx -fno-signed-bitfields
2190 @itemx -fno-unsigned-bitfields
2191 @opindex fsigned-bitfields
2192 @opindex funsigned-bitfields
2193 @opindex fno-signed-bitfields
2194 @opindex fno-unsigned-bitfields
2195 These options control whether a bit-field is signed or unsigned, when the
2196 declaration does not use either @code{signed} or @code{unsigned}.  By
2197 default, such a bit-field is signed, because this is consistent: the
2198 basic integer types such as @code{int} are signed types.
2200 @item -fsso-struct=@var{endianness}
2201 @opindex fsso-struct
2202 Set the default scalar storage order of structures and unions to the
2203 specified endianness.  The accepted values are @samp{big-endian},
2204 @samp{little-endian} and @samp{native} for the native endianness of
2205 the target (the default).  This option is not supported for C++.
2207 @strong{Warning:} the @option{-fsso-struct} switch causes GCC to generate
2208 code that is not binary compatible with code generated without it if the
2209 specified endianness is not the native endianness of the target.
2210 @end table
2212 @node C++ Dialect Options
2213 @section Options Controlling C++ Dialect
2215 @cindex compiler options, C++
2216 @cindex C++ options, command-line
2217 @cindex options, C++
2218 This section describes the command-line options that are only meaningful
2219 for C++ programs.  You can also use most of the GNU compiler options
2220 regardless of what language your program is in.  For example, you
2221 might compile a file @file{firstClass.C} like this:
2223 @smallexample
2224 g++ -g -fstrict-enums -O -c firstClass.C
2225 @end smallexample
2227 @noindent
2228 In this example, only @option{-fstrict-enums} is an option meant
2229 only for C++ programs; you can use the other options with any
2230 language supported by GCC@.
2232 Some options for compiling C programs, such as @option{-std}, are also
2233 relevant for C++ programs.
2234 @xref{C Dialect Options,,Options Controlling C Dialect}.
2236 Here is a list of options that are @emph{only} for compiling C++ programs:
2238 @table @gcctabopt
2240 @item -fabi-version=@var{n}
2241 @opindex fabi-version
2242 Use version @var{n} of the C++ ABI@.  The default is version 0.
2244 Version 0 refers to the version conforming most closely to
2245 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2246 will change in different versions of G++ as ABI bugs are fixed.
2248 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.
2250 Version 2 is the version of the C++ ABI that first appeared in G++
2251 3.4, and was the default through G++ 4.9.
2253 Version 3 corrects an error in mangling a constant address as a
2254 template argument.
2256 Version 4, which first appeared in G++ 4.5, implements a standard
2257 mangling for vector types.
2259 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2260 attribute const/volatile on function pointer types, decltype of a
2261 plain decl, and use of a function parameter in the declaration of
2262 another parameter.
2264 Version 6, which first appeared in G++ 4.7, corrects the promotion
2265 behavior of C++11 scoped enums and the mangling of template argument
2266 packs, const/static_cast, prefix ++ and --, and a class scope function
2267 used as a template argument.
2269 Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a
2270 builtin type and corrects the mangling of lambdas in default argument
2271 scope.
2273 Version 8, which first appeared in G++ 4.9, corrects the substitution
2274 behavior of function types with function-cv-qualifiers.
2276 Version 9, which first appeared in G++ 5.2, corrects the alignment of
2277 @code{nullptr_t}.
2279 Version 10, which first appeared in G++ 6.1, adds mangling of
2280 attributes that affect type identity, such as ia32 calling convention
2281 attributes (e.g. @samp{stdcall}).
2283 Version 11, which first appeared in G++ 7, corrects the mangling of
2284 sizeof... expressions and operator names.  For multiple entities with
2285 the same name within a function, that are declared in different scopes,
2286 the mangling now changes starting with the twelfth occurrence.  It also
2287 implies @option{-fnew-inheriting-ctors}.
2289 See also @option{-Wabi}.
2291 @item -fabi-compat-version=@var{n}
2292 @opindex fabi-compat-version
2293 On targets that support strong aliases, G++
2294 works around mangling changes by creating an alias with the correct
2295 mangled name when defining a symbol with an incorrect mangled name.
2296 This switch specifies which ABI version to use for the alias.
2298 With @option{-fabi-version=0} (the default), this defaults to 8 (GCC 5
2299 compatibility).  If another ABI version is explicitly selected, this
2300 defaults to 0.  For compatibility with GCC versions 3.2 through 4.9,
2301 use @option{-fabi-compat-version=2}.
2303 If this option is not provided but @option{-Wabi=@var{n}} is, that
2304 version is used for compatibility aliases.  If this option is provided
2305 along with @option{-Wabi} (without the version), the version from this
2306 option is used for the warning.
2308 @item -fno-access-control
2309 @opindex fno-access-control
2310 Turn off all access checking.  This switch is mainly useful for working
2311 around bugs in the access control code.
2313 @item -faligned-new
2314 @opindex faligned-new
2315 Enable support for C++17 @code{new} of types that require more
2316 alignment than @code{void* ::operator new(std::size_t)} provides.  A
2317 numeric argument such as @code{-faligned-new=32} can be used to
2318 specify how much alignment (in bytes) is provided by that function,
2319 but few users will need to override the default of
2320 @code{alignof(std::max_align_t)}.
2322 This flag is enabled by default for @option{-std=c++17}.
2324 @item -fcheck-new
2325 @opindex fcheck-new
2326 Check that the pointer returned by @code{operator new} is non-null
2327 before attempting to modify the storage allocated.  This check is
2328 normally unnecessary because the C++ standard specifies that
2329 @code{operator new} only returns @code{0} if it is declared
2330 @code{throw()}, in which case the compiler always checks the
2331 return value even without this option.  In all other cases, when
2332 @code{operator new} has a non-empty exception specification, memory
2333 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2334 @samp{new (nothrow)}.
2336 @item -fconcepts
2337 @opindex fconcepts
2338 Enable support for the C++ Extensions for Concepts Technical
2339 Specification, ISO 19217 (2015), which allows code like
2341 @smallexample
2342 template <class T> concept bool Addable = requires (T t) @{ t + t; @};
2343 template <Addable T> T add (T a, T b) @{ return a + b; @}
2344 @end smallexample
2346 @item -fconstexpr-depth=@var{n}
2347 @opindex fconstexpr-depth
2348 Set the maximum nested evaluation depth for C++11 constexpr functions
2349 to @var{n}.  A limit is needed to detect endless recursion during
2350 constant expression evaluation.  The minimum specified by the standard
2351 is 512.
2353 @item -fconstexpr-loop-limit=@var{n}
2354 @opindex fconstexpr-loop-limit
2355 Set the maximum number of iterations for a loop in C++14 constexpr functions
2356 to @var{n}.  A limit is needed to detect infinite loops during
2357 constant expression evaluation.  The default is 262144 (1<<18).
2359 @item -fdeduce-init-list
2360 @opindex fdeduce-init-list
2361 Enable deduction of a template type parameter as
2362 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2364 @smallexample
2365 template <class T> auto forward(T t) -> decltype (realfn (t))
2367   return realfn (t);
2370 void f()
2372   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2374 @end smallexample
2376 This deduction was implemented as a possible extension to the
2377 originally proposed semantics for the C++11 standard, but was not part
2378 of the final standard, so it is disabled by default.  This option is
2379 deprecated, and may be removed in a future version of G++.
2381 @item -ffriend-injection
2382 @opindex ffriend-injection
2383 Inject friend functions into the enclosing namespace, so that they are
2384 visible outside the scope of the class in which they are declared.
2385 Friend functions were documented to work this way in the old Annotated
2386 C++ Reference Manual.  
2387 However, in ISO C++ a friend function that is not declared
2388 in an enclosing scope can only be found using argument dependent
2389 lookup.  GCC defaults to the standard behavior.
2391 This option is for compatibility, and may be removed in a future
2392 release of G++.
2394 @item -fno-elide-constructors
2395 @opindex fno-elide-constructors
2396 The C++ standard allows an implementation to omit creating a temporary
2397 that is only used to initialize another object of the same type.
2398 Specifying this option disables that optimization, and forces G++ to
2399 call the copy constructor in all cases.  This option also causes G++
2400 to call trivial member functions which otherwise would be expanded inline.
2402 In C++17, the compiler is required to omit these temporaries, but this
2403 option still affects trivial member functions.
2405 @item -fno-enforce-eh-specs
2406 @opindex fno-enforce-eh-specs
2407 Don't generate code to check for violation of exception specifications
2408 at run time.  This option violates the C++ standard, but may be useful
2409 for reducing code size in production builds, much like defining
2410 @code{NDEBUG}.  This does not give user code permission to throw
2411 exceptions in violation of the exception specifications; the compiler
2412 still optimizes based on the specifications, so throwing an
2413 unexpected exception results in undefined behavior at run time.
2415 @item -fextern-tls-init
2416 @itemx -fno-extern-tls-init
2417 @opindex fextern-tls-init
2418 @opindex fno-extern-tls-init
2419 The C++11 and OpenMP standards allow @code{thread_local} and
2420 @code{threadprivate} variables to have dynamic (runtime)
2421 initialization.  To support this, any use of such a variable goes
2422 through a wrapper function that performs any necessary initialization.
2423 When the use and definition of the variable are in the same
2424 translation unit, this overhead can be optimized away, but when the
2425 use is in a different translation unit there is significant overhead
2426 even if the variable doesn't actually need dynamic initialization.  If
2427 the programmer can be sure that no use of the variable in a
2428 non-defining TU needs to trigger dynamic initialization (either
2429 because the variable is statically initialized, or a use of the
2430 variable in the defining TU will be executed before any uses in
2431 another TU), they can avoid this overhead with the
2432 @option{-fno-extern-tls-init} option.
2434 On targets that support symbol aliases, the default is
2435 @option{-fextern-tls-init}.  On targets that do not support symbol
2436 aliases, the default is @option{-fno-extern-tls-init}.
2438 @item -ffor-scope
2439 @itemx -fno-for-scope
2440 @opindex ffor-scope
2441 @opindex fno-for-scope
2442 If @option{-ffor-scope} is specified, the scope of variables declared in
2443 a @i{for-init-statement} is limited to the @code{for} loop itself,
2444 as specified by the C++ standard.
2445 If @option{-fno-for-scope} is specified, the scope of variables declared in
2446 a @i{for-init-statement} extends to the end of the enclosing scope,
2447 as was the case in old versions of G++, and other (traditional)
2448 implementations of C++.
2450 If neither flag is given, the default is to follow the standard,
2451 but to allow and give a warning for old-style code that would
2452 otherwise be invalid, or have different behavior.
2454 @item -fno-gnu-keywords
2455 @opindex fno-gnu-keywords
2456 Do not recognize @code{typeof} as a keyword, so that code can use this
2457 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2458 This option is implied by the strict ISO C++ dialects: @option{-ansi},
2459 @option{-std=c++98}, @option{-std=c++11}, etc.
2461 @item -fno-implicit-templates
2462 @opindex fno-implicit-templates
2463 Never emit code for non-inline templates that are instantiated
2464 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2465 @xref{Template Instantiation}, for more information.
2467 @item -fno-implicit-inline-templates
2468 @opindex fno-implicit-inline-templates
2469 Don't emit code for implicit instantiations of inline templates, either.
2470 The default is to handle inlines differently so that compiles with and
2471 without optimization need the same set of explicit instantiations.
2473 @item -fno-implement-inlines
2474 @opindex fno-implement-inlines
2475 To save space, do not emit out-of-line copies of inline functions
2476 controlled by @code{#pragma implementation}.  This causes linker
2477 errors if these functions are not inlined everywhere they are called.
2479 @item -fms-extensions
2480 @opindex fms-extensions
2481 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2482 int and getting a pointer to member function via non-standard syntax.
2484 @item -fnew-inheriting-ctors
2485 @opindex fnew-inheriting-ctors
2486 Enable the P0136 adjustment to the semantics of C++11 constructor
2487 inheritance.  This is part of C++17 but also considered to be a Defect
2488 Report against C++11 and C++14.  This flag is enabled by default
2489 unless @option{-fabi-version=10} or lower is specified.
2491 @item -fnew-ttp-matching
2492 @opindex fnew-ttp-matching
2493 Enable the P0522 resolution to Core issue 150, template template
2494 parameters and default arguments: this allows a template with default
2495 template arguments as an argument for a template template parameter
2496 with fewer template parameters.  This flag is enabled by default for
2497 @option{-std=c++17}.
2499 @item -fno-nonansi-builtins
2500 @opindex fno-nonansi-builtins
2501 Disable built-in declarations of functions that are not mandated by
2502 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2503 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2505 @item -fnothrow-opt
2506 @opindex fnothrow-opt
2507 Treat a @code{throw()} exception specification as if it were a
2508 @code{noexcept} specification to reduce or eliminate the text size
2509 overhead relative to a function with no exception specification.  If
2510 the function has local variables of types with non-trivial
2511 destructors, the exception specification actually makes the
2512 function smaller because the EH cleanups for those variables can be
2513 optimized away.  The semantic effect is that an exception thrown out of
2514 a function with such an exception specification results in a call
2515 to @code{terminate} rather than @code{unexpected}.
2517 @item -fno-operator-names
2518 @opindex fno-operator-names
2519 Do not treat the operator name keywords @code{and}, @code{bitand},
2520 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2521 synonyms as keywords.
2523 @item -fno-optional-diags
2524 @opindex fno-optional-diags
2525 Disable diagnostics that the standard says a compiler does not need to
2526 issue.  Currently, the only such diagnostic issued by G++ is the one for
2527 a name having multiple meanings within a class.
2529 @item -fpermissive
2530 @opindex fpermissive
2531 Downgrade some diagnostics about nonconformant code from errors to
2532 warnings.  Thus, using @option{-fpermissive} allows some
2533 nonconforming code to compile.
2535 @item -fno-pretty-templates
2536 @opindex fno-pretty-templates
2537 When an error message refers to a specialization of a function
2538 template, the compiler normally prints the signature of the
2539 template followed by the template arguments and any typedefs or
2540 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2541 rather than @code{void f(int)}) so that it's clear which template is
2542 involved.  When an error message refers to a specialization of a class
2543 template, the compiler omits any template arguments that match
2544 the default template arguments for that template.  If either of these
2545 behaviors make it harder to understand the error message rather than
2546 easier, you can use @option{-fno-pretty-templates} to disable them.
2548 @item -frepo
2549 @opindex frepo
2550 Enable automatic template instantiation at link time.  This option also
2551 implies @option{-fno-implicit-templates}.  @xref{Template
2552 Instantiation}, for more information.
2554 @item -fno-rtti
2555 @opindex fno-rtti
2556 Disable generation of information about every class with virtual
2557 functions for use by the C++ run-time type identification features
2558 (@code{dynamic_cast} and @code{typeid}).  If you don't use those parts
2559 of the language, you can save some space by using this flag.  Note that
2560 exception handling uses the same information, but G++ generates it as
2561 needed. The @code{dynamic_cast} operator can still be used for casts that
2562 do not require run-time type information, i.e.@: casts to @code{void *} or to
2563 unambiguous base classes.
2565 @item -fsized-deallocation
2566 @opindex fsized-deallocation
2567 Enable the built-in global declarations
2568 @smallexample
2569 void operator delete (void *, std::size_t) noexcept;
2570 void operator delete[] (void *, std::size_t) noexcept;
2571 @end smallexample
2572 as introduced in C++14.  This is useful for user-defined replacement
2573 deallocation functions that, for example, use the size of the object
2574 to make deallocation faster.  Enabled by default under
2575 @option{-std=c++14} and above.  The flag @option{-Wsized-deallocation}
2576 warns about places that might want to add a definition.
2578 @item -fstrict-enums
2579 @opindex fstrict-enums
2580 Allow the compiler to optimize using the assumption that a value of
2581 enumerated type can only be one of the values of the enumeration (as
2582 defined in the C++ standard; basically, a value that can be
2583 represented in the minimum number of bits needed to represent all the
2584 enumerators).  This assumption may not be valid if the program uses a
2585 cast to convert an arbitrary integer value to the enumerated type.
2587 @item -fstrong-eval-order
2588 @opindex fstrong-eval-order
2589 Evaluate member access, array subscripting, and shift expressions in
2590 left-to-right order, and evaluate assignment in right-to-left order,
2591 as adopted for C++17.  Enabled by default with @option{-std=c++17}.
2592 @option{-fstrong-eval-order=some} enables just the ordering of member
2593 access and shift expressions, and is the default without
2594 @option{-std=c++17}.
2596 @item -ftemplate-backtrace-limit=@var{n}
2597 @opindex ftemplate-backtrace-limit
2598 Set the maximum number of template instantiation notes for a single
2599 warning or error to @var{n}.  The default value is 10.
2601 @item -ftemplate-depth=@var{n}
2602 @opindex ftemplate-depth
2603 Set the maximum instantiation depth for template classes to @var{n}.
2604 A limit on the template instantiation depth is needed to detect
2605 endless recursions during template class instantiation.  ANSI/ISO C++
2606 conforming programs must not rely on a maximum depth greater than 17
2607 (changed to 1024 in C++11).  The default value is 900, as the compiler
2608 can run out of stack space before hitting 1024 in some situations.
2610 @item -fno-threadsafe-statics
2611 @opindex fno-threadsafe-statics
2612 Do not emit the extra code to use the routines specified in the C++
2613 ABI for thread-safe initialization of local statics.  You can use this
2614 option to reduce code size slightly in code that doesn't need to be
2615 thread-safe.
2617 @item -fuse-cxa-atexit
2618 @opindex fuse-cxa-atexit
2619 Register destructors for objects with static storage duration with the
2620 @code{__cxa_atexit} function rather than the @code{atexit} function.
2621 This option is required for fully standards-compliant handling of static
2622 destructors, but only works if your C library supports
2623 @code{__cxa_atexit}.
2625 @item -fno-use-cxa-get-exception-ptr
2626 @opindex fno-use-cxa-get-exception-ptr
2627 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2628 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2629 if the runtime routine is not available.
2631 @item -fvisibility-inlines-hidden
2632 @opindex fvisibility-inlines-hidden
2633 This switch declares that the user does not attempt to compare
2634 pointers to inline functions or methods where the addresses of the two functions
2635 are taken in different shared objects.
2637 The effect of this is that GCC may, effectively, mark inline methods with
2638 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2639 appear in the export table of a DSO and do not require a PLT indirection
2640 when used within the DSO@.  Enabling this option can have a dramatic effect
2641 on load and link times of a DSO as it massively reduces the size of the
2642 dynamic export table when the library makes heavy use of templates.
2644 The behavior of this switch is not quite the same as marking the
2645 methods as hidden directly, because it does not affect static variables
2646 local to the function or cause the compiler to deduce that
2647 the function is defined in only one shared object.
2649 You may mark a method as having a visibility explicitly to negate the
2650 effect of the switch for that method.  For example, if you do want to
2651 compare pointers to a particular inline method, you might mark it as
2652 having default visibility.  Marking the enclosing class with explicit
2653 visibility has no effect.
2655 Explicitly instantiated inline methods are unaffected by this option
2656 as their linkage might otherwise cross a shared library boundary.
2657 @xref{Template Instantiation}.
2659 @item -fvisibility-ms-compat
2660 @opindex fvisibility-ms-compat
2661 This flag attempts to use visibility settings to make GCC's C++
2662 linkage model compatible with that of Microsoft Visual Studio.
2664 The flag makes these changes to GCC's linkage model:
2666 @enumerate
2667 @item
2668 It sets the default visibility to @code{hidden}, like
2669 @option{-fvisibility=hidden}.
2671 @item
2672 Types, but not their members, are not hidden by default.
2674 @item
2675 The One Definition Rule is relaxed for types without explicit
2676 visibility specifications that are defined in more than one
2677 shared object: those declarations are permitted if they are
2678 permitted when this option is not used.
2679 @end enumerate
2681 In new code it is better to use @option{-fvisibility=hidden} and
2682 export those classes that are intended to be externally visible.
2683 Unfortunately it is possible for code to rely, perhaps accidentally,
2684 on the Visual Studio behavior.
2686 Among the consequences of these changes are that static data members
2687 of the same type with the same name but defined in different shared
2688 objects are different, so changing one does not change the other;
2689 and that pointers to function members defined in different shared
2690 objects may not compare equal.  When this flag is given, it is a
2691 violation of the ODR to define types with the same name differently.
2693 @item -fno-weak
2694 @opindex fno-weak
2695 Do not use weak symbol support, even if it is provided by the linker.
2696 By default, G++ uses weak symbols if they are available.  This
2697 option exists only for testing, and should not be used by end-users;
2698 it results in inferior code and has no benefits.  This option may
2699 be removed in a future release of G++.
2701 @item -nostdinc++
2702 @opindex nostdinc++
2703 Do not search for header files in the standard directories specific to
2704 C++, but do still search the other standard directories.  (This option
2705 is used when building the C++ library.)
2706 @end table
2708 In addition, these optimization, warning, and code generation options
2709 have meanings only for C++ programs:
2711 @table @gcctabopt
2712 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2713 @opindex Wabi
2714 @opindex Wno-abi
2715 Warn when G++ it generates code that is probably not compatible with
2716 the vendor-neutral C++ ABI@.  Since G++ now defaults to updating the
2717 ABI with each major release, normally @option{-Wabi} will warn only if
2718 there is a check added later in a release series for an ABI issue
2719 discovered since the initial release.  @option{-Wabi} will warn about
2720 more things if an older ABI version is selected (with
2721 @option{-fabi-version=@var{n}}).
2723 @option{-Wabi} can also be used with an explicit version number to
2724 warn about compatibility with a particular @option{-fabi-version}
2725 level, e.g. @option{-Wabi=2} to warn about changes relative to
2726 @option{-fabi-version=2}.
2728 If an explicit version number is provided and
2729 @option{-fabi-compat-version} is not specified, the version number
2730 from this option is used for compatibility aliases.  If no explicit
2731 version number is provided with this option, but
2732 @option{-fabi-compat-version} is specified, that version number is
2733 used for ABI warnings.
2735 Although an effort has been made to warn about
2736 all such cases, there are probably some cases that are not warned about,
2737 even though G++ is generating incompatible code.  There may also be
2738 cases where warnings are emitted even though the code that is generated
2739 is compatible.
2741 You should rewrite your code to avoid these warnings if you are
2742 concerned about the fact that code generated by G++ may not be binary
2743 compatible with code generated by other compilers.
2745 Known incompatibilities in @option{-fabi-version=2} (which was the
2746 default from GCC 3.4 to 4.9) include:
2748 @itemize @bullet
2750 @item
2751 A template with a non-type template parameter of reference type was
2752 mangled incorrectly:
2753 @smallexample
2754 extern int N;
2755 template <int &> struct S @{@};
2756 void n (S<N>) @{2@}
2757 @end smallexample
2759 This was fixed in @option{-fabi-version=3}.
2761 @item
2762 SIMD vector types declared using @code{__attribute ((vector_size))} were
2763 mangled in a non-standard way that does not allow for overloading of
2764 functions taking vectors of different sizes.
2766 The mangling was changed in @option{-fabi-version=4}.
2768 @item
2769 @code{__attribute ((const))} and @code{noreturn} were mangled as type
2770 qualifiers, and @code{decltype} of a plain declaration was folded away.
2772 These mangling issues were fixed in @option{-fabi-version=5}.
2774 @item
2775 Scoped enumerators passed as arguments to a variadic function are
2776 promoted like unscoped enumerators, causing @code{va_arg} to complain.
2777 On most targets this does not actually affect the parameter passing
2778 ABI, as there is no way to pass an argument smaller than @code{int}.
2780 Also, the ABI changed the mangling of template argument packs,
2781 @code{const_cast}, @code{static_cast}, prefix increment/decrement, and
2782 a class scope function used as a template argument.
2784 These issues were corrected in @option{-fabi-version=6}.
2786 @item
2787 Lambdas in default argument scope were mangled incorrectly, and the
2788 ABI changed the mangling of @code{nullptr_t}.
2790 These issues were corrected in @option{-fabi-version=7}.
2792 @item
2793 When mangling a function type with function-cv-qualifiers, the
2794 un-qualified function type was incorrectly treated as a substitution
2795 candidate.
2797 This was fixed in @option{-fabi-version=8}, the default for GCC 5.1.
2799 @item
2800 @code{decltype(nullptr)} incorrectly had an alignment of 1, leading to
2801 unaligned accesses.  Note that this did not affect the ABI of a
2802 function with a @code{nullptr_t} parameter, as parameters have a
2803 minimum alignment.
2805 This was fixed in @option{-fabi-version=9}, the default for GCC 5.2.
2807 @item
2808 Target-specific attributes that affect the identity of a type, such as
2809 ia32 calling conventions on a function type (stdcall, regparm, etc.),
2810 did not affect the mangled name, leading to name collisions when
2811 function pointers were used as template arguments.
2813 This was fixed in @option{-fabi-version=10}, the default for GCC 6.1.
2815 @end itemize
2817 It also warns about psABI-related changes.  The known psABI changes at this
2818 point include:
2820 @itemize @bullet
2822 @item
2823 For SysV/x86-64, unions with @code{long double} members are 
2824 passed in memory as specified in psABI.  For example:
2826 @smallexample
2827 union U @{
2828   long double ld;
2829   int i;
2831 @end smallexample
2833 @noindent
2834 @code{union U} is always passed in memory.
2836 @end itemize
2838 @item -Wabi-tag @r{(C++ and Objective-C++ only)}
2839 @opindex Wabi-tag
2840 @opindex -Wabi-tag
2841 Warn when a type with an ABI tag is used in a context that does not
2842 have that ABI tag.  See @ref{C++ Attributes} for more information
2843 about ABI tags.
2845 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2846 @opindex Wctor-dtor-privacy
2847 @opindex Wno-ctor-dtor-privacy
2848 Warn when a class seems unusable because all the constructors or
2849 destructors in that class are private, and it has neither friends nor
2850 public static member functions.  Also warn if there are no non-private
2851 methods, and there's at least one private member function that isn't
2852 a constructor or destructor.
2854 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2855 @opindex Wdelete-non-virtual-dtor
2856 @opindex Wno-delete-non-virtual-dtor
2857 Warn when @code{delete} is used to destroy an instance of a class that
2858 has virtual functions and non-virtual destructor. It is unsafe to delete
2859 an instance of a derived class through a pointer to a base class if the
2860 base class does not have a virtual destructor.  This warning is enabled
2861 by @option{-Wall}.
2863 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2864 @opindex Wliteral-suffix
2865 @opindex Wno-literal-suffix
2866 Warn when a string or character literal is followed by a ud-suffix which does
2867 not begin with an underscore.  As a conforming extension, GCC treats such
2868 suffixes as separate preprocessing tokens in order to maintain backwards
2869 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2870 For example:
2872 @smallexample
2873 #define __STDC_FORMAT_MACROS
2874 #include <inttypes.h>
2875 #include <stdio.h>
2877 int main() @{
2878   int64_t i64 = 123;
2879   printf("My int64: %" PRId64"\n", i64);
2881 @end smallexample
2883 In this case, @code{PRId64} is treated as a separate preprocessing token.
2885 Additionally, warn when a user-defined literal operator is declared with
2886 a literal suffix identifier that doesn't begin with an underscore. Literal
2887 suffix identifiers that don't begin with an underscore are reserved for
2888 future standardization.
2890 This warning is enabled by default.
2892 @item -Wlto-type-mismatch
2893 @opindex Wlto-type-mismatch
2894 @opindex Wno-lto-type-mismatch
2896 During the link-time optimization warn about type mismatches in
2897 global declarations from different compilation units.
2898 Requires @option{-flto} to be enabled.  Enabled by default.
2900 @item -Wno-narrowing @r{(C++ and Objective-C++ only)}
2901 @opindex Wnarrowing
2902 @opindex Wno-narrowing
2903 For C++11 and later standards, narrowing conversions are diagnosed by default,
2904 as required by the standard.  A narrowing conversion from a constant produces
2905 an error, and a narrowing conversion from a non-constant produces a warning,
2906 but @option{-Wno-narrowing} suppresses the diagnostic.
2907 Note that this does not affect the meaning of well-formed code;
2908 narrowing conversions are still considered ill-formed in SFINAE contexts.
2910 With @option{-Wnarrowing} in C++98, warn when a narrowing
2911 conversion prohibited by C++11 occurs within
2912 @samp{@{ @}}, e.g.
2914 @smallexample
2915 int i = @{ 2.2 @}; // error: narrowing from double to int
2916 @end smallexample
2918 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2920 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2921 @opindex Wnoexcept
2922 @opindex Wno-noexcept
2923 Warn when a noexcept-expression evaluates to false because of a call
2924 to a function that does not have a non-throwing exception
2925 specification (i.e. @code{throw()} or @code{noexcept}) but is known by
2926 the compiler to never throw an exception.
2928 @item -Wnoexcept-type @r{(C++ and Objective-C++ only)}
2929 @opindex Wnoexcept-type
2930 @opindex Wno-noexcept-type
2931 Warn if the C++17 feature making @code{noexcept} part of a function
2932 type changes the mangled name of a symbol relative to C++14.  Enabled
2933 by @option{-Wabi} and @option{-Wc++17-compat}.
2935 @smallexample
2936 template <class T> void f(T t) @{ t(); @};
2937 void g() noexcept;
2938 void h() @{ f(g); @} // in C++14 calls f<void(*)()>, in C++17 calls f<void(*)()noexcept>
2939 @end smallexample
2941 @item -Wclass-memaccess @r{(C++ and Objective-C++ only)}
2942 @opindex Wclass-memaccess
2943 Warn when the destination of a call to a raw memory function such as
2944 @code{memset} or @code{memcpy} is an object of class type writing into which
2945 might bypass the class non-trivial or deleted constructor or copy assignment,
2946 violate const-correctness or encapsulation, or corrupt the virtual table.
2947 Modifying the representation of such objects may violate invariants maintained
2948 by member functions of the class.  For example, the call to @code{memset}
2949 below is undefined becase it modifies a non-trivial class object and is,
2950 therefore, diagnosed.  The safe way to either initialize or clear the storage
2951 of objects of such types is by using the appropriate constructor or assignment
2952 operator, if one is available.
2953 @smallexample
2954 std::string str = "abc";
2955 memset (&str, 0, 3);
2956 @end smallexample
2957 The @option{-Wclass-memaccess} option is enabled by @option{-Wall}.
2959 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2960 @opindex Wnon-virtual-dtor
2961 @opindex Wno-non-virtual-dtor
2962 Warn when a class has virtual functions and an accessible non-virtual
2963 destructor itself or in an accessible polymorphic base class, in which
2964 case it is possible but unsafe to delete an instance of a derived
2965 class through a pointer to the class itself or base class.  This
2966 warning is automatically enabled if @option{-Weffc++} is specified.
2968 @item -Wregister @r{(C++ and Objective-C++ only)}
2969 @opindex Wregister
2970 @opindex Wno-register
2971 Warn on uses of the @code{register} storage class specifier, except
2972 when it is part of the GNU @ref{Explicit Register Variables} extension.
2973 The use of the @code{register} keyword as storage class specifier has
2974 been deprecated in C++11 and removed in C++17.
2975 Enabled by default with @option{-std=c++17}.
2977 @item -Wreorder @r{(C++ and Objective-C++ only)}
2978 @opindex Wreorder
2979 @opindex Wno-reorder
2980 @cindex reordering, warning
2981 @cindex warning for reordering of member initializers
2982 Warn when the order of member initializers given in the code does not
2983 match the order in which they must be executed.  For instance:
2985 @smallexample
2986 struct A @{
2987   int i;
2988   int j;
2989   A(): j (0), i (1) @{ @}
2991 @end smallexample
2993 @noindent
2994 The compiler rearranges the member initializers for @code{i}
2995 and @code{j} to match the declaration order of the members, emitting
2996 a warning to that effect.  This warning is enabled by @option{-Wall}.
2998 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
2999 @opindex fext-numeric-literals
3000 @opindex fno-ext-numeric-literals
3001 Accept imaginary, fixed-point, or machine-defined
3002 literal number suffixes as GNU extensions.
3003 When this option is turned off these suffixes are treated
3004 as C++11 user-defined literal numeric suffixes.
3005 This is on by default for all pre-C++11 dialects and all GNU dialects:
3006 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
3007 @option{-std=gnu++14}.
3008 This option is off by default
3009 for ISO C++11 onwards (@option{-std=c++11}, ...).
3010 @end table
3012 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
3014 @table @gcctabopt
3015 @item -Weffc++ @r{(C++ and Objective-C++ only)}
3016 @opindex Weffc++
3017 @opindex Wno-effc++
3018 Warn about violations of the following style guidelines from Scott Meyers'
3019 @cite{Effective C++} series of books:
3021 @itemize @bullet
3022 @item
3023 Define a copy constructor and an assignment operator for classes
3024 with dynamically-allocated memory.
3026 @item
3027 Prefer initialization to assignment in constructors.
3029 @item
3030 Have @code{operator=} return a reference to @code{*this}.
3032 @item
3033 Don't try to return a reference when you must return an object.
3035 @item
3036 Distinguish between prefix and postfix forms of increment and
3037 decrement operators.
3039 @item
3040 Never overload @code{&&}, @code{||}, or @code{,}.
3042 @end itemize
3044 This option also enables @option{-Wnon-virtual-dtor}, which is also
3045 one of the effective C++ recommendations.  However, the check is
3046 extended to warn about the lack of virtual destructor in accessible
3047 non-polymorphic bases classes too.
3049 When selecting this option, be aware that the standard library
3050 headers do not obey all of these guidelines; use @samp{grep -v}
3051 to filter out those warnings.
3053 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
3054 @opindex Wstrict-null-sentinel
3055 @opindex Wno-strict-null-sentinel
3056 Warn about the use of an uncasted @code{NULL} as sentinel.  When
3057 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
3058 to @code{__null}.  Although it is a null pointer constant rather than a
3059 null pointer, it is guaranteed to be of the same size as a pointer.
3060 But this use is not portable across different compilers.
3062 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
3063 @opindex Wno-non-template-friend
3064 @opindex Wnon-template-friend
3065 Disable warnings when non-template friend functions are declared
3066 within a template.  In very old versions of GCC that predate implementation
3067 of the ISO standard, declarations such as 
3068 @samp{friend int foo(int)}, where the name of the friend is an unqualified-id,
3069 could be interpreted as a particular specialization of a template
3070 function; the warning exists to diagnose compatibility problems, 
3071 and is enabled by default.
3073 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
3074 @opindex Wold-style-cast
3075 @opindex Wno-old-style-cast
3076 Warn if an old-style (C-style) cast to a non-void type is used within
3077 a C++ program.  The new-style casts (@code{dynamic_cast},
3078 @code{static_cast}, @code{reinterpret_cast}, and @code{const_cast}) are
3079 less vulnerable to unintended effects and much easier to search for.
3081 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
3082 @opindex Woverloaded-virtual
3083 @opindex Wno-overloaded-virtual
3084 @cindex overloaded virtual function, warning
3085 @cindex warning for overloaded virtual function
3086 Warn when a function declaration hides virtual functions from a
3087 base class.  For example, in:
3089 @smallexample
3090 struct A @{
3091   virtual void f();
3094 struct B: public A @{
3095   void f(int);
3097 @end smallexample
3099 the @code{A} class version of @code{f} is hidden in @code{B}, and code
3100 like:
3102 @smallexample
3103 B* b;
3104 b->f();
3105 @end smallexample
3107 @noindent
3108 fails to compile.
3110 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
3111 @opindex Wno-pmf-conversions
3112 @opindex Wpmf-conversions
3113 Disable the diagnostic for converting a bound pointer to member function
3114 to a plain pointer.
3116 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
3117 @opindex Wsign-promo
3118 @opindex Wno-sign-promo
3119 Warn when overload resolution chooses a promotion from unsigned or
3120 enumerated type to a signed type, over a conversion to an unsigned type of
3121 the same size.  Previous versions of G++ tried to preserve
3122 unsignedness, but the standard mandates the current behavior.
3124 @item -Wtemplates @r{(C++ and Objective-C++ only)}
3125 @opindex Wtemplates
3126 Warn when a primary template declaration is encountered.  Some coding
3127 rules disallow templates, and this may be used to enforce that rule.
3128 The warning is inactive inside a system header file, such as the STL, so
3129 one can still use the STL.  One may also instantiate or specialize
3130 templates.
3132 @item -Wmultiple-inheritance @r{(C++ and Objective-C++ only)}
3133 @opindex Wmultiple-inheritance
3134 Warn when a class is defined with multiple direct base classes.  Some
3135 coding rules disallow multiple inheritance, and this may be used to
3136 enforce that rule.  The warning is inactive inside a system header file,
3137 such as the STL, so one can still use the STL.  One may also define
3138 classes that indirectly use multiple inheritance.
3140 @item -Wvirtual-inheritance
3141 @opindex Wvirtual-inheritance
3142 Warn when a class is defined with a virtual direct base class.  Some
3143 coding rules disallow multiple inheritance, and this may be used to
3144 enforce that rule.  The warning is inactive inside a system header file,
3145 such as the STL, so one can still use the STL.  One may also define
3146 classes that indirectly use virtual inheritance.
3148 @item -Wnamespaces
3149 @opindex Wnamespaces
3150 Warn when a namespace definition is opened.  Some coding rules disallow
3151 namespaces, and this may be used to enforce that rule.  The warning is
3152 inactive inside a system header file, such as the STL, so one can still
3153 use the STL.  One may also use using directives and qualified names.
3155 @item -Wno-terminate @r{(C++ and Objective-C++ only)}
3156 @opindex Wterminate
3157 @opindex Wno-terminate
3158 Disable the warning about a throw-expression that will immediately
3159 result in a call to @code{terminate}.
3160 @end table
3162 @node Objective-C and Objective-C++ Dialect Options
3163 @section Options Controlling Objective-C and Objective-C++ Dialects
3165 @cindex compiler options, Objective-C and Objective-C++
3166 @cindex Objective-C and Objective-C++ options, command-line
3167 @cindex options, Objective-C and Objective-C++
3168 (NOTE: This manual does not describe the Objective-C and Objective-C++
3169 languages themselves.  @xref{Standards,,Language Standards
3170 Supported by GCC}, for references.)
3172 This section describes the command-line options that are only meaningful
3173 for Objective-C and Objective-C++ programs.  You can also use most of
3174 the language-independent GNU compiler options.
3175 For example, you might compile a file @file{some_class.m} like this:
3177 @smallexample
3178 gcc -g -fgnu-runtime -O -c some_class.m
3179 @end smallexample
3181 @noindent
3182 In this example, @option{-fgnu-runtime} is an option meant only for
3183 Objective-C and Objective-C++ programs; you can use the other options with
3184 any language supported by GCC@.
3186 Note that since Objective-C is an extension of the C language, Objective-C
3187 compilations may also use options specific to the C front-end (e.g.,
3188 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
3189 C++-specific options (e.g., @option{-Wabi}).
3191 Here is a list of options that are @emph{only} for compiling Objective-C
3192 and Objective-C++ programs:
3194 @table @gcctabopt
3195 @item -fconstant-string-class=@var{class-name}
3196 @opindex fconstant-string-class
3197 Use @var{class-name} as the name of the class to instantiate for each
3198 literal string specified with the syntax @code{@@"@dots{}"}.  The default
3199 class name is @code{NXConstantString} if the GNU runtime is being used, and
3200 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
3201 @option{-fconstant-cfstrings} option, if also present, overrides the
3202 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
3203 to be laid out as constant CoreFoundation strings.
3205 @item -fgnu-runtime
3206 @opindex fgnu-runtime
3207 Generate object code compatible with the standard GNU Objective-C
3208 runtime.  This is the default for most types of systems.
3210 @item -fnext-runtime
3211 @opindex fnext-runtime
3212 Generate output compatible with the NeXT runtime.  This is the default
3213 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
3214 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
3215 used.
3217 @item -fno-nil-receivers
3218 @opindex fno-nil-receivers
3219 Assume that all Objective-C message dispatches (@code{[receiver
3220 message:arg]}) in this translation unit ensure that the receiver is
3221 not @code{nil}.  This allows for more efficient entry points in the
3222 runtime to be used.  This option is only available in conjunction with
3223 the NeXT runtime and ABI version 0 or 1.
3225 @item -fobjc-abi-version=@var{n}
3226 @opindex fobjc-abi-version
3227 Use version @var{n} of the Objective-C ABI for the selected runtime.
3228 This option is currently supported only for the NeXT runtime.  In that
3229 case, Version 0 is the traditional (32-bit) ABI without support for
3230 properties and other Objective-C 2.0 additions.  Version 1 is the
3231 traditional (32-bit) ABI with support for properties and other
3232 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
3233 nothing is specified, the default is Version 0 on 32-bit target
3234 machines, and Version 2 on 64-bit target machines.
3236 @item -fobjc-call-cxx-cdtors
3237 @opindex fobjc-call-cxx-cdtors
3238 For each Objective-C class, check if any of its instance variables is a
3239 C++ object with a non-trivial default constructor.  If so, synthesize a
3240 special @code{- (id) .cxx_construct} instance method which runs
3241 non-trivial default constructors on any such instance variables, in order,
3242 and then return @code{self}.  Similarly, check if any instance variable
3243 is a C++ object with a non-trivial destructor, and if so, synthesize a
3244 special @code{- (void) .cxx_destruct} method which runs
3245 all such default destructors, in reverse order.
3247 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
3248 methods thusly generated only operate on instance variables
3249 declared in the current Objective-C class, and not those inherited
3250 from superclasses.  It is the responsibility of the Objective-C
3251 runtime to invoke all such methods in an object's inheritance
3252 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
3253 by the runtime immediately after a new object instance is allocated;
3254 the @code{- (void) .cxx_destruct} methods are invoked immediately
3255 before the runtime deallocates an object instance.
3257 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
3258 support for invoking the @code{- (id) .cxx_construct} and
3259 @code{- (void) .cxx_destruct} methods.
3261 @item -fobjc-direct-dispatch
3262 @opindex fobjc-direct-dispatch
3263 Allow fast jumps to the message dispatcher.  On Darwin this is
3264 accomplished via the comm page.
3266 @item -fobjc-exceptions
3267 @opindex fobjc-exceptions
3268 Enable syntactic support for structured exception handling in
3269 Objective-C, similar to what is offered by C++.  This option
3270 is required to use the Objective-C keywords @code{@@try},
3271 @code{@@throw}, @code{@@catch}, @code{@@finally} and
3272 @code{@@synchronized}.  This option is available with both the GNU
3273 runtime and the NeXT runtime (but not available in conjunction with
3274 the NeXT runtime on Mac OS X 10.2 and earlier).
3276 @item -fobjc-gc
3277 @opindex fobjc-gc
3278 Enable garbage collection (GC) in Objective-C and Objective-C++
3279 programs.  This option is only available with the NeXT runtime; the
3280 GNU runtime has a different garbage collection implementation that
3281 does not require special compiler flags.
3283 @item -fobjc-nilcheck
3284 @opindex fobjc-nilcheck
3285 For the NeXT runtime with version 2 of the ABI, check for a nil
3286 receiver in method invocations before doing the actual method call.
3287 This is the default and can be disabled using
3288 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
3289 checked for nil in this way no matter what this flag is set to.
3290 Currently this flag does nothing when the GNU runtime, or an older
3291 version of the NeXT runtime ABI, is used.
3293 @item -fobjc-std=objc1
3294 @opindex fobjc-std
3295 Conform to the language syntax of Objective-C 1.0, the language
3296 recognized by GCC 4.0.  This only affects the Objective-C additions to
3297 the C/C++ language; it does not affect conformance to C/C++ standards,
3298 which is controlled by the separate C/C++ dialect option flags.  When
3299 this option is used with the Objective-C or Objective-C++ compiler,
3300 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
3301 This is useful if you need to make sure that your Objective-C code can
3302 be compiled with older versions of GCC@.
3304 @item -freplace-objc-classes
3305 @opindex freplace-objc-classes
3306 Emit a special marker instructing @command{ld(1)} not to statically link in
3307 the resulting object file, and allow @command{dyld(1)} to load it in at
3308 run time instead.  This is used in conjunction with the Fix-and-Continue
3309 debugging mode, where the object file in question may be recompiled and
3310 dynamically reloaded in the course of program execution, without the need
3311 to restart the program itself.  Currently, Fix-and-Continue functionality
3312 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
3313 and later.
3315 @item -fzero-link
3316 @opindex fzero-link
3317 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
3318 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
3319 compile time) with static class references that get initialized at load time,
3320 which improves run-time performance.  Specifying the @option{-fzero-link} flag
3321 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
3322 to be retained.  This is useful in Zero-Link debugging mode, since it allows
3323 for individual class implementations to be modified during program execution.
3324 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
3325 regardless of command-line options.
3327 @item -fno-local-ivars
3328 @opindex fno-local-ivars
3329 @opindex flocal-ivars
3330 By default instance variables in Objective-C can be accessed as if
3331 they were local variables from within the methods of the class they're
3332 declared in.  This can lead to shadowing between instance variables
3333 and other variables declared either locally inside a class method or
3334 globally with the same name.  Specifying the @option{-fno-local-ivars}
3335 flag disables this behavior thus avoiding variable shadowing issues.
3337 @item -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]}
3338 @opindex fivar-visibility
3339 Set the default instance variable visibility to the specified option
3340 so that instance variables declared outside the scope of any access
3341 modifier directives default to the specified visibility.
3343 @item -gen-decls
3344 @opindex gen-decls
3345 Dump interface declarations for all classes seen in the source file to a
3346 file named @file{@var{sourcename}.decl}.
3348 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
3349 @opindex Wassign-intercept
3350 @opindex Wno-assign-intercept
3351 Warn whenever an Objective-C assignment is being intercepted by the
3352 garbage collector.
3354 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
3355 @opindex Wno-protocol
3356 @opindex Wprotocol
3357 If a class is declared to implement a protocol, a warning is issued for
3358 every method in the protocol that is not implemented by the class.  The
3359 default behavior is to issue a warning for every method not explicitly
3360 implemented in the class, even if a method implementation is inherited
3361 from the superclass.  If you use the @option{-Wno-protocol} option, then
3362 methods inherited from the superclass are considered to be implemented,
3363 and no warning is issued for them.
3365 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3366 @opindex Wselector
3367 @opindex Wno-selector
3368 Warn if multiple methods of different types for the same selector are
3369 found during compilation.  The check is performed on the list of methods
3370 in the final stage of compilation.  Additionally, a check is performed
3371 for each selector appearing in a @code{@@selector(@dots{})}
3372 expression, and a corresponding method for that selector has been found
3373 during compilation.  Because these checks scan the method table only at
3374 the end of compilation, these warnings are not produced if the final
3375 stage of compilation is not reached, for example because an error is
3376 found during compilation, or because the @option{-fsyntax-only} option is
3377 being used.
3379 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3380 @opindex Wstrict-selector-match
3381 @opindex Wno-strict-selector-match
3382 Warn if multiple methods with differing argument and/or return types are
3383 found for a given selector when attempting to send a message using this
3384 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3385 is off (which is the default behavior), the compiler omits such warnings
3386 if any differences found are confined to types that share the same size
3387 and alignment.
3389 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3390 @opindex Wundeclared-selector
3391 @opindex Wno-undeclared-selector
3392 Warn if a @code{@@selector(@dots{})} expression referring to an
3393 undeclared selector is found.  A selector is considered undeclared if no
3394 method with that name has been declared before the
3395 @code{@@selector(@dots{})} expression, either explicitly in an
3396 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3397 an @code{@@implementation} section.  This option always performs its
3398 checks as soon as a @code{@@selector(@dots{})} expression is found,
3399 while @option{-Wselector} only performs its checks in the final stage of
3400 compilation.  This also enforces the coding style convention
3401 that methods and selectors must be declared before being used.
3403 @item -print-objc-runtime-info
3404 @opindex print-objc-runtime-info
3405 Generate C header describing the largest structure that is passed by
3406 value, if any.
3408 @end table
3410 @node Diagnostic Message Formatting Options
3411 @section Options to Control Diagnostic Messages Formatting
3412 @cindex options to control diagnostics formatting
3413 @cindex diagnostic messages
3414 @cindex message formatting
3416 Traditionally, diagnostic messages have been formatted irrespective of
3417 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3418 options described below
3419 to control the formatting algorithm for diagnostic messages, 
3420 e.g.@: how many characters per line, how often source location
3421 information should be reported.  Note that some language front ends may not
3422 honor these options.
3424 @table @gcctabopt
3425 @item -fmessage-length=@var{n}
3426 @opindex fmessage-length
3427 Try to format error messages so that they fit on lines of about
3428 @var{n} characters.  If @var{n} is zero, then no line-wrapping is
3429 done; each error message appears on a single line.  This is the
3430 default for all front ends.
3432 @item -fdiagnostics-show-location=once
3433 @opindex fdiagnostics-show-location
3434 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3435 reporter to emit source location information @emph{once}; that is, in
3436 case the message is too long to fit on a single physical line and has to
3437 be wrapped, the source location won't be emitted (as prefix) again,
3438 over and over, in subsequent continuation lines.  This is the default
3439 behavior.
3441 @item -fdiagnostics-show-location=every-line
3442 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3443 messages reporter to emit the same source location information (as
3444 prefix) for physical lines that result from the process of breaking
3445 a message which is too long to fit on a single line.
3447 @item -fdiagnostics-color[=@var{WHEN}]
3448 @itemx -fno-diagnostics-color
3449 @opindex fdiagnostics-color
3450 @cindex highlight, color
3451 @vindex GCC_COLORS @r{environment variable}
3452 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3453 or @samp{auto}.  The default depends on how the compiler has been configured,
3454 it can be any of the above @var{WHEN} options or also @samp{never}
3455 if @env{GCC_COLORS} environment variable isn't present in the environment,
3456 and @samp{auto} otherwise.
3457 @samp{auto} means to use color only when the standard error is a terminal.
3458 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3459 aliases for @option{-fdiagnostics-color=always} and
3460 @option{-fdiagnostics-color=never}, respectively.
3462 The colors are defined by the environment variable @env{GCC_COLORS}.
3463 Its value is a colon-separated list of capabilities and Select Graphic
3464 Rendition (SGR) substrings. SGR commands are interpreted by the
3465 terminal or terminal emulator.  (See the section in the documentation
3466 of your text terminal for permitted values and their meanings as
3467 character attributes.)  These substring values are integers in decimal
3468 representation and can be concatenated with semicolons.
3469 Common values to concatenate include
3470 @samp{1} for bold,
3471 @samp{4} for underline,
3472 @samp{5} for blink,
3473 @samp{7} for inverse,
3474 @samp{39} for default foreground color,
3475 @samp{30} to @samp{37} for foreground colors,
3476 @samp{90} to @samp{97} for 16-color mode foreground colors,
3477 @samp{38;5;0} to @samp{38;5;255}
3478 for 88-color and 256-color modes foreground colors,
3479 @samp{49} for default background color,
3480 @samp{40} to @samp{47} for background colors,
3481 @samp{100} to @samp{107} for 16-color mode background colors,
3482 and @samp{48;5;0} to @samp{48;5;255}
3483 for 88-color and 256-color modes background colors.
3485 The default @env{GCC_COLORS} is
3486 @smallexample
3487 error=01;31:warning=01;35:note=01;36:range1=32:range2=34:locus=01:\
3488 quote=01:fixit-insert=32:fixit-delete=31:\
3489 diff-filename=01:diff-hunk=32:diff-delete=31:diff-insert=32:\
3490 type-diff=01;32
3491 @end smallexample
3492 @noindent
3493 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3494 @samp{01;36} is bold cyan, @samp{32} is green, @samp{34} is blue,
3495 @samp{01} is bold, and @samp{31} is red.
3496 Setting @env{GCC_COLORS} to the empty string disables colors.
3497 Supported capabilities are as follows.
3499 @table @code
3500 @item error=
3501 @vindex error GCC_COLORS @r{capability}
3502 SGR substring for error: markers.
3504 @item warning=
3505 @vindex warning GCC_COLORS @r{capability}
3506 SGR substring for warning: markers.
3508 @item note=
3509 @vindex note GCC_COLORS @r{capability}
3510 SGR substring for note: markers.
3512 @item range1=
3513 @vindex range1 GCC_COLORS @r{capability}
3514 SGR substring for first additional range.
3516 @item range2=
3517 @vindex range2 GCC_COLORS @r{capability}
3518 SGR substring for second additional range.
3520 @item locus=
3521 @vindex locus GCC_COLORS @r{capability}
3522 SGR substring for location information, @samp{file:line} or
3523 @samp{file:line:column} etc.
3525 @item quote=
3526 @vindex quote GCC_COLORS @r{capability}
3527 SGR substring for information printed within quotes.
3529 @item fixit-insert=
3530 @vindex fixit-insert GCC_COLORS @r{capability}
3531 SGR substring for fix-it hints suggesting text to
3532 be inserted or replaced.
3534 @item fixit-delete=
3535 @vindex fixit-delete GCC_COLORS @r{capability}
3536 SGR substring for fix-it hints suggesting text to
3537 be deleted.
3539 @item diff-filename=
3540 @vindex diff-filename GCC_COLORS @r{capability}
3541 SGR substring for filename headers within generated patches.
3543 @item diff-hunk=
3544 @vindex diff-hunk GCC_COLORS @r{capability}
3545 SGR substring for the starts of hunks within generated patches.
3547 @item diff-delete=
3548 @vindex diff-delete GCC_COLORS @r{capability}
3549 SGR substring for deleted lines within generated patches.
3551 @item diff-insert=
3552 @vindex diff-insert GCC_COLORS @r{capability}
3553 SGR substring for inserted lines within generated patches.
3555 @item type-diff=
3556 @vindex type-diff GCC_COLORS @r{capability}
3557 SGR substring for highlighting mismatching types within template
3558 arguments in the C++ frontend.
3559 @end table
3561 @item -fno-diagnostics-show-option
3562 @opindex fno-diagnostics-show-option
3563 @opindex fdiagnostics-show-option
3564 By default, each diagnostic emitted includes text indicating the
3565 command-line option that directly controls the diagnostic (if such an
3566 option is known to the diagnostic machinery).  Specifying the
3567 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3569 @item -fno-diagnostics-show-caret
3570 @opindex fno-diagnostics-show-caret
3571 @opindex fdiagnostics-show-caret
3572 By default, each diagnostic emitted includes the original source line
3573 and a caret @samp{^} indicating the column.  This option suppresses this
3574 information.  The source line is truncated to @var{n} characters, if
3575 the @option{-fmessage-length=n} option is given.  When the output is done
3576 to the terminal, the width is limited to the width given by the
3577 @env{COLUMNS} environment variable or, if not set, to the terminal width.
3579 @item -fdiagnostics-parseable-fixits
3580 @opindex fdiagnostics-parseable-fixits
3581 Emit fix-it hints in a machine-parseable format, suitable for consumption
3582 by IDEs.  For each fix-it, a line will be printed after the relevant
3583 diagnostic, starting with the string ``fix-it:''.  For example:
3585 @smallexample
3586 fix-it:"test.c":@{45:3-45:21@}:"gtk_widget_show_all"
3587 @end smallexample
3589 The location is expressed as a half-open range, expressed as a count of
3590 bytes, starting at byte 1 for the initial column.  In the above example,
3591 bytes 3 through 20 of line 45 of ``test.c'' are to be replaced with the
3592 given string:
3594 @smallexample
3595 00000000011111111112222222222
3596 12345678901234567890123456789
3597   gtk_widget_showall (dlg);
3598   ^^^^^^^^^^^^^^^^^^
3599   gtk_widget_show_all
3600 @end smallexample
3602 The filename and replacement string escape backslash as ``\\", tab as ``\t'',
3603 newline as ``\n'', double quotes as ``\"'', non-printable characters as octal
3604 (e.g. vertical tab as ``\013'').
3606 An empty replacement string indicates that the given range is to be removed.
3607 An empty range (e.g. ``45:3-45:3'') indicates that the string is to
3608 be inserted at the given position.
3610 @item -fdiagnostics-generate-patch
3611 @opindex fdiagnostics-generate-patch
3612 Print fix-it hints to stderr in unified diff format, after any diagnostics
3613 are printed.  For example:
3615 @smallexample
3616 --- test.c
3617 +++ test.c
3618 @@ -42,5 +42,5 @@
3620  void show_cb(GtkDialog *dlg)
3621  @{
3622 -  gtk_widget_showall(dlg);
3623 +  gtk_widget_show_all(dlg);
3624  @}
3626 @end smallexample
3628 The diff may or may not be colorized, following the same rules
3629 as for diagnostics (see @option{-fdiagnostics-color}).
3631 @item -fdiagnostics-show-template-tree
3632 @opindex fdiagnostics-show-template-tree
3634 In the C++ frontend, when printing diagnostics showing mismatching
3635 template types, such as:
3637 @smallexample
3638   could not convert 'std::map<int, std::vector<double> >()'
3639     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3640 @end smallexample
3642 the @option{-fdiagnostics-show-template-tree} flag enables printing a
3643 tree-like structure showing the common and differing parts of the types,
3644 such as:
3646 @smallexample
3647   map<
3648     [...],
3649     vector<
3650       [double != float]>>
3651 @end smallexample
3653 The parts that differ are highlighted with color (``double'' and
3654 ``float'' in this case).
3656 @item -fno-elide-type
3657 @opindex fno-elide-type
3658 @opindex felide-type
3659 By default when the C++ frontend prints diagnostics showing mismatching
3660 template types, common parts of the types are printed as ``[...]'' to
3661 simplify the error message.  For example:
3663 @smallexample
3664   could not convert 'std::map<int, std::vector<double> >()'
3665     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3666 @end smallexample
3668 Specifying the @option{-fno-elide-type} flag suppresses that behavior.
3669 This flag also affects the output of the
3670 @option{-fdiagnostics-show-template-tree} flag.
3672 @item -fno-show-column
3673 @opindex fno-show-column
3674 Do not print column numbers in diagnostics.  This may be necessary if
3675 diagnostics are being scanned by a program that does not understand the
3676 column numbers, such as @command{dejagnu}.
3678 @end table
3680 @node Warning Options
3681 @section Options to Request or Suppress Warnings
3682 @cindex options to control warnings
3683 @cindex warning messages
3684 @cindex messages, warning
3685 @cindex suppressing warnings
3687 Warnings are diagnostic messages that report constructions that
3688 are not inherently erroneous but that are risky or suggest there
3689 may have been an error.
3691 The following language-independent options do not enable specific
3692 warnings but control the kinds of diagnostics produced by GCC@.
3694 @table @gcctabopt
3695 @cindex syntax checking
3696 @item -fsyntax-only
3697 @opindex fsyntax-only
3698 Check the code for syntax errors, but don't do anything beyond that.
3700 @item -fmax-errors=@var{n}
3701 @opindex fmax-errors
3702 Limits the maximum number of error messages to @var{n}, at which point
3703 GCC bails out rather than attempting to continue processing the source
3704 code.  If @var{n} is 0 (the default), there is no limit on the number
3705 of error messages produced.  If @option{-Wfatal-errors} is also
3706 specified, then @option{-Wfatal-errors} takes precedence over this
3707 option.
3709 @item -w
3710 @opindex w
3711 Inhibit all warning messages.
3713 @item -Werror
3714 @opindex Werror
3715 @opindex Wno-error
3716 Make all warnings into errors.
3718 @item -Werror=
3719 @opindex Werror=
3720 @opindex Wno-error=
3721 Make the specified warning into an error.  The specifier for a warning
3722 is appended; for example @option{-Werror=switch} turns the warnings
3723 controlled by @option{-Wswitch} into errors.  This switch takes a
3724 negative form, to be used to negate @option{-Werror} for specific
3725 warnings; for example @option{-Wno-error=switch} makes
3726 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3727 is in effect.
3729 The warning message for each controllable warning includes the
3730 option that controls the warning.  That option can then be used with
3731 @option{-Werror=} and @option{-Wno-error=} as described above.
3732 (Printing of the option in the warning message can be disabled using the
3733 @option{-fno-diagnostics-show-option} flag.)
3735 Note that specifying @option{-Werror=}@var{foo} automatically implies
3736 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3737 imply anything.
3739 @item -Wfatal-errors
3740 @opindex Wfatal-errors
3741 @opindex Wno-fatal-errors
3742 This option causes the compiler to abort compilation on the first error
3743 occurred rather than trying to keep going and printing further error
3744 messages.
3746 @end table
3748 You can request many specific warnings with options beginning with
3749 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3750 implicit declarations.  Each of these specific warning options also
3751 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3752 example, @option{-Wno-implicit}.  This manual lists only one of the
3753 two forms, whichever is not the default.  For further
3754 language-specific options also refer to @ref{C++ Dialect Options} and
3755 @ref{Objective-C and Objective-C++ Dialect Options}.
3757 Some options, such as @option{-Wall} and @option{-Wextra}, turn on other
3758 options, such as @option{-Wunused}, which may turn on further options,
3759 such as @option{-Wunused-value}. The combined effect of positive and
3760 negative forms is that more specific options have priority over less
3761 specific ones, independently of their position in the command-line. For
3762 options of the same specificity, the last one takes effect. Options
3763 enabled or disabled via pragmas (@pxref{Diagnostic Pragmas}) take effect
3764 as if they appeared at the end of the command-line.
3766 When an unrecognized warning option is requested (e.g.,
3767 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3768 that the option is not recognized.  However, if the @option{-Wno-} form
3769 is used, the behavior is slightly different: no diagnostic is
3770 produced for @option{-Wno-unknown-warning} unless other diagnostics
3771 are being produced.  This allows the use of new @option{-Wno-} options
3772 with old compilers, but if something goes wrong, the compiler
3773 warns that an unrecognized option is present.
3775 @table @gcctabopt
3776 @item -Wpedantic
3777 @itemx -pedantic
3778 @opindex pedantic
3779 @opindex Wpedantic
3780 Issue all the warnings demanded by strict ISO C and ISO C++;
3781 reject all programs that use forbidden extensions, and some other
3782 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3783 version of the ISO C standard specified by any @option{-std} option used.
3785 Valid ISO C and ISO C++ programs should compile properly with or without
3786 this option (though a rare few require @option{-ansi} or a
3787 @option{-std} option specifying the required version of ISO C)@.  However,
3788 without this option, certain GNU extensions and traditional C and C++
3789 features are supported as well.  With this option, they are rejected.
3791 @option{-Wpedantic} does not cause warning messages for use of the
3792 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3793 warnings are also disabled in the expression that follows
3794 @code{__extension__}.  However, only system header files should use
3795 these escape routes; application programs should avoid them.
3796 @xref{Alternate Keywords}.
3798 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3799 C conformance.  They soon find that it does not do quite what they want:
3800 it finds some non-ISO practices, but not all---only those for which
3801 ISO C @emph{requires} a diagnostic, and some others for which
3802 diagnostics have been added.
3804 A feature to report any failure to conform to ISO C might be useful in
3805 some instances, but would require considerable additional work and would
3806 be quite different from @option{-Wpedantic}.  We don't have plans to
3807 support such a feature in the near future.
3809 Where the standard specified with @option{-std} represents a GNU
3810 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3811 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3812 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3813 where they are required by the base standard.  (It does not make sense
3814 for such warnings to be given only for features not in the specified GNU
3815 C dialect, since by definition the GNU dialects of C include all
3816 features the compiler supports with the given option, and there would be
3817 nothing to warn about.)
3819 @item -pedantic-errors
3820 @opindex pedantic-errors
3821 Give an error whenever the @dfn{base standard} (see @option{-Wpedantic})
3822 requires a diagnostic, in some cases where there is undefined behavior
3823 at compile-time and in some other cases that do not prevent compilation
3824 of programs that are valid according to the standard. This is not
3825 equivalent to @option{-Werror=pedantic}, since there are errors enabled
3826 by this option and not enabled by the latter and vice versa.
3828 @item -Wall
3829 @opindex Wall
3830 @opindex Wno-all
3831 This enables all the warnings about constructions that some users
3832 consider questionable, and that are easy to avoid (or modify to
3833 prevent the warning), even in conjunction with macros.  This also
3834 enables some language-specific warnings described in @ref{C++ Dialect
3835 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3837 @option{-Wall} turns on the following warning flags:
3839 @gccoptlist{-Waddress   @gol
3840 -Warray-bounds=1 @r{(only with} @option{-O2}@r{)}  @gol
3841 -Wbool-compare  @gol
3842 -Wbool-operation  @gol
3843 -Wc++11-compat  -Wc++14-compat  @gol
3844 -Wcatch-value @r{(C++ and Objective-C++ only)}  @gol
3845 -Wchar-subscripts  @gol
3846 -Wcomment  @gol
3847 -Wduplicate-decl-specifier @r{(C and Objective-C only)} @gol
3848 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3849 -Wformat   @gol
3850 -Wint-in-bool-context  @gol
3851 -Wimplicit @r{(C and Objective-C only)} @gol
3852 -Wimplicit-int @r{(C and Objective-C only)} @gol
3853 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3854 -Winit-self @r{(only for C++)} @gol
3855 -Wlogical-not-parentheses @gol
3856 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3857 -Wmaybe-uninitialized @gol
3858 -Wmemset-elt-size @gol
3859 -Wmemset-transposed-args @gol
3860 -Wmisleading-indentation @r{(only for C/C++)} @gol
3861 -Wmissing-braces @r{(only for C/ObjC)} @gol
3862 -Wmultistatement-macros  @gol
3863 -Wnarrowing @r{(only for C++)}  @gol
3864 -Wnonnull  @gol
3865 -Wnonnull-compare  @gol
3866 -Wopenmp-simd @gol
3867 -Wparentheses  @gol
3868 -Wpointer-sign  @gol
3869 -Wreorder   @gol
3870 -Wreturn-type  @gol
3871 -Wsequence-point  @gol
3872 -Wsign-compare @r{(only in C++)}  @gol
3873 -Wsizeof-pointer-div @gol
3874 -Wsizeof-pointer-memaccess @gol
3875 -Wstrict-aliasing  @gol
3876 -Wstrict-overflow=1  @gol
3877 -Wswitch  @gol
3878 -Wtautological-compare  @gol
3879 -Wtrigraphs  @gol
3880 -Wuninitialized  @gol
3881 -Wunknown-pragmas  @gol
3882 -Wunused-function  @gol
3883 -Wunused-label     @gol
3884 -Wunused-value     @gol
3885 -Wunused-variable  @gol
3886 -Wvolatile-register-var @gol
3889 Note that some warning flags are not implied by @option{-Wall}.  Some of
3890 them warn about constructions that users generally do not consider
3891 questionable, but which occasionally you might wish to check for;
3892 others warn about constructions that are necessary or hard to avoid in
3893 some cases, and there is no simple way to modify the code to suppress
3894 the warning. Some of them are enabled by @option{-Wextra} but many of
3895 them must be enabled individually.
3897 @item -Wextra
3898 @opindex W
3899 @opindex Wextra
3900 @opindex Wno-extra
3901 This enables some extra warning flags that are not enabled by
3902 @option{-Wall}. (This option used to be called @option{-W}.  The older
3903 name is still supported, but the newer name is more descriptive.)
3905 @gccoptlist{-Wclobbered  @gol
3906 -Wempty-body  @gol
3907 -Wignored-qualifiers @gol
3908 -Wimplicit-fallthrough=3 @gol
3909 -Wmissing-field-initializers  @gol
3910 -Wmissing-parameter-type @r{(C only)}  @gol
3911 -Wold-style-declaration @r{(C only)}  @gol
3912 -Woverride-init  @gol
3913 -Wsign-compare @r{(C only)} @gol
3914 -Wtype-limits  @gol
3915 -Wuninitialized  @gol
3916 -Wshift-negative-value @r{(in C++03 and in C99 and newer)}  @gol
3917 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3918 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3921 The option @option{-Wextra} also prints warning messages for the
3922 following cases:
3924 @itemize @bullet
3926 @item
3927 A pointer is compared against integer zero with @code{<}, @code{<=},
3928 @code{>}, or @code{>=}.
3930 @item
3931 (C++ only) An enumerator and a non-enumerator both appear in a
3932 conditional expression.
3934 @item
3935 (C++ only) Ambiguous virtual bases.
3937 @item
3938 (C++ only) Subscripting an array that has been declared @code{register}.
3940 @item
3941 (C++ only) Taking the address of a variable that has been declared
3942 @code{register}.
3944 @item
3945 (C++ only) A base class is not initialized in the copy constructor
3946 of a derived class.
3948 @end itemize
3950 @item -Wchar-subscripts
3951 @opindex Wchar-subscripts
3952 @opindex Wno-char-subscripts
3953 Warn if an array subscript has type @code{char}.  This is a common cause
3954 of error, as programmers often forget that this type is signed on some
3955 machines.
3956 This warning is enabled by @option{-Wall}.
3958 @item -Wchkp
3959 @opindex Wchkp
3960 Warn about an invalid memory access that is found by Pointer Bounds Checker
3961 (@option{-fcheck-pointer-bounds}).
3963 @item -Wno-coverage-mismatch
3964 @opindex Wno-coverage-mismatch
3965 Warn if feedback profiles do not match when using the
3966 @option{-fprofile-use} option.
3967 If a source file is changed between compiling with @option{-fprofile-gen} and
3968 with @option{-fprofile-use}, the files with the profile feedback can fail
3969 to match the source file and GCC cannot use the profile feedback
3970 information.  By default, this warning is enabled and is treated as an
3971 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3972 warning or @option{-Wno-error=coverage-mismatch} can be used to
3973 disable the error.  Disabling the error for this warning can result in
3974 poorly optimized code and is useful only in the
3975 case of very minor changes such as bug fixes to an existing code-base.
3976 Completely disabling the warning is not recommended.
3978 @item -Wno-cpp
3979 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3981 Suppress warning messages emitted by @code{#warning} directives.
3983 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3984 @opindex Wdouble-promotion
3985 @opindex Wno-double-promotion
3986 Give a warning when a value of type @code{float} is implicitly
3987 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
3988 floating-point unit implement @code{float} in hardware, but emulate
3989 @code{double} in software.  On such a machine, doing computations
3990 using @code{double} values is much more expensive because of the
3991 overhead required for software emulation.
3993 It is easy to accidentally do computations with @code{double} because
3994 floating-point literals are implicitly of type @code{double}.  For
3995 example, in:
3996 @smallexample
3997 @group
3998 float area(float radius)
4000    return 3.14159 * radius * radius;
4002 @end group
4003 @end smallexample
4004 the compiler performs the entire computation with @code{double}
4005 because the floating-point literal is a @code{double}.
4007 @item -Wduplicate-decl-specifier @r{(C and Objective-C only)}
4008 @opindex Wduplicate-decl-specifier
4009 @opindex Wno-duplicate-decl-specifier
4010 Warn if a declaration has duplicate @code{const}, @code{volatile},
4011 @code{restrict} or @code{_Atomic} specifier.  This warning is enabled by
4012 @option{-Wall}.
4014 @item -Wformat
4015 @itemx -Wformat=@var{n}
4016 @opindex Wformat
4017 @opindex Wno-format
4018 @opindex ffreestanding
4019 @opindex fno-builtin
4020 @opindex Wformat=
4021 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
4022 the arguments supplied have types appropriate to the format string
4023 specified, and that the conversions specified in the format string make
4024 sense.  This includes standard functions, and others specified by format
4025 attributes (@pxref{Function Attributes}), in the @code{printf},
4026 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
4027 not in the C standard) families (or other target-specific families).
4028 Which functions are checked without format attributes having been
4029 specified depends on the standard version selected, and such checks of
4030 functions without the attribute specified are disabled by
4031 @option{-ffreestanding} or @option{-fno-builtin}.
4033 The formats are checked against the format features supported by GNU
4034 libc version 2.2.  These include all ISO C90 and C99 features, as well
4035 as features from the Single Unix Specification and some BSD and GNU
4036 extensions.  Other library implementations may not support all these
4037 features; GCC does not support warning about features that go beyond a
4038 particular library's limitations.  However, if @option{-Wpedantic} is used
4039 with @option{-Wformat}, warnings are given about format features not
4040 in the selected standard version (but not for @code{strfmon} formats,
4041 since those are not in any version of the C standard).  @xref{C Dialect
4042 Options,,Options Controlling C Dialect}.
4044 @table @gcctabopt
4045 @item -Wformat=1
4046 @itemx -Wformat
4047 @opindex Wformat
4048 @opindex Wformat=1
4049 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
4050 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
4051 @option{-Wformat} also checks for null format arguments for several
4052 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
4053 aspects of this level of format checking can be disabled by the
4054 options: @option{-Wno-format-contains-nul},
4055 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
4056 @option{-Wformat} is enabled by @option{-Wall}.
4058 @item -Wno-format-contains-nul
4059 @opindex Wno-format-contains-nul
4060 @opindex Wformat-contains-nul
4061 If @option{-Wformat} is specified, do not warn about format strings that
4062 contain NUL bytes.
4064 @item -Wno-format-extra-args
4065 @opindex Wno-format-extra-args
4066 @opindex Wformat-extra-args
4067 If @option{-Wformat} is specified, do not warn about excess arguments to a
4068 @code{printf} or @code{scanf} format function.  The C standard specifies
4069 that such arguments are ignored.
4071 Where the unused arguments lie between used arguments that are
4072 specified with @samp{$} operand number specifications, normally
4073 warnings are still given, since the implementation could not know what
4074 type to pass to @code{va_arg} to skip the unused arguments.  However,
4075 in the case of @code{scanf} formats, this option suppresses the
4076 warning if the unused arguments are all pointers, since the Single
4077 Unix Specification says that such unused arguments are allowed.
4079 @item -Wformat-overflow
4080 @itemx -Wformat-overflow=@var{level}
4081 @opindex Wformat-overflow
4082 @opindex Wno-format-overflow
4083 Warn about calls to formatted input/output functions such as @code{sprintf}
4084 and @code{vsprintf} that might overflow the destination buffer.  When the
4085 exact number of bytes written by a format directive cannot be determined
4086 at compile-time it is estimated based on heuristics that depend on the
4087 @var{level} argument and on optimization.  While enabling optimization
4088 will in most cases improve the accuracy of the warning, it may also
4089 result in false positives.
4091 @table @gcctabopt
4092 @item -Wformat-overflow
4093 @item -Wformat-overflow=1
4094 @opindex Wformat-overflow
4095 @opindex Wno-format-overflow
4096 Level @var{1} of @option{-Wformat-overflow} enabled by @option{-Wformat}
4097 employs a conservative approach that warns only about calls that most
4098 likely overflow the buffer.  At this level, numeric arguments to format
4099 directives with unknown values are assumed to have the value of one, and
4100 strings of unknown length to be empty.  Numeric arguments that are known
4101 to be bounded to a subrange of their type, or string arguments whose output
4102 is bounded either by their directive's precision or by a finite set of
4103 string literals, are assumed to take on the value within the range that
4104 results in the most bytes on output.  For example, the call to @code{sprintf}
4105 below is diagnosed because even with both @var{a} and @var{b} equal to zero,
4106 the terminating NUL character (@code{'\0'}) appended by the function
4107 to the destination buffer will be written past its end.  Increasing
4108 the size of the buffer by a single byte is sufficient to avoid the
4109 warning, though it may not be sufficient to avoid the overflow.
4111 @smallexample
4112 void f (int a, int b)
4114   char buf [12];
4115   sprintf (buf, "a = %i, b = %i\n", a, b);
4117 @end smallexample
4119 @item -Wformat-overflow=2
4120 Level @var{2} warns also about calls that might overflow the destination
4121 buffer given an argument of sufficient length or magnitude.  At level
4122 @var{2}, unknown numeric arguments are assumed to have the minimum
4123 representable value for signed types with a precision greater than 1, and
4124 the maximum representable value otherwise.  Unknown string arguments whose
4125 length cannot be assumed to be bounded either by the directive's precision,
4126 or by a finite set of string literals they may evaluate to, or the character
4127 array they may point to, are assumed to be 1 character long.
4129 At level @var{2}, the call in the example above is again diagnosed, but
4130 this time because with @var{a} equal to a 32-bit @code{INT_MIN} the first
4131 @code{%i} directive will write some of its digits beyond the end of
4132 the destination buffer.  To make the call safe regardless of the values
4133 of the two variables, the size of the destination buffer must be increased
4134 to at least 34 bytes.  GCC includes the minimum size of the buffer in
4135 an informational note following the warning.
4137 An alternative to increasing the size of the destination buffer is to
4138 constrain the range of formatted values.  The maximum length of string
4139 arguments can be bounded by specifying the precision in the format
4140 directive.  When numeric arguments of format directives can be assumed
4141 to be bounded by less than the precision of their type, choosing
4142 an appropriate length modifier to the format specifier will reduce
4143 the required buffer size.  For example, if @var{a} and @var{b} in the
4144 example above can be assumed to be within the precision of
4145 the @code{short int} type then using either the @code{%hi} format
4146 directive or casting the argument to @code{short} reduces the maximum
4147 required size of the buffer to 24 bytes.
4149 @smallexample
4150 void f (int a, int b)
4152   char buf [23];
4153   sprintf (buf, "a = %hi, b = %i\n", a, (short)b);
4155 @end smallexample
4156 @end table
4158 @item -Wno-format-zero-length
4159 @opindex Wno-format-zero-length
4160 @opindex Wformat-zero-length
4161 If @option{-Wformat} is specified, do not warn about zero-length formats.
4162 The C standard specifies that zero-length formats are allowed.
4165 @item -Wformat=2
4166 @opindex Wformat=2
4167 Enable @option{-Wformat} plus additional format checks.  Currently
4168 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
4169 -Wformat-y2k}.
4171 @item -Wformat-nonliteral
4172 @opindex Wformat-nonliteral
4173 @opindex Wno-format-nonliteral
4174 If @option{-Wformat} is specified, also warn if the format string is not a
4175 string literal and so cannot be checked, unless the format function
4176 takes its format arguments as a @code{va_list}.
4178 @item -Wformat-security
4179 @opindex Wformat-security
4180 @opindex Wno-format-security
4181 If @option{-Wformat} is specified, also warn about uses of format
4182 functions that represent possible security problems.  At present, this
4183 warns about calls to @code{printf} and @code{scanf} functions where the
4184 format string is not a string literal and there are no format arguments,
4185 as in @code{printf (foo);}.  This may be a security hole if the format
4186 string came from untrusted input and contains @samp{%n}.  (This is
4187 currently a subset of what @option{-Wformat-nonliteral} warns about, but
4188 in future warnings may be added to @option{-Wformat-security} that are not
4189 included in @option{-Wformat-nonliteral}.)
4191 @item -Wformat-signedness
4192 @opindex Wformat-signedness
4193 @opindex Wno-format-signedness
4194 If @option{-Wformat} is specified, also warn if the format string
4195 requires an unsigned argument and the argument is signed and vice versa.
4197 @item -Wformat-truncation
4198 @itemx -Wformat-truncation=@var{level}
4199 @opindex Wformat-truncation
4200 @opindex Wno-format-truncation
4201 Warn about calls to formatted input/output functions such as @code{snprintf}
4202 and @code{vsnprintf} that might result in output truncation.  When the exact
4203 number of bytes written by a format directive cannot be determined at
4204 compile-time it is estimated based on heuristics that depend on
4205 the @var{level} argument and on optimization.  While enabling optimization
4206 will in most cases improve the accuracy of the warning, it may also result
4207 in false positives.  Except as noted otherwise, the option uses the same
4208 logic @option{-Wformat-overflow}.
4210 @table @gcctabopt
4211 @item -Wformat-truncation
4212 @item -Wformat-truncation=1
4213 @opindex Wformat-truncation
4214 @opindex Wno-format-overflow
4215 Level @var{1} of @option{-Wformat-truncation} enabled by @option{-Wformat}
4216 employs a conservative approach that warns only about calls to bounded
4217 functions whose return value is unused and that will most likely result
4218 in output truncation.
4220 @item -Wformat-truncation=2
4221 Level @var{2} warns also about calls to bounded functions whose return
4222 value is used and that might result in truncation given an argument of
4223 sufficient length or magnitude.
4224 @end table
4226 @item -Wformat-y2k
4227 @opindex Wformat-y2k
4228 @opindex Wno-format-y2k
4229 If @option{-Wformat} is specified, also warn about @code{strftime}
4230 formats that may yield only a two-digit year.
4231 @end table
4233 @item -Wnonnull
4234 @opindex Wnonnull
4235 @opindex Wno-nonnull
4236 Warn about passing a null pointer for arguments marked as
4237 requiring a non-null value by the @code{nonnull} function attribute.
4239 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
4240 can be disabled with the @option{-Wno-nonnull} option.
4242 @item -Wnonnull-compare
4243 @opindex Wnonnull-compare
4244 @opindex Wno-nonnull-compare
4245 Warn when comparing an argument marked with the @code{nonnull}
4246 function attribute against null inside the function.
4248 @option{-Wnonnull-compare} is included in @option{-Wall}.  It
4249 can be disabled with the @option{-Wno-nonnull-compare} option.
4251 @item -Wnull-dereference
4252 @opindex Wnull-dereference
4253 @opindex Wno-null-dereference
4254 Warn if the compiler detects paths that trigger erroneous or
4255 undefined behavior due to dereferencing a null pointer.  This option
4256 is only active when @option{-fdelete-null-pointer-checks} is active,
4257 which is enabled by optimizations in most targets.  The precision of
4258 the warnings depends on the optimization options used.
4260 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
4261 @opindex Winit-self
4262 @opindex Wno-init-self
4263 Warn about uninitialized variables that are initialized with themselves.
4264 Note this option can only be used with the @option{-Wuninitialized} option.
4266 For example, GCC warns about @code{i} being uninitialized in the
4267 following snippet only when @option{-Winit-self} has been specified:
4268 @smallexample
4269 @group
4270 int f()
4272   int i = i;
4273   return i;
4275 @end group
4276 @end smallexample
4278 This warning is enabled by @option{-Wall} in C++.
4280 @item -Wimplicit-int @r{(C and Objective-C only)}
4281 @opindex Wimplicit-int
4282 @opindex Wno-implicit-int
4283 Warn when a declaration does not specify a type.
4284 This warning is enabled by @option{-Wall}.
4286 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
4287 @opindex Wimplicit-function-declaration
4288 @opindex Wno-implicit-function-declaration
4289 Give a warning whenever a function is used before being declared. In
4290 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
4291 enabled by default and it is made into an error by
4292 @option{-pedantic-errors}. This warning is also enabled by
4293 @option{-Wall}.
4295 @item -Wimplicit @r{(C and Objective-C only)}
4296 @opindex Wimplicit
4297 @opindex Wno-implicit
4298 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
4299 This warning is enabled by @option{-Wall}.
4301 @item -Wimplicit-fallthrough
4302 @opindex Wimplicit-fallthrough
4303 @opindex Wno-implicit-fallthrough
4304 @option{-Wimplicit-fallthrough} is the same as @option{-Wimplicit-fallthrough=3}
4305 and @option{-Wno-implicit-fallthrough} is the same as
4306 @option{-Wimplicit-fallthrough=0}.
4308 @item -Wimplicit-fallthrough=@var{n}
4309 @opindex Wimplicit-fallthrough=
4310 Warn when a switch case falls through.  For example:
4312 @smallexample
4313 @group
4314 switch (cond)
4315   @{
4316   case 1:
4317     a = 1;
4318     break;
4319   case 2:
4320     a = 2;
4321   case 3:
4322     a = 3;
4323     break;
4324   @}
4325 @end group
4326 @end smallexample
4328 This warning does not warn when the last statement of a case cannot
4329 fall through, e.g. when there is a return statement or a call to function
4330 declared with the noreturn attribute.  @option{-Wimplicit-fallthrough=}
4331 also takes into account control flow statements, such as ifs, and only
4332 warns when appropriate.  E.g.@:
4334 @smallexample
4335 @group
4336 switch (cond)
4337   @{
4338   case 1:
4339     if (i > 3) @{
4340       bar (5);
4341       break;
4342     @} else if (i < 1) @{
4343       bar (0);
4344     @} else
4345       return;
4346   default:
4347     @dots{}
4348   @}
4349 @end group
4350 @end smallexample
4352 Since there are occasions where a switch case fall through is desirable,
4353 GCC provides an attribute, @code{__attribute__ ((fallthrough))}, that is
4354 to be used along with a null statement to suppress this warning that
4355 would normally occur:
4357 @smallexample
4358 @group
4359 switch (cond)
4360   @{
4361   case 1:
4362     bar (0);
4363     __attribute__ ((fallthrough));
4364   default:
4365     @dots{}
4366   @}
4367 @end group
4368 @end smallexample
4370 C++17 provides a standard way to suppress the @option{-Wimplicit-fallthrough}
4371 warning using @code{[[fallthrough]];} instead of the GNU attribute.  In C++11
4372 or C++14 users can use @code{[[gnu::fallthrough]];}, which is a GNU extension.
4373 Instead of these attributes, it is also possible to add a fallthrough comment
4374 to silence the warning.  The whole body of the C or C++ style comment should
4375 match the given regular expressions listed below.  The option argument @var{n}
4376 specifies what kind of comments are accepted:
4378 @itemize @bullet
4380 @item @option{-Wimplicit-fallthrough=0} disables the warning altogether.
4382 @item @option{-Wimplicit-fallthrough=1} matches @code{.*} regular
4383 expression, any comment is used as fallthrough comment.
4385 @item @option{-Wimplicit-fallthrough=2} case insensitively matches
4386 @code{.*falls?[ \t-]*thr(ough|u).*} regular expression.
4388 @item @option{-Wimplicit-fallthrough=3} case sensitively matches one of the
4389 following regular expressions:
4391 @itemize @bullet
4393 @item @code{-fallthrough}
4395 @item @code{@@fallthrough@@}
4397 @item @code{lint -fallthrough[ \t]*}
4399 @item @code{[ \t.!]*(ELSE,? |INTENTIONAL(LY)? )?@*FALL(S | |-)?THR(OUGH|U)[ \t.!]*(-[^\n\r]*)?}
4401 @item @code{[ \t.!]*(Else,? |Intentional(ly)? )?@*Fall((s | |-)[Tt]|t)hr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4403 @item @code{[ \t.!]*([Ee]lse,? |[Ii]ntentional(ly)? )?@*fall(s | |-)?thr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4405 @end itemize
4407 @item @option{-Wimplicit-fallthrough=4} case sensitively matches one of the
4408 following regular expressions:
4410 @itemize @bullet
4412 @item @code{-fallthrough}
4414 @item @code{@@fallthrough@@}
4416 @item @code{lint -fallthrough[ \t]*}
4418 @item @code{[ \t]*FALLTHR(OUGH|U)[ \t]*}
4420 @end itemize
4422 @item @option{-Wimplicit-fallthrough=5} doesn't recognize any comments as
4423 fallthrough comments, only attributes disable the warning.
4425 @end itemize
4427 The comment needs to be followed after optional whitespace and other comments
4428 by @code{case} or @code{default} keywords or by a user label that precedes some
4429 @code{case} or @code{default} label.
4431 @smallexample
4432 @group
4433 switch (cond)
4434   @{
4435   case 1:
4436     bar (0);
4437     /* FALLTHRU */
4438   default:
4439     @dots{}
4440   @}
4441 @end group
4442 @end smallexample
4444 The @option{-Wimplicit-fallthrough=3} warning is enabled by @option{-Wextra}.
4446 @item -Wif-not-aligned @r{(C, C++, Objective-C and Objective-C++ only)}
4447 @opindex Wif-not-aligned
4448 @opindex Wno-if-not-aligned
4449 Control if warning triggered by the @code{warn_if_not_aligned} attribute
4450 should be issued.  This is is enabled by default.
4451 Use @option{-Wno-if-not-aligned} to disable it.
4453 @item -Wignored-qualifiers @r{(C and C++ only)}
4454 @opindex Wignored-qualifiers
4455 @opindex Wno-ignored-qualifiers
4456 Warn if the return type of a function has a type qualifier
4457 such as @code{const}.  For ISO C such a type qualifier has no effect,
4458 since the value returned by a function is not an lvalue.
4459 For C++, the warning is only emitted for scalar types or @code{void}.
4460 ISO C prohibits qualified @code{void} return types on function
4461 definitions, so such return types always receive a warning
4462 even without this option.
4464 This warning is also enabled by @option{-Wextra}.
4466 @item -Wignored-attributes @r{(C and C++ only)}
4467 @opindex Wignored-attributes
4468 @opindex Wno-ignored-attributes
4469 Warn when an attribute is ignored.  This is different from the
4470 @option{-Wattributes} option in that it warns whenever the compiler decides
4471 to drop an attribute, not that the attribute is either unknown, used in a
4472 wrong place, etc.  This warning is enabled by default.
4474 @item -Wmain
4475 @opindex Wmain
4476 @opindex Wno-main
4477 Warn if the type of @code{main} is suspicious.  @code{main} should be
4478 a function with external linkage, returning int, taking either zero
4479 arguments, two, or three arguments of appropriate types.  This warning
4480 is enabled by default in C++ and is enabled by either @option{-Wall}
4481 or @option{-Wpedantic}.
4483 @item -Wmisleading-indentation @r{(C and C++ only)}
4484 @opindex Wmisleading-indentation
4485 @opindex Wno-misleading-indentation
4486 Warn when the indentation of the code does not reflect the block structure.
4487 Specifically, a warning is issued for @code{if}, @code{else}, @code{while}, and
4488 @code{for} clauses with a guarded statement that does not use braces,
4489 followed by an unguarded statement with the same indentation.
4491 In the following example, the call to ``bar'' is misleadingly indented as
4492 if it were guarded by the ``if'' conditional.
4494 @smallexample
4495   if (some_condition ())
4496     foo ();
4497     bar ();  /* Gotcha: this is not guarded by the "if".  */
4498 @end smallexample
4500 In the case of mixed tabs and spaces, the warning uses the
4501 @option{-ftabstop=} option to determine if the statements line up
4502 (defaulting to 8).
4504 The warning is not issued for code involving multiline preprocessor logic
4505 such as the following example.
4507 @smallexample
4508   if (flagA)
4509     foo (0);
4510 #if SOME_CONDITION_THAT_DOES_NOT_HOLD
4511   if (flagB)
4512 #endif
4513     foo (1);
4514 @end smallexample
4516 The warning is not issued after a @code{#line} directive, since this
4517 typically indicates autogenerated code, and no assumptions can be made
4518 about the layout of the file that the directive references.
4520 This warning is enabled by @option{-Wall} in C and C++.
4522 @item -Wmissing-braces
4523 @opindex Wmissing-braces
4524 @opindex Wno-missing-braces
4525 Warn if an aggregate or union initializer is not fully bracketed.  In
4526 the following example, the initializer for @code{a} is not fully
4527 bracketed, but that for @code{b} is fully bracketed.  This warning is
4528 enabled by @option{-Wall} in C.
4530 @smallexample
4531 int a[2][2] = @{ 0, 1, 2, 3 @};
4532 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
4533 @end smallexample
4535 This warning is enabled by @option{-Wall}.
4537 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
4538 @opindex Wmissing-include-dirs
4539 @opindex Wno-missing-include-dirs
4540 Warn if a user-supplied include directory does not exist.
4542 @item -Wmultistatement-macros
4543 @opindex Wmultistatement-macros
4544 @opindex Wno-multistatement-macros
4545 Warn about unsafe multiple statement macros that appear to be guarded
4546 by a clause such as @code{if}, @code{else}, @code{for}, @code{switch}, or
4547 @code{while}, in which only the first statement is actually guarded after
4548 the macro is expanded.
4550 For example:
4552 @smallexample
4553 #define DOIT x++; y++
4554 if (c)
4555   DOIT;
4556 @end smallexample
4558 will increment @code{y} unconditionally, not just when @code{c} holds.
4559 The can usually be fixed by wrapping the macro in a do-while loop:
4560 @smallexample
4561 #define DOIT do @{ x++; y++; @} while (0)
4562 if (c)
4563   DOIT;
4564 @end smallexample
4566 This warning is enabled by @option{-Wall} in C and C++.
4568 @item -Wparentheses
4569 @opindex Wparentheses
4570 @opindex Wno-parentheses
4571 Warn if parentheses are omitted in certain contexts, such
4572 as when there is an assignment in a context where a truth value
4573 is expected, or when operators are nested whose precedence people
4574 often get confused about.
4576 Also warn if a comparison like @code{x<=y<=z} appears; this is
4577 equivalent to @code{(x<=y ? 1 : 0) <= z}, which is a different
4578 interpretation from that of ordinary mathematical notation.
4580 Also warn for dangerous uses of the GNU extension to
4581 @code{?:} with omitted middle operand. When the condition
4582 in the @code{?}: operator is a boolean expression, the omitted value is
4583 always 1.  Often programmers expect it to be a value computed
4584 inside the conditional expression instead.
4586 For C++ this also warns for some cases of unnecessary parentheses in
4587 declarations, which can indicate an attempt at a function call instead
4588 of a declaration:
4589 @smallexample
4591   // Declares a local variable called mymutex.
4592   std::unique_lock<std::mutex> (mymutex);
4593   // User meant std::unique_lock<std::mutex> lock (mymutex);
4595 @end smallexample
4597 This warning is enabled by @option{-Wall}.
4599 @item -Wsequence-point
4600 @opindex Wsequence-point
4601 @opindex Wno-sequence-point
4602 Warn about code that may have undefined semantics because of violations
4603 of sequence point rules in the C and C++ standards.
4605 The C and C++ standards define the order in which expressions in a C/C++
4606 program are evaluated in terms of @dfn{sequence points}, which represent
4607 a partial ordering between the execution of parts of the program: those
4608 executed before the sequence point, and those executed after it.  These
4609 occur after the evaluation of a full expression (one which is not part
4610 of a larger expression), after the evaluation of the first operand of a
4611 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
4612 function is called (but after the evaluation of its arguments and the
4613 expression denoting the called function), and in certain other places.
4614 Other than as expressed by the sequence point rules, the order of
4615 evaluation of subexpressions of an expression is not specified.  All
4616 these rules describe only a partial order rather than a total order,
4617 since, for example, if two functions are called within one expression
4618 with no sequence point between them, the order in which the functions
4619 are called is not specified.  However, the standards committee have
4620 ruled that function calls do not overlap.
4622 It is not specified when between sequence points modifications to the
4623 values of objects take effect.  Programs whose behavior depends on this
4624 have undefined behavior; the C and C++ standards specify that ``Between
4625 the previous and next sequence point an object shall have its stored
4626 value modified at most once by the evaluation of an expression.
4627 Furthermore, the prior value shall be read only to determine the value
4628 to be stored.''.  If a program breaks these rules, the results on any
4629 particular implementation are entirely unpredictable.
4631 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
4632 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
4633 diagnosed by this option, and it may give an occasional false positive
4634 result, but in general it has been found fairly effective at detecting
4635 this sort of problem in programs.
4637 The C++17 standard will define the order of evaluation of operands in
4638 more cases: in particular it requires that the right-hand side of an
4639 assignment be evaluated before the left-hand side, so the above
4640 examples are no longer undefined.  But this warning will still warn
4641 about them, to help people avoid writing code that is undefined in C
4642 and earlier revisions of C++.
4644 The standard is worded confusingly, therefore there is some debate
4645 over the precise meaning of the sequence point rules in subtle cases.
4646 Links to discussions of the problem, including proposed formal
4647 definitions, may be found on the GCC readings page, at
4648 @uref{http://gcc.gnu.org/@/readings.html}.
4650 This warning is enabled by @option{-Wall} for C and C++.
4652 @item -Wno-return-local-addr
4653 @opindex Wno-return-local-addr
4654 @opindex Wreturn-local-addr
4655 Do not warn about returning a pointer (or in C++, a reference) to a
4656 variable that goes out of scope after the function returns.
4658 @item -Wreturn-type
4659 @opindex Wreturn-type
4660 @opindex Wno-return-type
4661 Warn whenever a function is defined with a return type that defaults
4662 to @code{int}.  Also warn about any @code{return} statement with no
4663 return value in a function whose return type is not @code{void}
4664 (falling off the end of the function body is considered returning
4665 without a value).
4667 For C only, warn about a @code{return} statement with an expression in a
4668 function whose return type is @code{void}, unless the expression type is
4669 also @code{void}.  As a GNU extension, the latter case is accepted
4670 without a warning unless @option{-Wpedantic} is used.
4672 For C++, a function without return type always produces a diagnostic
4673 message, even when @option{-Wno-return-type} is specified.  The only
4674 exceptions are @code{main} and functions defined in system headers.
4676 This warning is enabled by @option{-Wall}.
4678 @item -Wshift-count-negative
4679 @opindex Wshift-count-negative
4680 @opindex Wno-shift-count-negative
4681 Warn if shift count is negative. This warning is enabled by default.
4683 @item -Wshift-count-overflow
4684 @opindex Wshift-count-overflow
4685 @opindex Wno-shift-count-overflow
4686 Warn if shift count >= width of type. This warning is enabled by default.
4688 @item -Wshift-negative-value
4689 @opindex Wshift-negative-value
4690 @opindex Wno-shift-negative-value
4691 Warn if left shifting a negative value.  This warning is enabled by
4692 @option{-Wextra} in C99 and C++11 modes (and newer).
4694 @item -Wshift-overflow
4695 @itemx -Wshift-overflow=@var{n}
4696 @opindex Wshift-overflow
4697 @opindex Wno-shift-overflow
4698 Warn about left shift overflows.  This warning is enabled by
4699 default in C99 and C++11 modes (and newer).
4701 @table @gcctabopt
4702 @item -Wshift-overflow=1
4703 This is the warning level of @option{-Wshift-overflow} and is enabled
4704 by default in C99 and C++11 modes (and newer).  This warning level does
4705 not warn about left-shifting 1 into the sign bit.  (However, in C, such
4706 an overflow is still rejected in contexts where an integer constant expression
4707 is required.)
4709 @item -Wshift-overflow=2
4710 This warning level also warns about left-shifting 1 into the sign bit,
4711 unless C++14 mode is active.
4712 @end table
4714 @item -Wswitch
4715 @opindex Wswitch
4716 @opindex Wno-switch
4717 Warn whenever a @code{switch} statement has an index of enumerated type
4718 and lacks a @code{case} for one or more of the named codes of that
4719 enumeration.  (The presence of a @code{default} label prevents this
4720 warning.)  @code{case} labels outside the enumeration range also
4721 provoke warnings when this option is used (even if there is a
4722 @code{default} label).
4723 This warning is enabled by @option{-Wall}.
4725 @item -Wswitch-default
4726 @opindex Wswitch-default
4727 @opindex Wno-switch-default
4728 Warn whenever a @code{switch} statement does not have a @code{default}
4729 case.
4731 @item -Wswitch-enum
4732 @opindex Wswitch-enum
4733 @opindex Wno-switch-enum
4734 Warn whenever a @code{switch} statement has an index of enumerated type
4735 and lacks a @code{case} for one or more of the named codes of that
4736 enumeration.  @code{case} labels outside the enumeration range also
4737 provoke warnings when this option is used.  The only difference
4738 between @option{-Wswitch} and this option is that this option gives a
4739 warning about an omitted enumeration code even if there is a
4740 @code{default} label.
4742 @item -Wswitch-bool
4743 @opindex Wswitch-bool
4744 @opindex Wno-switch-bool
4745 Warn whenever a @code{switch} statement has an index of boolean type
4746 and the case values are outside the range of a boolean type.
4747 It is possible to suppress this warning by casting the controlling
4748 expression to a type other than @code{bool}.  For example:
4749 @smallexample
4750 @group
4751 switch ((int) (a == 4))
4752   @{
4753   @dots{}
4754   @}
4755 @end group
4756 @end smallexample
4757 This warning is enabled by default for C and C++ programs.
4759 @item -Wswitch-unreachable
4760 @opindex Wswitch-unreachable
4761 @opindex Wno-switch-unreachable
4762 Warn whenever a @code{switch} statement contains statements between the
4763 controlling expression and the first case label, which will never be
4764 executed.  For example:
4765 @smallexample
4766 @group
4767 switch (cond)
4768   @{
4769    i = 15;
4770   @dots{}
4771    case 5:
4772   @dots{}
4773   @}
4774 @end group
4775 @end smallexample
4776 @option{-Wswitch-unreachable} does not warn if the statement between the
4777 controlling expression and the first case label is just a declaration:
4778 @smallexample
4779 @group
4780 switch (cond)
4781   @{
4782    int i;
4783   @dots{}
4784    case 5:
4785    i = 5;
4786   @dots{}
4787   @}
4788 @end group
4789 @end smallexample
4790 This warning is enabled by default for C and C++ programs.
4792 @item -Wsync-nand @r{(C and C++ only)}
4793 @opindex Wsync-nand
4794 @opindex Wno-sync-nand
4795 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
4796 built-in functions are used.  These functions changed semantics in GCC 4.4.
4798 @item -Wunused-but-set-parameter
4799 @opindex Wunused-but-set-parameter
4800 @opindex Wno-unused-but-set-parameter
4801 Warn whenever a function parameter is assigned to, but otherwise unused
4802 (aside from its declaration).
4804 To suppress this warning use the @code{unused} attribute
4805 (@pxref{Variable Attributes}).
4807 This warning is also enabled by @option{-Wunused} together with
4808 @option{-Wextra}.
4810 @item -Wunused-but-set-variable
4811 @opindex Wunused-but-set-variable
4812 @opindex Wno-unused-but-set-variable
4813 Warn whenever a local variable is assigned to, but otherwise unused
4814 (aside from its declaration).
4815 This warning is enabled by @option{-Wall}.
4817 To suppress this warning use the @code{unused} attribute
4818 (@pxref{Variable Attributes}).
4820 This warning is also enabled by @option{-Wunused}, which is enabled
4821 by @option{-Wall}.
4823 @item -Wunused-function
4824 @opindex Wunused-function
4825 @opindex Wno-unused-function
4826 Warn whenever a static function is declared but not defined or a
4827 non-inline static function is unused.
4828 This warning is enabled by @option{-Wall}.
4830 @item -Wunused-label
4831 @opindex Wunused-label
4832 @opindex Wno-unused-label
4833 Warn whenever a label is declared but not used.
4834 This warning is enabled by @option{-Wall}.
4836 To suppress this warning use the @code{unused} attribute
4837 (@pxref{Variable Attributes}).
4839 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
4840 @opindex Wunused-local-typedefs
4841 Warn when a typedef locally defined in a function is not used.
4842 This warning is enabled by @option{-Wall}.
4844 @item -Wunused-parameter
4845 @opindex Wunused-parameter
4846 @opindex Wno-unused-parameter
4847 Warn whenever a function parameter is unused aside from its declaration.
4849 To suppress this warning use the @code{unused} attribute
4850 (@pxref{Variable Attributes}).
4852 @item -Wno-unused-result
4853 @opindex Wunused-result
4854 @opindex Wno-unused-result
4855 Do not warn if a caller of a function marked with attribute
4856 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
4857 its return value. The default is @option{-Wunused-result}.
4859 @item -Wunused-variable
4860 @opindex Wunused-variable
4861 @opindex Wno-unused-variable
4862 Warn whenever a local or static variable is unused aside from its
4863 declaration. This option implies @option{-Wunused-const-variable=1} for C,
4864 but not for C++. This warning is enabled by @option{-Wall}.
4866 To suppress this warning use the @code{unused} attribute
4867 (@pxref{Variable Attributes}).
4869 @item -Wunused-const-variable
4870 @itemx -Wunused-const-variable=@var{n}
4871 @opindex Wunused-const-variable
4872 @opindex Wno-unused-const-variable
4873 Warn whenever a constant static variable is unused aside from its declaration.
4874 @option{-Wunused-const-variable=1} is enabled by @option{-Wunused-variable}
4875 for C, but not for C++. In C this declares variable storage, but in C++ this
4876 is not an error since const variables take the place of @code{#define}s.
4878 To suppress this warning use the @code{unused} attribute
4879 (@pxref{Variable Attributes}).
4881 @table @gcctabopt
4882 @item -Wunused-const-variable=1
4883 This is the warning level that is enabled by @option{-Wunused-variable} for
4884 C.  It warns only about unused static const variables defined in the main
4885 compilation unit, but not about static const variables declared in any
4886 header included.
4888 @item -Wunused-const-variable=2
4889 This warning level also warns for unused constant static variables in
4890 headers (excluding system headers).  This is the warning level of
4891 @option{-Wunused-const-variable} and must be explicitly requested since
4892 in C++ this isn't an error and in C it might be harder to clean up all
4893 headers included.
4894 @end table
4896 @item -Wunused-value
4897 @opindex Wunused-value
4898 @opindex Wno-unused-value
4899 Warn whenever a statement computes a result that is explicitly not
4900 used. To suppress this warning cast the unused expression to
4901 @code{void}. This includes an expression-statement or the left-hand
4902 side of a comma expression that contains no side effects. For example,
4903 an expression such as @code{x[i,j]} causes a warning, while
4904 @code{x[(void)i,j]} does not.
4906 This warning is enabled by @option{-Wall}.
4908 @item -Wunused
4909 @opindex Wunused
4910 @opindex Wno-unused
4911 All the above @option{-Wunused} options combined.
4913 In order to get a warning about an unused function parameter, you must
4914 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
4915 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
4917 @item -Wuninitialized
4918 @opindex Wuninitialized
4919 @opindex Wno-uninitialized
4920 Warn if an automatic variable is used without first being initialized
4921 or if a variable may be clobbered by a @code{setjmp} call. In C++,
4922 warn if a non-static reference or non-static @code{const} member
4923 appears in a class without constructors.
4925 If you want to warn about code that uses the uninitialized value of the
4926 variable in its own initializer, use the @option{-Winit-self} option.
4928 These warnings occur for individual uninitialized or clobbered
4929 elements of structure, union or array variables as well as for
4930 variables that are uninitialized or clobbered as a whole.  They do
4931 not occur for variables or elements declared @code{volatile}.  Because
4932 these warnings depend on optimization, the exact variables or elements
4933 for which there are warnings depends on the precise optimization
4934 options and version of GCC used.
4936 Note that there may be no warning about a variable that is used only
4937 to compute a value that itself is never used, because such
4938 computations may be deleted by data flow analysis before the warnings
4939 are printed.
4941 @item -Winvalid-memory-model
4942 @opindex Winvalid-memory-model
4943 @opindex Wno-invalid-memory-model
4944 Warn for invocations of @ref{__atomic Builtins}, @ref{__sync Builtins},
4945 and the C11 atomic generic functions with a memory consistency argument
4946 that is either invalid for the operation or outside the range of values
4947 of the @code{memory_order} enumeration.  For example, since the
4948 @code{__atomic_store} and @code{__atomic_store_n} built-ins are only
4949 defined for the relaxed, release, and sequentially consistent memory
4950 orders the following code is diagnosed:
4952 @smallexample
4953 void store (int *i)
4955   __atomic_store_n (i, 0, memory_order_consume);
4957 @end smallexample
4959 @option{-Winvalid-memory-model} is enabled by default.
4961 @item -Wmaybe-uninitialized
4962 @opindex Wmaybe-uninitialized
4963 @opindex Wno-maybe-uninitialized
4964 For an automatic (i.e.@ local) variable, if there exists a path from the
4965 function entry to a use of the variable that is initialized, but there exist
4966 some other paths for which the variable is not initialized, the compiler
4967 emits a warning if it cannot prove the uninitialized paths are not
4968 executed at run time.
4970 These warnings are only possible in optimizing compilation, because otherwise
4971 GCC does not keep track of the state of variables.
4973 These warnings are made optional because GCC may not be able to determine when
4974 the code is correct in spite of appearing to have an error.  Here is one
4975 example of how this can happen:
4977 @smallexample
4978 @group
4980   int x;
4981   switch (y)
4982     @{
4983     case 1: x = 1;
4984       break;
4985     case 2: x = 4;
4986       break;
4987     case 3: x = 5;
4988     @}
4989   foo (x);
4991 @end group
4992 @end smallexample
4994 @noindent
4995 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
4996 always initialized, but GCC doesn't know this. To suppress the
4997 warning, you need to provide a default case with assert(0) or
4998 similar code.
5000 @cindex @code{longjmp} warnings
5001 This option also warns when a non-volatile automatic variable might be
5002 changed by a call to @code{longjmp}.
5003 The compiler sees only the calls to @code{setjmp}.  It cannot know
5004 where @code{longjmp} will be called; in fact, a signal handler could
5005 call it at any point in the code.  As a result, you may get a warning
5006 even when there is in fact no problem because @code{longjmp} cannot
5007 in fact be called at the place that would cause a problem.
5009 Some spurious warnings can be avoided if you declare all the functions
5010 you use that never return as @code{noreturn}.  @xref{Function
5011 Attributes}.
5013 This warning is enabled by @option{-Wall} or @option{-Wextra}.
5015 @item -Wunknown-pragmas
5016 @opindex Wunknown-pragmas
5017 @opindex Wno-unknown-pragmas
5018 @cindex warning for unknown pragmas
5019 @cindex unknown pragmas, warning
5020 @cindex pragmas, warning of unknown
5021 Warn when a @code{#pragma} directive is encountered that is not understood by 
5022 GCC@.  If this command-line option is used, warnings are even issued
5023 for unknown pragmas in system header files.  This is not the case if
5024 the warnings are only enabled by the @option{-Wall} command-line option.
5026 @item -Wno-pragmas
5027 @opindex Wno-pragmas
5028 @opindex Wpragmas
5029 Do not warn about misuses of pragmas, such as incorrect parameters,
5030 invalid syntax, or conflicts between pragmas.  See also
5031 @option{-Wunknown-pragmas}.
5033 @item -Wstrict-aliasing
5034 @opindex Wstrict-aliasing
5035 @opindex Wno-strict-aliasing
5036 This option is only active when @option{-fstrict-aliasing} is active.
5037 It warns about code that might break the strict aliasing rules that the
5038 compiler is using for optimization.  The warning does not catch all
5039 cases, but does attempt to catch the more common pitfalls.  It is
5040 included in @option{-Wall}.
5041 It is equivalent to @option{-Wstrict-aliasing=3}
5043 @item -Wstrict-aliasing=n
5044 @opindex Wstrict-aliasing=n
5045 This option is only active when @option{-fstrict-aliasing} is active.
5046 It warns about code that might break the strict aliasing rules that the
5047 compiler is using for optimization.
5048 Higher levels correspond to higher accuracy (fewer false positives).
5049 Higher levels also correspond to more effort, similar to the way @option{-O} 
5050 works.
5051 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
5053 Level 1: Most aggressive, quick, least accurate.
5054 Possibly useful when higher levels
5055 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
5056 false negatives.  However, it has many false positives.
5057 Warns for all pointer conversions between possibly incompatible types,
5058 even if never dereferenced.  Runs in the front end only.
5060 Level 2: Aggressive, quick, not too precise.
5061 May still have many false positives (not as many as level 1 though),
5062 and few false negatives (but possibly more than level 1).
5063 Unlike level 1, it only warns when an address is taken.  Warns about
5064 incomplete types.  Runs in the front end only.
5066 Level 3 (default for @option{-Wstrict-aliasing}):
5067 Should have very few false positives and few false
5068 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
5069 Takes care of the common pun+dereference pattern in the front end:
5070 @code{*(int*)&some_float}.
5071 If optimization is enabled, it also runs in the back end, where it deals
5072 with multiple statement cases using flow-sensitive points-to information.
5073 Only warns when the converted pointer is dereferenced.
5074 Does not warn about incomplete types.
5076 @item -Wstrict-overflow
5077 @itemx -Wstrict-overflow=@var{n}
5078 @opindex Wstrict-overflow
5079 @opindex Wno-strict-overflow
5080 This option is only active when signed overflow is undefined.
5081 It warns about cases where the compiler optimizes based on the
5082 assumption that signed overflow does not occur.  Note that it does not
5083 warn about all cases where the code might overflow: it only warns
5084 about cases where the compiler implements some optimization.  Thus
5085 this warning depends on the optimization level.
5087 An optimization that assumes that signed overflow does not occur is
5088 perfectly safe if the values of the variables involved are such that
5089 overflow never does, in fact, occur.  Therefore this warning can
5090 easily give a false positive: a warning about code that is not
5091 actually a problem.  To help focus on important issues, several
5092 warning levels are defined.  No warnings are issued for the use of
5093 undefined signed overflow when estimating how many iterations a loop
5094 requires, in particular when determining whether a loop will be
5095 executed at all.
5097 @table @gcctabopt
5098 @item -Wstrict-overflow=1
5099 Warn about cases that are both questionable and easy to avoid.  For
5100 example the compiler simplifies
5101 @code{x + 1 > x} to @code{1}.  This level of
5102 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
5103 are not, and must be explicitly requested.
5105 @item -Wstrict-overflow=2
5106 Also warn about other cases where a comparison is simplified to a
5107 constant.  For example: @code{abs (x) >= 0}.  This can only be
5108 simplified when signed integer overflow is undefined, because
5109 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
5110 zero.  @option{-Wstrict-overflow} (with no level) is the same as
5111 @option{-Wstrict-overflow=2}.
5113 @item -Wstrict-overflow=3
5114 Also warn about other cases where a comparison is simplified.  For
5115 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
5117 @item -Wstrict-overflow=4
5118 Also warn about other simplifications not covered by the above cases.
5119 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
5121 @item -Wstrict-overflow=5
5122 Also warn about cases where the compiler reduces the magnitude of a
5123 constant involved in a comparison.  For example: @code{x + 2 > y} is
5124 simplified to @code{x + 1 >= y}.  This is reported only at the
5125 highest warning level because this simplification applies to many
5126 comparisons, so this warning level gives a very large number of
5127 false positives.
5128 @end table
5130 @item -Wstringop-overflow
5131 @itemx -Wstringop-overflow=@var{type}
5132 @opindex Wstringop-overflow
5133 @opindex Wno-stringop-overflow
5134 Warn for calls to string manipulation functions such as @code{memcpy} and
5135 @code{strcpy} that are determined to overflow the destination buffer.  The
5136 optional argument is one greater than the type of Object Size Checking to
5137 perform to determine the size of the destination.  @xref{Object Size Checking}.
5138 The argument is meaningful only for functions that operate on character arrays
5139 but not for raw memory functions like @code{memcpy} which always make use
5140 of Object Size type-0.  The option also warns for calls that specify a size
5141 in excess of the largest possible object or at most @code{SIZE_MAX / 2} bytes.
5142 The option produces the best results with optimization enabled but can detect
5143 a small subset of simple buffer overflows even without optimization in
5144 calls to the GCC built-in functions like @code{__builtin_memcpy} that
5145 correspond to the standard functions.  In any case, the option warns about
5146 just a subset of buffer overflows detected by the corresponding overflow
5147 checking built-ins.  For example, the option will issue a warning for
5148 the @code{strcpy} call below because it copies at least 5 characters
5149 (the string @code{"blue"} including the terminating NUL) into the buffer
5150 of size 4.
5152 @smallexample
5153 enum Color @{ blue, purple, yellow @};
5154 const char* f (enum Color clr)
5156   static char buf [4];
5157   const char *str;
5158   switch (clr)
5159     @{
5160       case blue: str = "blue"; break;
5161       case purple: str = "purple"; break;
5162       case yellow: str = "yellow"; break;
5163     @}
5165   return strcpy (buf, str);   // warning here
5167 @end smallexample
5169 Option @option{-Wstringop-overflow=2} is enabled by default.
5171 @table @gcctabopt
5172 @item -Wstringop-overflow
5173 @item -Wstringop-overflow=1
5174 @opindex Wstringop-overflow
5175 @opindex Wno-stringop-overflow
5176 The @option{-Wstringop-overflow=1} option uses type-zero Object Size Checking
5177 to determine the sizes of destination objects.  This is the default setting
5178 of the option.  At this setting the option will not warn for writes past
5179 the end of subobjects of larger objects accessed by pointers unless the
5180 size of the largest surrounding object is known.  When the destination may
5181 be one of several objects it is assumed to be the largest one of them.  On
5182 Linux systems, when optimization is enabled at this setting the option warns
5183 for the same code as when the @code{_FORTIFY_SOURCE} macro is defined to
5184 a non-zero value.
5186 @item -Wstringop-overflow=2
5187 The @option{-Wstringop-overflow=2} option uses type-one Object Size Checking
5188 to determine the sizes of destination objects.  At this setting the option
5189 will warn about overflows when writing to members of the largest complete
5190 objects whose exact size is known.  It will, however, not warn for excessive
5191 writes to the same members of unknown objects referenced by pointers since
5192 they may point to arrays containing unknown numbers of elements.
5194 @item -Wstringop-overflow=3
5195 The @option{-Wstringop-overflow=3} option uses type-two Object Size Checking
5196 to determine the sizes of destination objects.  At this setting the option
5197 warns about overflowing the smallest object or data member.  This is the
5198 most restrictive setting of the option that may result in warnings for safe
5199 code.
5201 @item -Wstringop-overflow=4
5202 The @option{-Wstringop-overflow=4} option uses type-three Object Size Checking
5203 to determine the sizes of destination objects.  At this setting the option
5204 will warn about overflowing any data members, and when the destination is
5205 one of several objects it uses the size of the largest of them to decide
5206 whether to issue a warning.  Similarly to @option{-Wstringop-overflow=3} this
5207 setting of the option may result in warnings for benign code.
5208 @end table
5210 @item -Wstringop-truncation
5211 @opindex Wstringop-truncation
5212 @opindex Wno-stringop-truncation
5213 Warn for calls to bounded string manipulation functions such as @code{strncat},
5214 @code{strncpy}, and @code{stpncpy} that may either truncate the copied string
5215 or leave the destination unchanged.
5217 In the following example, the call to @code{strncat} specifies a bound that
5218 is less than the length of the source string.  As a result, the copy of
5219 the source will be truncated and so the call is diagnosed.  To avoid the
5220 warning use @code{bufsize - strlen (buf) - 1)} as the bound.
5222 @smallexample
5223 void append (char *buf, size_t bufsize)
5225   strncat (buf, ".txt", 3);
5227 @end smallexample
5229 As another example, the following call to @code{strncpy} results in copying
5230 to @code{d} just the characters preceding the terminating NUL, without
5231 appending the NUL to the end.  Assuming the result of @code{strncpy} is
5232 necessarily a NUL-terminated string is a common mistake, and so the call
5233 is diagnosed.  To avoid the warning when the result is not expected to be
5234 NUL-terminated, call @code{memcpy} instead.
5236 @smallexample
5237 void copy (char *d, const char *s)
5239   strncpy (d, s, strlen (s));
5241 @end smallexample
5243 In the following example, the call to @code{strncpy} specifies the size
5244 of the destination buffer as the bound.  If the length of the source
5245 string is equal to or greater than this size the result of the copy will
5246 not be NUL-terminated.  Therefore, the call is also diagnosed.  To avoid
5247 the warning, specify @code{sizeof buf - 1} as the bound and set the last
5248 element of the buffer to @code{NUL}.
5250 @smallexample
5251 void copy (const char *s)
5253   char buf[80];
5254   strncpy (buf, s, sizeof buf);
5255   @dots{}
5257 @end smallexample
5259 In situations where a character array is intended to store a sequence
5260 of bytes with no terminating @code{NUL} such an array may be annotated
5261 with attribute @code{nonstring} to avoid this warning.  Such arrays,
5262 however, are not suitable arguments to functions that expect
5263 @code{NUL}-terminated strings.  To help detect accidental misuses of
5264 such arrays GCC issues warnings unless it can prove that the use is
5265 safe.  @xref{Common Variable Attributes}.
5267 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{|}cold@r{|}malloc@r{]}
5268 @opindex Wsuggest-attribute=
5269 @opindex Wno-suggest-attribute=
5270 Warn for cases where adding an attribute may be beneficial. The
5271 attributes currently supported are listed below.
5273 @table @gcctabopt
5274 @item -Wsuggest-attribute=pure
5275 @itemx -Wsuggest-attribute=const
5276 @itemx -Wsuggest-attribute=noreturn
5277 @itemx -Wsuggest-attribute=malloc
5278 @opindex Wsuggest-attribute=pure
5279 @opindex Wno-suggest-attribute=pure
5280 @opindex Wsuggest-attribute=const
5281 @opindex Wno-suggest-attribute=const
5282 @opindex Wsuggest-attribute=noreturn
5283 @opindex Wno-suggest-attribute=noreturn
5284 @opindex Wsuggest-attribute=malloc
5285 @opindex Wno-suggest-attribute=malloc
5287 Warn about functions that might be candidates for attributes
5288 @code{pure}, @code{const} or @code{noreturn} or @code{malloc}. The compiler
5289 only warns for functions visible in other compilation units or (in the case of
5290 @code{pure} and @code{const}) if it cannot prove that the function returns
5291 normally. A function returns normally if it doesn't contain an infinite loop or
5292 return abnormally by throwing, calling @code{abort} or trapping.  This analysis
5293 requires option @option{-fipa-pure-const}, which is enabled by default at
5294 @option{-O} and higher.  Higher optimization levels improve the accuracy
5295 of the analysis.
5297 @item -Wsuggest-attribute=format
5298 @itemx -Wmissing-format-attribute
5299 @opindex Wsuggest-attribute=format
5300 @opindex Wmissing-format-attribute
5301 @opindex Wno-suggest-attribute=format
5302 @opindex Wno-missing-format-attribute
5303 @opindex Wformat
5304 @opindex Wno-format
5306 Warn about function pointers that might be candidates for @code{format}
5307 attributes.  Note these are only possible candidates, not absolute ones.
5308 GCC guesses that function pointers with @code{format} attributes that
5309 are used in assignment, initialization, parameter passing or return
5310 statements should have a corresponding @code{format} attribute in the
5311 resulting type.  I.e.@: the left-hand side of the assignment or
5312 initialization, the type of the parameter variable, or the return type
5313 of the containing function respectively should also have a @code{format}
5314 attribute to avoid the warning.
5316 GCC also warns about function definitions that might be
5317 candidates for @code{format} attributes.  Again, these are only
5318 possible candidates.  GCC guesses that @code{format} attributes
5319 might be appropriate for any function that calls a function like
5320 @code{vprintf} or @code{vscanf}, but this might not always be the
5321 case, and some functions for which @code{format} attributes are
5322 appropriate may not be detected.
5324 @item -Wsuggest-attribute=cold
5325 @opindex Wsuggest-attribute=cold
5326 @opindex Wno-suggest-attribute=cold
5328 Warn about functions that might be candidates for @code{cold} attribute.  This
5329 is based on static detection and generally will only warn about functions which
5330 always leads to a call to another @code{cold} function such as wrappers of
5331 C++ @code{throw} or fatal error reporting functions leading to @code{abort}.
5332 @end table
5334 @item -Wsuggest-final-types
5335 @opindex Wno-suggest-final-types
5336 @opindex Wsuggest-final-types
5337 Warn about types with virtual methods where code quality would be improved
5338 if the type were declared with the C++11 @code{final} specifier, 
5339 or, if possible,
5340 declared in an anonymous namespace. This allows GCC to more aggressively
5341 devirtualize the polymorphic calls. This warning is more effective with link
5342 time optimization, where the information about the class hierarchy graph is
5343 more complete.
5345 @item -Wsuggest-final-methods
5346 @opindex Wno-suggest-final-methods
5347 @opindex Wsuggest-final-methods
5348 Warn about virtual methods where code quality would be improved if the method
5349 were declared with the C++11 @code{final} specifier, 
5350 or, if possible, its type were
5351 declared in an anonymous namespace or with the @code{final} specifier.
5352 This warning is
5353 more effective with link-time optimization, where the information about the
5354 class hierarchy graph is more complete. It is recommended to first consider
5355 suggestions of @option{-Wsuggest-final-types} and then rebuild with new
5356 annotations.
5358 @item -Wsuggest-override
5359 Warn about overriding virtual functions that are not marked with the override
5360 keyword.
5362 @item -Walloc-zero
5363 @opindex Wno-alloc-zero
5364 @opindex Walloc-zero
5365 Warn about calls to allocation functions decorated with attribute
5366 @code{alloc_size} that specify zero bytes, including those to the built-in
5367 forms of the functions @code{aligned_alloc}, @code{alloca}, @code{calloc},
5368 @code{malloc}, and @code{realloc}.  Because the behavior of these functions
5369 when called with a zero size differs among implementations (and in the case
5370 of @code{realloc} has been deprecated) relying on it may result in subtle
5371 portability bugs and should be avoided.
5373 @item -Walloc-size-larger-than=@var{n}
5374 Warn about calls to functions decorated with attribute @code{alloc_size}
5375 that attempt to allocate objects larger than the specified number of bytes,
5376 or where the result of the size computation in an integer type with infinite
5377 precision would exceed @code{SIZE_MAX / 2}.  The option argument @var{n}
5378 may end in one of the standard suffixes designating a multiple of bytes
5379 such as @code{kB} and @code{KiB} for kilobyte and kibibyte, respectively,
5380 @code{MB} and @code{MiB} for megabyte and mebibyte, and so on.
5381 @xref{Function Attributes}.
5383 @item -Walloca
5384 @opindex Wno-alloca
5385 @opindex Walloca
5386 This option warns on all uses of @code{alloca} in the source.
5388 @item -Walloca-larger-than=@var{n}
5389 This option warns on calls to @code{alloca} that are not bounded by a
5390 controlling predicate limiting its argument of integer type to at most
5391 @var{n} bytes, or calls to @code{alloca} where the bound is unknown.
5392 Arguments of non-integer types are considered unbounded even if they
5393 appear to be constrained to the expected range.
5395 For example, a bounded case of @code{alloca} could be:
5397 @smallexample
5398 void func (size_t n)
5400   void *p;
5401   if (n <= 1000)
5402     p = alloca (n);
5403   else
5404     p = malloc (n);
5405   f (p);
5407 @end smallexample
5409 In the above example, passing @code{-Walloca-larger-than=1000} would not
5410 issue a warning because the call to @code{alloca} is known to be at most
5411 1000 bytes.  However, if @code{-Walloca-larger-than=500} were passed,
5412 the compiler would emit a warning.
5414 Unbounded uses, on the other hand, are uses of @code{alloca} with no
5415 controlling predicate constraining its integer argument.  For example:
5417 @smallexample
5418 void func ()
5420   void *p = alloca (n);
5421   f (p);
5423 @end smallexample
5425 If @code{-Walloca-larger-than=500} were passed, the above would trigger
5426 a warning, but this time because of the lack of bounds checking.
5428 Note, that even seemingly correct code involving signed integers could
5429 cause a warning:
5431 @smallexample
5432 void func (signed int n)
5434   if (n < 500)
5435     @{
5436       p = alloca (n);
5437       f (p);
5438     @}
5440 @end smallexample
5442 In the above example, @var{n} could be negative, causing a larger than
5443 expected argument to be implicitly cast into the @code{alloca} call.
5445 This option also warns when @code{alloca} is used in a loop.
5447 This warning is not enabled by @option{-Wall}, and is only active when
5448 @option{-ftree-vrp} is active (default for @option{-O2} and above).
5450 See also @option{-Wvla-larger-than=@var{n}}.
5452 @item -Warray-bounds
5453 @itemx -Warray-bounds=@var{n}
5454 @opindex Wno-array-bounds
5455 @opindex Warray-bounds
5456 This option is only active when @option{-ftree-vrp} is active
5457 (default for @option{-O2} and above). It warns about subscripts to arrays
5458 that are always out of bounds. This warning is enabled by @option{-Wall}.
5460 @table @gcctabopt
5461 @item -Warray-bounds=1
5462 This is the warning level of @option{-Warray-bounds} and is enabled
5463 by @option{-Wall}; higher levels are not, and must be explicitly requested.
5465 @item -Warray-bounds=2
5466 This warning level also warns about out of bounds access for
5467 arrays at the end of a struct and for arrays accessed through
5468 pointers. This warning level may give a larger number of
5469 false positives and is deactivated by default.
5470 @end table
5472 @item -Wattribute-alias
5473 Warn about declarations using the @code{alias} and similar attributes whose
5474 target is incompatible with the type of the alias.  @xref{Function Attributes,
5475 ,Declaring Attributes of Functions}.
5477 @item -Wbool-compare
5478 @opindex Wno-bool-compare
5479 @opindex Wbool-compare
5480 Warn about boolean expression compared with an integer value different from
5481 @code{true}/@code{false}.  For instance, the following comparison is
5482 always false:
5483 @smallexample
5484 int n = 5;
5485 @dots{}
5486 if ((n > 1) == 2) @{ @dots{} @}
5487 @end smallexample
5488 This warning is enabled by @option{-Wall}.
5490 @item -Wbool-operation
5491 @opindex Wno-bool-operation
5492 @opindex Wbool-operation
5493 Warn about suspicious operations on expressions of a boolean type.  For
5494 instance, bitwise negation of a boolean is very likely a bug in the program.
5495 For C, this warning also warns about incrementing or decrementing a boolean,
5496 which rarely makes sense.  (In C++, decrementing a boolean is always invalid.
5497 Incrementing a boolean is invalid in C++17, and deprecated otherwise.)
5499 This warning is enabled by @option{-Wall}.
5501 @item -Wduplicated-branches
5502 @opindex Wno-duplicated-branches
5503 @opindex Wduplicated-branches
5504 Warn when an if-else has identical branches.  This warning detects cases like
5505 @smallexample
5506 if (p != NULL)
5507   return 0;
5508 else
5509   return 0;
5510 @end smallexample
5511 It doesn't warn when both branches contain just a null statement.  This warning
5512 also warn for conditional operators:
5513 @smallexample
5514   int i = x ? *p : *p;
5515 @end smallexample
5517 @item -Wduplicated-cond
5518 @opindex Wno-duplicated-cond
5519 @opindex Wduplicated-cond
5520 Warn about duplicated conditions in an if-else-if chain.  For instance,
5521 warn for the following code:
5522 @smallexample
5523 if (p->q != NULL) @{ @dots{} @}
5524 else if (p->q != NULL) @{ @dots{} @}
5525 @end smallexample
5527 @item -Wframe-address
5528 @opindex Wno-frame-address
5529 @opindex Wframe-address
5530 Warn when the @samp{__builtin_frame_address} or @samp{__builtin_return_address}
5531 is called with an argument greater than 0.  Such calls may return indeterminate
5532 values or crash the program.  The warning is included in @option{-Wall}.
5534 @item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
5535 @opindex Wno-discarded-qualifiers
5536 @opindex Wdiscarded-qualifiers
5537 Do not warn if type qualifiers on pointers are being discarded.
5538 Typically, the compiler warns if a @code{const char *} variable is
5539 passed to a function that takes a @code{char *} parameter.  This option
5540 can be used to suppress such a warning.
5542 @item -Wno-discarded-array-qualifiers @r{(C and Objective-C only)}
5543 @opindex Wno-discarded-array-qualifiers
5544 @opindex Wdiscarded-array-qualifiers
5545 Do not warn if type qualifiers on arrays which are pointer targets
5546 are being discarded. Typically, the compiler warns if a
5547 @code{const int (*)[]} variable is passed to a function that
5548 takes a @code{int (*)[]} parameter.  This option can be used to
5549 suppress such a warning.
5551 @item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
5552 @opindex Wno-incompatible-pointer-types
5553 @opindex Wincompatible-pointer-types
5554 Do not warn when there is a conversion between pointers that have incompatible
5555 types.  This warning is for cases not covered by @option{-Wno-pointer-sign},
5556 which warns for pointer argument passing or assignment with different
5557 signedness.
5559 @item -Wno-int-conversion @r{(C and Objective-C only)}
5560 @opindex Wno-int-conversion
5561 @opindex Wint-conversion
5562 Do not warn about incompatible integer to pointer and pointer to integer
5563 conversions.  This warning is about implicit conversions; for explicit
5564 conversions the warnings @option{-Wno-int-to-pointer-cast} and
5565 @option{-Wno-pointer-to-int-cast} may be used.
5567 @item -Wno-div-by-zero
5568 @opindex Wno-div-by-zero
5569 @opindex Wdiv-by-zero
5570 Do not warn about compile-time integer division by zero.  Floating-point
5571 division by zero is not warned about, as it can be a legitimate way of
5572 obtaining infinities and NaNs.
5574 @item -Wsystem-headers
5575 @opindex Wsystem-headers
5576 @opindex Wno-system-headers
5577 @cindex warnings from system headers
5578 @cindex system headers, warnings from
5579 Print warning messages for constructs found in system header files.
5580 Warnings from system headers are normally suppressed, on the assumption
5581 that they usually do not indicate real problems and would only make the
5582 compiler output harder to read.  Using this command-line option tells
5583 GCC to emit warnings from system headers as if they occurred in user
5584 code.  However, note that using @option{-Wall} in conjunction with this
5585 option does @emph{not} warn about unknown pragmas in system
5586 headers---for that, @option{-Wunknown-pragmas} must also be used.
5588 @item -Wtautological-compare
5589 @opindex Wtautological-compare
5590 @opindex Wno-tautological-compare
5591 Warn if a self-comparison always evaluates to true or false.  This
5592 warning detects various mistakes such as:
5593 @smallexample
5594 int i = 1;
5595 @dots{}
5596 if (i > i) @{ @dots{} @}
5597 @end smallexample
5599 This warning also warns about bitwise comparisons that always evaluate
5600 to true or false, for instance:
5601 @smallexample
5602 if ((a & 16) == 10) @{ @dots{} @}
5603 @end smallexample
5604 will always be false.
5606 This warning is enabled by @option{-Wall}.
5608 @item -Wtrampolines
5609 @opindex Wtrampolines
5610 @opindex Wno-trampolines
5611 Warn about trampolines generated for pointers to nested functions.
5612 A trampoline is a small piece of data or code that is created at run
5613 time on the stack when the address of a nested function is taken, and is
5614 used to call the nested function indirectly.  For some targets, it is
5615 made up of data only and thus requires no special treatment.  But, for
5616 most targets, it is made up of code and thus requires the stack to be
5617 made executable in order for the program to work properly.
5619 @item -Wfloat-equal
5620 @opindex Wfloat-equal
5621 @opindex Wno-float-equal
5622 Warn if floating-point values are used in equality comparisons.
5624 The idea behind this is that sometimes it is convenient (for the
5625 programmer) to consider floating-point values as approximations to
5626 infinitely precise real numbers.  If you are doing this, then you need
5627 to compute (by analyzing the code, or in some other way) the maximum or
5628 likely maximum error that the computation introduces, and allow for it
5629 when performing comparisons (and when producing output, but that's a
5630 different problem).  In particular, instead of testing for equality, you
5631 should check to see whether the two values have ranges that overlap; and
5632 this is done with the relational operators, so equality comparisons are
5633 probably mistaken.
5635 @item -Wtraditional @r{(C and Objective-C only)}
5636 @opindex Wtraditional
5637 @opindex Wno-traditional
5638 Warn about certain constructs that behave differently in traditional and
5639 ISO C@.  Also warn about ISO C constructs that have no traditional C
5640 equivalent, and/or problematic constructs that should be avoided.
5642 @itemize @bullet
5643 @item
5644 Macro parameters that appear within string literals in the macro body.
5645 In traditional C macro replacement takes place within string literals,
5646 but in ISO C it does not.
5648 @item
5649 In traditional C, some preprocessor directives did not exist.
5650 Traditional preprocessors only considered a line to be a directive
5651 if the @samp{#} appeared in column 1 on the line.  Therefore
5652 @option{-Wtraditional} warns about directives that traditional C
5653 understands but ignores because the @samp{#} does not appear as the
5654 first character on the line.  It also suggests you hide directives like
5655 @code{#pragma} not understood by traditional C by indenting them.  Some
5656 traditional implementations do not recognize @code{#elif}, so this option
5657 suggests avoiding it altogether.
5659 @item
5660 A function-like macro that appears without arguments.
5662 @item
5663 The unary plus operator.
5665 @item
5666 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
5667 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
5668 constants.)  Note, these suffixes appear in macros defined in the system
5669 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
5670 Use of these macros in user code might normally lead to spurious
5671 warnings, however GCC's integrated preprocessor has enough context to
5672 avoid warning in these cases.
5674 @item
5675 A function declared external in one block and then used after the end of
5676 the block.
5678 @item
5679 A @code{switch} statement has an operand of type @code{long}.
5681 @item
5682 A non-@code{static} function declaration follows a @code{static} one.
5683 This construct is not accepted by some traditional C compilers.
5685 @item
5686 The ISO type of an integer constant has a different width or
5687 signedness from its traditional type.  This warning is only issued if
5688 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
5689 typically represent bit patterns, are not warned about.
5691 @item
5692 Usage of ISO string concatenation is detected.
5694 @item
5695 Initialization of automatic aggregates.
5697 @item
5698 Identifier conflicts with labels.  Traditional C lacks a separate
5699 namespace for labels.
5701 @item
5702 Initialization of unions.  If the initializer is zero, the warning is
5703 omitted.  This is done under the assumption that the zero initializer in
5704 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
5705 initializer warnings and relies on default initialization to zero in the
5706 traditional C case.
5708 @item
5709 Conversions by prototypes between fixed/floating-point values and vice
5710 versa.  The absence of these prototypes when compiling with traditional
5711 C causes serious problems.  This is a subset of the possible
5712 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
5714 @item
5715 Use of ISO C style function definitions.  This warning intentionally is
5716 @emph{not} issued for prototype declarations or variadic functions
5717 because these ISO C features appear in your code when using
5718 libiberty's traditional C compatibility macros, @code{PARAMS} and
5719 @code{VPARAMS}.  This warning is also bypassed for nested functions
5720 because that feature is already a GCC extension and thus not relevant to
5721 traditional C compatibility.
5722 @end itemize
5724 @item -Wtraditional-conversion @r{(C and Objective-C only)}
5725 @opindex Wtraditional-conversion
5726 @opindex Wno-traditional-conversion
5727 Warn if a prototype causes a type conversion that is different from what
5728 would happen to the same argument in the absence of a prototype.  This
5729 includes conversions of fixed point to floating and vice versa, and
5730 conversions changing the width or signedness of a fixed-point argument
5731 except when the same as the default promotion.
5733 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
5734 @opindex Wdeclaration-after-statement
5735 @opindex Wno-declaration-after-statement
5736 Warn when a declaration is found after a statement in a block.  This
5737 construct, known from C++, was introduced with ISO C99 and is by default
5738 allowed in GCC@.  It is not supported by ISO C90.  @xref{Mixed Declarations}.
5740 @item -Wshadow
5741 @opindex Wshadow
5742 @opindex Wno-shadow
5743 Warn whenever a local variable or type declaration shadows another
5744 variable, parameter, type, class member (in C++), or instance variable
5745 (in Objective-C) or whenever a built-in function is shadowed. Note
5746 that in C++, the compiler warns if a local variable shadows an
5747 explicit typedef, but not if it shadows a struct/class/enum.
5748 Same as @option{-Wshadow=global}.
5750 @item -Wno-shadow-ivar @r{(Objective-C only)}
5751 @opindex Wno-shadow-ivar
5752 @opindex Wshadow-ivar
5753 Do not warn whenever a local variable shadows an instance variable in an
5754 Objective-C method.
5756 @item -Wshadow=global
5757 @opindex Wshadow=local
5758 The default for @option{-Wshadow}. Warns for any (global) shadowing.
5760 @item -Wshadow=local
5761 @opindex Wshadow=local
5762 Warn when a local variable shadows another local variable or parameter.
5763 This warning is enabled by @option{-Wshadow=global}.
5765 @item -Wshadow=compatible-local
5766 @opindex Wshadow=compatible-local
5767 Warn when a local variable shadows another local variable or parameter
5768 whose type is compatible with that of the shadowing variable. In C++,
5769 type compatibility here means the type of the shadowing variable can be
5770 converted to that of the shadowed variable. The creation of this flag
5771 (in addition to @option{-Wshadow=local}) is based on the idea that when
5772 a local variable shadows another one of incompatible type, it is most
5773 likely intentional, not a bug or typo, as shown in the following example:
5775 @smallexample
5776 @group
5777 for (SomeIterator i = SomeObj.begin(); i != SomeObj.end(); ++i)
5779   for (int i = 0; i < N; ++i)
5780   @{
5781     ...
5782   @}
5783   ...
5785 @end group
5786 @end smallexample
5788 Since the two variable @code{i} in the example above have incompatible types,
5789 enabling only @option{-Wshadow=compatible-local} will not emit a warning.
5790 Because their types are incompatible, if a programmer accidentally uses one
5791 in place of the other, type checking will catch that and emit an error or
5792 warning. So not warning (about shadowing) in this case will not lead to
5793 undetected bugs. Use of this flag instead of @option{-Wshadow=local} can
5794 possibly reduce the number of warnings triggered by intentional shadowing.
5796 This warning is enabled by @option{-Wshadow=local}.
5798 @item -Wlarger-than=@var{len}
5799 @opindex Wlarger-than=@var{len}
5800 @opindex Wlarger-than-@var{len}
5801 Warn whenever an object of larger than @var{len} bytes is defined.
5803 @item -Wframe-larger-than=@var{len}
5804 @opindex Wframe-larger-than
5805 Warn if the size of a function frame is larger than @var{len} bytes.
5806 The computation done to determine the stack frame size is approximate
5807 and not conservative.
5808 The actual requirements may be somewhat greater than @var{len}
5809 even if you do not get a warning.  In addition, any space allocated
5810 via @code{alloca}, variable-length arrays, or related constructs
5811 is not included by the compiler when determining
5812 whether or not to issue a warning.
5814 @item -Wno-free-nonheap-object
5815 @opindex Wno-free-nonheap-object
5816 @opindex Wfree-nonheap-object
5817 Do not warn when attempting to free an object that was not allocated
5818 on the heap.
5820 @item -Wstack-usage=@var{len}
5821 @opindex Wstack-usage
5822 Warn if the stack usage of a function might be larger than @var{len} bytes.
5823 The computation done to determine the stack usage is conservative.
5824 Any space allocated via @code{alloca}, variable-length arrays, or related
5825 constructs is included by the compiler when determining whether or not to
5826 issue a warning.
5828 The message is in keeping with the output of @option{-fstack-usage}.
5830 @itemize
5831 @item
5832 If the stack usage is fully static but exceeds the specified amount, it's:
5834 @smallexample
5835   warning: stack usage is 1120 bytes
5836 @end smallexample
5837 @item
5838 If the stack usage is (partly) dynamic but bounded, it's:
5840 @smallexample
5841   warning: stack usage might be 1648 bytes
5842 @end smallexample
5843 @item
5844 If the stack usage is (partly) dynamic and not bounded, it's:
5846 @smallexample
5847   warning: stack usage might be unbounded
5848 @end smallexample
5849 @end itemize
5851 @item -Wunsafe-loop-optimizations
5852 @opindex Wunsafe-loop-optimizations
5853 @opindex Wno-unsafe-loop-optimizations
5854 Warn if the loop cannot be optimized because the compiler cannot
5855 assume anything on the bounds of the loop indices.  With
5856 @option{-funsafe-loop-optimizations} warn if the compiler makes
5857 such assumptions.
5859 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
5860 @opindex Wno-pedantic-ms-format
5861 @opindex Wpedantic-ms-format
5862 When used in combination with @option{-Wformat}
5863 and @option{-pedantic} without GNU extensions, this option
5864 disables the warnings about non-ISO @code{printf} / @code{scanf} format
5865 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
5866 which depend on the MS runtime.
5868 @item -Waligned-new
5869 @opindex Waligned-new
5870 @opindex Wno-aligned-new
5871 Warn about a new-expression of a type that requires greater alignment
5872 than the @code{alignof(std::max_align_t)} but uses an allocation
5873 function without an explicit alignment parameter. This option is
5874 enabled by @option{-Wall}.
5876 Normally this only warns about global allocation functions, but
5877 @option{-Waligned-new=all} also warns about class member allocation
5878 functions.
5880 @item -Wplacement-new
5881 @itemx -Wplacement-new=@var{n}
5882 @opindex Wplacement-new
5883 @opindex Wno-placement-new
5884 Warn about placement new expressions with undefined behavior, such as
5885 constructing an object in a buffer that is smaller than the type of
5886 the object.  For example, the placement new expression below is diagnosed
5887 because it attempts to construct an array of 64 integers in a buffer only
5888 64 bytes large.
5889 @smallexample
5890 char buf [64];
5891 new (buf) int[64];
5892 @end smallexample
5893 This warning is enabled by default.
5895 @table @gcctabopt
5896 @item -Wplacement-new=1
5897 This is the default warning level of @option{-Wplacement-new}.  At this
5898 level the warning is not issued for some strictly undefined constructs that
5899 GCC allows as extensions for compatibility with legacy code.  For example,
5900 the following @code{new} expression is not diagnosed at this level even
5901 though it has undefined behavior according to the C++ standard because
5902 it writes past the end of the one-element array.
5903 @smallexample
5904 struct S @{ int n, a[1]; @};
5905 S *s = (S *)malloc (sizeof *s + 31 * sizeof s->a[0]);
5906 new (s->a)int [32]();
5907 @end smallexample
5909 @item -Wplacement-new=2
5910 At this level, in addition to diagnosing all the same constructs as at level
5911 1, a diagnostic is also issued for placement new expressions that construct
5912 an object in the last member of structure whose type is an array of a single
5913 element and whose size is less than the size of the object being constructed.
5914 While the previous example would be diagnosed, the following construct makes
5915 use of the flexible member array extension to avoid the warning at level 2.
5916 @smallexample
5917 struct S @{ int n, a[]; @};
5918 S *s = (S *)malloc (sizeof *s + 32 * sizeof s->a[0]);
5919 new (s->a)int [32]();
5920 @end smallexample
5922 @end table
5924 @item -Wpointer-arith
5925 @opindex Wpointer-arith
5926 @opindex Wno-pointer-arith
5927 Warn about anything that depends on the ``size of'' a function type or
5928 of @code{void}.  GNU C assigns these types a size of 1, for
5929 convenience in calculations with @code{void *} pointers and pointers
5930 to functions.  In C++, warn also when an arithmetic operation involves
5931 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
5933 @item -Wpointer-compare
5934 @opindex Wpointer-compare
5935 @opindex Wno-pointer-compare
5936 Warn if a pointer is compared with a zero character constant.  This usually
5937 means that the pointer was meant to be dereferenced.  For example:
5939 @smallexample
5940 const char *p = foo ();
5941 if (p == '\0')
5942   return 42;
5943 @end smallexample
5945 Note that the code above is invalid in C++11.
5947 This warning is enabled by default.
5949 @item -Wtype-limits
5950 @opindex Wtype-limits
5951 @opindex Wno-type-limits
5952 Warn if a comparison is always true or always false due to the limited
5953 range of the data type, but do not warn for constant expressions.  For
5954 example, warn if an unsigned variable is compared against zero with
5955 @code{<} or @code{>=}.  This warning is also enabled by
5956 @option{-Wextra}.
5958 @include cppwarnopts.texi
5960 @item -Wbad-function-cast @r{(C and Objective-C only)}
5961 @opindex Wbad-function-cast
5962 @opindex Wno-bad-function-cast
5963 Warn when a function call is cast to a non-matching type.
5964 For example, warn if a call to a function returning an integer type 
5965 is cast to a pointer type.
5967 @item -Wc90-c99-compat @r{(C and Objective-C only)}
5968 @opindex Wc90-c99-compat
5969 @opindex Wno-c90-c99-compat
5970 Warn about features not present in ISO C90, but present in ISO C99.
5971 For instance, warn about use of variable length arrays, @code{long long}
5972 type, @code{bool} type, compound literals, designated initializers, and so
5973 on.  This option is independent of the standards mode.  Warnings are disabled
5974 in the expression that follows @code{__extension__}.
5976 @item -Wc99-c11-compat @r{(C and Objective-C only)}
5977 @opindex Wc99-c11-compat
5978 @opindex Wno-c99-c11-compat
5979 Warn about features not present in ISO C99, but present in ISO C11.
5980 For instance, warn about use of anonymous structures and unions,
5981 @code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier,
5982 @code{_Alignas} specifier, @code{Alignof} operator, @code{_Generic} keyword,
5983 and so on.  This option is independent of the standards mode.  Warnings are
5984 disabled in the expression that follows @code{__extension__}.
5986 @item -Wc++-compat @r{(C and Objective-C only)}
5987 @opindex Wc++-compat
5988 Warn about ISO C constructs that are outside of the common subset of
5989 ISO C and ISO C++, e.g.@: request for implicit conversion from
5990 @code{void *} to a pointer to non-@code{void} type.
5992 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
5993 @opindex Wc++11-compat
5994 Warn about C++ constructs whose meaning differs between ISO C++ 1998
5995 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
5996 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
5997 enabled by @option{-Wall}.
5999 @item -Wc++14-compat @r{(C++ and Objective-C++ only)}
6000 @opindex Wc++14-compat
6001 Warn about C++ constructs whose meaning differs between ISO C++ 2011
6002 and ISO C++ 2014.  This warning is enabled by @option{-Wall}.
6004 @item -Wc++17-compat @r{(C++ and Objective-C++ only)}
6005 @opindex Wc++17-compat
6006 Warn about C++ constructs whose meaning differs between ISO C++ 2014
6007 and ISO C++ 2017.  This warning is enabled by @option{-Wall}.
6009 @item -Wcast-qual
6010 @opindex Wcast-qual
6011 @opindex Wno-cast-qual
6012 Warn whenever a pointer is cast so as to remove a type qualifier from
6013 the target type.  For example, warn if a @code{const char *} is cast
6014 to an ordinary @code{char *}.
6016 Also warn when making a cast that introduces a type qualifier in an
6017 unsafe way.  For example, casting @code{char **} to @code{const char **}
6018 is unsafe, as in this example:
6020 @smallexample
6021   /* p is char ** value.  */
6022   const char **q = (const char **) p;
6023   /* Assignment of readonly string to const char * is OK.  */
6024   *q = "string";
6025   /* Now char** pointer points to read-only memory.  */
6026   **p = 'b';
6027 @end smallexample
6029 @item -Wcast-align
6030 @opindex Wcast-align
6031 @opindex Wno-cast-align
6032 Warn whenever a pointer is cast such that the required alignment of the
6033 target is increased.  For example, warn if a @code{char *} is cast to
6034 an @code{int *} on machines where integers can only be accessed at
6035 two- or four-byte boundaries.
6037 @item -Wcast-align=strict
6038 @opindex Wcast-align=strict
6039 Warn whenever a pointer is cast such that the required alignment of the
6040 target is increased.  For example, warn if a @code{char *} is cast to
6041 an @code{int *} regardless of the target machine.
6043 @item -Wwrite-strings
6044 @opindex Wwrite-strings
6045 @opindex Wno-write-strings
6046 When compiling C, give string constants the type @code{const
6047 char[@var{length}]} so that copying the address of one into a
6048 non-@code{const} @code{char *} pointer produces a warning.  These
6049 warnings help you find at compile time code that can try to write
6050 into a string constant, but only if you have been very careful about
6051 using @code{const} in declarations and prototypes.  Otherwise, it is
6052 just a nuisance. This is why we did not make @option{-Wall} request
6053 these warnings.
6055 When compiling C++, warn about the deprecated conversion from string
6056 literals to @code{char *}.  This warning is enabled by default for C++
6057 programs.
6059 @item -Wcatch-value
6060 @itemx -Wcatch-value=@var{n} @r{(C++ and Objective-C++ only)}
6061 @opindex Wcatch-value
6062 @opindex Wno-catch-value
6063 Warn about catch handlers that do not catch via reference.
6064 With @option{-Wcatch-value=1} (or @option{-Wcatch-value} for short)
6065 warn about polymorphic class types that are caught by value.
6066 With @option{-Wcatch-value=2} warn about all class types that are caught
6067 by value. With @option{-Wcatch-value=3} warn about all types that are
6068 not caught by reference. @option{-Wcatch-value} is enabled by @option{-Wall}.
6070 @item -Wclobbered
6071 @opindex Wclobbered
6072 @opindex Wno-clobbered
6073 Warn for variables that might be changed by @code{longjmp} or
6074 @code{vfork}.  This warning is also enabled by @option{-Wextra}.
6076 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
6077 @opindex Wconditionally-supported
6078 @opindex Wno-conditionally-supported
6079 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
6081 @item -Wconversion
6082 @opindex Wconversion
6083 @opindex Wno-conversion
6084 Warn for implicit conversions that may alter a value. This includes
6085 conversions between real and integer, like @code{abs (x)} when
6086 @code{x} is @code{double}; conversions between signed and unsigned,
6087 like @code{unsigned ui = -1}; and conversions to smaller types, like
6088 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
6089 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
6090 changed by the conversion like in @code{abs (2.0)}.  Warnings about
6091 conversions between signed and unsigned integers can be disabled by
6092 using @option{-Wno-sign-conversion}.
6094 For C++, also warn for confusing overload resolution for user-defined
6095 conversions; and conversions that never use a type conversion
6096 operator: conversions to @code{void}, the same type, a base class or a
6097 reference to them. Warnings about conversions between signed and
6098 unsigned integers are disabled by default in C++ unless
6099 @option{-Wsign-conversion} is explicitly enabled.
6101 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
6102 @opindex Wconversion-null
6103 @opindex Wno-conversion-null
6104 Do not warn for conversions between @code{NULL} and non-pointer
6105 types. @option{-Wconversion-null} is enabled by default.
6107 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
6108 @opindex Wzero-as-null-pointer-constant
6109 @opindex Wno-zero-as-null-pointer-constant
6110 Warn when a literal @samp{0} is used as null pointer constant.  This can
6111 be useful to facilitate the conversion to @code{nullptr} in C++11.
6113 @item -Wsubobject-linkage @r{(C++ and Objective-C++ only)}
6114 @opindex Wsubobject-linkage
6115 @opindex Wno-subobject-linkage
6116 Warn if a class type has a base or a field whose type uses the anonymous
6117 namespace or depends on a type with no linkage.  If a type A depends on
6118 a type B with no or internal linkage, defining it in multiple
6119 translation units would be an ODR violation because the meaning of B
6120 is different in each translation unit.  If A only appears in a single
6121 translation unit, the best way to silence the warning is to give it
6122 internal linkage by putting it in an anonymous namespace as well.  The
6123 compiler doesn't give this warning for types defined in the main .C
6124 file, as those are unlikely to have multiple definitions.
6125 @option{-Wsubobject-linkage} is enabled by default.
6127 @item -Wdangling-else
6128 @opindex Wdangling-else
6129 @opindex Wno-dangling-else
6130 Warn about constructions where there may be confusion to which
6131 @code{if} statement an @code{else} branch belongs.  Here is an example of
6132 such a case:
6134 @smallexample
6135 @group
6137   if (a)
6138     if (b)
6139       foo ();
6140   else
6141     bar ();
6143 @end group
6144 @end smallexample
6146 In C/C++, every @code{else} branch belongs to the innermost possible
6147 @code{if} statement, which in this example is @code{if (b)}.  This is
6148 often not what the programmer expected, as illustrated in the above
6149 example by indentation the programmer chose.  When there is the
6150 potential for this confusion, GCC issues a warning when this flag
6151 is specified.  To eliminate the warning, add explicit braces around
6152 the innermost @code{if} statement so there is no way the @code{else}
6153 can belong to the enclosing @code{if}.  The resulting code
6154 looks like this:
6156 @smallexample
6157 @group
6159   if (a)
6160     @{
6161       if (b)
6162         foo ();
6163       else
6164         bar ();
6165     @}
6167 @end group
6168 @end smallexample
6170 This warning is enabled by @option{-Wparentheses}.
6172 @item -Wdate-time
6173 @opindex Wdate-time
6174 @opindex Wno-date-time
6175 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
6176 are encountered as they might prevent bit-wise-identical reproducible
6177 compilations.
6179 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
6180 @opindex Wdelete-incomplete
6181 @opindex Wno-delete-incomplete
6182 Warn when deleting a pointer to incomplete type, which may cause
6183 undefined behavior at runtime.  This warning is enabled by default.
6185 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
6186 @opindex Wuseless-cast
6187 @opindex Wno-useless-cast
6188 Warn when an expression is casted to its own type.
6190 @item -Wempty-body
6191 @opindex Wempty-body
6192 @opindex Wno-empty-body
6193 Warn if an empty body occurs in an @code{if}, @code{else} or @code{do
6194 while} statement.  This warning is also enabled by @option{-Wextra}.
6196 @item -Wenum-compare
6197 @opindex Wenum-compare
6198 @opindex Wno-enum-compare
6199 Warn about a comparison between values of different enumerated types.
6200 In C++ enumerated type mismatches in conditional expressions are also
6201 diagnosed and the warning is enabled by default.  In C this warning is 
6202 enabled by @option{-Wall}.
6204 @item -Wextra-semi @r{(C++, Objective-C++ only)}
6205 @opindex Wextra-semi
6206 @opindex Wno-extra-semi
6207 Warn about redundant semicolon after in-class function definition.
6209 @item -Wjump-misses-init @r{(C, Objective-C only)}
6210 @opindex Wjump-misses-init
6211 @opindex Wno-jump-misses-init
6212 Warn if a @code{goto} statement or a @code{switch} statement jumps
6213 forward across the initialization of a variable, or jumps backward to a
6214 label after the variable has been initialized.  This only warns about
6215 variables that are initialized when they are declared.  This warning is
6216 only supported for C and Objective-C; in C++ this sort of branch is an
6217 error in any case.
6219 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
6220 can be disabled with the @option{-Wno-jump-misses-init} option.
6222 @item -Wsign-compare
6223 @opindex Wsign-compare
6224 @opindex Wno-sign-compare
6225 @cindex warning for comparison of signed and unsigned values
6226 @cindex comparison of signed and unsigned values, warning
6227 @cindex signed and unsigned values, comparison warning
6228 Warn when a comparison between signed and unsigned values could produce
6229 an incorrect result when the signed value is converted to unsigned.
6230 In C++, this warning is also enabled by @option{-Wall}.  In C, it is
6231 also enabled by @option{-Wextra}.
6233 @item -Wsign-conversion
6234 @opindex Wsign-conversion
6235 @opindex Wno-sign-conversion
6236 Warn for implicit conversions that may change the sign of an integer
6237 value, like assigning a signed integer expression to an unsigned
6238 integer variable. An explicit cast silences the warning. In C, this
6239 option is enabled also by @option{-Wconversion}.
6241 @item -Wfloat-conversion
6242 @opindex Wfloat-conversion
6243 @opindex Wno-float-conversion
6244 Warn for implicit conversions that reduce the precision of a real value.
6245 This includes conversions from real to integer, and from higher precision
6246 real to lower precision real values.  This option is also enabled by
6247 @option{-Wconversion}.
6249 @item -Wno-scalar-storage-order
6250 @opindex -Wno-scalar-storage-order
6251 @opindex -Wscalar-storage-order
6252 Do not warn on suspicious constructs involving reverse scalar storage order.
6254 @item -Wsized-deallocation @r{(C++ and Objective-C++ only)}
6255 @opindex Wsized-deallocation
6256 @opindex Wno-sized-deallocation
6257 Warn about a definition of an unsized deallocation function
6258 @smallexample
6259 void operator delete (void *) noexcept;
6260 void operator delete[] (void *) noexcept;
6261 @end smallexample
6262 without a definition of the corresponding sized deallocation function
6263 @smallexample
6264 void operator delete (void *, std::size_t) noexcept;
6265 void operator delete[] (void *, std::size_t) noexcept;
6266 @end smallexample
6267 or vice versa.  Enabled by @option{-Wextra} along with
6268 @option{-fsized-deallocation}.
6270 @item -Wsizeof-pointer-div
6271 @opindex Wsizeof-pointer-div
6272 @opindex Wno-sizeof-pointer-div
6273 Warn for suspicious divisions of two sizeof expressions that divide
6274 the pointer size by the element size, which is the usual way to compute
6275 the array size but won't work out correctly with pointers.  This warning
6276 warns e.g.@: about @code{sizeof (ptr) / sizeof (ptr[0])} if @code{ptr} is
6277 not an array, but a pointer.  This warning is enabled by @option{-Wall}.
6279 @item -Wsizeof-pointer-memaccess
6280 @opindex Wsizeof-pointer-memaccess
6281 @opindex Wno-sizeof-pointer-memaccess
6282 Warn for suspicious length parameters to certain string and memory built-in
6283 functions if the argument uses @code{sizeof}.  This warning triggers for
6284 example for @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not
6285 an array, but a pointer, and suggests a possible fix, or about
6286 @code{memcpy (&foo, ptr, sizeof (&foo));}.  @option{-Wsizeof-pointer-memaccess}
6287 also warns about calls to bounded string copy functions like @code{strncat}
6288 or @code{strncpy} that specify as the bound a @code{sizeof} expression of
6289 the source array.  For example, in the following function the call to
6290 @code{strncat} specifies the size of the source string as the bound.  That
6291 is almost certainly a mistake and so the call is diagnosed.
6292 @smallexample
6293 void make_file (const char *name)
6295   char path[PATH_MAX];
6296   strncpy (path, name, sizeof path - 1);
6297   strncat (path, ".text", sizeof ".text");
6298   @dots{}
6300 @end smallexample
6302 The @option{-Wsizeof-pointer-memaccess} option is enabled by @option{-Wall}.
6304 @item -Wsizeof-array-argument
6305 @opindex Wsizeof-array-argument
6306 @opindex Wno-sizeof-array-argument
6307 Warn when the @code{sizeof} operator is applied to a parameter that is
6308 declared as an array in a function definition.  This warning is enabled by
6309 default for C and C++ programs.
6311 @item -Wmemset-elt-size
6312 @opindex Wmemset-elt-size
6313 @opindex Wno-memset-elt-size
6314 Warn for suspicious calls to the @code{memset} built-in function, if the
6315 first argument references an array, and the third argument is a number
6316 equal to the number of elements, but not equal to the size of the array
6317 in memory.  This indicates that the user has omitted a multiplication by
6318 the element size.  This warning is enabled by @option{-Wall}.
6320 @item -Wmemset-transposed-args
6321 @opindex Wmemset-transposed-args
6322 @opindex Wno-memset-transposed-args
6323 Warn for suspicious calls to the @code{memset} built-in function, if the
6324 second argument is not zero and the third argument is zero.  This warns e.g.@
6325 about @code{memset (buf, sizeof buf, 0)} where most probably
6326 @code{memset (buf, 0, sizeof buf)} was meant instead.  The diagnostics
6327 is only emitted if the third argument is literal zero.  If it is some
6328 expression that is folded to zero, a cast of zero to some type, etc., 
6329 it is far less likely that the user has mistakenly exchanged the arguments 
6330 and no warning is emitted.  This warning is enabled by @option{-Wall}.
6332 @item -Waddress
6333 @opindex Waddress
6334 @opindex Wno-address
6335 Warn about suspicious uses of memory addresses. These include using
6336 the address of a function in a conditional expression, such as
6337 @code{void func(void); if (func)}, and comparisons against the memory
6338 address of a string literal, such as @code{if (x == "abc")}.  Such
6339 uses typically indicate a programmer error: the address of a function
6340 always evaluates to true, so their use in a conditional usually
6341 indicate that the programmer forgot the parentheses in a function
6342 call; and comparisons against string literals result in unspecified
6343 behavior and are not portable in C, so they usually indicate that the
6344 programmer intended to use @code{strcmp}.  This warning is enabled by
6345 @option{-Wall}.
6347 @item -Wlogical-op
6348 @opindex Wlogical-op
6349 @opindex Wno-logical-op
6350 Warn about suspicious uses of logical operators in expressions.
6351 This includes using logical operators in contexts where a
6352 bit-wise operator is likely to be expected.  Also warns when
6353 the operands of a logical operator are the same:
6354 @smallexample
6355 extern int a;
6356 if (a < 0 && a < 0) @{ @dots{} @}
6357 @end smallexample
6359 @item -Wlogical-not-parentheses
6360 @opindex Wlogical-not-parentheses
6361 @opindex Wno-logical-not-parentheses
6362 Warn about logical not used on the left hand side operand of a comparison.
6363 This option does not warn if the right operand is considered to be a boolean
6364 expression.  Its purpose is to detect suspicious code like the following:
6365 @smallexample
6366 int a;
6367 @dots{}
6368 if (!a > 1) @{ @dots{} @}
6369 @end smallexample
6371 It is possible to suppress the warning by wrapping the LHS into
6372 parentheses:
6373 @smallexample
6374 if ((!a) > 1) @{ @dots{} @}
6375 @end smallexample
6377 This warning is enabled by @option{-Wall}.
6379 @item -Waggregate-return
6380 @opindex Waggregate-return
6381 @opindex Wno-aggregate-return
6382 Warn if any functions that return structures or unions are defined or
6383 called.  (In languages where you can return an array, this also elicits
6384 a warning.)
6386 @item -Wno-aggressive-loop-optimizations
6387 @opindex Wno-aggressive-loop-optimizations
6388 @opindex Waggressive-loop-optimizations
6389 Warn if in a loop with constant number of iterations the compiler detects
6390 undefined behavior in some statement during one or more of the iterations.
6392 @item -Wno-attributes
6393 @opindex Wno-attributes
6394 @opindex Wattributes
6395 Do not warn if an unexpected @code{__attribute__} is used, such as
6396 unrecognized attributes, function attributes applied to variables,
6397 etc.  This does not stop errors for incorrect use of supported
6398 attributes.
6400 @item -Wno-builtin-declaration-mismatch
6401 @opindex Wno-builtin-declaration-mismatch
6402 @opindex Wbuiltin-declaration-mismatch
6403 Warn if a built-in function is declared with the wrong signature or 
6404 as non-function.
6405 This warning is enabled by default.
6407 @item -Wno-builtin-macro-redefined
6408 @opindex Wno-builtin-macro-redefined
6409 @opindex Wbuiltin-macro-redefined
6410 Do not warn if certain built-in macros are redefined.  This suppresses
6411 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
6412 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
6414 @item -Wstrict-prototypes @r{(C and Objective-C only)}
6415 @opindex Wstrict-prototypes
6416 @opindex Wno-strict-prototypes
6417 Warn if a function is declared or defined without specifying the
6418 argument types.  (An old-style function definition is permitted without
6419 a warning if preceded by a declaration that specifies the argument
6420 types.)
6422 @item -Wold-style-declaration @r{(C and Objective-C only)}
6423 @opindex Wold-style-declaration
6424 @opindex Wno-old-style-declaration
6425 Warn for obsolescent usages, according to the C Standard, in a
6426 declaration. For example, warn if storage-class specifiers like
6427 @code{static} are not the first things in a declaration.  This warning
6428 is also enabled by @option{-Wextra}.
6430 @item -Wold-style-definition @r{(C and Objective-C only)}
6431 @opindex Wold-style-definition
6432 @opindex Wno-old-style-definition
6433 Warn if an old-style function definition is used.  A warning is given
6434 even if there is a previous prototype.
6436 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
6437 @opindex Wmissing-parameter-type
6438 @opindex Wno-missing-parameter-type
6439 A function parameter is declared without a type specifier in K&R-style
6440 functions:
6442 @smallexample
6443 void foo(bar) @{ @}
6444 @end smallexample
6446 This warning is also enabled by @option{-Wextra}.
6448 @item -Wmissing-prototypes @r{(C and Objective-C only)}
6449 @opindex Wmissing-prototypes
6450 @opindex Wno-missing-prototypes
6451 Warn if a global function is defined without a previous prototype
6452 declaration.  This warning is issued even if the definition itself
6453 provides a prototype.  Use this option to detect global functions
6454 that do not have a matching prototype declaration in a header file.
6455 This option is not valid for C++ because all function declarations
6456 provide prototypes and a non-matching declaration declares an
6457 overload rather than conflict with an earlier declaration.
6458 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
6460 @item -Wmissing-declarations
6461 @opindex Wmissing-declarations
6462 @opindex Wno-missing-declarations
6463 Warn if a global function is defined without a previous declaration.
6464 Do so even if the definition itself provides a prototype.
6465 Use this option to detect global functions that are not declared in
6466 header files.  In C, no warnings are issued for functions with previous
6467 non-prototype declarations; use @option{-Wmissing-prototypes} to detect
6468 missing prototypes.  In C++, no warnings are issued for function templates,
6469 or for inline functions, or for functions in anonymous namespaces.
6471 @item -Wmissing-field-initializers
6472 @opindex Wmissing-field-initializers
6473 @opindex Wno-missing-field-initializers
6474 @opindex W
6475 @opindex Wextra
6476 @opindex Wno-extra
6477 Warn if a structure's initializer has some fields missing.  For
6478 example, the following code causes such a warning, because
6479 @code{x.h} is implicitly zero:
6481 @smallexample
6482 struct s @{ int f, g, h; @};
6483 struct s x = @{ 3, 4 @};
6484 @end smallexample
6486 This option does not warn about designated initializers, so the following
6487 modification does not trigger a warning:
6489 @smallexample
6490 struct s @{ int f, g, h; @};
6491 struct s x = @{ .f = 3, .g = 4 @};
6492 @end smallexample
6494 In C this option does not warn about the universal zero initializer
6495 @samp{@{ 0 @}}:
6497 @smallexample
6498 struct s @{ int f, g, h; @};
6499 struct s x = @{ 0 @};
6500 @end smallexample
6502 Likewise, in C++ this option does not warn about the empty @{ @}
6503 initializer, for example:
6505 @smallexample
6506 struct s @{ int f, g, h; @};
6507 s x = @{ @};
6508 @end smallexample
6510 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
6511 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
6513 @item -Wno-multichar
6514 @opindex Wno-multichar
6515 @opindex Wmultichar
6516 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
6517 Usually they indicate a typo in the user's code, as they have
6518 implementation-defined values, and should not be used in portable code.
6520 @item -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]}
6521 @opindex Wnormalized=
6522 @opindex Wnormalized
6523 @opindex Wno-normalized
6524 @cindex NFC
6525 @cindex NFKC
6526 @cindex character set, input normalization
6527 In ISO C and ISO C++, two identifiers are different if they are
6528 different sequences of characters.  However, sometimes when characters
6529 outside the basic ASCII character set are used, you can have two
6530 different character sequences that look the same.  To avoid confusion,
6531 the ISO 10646 standard sets out some @dfn{normalization rules} which
6532 when applied ensure that two sequences that look the same are turned into
6533 the same sequence.  GCC can warn you if you are using identifiers that
6534 have not been normalized; this option controls that warning.
6536 There are four levels of warning supported by GCC@.  The default is
6537 @option{-Wnormalized=nfc}, which warns about any identifier that is
6538 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
6539 recommended form for most uses.  It is equivalent to
6540 @option{-Wnormalized}.
6542 Unfortunately, there are some characters allowed in identifiers by
6543 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
6544 identifiers.  That is, there's no way to use these symbols in portable
6545 ISO C or C++ and have all your identifiers in NFC@.
6546 @option{-Wnormalized=id} suppresses the warning for these characters.
6547 It is hoped that future versions of the standards involved will correct
6548 this, which is why this option is not the default.
6550 You can switch the warning off for all characters by writing
6551 @option{-Wnormalized=none} or @option{-Wno-normalized}.  You should
6552 only do this if you are using some other normalization scheme (like
6553 ``D''), because otherwise you can easily create bugs that are
6554 literally impossible to see.
6556 Some characters in ISO 10646 have distinct meanings but look identical
6557 in some fonts or display methodologies, especially once formatting has
6558 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
6559 LETTER N'', displays just like a regular @code{n} that has been
6560 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
6561 normalization scheme to convert all these into a standard form as
6562 well, and GCC warns if your code is not in NFKC if you use
6563 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
6564 about every identifier that contains the letter O because it might be
6565 confused with the digit 0, and so is not the default, but may be
6566 useful as a local coding convention if the programming environment 
6567 cannot be fixed to display these characters distinctly.
6569 @item -Wno-deprecated
6570 @opindex Wno-deprecated
6571 @opindex Wdeprecated
6572 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
6574 @item -Wno-deprecated-declarations
6575 @opindex Wno-deprecated-declarations
6576 @opindex Wdeprecated-declarations
6577 Do not warn about uses of functions (@pxref{Function Attributes}),
6578 variables (@pxref{Variable Attributes}), and types (@pxref{Type
6579 Attributes}) marked as deprecated by using the @code{deprecated}
6580 attribute.
6582 @item -Wno-overflow
6583 @opindex Wno-overflow
6584 @opindex Woverflow
6585 Do not warn about compile-time overflow in constant expressions.
6587 @item -Wno-odr
6588 @opindex Wno-odr
6589 @opindex Wodr
6590 Warn about One Definition Rule violations during link-time optimization.
6591 Requires @option{-flto-odr-type-merging} to be enabled.  Enabled by default.
6593 @item -Wopenmp-simd
6594 @opindex Wopenm-simd
6595 Warn if the vectorizer cost model overrides the OpenMP or the Cilk Plus
6596 simd directive set by user.  The @option{-fsimd-cost-model=unlimited}
6597 option can be used to relax the cost model.
6599 @item -Woverride-init @r{(C and Objective-C only)}
6600 @opindex Woverride-init
6601 @opindex Wno-override-init
6602 @opindex W
6603 @opindex Wextra
6604 @opindex Wno-extra
6605 Warn if an initialized field without side effects is overridden when
6606 using designated initializers (@pxref{Designated Inits, , Designated
6607 Initializers}).
6609 This warning is included in @option{-Wextra}.  To get other
6610 @option{-Wextra} warnings without this one, use @option{-Wextra
6611 -Wno-override-init}.
6613 @item -Woverride-init-side-effects @r{(C and Objective-C only)}
6614 @opindex Woverride-init-side-effects
6615 @opindex Wno-override-init-side-effects
6616 Warn if an initialized field with side effects is overridden when
6617 using designated initializers (@pxref{Designated Inits, , Designated
6618 Initializers}).  This warning is enabled by default.
6620 @item -Wpacked
6621 @opindex Wpacked
6622 @opindex Wno-packed
6623 Warn if a structure is given the packed attribute, but the packed
6624 attribute has no effect on the layout or size of the structure.
6625 Such structures may be mis-aligned for little benefit.  For
6626 instance, in this code, the variable @code{f.x} in @code{struct bar}
6627 is misaligned even though @code{struct bar} does not itself
6628 have the packed attribute:
6630 @smallexample
6631 @group
6632 struct foo @{
6633   int x;
6634   char a, b, c, d;
6635 @} __attribute__((packed));
6636 struct bar @{
6637   char z;
6638   struct foo f;
6640 @end group
6641 @end smallexample
6643 @item -Wpacked-bitfield-compat
6644 @opindex Wpacked-bitfield-compat
6645 @opindex Wno-packed-bitfield-compat
6646 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
6647 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
6648 the change can lead to differences in the structure layout.  GCC
6649 informs you when the offset of such a field has changed in GCC 4.4.
6650 For example there is no longer a 4-bit padding between field @code{a}
6651 and @code{b} in this structure:
6653 @smallexample
6654 struct foo
6656   char a:4;
6657   char b:8;
6658 @} __attribute__ ((packed));
6659 @end smallexample
6661 This warning is enabled by default.  Use
6662 @option{-Wno-packed-bitfield-compat} to disable this warning.
6664 @item -Wpacked-not-aligned @r{(C, C++, Objective-C and Objective-C++ only)}
6665 @opindex Wpacked-not-aligned
6666 @opindex Wno-packed-not-aligned
6667 Warn if a structure field with explicitly specified alignment in a
6668 packed struct or union is misaligned.  For example, a warning will
6669 be issued on @code{struct S}, like, @code{warning: alignment 1 of
6670 'struct S' is less than 8}, in this code:
6672 @smallexample
6673 @group
6674 struct __attribute__ ((aligned (8))) S8 @{ char a[8]; @};
6675 struct __attribute__ ((packed)) S @{
6676   struct S8 s8;
6678 @end group
6679 @end smallexample
6681 This warning is enabled by @option{-Wall}.
6683 @item -Wpadded
6684 @opindex Wpadded
6685 @opindex Wno-padded
6686 Warn if padding is included in a structure, either to align an element
6687 of the structure or to align the whole structure.  Sometimes when this
6688 happens it is possible to rearrange the fields of the structure to
6689 reduce the padding and so make the structure smaller.
6691 @item -Wredundant-decls
6692 @opindex Wredundant-decls
6693 @opindex Wno-redundant-decls
6694 Warn if anything is declared more than once in the same scope, even in
6695 cases where multiple declaration is valid and changes nothing.
6697 @item -Wrestrict
6698 @opindex Wrestrict
6699 @opindex Wno-restrict
6700 Warn when an argument passed to a restrict-qualified parameter
6701 aliases with another argument.
6703 @item -Wnested-externs @r{(C and Objective-C only)}
6704 @opindex Wnested-externs
6705 @opindex Wno-nested-externs
6706 Warn if an @code{extern} declaration is encountered within a function.
6708 @item -Wno-inherited-variadic-ctor
6709 @opindex Winherited-variadic-ctor
6710 @opindex Wno-inherited-variadic-ctor
6711 Suppress warnings about use of C++11 inheriting constructors when the
6712 base class inherited from has a C variadic constructor; the warning is
6713 on by default because the ellipsis is not inherited.
6715 @item -Winline
6716 @opindex Winline
6717 @opindex Wno-inline
6718 Warn if a function that is declared as inline cannot be inlined.
6719 Even with this option, the compiler does not warn about failures to
6720 inline functions declared in system headers.
6722 The compiler uses a variety of heuristics to determine whether or not
6723 to inline a function.  For example, the compiler takes into account
6724 the size of the function being inlined and the amount of inlining
6725 that has already been done in the current function.  Therefore,
6726 seemingly insignificant changes in the source program can cause the
6727 warnings produced by @option{-Winline} to appear or disappear.
6729 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
6730 @opindex Wno-invalid-offsetof
6731 @opindex Winvalid-offsetof
6732 Suppress warnings from applying the @code{offsetof} macro to a non-POD
6733 type.  According to the 2014 ISO C++ standard, applying @code{offsetof}
6734 to a non-standard-layout type is undefined.  In existing C++ implementations,
6735 however, @code{offsetof} typically gives meaningful results.
6736 This flag is for users who are aware that they are
6737 writing nonportable code and who have deliberately chosen to ignore the
6738 warning about it.
6740 The restrictions on @code{offsetof} may be relaxed in a future version
6741 of the C++ standard.
6743 @item -Wint-in-bool-context
6744 @opindex Wint-in-bool-context
6745 @opindex Wno-int-in-bool-context
6746 Warn for suspicious use of integer values where boolean values are expected,
6747 such as conditional expressions (?:) using non-boolean integer constants in
6748 boolean context, like @code{if (a <= b ? 2 : 3)}.  Or left shifting of signed
6749 integers in boolean context, like @code{for (a = 0; 1 << a; a++);}.  Likewise
6750 for all kinds of multiplications regardless of the data type.
6751 This warning is enabled by @option{-Wall}.
6753 @item -Wno-int-to-pointer-cast
6754 @opindex Wno-int-to-pointer-cast
6755 @opindex Wint-to-pointer-cast
6756 Suppress warnings from casts to pointer type of an integer of a
6757 different size. In C++, casting to a pointer type of smaller size is
6758 an error. @option{Wint-to-pointer-cast} is enabled by default.
6761 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
6762 @opindex Wno-pointer-to-int-cast
6763 @opindex Wpointer-to-int-cast
6764 Suppress warnings from casts from a pointer to an integer type of a
6765 different size.
6767 @item -Winvalid-pch
6768 @opindex Winvalid-pch
6769 @opindex Wno-invalid-pch
6770 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
6771 the search path but cannot be used.
6773 @item -Wlong-long
6774 @opindex Wlong-long
6775 @opindex Wno-long-long
6776 Warn if @code{long long} type is used.  This is enabled by either
6777 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
6778 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
6780 @item -Wvariadic-macros
6781 @opindex Wvariadic-macros
6782 @opindex Wno-variadic-macros
6783 Warn if variadic macros are used in ISO C90 mode, or if the GNU
6784 alternate syntax is used in ISO C99 mode.  This is enabled by either
6785 @option{-Wpedantic} or @option{-Wtraditional}.  To inhibit the warning
6786 messages, use @option{-Wno-variadic-macros}.
6788 @item -Wvarargs
6789 @opindex Wvarargs
6790 @opindex Wno-varargs
6791 Warn upon questionable usage of the macros used to handle variable
6792 arguments like @code{va_start}.  This is default.  To inhibit the
6793 warning messages, use @option{-Wno-varargs}.
6795 @item -Wvector-operation-performance
6796 @opindex Wvector-operation-performance
6797 @opindex Wno-vector-operation-performance
6798 Warn if vector operation is not implemented via SIMD capabilities of the
6799 architecture.  Mainly useful for the performance tuning.
6800 Vector operation can be implemented @code{piecewise}, which means that the
6801 scalar operation is performed on every vector element; 
6802 @code{in parallel}, which means that the vector operation is implemented
6803 using scalars of wider type, which normally is more performance efficient;
6804 and @code{as a single scalar}, which means that vector fits into a
6805 scalar type.
6807 @item -Wno-virtual-move-assign
6808 @opindex Wvirtual-move-assign
6809 @opindex Wno-virtual-move-assign
6810 Suppress warnings about inheriting from a virtual base with a
6811 non-trivial C++11 move assignment operator.  This is dangerous because
6812 if the virtual base is reachable along more than one path, it is
6813 moved multiple times, which can mean both objects end up in the
6814 moved-from state.  If the move assignment operator is written to avoid
6815 moving from a moved-from object, this warning can be disabled.
6817 @item -Wvla
6818 @opindex Wvla
6819 @opindex Wno-vla
6820 Warn if a variable-length array is used in the code.
6821 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
6822 the variable-length array.
6824 @item -Wvla-larger-than=@var{n}
6825 If this option is used, the compiler will warn on uses of
6826 variable-length arrays where the size is either unbounded, or bounded
6827 by an argument that can be larger than @var{n} bytes.  This is similar
6828 to how @option{-Walloca-larger-than=@var{n}} works, but with
6829 variable-length arrays.
6831 Note that GCC may optimize small variable-length arrays of a known
6832 value into plain arrays, so this warning may not get triggered for
6833 such arrays.
6835 This warning is not enabled by @option{-Wall}, and is only active when
6836 @option{-ftree-vrp} is active (default for @option{-O2} and above).
6838 See also @option{-Walloca-larger-than=@var{n}}.
6840 @item -Wvolatile-register-var
6841 @opindex Wvolatile-register-var
6842 @opindex Wno-volatile-register-var
6843 Warn if a register variable is declared volatile.  The volatile
6844 modifier does not inhibit all optimizations that may eliminate reads
6845 and/or writes to register variables.  This warning is enabled by
6846 @option{-Wall}.
6848 @item -Wdisabled-optimization
6849 @opindex Wdisabled-optimization
6850 @opindex Wno-disabled-optimization
6851 Warn if a requested optimization pass is disabled.  This warning does
6852 not generally indicate that there is anything wrong with your code; it
6853 merely indicates that GCC's optimizers are unable to handle the code
6854 effectively.  Often, the problem is that your code is too big or too
6855 complex; GCC refuses to optimize programs when the optimization
6856 itself is likely to take inordinate amounts of time.
6858 @item -Wpointer-sign @r{(C and Objective-C only)}
6859 @opindex Wpointer-sign
6860 @opindex Wno-pointer-sign
6861 Warn for pointer argument passing or assignment with different signedness.
6862 This option is only supported for C and Objective-C@.  It is implied by
6863 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
6864 @option{-Wno-pointer-sign}.
6866 @item -Wstack-protector
6867 @opindex Wstack-protector
6868 @opindex Wno-stack-protector
6869 This option is only active when @option{-fstack-protector} is active.  It
6870 warns about functions that are not protected against stack smashing.
6872 @item -Woverlength-strings
6873 @opindex Woverlength-strings
6874 @opindex Wno-overlength-strings
6875 Warn about string constants that are longer than the ``minimum
6876 maximum'' length specified in the C standard.  Modern compilers
6877 generally allow string constants that are much longer than the
6878 standard's minimum limit, but very portable programs should avoid
6879 using longer strings.
6881 The limit applies @emph{after} string constant concatenation, and does
6882 not count the trailing NUL@.  In C90, the limit was 509 characters; in
6883 C99, it was raised to 4095.  C++98 does not specify a normative
6884 minimum maximum, so we do not diagnose overlength strings in C++@.
6886 This option is implied by @option{-Wpedantic}, and can be disabled with
6887 @option{-Wno-overlength-strings}.
6889 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
6890 @opindex Wunsuffixed-float-constants
6892 Issue a warning for any floating constant that does not have
6893 a suffix.  When used together with @option{-Wsystem-headers} it
6894 warns about such constants in system header files.  This can be useful
6895 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
6896 from the decimal floating-point extension to C99.
6898 @item -Wno-designated-init @r{(C and Objective-C only)}
6899 Suppress warnings when a positional initializer is used to initialize
6900 a structure that has been marked with the @code{designated_init}
6901 attribute.
6903 @item -Whsa
6904 Issue a warning when HSAIL cannot be emitted for the compiled function or
6905 OpenMP construct.
6907 @end table
6909 @node Debugging Options
6910 @section Options for Debugging Your Program
6911 @cindex options, debugging
6912 @cindex debugging information options
6914 To tell GCC to emit extra information for use by a debugger, in almost 
6915 all cases you need only to add @option{-g} to your other options.
6917 GCC allows you to use @option{-g} with
6918 @option{-O}.  The shortcuts taken by optimized code may occasionally
6919 be surprising: some variables you declared may not exist
6920 at all; flow of control may briefly move where you did not expect it;
6921 some statements may not be executed because they compute constant
6922 results or their values are already at hand; some statements may
6923 execute in different places because they have been moved out of loops.
6924 Nevertheless it is possible to debug optimized output.  This makes
6925 it reasonable to use the optimizer for programs that might have bugs.
6927 If you are not using some other optimization option, consider
6928 using @option{-Og} (@pxref{Optimize Options}) with @option{-g}.  
6929 With no @option{-O} option at all, some compiler passes that collect
6930 information useful for debugging do not run at all, so that
6931 @option{-Og} may result in a better debugging experience.
6933 @table @gcctabopt
6934 @item -g
6935 @opindex g
6936 Produce debugging information in the operating system's native format
6937 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
6938 information.
6940 On most systems that use stabs format, @option{-g} enables use of extra
6941 debugging information that only GDB can use; this extra information
6942 makes debugging work better in GDB but probably makes other debuggers
6943 crash or
6944 refuse to read the program.  If you want to control for certain whether
6945 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
6946 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
6948 @item -ggdb
6949 @opindex ggdb
6950 Produce debugging information for use by GDB@.  This means to use the
6951 most expressive format available (DWARF, stabs, or the native format
6952 if neither of those are supported), including GDB extensions if at all
6953 possible.
6955 @item -gdwarf
6956 @itemx -gdwarf-@var{version}
6957 @opindex gdwarf
6958 Produce debugging information in DWARF format (if that is supported).
6959 The value of @var{version} may be either 2, 3, 4 or 5; the default version
6960 for most targets is 4.  DWARF Version 5 is only experimental.
6962 Note that with DWARF Version 2, some ports require and always
6963 use some non-conflicting DWARF 3 extensions in the unwind tables.
6965 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
6966 for maximum benefit.
6968 GCC no longer supports DWARF Version 1, which is substantially
6969 different than Version 2 and later.  For historical reasons, some
6970 other DWARF-related options such as
6971 @option{-fno-dwarf2-cfi-asm}) retain a reference to DWARF Version 2
6972 in their names, but apply to all currently-supported versions of DWARF.
6974 @item -gstabs
6975 @opindex gstabs
6976 Produce debugging information in stabs format (if that is supported),
6977 without GDB extensions.  This is the format used by DBX on most BSD
6978 systems.  On MIPS, Alpha and System V Release 4 systems this option
6979 produces stabs debugging output that is not understood by DBX@.
6980 On System V Release 4 systems this option requires the GNU assembler.
6982 @item -gstabs+
6983 @opindex gstabs+
6984 Produce debugging information in stabs format (if that is supported),
6985 using GNU extensions understood only by the GNU debugger (GDB)@.  The
6986 use of these extensions is likely to make other debuggers crash or
6987 refuse to read the program.
6989 @item -gxcoff
6990 @opindex gxcoff
6991 Produce debugging information in XCOFF format (if that is supported).
6992 This is the format used by the DBX debugger on IBM RS/6000 systems.
6994 @item -gxcoff+
6995 @opindex gxcoff+
6996 Produce debugging information in XCOFF format (if that is supported),
6997 using GNU extensions understood only by the GNU debugger (GDB)@.  The
6998 use of these extensions is likely to make other debuggers crash or
6999 refuse to read the program, and may cause assemblers other than the GNU
7000 assembler (GAS) to fail with an error.
7002 @item -gvms
7003 @opindex gvms
7004 Produce debugging information in Alpha/VMS debug format (if that is
7005 supported).  This is the format used by DEBUG on Alpha/VMS systems.
7007 @item -g@var{level}
7008 @itemx -ggdb@var{level}
7009 @itemx -gstabs@var{level}
7010 @itemx -gxcoff@var{level}
7011 @itemx -gvms@var{level}
7012 Request debugging information and also use @var{level} to specify how
7013 much information.  The default level is 2.
7015 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
7016 @option{-g}.
7018 Level 1 produces minimal information, enough for making backtraces in
7019 parts of the program that you don't plan to debug.  This includes
7020 descriptions of functions and external variables, and line number
7021 tables, but no information about local variables.
7023 Level 3 includes extra information, such as all the macro definitions
7024 present in the program.  Some debuggers support macro expansion when
7025 you use @option{-g3}.
7027 @option{-gdwarf} does not accept a concatenated debug level, to avoid
7028 confusion with @option{-gdwarf-@var{level}}.
7029 Instead use an additional @option{-g@var{level}} option to change the
7030 debug level for DWARF.
7032 @item -feliminate-unused-debug-symbols
7033 @opindex feliminate-unused-debug-symbols
7034 Produce debugging information in stabs format (if that is supported),
7035 for only symbols that are actually used.
7037 @item -femit-class-debug-always
7038 @opindex femit-class-debug-always
7039 Instead of emitting debugging information for a C++ class in only one
7040 object file, emit it in all object files using the class.  This option
7041 should be used only with debuggers that are unable to handle the way GCC
7042 normally emits debugging information for classes because using this
7043 option increases the size of debugging information by as much as a
7044 factor of two.
7046 @item -fno-merge-debug-strings
7047 @opindex fmerge-debug-strings
7048 @opindex fno-merge-debug-strings
7049 Direct the linker to not merge together strings in the debugging
7050 information that are identical in different object files.  Merging is
7051 not supported by all assemblers or linkers.  Merging decreases the size
7052 of the debug information in the output file at the cost of increasing
7053 link processing time.  Merging is enabled by default.
7055 @item -fdebug-prefix-map=@var{old}=@var{new}
7056 @opindex fdebug-prefix-map
7057 When compiling files in directory @file{@var{old}}, record debugging
7058 information describing them as in @file{@var{new}} instead.  This can be
7059 used to replace a build-time path with an install-time path in the debug info.
7060 It can also be used to change an absolute path to a relative path by using
7061 @file{.} for @var{new}.  This can give more reproducible builds, which are
7062 location independent, but may require an extra command to tell GDB where to
7063 find the source files.
7065 @item -fvar-tracking
7066 @opindex fvar-tracking
7067 Run variable tracking pass.  It computes where variables are stored at each
7068 position in code.  Better debugging information is then generated
7069 (if the debugging information format supports this information).
7071 It is enabled by default when compiling with optimization (@option{-Os},
7072 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
7073 the debug info format supports it.
7075 @item -fvar-tracking-assignments
7076 @opindex fvar-tracking-assignments
7077 @opindex fno-var-tracking-assignments
7078 Annotate assignments to user variables early in the compilation and
7079 attempt to carry the annotations over throughout the compilation all the
7080 way to the end, in an attempt to improve debug information while
7081 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
7083 It can be enabled even if var-tracking is disabled, in which case
7084 annotations are created and maintained, but discarded at the end.
7085 By default, this flag is enabled together with @option{-fvar-tracking},
7086 except when selective scheduling is enabled.
7088 @item -gsplit-dwarf
7089 @opindex gsplit-dwarf
7090 Separate as much DWARF debugging information as possible into a
7091 separate output file with the extension @file{.dwo}.  This option allows
7092 the build system to avoid linking files with debug information.  To
7093 be useful, this option requires a debugger capable of reading @file{.dwo}
7094 files.
7096 @item -gpubnames
7097 @opindex gpubnames
7098 Generate DWARF @code{.debug_pubnames} and @code{.debug_pubtypes} sections.
7100 @item -ggnu-pubnames
7101 @opindex ggnu-pubnames
7102 Generate @code{.debug_pubnames} and @code{.debug_pubtypes} sections in a format
7103 suitable for conversion into a GDB@ index.  This option is only useful
7104 with a linker that can produce GDB@ index version 7.
7106 @item -fdebug-types-section
7107 @opindex fdebug-types-section
7108 @opindex fno-debug-types-section
7109 When using DWARF Version 4 or higher, type DIEs can be put into
7110 their own @code{.debug_types} section instead of making them part of the
7111 @code{.debug_info} section.  It is more efficient to put them in a separate
7112 comdat sections since the linker can then remove duplicates.
7113 But not all DWARF consumers support @code{.debug_types} sections yet
7114 and on some objects @code{.debug_types} produces larger instead of smaller
7115 debugging information.
7117 @item -grecord-gcc-switches
7118 @item -gno-record-gcc-switches
7119 @opindex grecord-gcc-switches
7120 @opindex gno-record-gcc-switches
7121 This switch causes the command-line options used to invoke the
7122 compiler that may affect code generation to be appended to the
7123 DW_AT_producer attribute in DWARF debugging information.  The options
7124 are concatenated with spaces separating them from each other and from
7125 the compiler version.  
7126 It is enabled by default.
7127 See also @option{-frecord-gcc-switches} for another
7128 way of storing compiler options into the object file.  
7130 @item -gstrict-dwarf
7131 @opindex gstrict-dwarf
7132 Disallow using extensions of later DWARF standard version than selected
7133 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
7134 DWARF extensions from later standard versions is allowed.
7136 @item -gno-strict-dwarf
7137 @opindex gno-strict-dwarf
7138 Allow using extensions of later DWARF standard version than selected with
7139 @option{-gdwarf-@var{version}}.
7141 @item -gcolumn-info
7142 @item -gno-column-info
7143 @opindex gcolumn-info
7144 @opindex gno-column-info
7145 Emit location column information into DWARF debugging information, rather
7146 than just file and line.
7147 This option is enabled by default.
7149 @item -gz@r{[}=@var{type}@r{]}
7150 @opindex gz
7151 Produce compressed debug sections in DWARF format, if that is supported.
7152 If @var{type} is not given, the default type depends on the capabilities
7153 of the assembler and linker used.  @var{type} may be one of
7154 @samp{none} (don't compress debug sections), @samp{zlib} (use zlib
7155 compression in ELF gABI format), or @samp{zlib-gnu} (use zlib
7156 compression in traditional GNU format).  If the linker doesn't support
7157 writing compressed debug sections, the option is rejected.  Otherwise,
7158 if the assembler does not support them, @option{-gz} is silently ignored
7159 when producing object files.
7161 @item -femit-struct-debug-baseonly
7162 @opindex femit-struct-debug-baseonly
7163 Emit debug information for struct-like types
7164 only when the base name of the compilation source file
7165 matches the base name of file in which the struct is defined.
7167 This option substantially reduces the size of debugging information,
7168 but at significant potential loss in type information to the debugger.
7169 See @option{-femit-struct-debug-reduced} for a less aggressive option.
7170 See @option{-femit-struct-debug-detailed} for more detailed control.
7172 This option works only with DWARF debug output.
7174 @item -femit-struct-debug-reduced
7175 @opindex femit-struct-debug-reduced
7176 Emit debug information for struct-like types
7177 only when the base name of the compilation source file
7178 matches the base name of file in which the type is defined,
7179 unless the struct is a template or defined in a system header.
7181 This option significantly reduces the size of debugging information,
7182 with some potential loss in type information to the debugger.
7183 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
7184 See @option{-femit-struct-debug-detailed} for more detailed control.
7186 This option works only with DWARF debug output.
7188 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
7189 @opindex femit-struct-debug-detailed
7190 Specify the struct-like types
7191 for which the compiler generates debug information.
7192 The intent is to reduce duplicate struct debug information
7193 between different object files within the same program.
7195 This option is a detailed version of
7196 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
7197 which serves for most needs.
7199 A specification has the syntax@*
7200 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
7202 The optional first word limits the specification to
7203 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
7204 A struct type is used directly when it is the type of a variable, member.
7205 Indirect uses arise through pointers to structs.
7206 That is, when use of an incomplete struct is valid, the use is indirect.
7207 An example is
7208 @samp{struct one direct; struct two * indirect;}.
7210 The optional second word limits the specification to
7211 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
7212 Generic structs are a bit complicated to explain.
7213 For C++, these are non-explicit specializations of template classes,
7214 or non-template classes within the above.
7215 Other programming languages have generics,
7216 but @option{-femit-struct-debug-detailed} does not yet implement them.
7218 The third word specifies the source files for those
7219 structs for which the compiler should emit debug information.
7220 The values @samp{none} and @samp{any} have the normal meaning.
7221 The value @samp{base} means that
7222 the base of name of the file in which the type declaration appears
7223 must match the base of the name of the main compilation file.
7224 In practice, this means that when compiling @file{foo.c}, debug information
7225 is generated for types declared in that file and @file{foo.h},
7226 but not other header files.
7227 The value @samp{sys} means those types satisfying @samp{base}
7228 or declared in system or compiler headers.
7230 You may need to experiment to determine the best settings for your application.
7232 The default is @option{-femit-struct-debug-detailed=all}.
7234 This option works only with DWARF debug output.
7236 @item -fno-dwarf2-cfi-asm
7237 @opindex fdwarf2-cfi-asm
7238 @opindex fno-dwarf2-cfi-asm
7239 Emit DWARF unwind info as compiler generated @code{.eh_frame} section
7240 instead of using GAS @code{.cfi_*} directives.
7242 @item -fno-eliminate-unused-debug-types
7243 @opindex feliminate-unused-debug-types
7244 @opindex fno-eliminate-unused-debug-types
7245 Normally, when producing DWARF output, GCC avoids producing debug symbol 
7246 output for types that are nowhere used in the source file being compiled.
7247 Sometimes it is useful to have GCC emit debugging
7248 information for all types declared in a compilation
7249 unit, regardless of whether or not they are actually used
7250 in that compilation unit, for example 
7251 if, in the debugger, you want to cast a value to a type that is
7252 not actually used in your program (but is declared).  More often,
7253 however, this results in a significant amount of wasted space.
7254 @end table
7256 @node Optimize Options
7257 @section Options That Control Optimization
7258 @cindex optimize options
7259 @cindex options, optimization
7261 These options control various sorts of optimizations.
7263 Without any optimization option, the compiler's goal is to reduce the
7264 cost of compilation and to make debugging produce the expected
7265 results.  Statements are independent: if you stop the program with a
7266 breakpoint between statements, you can then assign a new value to any
7267 variable or change the program counter to any other statement in the
7268 function and get exactly the results you expect from the source
7269 code.
7271 Turning on optimization flags makes the compiler attempt to improve
7272 the performance and/or code size at the expense of compilation time
7273 and possibly the ability to debug the program.
7275 The compiler performs optimization based on the knowledge it has of the
7276 program.  Compiling multiple files at once to a single output file mode allows
7277 the compiler to use information gained from all of the files when compiling
7278 each of them.
7280 Not all optimizations are controlled directly by a flag.  Only
7281 optimizations that have a flag are listed in this section.
7283 Most optimizations are only enabled if an @option{-O} level is set on
7284 the command line.  Otherwise they are disabled, even if individual
7285 optimization flags are specified.
7287 Depending on the target and how GCC was configured, a slightly different
7288 set of optimizations may be enabled at each @option{-O} level than
7289 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
7290 to find out the exact set of optimizations that are enabled at each level.
7291 @xref{Overall Options}, for examples.
7293 @table @gcctabopt
7294 @item -O
7295 @itemx -O1
7296 @opindex O
7297 @opindex O1
7298 Optimize.  Optimizing compilation takes somewhat more time, and a lot
7299 more memory for a large function.
7301 With @option{-O}, the compiler tries to reduce code size and execution
7302 time, without performing any optimizations that take a great deal of
7303 compilation time.
7305 @option{-O} turns on the following optimization flags:
7306 @gccoptlist{
7307 -fauto-inc-dec @gol
7308 -fbranch-count-reg @gol
7309 -fcombine-stack-adjustments @gol
7310 -fcompare-elim @gol
7311 -fcprop-registers @gol
7312 -fdce @gol
7313 -fdefer-pop @gol
7314 -fdelayed-branch @gol
7315 -fdse @gol
7316 -fforward-propagate @gol
7317 -fguess-branch-probability @gol
7318 -fif-conversion2 @gol
7319 -fif-conversion @gol
7320 -finline-functions-called-once @gol
7321 -fipa-pure-const @gol
7322 -fipa-profile @gol
7323 -fipa-reference @gol
7324 -fmerge-constants @gol
7325 -fmove-loop-invariants @gol
7326 -fomit-frame-pointer @gol
7327 -freorder-blocks @gol
7328 -fshrink-wrap @gol
7329 -fshrink-wrap-separate @gol
7330 -fsplit-wide-types @gol
7331 -fssa-backprop @gol
7332 -fssa-phiopt @gol
7333 -ftree-bit-ccp @gol
7334 -ftree-ccp @gol
7335 -ftree-ch @gol
7336 -ftree-coalesce-vars @gol
7337 -ftree-copy-prop @gol
7338 -ftree-dce @gol
7339 -ftree-dominator-opts @gol
7340 -ftree-dse @gol
7341 -ftree-forwprop @gol
7342 -ftree-fre @gol
7343 -ftree-phiprop @gol
7344 -ftree-sink @gol
7345 -ftree-slsr @gol
7346 -ftree-sra @gol
7347 -ftree-pta @gol
7348 -ftree-ter @gol
7349 -funit-at-a-time}
7351 @item -O2
7352 @opindex O2
7353 Optimize even more.  GCC performs nearly all supported optimizations
7354 that do not involve a space-speed tradeoff.
7355 As compared to @option{-O}, this option increases both compilation time
7356 and the performance of the generated code.
7358 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
7359 also turns on the following optimization flags:
7360 @gccoptlist{-fthread-jumps @gol
7361 -falign-functions  -falign-jumps @gol
7362 -falign-loops  -falign-labels @gol
7363 -fcaller-saves @gol
7364 -fcrossjumping @gol
7365 -fcse-follow-jumps  -fcse-skip-blocks @gol
7366 -fdelete-null-pointer-checks @gol
7367 -fdevirtualize -fdevirtualize-speculatively @gol
7368 -fexpensive-optimizations @gol
7369 -fgcse  -fgcse-lm  @gol
7370 -fhoist-adjacent-loads @gol
7371 -finline-small-functions @gol
7372 -findirect-inlining @gol
7373 -fipa-cp @gol
7374 -fipa-bit-cp @gol
7375 -fipa-vrp @gol
7376 -fipa-sra @gol
7377 -fipa-icf @gol
7378 -fisolate-erroneous-paths-dereference @gol
7379 -flra-remat @gol
7380 -foptimize-sibling-calls @gol
7381 -foptimize-strlen @gol
7382 -fpartial-inlining @gol
7383 -fpeephole2 @gol
7384 -freorder-blocks-algorithm=stc @gol
7385 -freorder-blocks-and-partition -freorder-functions @gol
7386 -frerun-cse-after-loop  @gol
7387 -fsched-interblock  -fsched-spec @gol
7388 -fschedule-insns  -fschedule-insns2 @gol
7389 -fstore-merging @gol
7390 -fstrict-aliasing @gol
7391 -ftree-builtin-call-dce @gol
7392 -ftree-switch-conversion -ftree-tail-merge @gol
7393 -fcode-hoisting @gol
7394 -ftree-pre @gol
7395 -ftree-vrp @gol
7396 -fipa-ra}
7398 Please note the warning under @option{-fgcse} about
7399 invoking @option{-O2} on programs that use computed gotos.
7401 @item -O3
7402 @opindex O3
7403 Optimize yet more.  @option{-O3} turns on all optimizations specified
7404 by @option{-O2} and also turns on the following optimization flags:
7405 @gccoptlist{-finline-functions @gol
7406 -funswitch-loops @gol
7407 -fpredictive-commoning @gol
7408 -fgcse-after-reload @gol
7409 -ftree-loop-vectorize @gol
7410 -ftree-loop-distribution @gol
7411 -ftree-loop-distribute-patterns @gol
7412 -floop-interchange @gol
7413 -fsplit-paths @gol
7414 -ftree-slp-vectorize @gol
7415 -fvect-cost-model @gol
7416 -ftree-partial-pre @gol
7417 -fpeel-loops @gol
7418 -fipa-cp-clone}
7420 @item -O0
7421 @opindex O0
7422 Reduce compilation time and make debugging produce the expected
7423 results.  This is the default.
7425 @item -Os
7426 @opindex Os
7427 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
7428 do not typically increase code size.  It also performs further
7429 optimizations designed to reduce code size.
7431 @option{-Os} disables the following optimization flags:
7432 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
7433 -falign-labels  -freorder-blocks  -freorder-blocks-algorithm=stc @gol
7434 -freorder-blocks-and-partition  -fprefetch-loop-arrays}
7436 @item -Ofast
7437 @opindex Ofast
7438 Disregard strict standards compliance.  @option{-Ofast} enables all
7439 @option{-O3} optimizations.  It also enables optimizations that are not
7440 valid for all standard-compliant programs.
7441 It turns on @option{-ffast-math} and the Fortran-specific
7442 @option{-fstack-arrays}, unless @option{-fmax-stack-var-size} is
7443 specified, and @option{-fno-protect-parens}.
7445 @item -Og
7446 @opindex Og
7447 Optimize debugging experience.  @option{-Og} enables optimizations
7448 that do not interfere with debugging. It should be the optimization
7449 level of choice for the standard edit-compile-debug cycle, offering
7450 a reasonable level of optimization while maintaining fast compilation
7451 and a good debugging experience.
7452 @end table
7454 If you use multiple @option{-O} options, with or without level numbers,
7455 the last such option is the one that is effective.
7457 Options of the form @option{-f@var{flag}} specify machine-independent
7458 flags.  Most flags have both positive and negative forms; the negative
7459 form of @option{-ffoo} is @option{-fno-foo}.  In the table
7460 below, only one of the forms is listed---the one you typically 
7461 use.  You can figure out the other form by either removing @samp{no-}
7462 or adding it.
7464 The following options control specific optimizations.  They are either
7465 activated by @option{-O} options or are related to ones that are.  You
7466 can use the following flags in the rare cases when ``fine-tuning'' of
7467 optimizations to be performed is desired.
7469 @table @gcctabopt
7470 @item -fno-defer-pop
7471 @opindex fno-defer-pop
7472 Always pop the arguments to each function call as soon as that function
7473 returns.  For machines that must pop arguments after a function call,
7474 the compiler normally lets arguments accumulate on the stack for several
7475 function calls and pops them all at once.
7477 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7479 @item -fforward-propagate
7480 @opindex fforward-propagate
7481 Perform a forward propagation pass on RTL@.  The pass tries to combine two
7482 instructions and checks if the result can be simplified.  If loop unrolling
7483 is active, two passes are performed and the second is scheduled after
7484 loop unrolling.
7486 This option is enabled by default at optimization levels @option{-O},
7487 @option{-O2}, @option{-O3}, @option{-Os}.
7489 @item -ffp-contract=@var{style}
7490 @opindex ffp-contract
7491 @option{-ffp-contract=off} disables floating-point expression contraction.
7492 @option{-ffp-contract=fast} enables floating-point expression contraction
7493 such as forming of fused multiply-add operations if the target has
7494 native support for them.
7495 @option{-ffp-contract=on} enables floating-point expression contraction
7496 if allowed by the language standard.  This is currently not implemented
7497 and treated equal to @option{-ffp-contract=off}.
7499 The default is @option{-ffp-contract=fast}.
7501 @item -fomit-frame-pointer
7502 @opindex fomit-frame-pointer
7503 Omit the frame pointer in functions that don't need one.  This avoids the
7504 instructions to save, set up and restore the frame pointer; on many targets
7505 it also makes an extra register available.
7507 On some targets this flag has no effect because the standard calling sequence
7508 always uses a frame pointer, so it cannot be omitted.
7510 Note that @option{-fno-omit-frame-pointer} doesn't guarantee the frame pointer
7511 is used in all functions.  Several targets always omit the frame pointer in
7512 leaf functions.
7514 Enabled by default at @option{-O} and higher.
7516 @item -foptimize-sibling-calls
7517 @opindex foptimize-sibling-calls
7518 Optimize sibling and tail recursive calls.
7520 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7522 @item -foptimize-strlen
7523 @opindex foptimize-strlen
7524 Optimize various standard C string functions (e.g. @code{strlen},
7525 @code{strchr} or @code{strcpy}) and
7526 their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
7528 Enabled at levels @option{-O2}, @option{-O3}.
7530 @item -fno-inline
7531 @opindex fno-inline
7532 Do not expand any functions inline apart from those marked with
7533 the @code{always_inline} attribute.  This is the default when not
7534 optimizing.
7536 Single functions can be exempted from inlining by marking them
7537 with the @code{noinline} attribute.
7539 @item -finline-small-functions
7540 @opindex finline-small-functions
7541 Integrate functions into their callers when their body is smaller than expected
7542 function call code (so overall size of program gets smaller).  The compiler
7543 heuristically decides which functions are simple enough to be worth integrating
7544 in this way.  This inlining applies to all functions, even those not declared
7545 inline.
7547 Enabled at level @option{-O2}.
7549 @item -findirect-inlining
7550 @opindex findirect-inlining
7551 Inline also indirect calls that are discovered to be known at compile
7552 time thanks to previous inlining.  This option has any effect only
7553 when inlining itself is turned on by the @option{-finline-functions}
7554 or @option{-finline-small-functions} options.
7556 Enabled at level @option{-O2}.
7558 @item -finline-functions
7559 @opindex finline-functions
7560 Consider all functions for inlining, even if they are not declared inline.
7561 The compiler heuristically decides which functions are worth integrating
7562 in this way.
7564 If all calls to a given function are integrated, and the function is
7565 declared @code{static}, then the function is normally not output as
7566 assembler code in its own right.
7568 Enabled at level @option{-O3}.
7570 @item -finline-functions-called-once
7571 @opindex finline-functions-called-once
7572 Consider all @code{static} functions called once for inlining into their
7573 caller even if they are not marked @code{inline}.  If a call to a given
7574 function is integrated, then the function is not output as assembler code
7575 in its own right.
7577 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
7579 @item -fearly-inlining
7580 @opindex fearly-inlining
7581 Inline functions marked by @code{always_inline} and functions whose body seems
7582 smaller than the function call overhead early before doing
7583 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
7584 makes profiling significantly cheaper and usually inlining faster on programs
7585 having large chains of nested wrapper functions.
7587 Enabled by default.
7589 @item -fipa-sra
7590 @opindex fipa-sra
7591 Perform interprocedural scalar replacement of aggregates, removal of
7592 unused parameters and replacement of parameters passed by reference
7593 by parameters passed by value.
7595 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
7597 @item -finline-limit=@var{n}
7598 @opindex finline-limit
7599 By default, GCC limits the size of functions that can be inlined.  This flag
7600 allows coarse control of this limit.  @var{n} is the size of functions that
7601 can be inlined in number of pseudo instructions.
7603 Inlining is actually controlled by a number of parameters, which may be
7604 specified individually by using @option{--param @var{name}=@var{value}}.
7605 The @option{-finline-limit=@var{n}} option sets some of these parameters
7606 as follows:
7608 @table @gcctabopt
7609 @item max-inline-insns-single
7610 is set to @var{n}/2.
7611 @item max-inline-insns-auto
7612 is set to @var{n}/2.
7613 @end table
7615 See below for a documentation of the individual
7616 parameters controlling inlining and for the defaults of these parameters.
7618 @emph{Note:} there may be no value to @option{-finline-limit} that results
7619 in default behavior.
7621 @emph{Note:} pseudo instruction represents, in this particular context, an
7622 abstract measurement of function's size.  In no way does it represent a count
7623 of assembly instructions and as such its exact meaning might change from one
7624 release to an another.
7626 @item -fno-keep-inline-dllexport
7627 @opindex fno-keep-inline-dllexport
7628 This is a more fine-grained version of @option{-fkeep-inline-functions},
7629 which applies only to functions that are declared using the @code{dllexport}
7630 attribute or declspec.  @xref{Function Attributes,,Declaring Attributes of
7631 Functions}.
7633 @item -fkeep-inline-functions
7634 @opindex fkeep-inline-functions
7635 In C, emit @code{static} functions that are declared @code{inline}
7636 into the object file, even if the function has been inlined into all
7637 of its callers.  This switch does not affect functions using the
7638 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
7639 inline functions into the object file.
7641 @item -fkeep-static-functions
7642 @opindex fkeep-static-functions
7643 Emit @code{static} functions into the object file, even if the function
7644 is never used.
7646 @item -fkeep-static-consts
7647 @opindex fkeep-static-consts
7648 Emit variables declared @code{static const} when optimization isn't turned
7649 on, even if the variables aren't referenced.
7651 GCC enables this option by default.  If you want to force the compiler to
7652 check if a variable is referenced, regardless of whether or not
7653 optimization is turned on, use the @option{-fno-keep-static-consts} option.
7655 @item -fmerge-constants
7656 @opindex fmerge-constants
7657 Attempt to merge identical constants (string constants and floating-point
7658 constants) across compilation units.
7660 This option is the default for optimized compilation if the assembler and
7661 linker support it.  Use @option{-fno-merge-constants} to inhibit this
7662 behavior.
7664 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7666 @item -fmerge-all-constants
7667 @opindex fmerge-all-constants
7668 Attempt to merge identical constants and identical variables.
7670 This option implies @option{-fmerge-constants}.  In addition to
7671 @option{-fmerge-constants} this considers e.g.@: even constant initialized
7672 arrays or initialized constant variables with integral or floating-point
7673 types.  Languages like C or C++ require each variable, including multiple
7674 instances of the same variable in recursive calls, to have distinct locations,
7675 so using this option results in non-conforming
7676 behavior.
7678 @item -fmodulo-sched
7679 @opindex fmodulo-sched
7680 Perform swing modulo scheduling immediately before the first scheduling
7681 pass.  This pass looks at innermost loops and reorders their
7682 instructions by overlapping different iterations.
7684 @item -fmodulo-sched-allow-regmoves
7685 @opindex fmodulo-sched-allow-regmoves
7686 Perform more aggressive SMS-based modulo scheduling with register moves
7687 allowed.  By setting this flag certain anti-dependences edges are
7688 deleted, which triggers the generation of reg-moves based on the
7689 life-range analysis.  This option is effective only with
7690 @option{-fmodulo-sched} enabled.
7692 @item -fno-branch-count-reg
7693 @opindex fno-branch-count-reg
7694 Avoid running a pass scanning for opportunities to use ``decrement and
7695 branch'' instructions on a count register instead of generating sequences
7696 of instructions that decrement a register, compare it against zero, and
7697 then branch based upon the result.  This option is only meaningful on
7698 architectures that support such instructions, which include x86, PowerPC,
7699 IA-64 and S/390.  Note that the @option{-fno-branch-count-reg} option
7700 doesn't remove the decrement and branch instructions from the generated
7701 instruction stream introduced by other optimization passes.
7703 Enabled by default at @option{-O1} and higher.
7705 The default is @option{-fbranch-count-reg}.
7707 @item -fno-function-cse
7708 @opindex fno-function-cse
7709 Do not put function addresses in registers; make each instruction that
7710 calls a constant function contain the function's address explicitly.
7712 This option results in less efficient code, but some strange hacks
7713 that alter the assembler output may be confused by the optimizations
7714 performed when this option is not used.
7716 The default is @option{-ffunction-cse}
7718 @item -fno-zero-initialized-in-bss
7719 @opindex fno-zero-initialized-in-bss
7720 If the target supports a BSS section, GCC by default puts variables that
7721 are initialized to zero into BSS@.  This can save space in the resulting
7722 code.
7724 This option turns off this behavior because some programs explicitly
7725 rely on variables going to the data section---e.g., so that the
7726 resulting executable can find the beginning of that section and/or make
7727 assumptions based on that.
7729 The default is @option{-fzero-initialized-in-bss}.
7731 @item -fthread-jumps
7732 @opindex fthread-jumps
7733 Perform optimizations that check to see if a jump branches to a
7734 location where another comparison subsumed by the first is found.  If
7735 so, the first branch is redirected to either the destination of the
7736 second branch or a point immediately following it, depending on whether
7737 the condition is known to be true or false.
7739 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7741 @item -fsplit-wide-types
7742 @opindex fsplit-wide-types
7743 When using a type that occupies multiple registers, such as @code{long
7744 long} on a 32-bit system, split the registers apart and allocate them
7745 independently.  This normally generates better code for those types,
7746 but may make debugging more difficult.
7748 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
7749 @option{-Os}.
7751 @item -fcse-follow-jumps
7752 @opindex fcse-follow-jumps
7753 In common subexpression elimination (CSE), scan through jump instructions
7754 when the target of the jump is not reached by any other path.  For
7755 example, when CSE encounters an @code{if} statement with an
7756 @code{else} clause, CSE follows the jump when the condition
7757 tested is false.
7759 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7761 @item -fcse-skip-blocks
7762 @opindex fcse-skip-blocks
7763 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
7764 follow jumps that conditionally skip over blocks.  When CSE
7765 encounters a simple @code{if} statement with no else clause,
7766 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
7767 body of the @code{if}.
7769 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7771 @item -frerun-cse-after-loop
7772 @opindex frerun-cse-after-loop
7773 Re-run common subexpression elimination after loop optimizations are
7774 performed.
7776 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7778 @item -fgcse
7779 @opindex fgcse
7780 Perform a global common subexpression elimination pass.
7781 This pass also performs global constant and copy propagation.
7783 @emph{Note:} When compiling a program using computed gotos, a GCC
7784 extension, you may get better run-time performance if you disable
7785 the global common subexpression elimination pass by adding
7786 @option{-fno-gcse} to the command line.
7788 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7790 @item -fgcse-lm
7791 @opindex fgcse-lm
7792 When @option{-fgcse-lm} is enabled, global common subexpression elimination
7793 attempts to move loads that are only killed by stores into themselves.  This
7794 allows a loop containing a load/store sequence to be changed to a load outside
7795 the loop, and a copy/store within the loop.
7797 Enabled by default when @option{-fgcse} is enabled.
7799 @item -fgcse-sm
7800 @opindex fgcse-sm
7801 When @option{-fgcse-sm} is enabled, a store motion pass is run after
7802 global common subexpression elimination.  This pass attempts to move
7803 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
7804 loops containing a load/store sequence can be changed to a load before
7805 the loop and a store after the loop.
7807 Not enabled at any optimization level.
7809 @item -fgcse-las
7810 @opindex fgcse-las
7811 When @option{-fgcse-las} is enabled, the global common subexpression
7812 elimination pass eliminates redundant loads that come after stores to the
7813 same memory location (both partial and full redundancies).
7815 Not enabled at any optimization level.
7817 @item -fgcse-after-reload
7818 @opindex fgcse-after-reload
7819 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
7820 pass is performed after reload.  The purpose of this pass is to clean up
7821 redundant spilling.
7823 @item -faggressive-loop-optimizations
7824 @opindex faggressive-loop-optimizations
7825 This option tells the loop optimizer to use language constraints to
7826 derive bounds for the number of iterations of a loop.  This assumes that
7827 loop code does not invoke undefined behavior by for example causing signed
7828 integer overflows or out-of-bound array accesses.  The bounds for the
7829 number of iterations of a loop are used to guide loop unrolling and peeling
7830 and loop exit test optimizations.
7831 This option is enabled by default.
7833 @item -funconstrained-commons
7834 @opindex funconstrained-commons
7835 This option tells the compiler that variables declared in common blocks
7836 (e.g. Fortran) may later be overridden with longer trailing arrays. This
7837 prevents certain optimizations that depend on knowing the array bounds.
7839 @item -fcrossjumping
7840 @opindex fcrossjumping
7841 Perform cross-jumping transformation.
7842 This transformation unifies equivalent code and saves code size.  The
7843 resulting code may or may not perform better than without cross-jumping.
7845 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7847 @item -fauto-inc-dec
7848 @opindex fauto-inc-dec
7849 Combine increments or decrements of addresses with memory accesses.
7850 This pass is always skipped on architectures that do not have
7851 instructions to support this.  Enabled by default at @option{-O} and
7852 higher on architectures that support this.
7854 @item -fdce
7855 @opindex fdce
7856 Perform dead code elimination (DCE) on RTL@.
7857 Enabled by default at @option{-O} and higher.
7859 @item -fdse
7860 @opindex fdse
7861 Perform dead store elimination (DSE) on RTL@.
7862 Enabled by default at @option{-O} and higher.
7864 @item -fif-conversion
7865 @opindex fif-conversion
7866 Attempt to transform conditional jumps into branch-less equivalents.  This
7867 includes use of conditional moves, min, max, set flags and abs instructions, and
7868 some tricks doable by standard arithmetics.  The use of conditional execution
7869 on chips where it is available is controlled by @option{-fif-conversion2}.
7871 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7873 @item -fif-conversion2
7874 @opindex fif-conversion2
7875 Use conditional execution (where available) to transform conditional jumps into
7876 branch-less equivalents.
7878 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7880 @item -fdeclone-ctor-dtor
7881 @opindex fdeclone-ctor-dtor
7882 The C++ ABI requires multiple entry points for constructors and
7883 destructors: one for a base subobject, one for a complete object, and
7884 one for a virtual destructor that calls operator delete afterwards.
7885 For a hierarchy with virtual bases, the base and complete variants are
7886 clones, which means two copies of the function.  With this option, the
7887 base and complete variants are changed to be thunks that call a common
7888 implementation.
7890 Enabled by @option{-Os}.
7892 @item -fdelete-null-pointer-checks
7893 @opindex fdelete-null-pointer-checks
7894 Assume that programs cannot safely dereference null pointers, and that
7895 no code or data element resides at address zero.
7896 This option enables simple constant
7897 folding optimizations at all optimization levels.  In addition, other
7898 optimization passes in GCC use this flag to control global dataflow
7899 analyses that eliminate useless checks for null pointers; these assume
7900 that a memory access to address zero always results in a trap, so
7901 that if a pointer is checked after it has already been dereferenced,
7902 it cannot be null.
7904 Note however that in some environments this assumption is not true.
7905 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
7906 for programs that depend on that behavior.
7908 This option is enabled by default on most targets.  On Nios II ELF, it
7909 defaults to off.  On AVR, CR16, and MSP430, this option is completely disabled.
7911 Passes that use the dataflow information
7912 are enabled independently at different optimization levels.
7914 @item -fdevirtualize
7915 @opindex fdevirtualize
7916 Attempt to convert calls to virtual functions to direct calls.  This
7917 is done both within a procedure and interprocedurally as part of
7918 indirect inlining (@option{-findirect-inlining}) and interprocedural constant
7919 propagation (@option{-fipa-cp}).
7920 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7922 @item -fdevirtualize-speculatively
7923 @opindex fdevirtualize-speculatively
7924 Attempt to convert calls to virtual functions to speculative direct calls.
7925 Based on the analysis of the type inheritance graph, determine for a given call
7926 the set of likely targets. If the set is small, preferably of size 1, change
7927 the call into a conditional deciding between direct and indirect calls.  The
7928 speculative calls enable more optimizations, such as inlining.  When they seem
7929 useless after further optimization, they are converted back into original form.
7931 @item -fdevirtualize-at-ltrans
7932 @opindex fdevirtualize-at-ltrans
7933 Stream extra information needed for aggressive devirtualization when running
7934 the link-time optimizer in local transformation mode.  
7935 This option enables more devirtualization but
7936 significantly increases the size of streamed data. For this reason it is
7937 disabled by default.
7939 @item -fexpensive-optimizations
7940 @opindex fexpensive-optimizations
7941 Perform a number of minor optimizations that are relatively expensive.
7943 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7945 @item -free
7946 @opindex free
7947 Attempt to remove redundant extension instructions.  This is especially
7948 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
7949 registers after writing to their lower 32-bit half.
7951 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
7952 @option{-O3}, @option{-Os}.
7954 @item -fno-lifetime-dse
7955 @opindex fno-lifetime-dse
7956 In C++ the value of an object is only affected by changes within its
7957 lifetime: when the constructor begins, the object has an indeterminate
7958 value, and any changes during the lifetime of the object are dead when
7959 the object is destroyed.  Normally dead store elimination will take
7960 advantage of this; if your code relies on the value of the object
7961 storage persisting beyond the lifetime of the object, you can use this
7962 flag to disable this optimization.  To preserve stores before the
7963 constructor starts (e.g. because your operator new clears the object
7964 storage) but still treat the object as dead after the destructor you,
7965 can use @option{-flifetime-dse=1}.  The default behavior can be
7966 explicitly selected with @option{-flifetime-dse=2}.
7967 @option{-flifetime-dse=0} is equivalent to @option{-fno-lifetime-dse}.
7969 @item -flive-range-shrinkage
7970 @opindex flive-range-shrinkage
7971 Attempt to decrease register pressure through register live range
7972 shrinkage.  This is helpful for fast processors with small or moderate
7973 size register sets.
7975 @item -fira-algorithm=@var{algorithm}
7976 @opindex fira-algorithm
7977 Use the specified coloring algorithm for the integrated register
7978 allocator.  The @var{algorithm} argument can be @samp{priority}, which
7979 specifies Chow's priority coloring, or @samp{CB}, which specifies
7980 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
7981 for all architectures, but for those targets that do support it, it is
7982 the default because it generates better code.
7984 @item -fira-region=@var{region}
7985 @opindex fira-region
7986 Use specified regions for the integrated register allocator.  The
7987 @var{region} argument should be one of the following:
7989 @table @samp
7991 @item all
7992 Use all loops as register allocation regions.
7993 This can give the best results for machines with a small and/or
7994 irregular register set.
7996 @item mixed
7997 Use all loops except for loops with small register pressure 
7998 as the regions.  This value usually gives
7999 the best results in most cases and for most architectures,
8000 and is enabled by default when compiling with optimization for speed
8001 (@option{-O}, @option{-O2}, @dots{}).
8003 @item one
8004 Use all functions as a single region.  
8005 This typically results in the smallest code size, and is enabled by default for
8006 @option{-Os} or @option{-O0}.
8008 @end table
8010 @item -fira-hoist-pressure
8011 @opindex fira-hoist-pressure
8012 Use IRA to evaluate register pressure in the code hoisting pass for
8013 decisions to hoist expressions.  This option usually results in smaller
8014 code, but it can slow the compiler down.
8016 This option is enabled at level @option{-Os} for all targets.
8018 @item -fira-loop-pressure
8019 @opindex fira-loop-pressure
8020 Use IRA to evaluate register pressure in loops for decisions to move
8021 loop invariants.  This option usually results in generation
8022 of faster and smaller code on machines with large register files (>= 32
8023 registers), but it can slow the compiler down.
8025 This option is enabled at level @option{-O3} for some targets.
8027 @item -fno-ira-share-save-slots
8028 @opindex fno-ira-share-save-slots
8029 Disable sharing of stack slots used for saving call-used hard
8030 registers living through a call.  Each hard register gets a
8031 separate stack slot, and as a result function stack frames are
8032 larger.
8034 @item -fno-ira-share-spill-slots
8035 @opindex fno-ira-share-spill-slots
8036 Disable sharing of stack slots allocated for pseudo-registers.  Each
8037 pseudo-register that does not get a hard register gets a separate
8038 stack slot, and as a result function stack frames are larger.
8040 @item -flra-remat
8041 @opindex flra-remat
8042 Enable CFG-sensitive rematerialization in LRA.  Instead of loading
8043 values of spilled pseudos, LRA tries to rematerialize (recalculate)
8044 values if it is profitable.
8046 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8048 @item -fdelayed-branch
8049 @opindex fdelayed-branch
8050 If supported for the target machine, attempt to reorder instructions
8051 to exploit instruction slots available after delayed branch
8052 instructions.
8054 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8056 @item -fschedule-insns
8057 @opindex fschedule-insns
8058 If supported for the target machine, attempt to reorder instructions to
8059 eliminate execution stalls due to required data being unavailable.  This
8060 helps machines that have slow floating point or memory load instructions
8061 by allowing other instructions to be issued until the result of the load
8062 or floating-point instruction is required.
8064 Enabled at levels @option{-O2}, @option{-O3}.
8066 @item -fschedule-insns2
8067 @opindex fschedule-insns2
8068 Similar to @option{-fschedule-insns}, but requests an additional pass of
8069 instruction scheduling after register allocation has been done.  This is
8070 especially useful on machines with a relatively small number of
8071 registers and where memory load instructions take more than one cycle.
8073 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8075 @item -fno-sched-interblock
8076 @opindex fno-sched-interblock
8077 Don't schedule instructions across basic blocks.  This is normally
8078 enabled by default when scheduling before register allocation, i.e.@:
8079 with @option{-fschedule-insns} or at @option{-O2} or higher.
8081 @item -fno-sched-spec
8082 @opindex fno-sched-spec
8083 Don't allow speculative motion of non-load instructions.  This is normally
8084 enabled by default when scheduling before register allocation, i.e.@:
8085 with @option{-fschedule-insns} or at @option{-O2} or higher.
8087 @item -fsched-pressure
8088 @opindex fsched-pressure
8089 Enable register pressure sensitive insn scheduling before register
8090 allocation.  This only makes sense when scheduling before register
8091 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
8092 @option{-O2} or higher.  Usage of this option can improve the
8093 generated code and decrease its size by preventing register pressure
8094 increase above the number of available hard registers and subsequent
8095 spills in register allocation.
8097 @item -fsched-spec-load
8098 @opindex fsched-spec-load
8099 Allow speculative motion of some load instructions.  This only makes
8100 sense when scheduling before register allocation, i.e.@: with
8101 @option{-fschedule-insns} or at @option{-O2} or higher.
8103 @item -fsched-spec-load-dangerous
8104 @opindex fsched-spec-load-dangerous
8105 Allow speculative motion of more load instructions.  This only makes
8106 sense when scheduling before register allocation, i.e.@: with
8107 @option{-fschedule-insns} or at @option{-O2} or higher.
8109 @item -fsched-stalled-insns
8110 @itemx -fsched-stalled-insns=@var{n}
8111 @opindex fsched-stalled-insns
8112 Define how many insns (if any) can be moved prematurely from the queue
8113 of stalled insns into the ready list during the second scheduling pass.
8114 @option{-fno-sched-stalled-insns} means that no insns are moved
8115 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
8116 on how many queued insns can be moved prematurely.
8117 @option{-fsched-stalled-insns} without a value is equivalent to
8118 @option{-fsched-stalled-insns=1}.
8120 @item -fsched-stalled-insns-dep
8121 @itemx -fsched-stalled-insns-dep=@var{n}
8122 @opindex fsched-stalled-insns-dep
8123 Define how many insn groups (cycles) are examined for a dependency
8124 on a stalled insn that is a candidate for premature removal from the queue
8125 of stalled insns.  This has an effect only during the second scheduling pass,
8126 and only if @option{-fsched-stalled-insns} is used.
8127 @option{-fno-sched-stalled-insns-dep} is equivalent to
8128 @option{-fsched-stalled-insns-dep=0}.
8129 @option{-fsched-stalled-insns-dep} without a value is equivalent to
8130 @option{-fsched-stalled-insns-dep=1}.
8132 @item -fsched2-use-superblocks
8133 @opindex fsched2-use-superblocks
8134 When scheduling after register allocation, use superblock scheduling.
8135 This allows motion across basic block boundaries,
8136 resulting in faster schedules.  This option is experimental, as not all machine
8137 descriptions used by GCC model the CPU closely enough to avoid unreliable
8138 results from the algorithm.
8140 This only makes sense when scheduling after register allocation, i.e.@: with
8141 @option{-fschedule-insns2} or at @option{-O2} or higher.
8143 @item -fsched-group-heuristic
8144 @opindex fsched-group-heuristic
8145 Enable the group heuristic in the scheduler.  This heuristic favors
8146 the instruction that belongs to a schedule group.  This is enabled
8147 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8148 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8150 @item -fsched-critical-path-heuristic
8151 @opindex fsched-critical-path-heuristic
8152 Enable the critical-path heuristic in the scheduler.  This heuristic favors
8153 instructions on the critical path.  This is enabled by default when
8154 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8155 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8157 @item -fsched-spec-insn-heuristic
8158 @opindex fsched-spec-insn-heuristic
8159 Enable the speculative instruction heuristic in the scheduler.  This
8160 heuristic favors speculative instructions with greater dependency weakness.
8161 This is enabled by default when scheduling is enabled, i.e.@:
8162 with @option{-fschedule-insns} or @option{-fschedule-insns2}
8163 or at @option{-O2} or higher.
8165 @item -fsched-rank-heuristic
8166 @opindex fsched-rank-heuristic
8167 Enable the rank heuristic in the scheduler.  This heuristic favors
8168 the instruction belonging to a basic block with greater size or frequency.
8169 This is enabled by default when scheduling is enabled, i.e.@:
8170 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8171 at @option{-O2} or higher.
8173 @item -fsched-last-insn-heuristic
8174 @opindex fsched-last-insn-heuristic
8175 Enable the last-instruction heuristic in the scheduler.  This heuristic
8176 favors the instruction that is less dependent on the last instruction
8177 scheduled.  This is enabled by default when scheduling is enabled,
8178 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8179 at @option{-O2} or higher.
8181 @item -fsched-dep-count-heuristic
8182 @opindex fsched-dep-count-heuristic
8183 Enable the dependent-count heuristic in the scheduler.  This heuristic
8184 favors the instruction that has more instructions depending on it.
8185 This is enabled by default when scheduling is enabled, i.e.@:
8186 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8187 at @option{-O2} or higher.
8189 @item -freschedule-modulo-scheduled-loops
8190 @opindex freschedule-modulo-scheduled-loops
8191 Modulo scheduling is performed before traditional scheduling.  If a loop
8192 is modulo scheduled, later scheduling passes may change its schedule.  
8193 Use this option to control that behavior.
8195 @item -fselective-scheduling
8196 @opindex fselective-scheduling
8197 Schedule instructions using selective scheduling algorithm.  Selective
8198 scheduling runs instead of the first scheduler pass.
8200 @item -fselective-scheduling2
8201 @opindex fselective-scheduling2
8202 Schedule instructions using selective scheduling algorithm.  Selective
8203 scheduling runs instead of the second scheduler pass.
8205 @item -fsel-sched-pipelining
8206 @opindex fsel-sched-pipelining
8207 Enable software pipelining of innermost loops during selective scheduling.
8208 This option has no effect unless one of @option{-fselective-scheduling} or
8209 @option{-fselective-scheduling2} is turned on.
8211 @item -fsel-sched-pipelining-outer-loops
8212 @opindex fsel-sched-pipelining-outer-loops
8213 When pipelining loops during selective scheduling, also pipeline outer loops.
8214 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
8216 @item -fsemantic-interposition
8217 @opindex fsemantic-interposition
8218 Some object formats, like ELF, allow interposing of symbols by the 
8219 dynamic linker.
8220 This means that for symbols exported from the DSO, the compiler cannot perform
8221 interprocedural propagation, inlining and other optimizations in anticipation
8222 that the function or variable in question may change. While this feature is
8223 useful, for example, to rewrite memory allocation functions by a debugging
8224 implementation, it is expensive in the terms of code quality.
8225 With @option{-fno-semantic-interposition} the compiler assumes that 
8226 if interposition happens for functions the overwriting function will have 
8227 precisely the same semantics (and side effects). 
8228 Similarly if interposition happens
8229 for variables, the constructor of the variable will be the same. The flag
8230 has no effect for functions explicitly declared inline 
8231 (where it is never allowed for interposition to change semantics) 
8232 and for symbols explicitly declared weak.
8234 @item -fshrink-wrap
8235 @opindex fshrink-wrap
8236 Emit function prologues only before parts of the function that need it,
8237 rather than at the top of the function.  This flag is enabled by default at
8238 @option{-O} and higher.
8240 @item -fshrink-wrap-separate
8241 @opindex fshrink-wrap-separate
8242 Shrink-wrap separate parts of the prologue and epilogue separately, so that
8243 those parts are only executed when needed.
8244 This option is on by default, but has no effect unless @option{-fshrink-wrap}
8245 is also turned on and the target supports this.
8247 @item -fcaller-saves
8248 @opindex fcaller-saves
8249 Enable allocation of values to registers that are clobbered by
8250 function calls, by emitting extra instructions to save and restore the
8251 registers around such calls.  Such allocation is done only when it
8252 seems to result in better code.
8254 This option is always enabled by default on certain machines, usually
8255 those which have no call-preserved registers to use instead.
8257 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8259 @item -fcombine-stack-adjustments
8260 @opindex fcombine-stack-adjustments
8261 Tracks stack adjustments (pushes and pops) and stack memory references
8262 and then tries to find ways to combine them.
8264 Enabled by default at @option{-O1} and higher.
8266 @item -fipa-ra
8267 @opindex fipa-ra
8268 Use caller save registers for allocation if those registers are not used by
8269 any called function.  In that case it is not necessary to save and restore
8270 them around calls.  This is only possible if called functions are part of
8271 same compilation unit as current function and they are compiled before it.
8273 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}, however the option
8274 is disabled if generated code will be instrumented for profiling
8275 (@option{-p}, or @option{-pg}) or if callee's register usage cannot be known
8276 exactly (this happens on targets that do not expose prologues
8277 and epilogues in RTL).
8279 @item -fconserve-stack
8280 @opindex fconserve-stack
8281 Attempt to minimize stack usage.  The compiler attempts to use less
8282 stack space, even if that makes the program slower.  This option
8283 implies setting the @option{large-stack-frame} parameter to 100
8284 and the @option{large-stack-frame-growth} parameter to 400.
8286 @item -ftree-reassoc
8287 @opindex ftree-reassoc
8288 Perform reassociation on trees.  This flag is enabled by default
8289 at @option{-O} and higher.
8291 @item -fcode-hoisting
8292 @opindex fcode-hoisting
8293 Perform code hoisting.  Code hoisting tries to move the
8294 evaluation of expressions executed on all paths to the function exit
8295 as early as possible.  This is especially useful as a code size
8296 optimization, but it often helps for code speed as well.
8297 This flag is enabled by default at @option{-O2} and higher.
8299 @item -ftree-pre
8300 @opindex ftree-pre
8301 Perform partial redundancy elimination (PRE) on trees.  This flag is
8302 enabled by default at @option{-O2} and @option{-O3}.
8304 @item -ftree-partial-pre
8305 @opindex ftree-partial-pre
8306 Make partial redundancy elimination (PRE) more aggressive.  This flag is
8307 enabled by default at @option{-O3}.
8309 @item -ftree-forwprop
8310 @opindex ftree-forwprop
8311 Perform forward propagation on trees.  This flag is enabled by default
8312 at @option{-O} and higher.
8314 @item -ftree-fre
8315 @opindex ftree-fre
8316 Perform full redundancy elimination (FRE) on trees.  The difference
8317 between FRE and PRE is that FRE only considers expressions
8318 that are computed on all paths leading to the redundant computation.
8319 This analysis is faster than PRE, though it exposes fewer redundancies.
8320 This flag is enabled by default at @option{-O} and higher.
8322 @item -ftree-phiprop
8323 @opindex ftree-phiprop
8324 Perform hoisting of loads from conditional pointers on trees.  This
8325 pass is enabled by default at @option{-O} and higher.
8327 @item -fhoist-adjacent-loads
8328 @opindex fhoist-adjacent-loads
8329 Speculatively hoist loads from both branches of an if-then-else if the
8330 loads are from adjacent locations in the same structure and the target
8331 architecture has a conditional move instruction.  This flag is enabled
8332 by default at @option{-O2} and higher.
8334 @item -ftree-copy-prop
8335 @opindex ftree-copy-prop
8336 Perform copy propagation on trees.  This pass eliminates unnecessary
8337 copy operations.  This flag is enabled by default at @option{-O} and
8338 higher.
8340 @item -fipa-pure-const
8341 @opindex fipa-pure-const
8342 Discover which functions are pure or constant.
8343 Enabled by default at @option{-O} and higher.
8345 @item -fipa-reference
8346 @opindex fipa-reference
8347 Discover which static variables do not escape the
8348 compilation unit.
8349 Enabled by default at @option{-O} and higher.
8351 @item -fipa-pta
8352 @opindex fipa-pta
8353 Perform interprocedural pointer analysis and interprocedural modification
8354 and reference analysis.  This option can cause excessive memory and
8355 compile-time usage on large compilation units.  It is not enabled by
8356 default at any optimization level.
8358 @item -fipa-profile
8359 @opindex fipa-profile
8360 Perform interprocedural profile propagation.  The functions called only from
8361 cold functions are marked as cold. Also functions executed once (such as
8362 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
8363 functions and loop less parts of functions executed once are then optimized for
8364 size.
8365 Enabled by default at @option{-O} and higher.
8367 @item -fipa-cp
8368 @opindex fipa-cp
8369 Perform interprocedural constant propagation.
8370 This optimization analyzes the program to determine when values passed
8371 to functions are constants and then optimizes accordingly.
8372 This optimization can substantially increase performance
8373 if the application has constants passed to functions.
8374 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
8376 @item -fipa-cp-clone
8377 @opindex fipa-cp-clone
8378 Perform function cloning to make interprocedural constant propagation stronger.
8379 When enabled, interprocedural constant propagation performs function cloning
8380 when externally visible function can be called with constant arguments.
8381 Because this optimization can create multiple copies of functions,
8382 it may significantly increase code size
8383 (see @option{--param ipcp-unit-growth=@var{value}}).
8384 This flag is enabled by default at @option{-O3}.
8386 @item -fipa-bit-cp
8387 @opindex -fipa-bit-cp
8388 When enabled, perform interprocedural bitwise constant
8389 propagation. This flag is enabled by default at @option{-O2}. It
8390 requires that @option{-fipa-cp} is enabled.
8392 @item -fipa-vrp
8393 @opindex -fipa-vrp
8394 When enabled, perform interprocedural propagation of value
8395 ranges. This flag is enabled by default at @option{-O2}. It requires
8396 that @option{-fipa-cp} is enabled.
8398 @item -fipa-icf
8399 @opindex fipa-icf
8400 Perform Identical Code Folding for functions and read-only variables.
8401 The optimization reduces code size and may disturb unwind stacks by replacing
8402 a function by equivalent one with a different name. The optimization works
8403 more effectively with link-time optimization enabled.
8405 Nevertheless the behavior is similar to Gold Linker ICF optimization, GCC ICF
8406 works on different levels and thus the optimizations are not same - there are
8407 equivalences that are found only by GCC and equivalences found only by Gold.
8409 This flag is enabled by default at @option{-O2} and @option{-Os}.
8411 @item -fisolate-erroneous-paths-dereference
8412 @opindex fisolate-erroneous-paths-dereference
8413 Detect paths that trigger erroneous or undefined behavior due to
8414 dereferencing a null pointer.  Isolate those paths from the main control
8415 flow and turn the statement with erroneous or undefined behavior into a trap.
8416 This flag is enabled by default at @option{-O2} and higher and depends on
8417 @option{-fdelete-null-pointer-checks} also being enabled.
8419 @item -fisolate-erroneous-paths-attribute
8420 @opindex fisolate-erroneous-paths-attribute
8421 Detect paths that trigger erroneous or undefined behavior due a null value
8422 being used in a way forbidden by a @code{returns_nonnull} or @code{nonnull}
8423 attribute.  Isolate those paths from the main control flow and turn the
8424 statement with erroneous or undefined behavior into a trap.  This is not
8425 currently enabled, but may be enabled by @option{-O2} in the future.
8427 @item -ftree-sink
8428 @opindex ftree-sink
8429 Perform forward store motion on trees.  This flag is
8430 enabled by default at @option{-O} and higher.
8432 @item -ftree-bit-ccp
8433 @opindex ftree-bit-ccp
8434 Perform sparse conditional bit constant propagation on trees and propagate
8435 pointer alignment information.
8436 This pass only operates on local scalar variables and is enabled by default
8437 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
8439 @item -ftree-ccp
8440 @opindex ftree-ccp
8441 Perform sparse conditional constant propagation (CCP) on trees.  This
8442 pass only operates on local scalar variables and is enabled by default
8443 at @option{-O} and higher.
8445 @item -fssa-backprop
8446 @opindex fssa-backprop
8447 Propagate information about uses of a value up the definition chain
8448 in order to simplify the definitions.  For example, this pass strips
8449 sign operations if the sign of a value never matters.  The flag is
8450 enabled by default at @option{-O} and higher.
8452 @item -fssa-phiopt
8453 @opindex fssa-phiopt
8454 Perform pattern matching on SSA PHI nodes to optimize conditional
8455 code.  This pass is enabled by default at @option{-O} and higher.
8457 @item -ftree-switch-conversion
8458 @opindex ftree-switch-conversion
8459 Perform conversion of simple initializations in a switch to
8460 initializations from a scalar array.  This flag is enabled by default
8461 at @option{-O2} and higher.
8463 @item -ftree-tail-merge
8464 @opindex ftree-tail-merge
8465 Look for identical code sequences.  When found, replace one with a jump to the
8466 other.  This optimization is known as tail merging or cross jumping.  This flag
8467 is enabled by default at @option{-O2} and higher.  The compilation time
8468 in this pass can
8469 be limited using @option{max-tail-merge-comparisons} parameter and
8470 @option{max-tail-merge-iterations} parameter.
8472 @item -ftree-dce
8473 @opindex ftree-dce
8474 Perform dead code elimination (DCE) on trees.  This flag is enabled by
8475 default at @option{-O} and higher.
8477 @item -ftree-builtin-call-dce
8478 @opindex ftree-builtin-call-dce
8479 Perform conditional dead code elimination (DCE) for calls to built-in functions
8480 that may set @code{errno} but are otherwise side-effect free.  This flag is
8481 enabled by default at @option{-O2} and higher if @option{-Os} is not also
8482 specified.
8484 @item -ftree-dominator-opts
8485 @opindex ftree-dominator-opts
8486 Perform a variety of simple scalar cleanups (constant/copy
8487 propagation, redundancy elimination, range propagation and expression
8488 simplification) based on a dominator tree traversal.  This also
8489 performs jump threading (to reduce jumps to jumps). This flag is
8490 enabled by default at @option{-O} and higher.
8492 @item -ftree-dse
8493 @opindex ftree-dse
8494 Perform dead store elimination (DSE) on trees.  A dead store is a store into
8495 a memory location that is later overwritten by another store without
8496 any intervening loads.  In this case the earlier store can be deleted.  This
8497 flag is enabled by default at @option{-O} and higher.
8499 @item -ftree-ch
8500 @opindex ftree-ch
8501 Perform loop header copying on trees.  This is beneficial since it increases
8502 effectiveness of code motion optimizations.  It also saves one jump.  This flag
8503 is enabled by default at @option{-O} and higher.  It is not enabled
8504 for @option{-Os}, since it usually increases code size.
8506 @item -ftree-loop-optimize
8507 @opindex ftree-loop-optimize
8508 Perform loop optimizations on trees.  This flag is enabled by default
8509 at @option{-O} and higher.
8511 @item -ftree-loop-linear
8512 @itemx -floop-strip-mine
8513 @itemx -floop-block
8514 @opindex ftree-loop-linear
8515 @opindex floop-strip-mine
8516 @opindex floop-block
8517 Perform loop nest optimizations.  Same as
8518 @option{-floop-nest-optimize}.  To use this code transformation, GCC has
8519 to be configured with @option{--with-isl} to enable the Graphite loop
8520 transformation infrastructure.
8522 @item -fgraphite-identity
8523 @opindex fgraphite-identity
8524 Enable the identity transformation for graphite.  For every SCoP we generate
8525 the polyhedral representation and transform it back to gimple.  Using
8526 @option{-fgraphite-identity} we can check the costs or benefits of the
8527 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
8528 are also performed by the code generator isl, like index splitting and
8529 dead code elimination in loops.
8531 @item -floop-nest-optimize
8532 @opindex floop-nest-optimize
8533 Enable the isl based loop nest optimizer.  This is a generic loop nest
8534 optimizer based on the Pluto optimization algorithms.  It calculates a loop
8535 structure optimized for data-locality and parallelism.  This option
8536 is experimental.
8538 @item -floop-parallelize-all
8539 @opindex floop-parallelize-all
8540 Use the Graphite data dependence analysis to identify loops that can
8541 be parallelized.  Parallelize all the loops that can be analyzed to
8542 not contain loop carried dependences without checking that it is
8543 profitable to parallelize the loops.
8545 @item -ftree-coalesce-vars
8546 @opindex ftree-coalesce-vars
8547 While transforming the program out of the SSA representation, attempt to
8548 reduce copying by coalescing versions of different user-defined
8549 variables, instead of just compiler temporaries.  This may severely
8550 limit the ability to debug an optimized program compiled with
8551 @option{-fno-var-tracking-assignments}.  In the negated form, this flag
8552 prevents SSA coalescing of user variables.  This option is enabled by
8553 default if optimization is enabled, and it does very little otherwise.
8555 @item -ftree-loop-if-convert
8556 @opindex ftree-loop-if-convert
8557 Attempt to transform conditional jumps in the innermost loops to
8558 branch-less equivalents.  The intent is to remove control-flow from
8559 the innermost loops in order to improve the ability of the
8560 vectorization pass to handle these loops.  This is enabled by default
8561 if vectorization is enabled.
8563 @item -ftree-loop-distribution
8564 @opindex ftree-loop-distribution
8565 Perform loop distribution.  This flag can improve cache performance on
8566 big loop bodies and allow further loop optimizations, like
8567 parallelization or vectorization, to take place.  For example, the loop
8568 @smallexample
8569 DO I = 1, N
8570   A(I) = B(I) + C
8571   D(I) = E(I) * F
8572 ENDDO
8573 @end smallexample
8574 is transformed to
8575 @smallexample
8576 DO I = 1, N
8577    A(I) = B(I) + C
8578 ENDDO
8579 DO I = 1, N
8580    D(I) = E(I) * F
8581 ENDDO
8582 @end smallexample
8584 @item -ftree-loop-distribute-patterns
8585 @opindex ftree-loop-distribute-patterns
8586 Perform loop distribution of patterns that can be code generated with
8587 calls to a library.  This flag is enabled by default at @option{-O3}.
8589 This pass distributes the initialization loops and generates a call to
8590 memset zero.  For example, the loop
8591 @smallexample
8592 DO I = 1, N
8593   A(I) = 0
8594   B(I) = A(I) + I
8595 ENDDO
8596 @end smallexample
8597 is transformed to
8598 @smallexample
8599 DO I = 1, N
8600    A(I) = 0
8601 ENDDO
8602 DO I = 1, N
8603    B(I) = A(I) + I
8604 ENDDO
8605 @end smallexample
8606 and the initialization loop is transformed into a call to memset zero.
8608 @item -floop-interchange
8609 @opindex floop-interchange
8610 Perform loop interchange outside of graphite.  This flag can improve cache
8611 performance on loop nest and allow further loop optimizations, like
8612 vectorization, to take place.  For example, the loop
8613 @smallexample
8614 for (int i = 0; i < N; i++)
8615   for (int j = 0; j < N; j++)
8616     for (int k = 0; k < N; k++)
8617       c[i][j] = c[i][j] + a[i][k]*b[k][j];
8618 @end smallexample
8619 is transformed to
8620 @smallexample
8621 for (int i = 0; i < N; i++)
8622   for (int k = 0; k < N; k++)
8623     for (int j = 0; j < N; j++)
8624       c[i][j] = c[i][j] + a[i][k]*b[k][j];
8625 @end smallexample
8627 @item -ftree-loop-im
8628 @opindex ftree-loop-im
8629 Perform loop invariant motion on trees.  This pass moves only invariants that
8630 are hard to handle at RTL level (function calls, operations that expand to
8631 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
8632 operands of conditions that are invariant out of the loop, so that we can use
8633 just trivial invariantness analysis in loop unswitching.  The pass also includes
8634 store motion.
8636 @item -ftree-loop-ivcanon
8637 @opindex ftree-loop-ivcanon
8638 Create a canonical counter for number of iterations in loops for which
8639 determining number of iterations requires complicated analysis.  Later
8640 optimizations then may determine the number easily.  Useful especially
8641 in connection with unrolling.
8643 @item -fivopts
8644 @opindex fivopts
8645 Perform induction variable optimizations (strength reduction, induction
8646 variable merging and induction variable elimination) on trees.
8648 @item -ftree-parallelize-loops=n
8649 @opindex ftree-parallelize-loops
8650 Parallelize loops, i.e., split their iteration space to run in n threads.
8651 This is only possible for loops whose iterations are independent
8652 and can be arbitrarily reordered.  The optimization is only
8653 profitable on multiprocessor machines, for loops that are CPU-intensive,
8654 rather than constrained e.g.@: by memory bandwidth.  This option
8655 implies @option{-pthread}, and thus is only supported on targets
8656 that have support for @option{-pthread}.
8658 @item -ftree-pta
8659 @opindex ftree-pta
8660 Perform function-local points-to analysis on trees.  This flag is
8661 enabled by default at @option{-O} and higher.
8663 @item -ftree-sra
8664 @opindex ftree-sra
8665 Perform scalar replacement of aggregates.  This pass replaces structure
8666 references with scalars to prevent committing structures to memory too
8667 early.  This flag is enabled by default at @option{-O} and higher.
8669 @item -fstore-merging
8670 @opindex fstore-merging
8671 Perform merging of narrow stores to consecutive memory addresses.  This pass
8672 merges contiguous stores of immediate values narrower than a word into fewer
8673 wider stores to reduce the number of instructions.  This is enabled by default
8674 at @option{-O2} and higher as well as @option{-Os}.
8676 @item -ftree-ter
8677 @opindex ftree-ter
8678 Perform temporary expression replacement during the SSA->normal phase.  Single
8679 use/single def temporaries are replaced at their use location with their
8680 defining expression.  This results in non-GIMPLE code, but gives the expanders
8681 much more complex trees to work on resulting in better RTL generation.  This is
8682 enabled by default at @option{-O} and higher.
8684 @item -ftree-slsr
8685 @opindex ftree-slsr
8686 Perform straight-line strength reduction on trees.  This recognizes related
8687 expressions involving multiplications and replaces them by less expensive
8688 calculations when possible.  This is enabled by default at @option{-O} and
8689 higher.
8691 @item -ftree-vectorize
8692 @opindex ftree-vectorize
8693 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
8694 and @option{-ftree-slp-vectorize} if not explicitly specified.
8696 @item -ftree-loop-vectorize
8697 @opindex ftree-loop-vectorize
8698 Perform loop vectorization on trees. This flag is enabled by default at
8699 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8701 @item -ftree-slp-vectorize
8702 @opindex ftree-slp-vectorize
8703 Perform basic block vectorization on trees. This flag is enabled by default at
8704 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8706 @item -fvect-cost-model=@var{model}
8707 @opindex fvect-cost-model
8708 Alter the cost model used for vectorization.  The @var{model} argument
8709 should be one of @samp{unlimited}, @samp{dynamic} or @samp{cheap}.
8710 With the @samp{unlimited} model the vectorized code-path is assumed
8711 to be profitable while with the @samp{dynamic} model a runtime check
8712 guards the vectorized code-path to enable it only for iteration
8713 counts that will likely execute faster than when executing the original
8714 scalar loop.  The @samp{cheap} model disables vectorization of
8715 loops where doing so would be cost prohibitive for example due to
8716 required runtime checks for data dependence or alignment but otherwise
8717 is equal to the @samp{dynamic} model.
8718 The default cost model depends on other optimization flags and is
8719 either @samp{dynamic} or @samp{cheap}.
8721 @item -fsimd-cost-model=@var{model}
8722 @opindex fsimd-cost-model
8723 Alter the cost model used for vectorization of loops marked with the OpenMP
8724 or Cilk Plus simd directive.  The @var{model} argument should be one of
8725 @samp{unlimited}, @samp{dynamic}, @samp{cheap}.  All values of @var{model}
8726 have the same meaning as described in @option{-fvect-cost-model} and by
8727 default a cost model defined with @option{-fvect-cost-model} is used.
8729 @item -ftree-vrp
8730 @opindex ftree-vrp
8731 Perform Value Range Propagation on trees.  This is similar to the
8732 constant propagation pass, but instead of values, ranges of values are
8733 propagated.  This allows the optimizers to remove unnecessary range
8734 checks like array bound checks and null pointer checks.  This is
8735 enabled by default at @option{-O2} and higher.  Null pointer check
8736 elimination is only done if @option{-fdelete-null-pointer-checks} is
8737 enabled.
8739 @item -fsplit-paths
8740 @opindex fsplit-paths
8741 Split paths leading to loop backedges.  This can improve dead code
8742 elimination and common subexpression elimination.  This is enabled by
8743 default at @option{-O2} and above.
8745 @item -fsplit-ivs-in-unroller
8746 @opindex fsplit-ivs-in-unroller
8747 Enables expression of values of induction variables in later iterations
8748 of the unrolled loop using the value in the first iteration.  This breaks
8749 long dependency chains, thus improving efficiency of the scheduling passes.
8751 A combination of @option{-fweb} and CSE is often sufficient to obtain the
8752 same effect.  However, that is not reliable in cases where the loop body
8753 is more complicated than a single basic block.  It also does not work at all
8754 on some architectures due to restrictions in the CSE pass.
8756 This optimization is enabled by default.
8758 @item -fvariable-expansion-in-unroller
8759 @opindex fvariable-expansion-in-unroller
8760 With this option, the compiler creates multiple copies of some
8761 local variables when unrolling a loop, which can result in superior code.
8763 @item -fpartial-inlining
8764 @opindex fpartial-inlining
8765 Inline parts of functions.  This option has any effect only
8766 when inlining itself is turned on by the @option{-finline-functions}
8767 or @option{-finline-small-functions} options.
8769 Enabled at level @option{-O2}.
8771 @item -fpredictive-commoning
8772 @opindex fpredictive-commoning
8773 Perform predictive commoning optimization, i.e., reusing computations
8774 (especially memory loads and stores) performed in previous
8775 iterations of loops.
8777 This option is enabled at level @option{-O3}.
8779 @item -fprefetch-loop-arrays
8780 @opindex fprefetch-loop-arrays
8781 If supported by the target machine, generate instructions to prefetch
8782 memory to improve the performance of loops that access large arrays.
8784 This option may generate better or worse code; results are highly
8785 dependent on the structure of loops within the source code.
8787 Disabled at level @option{-Os}.
8789 @item -fno-printf-return-value
8790 @opindex fno-printf-return-value
8791 Do not substitute constants for known return value of formatted output
8792 functions such as @code{sprintf}, @code{snprintf}, @code{vsprintf}, and
8793 @code{vsnprintf} (but not @code{printf} of @code{fprintf}).  This
8794 transformation allows GCC to optimize or even eliminate branches based
8795 on the known return value of these functions called with arguments that
8796 are either constant, or whose values are known to be in a range that
8797 makes determining the exact return value possible.  For example, when
8798 @option{-fprintf-return-value} is in effect, both the branch and the
8799 body of the @code{if} statement (but not the call to @code{snprint})
8800 can be optimized away when @code{i} is a 32-bit or smaller integer
8801 because the return value is guaranteed to be at most 8.
8803 @smallexample
8804 char buf[9];
8805 if (snprintf (buf, "%08x", i) >= sizeof buf)
8806   @dots{}
8807 @end smallexample
8809 The @option{-fprintf-return-value} option relies on other optimizations
8810 and yields best results with @option{-O2}.  It works in tandem with the
8811 @option{-Wformat-overflow} and @option{-Wformat-truncation} options.
8812 The @option{-fprintf-return-value} option is enabled by default.
8814 @item -fno-peephole
8815 @itemx -fno-peephole2
8816 @opindex fno-peephole
8817 @opindex fno-peephole2
8818 Disable any machine-specific peephole optimizations.  The difference
8819 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
8820 are implemented in the compiler; some targets use one, some use the
8821 other, a few use both.
8823 @option{-fpeephole} is enabled by default.
8824 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8826 @item -fno-guess-branch-probability
8827 @opindex fno-guess-branch-probability
8828 Do not guess branch probabilities using heuristics.
8830 GCC uses heuristics to guess branch probabilities if they are
8831 not provided by profiling feedback (@option{-fprofile-arcs}).  These
8832 heuristics are based on the control flow graph.  If some branch probabilities
8833 are specified by @code{__builtin_expect}, then the heuristics are
8834 used to guess branch probabilities for the rest of the control flow graph,
8835 taking the @code{__builtin_expect} info into account.  The interactions
8836 between the heuristics and @code{__builtin_expect} can be complex, and in
8837 some cases, it may be useful to disable the heuristics so that the effects
8838 of @code{__builtin_expect} are easier to understand.
8840 The default is @option{-fguess-branch-probability} at levels
8841 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8843 @item -freorder-blocks
8844 @opindex freorder-blocks
8845 Reorder basic blocks in the compiled function in order to reduce number of
8846 taken branches and improve code locality.
8848 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8850 @item -freorder-blocks-algorithm=@var{algorithm}
8851 @opindex freorder-blocks-algorithm
8852 Use the specified algorithm for basic block reordering.  The
8853 @var{algorithm} argument can be @samp{simple}, which does not increase
8854 code size (except sometimes due to secondary effects like alignment),
8855 or @samp{stc}, the ``software trace cache'' algorithm, which tries to
8856 put all often executed code together, minimizing the number of branches
8857 executed by making extra copies of code.
8859 The default is @samp{simple} at levels @option{-O}, @option{-Os}, and
8860 @samp{stc} at levels @option{-O2}, @option{-O3}.
8862 @item -freorder-blocks-and-partition
8863 @opindex freorder-blocks-and-partition
8864 In addition to reordering basic blocks in the compiled function, in order
8865 to reduce number of taken branches, partitions hot and cold basic blocks
8866 into separate sections of the assembly and @file{.o} files, to improve
8867 paging and cache locality performance.
8869 This optimization is automatically turned off in the presence of
8870 exception handling or unwind tables (on targets using setjump/longjump or target specific scheme), for linkonce sections, for functions with a user-defined
8871 section attribute and on any architecture that does not support named
8872 sections.  When @option{-fsplit-stack} is used this option is not
8873 enabled by default (to avoid linker errors), but may be enabled
8874 explicitly (if using a working linker).
8876 Enabled for x86 at levels @option{-O2}, @option{-O3}.
8878 @item -freorder-functions
8879 @opindex freorder-functions
8880 Reorder functions in the object file in order to
8881 improve code locality.  This is implemented by using special
8882 subsections @code{.text.hot} for most frequently executed functions and
8883 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
8884 the linker so object file format must support named sections and linker must
8885 place them in a reasonable way.
8887 Also profile feedback must be available to make this option effective.  See
8888 @option{-fprofile-arcs} for details.
8890 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8892 @item -fstrict-aliasing
8893 @opindex fstrict-aliasing
8894 Allow the compiler to assume the strictest aliasing rules applicable to
8895 the language being compiled.  For C (and C++), this activates
8896 optimizations based on the type of expressions.  In particular, an
8897 object of one type is assumed never to reside at the same address as an
8898 object of a different type, unless the types are almost the same.  For
8899 example, an @code{unsigned int} can alias an @code{int}, but not a
8900 @code{void*} or a @code{double}.  A character type may alias any other
8901 type.
8903 @anchor{Type-punning}Pay special attention to code like this:
8904 @smallexample
8905 union a_union @{
8906   int i;
8907   double d;
8910 int f() @{
8911   union a_union t;
8912   t.d = 3.0;
8913   return t.i;
8915 @end smallexample
8916 The practice of reading from a different union member than the one most
8917 recently written to (called ``type-punning'') is common.  Even with
8918 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
8919 is accessed through the union type.  So, the code above works as
8920 expected.  @xref{Structures unions enumerations and bit-fields
8921 implementation}.  However, this code might not:
8922 @smallexample
8923 int f() @{
8924   union a_union t;
8925   int* ip;
8926   t.d = 3.0;
8927   ip = &t.i;
8928   return *ip;
8930 @end smallexample
8932 Similarly, access by taking the address, casting the resulting pointer
8933 and dereferencing the result has undefined behavior, even if the cast
8934 uses a union type, e.g.:
8935 @smallexample
8936 int f() @{
8937   double d = 3.0;
8938   return ((union a_union *) &d)->i;
8940 @end smallexample
8942 The @option{-fstrict-aliasing} option is enabled at levels
8943 @option{-O2}, @option{-O3}, @option{-Os}.
8945 @item -falign-functions
8946 @itemx -falign-functions=@var{n}
8947 @opindex falign-functions
8948 Align the start of functions to the next power-of-two greater than
8949 @var{n}, skipping up to @var{n} bytes.  For instance,
8950 @option{-falign-functions=32} aligns functions to the next 32-byte
8951 boundary, but @option{-falign-functions=24} aligns to the next
8952 32-byte boundary only if this can be done by skipping 23 bytes or less.
8954 @option{-fno-align-functions} and @option{-falign-functions=1} are
8955 equivalent and mean that functions are not aligned.
8957 Some assemblers only support this flag when @var{n} is a power of two;
8958 in that case, it is rounded up.
8960 If @var{n} is not specified or is zero, use a machine-dependent default.
8962 Enabled at levels @option{-O2}, @option{-O3}.
8964 @item -flimit-function-alignment
8965 If this option is enabled, the compiler tries to avoid unnecessarily
8966 overaligning functions. It attempts to instruct the assembler to align
8967 by the amount specified by @option{-falign-functions}, but not to
8968 skip more bytes than the size of the function.
8970 @item -falign-labels
8971 @itemx -falign-labels=@var{n}
8972 @opindex falign-labels
8973 Align all branch targets to a power-of-two boundary, skipping up to
8974 @var{n} bytes like @option{-falign-functions}.  This option can easily
8975 make code slower, because it must insert dummy operations for when the
8976 branch target is reached in the usual flow of the code.
8978 @option{-fno-align-labels} and @option{-falign-labels=1} are
8979 equivalent and mean that labels are not aligned.
8981 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
8982 are greater than this value, then their values are used instead.
8984 If @var{n} is not specified or is zero, use a machine-dependent default
8985 which is very likely to be @samp{1}, meaning no alignment.
8987 Enabled at levels @option{-O2}, @option{-O3}.
8989 @item -falign-loops
8990 @itemx -falign-loops=@var{n}
8991 @opindex falign-loops
8992 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
8993 like @option{-falign-functions}.  If the loops are
8994 executed many times, this makes up for any execution of the dummy
8995 operations.
8997 @option{-fno-align-loops} and @option{-falign-loops=1} are
8998 equivalent and mean that loops are not aligned.
9000 If @var{n} is not specified or is zero, use a machine-dependent default.
9002 Enabled at levels @option{-O2}, @option{-O3}.
9004 @item -falign-jumps
9005 @itemx -falign-jumps=@var{n}
9006 @opindex falign-jumps
9007 Align branch targets to a power-of-two boundary, for branch targets
9008 where the targets can only be reached by jumping, skipping up to @var{n}
9009 bytes like @option{-falign-functions}.  In this case, no dummy operations
9010 need be executed.
9012 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
9013 equivalent and mean that loops are not aligned.
9015 If @var{n} is not specified or is zero, use a machine-dependent default.
9017 Enabled at levels @option{-O2}, @option{-O3}.
9019 @item -funit-at-a-time
9020 @opindex funit-at-a-time
9021 This option is left for compatibility reasons. @option{-funit-at-a-time}
9022 has no effect, while @option{-fno-unit-at-a-time} implies
9023 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
9025 Enabled by default.
9027 @item -fno-toplevel-reorder
9028 @opindex fno-toplevel-reorder
9029 Do not reorder top-level functions, variables, and @code{asm}
9030 statements.  Output them in the same order that they appear in the
9031 input file.  When this option is used, unreferenced static variables
9032 are not removed.  This option is intended to support existing code
9033 that relies on a particular ordering.  For new code, it is better to
9034 use attributes when possible.
9036 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
9037 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
9038 targets.
9040 @item -fweb
9041 @opindex fweb
9042 Constructs webs as commonly used for register allocation purposes and assign
9043 each web individual pseudo register.  This allows the register allocation pass
9044 to operate on pseudos directly, but also strengthens several other optimization
9045 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
9046 however, make debugging impossible, since variables no longer stay in a
9047 ``home register''.
9049 Enabled by default with @option{-funroll-loops}.
9051 @item -fwhole-program
9052 @opindex fwhole-program
9053 Assume that the current compilation unit represents the whole program being
9054 compiled.  All public functions and variables with the exception of @code{main}
9055 and those merged by attribute @code{externally_visible} become static functions
9056 and in effect are optimized more aggressively by interprocedural optimizers.
9058 This option should not be used in combination with @option{-flto}.
9059 Instead relying on a linker plugin should provide safer and more precise
9060 information.
9062 @item -flto[=@var{n}]
9063 @opindex flto
9064 This option runs the standard link-time optimizer.  When invoked
9065 with source code, it generates GIMPLE (one of GCC's internal
9066 representations) and writes it to special ELF sections in the object
9067 file.  When the object files are linked together, all the function
9068 bodies are read from these ELF sections and instantiated as if they
9069 had been part of the same translation unit.
9071 To use the link-time optimizer, @option{-flto} and optimization
9072 options should be specified at compile time and during the final link.
9073 It is recommended that you compile all the files participating in the
9074 same link with the same options and also specify those options at
9075 link time.  
9076 For example:
9078 @smallexample
9079 gcc -c -O2 -flto foo.c
9080 gcc -c -O2 -flto bar.c
9081 gcc -o myprog -flto -O2 foo.o bar.o
9082 @end smallexample
9084 The first two invocations to GCC save a bytecode representation
9085 of GIMPLE into special ELF sections inside @file{foo.o} and
9086 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
9087 @file{foo.o} and @file{bar.o}, merges the two files into a single
9088 internal image, and compiles the result as usual.  Since both
9089 @file{foo.o} and @file{bar.o} are merged into a single image, this
9090 causes all the interprocedural analyses and optimizations in GCC to
9091 work across the two files as if they were a single one.  This means,
9092 for example, that the inliner is able to inline functions in
9093 @file{bar.o} into functions in @file{foo.o} and vice-versa.
9095 Another (simpler) way to enable link-time optimization is:
9097 @smallexample
9098 gcc -o myprog -flto -O2 foo.c bar.c
9099 @end smallexample
9101 The above generates bytecode for @file{foo.c} and @file{bar.c},
9102 merges them together into a single GIMPLE representation and optimizes
9103 them as usual to produce @file{myprog}.
9105 The only important thing to keep in mind is that to enable link-time
9106 optimizations you need to use the GCC driver to perform the link step.
9107 GCC then automatically performs link-time optimization if any of the
9108 objects involved were compiled with the @option{-flto} command-line option.  
9109 You generally
9110 should specify the optimization options to be used for link-time
9111 optimization though GCC tries to be clever at guessing an
9112 optimization level to use from the options used at compile time
9113 if you fail to specify one at link time.  You can always override
9114 the automatic decision to do link-time optimization
9115 by passing @option{-fno-lto} to the link command.
9117 To make whole program optimization effective, it is necessary to make
9118 certain whole program assumptions.  The compiler needs to know
9119 what functions and variables can be accessed by libraries and runtime
9120 outside of the link-time optimized unit.  When supported by the linker,
9121 the linker plugin (see @option{-fuse-linker-plugin}) passes information
9122 to the compiler about used and externally visible symbols.  When
9123 the linker plugin is not available, @option{-fwhole-program} should be
9124 used to allow the compiler to make these assumptions, which leads
9125 to more aggressive optimization decisions.
9127 When @option{-fuse-linker-plugin} is not enabled, when a file is
9128 compiled with @option{-flto}, the generated object file is larger than
9129 a regular object file because it contains GIMPLE bytecodes and the usual
9130 final code (see @option{-ffat-lto-objects}.  This means that
9131 object files with LTO information can be linked as normal object
9132 files; if @option{-fno-lto} is passed to the linker, no
9133 interprocedural optimizations are applied.  Note that when
9134 @option{-fno-fat-lto-objects} is enabled the compile stage is faster
9135 but you cannot perform a regular, non-LTO link on them.
9137 Additionally, the optimization flags used to compile individual files
9138 are not necessarily related to those used at link time.  For instance,
9140 @smallexample
9141 gcc -c -O0 -ffat-lto-objects -flto foo.c
9142 gcc -c -O0 -ffat-lto-objects -flto bar.c
9143 gcc -o myprog -O3 foo.o bar.o
9144 @end smallexample
9146 This produces individual object files with unoptimized assembler
9147 code, but the resulting binary @file{myprog} is optimized at
9148 @option{-O3}.  If, instead, the final binary is generated with
9149 @option{-fno-lto}, then @file{myprog} is not optimized.
9151 When producing the final binary, GCC only
9152 applies link-time optimizations to those files that contain bytecode.
9153 Therefore, you can mix and match object files and libraries with
9154 GIMPLE bytecodes and final object code.  GCC automatically selects
9155 which files to optimize in LTO mode and which files to link without
9156 further processing.
9158 There are some code generation flags preserved by GCC when
9159 generating bytecodes, as they need to be used during the final link
9160 stage.  Generally options specified at link time override those
9161 specified at compile time.
9163 If you do not specify an optimization level option @option{-O} at
9164 link time, then GCC uses the highest optimization level 
9165 used when compiling the object files.
9167 Currently, the following options and their settings are taken from
9168 the first object file that explicitly specifies them: 
9169 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
9170 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
9171 and all the @option{-m} target flags.
9173 Certain ABI-changing flags are required to match in all compilation units,
9174 and trying to override this at link time with a conflicting value
9175 is ignored.  This includes options such as @option{-freg-struct-return}
9176 and @option{-fpcc-struct-return}. 
9178 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
9179 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
9180 are passed through to the link stage and merged conservatively for
9181 conflicting translation units.  Specifically
9182 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
9183 precedence; and for example @option{-ffp-contract=off} takes precedence
9184 over @option{-ffp-contract=fast}.  You can override them at link time.
9186 If LTO encounters objects with C linkage declared with incompatible
9187 types in separate translation units to be linked together (undefined
9188 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
9189 issued.  The behavior is still undefined at run time.  Similar
9190 diagnostics may be raised for other languages.
9192 Another feature of LTO is that it is possible to apply interprocedural
9193 optimizations on files written in different languages:
9195 @smallexample
9196 gcc -c -flto foo.c
9197 g++ -c -flto bar.cc
9198 gfortran -c -flto baz.f90
9199 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
9200 @end smallexample
9202 Notice that the final link is done with @command{g++} to get the C++
9203 runtime libraries and @option{-lgfortran} is added to get the Fortran
9204 runtime libraries.  In general, when mixing languages in LTO mode, you
9205 should use the same link command options as when mixing languages in a
9206 regular (non-LTO) compilation.
9208 If object files containing GIMPLE bytecode are stored in a library archive, say
9209 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
9210 are using a linker with plugin support.  To create static libraries suitable
9211 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
9212 and @command{ranlib}; 
9213 to show the symbols of object files with GIMPLE bytecode, use
9214 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
9215 and @command{nm} have been compiled with plugin support.  At link time, use the the
9216 flag @option{-fuse-linker-plugin} to ensure that the library participates in
9217 the LTO optimization process:
9219 @smallexample
9220 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
9221 @end smallexample
9223 With the linker plugin enabled, the linker extracts the needed
9224 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
9225 to make them part of the aggregated GIMPLE image to be optimized.
9227 If you are not using a linker with plugin support and/or do not
9228 enable the linker plugin, then the objects inside @file{libfoo.a}
9229 are extracted and linked as usual, but they do not participate
9230 in the LTO optimization process.  In order to make a static library suitable
9231 for both LTO optimization and usual linkage, compile its object files with
9232 @option{-flto} @option{-ffat-lto-objects}.
9234 Link-time optimizations do not require the presence of the whole program to
9235 operate.  If the program does not require any symbols to be exported, it is
9236 possible to combine @option{-flto} and @option{-fwhole-program} to allow
9237 the interprocedural optimizers to use more aggressive assumptions which may
9238 lead to improved optimization opportunities.
9239 Use of @option{-fwhole-program} is not needed when linker plugin is
9240 active (see @option{-fuse-linker-plugin}).
9242 The current implementation of LTO makes no
9243 attempt to generate bytecode that is portable between different
9244 types of hosts.  The bytecode files are versioned and there is a
9245 strict version check, so bytecode files generated in one version of
9246 GCC do not work with an older or newer version of GCC.
9248 Link-time optimization does not work well with generation of debugging
9249 information.  Combining @option{-flto} with
9250 @option{-g} is currently experimental and expected to produce unexpected
9251 results.
9253 If you specify the optional @var{n}, the optimization and code
9254 generation done at link time is executed in parallel using @var{n}
9255 parallel jobs by utilizing an installed @command{make} program.  The
9256 environment variable @env{MAKE} may be used to override the program
9257 used.  The default value for @var{n} is 1.
9259 You can also specify @option{-flto=jobserver} to use GNU make's
9260 job server mode to determine the number of parallel jobs. This
9261 is useful when the Makefile calling GCC is already executing in parallel.
9262 You must prepend a @samp{+} to the command recipe in the parent Makefile
9263 for this to work.  This option likely only works if @env{MAKE} is
9264 GNU make.
9266 @item -flto-partition=@var{alg}
9267 @opindex flto-partition
9268 Specify the partitioning algorithm used by the link-time optimizer.
9269 The value is either @samp{1to1} to specify a partitioning mirroring
9270 the original source files or @samp{balanced} to specify partitioning
9271 into equally sized chunks (whenever possible) or @samp{max} to create
9272 new partition for every symbol where possible.  Specifying @samp{none}
9273 as an algorithm disables partitioning and streaming completely. 
9274 The default value is @samp{balanced}. While @samp{1to1} can be used
9275 as an workaround for various code ordering issues, the @samp{max}
9276 partitioning is intended for internal testing only.
9277 The value @samp{one} specifies that exactly one partition should be
9278 used while the value @samp{none} bypasses partitioning and executes
9279 the link-time optimization step directly from the WPA phase.
9281 @item -flto-odr-type-merging
9282 @opindex flto-odr-type-merging
9283 Enable streaming of mangled types names of C++ types and their unification
9284 at link time.  This increases size of LTO object files, but enables
9285 diagnostics about One Definition Rule violations.
9287 @item -flto-compression-level=@var{n}
9288 @opindex flto-compression-level
9289 This option specifies the level of compression used for intermediate
9290 language written to LTO object files, and is only meaningful in
9291 conjunction with LTO mode (@option{-flto}).  Valid
9292 values are 0 (no compression) to 9 (maximum compression).  Values
9293 outside this range are clamped to either 0 or 9.  If the option is not
9294 given, a default balanced compression setting is used.
9296 @item -fuse-linker-plugin
9297 @opindex fuse-linker-plugin
9298 Enables the use of a linker plugin during link-time optimization.  This
9299 option relies on plugin support in the linker, which is available in gold
9300 or in GNU ld 2.21 or newer.
9302 This option enables the extraction of object files with GIMPLE bytecode out
9303 of library archives. This improves the quality of optimization by exposing
9304 more code to the link-time optimizer.  This information specifies what
9305 symbols can be accessed externally (by non-LTO object or during dynamic
9306 linking).  Resulting code quality improvements on binaries (and shared
9307 libraries that use hidden visibility) are similar to @option{-fwhole-program}.
9308 See @option{-flto} for a description of the effect of this flag and how to
9309 use it.
9311 This option is enabled by default when LTO support in GCC is enabled
9312 and GCC was configured for use with
9313 a linker supporting plugins (GNU ld 2.21 or newer or gold).
9315 @item -ffat-lto-objects
9316 @opindex ffat-lto-objects
9317 Fat LTO objects are object files that contain both the intermediate language
9318 and the object code. This makes them usable for both LTO linking and normal
9319 linking. This option is effective only when compiling with @option{-flto}
9320 and is ignored at link time.
9322 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
9323 requires the complete toolchain to be aware of LTO. It requires a linker with
9324 linker plugin support for basic functionality.  Additionally,
9325 @command{nm}, @command{ar} and @command{ranlib}
9326 need to support linker plugins to allow a full-featured build environment
9327 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
9328 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
9329 to these tools. With non fat LTO makefiles need to be modified to use them.
9331 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
9332 support.
9334 @item -fcompare-elim
9335 @opindex fcompare-elim
9336 After register allocation and post-register allocation instruction splitting,
9337 identify arithmetic instructions that compute processor flags similar to a
9338 comparison operation based on that arithmetic.  If possible, eliminate the
9339 explicit comparison operation.
9341 This pass only applies to certain targets that cannot explicitly represent
9342 the comparison operation before register allocation is complete.
9344 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9346 @item -fcprop-registers
9347 @opindex fcprop-registers
9348 After register allocation and post-register allocation instruction splitting,
9349 perform a copy-propagation pass to try to reduce scheduling dependencies
9350 and occasionally eliminate the copy.
9352 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9354 @item -fprofile-correction
9355 @opindex fprofile-correction
9356 Profiles collected using an instrumented binary for multi-threaded programs may
9357 be inconsistent due to missed counter updates. When this option is specified,
9358 GCC uses heuristics to correct or smooth out such inconsistencies. By
9359 default, GCC emits an error message when an inconsistent profile is detected.
9361 @item -fprofile-use
9362 @itemx -fprofile-use=@var{path}
9363 @opindex fprofile-use
9364 Enable profile feedback-directed optimizations, 
9365 and the following optimizations
9366 which are generally profitable only with profile feedback available:
9367 @option{-fbranch-probabilities}, @option{-fvpt},
9368 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9369 @option{-ftree-vectorize}, and @option{ftree-loop-distribute-patterns}.
9371 Before you can use this option, you must first generate profiling information.
9372 @xref{Instrumentation Options}, for information about the
9373 @option{-fprofile-generate} option.
9375 By default, GCC emits an error message if the feedback profiles do not
9376 match the source code.  This error can be turned into a warning by using
9377 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
9378 code.
9380 If @var{path} is specified, GCC looks at the @var{path} to find
9381 the profile feedback data files. See @option{-fprofile-dir}.
9383 @item -fauto-profile
9384 @itemx -fauto-profile=@var{path}
9385 @opindex fauto-profile
9386 Enable sampling-based feedback-directed optimizations, 
9387 and the following optimizations
9388 which are generally profitable only with profile feedback available:
9389 @option{-fbranch-probabilities}, @option{-fvpt},
9390 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9391 @option{-ftree-vectorize},
9392 @option{-finline-functions}, @option{-fipa-cp}, @option{-fipa-cp-clone},
9393 @option{-fpredictive-commoning}, @option{-funswitch-loops},
9394 @option{-fgcse-after-reload}, and @option{-ftree-loop-distribute-patterns}.
9396 @var{path} is the name of a file containing AutoFDO profile information.
9397 If omitted, it defaults to @file{fbdata.afdo} in the current directory.
9399 Producing an AutoFDO profile data file requires running your program
9400 with the @command{perf} utility on a supported GNU/Linux target system.
9401 For more information, see @uref{https://perf.wiki.kernel.org/}.
9403 E.g.
9404 @smallexample
9405 perf record -e br_inst_retired:near_taken -b -o perf.data \
9406     -- your_program
9407 @end smallexample
9409 Then use the @command{create_gcov} tool to convert the raw profile data
9410 to a format that can be used by GCC.@  You must also supply the 
9411 unstripped binary for your program to this tool.  
9412 See @uref{https://github.com/google/autofdo}.
9414 E.g.
9415 @smallexample
9416 create_gcov --binary=your_program.unstripped --profile=perf.data \
9417     --gcov=profile.afdo
9418 @end smallexample
9419 @end table
9421 The following options control compiler behavior regarding floating-point 
9422 arithmetic.  These options trade off between speed and
9423 correctness.  All must be specifically enabled.
9425 @table @gcctabopt
9426 @item -ffloat-store
9427 @opindex ffloat-store
9428 Do not store floating-point variables in registers, and inhibit other
9429 options that might change whether a floating-point value is taken from a
9430 register or memory.
9432 @cindex floating-point precision
9433 This option prevents undesirable excess precision on machines such as
9434 the 68000 where the floating registers (of the 68881) keep more
9435 precision than a @code{double} is supposed to have.  Similarly for the
9436 x86 architecture.  For most programs, the excess precision does only
9437 good, but a few programs rely on the precise definition of IEEE floating
9438 point.  Use @option{-ffloat-store} for such programs, after modifying
9439 them to store all pertinent intermediate computations into variables.
9441 @item -fexcess-precision=@var{style}
9442 @opindex fexcess-precision
9443 This option allows further control over excess precision on machines
9444 where floating-point operations occur in a format with more precision or
9445 range than the IEEE standard and interchange floating-point types.  By
9446 default, @option{-fexcess-precision=fast} is in effect; this means that
9447 operations may be carried out in a wider precision than the types specified
9448 in the source if that would result in faster code, and it is unpredictable
9449 when rounding to the types specified in the source code takes place.
9450 When compiling C, if @option{-fexcess-precision=standard} is specified then
9451 excess precision follows the rules specified in ISO C99; in particular,
9452 both casts and assignments cause values to be rounded to their
9453 semantic types (whereas @option{-ffloat-store} only affects
9454 assignments).  This option is enabled by default for C if a strict
9455 conformance option such as @option{-std=c99} is used.
9456 @option{-ffast-math} enables @option{-fexcess-precision=fast} by default
9457 regardless of whether a strict conformance option is used.
9459 @opindex mfpmath
9460 @option{-fexcess-precision=standard} is not implemented for languages
9461 other than C.  On the x86, it has no effect if @option{-mfpmath=sse}
9462 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
9463 semantics apply without excess precision, and in the latter, rounding
9464 is unpredictable.
9466 @item -ffast-math
9467 @opindex ffast-math
9468 Sets the options @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
9469 @option{-ffinite-math-only}, @option{-fno-rounding-math},
9470 @option{-fno-signaling-nans}, @option{-fcx-limited-range} and
9471 @option{-fexcess-precision=fast}.
9473 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
9475 This option is not turned on by any @option{-O} option besides
9476 @option{-Ofast} since it can result in incorrect output for programs
9477 that depend on an exact implementation of IEEE or ISO rules/specifications
9478 for math functions. It may, however, yield faster code for programs
9479 that do not require the guarantees of these specifications.
9481 @item -fno-math-errno
9482 @opindex fno-math-errno
9483 Do not set @code{errno} after calling math functions that are executed
9484 with a single instruction, e.g., @code{sqrt}.  A program that relies on
9485 IEEE exceptions for math error handling may want to use this flag
9486 for speed while maintaining IEEE arithmetic compatibility.
9488 This option is not turned on by any @option{-O} option since
9489 it can result in incorrect output for programs that depend on
9490 an exact implementation of IEEE or ISO rules/specifications for
9491 math functions. It may, however, yield faster code for programs
9492 that do not require the guarantees of these specifications.
9494 The default is @option{-fmath-errno}.
9496 On Darwin systems, the math library never sets @code{errno}.  There is
9497 therefore no reason for the compiler to consider the possibility that
9498 it might, and @option{-fno-math-errno} is the default.
9500 @item -funsafe-math-optimizations
9501 @opindex funsafe-math-optimizations
9503 Allow optimizations for floating-point arithmetic that (a) assume
9504 that arguments and results are valid and (b) may violate IEEE or
9505 ANSI standards.  When used at link time, it may include libraries
9506 or startup files that change the default FPU control word or other
9507 similar optimizations.
9509 This option is not turned on by any @option{-O} option since
9510 it can result in incorrect output for programs that depend on
9511 an exact implementation of IEEE or ISO rules/specifications for
9512 math functions. It may, however, yield faster code for programs
9513 that do not require the guarantees of these specifications.
9514 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
9515 @option{-fassociative-math} and @option{-freciprocal-math}.
9517 The default is @option{-fno-unsafe-math-optimizations}.
9519 @item -fassociative-math
9520 @opindex fassociative-math
9522 Allow re-association of operands in series of floating-point operations.
9523 This violates the ISO C and C++ language standard by possibly changing
9524 computation result.  NOTE: re-ordering may change the sign of zero as
9525 well as ignore NaNs and inhibit or create underflow or overflow (and
9526 thus cannot be used on code that relies on rounding behavior like
9527 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
9528 and thus may not be used when ordered comparisons are required.
9529 This option requires that both @option{-fno-signed-zeros} and
9530 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
9531 much sense with @option{-frounding-math}. For Fortran the option
9532 is automatically enabled when both @option{-fno-signed-zeros} and
9533 @option{-fno-trapping-math} are in effect.
9535 The default is @option{-fno-associative-math}.
9537 @item -freciprocal-math
9538 @opindex freciprocal-math
9540 Allow the reciprocal of a value to be used instead of dividing by
9541 the value if this enables optimizations.  For example @code{x / y}
9542 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
9543 is subject to common subexpression elimination.  Note that this loses
9544 precision and increases the number of flops operating on the value.
9546 The default is @option{-fno-reciprocal-math}.
9548 @item -ffinite-math-only
9549 @opindex ffinite-math-only
9550 Allow optimizations for floating-point arithmetic that assume
9551 that arguments and results are not NaNs or +-Infs.
9553 This option is not turned on by any @option{-O} option since
9554 it can result in incorrect output for programs that depend on
9555 an exact implementation of IEEE or ISO rules/specifications for
9556 math functions. It may, however, yield faster code for programs
9557 that do not require the guarantees of these specifications.
9559 The default is @option{-fno-finite-math-only}.
9561 @item -fno-signed-zeros
9562 @opindex fno-signed-zeros
9563 Allow optimizations for floating-point arithmetic that ignore the
9564 signedness of zero.  IEEE arithmetic specifies the behavior of
9565 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
9566 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
9567 This option implies that the sign of a zero result isn't significant.
9569 The default is @option{-fsigned-zeros}.
9571 @item -fno-trapping-math
9572 @opindex fno-trapping-math
9573 Compile code assuming that floating-point operations cannot generate
9574 user-visible traps.  These traps include division by zero, overflow,
9575 underflow, inexact result and invalid operation.  This option requires
9576 that @option{-fno-signaling-nans} be in effect.  Setting this option may
9577 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
9579 This option should never be turned on by any @option{-O} option since
9580 it can result in incorrect output for programs that depend on
9581 an exact implementation of IEEE or ISO rules/specifications for
9582 math functions.
9584 The default is @option{-ftrapping-math}.
9586 @item -frounding-math
9587 @opindex frounding-math
9588 Disable transformations and optimizations that assume default floating-point
9589 rounding behavior.  This is round-to-zero for all floating point
9590 to integer conversions, and round-to-nearest for all other arithmetic
9591 truncations.  This option should be specified for programs that change
9592 the FP rounding mode dynamically, or that may be executed with a
9593 non-default rounding mode.  This option disables constant folding of
9594 floating-point expressions at compile time (which may be affected by
9595 rounding mode) and arithmetic transformations that are unsafe in the
9596 presence of sign-dependent rounding modes.
9598 The default is @option{-fno-rounding-math}.
9600 This option is experimental and does not currently guarantee to
9601 disable all GCC optimizations that are affected by rounding mode.
9602 Future versions of GCC may provide finer control of this setting
9603 using C99's @code{FENV_ACCESS} pragma.  This command-line option
9604 will be used to specify the default state for @code{FENV_ACCESS}.
9606 @item -fsignaling-nans
9607 @opindex fsignaling-nans
9608 Compile code assuming that IEEE signaling NaNs may generate user-visible
9609 traps during floating-point operations.  Setting this option disables
9610 optimizations that may change the number of exceptions visible with
9611 signaling NaNs.  This option implies @option{-ftrapping-math}.
9613 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
9614 be defined.
9616 The default is @option{-fno-signaling-nans}.
9618 This option is experimental and does not currently guarantee to
9619 disable all GCC optimizations that affect signaling NaN behavior.
9621 @item -fno-fp-int-builtin-inexact
9622 @opindex fno-fp-int-builtin-inexact
9623 Do not allow the built-in functions @code{ceil}, @code{floor},
9624 @code{round} and @code{trunc}, and their @code{float} and @code{long
9625 double} variants, to generate code that raises the ``inexact''
9626 floating-point exception for noninteger arguments.  ISO C99 and C11
9627 allow these functions to raise the ``inexact'' exception, but ISO/IEC
9628 TS 18661-1:2014, the C bindings to IEEE 754-2008, does not allow these
9629 functions to do so.
9631 The default is @option{-ffp-int-builtin-inexact}, allowing the
9632 exception to be raised.  This option does nothing unless
9633 @option{-ftrapping-math} is in effect.
9635 Even if @option{-fno-fp-int-builtin-inexact} is used, if the functions
9636 generate a call to a library function then the ``inexact'' exception
9637 may be raised if the library implementation does not follow TS 18661.
9639 @item -fsingle-precision-constant
9640 @opindex fsingle-precision-constant
9641 Treat floating-point constants as single precision instead of
9642 implicitly converting them to double-precision constants.
9644 @item -fcx-limited-range
9645 @opindex fcx-limited-range
9646 When enabled, this option states that a range reduction step is not
9647 needed when performing complex division.  Also, there is no checking
9648 whether the result of a complex multiplication or division is @code{NaN
9649 + I*NaN}, with an attempt to rescue the situation in that case.  The
9650 default is @option{-fno-cx-limited-range}, but is enabled by
9651 @option{-ffast-math}.
9653 This option controls the default setting of the ISO C99
9654 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
9655 all languages.
9657 @item -fcx-fortran-rules
9658 @opindex fcx-fortran-rules
9659 Complex multiplication and division follow Fortran rules.  Range
9660 reduction is done as part of complex division, but there is no checking
9661 whether the result of a complex multiplication or division is @code{NaN
9662 + I*NaN}, with an attempt to rescue the situation in that case.
9664 The default is @option{-fno-cx-fortran-rules}.
9666 @end table
9668 The following options control optimizations that may improve
9669 performance, but are not enabled by any @option{-O} options.  This
9670 section includes experimental options that may produce broken code.
9672 @table @gcctabopt
9673 @item -fbranch-probabilities
9674 @opindex fbranch-probabilities
9675 After running a program compiled with @option{-fprofile-arcs}
9676 (@pxref{Instrumentation Options}),
9677 you can compile it a second time using
9678 @option{-fbranch-probabilities}, to improve optimizations based on
9679 the number of times each branch was taken.  When a program
9680 compiled with @option{-fprofile-arcs} exits, it saves arc execution
9681 counts to a file called @file{@var{sourcename}.gcda} for each source
9682 file.  The information in this data file is very dependent on the
9683 structure of the generated code, so you must use the same source code
9684 and the same optimization options for both compilations.
9686 With @option{-fbranch-probabilities}, GCC puts a
9687 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
9688 These can be used to improve optimization.  Currently, they are only
9689 used in one place: in @file{reorg.c}, instead of guessing which path a
9690 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
9691 exactly determine which path is taken more often.
9693 @item -fprofile-values
9694 @opindex fprofile-values
9695 If combined with @option{-fprofile-arcs}, it adds code so that some
9696 data about values of expressions in the program is gathered.
9698 With @option{-fbranch-probabilities}, it reads back the data gathered
9699 from profiling values of expressions for usage in optimizations.
9701 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
9703 @item -fprofile-reorder-functions
9704 @opindex fprofile-reorder-functions
9705 Function reordering based on profile instrumentation collects
9706 first time of execution of a function and orders these functions
9707 in ascending order.
9709 Enabled with @option{-fprofile-use}.
9711 @item -fvpt
9712 @opindex fvpt
9713 If combined with @option{-fprofile-arcs}, this option instructs the compiler
9714 to add code to gather information about values of expressions.
9716 With @option{-fbranch-probabilities}, it reads back the data gathered
9717 and actually performs the optimizations based on them.
9718 Currently the optimizations include specialization of division operations
9719 using the knowledge about the value of the denominator.
9721 @item -frename-registers
9722 @opindex frename-registers
9723 Attempt to avoid false dependencies in scheduled code by making use
9724 of registers left over after register allocation.  This optimization
9725 most benefits processors with lots of registers.  Depending on the
9726 debug information format adopted by the target, however, it can
9727 make debugging impossible, since variables no longer stay in
9728 a ``home register''.
9730 Enabled by default with @option{-funroll-loops}.
9732 @item -fschedule-fusion
9733 @opindex fschedule-fusion
9734 Performs a target dependent pass over the instruction stream to schedule
9735 instructions of same type together because target machine can execute them
9736 more efficiently if they are adjacent to each other in the instruction flow.
9738 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9740 @item -ftracer
9741 @opindex ftracer
9742 Perform tail duplication to enlarge superblock size.  This transformation
9743 simplifies the control flow of the function allowing other optimizations to do
9744 a better job.
9746 Enabled with @option{-fprofile-use}.
9748 @item -funroll-loops
9749 @opindex funroll-loops
9750 Unroll loops whose number of iterations can be determined at compile time or
9751 upon entry to the loop.  @option{-funroll-loops} implies
9752 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
9753 It also turns on complete loop peeling (i.e.@: complete removal of loops with
9754 a small constant number of iterations).  This option makes code larger, and may
9755 or may not make it run faster.
9757 Enabled with @option{-fprofile-use}.
9759 @item -funroll-all-loops
9760 @opindex funroll-all-loops
9761 Unroll all loops, even if their number of iterations is uncertain when
9762 the loop is entered.  This usually makes programs run more slowly.
9763 @option{-funroll-all-loops} implies the same options as
9764 @option{-funroll-loops}.
9766 @item -fpeel-loops
9767 @opindex fpeel-loops
9768 Peels loops for which there is enough information that they do not
9769 roll much (from profile feedback or static analysis).  It also turns on
9770 complete loop peeling (i.e.@: complete removal of loops with small constant
9771 number of iterations).
9773 Enabled with @option{-O3} and/or @option{-fprofile-use}.
9775 @item -fmove-loop-invariants
9776 @opindex fmove-loop-invariants
9777 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
9778 at level @option{-O1}
9780 @item -fsplit-loops
9781 @opindex fsplit-loops
9782 Split a loop into two if it contains a condition that's always true
9783 for one side of the iteration space and false for the other.
9785 @item -funswitch-loops
9786 @opindex funswitch-loops
9787 Move branches with loop invariant conditions out of the loop, with duplicates
9788 of the loop on both branches (modified according to result of the condition).
9790 @item -floop-unroll-and-jam
9791 @opindex floop-unroll-and-jam
9792 Apply unroll and jam transoformations on feasible loops.  In a loop
9793 nest this unrolls the outer loop by some factor and fuses the resulting
9794 multiple inner loops.
9796 @item -ffunction-sections
9797 @itemx -fdata-sections
9798 @opindex ffunction-sections
9799 @opindex fdata-sections
9800 Place each function or data item into its own section in the output
9801 file if the target supports arbitrary sections.  The name of the
9802 function or the name of the data item determines the section's name
9803 in the output file.
9805 Use these options on systems where the linker can perform optimizations to
9806 improve locality of reference in the instruction space.  Most systems using the
9807 ELF object format have linkers with such optimizations.  On AIX, the linker
9808 rearranges sections (CSECTs) based on the call graph.  The performance impact
9809 varies.
9811 Together with a linker garbage collection (linker @option{--gc-sections}
9812 option) these options may lead to smaller statically-linked executables (after
9813 stripping).
9815 On ELF/DWARF systems these options do not degenerate the quality of the debug
9816 information.  There could be issues with other object files/debug info formats.
9818 Only use these options when there are significant benefits from doing so.  When
9819 you specify these options, the assembler and linker create larger object and
9820 executable files and are also slower.  These options affect code generation.
9821 They prevent optimizations by the compiler and assembler using relative
9822 locations inside a translation unit since the locations are unknown until
9823 link time.  An example of such an optimization is relaxing calls to short call
9824 instructions.
9826 @item -fbranch-target-load-optimize
9827 @opindex fbranch-target-load-optimize
9828 Perform branch target register load optimization before prologue / epilogue
9829 threading.
9830 The use of target registers can typically be exposed only during reload,
9831 thus hoisting loads out of loops and doing inter-block scheduling needs
9832 a separate optimization pass.
9834 @item -fbranch-target-load-optimize2
9835 @opindex fbranch-target-load-optimize2
9836 Perform branch target register load optimization after prologue / epilogue
9837 threading.
9839 @item -fbtr-bb-exclusive
9840 @opindex fbtr-bb-exclusive
9841 When performing branch target register load optimization, don't reuse
9842 branch target registers within any basic block.
9844 @item -fstdarg-opt
9845 @opindex fstdarg-opt
9846 Optimize the prologue of variadic argument functions with respect to usage of
9847 those arguments.
9849 @item -fsection-anchors
9850 @opindex fsection-anchors
9851 Try to reduce the number of symbolic address calculations by using
9852 shared ``anchor'' symbols to address nearby objects.  This transformation
9853 can help to reduce the number of GOT entries and GOT accesses on some
9854 targets.
9856 For example, the implementation of the following function @code{foo}:
9858 @smallexample
9859 static int a, b, c;
9860 int foo (void) @{ return a + b + c; @}
9861 @end smallexample
9863 @noindent
9864 usually calculates the addresses of all three variables, but if you
9865 compile it with @option{-fsection-anchors}, it accesses the variables
9866 from a common anchor point instead.  The effect is similar to the
9867 following pseudocode (which isn't valid C):
9869 @smallexample
9870 int foo (void)
9872   register int *xr = &x;
9873   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
9875 @end smallexample
9877 Not all targets support this option.
9879 @item --param @var{name}=@var{value}
9880 @opindex param
9881 In some places, GCC uses various constants to control the amount of
9882 optimization that is done.  For example, GCC does not inline functions
9883 that contain more than a certain number of instructions.  You can
9884 control some of these constants on the command line using the
9885 @option{--param} option.
9887 The names of specific parameters, and the meaning of the values, are
9888 tied to the internals of the compiler, and are subject to change
9889 without notice in future releases.
9891 In each case, the @var{value} is an integer.  The allowable choices for
9892 @var{name} are:
9894 @table @gcctabopt
9895 @item predictable-branch-outcome
9896 When branch is predicted to be taken with probability lower than this threshold
9897 (in percent), then it is considered well predictable. The default is 10.
9899 @item max-rtl-if-conversion-insns
9900 RTL if-conversion tries to remove conditional branches around a block and
9901 replace them with conditionally executed instructions.  This parameter
9902 gives the maximum number of instructions in a block which should be
9903 considered for if-conversion.  The default is 10, though the compiler will
9904 also use other heuristics to decide whether if-conversion is likely to be
9905 profitable.
9907 @item max-rtl-if-conversion-predictable-cost
9908 @item max-rtl-if-conversion-unpredictable-cost
9909 RTL if-conversion will try to remove conditional branches around a block
9910 and replace them with conditionally executed instructions.  These parameters
9911 give the maximum permissible cost for the sequence that would be generated
9912 by if-conversion depending on whether the branch is statically determined
9913 to be predictable or not.  The units for this parameter are the same as
9914 those for the GCC internal seq_cost metric.  The compiler will try to
9915 provide a reasonable default for this parameter using the BRANCH_COST
9916 target macro.
9918 @item max-crossjump-edges
9919 The maximum number of incoming edges to consider for cross-jumping.
9920 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
9921 the number of edges incoming to each block.  Increasing values mean
9922 more aggressive optimization, making the compilation time increase with
9923 probably small improvement in executable size.
9925 @item min-crossjump-insns
9926 The minimum number of instructions that must be matched at the end
9927 of two blocks before cross-jumping is performed on them.  This
9928 value is ignored in the case where all instructions in the block being
9929 cross-jumped from are matched.  The default value is 5.
9931 @item max-grow-copy-bb-insns
9932 The maximum code size expansion factor when copying basic blocks
9933 instead of jumping.  The expansion is relative to a jump instruction.
9934 The default value is 8.
9936 @item max-goto-duplication-insns
9937 The maximum number of instructions to duplicate to a block that jumps
9938 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
9939 passes, GCC factors computed gotos early in the compilation process,
9940 and unfactors them as late as possible.  Only computed jumps at the
9941 end of a basic blocks with no more than max-goto-duplication-insns are
9942 unfactored.  The default value is 8.
9944 @item max-delay-slot-insn-search
9945 The maximum number of instructions to consider when looking for an
9946 instruction to fill a delay slot.  If more than this arbitrary number of
9947 instructions are searched, the time savings from filling the delay slot
9948 are minimal, so stop searching.  Increasing values mean more
9949 aggressive optimization, making the compilation time increase with probably
9950 small improvement in execution time.
9952 @item max-delay-slot-live-search
9953 When trying to fill delay slots, the maximum number of instructions to
9954 consider when searching for a block with valid live register
9955 information.  Increasing this arbitrarily chosen value means more
9956 aggressive optimization, increasing the compilation time.  This parameter
9957 should be removed when the delay slot code is rewritten to maintain the
9958 control-flow graph.
9960 @item max-gcse-memory
9961 The approximate maximum amount of memory that can be allocated in
9962 order to perform the global common subexpression elimination
9963 optimization.  If more memory than specified is required, the
9964 optimization is not done.
9966 @item max-gcse-insertion-ratio
9967 If the ratio of expression insertions to deletions is larger than this value
9968 for any expression, then RTL PRE inserts or removes the expression and thus
9969 leaves partially redundant computations in the instruction stream.  The default value is 20.
9971 @item max-pending-list-length
9972 The maximum number of pending dependencies scheduling allows
9973 before flushing the current state and starting over.  Large functions
9974 with few branches or calls can create excessively large lists which
9975 needlessly consume memory and resources.
9977 @item max-modulo-backtrack-attempts
9978 The maximum number of backtrack attempts the scheduler should make
9979 when modulo scheduling a loop.  Larger values can exponentially increase
9980 compilation time.
9982 @item max-inline-insns-single
9983 Several parameters control the tree inliner used in GCC@.
9984 This number sets the maximum number of instructions (counted in GCC's
9985 internal representation) in a single function that the tree inliner
9986 considers for inlining.  This only affects functions declared
9987 inline and methods implemented in a class declaration (C++).
9988 The default value is 400.
9990 @item max-inline-insns-auto
9991 When you use @option{-finline-functions} (included in @option{-O3}),
9992 a lot of functions that would otherwise not be considered for inlining
9993 by the compiler are investigated.  To those functions, a different
9994 (more restrictive) limit compared to functions declared inline can
9995 be applied.
9996 The default value is 40.
9998 @item inline-min-speedup
9999 When estimated performance improvement of caller + callee runtime exceeds this
10000 threshold (in percent), the function can be inlined regardless of the limit on
10001 @option{--param max-inline-insns-single} and @option{--param
10002 max-inline-insns-auto}.
10004 @item large-function-insns
10005 The limit specifying really large functions.  For functions larger than this
10006 limit after inlining, inlining is constrained by
10007 @option{--param large-function-growth}.  This parameter is useful primarily
10008 to avoid extreme compilation time caused by non-linear algorithms used by the
10009 back end.
10010 The default value is 2700.
10012 @item large-function-growth
10013 Specifies maximal growth of large function caused by inlining in percents.
10014 The default value is 100 which limits large function growth to 2.0 times
10015 the original size.
10017 @item large-unit-insns
10018 The limit specifying large translation unit.  Growth caused by inlining of
10019 units larger than this limit is limited by @option{--param inline-unit-growth}.
10020 For small units this might be too tight.
10021 For example, consider a unit consisting of function A
10022 that is inline and B that just calls A three times.  If B is small relative to
10023 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
10024 large units consisting of small inlineable functions, however, the overall unit
10025 growth limit is needed to avoid exponential explosion of code size.  Thus for
10026 smaller units, the size is increased to @option{--param large-unit-insns}
10027 before applying @option{--param inline-unit-growth}.  The default is 10000.
10029 @item inline-unit-growth
10030 Specifies maximal overall growth of the compilation unit caused by inlining.
10031 The default value is 20 which limits unit growth to 1.2 times the original
10032 size. Cold functions (either marked cold via an attribute or by profile
10033 feedback) are not accounted into the unit size.
10035 @item ipcp-unit-growth
10036 Specifies maximal overall growth of the compilation unit caused by
10037 interprocedural constant propagation.  The default value is 10 which limits
10038 unit growth to 1.1 times the original size.
10040 @item large-stack-frame
10041 The limit specifying large stack frames.  While inlining the algorithm is trying
10042 to not grow past this limit too much.  The default value is 256 bytes.
10044 @item large-stack-frame-growth
10045 Specifies maximal growth of large stack frames caused by inlining in percents.
10046 The default value is 1000 which limits large stack frame growth to 11 times
10047 the original size.
10049 @item max-inline-insns-recursive
10050 @itemx max-inline-insns-recursive-auto
10051 Specifies the maximum number of instructions an out-of-line copy of a
10052 self-recursive inline
10053 function can grow into by performing recursive inlining.
10055 @option{--param max-inline-insns-recursive} applies to functions
10056 declared inline.
10057 For functions not declared inline, recursive inlining
10058 happens only when @option{-finline-functions} (included in @option{-O3}) is
10059 enabled; @option{--param max-inline-insns-recursive-auto} applies instead.  The
10060 default value is 450.
10062 @item max-inline-recursive-depth
10063 @itemx max-inline-recursive-depth-auto
10064 Specifies the maximum recursion depth used for recursive inlining.
10066 @option{--param max-inline-recursive-depth} applies to functions
10067 declared inline.  For functions not declared inline, recursive inlining
10068 happens only when @option{-finline-functions} (included in @option{-O3}) is
10069 enabled; @option{--param max-inline-recursive-depth-auto} applies instead.  The
10070 default value is 8.
10072 @item min-inline-recursive-probability
10073 Recursive inlining is profitable only for function having deep recursion
10074 in average and can hurt for function having little recursion depth by
10075 increasing the prologue size or complexity of function body to other
10076 optimizers.
10078 When profile feedback is available (see @option{-fprofile-generate}) the actual
10079 recursion depth can be guessed from the probability that function recurses
10080 via a given call expression.  This parameter limits inlining only to call
10081 expressions whose probability exceeds the given threshold (in percents).
10082 The default value is 10.
10084 @item early-inlining-insns
10085 Specify growth that the early inliner can make.  In effect it increases
10086 the amount of inlining for code having a large abstraction penalty.
10087 The default value is 14.
10089 @item max-early-inliner-iterations
10090 Limit of iterations of the early inliner.  This basically bounds
10091 the number of nested indirect calls the early inliner can resolve.
10092 Deeper chains are still handled by late inlining.
10094 @item comdat-sharing-probability
10095 Probability (in percent) that C++ inline function with comdat visibility
10096 are shared across multiple compilation units.  The default value is 20.
10098 @item profile-func-internal-id
10099 A parameter to control whether to use function internal id in profile
10100 database lookup. If the value is 0, the compiler uses an id that
10101 is based on function assembler name and filename, which makes old profile
10102 data more tolerant to source changes such as function reordering etc.
10103 The default value is 0.
10105 @item min-vect-loop-bound
10106 The minimum number of iterations under which loops are not vectorized
10107 when @option{-ftree-vectorize} is used.  The number of iterations after
10108 vectorization needs to be greater than the value specified by this option
10109 to allow vectorization.  The default value is 0.
10111 @item gcse-cost-distance-ratio
10112 Scaling factor in calculation of maximum distance an expression
10113 can be moved by GCSE optimizations.  This is currently supported only in the
10114 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
10115 is with simple expressions, i.e., the expressions that have cost
10116 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
10117 hoisting of simple expressions.  The default value is 10.
10119 @item gcse-unrestricted-cost
10120 Cost, roughly measured as the cost of a single typical machine
10121 instruction, at which GCSE optimizations do not constrain
10122 the distance an expression can travel.  This is currently
10123 supported only in the code hoisting pass.  The lesser the cost,
10124 the more aggressive code hoisting is.  Specifying 0 
10125 allows all expressions to travel unrestricted distances.
10126 The default value is 3.
10128 @item max-hoist-depth
10129 The depth of search in the dominator tree for expressions to hoist.
10130 This is used to avoid quadratic behavior in hoisting algorithm.
10131 The value of 0 does not limit on the search, but may slow down compilation
10132 of huge functions.  The default value is 30.
10134 @item max-tail-merge-comparisons
10135 The maximum amount of similar bbs to compare a bb with.  This is used to
10136 avoid quadratic behavior in tree tail merging.  The default value is 10.
10138 @item max-tail-merge-iterations
10139 The maximum amount of iterations of the pass over the function.  This is used to
10140 limit compilation time in tree tail merging.  The default value is 2.
10142 @item store-merging-allow-unaligned
10143 Allow the store merging pass to introduce unaligned stores if it is legal to
10144 do so.  The default value is 1.
10146 @item max-stores-to-merge
10147 The maximum number of stores to attempt to merge into wider stores in the store
10148 merging pass.  The minimum value is 2 and the default is 64.
10150 @item max-unrolled-insns
10151 The maximum number of instructions that a loop may have to be unrolled.
10152 If a loop is unrolled, this parameter also determines how many times
10153 the loop code is unrolled.
10155 @item max-average-unrolled-insns
10156 The maximum number of instructions biased by probabilities of their execution
10157 that a loop may have to be unrolled.  If a loop is unrolled,
10158 this parameter also determines how many times the loop code is unrolled.
10160 @item max-unroll-times
10161 The maximum number of unrollings of a single loop.
10163 @item max-peeled-insns
10164 The maximum number of instructions that a loop may have to be peeled.
10165 If a loop is peeled, this parameter also determines how many times
10166 the loop code is peeled.
10168 @item max-peel-times
10169 The maximum number of peelings of a single loop.
10171 @item max-peel-branches
10172 The maximum number of branches on the hot path through the peeled sequence.
10174 @item max-completely-peeled-insns
10175 The maximum number of insns of a completely peeled loop.
10177 @item max-completely-peel-times
10178 The maximum number of iterations of a loop to be suitable for complete peeling.
10180 @item max-completely-peel-loop-nest-depth
10181 The maximum depth of a loop nest suitable for complete peeling.
10183 @item max-unswitch-insns
10184 The maximum number of insns of an unswitched loop.
10186 @item max-unswitch-level
10187 The maximum number of branches unswitched in a single loop.
10189 @item max-loop-headers-insns
10190 The maximum number of insns in loop header duplicated by the copy loop headers
10191 pass.
10193 @item lim-expensive
10194 The minimum cost of an expensive expression in the loop invariant motion.
10196 @item iv-consider-all-candidates-bound
10197 Bound on number of candidates for induction variables, below which
10198 all candidates are considered for each use in induction variable
10199 optimizations.  If there are more candidates than this,
10200 only the most relevant ones are considered to avoid quadratic time complexity.
10202 @item iv-max-considered-uses
10203 The induction variable optimizations give up on loops that contain more
10204 induction variable uses.
10206 @item iv-always-prune-cand-set-bound
10207 If the number of candidates in the set is smaller than this value,
10208 always try to remove unnecessary ivs from the set
10209 when adding a new one.
10211 @item avg-loop-niter
10212 Average number of iterations of a loop.
10214 @item dse-max-object-size
10215 Maximum size (in bytes) of objects tracked bytewise by dead store elimination.
10216 Larger values may result in larger compilation times.
10218 @item scev-max-expr-size
10219 Bound on size of expressions used in the scalar evolutions analyzer.
10220 Large expressions slow the analyzer.
10222 @item scev-max-expr-complexity
10223 Bound on the complexity of the expressions in the scalar evolutions analyzer.
10224 Complex expressions slow the analyzer.
10226 @item max-tree-if-conversion-phi-args
10227 Maximum number of arguments in a PHI supported by TREE if conversion
10228 unless the loop is marked with simd pragma.
10230 @item vect-max-version-for-alignment-checks
10231 The maximum number of run-time checks that can be performed when
10232 doing loop versioning for alignment in the vectorizer.
10234 @item vect-max-version-for-alias-checks
10235 The maximum number of run-time checks that can be performed when
10236 doing loop versioning for alias in the vectorizer.
10238 @item vect-max-peeling-for-alignment
10239 The maximum number of loop peels to enhance access alignment
10240 for vectorizer. Value -1 means no limit.
10242 @item max-iterations-to-track
10243 The maximum number of iterations of a loop the brute-force algorithm
10244 for analysis of the number of iterations of the loop tries to evaluate.
10246 @item hot-bb-count-ws-permille
10247 A basic block profile count is considered hot if it contributes to 
10248 the given permillage (i.e. 0...1000) of the entire profiled execution.
10250 @item hot-bb-frequency-fraction
10251 Select fraction of the entry block frequency of executions of basic block in
10252 function given basic block needs to have to be considered hot.
10254 @item max-predicted-iterations
10255 The maximum number of loop iterations we predict statically.  This is useful
10256 in cases where a function contains a single loop with known bound and
10257 another loop with unknown bound.
10258 The known number of iterations is predicted correctly, while
10259 the unknown number of iterations average to roughly 10.  This means that the
10260 loop without bounds appears artificially cold relative to the other one.
10262 @item builtin-expect-probability
10263 Control the probability of the expression having the specified value. This
10264 parameter takes a percentage (i.e. 0 ... 100) as input.
10265 The default probability of 90 is obtained empirically.
10267 @item align-threshold
10269 Select fraction of the maximal frequency of executions of a basic block in
10270 a function to align the basic block.
10272 @item align-loop-iterations
10274 A loop expected to iterate at least the selected number of iterations is
10275 aligned.
10277 @item tracer-dynamic-coverage
10278 @itemx tracer-dynamic-coverage-feedback
10280 This value is used to limit superblock formation once the given percentage of
10281 executed instructions is covered.  This limits unnecessary code size
10282 expansion.
10284 The @option{tracer-dynamic-coverage-feedback} parameter
10285 is used only when profile
10286 feedback is available.  The real profiles (as opposed to statically estimated
10287 ones) are much less balanced allowing the threshold to be larger value.
10289 @item tracer-max-code-growth
10290 Stop tail duplication once code growth has reached given percentage.  This is
10291 a rather artificial limit, as most of the duplicates are eliminated later in
10292 cross jumping, so it may be set to much higher values than is the desired code
10293 growth.
10295 @item tracer-min-branch-ratio
10297 Stop reverse growth when the reverse probability of best edge is less than this
10298 threshold (in percent).
10300 @item tracer-min-branch-probability
10301 @itemx tracer-min-branch-probability-feedback
10303 Stop forward growth if the best edge has probability lower than this
10304 threshold.
10306 Similarly to @option{tracer-dynamic-coverage} two parameters are
10307 provided.  @option{tracer-min-branch-probability-feedback} is used for
10308 compilation with profile feedback and @option{tracer-min-branch-probability}
10309 compilation without.  The value for compilation with profile feedback
10310 needs to be more conservative (higher) in order to make tracer
10311 effective.
10313 @item stack-clash-protection-guard-size
10314 Specify the size of the operating system provided stack guard as
10315 2 raised to @var{num} bytes.  The default value is 12 (4096 bytes).
10316 Acceptable values are between 12 and 30.  Higher values may reduce the
10317 number of explicit probes, but a value larger than the operating system
10318 provided guard will leave code vulnerable to stack clash style attacks.
10320 @item stack-clash-protection-probe-interval
10321 Stack clash protection involves probing stack space as it is allocated.  This
10322 param controls the maximum distance between probes into the stack as 2 raised
10323 to @var{num} bytes.  Acceptable values are between 10 and 16 and defaults to
10324 12.  Higher values may reduce the number of explicit probes, but a value
10325 larger than the operating system provided guard will leave code vulnerable to
10326 stack clash style attacks.
10328 @item max-cse-path-length
10330 The maximum number of basic blocks on path that CSE considers.
10331 The default is 10.
10333 @item max-cse-insns
10334 The maximum number of instructions CSE processes before flushing.
10335 The default is 1000.
10337 @item ggc-min-expand
10339 GCC uses a garbage collector to manage its own memory allocation.  This
10340 parameter specifies the minimum percentage by which the garbage
10341 collector's heap should be allowed to expand between collections.
10342 Tuning this may improve compilation speed; it has no effect on code
10343 generation.
10345 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
10346 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
10347 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
10348 GCC is not able to calculate RAM on a particular platform, the lower
10349 bound of 30% is used.  Setting this parameter and
10350 @option{ggc-min-heapsize} to zero causes a full collection to occur at
10351 every opportunity.  This is extremely slow, but can be useful for
10352 debugging.
10354 @item ggc-min-heapsize
10356 Minimum size of the garbage collector's heap before it begins bothering
10357 to collect garbage.  The first collection occurs after the heap expands
10358 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
10359 tuning this may improve compilation speed, and has no effect on code
10360 generation.
10362 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
10363 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
10364 with a lower bound of 4096 (four megabytes) and an upper bound of
10365 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
10366 particular platform, the lower bound is used.  Setting this parameter
10367 very large effectively disables garbage collection.  Setting this
10368 parameter and @option{ggc-min-expand} to zero causes a full collection
10369 to occur at every opportunity.
10371 @item max-reload-search-insns
10372 The maximum number of instruction reload should look backward for equivalent
10373 register.  Increasing values mean more aggressive optimization, making the
10374 compilation time increase with probably slightly better performance.
10375 The default value is 100.
10377 @item max-cselib-memory-locations
10378 The maximum number of memory locations cselib should take into account.
10379 Increasing values mean more aggressive optimization, making the compilation time
10380 increase with probably slightly better performance.  The default value is 500.
10382 @item max-sched-ready-insns
10383 The maximum number of instructions ready to be issued the scheduler should
10384 consider at any given time during the first scheduling pass.  Increasing
10385 values mean more thorough searches, making the compilation time increase
10386 with probably little benefit.  The default value is 100.
10388 @item max-sched-region-blocks
10389 The maximum number of blocks in a region to be considered for
10390 interblock scheduling.  The default value is 10.
10392 @item max-pipeline-region-blocks
10393 The maximum number of blocks in a region to be considered for
10394 pipelining in the selective scheduler.  The default value is 15.
10396 @item max-sched-region-insns
10397 The maximum number of insns in a region to be considered for
10398 interblock scheduling.  The default value is 100.
10400 @item max-pipeline-region-insns
10401 The maximum number of insns in a region to be considered for
10402 pipelining in the selective scheduler.  The default value is 200.
10404 @item min-spec-prob
10405 The minimum probability (in percents) of reaching a source block
10406 for interblock speculative scheduling.  The default value is 40.
10408 @item max-sched-extend-regions-iters
10409 The maximum number of iterations through CFG to extend regions.
10410 A value of 0 (the default) disables region extensions.
10412 @item max-sched-insn-conflict-delay
10413 The maximum conflict delay for an insn to be considered for speculative motion.
10414 The default value is 3.
10416 @item sched-spec-prob-cutoff
10417 The minimal probability of speculation success (in percents), so that
10418 speculative insns are scheduled.
10419 The default value is 40.
10421 @item sched-state-edge-prob-cutoff
10422 The minimum probability an edge must have for the scheduler to save its
10423 state across it.
10424 The default value is 10.
10426 @item sched-mem-true-dep-cost
10427 Minimal distance (in CPU cycles) between store and load targeting same
10428 memory locations.  The default value is 1.
10430 @item selsched-max-lookahead
10431 The maximum size of the lookahead window of selective scheduling.  It is a
10432 depth of search for available instructions.
10433 The default value is 50.
10435 @item selsched-max-sched-times
10436 The maximum number of times that an instruction is scheduled during
10437 selective scheduling.  This is the limit on the number of iterations
10438 through which the instruction may be pipelined.  The default value is 2.
10440 @item selsched-insns-to-rename
10441 The maximum number of best instructions in the ready list that are considered
10442 for renaming in the selective scheduler.  The default value is 2.
10444 @item sms-min-sc
10445 The minimum value of stage count that swing modulo scheduler
10446 generates.  The default value is 2.
10448 @item max-last-value-rtl
10449 The maximum size measured as number of RTLs that can be recorded in an expression
10450 in combiner for a pseudo register as last known value of that register.  The default
10451 is 10000.
10453 @item max-combine-insns
10454 The maximum number of instructions the RTL combiner tries to combine.
10455 The default value is 2 at @option{-Og} and 4 otherwise.
10457 @item integer-share-limit
10458 Small integer constants can use a shared data structure, reducing the
10459 compiler's memory usage and increasing its speed.  This sets the maximum
10460 value of a shared integer constant.  The default value is 256.
10462 @item ssp-buffer-size
10463 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
10464 protection when @option{-fstack-protection} is used.
10466 @item min-size-for-stack-sharing
10467 The minimum size of variables taking part in stack slot sharing when not
10468 optimizing. The default value is 32.
10470 @item max-jump-thread-duplication-stmts
10471 Maximum number of statements allowed in a block that needs to be
10472 duplicated when threading jumps.
10474 @item max-fields-for-field-sensitive
10475 Maximum number of fields in a structure treated in
10476 a field sensitive manner during pointer analysis.  The default is zero
10477 for @option{-O0} and @option{-O1},
10478 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
10480 @item prefetch-latency
10481 Estimate on average number of instructions that are executed before
10482 prefetch finishes.  The distance prefetched ahead is proportional
10483 to this constant.  Increasing this number may also lead to less
10484 streams being prefetched (see @option{simultaneous-prefetches}).
10486 @item simultaneous-prefetches
10487 Maximum number of prefetches that can run at the same time.
10489 @item l1-cache-line-size
10490 The size of cache line in L1 cache, in bytes.
10492 @item l1-cache-size
10493 The size of L1 cache, in kilobytes.
10495 @item l2-cache-size
10496 The size of L2 cache, in kilobytes.
10498 @item loop-interchange-max-num-stmts
10499 The maximum number of stmts in a loop to be interchanged.
10501 @item loop-interchange-stride-ratio
10502 The minimum ratio between stride of two loops for interchange to be profitable.
10504 @item min-insn-to-prefetch-ratio
10505 The minimum ratio between the number of instructions and the
10506 number of prefetches to enable prefetching in a loop.
10508 @item prefetch-min-insn-to-mem-ratio
10509 The minimum ratio between the number of instructions and the
10510 number of memory references to enable prefetching in a loop.
10512 @item use-canonical-types
10513 Whether the compiler should use the ``canonical'' type system.  By
10514 default, this should always be 1, which uses a more efficient internal
10515 mechanism for comparing types in C++ and Objective-C++.  However, if
10516 bugs in the canonical type system are causing compilation failures,
10517 set this value to 0 to disable canonical types.
10519 @item switch-conversion-max-branch-ratio
10520 Switch initialization conversion refuses to create arrays that are
10521 bigger than @option{switch-conversion-max-branch-ratio} times the number of
10522 branches in the switch.
10524 @item max-partial-antic-length
10525 Maximum length of the partial antic set computed during the tree
10526 partial redundancy elimination optimization (@option{-ftree-pre}) when
10527 optimizing at @option{-O3} and above.  For some sorts of source code
10528 the enhanced partial redundancy elimination optimization can run away,
10529 consuming all of the memory available on the host machine.  This
10530 parameter sets a limit on the length of the sets that are computed,
10531 which prevents the runaway behavior.  Setting a value of 0 for
10532 this parameter allows an unlimited set length.
10534 @item sccvn-max-scc-size
10535 Maximum size of a strongly connected component (SCC) during SCCVN
10536 processing.  If this limit is hit, SCCVN processing for the whole
10537 function is not done and optimizations depending on it are
10538 disabled.  The default maximum SCC size is 10000.
10540 @item sccvn-max-alias-queries-per-access
10541 Maximum number of alias-oracle queries we perform when looking for
10542 redundancies for loads and stores.  If this limit is hit the search
10543 is aborted and the load or store is not considered redundant.  The
10544 number of queries is algorithmically limited to the number of
10545 stores on all paths from the load to the function entry.
10546 The default maximum number of queries is 1000.
10548 @item ira-max-loops-num
10549 IRA uses regional register allocation by default.  If a function
10550 contains more loops than the number given by this parameter, only at most
10551 the given number of the most frequently-executed loops form regions
10552 for regional register allocation.  The default value of the
10553 parameter is 100.
10555 @item ira-max-conflict-table-size 
10556 Although IRA uses a sophisticated algorithm to compress the conflict
10557 table, the table can still require excessive amounts of memory for
10558 huge functions.  If the conflict table for a function could be more
10559 than the size in MB given by this parameter, the register allocator
10560 instead uses a faster, simpler, and lower-quality
10561 algorithm that does not require building a pseudo-register conflict table.  
10562 The default value of the parameter is 2000.
10564 @item ira-loop-reserved-regs
10565 IRA can be used to evaluate more accurate register pressure in loops
10566 for decisions to move loop invariants (see @option{-O3}).  The number
10567 of available registers reserved for some other purposes is given
10568 by this parameter.  The default value of the parameter is 2, which is
10569 the minimal number of registers needed by typical instructions.
10570 This value is the best found from numerous experiments.
10572 @item lra-inheritance-ebb-probability-cutoff
10573 LRA tries to reuse values reloaded in registers in subsequent insns.
10574 This optimization is called inheritance.  EBB is used as a region to
10575 do this optimization.  The parameter defines a minimal fall-through
10576 edge probability in percentage used to add BB to inheritance EBB in
10577 LRA.  The default value of the parameter is 40.  The value was chosen
10578 from numerous runs of SPEC2000 on x86-64.
10580 @item loop-invariant-max-bbs-in-loop
10581 Loop invariant motion can be very expensive, both in compilation time and
10582 in amount of needed compile-time memory, with very large loops.  Loops
10583 with more basic blocks than this parameter won't have loop invariant
10584 motion optimization performed on them.  The default value of the
10585 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
10587 @item loop-max-datarefs-for-datadeps
10588 Building data dependencies is expensive for very large loops.  This
10589 parameter limits the number of data references in loops that are
10590 considered for data dependence analysis.  These large loops are no
10591 handled by the optimizations using loop data dependencies.
10592 The default value is 1000.
10594 @item max-vartrack-size
10595 Sets a maximum number of hash table slots to use during variable
10596 tracking dataflow analysis of any function.  If this limit is exceeded
10597 with variable tracking at assignments enabled, analysis for that
10598 function is retried without it, after removing all debug insns from
10599 the function.  If the limit is exceeded even without debug insns, var
10600 tracking analysis is completely disabled for the function.  Setting
10601 the parameter to zero makes it unlimited.
10603 @item max-vartrack-expr-depth
10604 Sets a maximum number of recursion levels when attempting to map
10605 variable names or debug temporaries to value expressions.  This trades
10606 compilation time for more complete debug information.  If this is set too
10607 low, value expressions that are available and could be represented in
10608 debug information may end up not being used; setting this higher may
10609 enable the compiler to find more complex debug expressions, but compile
10610 time and memory use may grow.  The default is 12.
10612 @item max-debug-marker-count
10613 Sets a threshold on the number of debug markers (e.g. begin stmt
10614 markers) to avoid complexity explosion at inlining or expanding to RTL.
10615 If a function has more such gimple stmts than the set limit, such stmts
10616 will be dropped from the inlined copy of a function, and from its RTL
10617 expansion.  The default is 100000.
10619 @item min-nondebug-insn-uid
10620 Use uids starting at this parameter for nondebug insns.  The range below
10621 the parameter is reserved exclusively for debug insns created by
10622 @option{-fvar-tracking-assignments}, but debug insns may get
10623 (non-overlapping) uids above it if the reserved range is exhausted.
10625 @item ipa-sra-ptr-growth-factor
10626 IPA-SRA replaces a pointer to an aggregate with one or more new
10627 parameters only when their cumulative size is less or equal to
10628 @option{ipa-sra-ptr-growth-factor} times the size of the original
10629 pointer parameter.
10631 @item sra-max-scalarization-size-Ospeed
10632 @item sra-max-scalarization-size-Osize
10633 The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to
10634 replace scalar parts of aggregates with uses of independent scalar
10635 variables.  These parameters control the maximum size, in storage units,
10636 of aggregate which is considered for replacement when compiling for
10637 speed
10638 (@option{sra-max-scalarization-size-Ospeed}) or size
10639 (@option{sra-max-scalarization-size-Osize}) respectively.
10641 @item tm-max-aggregate-size
10642 When making copies of thread-local variables in a transaction, this
10643 parameter specifies the size in bytes after which variables are
10644 saved with the logging functions as opposed to save/restore code
10645 sequence pairs.  This option only applies when using
10646 @option{-fgnu-tm}.
10648 @item graphite-max-nb-scop-params
10649 To avoid exponential effects in the Graphite loop transforms, the
10650 number of parameters in a Static Control Part (SCoP) is bounded.  The
10651 default value is 10 parameters, a value of zero can be used to lift
10652 the bound.  A variable whose value is unknown at compilation time and
10653 defined outside a SCoP is a parameter of the SCoP.
10655 @item loop-block-tile-size
10656 Loop blocking or strip mining transforms, enabled with
10657 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
10658 loop in the loop nest by a given number of iterations.  The strip
10659 length can be changed using the @option{loop-block-tile-size}
10660 parameter.  The default value is 51 iterations.
10662 @item loop-unroll-jam-size
10663 Specify the unroll factor for the @option{-floop-unroll-and-jam} option.  The 
10664 default value is 4.
10666 @item loop-unroll-jam-depth
10667 Specify the dimension to be unrolled (counting from the most inner loop)
10668 for the  @option{-floop-unroll-and-jam}.  The default value is 2.
10670 @item ipa-cp-value-list-size
10671 IPA-CP attempts to track all possible values and types passed to a function's
10672 parameter in order to propagate them and perform devirtualization.
10673 @option{ipa-cp-value-list-size} is the maximum number of values and types it
10674 stores per one formal parameter of a function.
10676 @item ipa-cp-eval-threshold
10677 IPA-CP calculates its own score of cloning profitability heuristics
10678 and performs those cloning opportunities with scores that exceed
10679 @option{ipa-cp-eval-threshold}.
10681 @item ipa-cp-recursion-penalty
10682 Percentage penalty the recursive functions will receive when they
10683 are evaluated for cloning.
10685 @item ipa-cp-single-call-penalty
10686 Percentage penalty functions containing a single call to another
10687 function will receive when they are evaluated for cloning.
10690 @item ipa-max-agg-items
10691 IPA-CP is also capable to propagate a number of scalar values passed
10692 in an aggregate. @option{ipa-max-agg-items} controls the maximum
10693 number of such values per one parameter.
10695 @item ipa-cp-loop-hint-bonus
10696 When IPA-CP determines that a cloning candidate would make the number
10697 of iterations of a loop known, it adds a bonus of
10698 @option{ipa-cp-loop-hint-bonus} to the profitability score of
10699 the candidate.
10701 @item ipa-cp-array-index-hint-bonus
10702 When IPA-CP determines that a cloning candidate would make the index of
10703 an array access known, it adds a bonus of
10704 @option{ipa-cp-array-index-hint-bonus} to the profitability
10705 score of the candidate.
10707 @item ipa-max-aa-steps
10708 During its analysis of function bodies, IPA-CP employs alias analysis
10709 in order to track values pointed to by function parameters.  In order
10710 not spend too much time analyzing huge functions, it gives up and
10711 consider all memory clobbered after examining
10712 @option{ipa-max-aa-steps} statements modifying memory.
10714 @item lto-partitions
10715 Specify desired number of partitions produced during WHOPR compilation.
10716 The number of partitions should exceed the number of CPUs used for compilation.
10717 The default value is 32.
10719 @item lto-min-partition
10720 Size of minimal partition for WHOPR (in estimated instructions).
10721 This prevents expenses of splitting very small programs into too many
10722 partitions.
10724 @item lto-max-partition
10725 Size of max partition for WHOPR (in estimated instructions).
10726 to provide an upper bound for individual size of partition.
10727 Meant to be used only with balanced partitioning.
10729 @item cxx-max-namespaces-for-diagnostic-help
10730 The maximum number of namespaces to consult for suggestions when C++
10731 name lookup fails for an identifier.  The default is 1000.
10733 @item sink-frequency-threshold
10734 The maximum relative execution frequency (in percents) of the target block
10735 relative to a statement's original block to allow statement sinking of a
10736 statement.  Larger numbers result in more aggressive statement sinking.
10737 The default value is 75.  A small positive adjustment is applied for
10738 statements with memory operands as those are even more profitable so sink.
10740 @item max-stores-to-sink
10741 The maximum number of conditional store pairs that can be sunk.  Set to 0
10742 if either vectorization (@option{-ftree-vectorize}) or if-conversion
10743 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
10745 @item allow-store-data-races
10746 Allow optimizers to introduce new data races on stores.
10747 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10748 at optimization level @option{-Ofast}.
10750 @item case-values-threshold
10751 The smallest number of different values for which it is best to use a
10752 jump-table instead of a tree of conditional branches.  If the value is
10753 0, use the default for the machine.  The default is 0.
10755 @item tree-reassoc-width
10756 Set the maximum number of instructions executed in parallel in
10757 reassociated tree. This parameter overrides target dependent
10758 heuristics used by default if has non zero value.
10760 @item sched-pressure-algorithm
10761 Choose between the two available implementations of
10762 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
10763 and is the more likely to prevent instructions from being reordered.
10764 Algorithm 2 was designed to be a compromise between the relatively
10765 conservative approach taken by algorithm 1 and the rather aggressive
10766 approach taken by the default scheduler.  It relies more heavily on
10767 having a regular register file and accurate register pressure classes.
10768 See @file{haifa-sched.c} in the GCC sources for more details.
10770 The default choice depends on the target.
10772 @item max-slsr-cand-scan
10773 Set the maximum number of existing candidates that are considered when
10774 seeking a basis for a new straight-line strength reduction candidate.
10776 @item asan-globals
10777 Enable buffer overflow detection for global objects.  This kind
10778 of protection is enabled by default if you are using
10779 @option{-fsanitize=address} option.
10780 To disable global objects protection use @option{--param asan-globals=0}.
10782 @item asan-stack
10783 Enable buffer overflow detection for stack objects.  This kind of
10784 protection is enabled by default when using @option{-fsanitize=address}.
10785 To disable stack protection use @option{--param asan-stack=0} option.
10787 @item asan-instrument-reads
10788 Enable buffer overflow detection for memory reads.  This kind of
10789 protection is enabled by default when using @option{-fsanitize=address}.
10790 To disable memory reads protection use
10791 @option{--param asan-instrument-reads=0}.
10793 @item asan-instrument-writes
10794 Enable buffer overflow detection for memory writes.  This kind of
10795 protection is enabled by default when using @option{-fsanitize=address}.
10796 To disable memory writes protection use
10797 @option{--param asan-instrument-writes=0} option.
10799 @item asan-memintrin
10800 Enable detection for built-in functions.  This kind of protection
10801 is enabled by default when using @option{-fsanitize=address}.
10802 To disable built-in functions protection use
10803 @option{--param asan-memintrin=0}.
10805 @item asan-use-after-return
10806 Enable detection of use-after-return.  This kind of protection
10807 is enabled by default when using the @option{-fsanitize=address} option.
10808 To disable it use @option{--param asan-use-after-return=0}.
10810 Note: By default the check is disabled at run time.  To enable it,
10811 add @code{detect_stack_use_after_return=1} to the environment variable
10812 @env{ASAN_OPTIONS}.
10814 @item asan-instrumentation-with-call-threshold
10815 If number of memory accesses in function being instrumented
10816 is greater or equal to this number, use callbacks instead of inline checks.
10817 E.g. to disable inline code use
10818 @option{--param asan-instrumentation-with-call-threshold=0}.
10820 @item use-after-scope-direct-emission-threshold
10821 If the size of a local variable in bytes is smaller or equal to this
10822 number, directly poison (or unpoison) shadow memory instead of using
10823 run-time callbacks.  The default value is 256.
10825 @item chkp-max-ctor-size
10826 Static constructors generated by Pointer Bounds Checker may become very
10827 large and significantly increase compile time at optimization level
10828 @option{-O1} and higher.  This parameter is a maximum number of statements
10829 in a single generated constructor.  Default value is 5000.
10831 @item max-fsm-thread-path-insns
10832 Maximum number of instructions to copy when duplicating blocks on a
10833 finite state automaton jump thread path.  The default is 100.
10835 @item max-fsm-thread-length
10836 Maximum number of basic blocks on a finite state automaton jump thread
10837 path.  The default is 10.
10839 @item max-fsm-thread-paths
10840 Maximum number of new jump thread paths to create for a finite state
10841 automaton.  The default is 50.
10843 @item parloops-chunk-size
10844 Chunk size of omp schedule for loops parallelized by parloops.  The default
10845 is 0.
10847 @item parloops-schedule
10848 Schedule type of omp schedule for loops parallelized by parloops (static,
10849 dynamic, guided, auto, runtime).  The default is static.
10851 @item parloops-min-per-thread
10852 The minimum number of iterations per thread of an innermost parallelized
10853 loop for which the parallelized variant is prefered over the single threaded
10854 one.  The default is 100.  Note that for a parallelized loop nest the
10855 minimum number of iterations of the outermost loop per thread is two.
10857 @item max-ssa-name-query-depth
10858 Maximum depth of recursion when querying properties of SSA names in things
10859 like fold routines.  One level of recursion corresponds to following a
10860 use-def chain.
10862 @item hsa-gen-debug-stores
10863 Enable emission of special debug stores within HSA kernels which are
10864 then read and reported by libgomp plugin.  Generation of these stores
10865 is disabled by default, use @option{--param hsa-gen-debug-stores=1} to
10866 enable it.
10868 @item max-speculative-devirt-maydefs
10869 The maximum number of may-defs we analyze when looking for a must-def
10870 specifying the dynamic type of an object that invokes a virtual call
10871 we may be able to devirtualize speculatively.
10873 @item max-vrp-switch-assertions
10874 The maximum number of assertions to add along the default edge of a switch
10875 statement during VRP.  The default is 10.
10877 @item unroll-jam-min-percent
10878 The minimum percentage of memory references that must be optimized
10879 away for the unroll-and-jam transformation to be considered profitable.
10881 @item unroll-jam-max-unroll
10882 The maximum number of times the outer loop should be unrolled by
10883 the unroll-and-jam transformation.
10884 @end table
10885 @end table
10887 @node Instrumentation Options
10888 @section Program Instrumentation Options
10889 @cindex instrumentation options
10890 @cindex program instrumentation options
10891 @cindex run-time error checking options
10892 @cindex profiling options
10893 @cindex options, program instrumentation
10894 @cindex options, run-time error checking
10895 @cindex options, profiling
10897 GCC supports a number of command-line options that control adding
10898 run-time instrumentation to the code it normally generates.  
10899 For example, one purpose of instrumentation is collect profiling
10900 statistics for use in finding program hot spots, code coverage
10901 analysis, or profile-guided optimizations.
10902 Another class of program instrumentation is adding run-time checking 
10903 to detect programming errors like invalid pointer
10904 dereferences or out-of-bounds array accesses, as well as deliberately
10905 hostile attacks such as stack smashing or C++ vtable hijacking.
10906 There is also a general hook which can be used to implement other
10907 forms of tracing or function-level instrumentation for debug or
10908 program analysis purposes.
10910 @table @gcctabopt
10911 @cindex @command{prof}
10912 @item -p
10913 @opindex p
10914 Generate extra code to write profile information suitable for the
10915 analysis program @command{prof}.  You must use this option when compiling
10916 the source files you want data about, and you must also use it when
10917 linking.
10919 @cindex @command{gprof}
10920 @item -pg
10921 @opindex pg
10922 Generate extra code to write profile information suitable for the
10923 analysis program @command{gprof}.  You must use this option when compiling
10924 the source files you want data about, and you must also use it when
10925 linking.
10927 @item -fprofile-arcs
10928 @opindex fprofile-arcs
10929 Add code so that program flow @dfn{arcs} are instrumented.  During
10930 execution the program records how many times each branch and call is
10931 executed and how many times it is taken or returns.  On targets that support
10932 constructors with priority support, profiling properly handles constructors,
10933 destructors and C++ constructors (and destructors) of classes which are used
10934 as a type of a global variable.
10936 When the compiled
10937 program exits it saves this data to a file called
10938 @file{@var{auxname}.gcda} for each source file.  The data may be used for
10939 profile-directed optimizations (@option{-fbranch-probabilities}), or for
10940 test coverage analysis (@option{-ftest-coverage}).  Each object file's
10941 @var{auxname} is generated from the name of the output file, if
10942 explicitly specified and it is not the final executable, otherwise it is
10943 the basename of the source file.  In both cases any suffix is removed
10944 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
10945 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
10946 @xref{Cross-profiling}.
10948 @cindex @command{gcov}
10949 @item --coverage
10950 @opindex coverage
10952 This option is used to compile and link code instrumented for coverage
10953 analysis.  The option is a synonym for @option{-fprofile-arcs}
10954 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
10955 linking).  See the documentation for those options for more details.
10957 @itemize
10959 @item
10960 Compile the source files with @option{-fprofile-arcs} plus optimization
10961 and code generation options.  For test coverage analysis, use the
10962 additional @option{-ftest-coverage} option.  You do not need to profile
10963 every source file in a program.
10965 @item
10966 Compile the source files additionally with @option{-fprofile-abs-path}
10967 to create absolute path names in the @file{.gcno} files.  This allows
10968 @command{gcov} to find the correct sources in projects where compilations
10969 occur with different working directories.
10971 @item
10972 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
10973 (the latter implies the former).
10975 @item
10976 Run the program on a representative workload to generate the arc profile
10977 information.  This may be repeated any number of times.  You can run
10978 concurrent instances of your program, and provided that the file system
10979 supports locking, the data files will be correctly updated.  Unless
10980 a strict ISO C dialect option is in effect, @code{fork} calls are
10981 detected and correctly handled without double counting.
10983 @item
10984 For profile-directed optimizations, compile the source files again with
10985 the same optimization and code generation options plus
10986 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
10987 Control Optimization}).
10989 @item
10990 For test coverage analysis, use @command{gcov} to produce human readable
10991 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
10992 @command{gcov} documentation for further information.
10994 @end itemize
10996 With @option{-fprofile-arcs}, for each function of your program GCC
10997 creates a program flow graph, then finds a spanning tree for the graph.
10998 Only arcs that are not on the spanning tree have to be instrumented: the
10999 compiler adds code to count the number of times that these arcs are
11000 executed.  When an arc is the only exit or only entrance to a block, the
11001 instrumentation code can be added to the block; otherwise, a new basic
11002 block must be created to hold the instrumentation code.
11004 @need 2000
11005 @item -ftest-coverage
11006 @opindex ftest-coverage
11007 Produce a notes file that the @command{gcov} code-coverage utility
11008 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
11009 show program coverage.  Each source file's note file is called
11010 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
11011 above for a description of @var{auxname} and instructions on how to
11012 generate test coverage data.  Coverage data matches the source files
11013 more closely if you do not optimize.
11015 @item -fprofile-abs-path
11016 @opindex fprofile-abs-path
11017 Automatically convert relative source file names to absolute path names
11018 in the @file{.gcno} files.  This allows @command{gcov} to find the correct
11019 sources in projects where compilations occur with different working
11020 directories.
11022 @item -fprofile-dir=@var{path}
11023 @opindex fprofile-dir
11025 Set the directory to search for the profile data files in to @var{path}.
11026 This option affects only the profile data generated by
11027 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
11028 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
11029 and its related options.  Both absolute and relative paths can be used.
11030 By default, GCC uses the current directory as @var{path}, thus the
11031 profile data file appears in the same directory as the object file.
11033 @item -fprofile-generate
11034 @itemx -fprofile-generate=@var{path}
11035 @opindex fprofile-generate
11037 Enable options usually used for instrumenting application to produce
11038 profile useful for later recompilation with profile feedback based
11039 optimization.  You must use @option{-fprofile-generate} both when
11040 compiling and when linking your program.
11042 The following options are enabled: @option{-fprofile-arcs}, @option{-fprofile-values}, @option{-fvpt}.
11044 If @var{path} is specified, GCC looks at the @var{path} to find
11045 the profile feedback data files. See @option{-fprofile-dir}.
11047 To optimize the program based on the collected profile information, use
11048 @option{-fprofile-use}.  @xref{Optimize Options}, for more information.
11050 @item -fprofile-update=@var{method}
11051 @opindex fprofile-update
11053 Alter the update method for an application instrumented for profile
11054 feedback based optimization.  The @var{method} argument should be one of
11055 @samp{single}, @samp{atomic} or @samp{prefer-atomic}.
11056 The first one is useful for single-threaded applications,
11057 while the second one prevents profile corruption by emitting thread-safe code.
11059 @strong{Warning:} When an application does not properly join all threads
11060 (or creates an detached thread), a profile file can be still corrupted.
11062 Using @samp{prefer-atomic} would be transformed either to @samp{atomic},
11063 when supported by a target, or to @samp{single} otherwise.  The GCC driver
11064 automatically selects @samp{prefer-atomic} when @option{-pthread}
11065 is present in the command line.
11067 @item -fsanitize=address
11068 @opindex fsanitize=address
11069 Enable AddressSanitizer, a fast memory error detector.
11070 Memory access instructions are instrumented to detect
11071 out-of-bounds and use-after-free bugs.
11072 The option enables @option{-fsanitize-address-use-after-scope}.
11073 See @uref{https://github.com/google/sanitizers/wiki/AddressSanitizer} for
11074 more details.  The run-time behavior can be influenced using the
11075 @env{ASAN_OPTIONS} environment variable.  When set to @code{help=1},
11076 the available options are shown at startup of the instrumented program.  See
11077 @url{https://github.com/google/sanitizers/wiki/AddressSanitizerFlags#run-time-flags}
11078 for a list of supported options.
11079 The option cannot be combined with @option{-fsanitize=thread}
11080 and/or @option{-fcheck-pointer-bounds}.
11082 @item -fsanitize=kernel-address
11083 @opindex fsanitize=kernel-address
11084 Enable AddressSanitizer for Linux kernel.
11085 See @uref{https://github.com/google/kasan/wiki} for more details.
11086 The option cannot be combined with @option{-fcheck-pointer-bounds}.
11088 @item -fsanitize=pointer-compare
11089 @opindex fsanitize=pointer-compare
11090 Instrument comparison operation (<, <=, >, >=) with pointer operands.
11091 The option must be combined with either @option{-fsanitize=kernel-address} or
11092 @option{-fsanitize=address}
11093 The option cannot be combined with @option{-fsanitize=thread}
11094 and/or @option{-fcheck-pointer-bounds}.
11095 Note: By default the check is disabled at run time.  To enable it,
11096 add @code{detect_invalid_pointer_pairs=1} to the environment variable
11097 @env{ASAN_OPTIONS}.
11099 @item -fsanitize=pointer-subtract
11100 @opindex fsanitize=pointer-subtract
11101 Instrument subtraction with pointer operands.
11102 The option must be combined with either @option{-fsanitize=kernel-address} or
11103 @option{-fsanitize=address}
11104 The option cannot be combined with @option{-fsanitize=thread}
11105 and/or @option{-fcheck-pointer-bounds}.
11106 Note: By default the check is disabled at run time.  To enable it,
11107 add @code{detect_invalid_pointer_pairs=1} to the environment variable
11108 @env{ASAN_OPTIONS}.
11110 @item -fsanitize=thread
11111 @opindex fsanitize=thread
11112 Enable ThreadSanitizer, a fast data race detector.
11113 Memory access instructions are instrumented to detect
11114 data race bugs.  See @uref{https://github.com/google/sanitizers/wiki#threadsanitizer} for more
11115 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
11116 environment variable; see
11117 @url{https://github.com/google/sanitizers/wiki/ThreadSanitizerFlags} for a list of
11118 supported options.
11119 The option cannot be combined with @option{-fsanitize=address},
11120 @option{-fsanitize=leak} and/or @option{-fcheck-pointer-bounds}.
11122 Note that sanitized atomic builtins cannot throw exceptions when
11123 operating on invalid memory addresses with non-call exceptions
11124 (@option{-fnon-call-exceptions}).
11126 @item -fsanitize=leak
11127 @opindex fsanitize=leak
11128 Enable LeakSanitizer, a memory leak detector.
11129 This option only matters for linking of executables and
11130 the executable is linked against a library that overrides @code{malloc}
11131 and other allocator functions.  See
11132 @uref{https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer} for more
11133 details.  The run-time behavior can be influenced using the
11134 @env{LSAN_OPTIONS} environment variable.
11135 The option cannot be combined with @option{-fsanitize=thread}.
11137 @item -fsanitize=undefined
11138 @opindex fsanitize=undefined
11139 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
11140 Various computations are instrumented to detect undefined behavior
11141 at runtime.  Current suboptions are:
11143 @table @gcctabopt
11145 @item -fsanitize=shift
11146 @opindex fsanitize=shift
11147 This option enables checking that the result of a shift operation is
11148 not undefined.  Note that what exactly is considered undefined differs
11149 slightly between C and C++, as well as between ISO C90 and C99, etc.
11150 This option has two suboptions, @option{-fsanitize=shift-base} and
11151 @option{-fsanitize=shift-exponent}.
11153 @item -fsanitize=shift-exponent
11154 @opindex fsanitize=shift-exponent
11155 This option enables checking that the second argument of a shift operation
11156 is not negative and is smaller than the precision of the promoted first
11157 argument.
11159 @item -fsanitize=shift-base
11160 @opindex fsanitize=shift-base
11161 If the second argument of a shift operation is within range, check that the
11162 result of a shift operation is not undefined.  Note that what exactly is
11163 considered undefined differs slightly between C and C++, as well as between
11164 ISO C90 and C99, etc.
11166 @item -fsanitize=integer-divide-by-zero
11167 @opindex fsanitize=integer-divide-by-zero
11168 Detect integer division by zero as well as @code{INT_MIN / -1} division.
11170 @item -fsanitize=unreachable
11171 @opindex fsanitize=unreachable
11172 With this option, the compiler turns the @code{__builtin_unreachable}
11173 call into a diagnostics message call instead.  When reaching the
11174 @code{__builtin_unreachable} call, the behavior is undefined.
11176 @item -fsanitize=vla-bound
11177 @opindex fsanitize=vla-bound
11178 This option instructs the compiler to check that the size of a variable
11179 length array is positive.
11181 @item -fsanitize=null
11182 @opindex fsanitize=null
11183 This option enables pointer checking.  Particularly, the application
11184 built with this option turned on will issue an error message when it
11185 tries to dereference a NULL pointer, or if a reference (possibly an
11186 rvalue reference) is bound to a NULL pointer, or if a method is invoked
11187 on an object pointed by a NULL pointer.
11189 @item -fsanitize=return
11190 @opindex fsanitize=return
11191 This option enables return statement checking.  Programs
11192 built with this option turned on will issue an error message
11193 when the end of a non-void function is reached without actually
11194 returning a value.  This option works in C++ only.
11196 @item -fsanitize=signed-integer-overflow
11197 @opindex fsanitize=signed-integer-overflow
11198 This option enables signed integer overflow checking.  We check that
11199 the result of @code{+}, @code{*}, and both unary and binary @code{-}
11200 does not overflow in the signed arithmetics.  Note, integer promotion
11201 rules must be taken into account.  That is, the following is not an
11202 overflow:
11203 @smallexample
11204 signed char a = SCHAR_MAX;
11205 a++;
11206 @end smallexample
11208 @item -fsanitize=bounds
11209 @opindex fsanitize=bounds
11210 This option enables instrumentation of array bounds.  Various out of bounds
11211 accesses are detected.  Flexible array members, flexible array member-like
11212 arrays, and initializers of variables with static storage are not instrumented.
11213 The option cannot be combined with @option{-fcheck-pointer-bounds}.
11215 @item -fsanitize=bounds-strict
11216 @opindex fsanitize=bounds-strict
11217 This option enables strict instrumentation of array bounds.  Most out of bounds
11218 accesses are detected, including flexible array members and flexible array
11219 member-like arrays.  Initializers of variables with static storage are not
11220 instrumented.  The option cannot be combined
11221 with @option{-fcheck-pointer-bounds}.
11223 @item -fsanitize=alignment
11224 @opindex fsanitize=alignment
11226 This option enables checking of alignment of pointers when they are
11227 dereferenced, or when a reference is bound to insufficiently aligned target,
11228 or when a method or constructor is invoked on insufficiently aligned object.
11230 @item -fsanitize=object-size
11231 @opindex fsanitize=object-size
11232 This option enables instrumentation of memory references using the
11233 @code{__builtin_object_size} function.  Various out of bounds pointer
11234 accesses are detected.
11236 @item -fsanitize=float-divide-by-zero
11237 @opindex fsanitize=float-divide-by-zero
11238 Detect floating-point division by zero.  Unlike other similar options,
11239 @option{-fsanitize=float-divide-by-zero} is not enabled by
11240 @option{-fsanitize=undefined}, since floating-point division by zero can
11241 be a legitimate way of obtaining infinities and NaNs.
11243 @item -fsanitize=float-cast-overflow
11244 @opindex fsanitize=float-cast-overflow
11245 This option enables floating-point type to integer conversion checking.
11246 We check that the result of the conversion does not overflow.
11247 Unlike other similar options, @option{-fsanitize=float-cast-overflow} is
11248 not enabled by @option{-fsanitize=undefined}.
11249 This option does not work well with @code{FE_INVALID} exceptions enabled.
11251 @item -fsanitize=nonnull-attribute
11252 @opindex fsanitize=nonnull-attribute
11254 This option enables instrumentation of calls, checking whether null values
11255 are not passed to arguments marked as requiring a non-null value by the
11256 @code{nonnull} function attribute.
11258 @item -fsanitize=returns-nonnull-attribute
11259 @opindex fsanitize=returns-nonnull-attribute
11261 This option enables instrumentation of return statements in functions
11262 marked with @code{returns_nonnull} function attribute, to detect returning
11263 of null values from such functions.
11265 @item -fsanitize=bool
11266 @opindex fsanitize=bool
11268 This option enables instrumentation of loads from bool.  If a value other
11269 than 0/1 is loaded, a run-time error is issued.
11271 @item -fsanitize=enum
11272 @opindex fsanitize=enum
11274 This option enables instrumentation of loads from an enum type.  If
11275 a value outside the range of values for the enum type is loaded,
11276 a run-time error is issued.
11278 @item -fsanitize=vptr
11279 @opindex fsanitize=vptr
11281 This option enables instrumentation of C++ member function calls, member
11282 accesses and some conversions between pointers to base and derived classes,
11283 to verify the referenced object has the correct dynamic type.
11285 @item -fsanitize=pointer-overflow
11286 @opindex fsanitize=pointer-overflow
11288 This option enables instrumentation of pointer arithmetics.  If the pointer
11289 arithmetics overflows, a run-time error is issued.
11291 @item -fsanitize=builtin
11292 @opindex fsanitize=builtin
11294 This option enables instrumentation of arguments to selected builtin
11295 functions.  If an invalid value is passed to such arguments, a run-time
11296 error is issued.  E.g.@ passing 0 as the argument to @code{__builtin_ctz}
11297 or @code{__builtin_clz} invokes undefined behavior and is diagnosed
11298 by this option.
11300 @end table
11302 While @option{-ftrapv} causes traps for signed overflows to be emitted,
11303 @option{-fsanitize=undefined} gives a diagnostic message.
11304 This currently works only for the C family of languages.
11306 @item -fno-sanitize=all
11307 @opindex fno-sanitize=all
11309 This option disables all previously enabled sanitizers.
11310 @option{-fsanitize=all} is not allowed, as some sanitizers cannot be used
11311 together.
11313 @item -fasan-shadow-offset=@var{number}
11314 @opindex fasan-shadow-offset
11315 This option forces GCC to use custom shadow offset in AddressSanitizer checks.
11316 It is useful for experimenting with different shadow memory layouts in
11317 Kernel AddressSanitizer.
11319 @item -fsanitize-sections=@var{s1},@var{s2},...
11320 @opindex fsanitize-sections
11321 Sanitize global variables in selected user-defined sections.  @var{si} may
11322 contain wildcards.
11324 @item -fsanitize-recover@r{[}=@var{opts}@r{]}
11325 @opindex fsanitize-recover
11326 @opindex fno-sanitize-recover
11327 @option{-fsanitize-recover=} controls error recovery mode for sanitizers
11328 mentioned in comma-separated list of @var{opts}.  Enabling this option
11329 for a sanitizer component causes it to attempt to continue
11330 running the program as if no error happened.  This means multiple
11331 runtime errors can be reported in a single program run, and the exit
11332 code of the program may indicate success even when errors
11333 have been reported.  The @option{-fno-sanitize-recover=} option
11334 can be used to alter
11335 this behavior: only the first detected error is reported
11336 and program then exits with a non-zero exit code.
11338 Currently this feature only works for @option{-fsanitize=undefined} (and its suboptions
11339 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return}),
11340 @option{-fsanitize=float-cast-overflow}, @option{-fsanitize=float-divide-by-zero},
11341 @option{-fsanitize=bounds-strict},
11342 @option{-fsanitize=kernel-address} and @option{-fsanitize=address}.
11343 For these sanitizers error recovery is turned on by default,
11344 except @option{-fsanitize=address}, for which this feature is experimental.
11345 @option{-fsanitize-recover=all} and @option{-fno-sanitize-recover=all} is also
11346 accepted, the former enables recovery for all sanitizers that support it,
11347 the latter disables recovery for all sanitizers that support it.
11349 Even if a recovery mode is turned on the compiler side, it needs to be also
11350 enabled on the runtime library side, otherwise the failures are still fatal.
11351 The runtime library defaults to @code{halt_on_error=0} for
11352 ThreadSanitizer and UndefinedBehaviorSanitizer, while default value for
11353 AddressSanitizer is @code{halt_on_error=1}. This can be overridden through
11354 setting the @code{halt_on_error} flag in the corresponding environment variable.
11356 Syntax without an explicit @var{opts} parameter is deprecated.  It is
11357 equivalent to specifying an @var{opts} list of:
11359 @smallexample
11360 undefined,float-cast-overflow,float-divide-by-zero,bounds-strict
11361 @end smallexample
11363 @item -fsanitize-address-use-after-scope
11364 @opindex fsanitize-address-use-after-scope
11365 Enable sanitization of local variables to detect use-after-scope bugs.
11366 The option sets @option{-fstack-reuse} to @samp{none}.
11368 @item -fsanitize-undefined-trap-on-error
11369 @opindex fsanitize-undefined-trap-on-error
11370 The @option{-fsanitize-undefined-trap-on-error} option instructs the compiler to
11371 report undefined behavior using @code{__builtin_trap} rather than
11372 a @code{libubsan} library routine.  The advantage of this is that the
11373 @code{libubsan} library is not needed and is not linked in, so this
11374 is usable even in freestanding environments.
11376 @item -fsanitize-coverage=trace-pc
11377 @opindex fsanitize-coverage=trace-pc
11378 Enable coverage-guided fuzzing code instrumentation.
11379 Inserts a call to @code{__sanitizer_cov_trace_pc} into every basic block.
11381 @item -fsanitize-coverage=trace-cmp
11382 @opindex fsanitize-coverage=trace-cmp
11383 Enable dataflow guided fuzzing code instrumentation.
11384 Inserts a call to @code{__sanitizer_cov_trace_cmp1},
11385 @code{__sanitizer_cov_trace_cmp2}, @code{__sanitizer_cov_trace_cmp4} or
11386 @code{__sanitizer_cov_trace_cmp8} for integral comparison with both operands
11387 variable or @code{__sanitizer_cov_trace_const_cmp1},
11388 @code{__sanitizer_cov_trace_const_cmp2},
11389 @code{__sanitizer_cov_trace_const_cmp4} or
11390 @code{__sanitizer_cov_trace_const_cmp8} for integral comparison with one
11391 operand constant, @code{__sanitizer_cov_trace_cmpf} or
11392 @code{__sanitizer_cov_trace_cmpd} for float or double comparisons and
11393 @code{__sanitizer_cov_trace_switch} for switch statements.
11395 @item -fbounds-check
11396 @opindex fbounds-check
11397 For front ends that support it, generate additional code to check that
11398 indices used to access arrays are within the declared range.  This is
11399 currently only supported by the Fortran front end, where this option
11400 defaults to false.
11402 @item -fcheck-pointer-bounds
11403 @opindex fcheck-pointer-bounds
11404 @opindex fno-check-pointer-bounds
11405 @cindex Pointer Bounds Checker options
11406 Enable Pointer Bounds Checker instrumentation.  Each memory reference
11407 is instrumented with checks of the pointer used for memory access against
11408 bounds associated with that pointer.  
11410 Currently there
11411 is only an implementation for Intel MPX available, thus x86 GNU/Linux target
11412 and @option{-mmpx} are required to enable this feature.  
11413 MPX-based instrumentation requires
11414 a runtime library to enable MPX in hardware and handle bounds
11415 violation signals.  By default when @option{-fcheck-pointer-bounds}
11416 and @option{-mmpx} options are used to link a program, the GCC driver
11417 links against the @file{libmpx} and @file{libmpxwrappers} libraries.
11418 Bounds checking on calls to dynamic libraries requires a linker
11419 with @option{-z bndplt} support; if GCC was configured with a linker
11420 without support for this option (including the Gold linker and older
11421 versions of ld), a warning is given if you link with @option{-mmpx}
11422 without also specifying @option{-static}, since the overall effectiveness
11423 of the bounds checking protection is reduced.
11424 See also @option{-static-libmpxwrappers}.
11426 MPX-based instrumentation
11427 may be used for debugging and also may be included in production code
11428 to increase program security.  Depending on usage, you may
11429 have different requirements for the runtime library.  The current version
11430 of the MPX runtime library is more oriented for use as a debugging
11431 tool.  MPX runtime library usage implies @option{-lpthread}.  See
11432 also @option{-static-libmpx}.  The runtime library  behavior can be
11433 influenced using various @env{CHKP_RT_*} environment variables.  See
11434 @uref{https://gcc.gnu.org/wiki/Intel%20MPX%20support%20in%20the%20GCC%20compiler}
11435 for more details.
11437 Generated instrumentation may be controlled by various
11438 @option{-fchkp-*} options and by the @code{bnd_variable_size}
11439 structure field attribute (@pxref{Type Attributes}) and
11440 @code{bnd_legacy}, and @code{bnd_instrument} function attributes
11441 (@pxref{Function Attributes}).  GCC also provides a number of built-in
11442 functions for controlling the Pointer Bounds Checker.  @xref{Pointer
11443 Bounds Checker builtins}, for more information.
11445 @item -fchkp-check-incomplete-type
11446 @opindex fchkp-check-incomplete-type
11447 @opindex fno-chkp-check-incomplete-type
11448 Generate pointer bounds checks for variables with incomplete type.
11449 Enabled by default.
11451 @item -fchkp-narrow-bounds
11452 @opindex fchkp-narrow-bounds
11453 @opindex fno-chkp-narrow-bounds
11454 Controls bounds used by Pointer Bounds Checker for pointers to object
11455 fields.  If narrowing is enabled then field bounds are used.  Otherwise
11456 object bounds are used.  See also @option{-fchkp-narrow-to-innermost-array}
11457 and @option{-fchkp-first-field-has-own-bounds}.  Enabled by default.
11459 @item -fchkp-first-field-has-own-bounds
11460 @opindex fchkp-first-field-has-own-bounds
11461 @opindex fno-chkp-first-field-has-own-bounds
11462 Forces Pointer Bounds Checker to use narrowed bounds for the address of the
11463 first field in the structure.  By default a pointer to the first field has
11464 the same bounds as a pointer to the whole structure.
11466 @item -fchkp-flexible-struct-trailing-arrays
11467 @opindex fchkp-flexible-struct-trailing-arrays
11468 @opindex fno-chkp-flexible-struct-trailing-arrays
11469 Forces Pointer Bounds Checker to treat all trailing arrays in structures as
11470 possibly flexible.  By default only array fields with zero length or that are
11471 marked with attribute bnd_variable_size are treated as flexible.
11473 @item -fchkp-narrow-to-innermost-array
11474 @opindex fchkp-narrow-to-innermost-array
11475 @opindex fno-chkp-narrow-to-innermost-array
11476 Forces Pointer Bounds Checker to use bounds of the innermost arrays in
11477 case of nested static array access.  By default this option is disabled and
11478 bounds of the outermost array are used.
11480 @item -fchkp-optimize
11481 @opindex fchkp-optimize
11482 @opindex fno-chkp-optimize
11483 Enables Pointer Bounds Checker optimizations.  Enabled by default at
11484 optimization levels @option{-O}, @option{-O2}, @option{-O3}.
11486 @item -fchkp-use-fast-string-functions
11487 @opindex fchkp-use-fast-string-functions
11488 @opindex fno-chkp-use-fast-string-functions
11489 Enables use of @code{*_nobnd} versions of string functions (not copying bounds)
11490 by Pointer Bounds Checker.  Disabled by default.
11492 @item -fchkp-use-nochk-string-functions
11493 @opindex fchkp-use-nochk-string-functions
11494 @opindex fno-chkp-use-nochk-string-functions
11495 Enables use of @code{*_nochk} versions of string functions (not checking bounds)
11496 by Pointer Bounds Checker.  Disabled by default.
11498 @item -fchkp-use-static-bounds
11499 @opindex fchkp-use-static-bounds
11500 @opindex fno-chkp-use-static-bounds
11501 Allow Pointer Bounds Checker to generate static bounds holding
11502 bounds of static variables.  Enabled by default.
11504 @item -fchkp-use-static-const-bounds
11505 @opindex fchkp-use-static-const-bounds
11506 @opindex fno-chkp-use-static-const-bounds
11507 Use statically-initialized bounds for constant bounds instead of
11508 generating them each time they are required.  By default enabled when
11509 @option{-fchkp-use-static-bounds} is enabled.
11511 @item -fchkp-treat-zero-dynamic-size-as-infinite
11512 @opindex fchkp-treat-zero-dynamic-size-as-infinite
11513 @opindex fno-chkp-treat-zero-dynamic-size-as-infinite
11514 With this option, objects with incomplete type whose
11515 dynamically-obtained size is zero are treated as having infinite size
11516 instead by Pointer Bounds
11517 Checker.  This option may be helpful if a program is linked with a library
11518 missing size information for some symbols.  Disabled by default.
11520 @item -fchkp-check-read
11521 @opindex fchkp-check-read
11522 @opindex fno-chkp-check-read
11523 Instructs Pointer Bounds Checker to generate checks for all read
11524 accesses to memory.  Enabled by default.
11526 @item -fchkp-check-write
11527 @opindex fchkp-check-write
11528 @opindex fno-chkp-check-write
11529 Instructs Pointer Bounds Checker to generate checks for all write
11530 accesses to memory.  Enabled by default.
11532 @item -fchkp-store-bounds
11533 @opindex fchkp-store-bounds
11534 @opindex fno-chkp-store-bounds
11535 Instructs Pointer Bounds Checker to generate bounds stores for
11536 pointer writes.  Enabled by default.
11538 @item -fchkp-instrument-calls
11539 @opindex fchkp-instrument-calls
11540 @opindex fno-chkp-instrument-calls
11541 Instructs Pointer Bounds Checker to pass pointer bounds to calls.
11542 Enabled by default.
11544 @item -fchkp-instrument-marked-only
11545 @opindex fchkp-instrument-marked-only
11546 @opindex fno-chkp-instrument-marked-only
11547 Instructs Pointer Bounds Checker to instrument only functions
11548 marked with the @code{bnd_instrument} attribute
11549 (@pxref{Function Attributes}).  Disabled by default.
11551 @item -fchkp-use-wrappers
11552 @opindex fchkp-use-wrappers
11553 @opindex fno-chkp-use-wrappers
11554 Allows Pointer Bounds Checker to replace calls to built-in functions
11555 with calls to wrapper functions.  When @option{-fchkp-use-wrappers}
11556 is used to link a program, the GCC driver automatically links
11557 against @file{libmpxwrappers}.  See also @option{-static-libmpxwrappers}.
11558 Enabled by default.
11560 @item -fcf-protection==@r{[}full@r{|}branch@r{|}return@r{|}none@r{]}
11561 @opindex fcf-protection
11562 Enable code instrumentation of control-flow transfers to increase
11563 program security by checking that target addresses of control-flow
11564 transfer instructions (such as indirect function call, function return,
11565 indirect jump) are valid.  This prevents diverting the flow of control
11566 to an unexpected target.  This is intended to protect against such
11567 threats as Return-oriented Programming (ROP), and similarly
11568 call/jmp-oriented programming (COP/JOP).
11570 The value @code{branch} tells the compiler to implement checking of
11571 validity of control-flow transfer at the point of indirect branch
11572 instructions, i.e. call/jmp instructions.  The value @code{return}
11573 implements checking of validity at the point of returning from a
11574 function.  The value @code{full} is an alias for specifying both
11575 @code{branch} and @code{return}. The value @code{none} turns off
11576 instrumentation.
11578 You can also use the @code{nocf_check} attribute to identify
11579 which functions and calls should be skipped from instrumentation
11580 (@pxref{Function Attributes}).
11582 Currently the x86 GNU/Linux target provides an implementation based
11583 on Intel Control-flow Enforcement Technology (CET).  Instrumentation
11584 for x86 is controlled by target-specific options @option{-mcet},
11585 @option{-mibt} and @option{-mshstk} (@pxref{x86 Options}).
11587 @item -fstack-protector
11588 @opindex fstack-protector
11589 Emit extra code to check for buffer overflows, such as stack smashing
11590 attacks.  This is done by adding a guard variable to functions with
11591 vulnerable objects.  This includes functions that call @code{alloca}, and
11592 functions with buffers larger than 8 bytes.  The guards are initialized
11593 when a function is entered and then checked when the function exits.
11594 If a guard check fails, an error message is printed and the program exits.
11596 @item -fstack-protector-all
11597 @opindex fstack-protector-all
11598 Like @option{-fstack-protector} except that all functions are protected.
11600 @item -fstack-protector-strong
11601 @opindex fstack-protector-strong
11602 Like @option{-fstack-protector} but includes additional functions to
11603 be protected --- those that have local array definitions, or have
11604 references to local frame addresses.
11606 @item -fstack-protector-explicit
11607 @opindex fstack-protector-explicit
11608 Like @option{-fstack-protector} but only protects those functions which
11609 have the @code{stack_protect} attribute.
11611 @item -fstack-check
11612 @opindex fstack-check
11613 Generate code to verify that you do not go beyond the boundary of the
11614 stack.  You should specify this flag if you are running in an
11615 environment with multiple threads, but you only rarely need to specify it in
11616 a single-threaded environment since stack overflow is automatically
11617 detected on nearly all systems if there is only one stack.
11619 Note that this switch does not actually cause checking to be done; the
11620 operating system or the language runtime must do that.  The switch causes
11621 generation of code to ensure that they see the stack being extended.
11623 You can additionally specify a string parameter: @samp{no} means no
11624 checking, @samp{generic} means force the use of old-style checking,
11625 @samp{specific} means use the best checking method and is equivalent
11626 to bare @option{-fstack-check}.
11628 Old-style checking is a generic mechanism that requires no specific
11629 target support in the compiler but comes with the following drawbacks:
11631 @enumerate
11632 @item
11633 Modified allocation strategy for large objects: they are always
11634 allocated dynamically if their size exceeds a fixed threshold.  Note this
11635 may change the semantics of some code.
11637 @item
11638 Fixed limit on the size of the static frame of functions: when it is
11639 topped by a particular function, stack checking is not reliable and
11640 a warning is issued by the compiler.
11642 @item
11643 Inefficiency: because of both the modified allocation strategy and the
11644 generic implementation, code performance is hampered.
11645 @end enumerate
11647 Note that old-style stack checking is also the fallback method for
11648 @samp{specific} if no target support has been added in the compiler.
11650 @samp{-fstack-check=} is designed for Ada's needs to detect infinite recursion
11651 and stack overflows.  @samp{specific} is an excellent choice when compiling
11652 Ada code.  It is not generally sufficient to protect against stack-clash
11653 attacks.  To protect against those you want @samp{-fstack-clash-protection}.
11655 @item -fstack-clash-protection
11656 @opindex fstack-clash-protection
11657 Generate code to prevent stack clash style attacks.  When this option is
11658 enabled, the compiler will only allocate one page of stack space at a time
11659 and each page is accessed immediately after allocation.  Thus, it prevents
11660 allocations from jumping over any stack guard page provided by the
11661 operating system.
11663 Most targets do not fully support stack clash protection.  However, on
11664 those targets @option{-fstack-clash-protection} will protect dynamic stack
11665 allocations.  @option{-fstack-clash-protection} may also provide limited
11666 protection for static stack allocations if the target supports
11667 @option{-fstack-check=specific}.
11669 @item -fstack-limit-register=@var{reg}
11670 @itemx -fstack-limit-symbol=@var{sym}
11671 @itemx -fno-stack-limit
11672 @opindex fstack-limit-register
11673 @opindex fstack-limit-symbol
11674 @opindex fno-stack-limit
11675 Generate code to ensure that the stack does not grow beyond a certain value,
11676 either the value of a register or the address of a symbol.  If a larger
11677 stack is required, a signal is raised at run time.  For most targets,
11678 the signal is raised before the stack overruns the boundary, so
11679 it is possible to catch the signal without taking special precautions.
11681 For instance, if the stack starts at absolute address @samp{0x80000000}
11682 and grows downwards, you can use the flags
11683 @option{-fstack-limit-symbol=__stack_limit} and
11684 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11685 of 128KB@.  Note that this may only work with the GNU linker.
11687 You can locally override stack limit checking by using the
11688 @code{no_stack_limit} function attribute (@pxref{Function Attributes}).
11690 @item -fsplit-stack
11691 @opindex fsplit-stack
11692 Generate code to automatically split the stack before it overflows.
11693 The resulting program has a discontiguous stack which can only
11694 overflow if the program is unable to allocate any more memory.  This
11695 is most useful when running threaded programs, as it is no longer
11696 necessary to calculate a good stack size to use for each thread.  This
11697 is currently only implemented for the x86 targets running
11698 GNU/Linux.
11700 When code compiled with @option{-fsplit-stack} calls code compiled
11701 without @option{-fsplit-stack}, there may not be much stack space
11702 available for the latter code to run.  If compiling all code,
11703 including library code, with @option{-fsplit-stack} is not an option,
11704 then the linker can fix up these calls so that the code compiled
11705 without @option{-fsplit-stack} always has a large stack.  Support for
11706 this is implemented in the gold linker in GNU binutils release 2.21
11707 and later.
11709 @item -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]}
11710 @opindex fvtable-verify
11711 This option is only available when compiling C++ code.
11712 It turns on (or off, if using @option{-fvtable-verify=none}) the security
11713 feature that verifies at run time, for every virtual call, that
11714 the vtable pointer through which the call is made is valid for the type of
11715 the object, and has not been corrupted or overwritten.  If an invalid vtable
11716 pointer is detected at run time, an error is reported and execution of the
11717 program is immediately halted.
11719 This option causes run-time data structures to be built at program startup,
11720 which are used for verifying the vtable pointers.  
11721 The options @samp{std} and @samp{preinit}
11722 control the timing of when these data structures are built.  In both cases the
11723 data structures are built before execution reaches @code{main}.  Using
11724 @option{-fvtable-verify=std} causes the data structures to be built after
11725 shared libraries have been loaded and initialized.
11726 @option{-fvtable-verify=preinit} causes them to be built before shared
11727 libraries have been loaded and initialized.
11729 If this option appears multiple times in the command line with different
11730 values specified, @samp{none} takes highest priority over both @samp{std} and
11731 @samp{preinit}; @samp{preinit} takes priority over @samp{std}.
11733 @item -fvtv-debug
11734 @opindex fvtv-debug
11735 When used in conjunction with @option{-fvtable-verify=std} or 
11736 @option{-fvtable-verify=preinit}, causes debug versions of the 
11737 runtime functions for the vtable verification feature to be called.  
11738 This flag also causes the compiler to log information about which 
11739 vtable pointers it finds for each class.
11740 This information is written to a file named @file{vtv_set_ptr_data.log} 
11741 in the directory named by the environment variable @env{VTV_LOGS_DIR} 
11742 if that is defined or the current working directory otherwise.
11744 Note:  This feature @emph{appends} data to the log file. If you want a fresh log
11745 file, be sure to delete any existing one.
11747 @item -fvtv-counts
11748 @opindex fvtv-counts
11749 This is a debugging flag.  When used in conjunction with
11750 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
11751 causes the compiler to keep track of the total number of virtual calls
11752 it encounters and the number of verifications it inserts.  It also
11753 counts the number of calls to certain run-time library functions
11754 that it inserts and logs this information for each compilation unit.
11755 The compiler writes this information to a file named
11756 @file{vtv_count_data.log} in the directory named by the environment
11757 variable @env{VTV_LOGS_DIR} if that is defined or the current working
11758 directory otherwise.  It also counts the size of the vtable pointer sets
11759 for each class, and writes this information to @file{vtv_class_set_sizes.log}
11760 in the same directory.
11762 Note:  This feature @emph{appends} data to the log files.  To get fresh log
11763 files, be sure to delete any existing ones.
11765 @item -finstrument-functions
11766 @opindex finstrument-functions
11767 Generate instrumentation calls for entry and exit to functions.  Just
11768 after function entry and just before function exit, the following
11769 profiling functions are called with the address of the current
11770 function and its call site.  (On some platforms,
11771 @code{__builtin_return_address} does not work beyond the current
11772 function, so the call site information may not be available to the
11773 profiling functions otherwise.)
11775 @smallexample
11776 void __cyg_profile_func_enter (void *this_fn,
11777                                void *call_site);
11778 void __cyg_profile_func_exit  (void *this_fn,
11779                                void *call_site);
11780 @end smallexample
11782 The first argument is the address of the start of the current function,
11783 which may be looked up exactly in the symbol table.
11785 This instrumentation is also done for functions expanded inline in other
11786 functions.  The profiling calls indicate where, conceptually, the
11787 inline function is entered and exited.  This means that addressable
11788 versions of such functions must be available.  If all your uses of a
11789 function are expanded inline, this may mean an additional expansion of
11790 code size.  If you use @code{extern inline} in your C code, an
11791 addressable version of such functions must be provided.  (This is
11792 normally the case anyway, but if you get lucky and the optimizer always
11793 expands the functions inline, you might have gotten away without
11794 providing static copies.)
11796 A function may be given the attribute @code{no_instrument_function}, in
11797 which case this instrumentation is not done.  This can be used, for
11798 example, for the profiling functions listed above, high-priority
11799 interrupt routines, and any functions from which the profiling functions
11800 cannot safely be called (perhaps signal handlers, if the profiling
11801 routines generate output or allocate memory).
11803 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
11804 @opindex finstrument-functions-exclude-file-list
11806 Set the list of functions that are excluded from instrumentation (see
11807 the description of @option{-finstrument-functions}).  If the file that
11808 contains a function definition matches with one of @var{file}, then
11809 that function is not instrumented.  The match is done on substrings:
11810 if the @var{file} parameter is a substring of the file name, it is
11811 considered to be a match.
11813 For example:
11815 @smallexample
11816 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
11817 @end smallexample
11819 @noindent
11820 excludes any inline function defined in files whose pathnames
11821 contain @file{/bits/stl} or @file{include/sys}.
11823 If, for some reason, you want to include letter @samp{,} in one of
11824 @var{sym}, write @samp{\,}. For example,
11825 @option{-finstrument-functions-exclude-file-list='\,\,tmp'}
11826 (note the single quote surrounding the option).
11828 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
11829 @opindex finstrument-functions-exclude-function-list
11831 This is similar to @option{-finstrument-functions-exclude-file-list},
11832 but this option sets the list of function names to be excluded from
11833 instrumentation.  The function name to be matched is its user-visible
11834 name, such as @code{vector<int> blah(const vector<int> &)}, not the
11835 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
11836 match is done on substrings: if the @var{sym} parameter is a substring
11837 of the function name, it is considered to be a match.  For C99 and C++
11838 extended identifiers, the function name must be given in UTF-8, not
11839 using universal character names.
11841 @item -fpatchable-function-entry=@var{N}[,@var{M}]
11842 @opindex fpatchable-function-entry
11843 Generate @var{N} NOPs right at the beginning
11844 of each function, with the function entry point before the @var{M}th NOP.
11845 If @var{M} is omitted, it defaults to @code{0} so the
11846 function entry points to the address just at the first NOP.
11847 The NOP instructions reserve extra space which can be used to patch in
11848 any desired instrumentation at run time, provided that the code segment
11849 is writable.  The amount of space is controllable indirectly via
11850 the number of NOPs; the NOP instruction used corresponds to the instruction
11851 emitted by the internal GCC back-end interface @code{gen_nop}.  This behavior
11852 is target-specific and may also depend on the architecture variant and/or
11853 other compilation options.
11855 For run-time identification, the starting addresses of these areas,
11856 which correspond to their respective function entries minus @var{M},
11857 are additionally collected in the @code{__patchable_function_entries}
11858 section of the resulting binary.
11860 Note that the value of @code{__attribute__ ((patchable_function_entry
11861 (N,M)))} takes precedence over command-line option
11862 @option{-fpatchable-function-entry=N,M}.  This can be used to increase
11863 the area size or to remove it completely on a single function.
11864 If @code{N=0}, no pad location is recorded.
11866 The NOP instructions are inserted at---and maybe before, depending on
11867 @var{M}---the function entry address, even before the prologue.
11869 @end table
11872 @node Preprocessor Options
11873 @section Options Controlling the Preprocessor
11874 @cindex preprocessor options
11875 @cindex options, preprocessor
11877 These options control the C preprocessor, which is run on each C source
11878 file before actual compilation.
11880 If you use the @option{-E} option, nothing is done except preprocessing.
11881 Some of these options make sense only together with @option{-E} because
11882 they cause the preprocessor output to be unsuitable for actual
11883 compilation.
11885 In addition to the options listed here, there are a number of options 
11886 to control search paths for include files documented in 
11887 @ref{Directory Options}.  
11888 Options to control preprocessor diagnostics are listed in 
11889 @ref{Warning Options}.
11891 @table @gcctabopt
11892 @include cppopts.texi
11894 @item -Wp,@var{option}
11895 @opindex Wp
11896 You can use @option{-Wp,@var{option}} to bypass the compiler driver
11897 and pass @var{option} directly through to the preprocessor.  If
11898 @var{option} contains commas, it is split into multiple options at the
11899 commas.  However, many options are modified, translated or interpreted
11900 by the compiler driver before being passed to the preprocessor, and
11901 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
11902 interface is undocumented and subject to change, so whenever possible
11903 you should avoid using @option{-Wp} and let the driver handle the
11904 options instead.
11906 @item -Xpreprocessor @var{option}
11907 @opindex Xpreprocessor
11908 Pass @var{option} as an option to the preprocessor.  You can use this to
11909 supply system-specific preprocessor options that GCC does not 
11910 recognize.
11912 If you want to pass an option that takes an argument, you must use
11913 @option{-Xpreprocessor} twice, once for the option and once for the argument.
11915 @item -no-integrated-cpp
11916 @opindex no-integrated-cpp
11917 Perform preprocessing as a separate pass before compilation.
11918 By default, GCC performs preprocessing as an integrated part of
11919 input tokenization and parsing.
11920 If this option is provided, the appropriate language front end
11921 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
11922 and Objective-C, respectively) is instead invoked twice,
11923 once for preprocessing only and once for actual compilation
11924 of the preprocessed input.
11925 This option may be useful in conjunction with the @option{-B} or
11926 @option{-wrapper} options to specify an alternate preprocessor or
11927 perform additional processing of the program source between
11928 normal preprocessing and compilation.
11930 @end table
11932 @node Assembler Options
11933 @section Passing Options to the Assembler
11935 @c prevent bad page break with this line
11936 You can pass options to the assembler.
11938 @table @gcctabopt
11939 @item -Wa,@var{option}
11940 @opindex Wa
11941 Pass @var{option} as an option to the assembler.  If @var{option}
11942 contains commas, it is split into multiple options at the commas.
11944 @item -Xassembler @var{option}
11945 @opindex Xassembler
11946 Pass @var{option} as an option to the assembler.  You can use this to
11947 supply system-specific assembler options that GCC does not
11948 recognize.
11950 If you want to pass an option that takes an argument, you must use
11951 @option{-Xassembler} twice, once for the option and once for the argument.
11953 @end table
11955 @node Link Options
11956 @section Options for Linking
11957 @cindex link options
11958 @cindex options, linking
11960 These options come into play when the compiler links object files into
11961 an executable output file.  They are meaningless if the compiler is
11962 not doing a link step.
11964 @table @gcctabopt
11965 @cindex file names
11966 @item @var{object-file-name}
11967 A file name that does not end in a special recognized suffix is
11968 considered to name an object file or library.  (Object files are
11969 distinguished from libraries by the linker according to the file
11970 contents.)  If linking is done, these object files are used as input
11971 to the linker.
11973 @item -c
11974 @itemx -S
11975 @itemx -E
11976 @opindex c
11977 @opindex S
11978 @opindex E
11979 If any of these options is used, then the linker is not run, and
11980 object file names should not be used as arguments.  @xref{Overall
11981 Options}.
11983 @item -fuse-ld=bfd
11984 @opindex fuse-ld=bfd
11985 Use the @command{bfd} linker instead of the default linker.
11987 @item -fuse-ld=gold
11988 @opindex fuse-ld=gold
11989 Use the @command{gold} linker instead of the default linker.
11991 @cindex Libraries
11992 @item -l@var{library}
11993 @itemx -l @var{library}
11994 @opindex l
11995 Search the library named @var{library} when linking.  (The second
11996 alternative with the library as a separate argument is only for
11997 POSIX compliance and is not recommended.)
11999 It makes a difference where in the command you write this option; the
12000 linker searches and processes libraries and object files in the order they
12001 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
12002 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
12003 to functions in @samp{z}, those functions may not be loaded.
12005 The linker searches a standard list of directories for the library,
12006 which is actually a file named @file{lib@var{library}.a}.  The linker
12007 then uses this file as if it had been specified precisely by name.
12009 The directories searched include several standard system directories
12010 plus any that you specify with @option{-L}.
12012 Normally the files found this way are library files---archive files
12013 whose members are object files.  The linker handles an archive file by
12014 scanning through it for members which define symbols that have so far
12015 been referenced but not defined.  But if the file that is found is an
12016 ordinary object file, it is linked in the usual fashion.  The only
12017 difference between using an @option{-l} option and specifying a file name
12018 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
12019 and searches several directories.
12021 @item -lobjc
12022 @opindex lobjc
12023 You need this special case of the @option{-l} option in order to
12024 link an Objective-C or Objective-C++ program.
12026 @item -nostartfiles
12027 @opindex nostartfiles
12028 Do not use the standard system startup files when linking.
12029 The standard system libraries are used normally, unless @option{-nostdlib}
12030 or @option{-nodefaultlibs} is used.
12032 @item -nodefaultlibs
12033 @opindex nodefaultlibs
12034 Do not use the standard system libraries when linking.
12035 Only the libraries you specify are passed to the linker, and options
12036 specifying linkage of the system libraries, such as @option{-static-libgcc}
12037 or @option{-shared-libgcc}, are ignored.  
12038 The standard startup files are used normally, unless @option{-nostartfiles}
12039 is used.  
12041 The compiler may generate calls to @code{memcmp},
12042 @code{memset}, @code{memcpy} and @code{memmove}.
12043 These entries are usually resolved by entries in
12044 libc.  These entry points should be supplied through some other
12045 mechanism when this option is specified.
12047 @item -nostdlib
12048 @opindex nostdlib
12049 Do not use the standard system startup files or libraries when linking.
12050 No startup files and only the libraries you specify are passed to
12051 the linker, and options specifying linkage of the system libraries, such as
12052 @option{-static-libgcc} or @option{-shared-libgcc}, are ignored.
12054 The compiler may generate calls to @code{memcmp}, @code{memset},
12055 @code{memcpy} and @code{memmove}.
12056 These entries are usually resolved by entries in
12057 libc.  These entry points should be supplied through some other
12058 mechanism when this option is specified.
12060 @cindex @option{-lgcc}, use with @option{-nostdlib}
12061 @cindex @option{-nostdlib} and unresolved references
12062 @cindex unresolved references and @option{-nostdlib}
12063 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
12064 @cindex @option{-nodefaultlibs} and unresolved references
12065 @cindex unresolved references and @option{-nodefaultlibs}
12066 One of the standard libraries bypassed by @option{-nostdlib} and
12067 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
12068 which GCC uses to overcome shortcomings of particular machines, or special
12069 needs for some languages.
12070 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
12071 Collection (GCC) Internals},
12072 for more discussion of @file{libgcc.a}.)
12073 In most cases, you need @file{libgcc.a} even when you want to avoid
12074 other standard libraries.  In other words, when you specify @option{-nostdlib}
12075 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
12076 This ensures that you have no unresolved references to internal GCC
12077 library subroutines.
12078 (An example of such an internal subroutine is @code{__main}, used to ensure C++
12079 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
12080 GNU Compiler Collection (GCC) Internals}.)
12082 @item -pie
12083 @opindex pie
12084 Produce a dynamically linked position independent executable on targets
12085 that support it.  For predictable results, you must also specify the same
12086 set of options used for compilation (@option{-fpie}, @option{-fPIE},
12087 or model suboptions) when you specify this linker option.
12089 @item -no-pie
12090 @opindex no-pie
12091 Don't produce a dynamically linked position independent executable.
12093 @item -static-pie
12094 @opindex static-pie
12095 Produce a static position independent executable on targets that support
12096 it.  A static position independent executable is similar to a static
12097 executable, but can be loaded at any address without a dynamic linker.
12098 For predictable results, you must also specify the same set of options
12099 used for compilation (@option{-fpie}, @option{-fPIE}, or model
12100 suboptions) when you specify this linker option.
12102 @item -pthread
12103 @opindex pthread
12104 Link with the POSIX threads library.  This option is supported on 
12105 GNU/Linux targets, most other Unix derivatives, and also on 
12106 x86 Cygwin and MinGW targets.  On some targets this option also sets 
12107 flags for the preprocessor, so it should be used consistently for both
12108 compilation and linking.
12110 @item -rdynamic
12111 @opindex rdynamic
12112 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
12113 that support it. This instructs the linker to add all symbols, not
12114 only used ones, to the dynamic symbol table. This option is needed
12115 for some uses of @code{dlopen} or to allow obtaining backtraces
12116 from within a program.
12118 @item -s
12119 @opindex s
12120 Remove all symbol table and relocation information from the executable.
12122 @item -static
12123 @opindex static
12124 On systems that support dynamic linking, this overrides @option{-pie}
12125 and prevents linking with the shared libraries.  On other systems, this
12126 option has no effect.
12128 @item -shared
12129 @opindex shared
12130 Produce a shared object which can then be linked with other objects to
12131 form an executable.  Not all systems support this option.  For predictable
12132 results, you must also specify the same set of options used for compilation
12133 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
12134 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
12135 needs to build supplementary stub code for constructors to work.  On
12136 multi-libbed systems, @samp{gcc -shared} must select the correct support
12137 libraries to link against.  Failing to supply the correct flags may lead
12138 to subtle defects.  Supplying them in cases where they are not necessary
12139 is innocuous.}
12141 @item -shared-libgcc
12142 @itemx -static-libgcc
12143 @opindex shared-libgcc
12144 @opindex static-libgcc
12145 On systems that provide @file{libgcc} as a shared library, these options
12146 force the use of either the shared or static version, respectively.
12147 If no shared version of @file{libgcc} was built when the compiler was
12148 configured, these options have no effect.
12150 There are several situations in which an application should use the
12151 shared @file{libgcc} instead of the static version.  The most common
12152 of these is when the application wishes to throw and catch exceptions
12153 across different shared libraries.  In that case, each of the libraries
12154 as well as the application itself should use the shared @file{libgcc}.
12156 Therefore, the G++ and driver automatically adds @option{-shared-libgcc}
12157  whenever you build a shared library or a main executable, because C++
12158  programs typically use exceptions, so this is the right thing to do.
12160 If, instead, you use the GCC driver to create shared libraries, you may
12161 find that they are not always linked with the shared @file{libgcc}.
12162 If GCC finds, at its configuration time, that you have a non-GNU linker
12163 or a GNU linker that does not support option @option{--eh-frame-hdr},
12164 it links the shared version of @file{libgcc} into shared libraries
12165 by default.  Otherwise, it takes advantage of the linker and optimizes
12166 away the linking with the shared version of @file{libgcc}, linking with
12167 the static version of libgcc by default.  This allows exceptions to
12168 propagate through such shared libraries, without incurring relocation
12169 costs at library load time.
12171 However, if a library or main executable is supposed to throw or catch
12172 exceptions, you must link it using the G++ driver, as appropriate
12173 for the languages used in the program, or using the option
12174 @option{-shared-libgcc}, such that it is linked with the shared
12175 @file{libgcc}.
12177 @item -static-libasan
12178 @opindex static-libasan
12179 When the @option{-fsanitize=address} option is used to link a program,
12180 the GCC driver automatically links against @option{libasan}.  If
12181 @file{libasan} is available as a shared library, and the @option{-static}
12182 option is not used, then this links against the shared version of
12183 @file{libasan}.  The @option{-static-libasan} option directs the GCC
12184 driver to link @file{libasan} statically, without necessarily linking
12185 other libraries statically.
12187 @item -static-libtsan
12188 @opindex static-libtsan
12189 When the @option{-fsanitize=thread} option is used to link a program,
12190 the GCC driver automatically links against @option{libtsan}.  If
12191 @file{libtsan} is available as a shared library, and the @option{-static}
12192 option is not used, then this links against the shared version of
12193 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
12194 driver to link @file{libtsan} statically, without necessarily linking
12195 other libraries statically.
12197 @item -static-liblsan
12198 @opindex static-liblsan
12199 When the @option{-fsanitize=leak} option is used to link a program,
12200 the GCC driver automatically links against @option{liblsan}.  If
12201 @file{liblsan} is available as a shared library, and the @option{-static}
12202 option is not used, then this links against the shared version of
12203 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
12204 driver to link @file{liblsan} statically, without necessarily linking
12205 other libraries statically.
12207 @item -static-libubsan
12208 @opindex static-libubsan
12209 When the @option{-fsanitize=undefined} option is used to link a program,
12210 the GCC driver automatically links against @option{libubsan}.  If
12211 @file{libubsan} is available as a shared library, and the @option{-static}
12212 option is not used, then this links against the shared version of
12213 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
12214 driver to link @file{libubsan} statically, without necessarily linking
12215 other libraries statically.
12217 @item -static-libmpx
12218 @opindex static-libmpx
12219 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are
12220 used to link a program, the GCC driver automatically links against
12221 @file{libmpx}.  If @file{libmpx} is available as a shared library,
12222 and the @option{-static} option is not used, then this links against
12223 the shared version of @file{libmpx}.  The @option{-static-libmpx}
12224 option directs the GCC driver to link @file{libmpx} statically,
12225 without necessarily linking other libraries statically.
12227 @item -static-libmpxwrappers
12228 @opindex static-libmpxwrappers
12229 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are used
12230 to link a program without also using @option{-fno-chkp-use-wrappers}, the
12231 GCC driver automatically links against @file{libmpxwrappers}.  If
12232 @file{libmpxwrappers} is available as a shared library, and the
12233 @option{-static} option is not used, then this links against the shared
12234 version of @file{libmpxwrappers}.  The @option{-static-libmpxwrappers}
12235 option directs the GCC driver to link @file{libmpxwrappers} statically,
12236 without necessarily linking other libraries statically.
12238 @item -static-libstdc++
12239 @opindex static-libstdc++
12240 When the @command{g++} program is used to link a C++ program, it
12241 normally automatically links against @option{libstdc++}.  If
12242 @file{libstdc++} is available as a shared library, and the
12243 @option{-static} option is not used, then this links against the
12244 shared version of @file{libstdc++}.  That is normally fine.  However, it
12245 is sometimes useful to freeze the version of @file{libstdc++} used by
12246 the program without going all the way to a fully static link.  The
12247 @option{-static-libstdc++} option directs the @command{g++} driver to
12248 link @file{libstdc++} statically, without necessarily linking other
12249 libraries statically.
12251 @item -symbolic
12252 @opindex symbolic
12253 Bind references to global symbols when building a shared object.  Warn
12254 about any unresolved references (unless overridden by the link editor
12255 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
12256 this option.
12258 @item -T @var{script}
12259 @opindex T
12260 @cindex linker script
12261 Use @var{script} as the linker script.  This option is supported by most
12262 systems using the GNU linker.  On some targets, such as bare-board
12263 targets without an operating system, the @option{-T} option may be required
12264 when linking to avoid references to undefined symbols.
12266 @item -Xlinker @var{option}
12267 @opindex Xlinker
12268 Pass @var{option} as an option to the linker.  You can use this to
12269 supply system-specific linker options that GCC does not recognize.
12271 If you want to pass an option that takes a separate argument, you must use
12272 @option{-Xlinker} twice, once for the option and once for the argument.
12273 For example, to pass @option{-assert definitions}, you must write
12274 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
12275 @option{-Xlinker "-assert definitions"}, because this passes the entire
12276 string as a single argument, which is not what the linker expects.
12278 When using the GNU linker, it is usually more convenient to pass
12279 arguments to linker options using the @option{@var{option}=@var{value}}
12280 syntax than as separate arguments.  For example, you can specify
12281 @option{-Xlinker -Map=output.map} rather than
12282 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
12283 this syntax for command-line options.
12285 @item -Wl,@var{option}
12286 @opindex Wl
12287 Pass @var{option} as an option to the linker.  If @var{option} contains
12288 commas, it is split into multiple options at the commas.  You can use this
12289 syntax to pass an argument to the option.
12290 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
12291 linker.  When using the GNU linker, you can also get the same effect with
12292 @option{-Wl,-Map=output.map}.
12294 @item -u @var{symbol}
12295 @opindex u
12296 Pretend the symbol @var{symbol} is undefined, to force linking of
12297 library modules to define it.  You can use @option{-u} multiple times with
12298 different symbols to force loading of additional library modules.
12300 @item -z @var{keyword}
12301 @opindex z
12302 @option{-z} is passed directly on to the linker along with the keyword
12303 @var{keyword}. See the section in the documentation of your linker for
12304 permitted values and their meanings.
12305 @end table
12307 @node Directory Options
12308 @section Options for Directory Search
12309 @cindex directory options
12310 @cindex options, directory search
12311 @cindex search path
12313 These options specify directories to search for header files, for
12314 libraries and for parts of the compiler:
12316 @table @gcctabopt
12317 @include cppdiropts.texi
12319 @item -iplugindir=@var{dir}
12320 @opindex iplugindir=
12321 Set the directory to search for plugins that are passed
12322 by @option{-fplugin=@var{name}} instead of
12323 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
12324 to be used by the user, but only passed by the driver.
12326 @item -L@var{dir}
12327 @opindex L
12328 Add directory @var{dir} to the list of directories to be searched
12329 for @option{-l}.
12331 @item -B@var{prefix}
12332 @opindex B
12333 This option specifies where to find the executables, libraries,
12334 include files, and data files of the compiler itself.
12336 The compiler driver program runs one or more of the subprograms
12337 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
12338 @var{prefix} as a prefix for each program it tries to run, both with and
12339 without @samp{@var{machine}/@var{version}/} for the corresponding target
12340 machine and compiler version.
12342 For each subprogram to be run, the compiler driver first tries the
12343 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
12344 is not specified, the driver tries two standard prefixes, 
12345 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
12346 those results in a file name that is found, the unmodified program
12347 name is searched for using the directories specified in your
12348 @env{PATH} environment variable.
12350 The compiler checks to see if the path provided by @option{-B}
12351 refers to a directory, and if necessary it adds a directory
12352 separator character at the end of the path.
12354 @option{-B} prefixes that effectively specify directory names also apply
12355 to libraries in the linker, because the compiler translates these
12356 options into @option{-L} options for the linker.  They also apply to
12357 include files in the preprocessor, because the compiler translates these
12358 options into @option{-isystem} options for the preprocessor.  In this case,
12359 the compiler appends @samp{include} to the prefix.
12361 The runtime support file @file{libgcc.a} can also be searched for using
12362 the @option{-B} prefix, if needed.  If it is not found there, the two
12363 standard prefixes above are tried, and that is all.  The file is left
12364 out of the link if it is not found by those means.
12366 Another way to specify a prefix much like the @option{-B} prefix is to use
12367 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
12368 Variables}.
12370 As a special kludge, if the path provided by @option{-B} is
12371 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
12372 9, then it is replaced by @file{[dir/]include}.  This is to help
12373 with boot-strapping the compiler.
12375 @item -no-canonical-prefixes
12376 @opindex no-canonical-prefixes
12377 Do not expand any symbolic links, resolve references to @samp{/../}
12378 or @samp{/./}, or make the path absolute when generating a relative
12379 prefix.
12381 @item --sysroot=@var{dir}
12382 @opindex sysroot
12383 Use @var{dir} as the logical root directory for headers and libraries.
12384 For example, if the compiler normally searches for headers in
12385 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
12386 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
12388 If you use both this option and the @option{-isysroot} option, then
12389 the @option{--sysroot} option applies to libraries, but the
12390 @option{-isysroot} option applies to header files.
12392 The GNU linker (beginning with version 2.16) has the necessary support
12393 for this option.  If your linker does not support this option, the
12394 header file aspect of @option{--sysroot} still works, but the
12395 library aspect does not.
12397 @item --no-sysroot-suffix
12398 @opindex no-sysroot-suffix
12399 For some targets, a suffix is added to the root directory specified
12400 with @option{--sysroot}, depending on the other options used, so that
12401 headers may for example be found in
12402 @file{@var{dir}/@var{suffix}/usr/include} instead of
12403 @file{@var{dir}/usr/include}.  This option disables the addition of
12404 such a suffix.
12406 @end table
12408 @node Code Gen Options
12409 @section Options for Code Generation Conventions
12410 @cindex code generation conventions
12411 @cindex options, code generation
12412 @cindex run-time options
12414 These machine-independent options control the interface conventions
12415 used in code generation.
12417 Most of them have both positive and negative forms; the negative form
12418 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
12419 one of the forms is listed---the one that is not the default.  You
12420 can figure out the other form by either removing @samp{no-} or adding
12423 @table @gcctabopt
12424 @item -fstack-reuse=@var{reuse-level}
12425 @opindex fstack_reuse
12426 This option controls stack space reuse for user declared local/auto variables
12427 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
12428 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
12429 local variables and temporaries, @samp{named_vars} enables the reuse only for
12430 user defined local variables with names, and @samp{none} disables stack reuse
12431 completely. The default value is @samp{all}. The option is needed when the
12432 program extends the lifetime of a scoped local variable or a compiler generated
12433 temporary beyond the end point defined by the language.  When a lifetime of
12434 a variable ends, and if the variable lives in memory, the optimizing compiler
12435 has the freedom to reuse its stack space with other temporaries or scoped
12436 local variables whose live range does not overlap with it. Legacy code extending
12437 local lifetime is likely to break with the stack reuse optimization.
12439 For example,
12441 @smallexample
12442    int *p;
12443    @{
12444      int local1;
12446      p = &local1;
12447      local1 = 10;
12448      ....
12449    @}
12450    @{
12451       int local2;
12452       local2 = 20;
12453       ...
12454    @}
12456    if (*p == 10)  // out of scope use of local1
12457      @{
12459      @}
12460 @end smallexample
12462 Another example:
12463 @smallexample
12465    struct A
12466    @{
12467        A(int k) : i(k), j(k) @{ @}
12468        int i;
12469        int j;
12470    @};
12472    A *ap;
12474    void foo(const A& ar)
12475    @{
12476       ap = &ar;
12477    @}
12479    void bar()
12480    @{
12481       foo(A(10)); // temp object's lifetime ends when foo returns
12483       @{
12484         A a(20);
12485         ....
12486       @}
12487       ap->i+= 10;  // ap references out of scope temp whose space
12488                    // is reused with a. What is the value of ap->i?
12489    @}
12491 @end smallexample
12493 The lifetime of a compiler generated temporary is well defined by the C++
12494 standard. When a lifetime of a temporary ends, and if the temporary lives
12495 in memory, the optimizing compiler has the freedom to reuse its stack
12496 space with other temporaries or scoped local variables whose live range
12497 does not overlap with it. However some of the legacy code relies on
12498 the behavior of older compilers in which temporaries' stack space is
12499 not reused, the aggressive stack reuse can lead to runtime errors. This
12500 option is used to control the temporary stack reuse optimization.
12502 @item -ftrapv
12503 @opindex ftrapv
12504 This option generates traps for signed overflow on addition, subtraction,
12505 multiplication operations.
12506 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12507 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12508 @option{-fwrapv} being effective.  Note that only active options override, so
12509 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12510 results in @option{-ftrapv} being effective.
12512 @item -fwrapv
12513 @opindex fwrapv
12514 This option instructs the compiler to assume that signed arithmetic
12515 overflow of addition, subtraction and multiplication wraps around
12516 using twos-complement representation.  This flag enables some optimizations
12517 and disables others.
12518 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12519 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12520 @option{-fwrapv} being effective.  Note that only active options override, so
12521 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12522 results in @option{-ftrapv} being effective.
12524 @item -fexceptions
12525 @opindex fexceptions
12526 Enable exception handling.  Generates extra code needed to propagate
12527 exceptions.  For some targets, this implies GCC generates frame
12528 unwind information for all functions, which can produce significant data
12529 size overhead, although it does not affect execution.  If you do not
12530 specify this option, GCC enables it by default for languages like
12531 C++ that normally require exception handling, and disables it for
12532 languages like C that do not normally require it.  However, you may need
12533 to enable this option when compiling C code that needs to interoperate
12534 properly with exception handlers written in C++.  You may also wish to
12535 disable this option if you are compiling older C++ programs that don't
12536 use exception handling.
12538 @item -fnon-call-exceptions
12539 @opindex fnon-call-exceptions
12540 Generate code that allows trapping instructions to throw exceptions.
12541 Note that this requires platform-specific runtime support that does
12542 not exist everywhere.  Moreover, it only allows @emph{trapping}
12543 instructions to throw exceptions, i.e.@: memory references or floating-point
12544 instructions.  It does not allow exceptions to be thrown from
12545 arbitrary signal handlers such as @code{SIGALRM}.
12547 @item -fdelete-dead-exceptions
12548 @opindex fdelete-dead-exceptions
12549 Consider that instructions that may throw exceptions but don't otherwise
12550 contribute to the execution of the program can be optimized away.
12551 This option is enabled by default for the Ada front end, as permitted by
12552 the Ada language specification.
12553 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
12555 @item -funwind-tables
12556 @opindex funwind-tables
12557 Similar to @option{-fexceptions}, except that it just generates any needed
12558 static data, but does not affect the generated code in any other way.
12559 You normally do not need to enable this option; instead, a language processor
12560 that needs this handling enables it on your behalf.
12562 @item -fasynchronous-unwind-tables
12563 @opindex fasynchronous-unwind-tables
12564 Generate unwind table in DWARF format, if supported by target machine.  The
12565 table is exact at each instruction boundary, so it can be used for stack
12566 unwinding from asynchronous events (such as debugger or garbage collector).
12568 @item -fno-gnu-unique
12569 @opindex fno-gnu-unique
12570 On systems with recent GNU assembler and C library, the C++ compiler
12571 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
12572 of template static data members and static local variables in inline
12573 functions are unique even in the presence of @code{RTLD_LOCAL}; this
12574 is necessary to avoid problems with a library used by two different
12575 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
12576 therefore disagreeing with the other one about the binding of the
12577 symbol.  But this causes @code{dlclose} to be ignored for affected
12578 DSOs; if your program relies on reinitialization of a DSO via
12579 @code{dlclose} and @code{dlopen}, you can use
12580 @option{-fno-gnu-unique}.
12582 @item -fpcc-struct-return
12583 @opindex fpcc-struct-return
12584 Return ``short'' @code{struct} and @code{union} values in memory like
12585 longer ones, rather than in registers.  This convention is less
12586 efficient, but it has the advantage of allowing intercallability between
12587 GCC-compiled files and files compiled with other compilers, particularly
12588 the Portable C Compiler (pcc).
12590 The precise convention for returning structures in memory depends
12591 on the target configuration macros.
12593 Short structures and unions are those whose size and alignment match
12594 that of some integer type.
12596 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12597 switch is not binary compatible with code compiled with the
12598 @option{-freg-struct-return} switch.
12599 Use it to conform to a non-default application binary interface.
12601 @item -freg-struct-return
12602 @opindex freg-struct-return
12603 Return @code{struct} and @code{union} values in registers when possible.
12604 This is more efficient for small structures than
12605 @option{-fpcc-struct-return}.
12607 If you specify neither @option{-fpcc-struct-return} nor
12608 @option{-freg-struct-return}, GCC defaults to whichever convention is
12609 standard for the target.  If there is no standard convention, GCC
12610 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12611 the principal compiler.  In those cases, we can choose the standard, and
12612 we chose the more efficient register return alternative.
12614 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12615 switch is not binary compatible with code compiled with the
12616 @option{-fpcc-struct-return} switch.
12617 Use it to conform to a non-default application binary interface.
12619 @item -fshort-enums
12620 @opindex fshort-enums
12621 Allocate to an @code{enum} type only as many bytes as it needs for the
12622 declared range of possible values.  Specifically, the @code{enum} type
12623 is equivalent to the smallest integer type that has enough room.
12625 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12626 code that is not binary compatible with code generated without that switch.
12627 Use it to conform to a non-default application binary interface.
12629 @item -fshort-wchar
12630 @opindex fshort-wchar
12631 Override the underlying type for @code{wchar_t} to be @code{short
12632 unsigned int} instead of the default for the target.  This option is
12633 useful for building programs to run under WINE@.
12635 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12636 code that is not binary compatible with code generated without that switch.
12637 Use it to conform to a non-default application binary interface.
12639 @item -fno-common
12640 @opindex fno-common
12641 @cindex tentative definitions
12642 In C code, this option controls the placement of global variables 
12643 defined without an initializer, known as @dfn{tentative definitions} 
12644 in the C standard.  Tentative definitions are distinct from declarations 
12645 of a variable with the @code{extern} keyword, which do not allocate storage.
12647 Unix C compilers have traditionally allocated storage for
12648 uninitialized global variables in a common block.  This allows the
12649 linker to resolve all tentative definitions of the same variable
12650 in different compilation units to the same object, or to a non-tentative
12651 definition.  
12652 This is the behavior specified by @option{-fcommon}, and is the default for 
12653 GCC on most targets.  
12654 On the other hand, this behavior is not required by ISO
12655 C, and on some targets may carry a speed or code size penalty on
12656 variable references.
12658 The @option{-fno-common} option specifies that the compiler should instead
12659 place uninitialized global variables in the data section of the object file.
12660 This inhibits the merging of tentative definitions by the linker so
12661 you get a multiple-definition error if the same 
12662 variable is defined in more than one compilation unit.
12663 Compiling with @option{-fno-common} is useful on targets for which
12664 it provides better performance, or if you wish to verify that the
12665 program will work on other systems that always treat uninitialized
12666 variable definitions this way.
12668 @item -fno-ident
12669 @opindex fno-ident
12670 Ignore the @code{#ident} directive.
12672 @item -finhibit-size-directive
12673 @opindex finhibit-size-directive
12674 Don't output a @code{.size} assembler directive, or anything else that
12675 would cause trouble if the function is split in the middle, and the
12676 two halves are placed at locations far apart in memory.  This option is
12677 used when compiling @file{crtstuff.c}; you should not need to use it
12678 for anything else.
12680 @item -fverbose-asm
12681 @opindex fverbose-asm
12682 Put extra commentary information in the generated assembly code to
12683 make it more readable.  This option is generally only of use to those
12684 who actually need to read the generated assembly code (perhaps while
12685 debugging the compiler itself).
12687 @option{-fno-verbose-asm}, the default, causes the
12688 extra information to be omitted and is useful when comparing two assembler
12689 files.
12691 The added comments include:
12693 @itemize @bullet
12695 @item
12696 information on the compiler version and command-line options,
12698 @item
12699 the source code lines associated with the assembly instructions,
12700 in the form FILENAME:LINENUMBER:CONTENT OF LINE,
12702 @item
12703 hints on which high-level expressions correspond to
12704 the various assembly instruction operands.
12706 @end itemize
12708 For example, given this C source file:
12710 @smallexample
12711 int test (int n)
12713   int i;
12714   int total = 0;
12716   for (i = 0; i < n; i++)
12717     total += i * i;
12719   return total;
12721 @end smallexample
12723 compiling to (x86_64) assembly via @option{-S} and emitting the result
12724 direct to stdout via @option{-o} @option{-}
12726 @smallexample
12727 gcc -S test.c -fverbose-asm -Os -o -
12728 @end smallexample
12730 gives output similar to this:
12732 @smallexample
12733         .file   "test.c"
12734 # GNU C11 (GCC) version 7.0.0 20160809 (experimental) (x86_64-pc-linux-gnu)
12735   [...snip...]
12736 # options passed:
12737   [...snip...]
12739         .text
12740         .globl  test
12741         .type   test, @@function
12742 test:
12743 .LFB0:
12744         .cfi_startproc
12745 # test.c:4:   int total = 0;
12746         xorl    %eax, %eax      # <retval>
12747 # test.c:6:   for (i = 0; i < n; i++)
12748         xorl    %edx, %edx      # i
12749 .L2:
12750 # test.c:6:   for (i = 0; i < n; i++)
12751         cmpl    %edi, %edx      # n, i
12752         jge     .L5     #,
12753 # test.c:7:     total += i * i;
12754         movl    %edx, %ecx      # i, tmp92
12755         imull   %edx, %ecx      # i, tmp92
12756 # test.c:6:   for (i = 0; i < n; i++)
12757         incl    %edx    # i
12758 # test.c:7:     total += i * i;
12759         addl    %ecx, %eax      # tmp92, <retval>
12760         jmp     .L2     #
12761 .L5:
12762 # test.c:10: @}
12763         ret
12764         .cfi_endproc
12765 .LFE0:
12766         .size   test, .-test
12767         .ident  "GCC: (GNU) 7.0.0 20160809 (experimental)"
12768         .section        .note.GNU-stack,"",@@progbits
12769 @end smallexample
12771 The comments are intended for humans rather than machines and hence the
12772 precise format of the comments is subject to change.
12774 @item -frecord-gcc-switches
12775 @opindex frecord-gcc-switches
12776 This switch causes the command line used to invoke the
12777 compiler to be recorded into the object file that is being created.
12778 This switch is only implemented on some targets and the exact format
12779 of the recording is target and binary file format dependent, but it
12780 usually takes the form of a section containing ASCII text.  This
12781 switch is related to the @option{-fverbose-asm} switch, but that
12782 switch only records information in the assembler output file as
12783 comments, so it never reaches the object file.
12784 See also @option{-grecord-gcc-switches} for another
12785 way of storing compiler options into the object file.
12787 @item -fpic
12788 @opindex fpic
12789 @cindex global offset table
12790 @cindex PIC
12791 Generate position-independent code (PIC) suitable for use in a shared
12792 library, if supported for the target machine.  Such code accesses all
12793 constant addresses through a global offset table (GOT)@.  The dynamic
12794 loader resolves the GOT entries when the program starts (the dynamic
12795 loader is not part of GCC; it is part of the operating system).  If
12796 the GOT size for the linked executable exceeds a machine-specific
12797 maximum size, you get an error message from the linker indicating that
12798 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
12799 instead.  (These maximums are 8k on the SPARC, 28k on AArch64 and 32k
12800 on the m68k and RS/6000.  The x86 has no such limit.)
12802 Position-independent code requires special support, and therefore works
12803 only on certain machines.  For the x86, GCC supports PIC for System V
12804 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
12805 position-independent.
12807 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12808 are defined to 1.
12810 @item -fPIC
12811 @opindex fPIC
12812 If supported for the target machine, emit position-independent code,
12813 suitable for dynamic linking and avoiding any limit on the size of the
12814 global offset table.  This option makes a difference on AArch64, m68k,
12815 PowerPC and SPARC@.
12817 Position-independent code requires special support, and therefore works
12818 only on certain machines.
12820 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12821 are defined to 2.
12823 @item -fpie
12824 @itemx -fPIE
12825 @opindex fpie
12826 @opindex fPIE
12827 These options are similar to @option{-fpic} and @option{-fPIC}, but
12828 generated position independent code can be only linked into executables.
12829 Usually these options are used when @option{-pie} GCC option is
12830 used during linking.
12832 @option{-fpie} and @option{-fPIE} both define the macros
12833 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
12834 for @option{-fpie} and 2 for @option{-fPIE}.
12836 @item -fno-plt
12837 @opindex fno-plt
12838 Do not use the PLT for external function calls in position-independent code.
12839 Instead, load the callee address at call sites from the GOT and branch to it.
12840 This leads to more efficient code by eliminating PLT stubs and exposing
12841 GOT loads to optimizations.  On architectures such as 32-bit x86 where
12842 PLT stubs expect the GOT pointer in a specific register, this gives more
12843 register allocation freedom to the compiler.
12844 Lazy binding requires use of the PLT; 
12845 with @option{-fno-plt} all external symbols are resolved at load time.
12847 Alternatively, the function attribute @code{noplt} can be used to avoid calls
12848 through the PLT for specific external functions.
12850 In position-dependent code, a few targets also convert calls to
12851 functions that are marked to not use the PLT to use the GOT instead.
12853 @item -fno-jump-tables
12854 @opindex fno-jump-tables
12855 Do not use jump tables for switch statements even where it would be
12856 more efficient than other code generation strategies.  This option is
12857 of use in conjunction with @option{-fpic} or @option{-fPIC} for
12858 building code that forms part of a dynamic linker and cannot
12859 reference the address of a jump table.  On some targets, jump tables
12860 do not require a GOT and this option is not needed.
12862 @item -ffixed-@var{reg}
12863 @opindex ffixed
12864 Treat the register named @var{reg} as a fixed register; generated code
12865 should never refer to it (except perhaps as a stack pointer, frame
12866 pointer or in some other fixed role).
12868 @var{reg} must be the name of a register.  The register names accepted
12869 are machine-specific and are defined in the @code{REGISTER_NAMES}
12870 macro in the machine description macro file.
12872 This flag does not have a negative form, because it specifies a
12873 three-way choice.
12875 @item -fcall-used-@var{reg}
12876 @opindex fcall-used
12877 Treat the register named @var{reg} as an allocable register that is
12878 clobbered by function calls.  It may be allocated for temporaries or
12879 variables that do not live across a call.  Functions compiled this way
12880 do not save and restore the register @var{reg}.
12882 It is an error to use this flag with the frame pointer or stack pointer.
12883 Use of this flag for other registers that have fixed pervasive roles in
12884 the machine's execution model produces disastrous results.
12886 This flag does not have a negative form, because it specifies a
12887 three-way choice.
12889 @item -fcall-saved-@var{reg}
12890 @opindex fcall-saved
12891 Treat the register named @var{reg} as an allocable register saved by
12892 functions.  It may be allocated even for temporaries or variables that
12893 live across a call.  Functions compiled this way save and restore
12894 the register @var{reg} if they use it.
12896 It is an error to use this flag with the frame pointer or stack pointer.
12897 Use of this flag for other registers that have fixed pervasive roles in
12898 the machine's execution model produces disastrous results.
12900 A different sort of disaster results from the use of this flag for
12901 a register in which function values may be returned.
12903 This flag does not have a negative form, because it specifies a
12904 three-way choice.
12906 @item -fpack-struct[=@var{n}]
12907 @opindex fpack-struct
12908 Without a value specified, pack all structure members together without
12909 holes.  When a value is specified (which must be a small power of two), pack
12910 structure members according to this value, representing the maximum
12911 alignment (that is, objects with default alignment requirements larger than
12912 this are output potentially unaligned at the next fitting location.
12914 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
12915 code that is not binary compatible with code generated without that switch.
12916 Additionally, it makes the code suboptimal.
12917 Use it to conform to a non-default application binary interface.
12919 @item -fleading-underscore
12920 @opindex fleading-underscore
12921 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
12922 change the way C symbols are represented in the object file.  One use
12923 is to help link with legacy assembly code.
12925 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
12926 generate code that is not binary compatible with code generated without that
12927 switch.  Use it to conform to a non-default application binary interface.
12928 Not all targets provide complete support for this switch.
12930 @item -ftls-model=@var{model}
12931 @opindex ftls-model
12932 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
12933 The @var{model} argument should be one of @samp{global-dynamic},
12934 @samp{local-dynamic}, @samp{initial-exec} or @samp{local-exec}.
12935 Note that the choice is subject to optimization: the compiler may use
12936 a more efficient model for symbols not visible outside of the translation
12937 unit, or if @option{-fpic} is not given on the command line.
12939 The default without @option{-fpic} is @samp{initial-exec}; with
12940 @option{-fpic} the default is @samp{global-dynamic}.
12942 @item -ftrampolines
12943 @opindex ftrampolines
12944 For targets that normally need trampolines for nested functions, always
12945 generate them instead of using descriptors.  Otherwise, for targets that
12946 do not need them, like for example HP-PA or IA-64, do nothing.
12948 A trampoline is a small piece of code that is created at run time on the
12949 stack when the address of a nested function is taken, and is used to call
12950 the nested function indirectly.  Therefore, it requires the stack to be
12951 made executable in order for the program to work properly.
12953 @option{-fno-trampolines} is enabled by default on a language by language
12954 basis to let the compiler avoid generating them, if it computes that this
12955 is safe, and replace them with descriptors.  Descriptors are made up of data
12956 only, but the generated code must be prepared to deal with them.  As of this
12957 writing, @option{-fno-trampolines} is enabled by default only for Ada.
12959 Moreover, code compiled with @option{-ftrampolines} and code compiled with
12960 @option{-fno-trampolines} are not binary compatible if nested functions are
12961 present.  This option must therefore be used on a program-wide basis and be
12962 manipulated with extreme care.
12964 @item -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]}
12965 @opindex fvisibility
12966 Set the default ELF image symbol visibility to the specified option---all
12967 symbols are marked with this unless overridden within the code.
12968 Using this feature can very substantially improve linking and
12969 load times of shared object libraries, produce more optimized
12970 code, provide near-perfect API export and prevent symbol clashes.
12971 It is @strong{strongly} recommended that you use this in any shared objects
12972 you distribute.
12974 Despite the nomenclature, @samp{default} always means public; i.e.,
12975 available to be linked against from outside the shared object.
12976 @samp{protected} and @samp{internal} are pretty useless in real-world
12977 usage so the only other commonly used option is @samp{hidden}.
12978 The default if @option{-fvisibility} isn't specified is
12979 @samp{default}, i.e., make every symbol public.
12981 A good explanation of the benefits offered by ensuring ELF
12982 symbols have the correct visibility is given by ``How To Write
12983 Shared Libraries'' by Ulrich Drepper (which can be found at
12984 @w{@uref{https://www.akkadia.org/drepper/}})---however a superior
12985 solution made possible by this option to marking things hidden when
12986 the default is public is to make the default hidden and mark things
12987 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
12988 and @code{__attribute__ ((visibility("default")))} instead of
12989 @code{__declspec(dllexport)} you get almost identical semantics with
12990 identical syntax.  This is a great boon to those working with
12991 cross-platform projects.
12993 For those adding visibility support to existing code, you may find
12994 @code{#pragma GCC visibility} of use.  This works by you enclosing
12995 the declarations you wish to set visibility for with (for example)
12996 @code{#pragma GCC visibility push(hidden)} and
12997 @code{#pragma GCC visibility pop}.
12998 Bear in mind that symbol visibility should be viewed @strong{as
12999 part of the API interface contract} and thus all new code should
13000 always specify visibility when it is not the default; i.e., declarations
13001 only for use within the local DSO should @strong{always} be marked explicitly
13002 as hidden as so to avoid PLT indirection overheads---making this
13003 abundantly clear also aids readability and self-documentation of the code.
13004 Note that due to ISO C++ specification requirements, @code{operator new} and
13005 @code{operator delete} must always be of default visibility.
13007 Be aware that headers from outside your project, in particular system
13008 headers and headers from any other library you use, may not be
13009 expecting to be compiled with visibility other than the default.  You
13010 may need to explicitly say @code{#pragma GCC visibility push(default)}
13011 before including any such headers.
13013 @code{extern} declarations are not affected by @option{-fvisibility}, so
13014 a lot of code can be recompiled with @option{-fvisibility=hidden} with
13015 no modifications.  However, this means that calls to @code{extern}
13016 functions with no explicit visibility use the PLT, so it is more
13017 effective to use @code{__attribute ((visibility))} and/or
13018 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
13019 declarations should be treated as hidden.
13021 Note that @option{-fvisibility} does affect C++ vague linkage
13022 entities. This means that, for instance, an exception class that is
13023 be thrown between DSOs must be explicitly marked with default
13024 visibility so that the @samp{type_info} nodes are unified between
13025 the DSOs.
13027 An overview of these techniques, their benefits and how to use them
13028 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
13030 @item -fstrict-volatile-bitfields
13031 @opindex fstrict-volatile-bitfields
13032 This option should be used if accesses to volatile bit-fields (or other
13033 structure fields, although the compiler usually honors those types
13034 anyway) should use a single access of the width of the
13035 field's type, aligned to a natural alignment if possible.  For
13036 example, targets with memory-mapped peripheral registers might require
13037 all such accesses to be 16 bits wide; with this flag you can
13038 declare all peripheral bit-fields as @code{unsigned short} (assuming short
13039 is 16 bits on these targets) to force GCC to use 16-bit accesses
13040 instead of, perhaps, a more efficient 32-bit access.
13042 If this option is disabled, the compiler uses the most efficient
13043 instruction.  In the previous example, that might be a 32-bit load
13044 instruction, even though that accesses bytes that do not contain
13045 any portion of the bit-field, or memory-mapped registers unrelated to
13046 the one being updated.
13048 In some cases, such as when the @code{packed} attribute is applied to a 
13049 structure field, it may not be possible to access the field with a single
13050 read or write that is correctly aligned for the target machine.  In this
13051 case GCC falls back to generating multiple accesses rather than code that 
13052 will fault or truncate the result at run time.
13054 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
13055 not allowed to touch non bit-field members.  It is therefore recommended
13056 to define all bits of the field's type as bit-field members.
13058 The default value of this option is determined by the application binary
13059 interface for the target processor.
13061 @item -fsync-libcalls
13062 @opindex fsync-libcalls
13063 This option controls whether any out-of-line instance of the @code{__sync}
13064 family of functions may be used to implement the C++11 @code{__atomic}
13065 family of functions.
13067 The default value of this option is enabled, thus the only useful form
13068 of the option is @option{-fno-sync-libcalls}.  This option is used in
13069 the implementation of the @file{libatomic} runtime library.
13071 @end table
13073 @node Developer Options
13074 @section GCC Developer Options
13075 @cindex developer options
13076 @cindex debugging GCC
13077 @cindex debug dump options
13078 @cindex dump options
13079 @cindex compilation statistics
13081 This section describes command-line options that are primarily of
13082 interest to GCC developers, including options to support compiler
13083 testing and investigation of compiler bugs and compile-time
13084 performance problems.  This includes options that produce debug dumps
13085 at various points in the compilation; that print statistics such as
13086 memory use and execution time; and that print information about GCC's
13087 configuration, such as where it searches for libraries.  You should
13088 rarely need to use any of these options for ordinary compilation and
13089 linking tasks.
13091 @table @gcctabopt
13093 @item -d@var{letters}
13094 @itemx -fdump-rtl-@var{pass}
13095 @itemx -fdump-rtl-@var{pass}=@var{filename}
13096 @opindex d
13097 @opindex fdump-rtl-@var{pass}
13098 Says to make debugging dumps during compilation at times specified by
13099 @var{letters}.  This is used for debugging the RTL-based passes of the
13100 compiler.  The file names for most of the dumps are made by appending
13101 a pass number and a word to the @var{dumpname}, and the files are
13102 created in the directory of the output file.  In case of
13103 @option{=@var{filename}} option, the dump is output on the given file
13104 instead of the pass numbered dump files.  Note that the pass number is
13105 assigned as passes are registered into the pass manager.  Most passes
13106 are registered in the order that they will execute and for these passes
13107 the number corresponds to the pass execution order.  However, passes
13108 registered by plugins, passes specific to compilation targets, or
13109 passes that are otherwise registered after all the other passes are
13110 numbered higher than a pass named "final", even if they are executed
13111 earlier.  @var{dumpname} is generated from the name of the output
13112 file if explicitly specified and not an executable, otherwise it is
13113 the basename of the source file.  
13115 Some @option{-d@var{letters}} switches have different meaning when
13116 @option{-E} is used for preprocessing.  @xref{Preprocessor Options},
13117 for information about preprocessor-specific dump options.
13119 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
13120 @option{-d} option @var{letters}.  Here are the possible
13121 letters for use in @var{pass} and @var{letters}, and their meanings:
13123 @table @gcctabopt
13125 @item -fdump-rtl-alignments
13126 @opindex fdump-rtl-alignments
13127 Dump after branch alignments have been computed.
13129 @item -fdump-rtl-asmcons
13130 @opindex fdump-rtl-asmcons
13131 Dump after fixing rtl statements that have unsatisfied in/out constraints.
13133 @item -fdump-rtl-auto_inc_dec
13134 @opindex fdump-rtl-auto_inc_dec
13135 Dump after auto-inc-dec discovery.  This pass is only run on
13136 architectures that have auto inc or auto dec instructions.
13138 @item -fdump-rtl-barriers
13139 @opindex fdump-rtl-barriers
13140 Dump after cleaning up the barrier instructions.
13142 @item -fdump-rtl-bbpart
13143 @opindex fdump-rtl-bbpart
13144 Dump after partitioning hot and cold basic blocks.
13146 @item -fdump-rtl-bbro
13147 @opindex fdump-rtl-bbro
13148 Dump after block reordering.
13150 @item -fdump-rtl-btl1
13151 @itemx -fdump-rtl-btl2
13152 @opindex fdump-rtl-btl2
13153 @opindex fdump-rtl-btl2
13154 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
13155 after the two branch
13156 target load optimization passes.
13158 @item -fdump-rtl-bypass
13159 @opindex fdump-rtl-bypass
13160 Dump after jump bypassing and control flow optimizations.
13162 @item -fdump-rtl-combine
13163 @opindex fdump-rtl-combine
13164 Dump after the RTL instruction combination pass.
13166 @item -fdump-rtl-compgotos
13167 @opindex fdump-rtl-compgotos
13168 Dump after duplicating the computed gotos.
13170 @item -fdump-rtl-ce1
13171 @itemx -fdump-rtl-ce2
13172 @itemx -fdump-rtl-ce3
13173 @opindex fdump-rtl-ce1
13174 @opindex fdump-rtl-ce2
13175 @opindex fdump-rtl-ce3
13176 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
13177 @option{-fdump-rtl-ce3} enable dumping after the three
13178 if conversion passes.
13180 @item -fdump-rtl-cprop_hardreg
13181 @opindex fdump-rtl-cprop_hardreg
13182 Dump after hard register copy propagation.
13184 @item -fdump-rtl-csa
13185 @opindex fdump-rtl-csa
13186 Dump after combining stack adjustments.
13188 @item -fdump-rtl-cse1
13189 @itemx -fdump-rtl-cse2
13190 @opindex fdump-rtl-cse1
13191 @opindex fdump-rtl-cse2
13192 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
13193 the two common subexpression elimination passes.
13195 @item -fdump-rtl-dce
13196 @opindex fdump-rtl-dce
13197 Dump after the standalone dead code elimination passes.
13199 @item -fdump-rtl-dbr
13200 @opindex fdump-rtl-dbr
13201 Dump after delayed branch scheduling.
13203 @item -fdump-rtl-dce1
13204 @itemx -fdump-rtl-dce2
13205 @opindex fdump-rtl-dce1
13206 @opindex fdump-rtl-dce2
13207 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
13208 the two dead store elimination passes.
13210 @item -fdump-rtl-eh
13211 @opindex fdump-rtl-eh
13212 Dump after finalization of EH handling code.
13214 @item -fdump-rtl-eh_ranges
13215 @opindex fdump-rtl-eh_ranges
13216 Dump after conversion of EH handling range regions.
13218 @item -fdump-rtl-expand
13219 @opindex fdump-rtl-expand
13220 Dump after RTL generation.
13222 @item -fdump-rtl-fwprop1
13223 @itemx -fdump-rtl-fwprop2
13224 @opindex fdump-rtl-fwprop1
13225 @opindex fdump-rtl-fwprop2
13226 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
13227 dumping after the two forward propagation passes.
13229 @item -fdump-rtl-gcse1
13230 @itemx -fdump-rtl-gcse2
13231 @opindex fdump-rtl-gcse1
13232 @opindex fdump-rtl-gcse2
13233 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
13234 after global common subexpression elimination.
13236 @item -fdump-rtl-init-regs
13237 @opindex fdump-rtl-init-regs
13238 Dump after the initialization of the registers.
13240 @item -fdump-rtl-initvals
13241 @opindex fdump-rtl-initvals
13242 Dump after the computation of the initial value sets.
13244 @item -fdump-rtl-into_cfglayout
13245 @opindex fdump-rtl-into_cfglayout
13246 Dump after converting to cfglayout mode.
13248 @item -fdump-rtl-ira
13249 @opindex fdump-rtl-ira
13250 Dump after iterated register allocation.
13252 @item -fdump-rtl-jump
13253 @opindex fdump-rtl-jump
13254 Dump after the second jump optimization.
13256 @item -fdump-rtl-loop2
13257 @opindex fdump-rtl-loop2
13258 @option{-fdump-rtl-loop2} enables dumping after the rtl
13259 loop optimization passes.
13261 @item -fdump-rtl-mach
13262 @opindex fdump-rtl-mach
13263 Dump after performing the machine dependent reorganization pass, if that
13264 pass exists.
13266 @item -fdump-rtl-mode_sw
13267 @opindex fdump-rtl-mode_sw
13268 Dump after removing redundant mode switches.
13270 @item -fdump-rtl-rnreg
13271 @opindex fdump-rtl-rnreg
13272 Dump after register renumbering.
13274 @item -fdump-rtl-outof_cfglayout
13275 @opindex fdump-rtl-outof_cfglayout
13276 Dump after converting from cfglayout mode.
13278 @item -fdump-rtl-peephole2
13279 @opindex fdump-rtl-peephole2
13280 Dump after the peephole pass.
13282 @item -fdump-rtl-postreload
13283 @opindex fdump-rtl-postreload
13284 Dump after post-reload optimizations.
13286 @item -fdump-rtl-pro_and_epilogue
13287 @opindex fdump-rtl-pro_and_epilogue
13288 Dump after generating the function prologues and epilogues.
13290 @item -fdump-rtl-sched1
13291 @itemx -fdump-rtl-sched2
13292 @opindex fdump-rtl-sched1
13293 @opindex fdump-rtl-sched2
13294 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
13295 after the basic block scheduling passes.
13297 @item -fdump-rtl-ree
13298 @opindex fdump-rtl-ree
13299 Dump after sign/zero extension elimination.
13301 @item -fdump-rtl-seqabstr
13302 @opindex fdump-rtl-seqabstr
13303 Dump after common sequence discovery.
13305 @item -fdump-rtl-shorten
13306 @opindex fdump-rtl-shorten
13307 Dump after shortening branches.
13309 @item -fdump-rtl-sibling
13310 @opindex fdump-rtl-sibling
13311 Dump after sibling call optimizations.
13313 @item -fdump-rtl-split1
13314 @itemx -fdump-rtl-split2
13315 @itemx -fdump-rtl-split3
13316 @itemx -fdump-rtl-split4
13317 @itemx -fdump-rtl-split5
13318 @opindex fdump-rtl-split1
13319 @opindex fdump-rtl-split2
13320 @opindex fdump-rtl-split3
13321 @opindex fdump-rtl-split4
13322 @opindex fdump-rtl-split5
13323 These options enable dumping after five rounds of
13324 instruction splitting.
13326 @item -fdump-rtl-sms
13327 @opindex fdump-rtl-sms
13328 Dump after modulo scheduling.  This pass is only run on some
13329 architectures.
13331 @item -fdump-rtl-stack
13332 @opindex fdump-rtl-stack
13333 Dump after conversion from GCC's ``flat register file'' registers to the
13334 x87's stack-like registers.  This pass is only run on x86 variants.
13336 @item -fdump-rtl-subreg1
13337 @itemx -fdump-rtl-subreg2
13338 @opindex fdump-rtl-subreg1
13339 @opindex fdump-rtl-subreg2
13340 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
13341 the two subreg expansion passes.
13343 @item -fdump-rtl-unshare
13344 @opindex fdump-rtl-unshare
13345 Dump after all rtl has been unshared.
13347 @item -fdump-rtl-vartrack
13348 @opindex fdump-rtl-vartrack
13349 Dump after variable tracking.
13351 @item -fdump-rtl-vregs
13352 @opindex fdump-rtl-vregs
13353 Dump after converting virtual registers to hard registers.
13355 @item -fdump-rtl-web
13356 @opindex fdump-rtl-web
13357 Dump after live range splitting.
13359 @item -fdump-rtl-regclass
13360 @itemx -fdump-rtl-subregs_of_mode_init
13361 @itemx -fdump-rtl-subregs_of_mode_finish
13362 @itemx -fdump-rtl-dfinit
13363 @itemx -fdump-rtl-dfinish
13364 @opindex fdump-rtl-regclass
13365 @opindex fdump-rtl-subregs_of_mode_init
13366 @opindex fdump-rtl-subregs_of_mode_finish
13367 @opindex fdump-rtl-dfinit
13368 @opindex fdump-rtl-dfinish
13369 These dumps are defined but always produce empty files.
13371 @item -da
13372 @itemx -fdump-rtl-all
13373 @opindex da
13374 @opindex fdump-rtl-all
13375 Produce all the dumps listed above.
13377 @item -dA
13378 @opindex dA
13379 Annotate the assembler output with miscellaneous debugging information.
13381 @item -dD
13382 @opindex dD
13383 Dump all macro definitions, at the end of preprocessing, in addition to
13384 normal output.
13386 @item -dH
13387 @opindex dH
13388 Produce a core dump whenever an error occurs.
13390 @item -dp
13391 @opindex dp
13392 Annotate the assembler output with a comment indicating which
13393 pattern and alternative is used.  The length and cost of each instruction are
13394 also printed.
13396 @item -dP
13397 @opindex dP
13398 Dump the RTL in the assembler output as a comment before each instruction.
13399 Also turns on @option{-dp} annotation.
13401 @item -dx
13402 @opindex dx
13403 Just generate RTL for a function instead of compiling it.  Usually used
13404 with @option{-fdump-rtl-expand}.
13405 @end table
13407 @item -fdump-noaddr
13408 @opindex fdump-noaddr
13409 When doing debugging dumps, suppress address output.  This makes it more
13410 feasible to use diff on debugging dumps for compiler invocations with
13411 different compiler binaries and/or different
13412 text / bss / data / heap / stack / dso start locations.
13414 @item -freport-bug
13415 @opindex freport-bug
13416 Collect and dump debug information into a temporary file if an
13417 internal compiler error (ICE) occurs.
13419 @item -fdump-unnumbered
13420 @opindex fdump-unnumbered
13421 When doing debugging dumps, suppress instruction numbers and address output.
13422 This makes it more feasible to use diff on debugging dumps for compiler
13423 invocations with different options, in particular with and without
13424 @option{-g}.
13426 @item -fdump-unnumbered-links
13427 @opindex fdump-unnumbered-links
13428 When doing debugging dumps (see @option{-d} option above), suppress
13429 instruction numbers for the links to the previous and next instructions
13430 in a sequence.
13432 @item -fdump-ipa-@var{switch}
13433 @opindex fdump-ipa
13434 Control the dumping at various stages of inter-procedural analysis
13435 language tree to a file.  The file name is generated by appending a
13436 switch specific suffix to the source file name, and the file is created
13437 in the same directory as the output file.  The following dumps are
13438 possible:
13440 @table @samp
13441 @item all
13442 Enables all inter-procedural analysis dumps.
13444 @item cgraph
13445 Dumps information about call-graph optimization, unused function removal,
13446 and inlining decisions.
13448 @item inline
13449 Dump after function inlining.
13451 @end table
13453 @item -fdump-lang-all
13454 @itemx -fdump-lang-@var{switch}
13455 @itemx -fdump-lang-@var{switch}-@var{options}
13456 @itemx -fdump-lang-@var{switch}-@var{options}=@var{filename}
13457 @opindex fdump-lang-all
13458 @opindex fdump-lang
13459 Control the dumping of language-specific information.  The @var{options}
13460 and @var{filename} portions behave as described in the
13461 @option{-fdump-tree} option.  The following @var{switch} values are
13462 accepted:
13464 @table @samp
13465 @item all
13467 Enable all language-specific dumps.
13469 @item class
13470 Dump class hierarchy information.  Virtual table information is emitted
13471 unless '@option{slim}' is specified.  This option is applicable to C++ only.
13473 @item raw
13474 Dump the raw internal tree data.  This option is applicable to C++ only.
13476 @end table
13478 @item -fdump-passes
13479 @opindex fdump-passes
13480 Print on @file{stderr} the list of optimization passes that are turned
13481 on and off by the current command-line options.
13483 @item -fdump-statistics-@var{option}
13484 @opindex fdump-statistics
13485 Enable and control dumping of pass statistics in a separate file.  The
13486 file name is generated by appending a suffix ending in
13487 @samp{.statistics} to the source file name, and the file is created in
13488 the same directory as the output file.  If the @samp{-@var{option}}
13489 form is used, @samp{-stats} causes counters to be summed over the
13490 whole compilation unit while @samp{-details} dumps every event as
13491 the passes generate them.  The default with no option is to sum
13492 counters for each function compiled.
13494 @item -fdump-tree-all
13495 @itemx -fdump-tree-@var{switch}
13496 @itemx -fdump-tree-@var{switch}-@var{options}
13497 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
13498 @opindex fdump-tree-all
13499 @opindex fdump-tree
13500 Control the dumping at various stages of processing the intermediate
13501 language tree to a file.  The file name is generated by appending a
13502 switch-specific suffix to the source file name, and the file is
13503 created in the same directory as the output file. In case of
13504 @option{=@var{filename}} option, the dump is output on the given file
13505 instead of the auto named dump files.  If the @samp{-@var{options}}
13506 form is used, @var{options} is a list of @samp{-} separated options
13507 which control the details of the dump.  Not all options are applicable
13508 to all dumps; those that are not meaningful are ignored.  The
13509 following options are available
13511 @table @samp
13512 @item address
13513 Print the address of each node.  Usually this is not meaningful as it
13514 changes according to the environment and source file.  Its primary use
13515 is for tying up a dump file with a debug environment.
13516 @item asmname
13517 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
13518 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
13519 use working backward from mangled names in the assembly file.
13520 @item slim
13521 When dumping front-end intermediate representations, inhibit dumping
13522 of members of a scope or body of a function merely because that scope
13523 has been reached.  Only dump such items when they are directly reachable
13524 by some other path.
13526 When dumping pretty-printed trees, this option inhibits dumping the
13527 bodies of control structures.
13529 When dumping RTL, print the RTL in slim (condensed) form instead of
13530 the default LISP-like representation.
13531 @item raw
13532 Print a raw representation of the tree.  By default, trees are
13533 pretty-printed into a C-like representation.
13534 @item details
13535 Enable more detailed dumps (not honored by every dump option). Also
13536 include information from the optimization passes.
13537 @item stats
13538 Enable dumping various statistics about the pass (not honored by every dump
13539 option).
13540 @item blocks
13541 Enable showing basic block boundaries (disabled in raw dumps).
13542 @item graph
13543 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
13544 dump a representation of the control flow graph suitable for viewing with
13545 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
13546 the file is pretty-printed as a subgraph, so that GraphViz can render them
13547 all in a single plot.
13549 This option currently only works for RTL dumps, and the RTL is always
13550 dumped in slim form.
13551 @item vops
13552 Enable showing virtual operands for every statement.
13553 @item lineno
13554 Enable showing line numbers for statements.
13555 @item uid
13556 Enable showing the unique ID (@code{DECL_UID}) for each variable.
13557 @item verbose
13558 Enable showing the tree dump for each statement.
13559 @item eh
13560 Enable showing the EH region number holding each statement.
13561 @item scev
13562 Enable showing scalar evolution analysis details.
13563 @item optimized
13564 Enable showing optimization information (only available in certain
13565 passes).
13566 @item missed
13567 Enable showing missed optimization information (only available in certain
13568 passes).
13569 @item note
13570 Enable other detailed optimization information (only available in
13571 certain passes).
13572 @item =@var{filename}
13573 Instead of an auto named dump file, output into the given file
13574 name. The file names @file{stdout} and @file{stderr} are treated
13575 specially and are considered already open standard streams. For
13576 example,
13578 @smallexample
13579 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
13580      -fdump-tree-pre=/dev/stderr file.c
13581 @end smallexample
13583 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
13584 output on to @file{stderr}. If two conflicting dump filenames are
13585 given for the same pass, then the latter option overrides the earlier
13586 one.
13588 @item all
13589 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
13590 and @option{lineno}.
13592 @item optall
13593 Turn on all optimization options, i.e., @option{optimized},
13594 @option{missed}, and @option{note}.
13595 @end table
13597 To determine what tree dumps are available or find the dump for a pass
13598 of interest follow the steps below.
13600 @enumerate
13601 @item
13602 Invoke GCC with @option{-fdump-passes} and in the @file{stderr} output
13603 look for a code that corresponds to the pass you are interested in.
13604 For example, the codes @code{tree-evrp}, @code{tree-vrp1}, and
13605 @code{tree-vrp2} correspond to the three Value Range Propagation passes.
13606 The number at the end distinguishes distinct invocations of the same pass.
13607 @item
13608 To enable the creation of the dump file, append the pass code to
13609 the @option{-fdump-} option prefix and invoke GCC with it.  For example,
13610 to enable the dump from the Early Value Range Propagation pass, invoke
13611 GCC with the @option{-fdump-tree-evrp} option.  Optionally, you may
13612 specify the name of the dump file.  If you don't specify one, GCC
13613 creates as described below.
13614 @item
13615 Find the pass dump in a file whose name is composed of three components
13616 separated by a period: the name of the source file GCC was invoked to
13617 compile, a numeric suffix indicating the pass number followed by the
13618 letter @samp{t} for tree passes (and the letter @samp{r} for RTL passes),
13619 and finally the pass code.  For example, the Early VRP pass dump might
13620 be in a file named @file{myfile.c.038t.evrp} in the current working
13621 directory.  Note that the numeric codes are not stable and may change
13622 from one version of GCC to another.
13623 @end enumerate
13625 @item -fopt-info
13626 @itemx -fopt-info-@var{options}
13627 @itemx -fopt-info-@var{options}=@var{filename}
13628 @opindex fopt-info
13629 Controls optimization dumps from various optimization passes. If the
13630 @samp{-@var{options}} form is used, @var{options} is a list of
13631 @samp{-} separated option keywords to select the dump details and
13632 optimizations.  
13634 The @var{options} can be divided into two groups: options describing the
13635 verbosity of the dump, and options describing which optimizations
13636 should be included. The options from both the groups can be freely
13637 mixed as they are non-overlapping. However, in case of any conflicts,
13638 the later options override the earlier options on the command
13639 line. 
13641 The following options control the dump verbosity:
13643 @table @samp
13644 @item optimized
13645 Print information when an optimization is successfully applied. It is
13646 up to a pass to decide which information is relevant. For example, the
13647 vectorizer passes print the source location of loops which are
13648 successfully vectorized.
13649 @item missed
13650 Print information about missed optimizations. Individual passes
13651 control which information to include in the output. 
13652 @item note
13653 Print verbose information about optimizations, such as certain
13654 transformations, more detailed messages about decisions etc.
13655 @item all
13656 Print detailed optimization information. This includes
13657 @samp{optimized}, @samp{missed}, and @samp{note}.
13658 @end table
13660 One or more of the following option keywords can be used to describe a
13661 group of optimizations:
13663 @table @samp
13664 @item ipa
13665 Enable dumps from all interprocedural optimizations.
13666 @item loop
13667 Enable dumps from all loop optimizations.
13668 @item inline
13669 Enable dumps from all inlining optimizations.
13670 @item omp
13671 Enable dumps from all OMP (Offloading and Multi Processing) optimizations.
13672 @item vec
13673 Enable dumps from all vectorization optimizations.
13674 @item optall
13675 Enable dumps from all optimizations. This is a superset of
13676 the optimization groups listed above.
13677 @end table
13679 If @var{options} is
13680 omitted, it defaults to @samp{optimized-optall}, which means to dump all
13681 info about successful optimizations from all the passes.  
13683 If the @var{filename} is provided, then the dumps from all the
13684 applicable optimizations are concatenated into the @var{filename}.
13685 Otherwise the dump is output onto @file{stderr}. Though multiple
13686 @option{-fopt-info} options are accepted, only one of them can include
13687 a @var{filename}. If other filenames are provided then all but the
13688 first such option are ignored.
13690 Note that the output @var{filename} is overwritten
13691 in case of multiple translation units. If a combined output from
13692 multiple translation units is desired, @file{stderr} should be used
13693 instead.
13695 In the following example, the optimization info is output to
13696 @file{stderr}:
13698 @smallexample
13699 gcc -O3 -fopt-info
13700 @end smallexample
13702 This example:
13703 @smallexample
13704 gcc -O3 -fopt-info-missed=missed.all
13705 @end smallexample
13707 @noindent
13708 outputs missed optimization report from all the passes into
13709 @file{missed.all}, and this one:
13711 @smallexample
13712 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
13713 @end smallexample
13715 @noindent
13716 prints information about missed optimization opportunities from
13717 vectorization passes on @file{stderr}.  
13718 Note that @option{-fopt-info-vec-missed} is equivalent to 
13719 @option{-fopt-info-missed-vec}.  The order of the optimization group
13720 names and message types listed after @option{-fopt-info} does not matter.
13722 As another example,
13723 @smallexample
13724 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
13725 @end smallexample
13727 @noindent
13728 outputs information about missed optimizations as well as
13729 optimized locations from all the inlining passes into
13730 @file{inline.txt}.
13732 Finally, consider:
13734 @smallexample
13735 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
13736 @end smallexample
13738 @noindent
13739 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
13740 in conflict since only one output file is allowed. In this case, only
13741 the first option takes effect and the subsequent options are
13742 ignored. Thus only @file{vec.miss} is produced which contains
13743 dumps from the vectorizer about missed opportunities.
13745 @item -fsched-verbose=@var{n}
13746 @opindex fsched-verbose
13747 On targets that use instruction scheduling, this option controls the
13748 amount of debugging output the scheduler prints to the dump files.
13750 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
13751 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
13752 For @var{n} greater than one, it also output basic block probabilities,
13753 detailed ready list information and unit/insn info.  For @var{n} greater
13754 than two, it includes RTL at abort point, control-flow and regions info.
13755 And for @var{n} over four, @option{-fsched-verbose} also includes
13756 dependence info.
13760 @item -fenable-@var{kind}-@var{pass}
13761 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
13762 @opindex fdisable-
13763 @opindex fenable-
13765 This is a set of options that are used to explicitly disable/enable
13766 optimization passes.  These options are intended for use for debugging GCC.
13767 Compiler users should use regular options for enabling/disabling
13768 passes instead.
13770 @table @gcctabopt
13772 @item -fdisable-ipa-@var{pass}
13773 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
13774 statically invoked in the compiler multiple times, the pass name should be
13775 appended with a sequential number starting from 1.
13777 @item -fdisable-rtl-@var{pass}
13778 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
13779 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
13780 statically invoked in the compiler multiple times, the pass name should be
13781 appended with a sequential number starting from 1.  @var{range-list} is a 
13782 comma-separated list of function ranges or assembler names.  Each range is a number
13783 pair separated by a colon.  The range is inclusive in both ends.  If the range
13784 is trivial, the number pair can be simplified as a single number.  If the
13785 function's call graph node's @var{uid} falls within one of the specified ranges,
13786 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
13787 function header of a dump file, and the pass names can be dumped by using
13788 option @option{-fdump-passes}.
13790 @item -fdisable-tree-@var{pass}
13791 @itemx -fdisable-tree-@var{pass}=@var{range-list}
13792 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
13793 option arguments.
13795 @item -fenable-ipa-@var{pass}
13796 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
13797 statically invoked in the compiler multiple times, the pass name should be
13798 appended with a sequential number starting from 1.
13800 @item -fenable-rtl-@var{pass}
13801 @itemx -fenable-rtl-@var{pass}=@var{range-list}
13802 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
13803 description and examples.
13805 @item -fenable-tree-@var{pass}
13806 @itemx -fenable-tree-@var{pass}=@var{range-list}
13807 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
13808 of option arguments.
13810 @end table
13812 Here are some examples showing uses of these options.
13814 @smallexample
13816 # disable ccp1 for all functions
13817    -fdisable-tree-ccp1
13818 # disable complete unroll for function whose cgraph node uid is 1
13819    -fenable-tree-cunroll=1
13820 # disable gcse2 for functions at the following ranges [1,1],
13821 # [300,400], and [400,1000]
13822 # disable gcse2 for functions foo and foo2
13823    -fdisable-rtl-gcse2=foo,foo2
13824 # disable early inlining
13825    -fdisable-tree-einline
13826 # disable ipa inlining
13827    -fdisable-ipa-inline
13828 # enable tree full unroll
13829    -fenable-tree-unroll
13831 @end smallexample
13833 @item -fchecking
13834 @itemx -fchecking=@var{n}
13835 @opindex fchecking
13836 @opindex fno-checking
13837 Enable internal consistency checking.  The default depends on
13838 the compiler configuration.  @option{-fchecking=2} enables further
13839 internal consistency checking that might affect code generation.
13841 @item -frandom-seed=@var{string}
13842 @opindex frandom-seed
13843 This option provides a seed that GCC uses in place of
13844 random numbers in generating certain symbol names
13845 that have to be different in every compiled file.  It is also used to
13846 place unique stamps in coverage data files and the object files that
13847 produce them.  You can use the @option{-frandom-seed} option to produce
13848 reproducibly identical object files.
13850 The @var{string} can either be a number (decimal, octal or hex) or an
13851 arbitrary string (in which case it's converted to a number by
13852 computing CRC32).
13854 The @var{string} should be different for every file you compile.
13856 @item -save-temps
13857 @itemx -save-temps=cwd
13858 @opindex save-temps
13859 Store the usual ``temporary'' intermediate files permanently; place them
13860 in the current directory and name them based on the source file.  Thus,
13861 compiling @file{foo.c} with @option{-c -save-temps} produces files
13862 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
13863 preprocessed @file{foo.i} output file even though the compiler now
13864 normally uses an integrated preprocessor.
13866 When used in combination with the @option{-x} command-line option,
13867 @option{-save-temps} is sensible enough to avoid over writing an
13868 input source file with the same extension as an intermediate file.
13869 The corresponding intermediate file may be obtained by renaming the
13870 source file before using @option{-save-temps}.
13872 If you invoke GCC in parallel, compiling several different source
13873 files that share a common base name in different subdirectories or the
13874 same source file compiled for multiple output destinations, it is
13875 likely that the different parallel compilers will interfere with each
13876 other, and overwrite the temporary files.  For instance:
13878 @smallexample
13879 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
13880 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
13881 @end smallexample
13883 may result in @file{foo.i} and @file{foo.o} being written to
13884 simultaneously by both compilers.
13886 @item -save-temps=obj
13887 @opindex save-temps=obj
13888 Store the usual ``temporary'' intermediate files permanently.  If the
13889 @option{-o} option is used, the temporary files are based on the
13890 object file.  If the @option{-o} option is not used, the
13891 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
13893 For example:
13895 @smallexample
13896 gcc -save-temps=obj -c foo.c
13897 gcc -save-temps=obj -c bar.c -o dir/xbar.o
13898 gcc -save-temps=obj foobar.c -o dir2/yfoobar
13899 @end smallexample
13901 @noindent
13902 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
13903 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
13904 @file{dir2/yfoobar.o}.
13906 @item -time@r{[}=@var{file}@r{]}
13907 @opindex time
13908 Report the CPU time taken by each subprocess in the compilation
13909 sequence.  For C source files, this is the compiler proper and assembler
13910 (plus the linker if linking is done).
13912 Without the specification of an output file, the output looks like this:
13914 @smallexample
13915 # cc1 0.12 0.01
13916 # as 0.00 0.01
13917 @end smallexample
13919 The first number on each line is the ``user time'', that is time spent
13920 executing the program itself.  The second number is ``system time'',
13921 time spent executing operating system routines on behalf of the program.
13922 Both numbers are in seconds.
13924 With the specification of an output file, the output is appended to the
13925 named file, and it looks like this:
13927 @smallexample
13928 0.12 0.01 cc1 @var{options}
13929 0.00 0.01 as @var{options}
13930 @end smallexample
13932 The ``user time'' and the ``system time'' are moved before the program
13933 name, and the options passed to the program are displayed, so that one
13934 can later tell what file was being compiled, and with which options.
13936 @item -fdump-final-insns@r{[}=@var{file}@r{]}
13937 @opindex fdump-final-insns
13938 Dump the final internal representation (RTL) to @var{file}.  If the
13939 optional argument is omitted (or if @var{file} is @code{.}), the name
13940 of the dump file is determined by appending @code{.gkd} to the
13941 compilation output file name.
13943 @item -fcompare-debug@r{[}=@var{opts}@r{]}
13944 @opindex fcompare-debug
13945 @opindex fno-compare-debug
13946 If no error occurs during compilation, run the compiler a second time,
13947 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
13948 passed to the second compilation.  Dump the final internal
13949 representation in both compilations, and print an error if they differ.
13951 If the equal sign is omitted, the default @option{-gtoggle} is used.
13953 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
13954 and nonzero, implicitly enables @option{-fcompare-debug}.  If
13955 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
13956 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
13957 is used.
13959 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
13960 is equivalent to @option{-fno-compare-debug}, which disables the dumping
13961 of the final representation and the second compilation, preventing even
13962 @env{GCC_COMPARE_DEBUG} from taking effect.
13964 To verify full coverage during @option{-fcompare-debug} testing, set
13965 @env{GCC_COMPARE_DEBUG} to say @option{-fcompare-debug-not-overridden},
13966 which GCC rejects as an invalid option in any actual compilation
13967 (rather than preprocessing, assembly or linking).  To get just a
13968 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
13969 not overridden} will do.
13971 @item -fcompare-debug-second
13972 @opindex fcompare-debug-second
13973 This option is implicitly passed to the compiler for the second
13974 compilation requested by @option{-fcompare-debug}, along with options to
13975 silence warnings, and omitting other options that would cause
13976 side-effect compiler outputs to files or to the standard output.  Dump
13977 files and preserved temporary files are renamed so as to contain the
13978 @code{.gk} additional extension during the second compilation, to avoid
13979 overwriting those generated by the first.
13981 When this option is passed to the compiler driver, it causes the
13982 @emph{first} compilation to be skipped, which makes it useful for little
13983 other than debugging the compiler proper.
13985 @item -gtoggle
13986 @opindex gtoggle
13987 Turn off generation of debug info, if leaving out this option
13988 generates it, or turn it on at level 2 otherwise.  The position of this
13989 argument in the command line does not matter; it takes effect after all
13990 other options are processed, and it does so only once, no matter how
13991 many times it is given.  This is mainly intended to be used with
13992 @option{-fcompare-debug}.
13994 @item -fvar-tracking-assignments-toggle
13995 @opindex fvar-tracking-assignments-toggle
13996 @opindex fno-var-tracking-assignments-toggle
13997 Toggle @option{-fvar-tracking-assignments}, in the same way that
13998 @option{-gtoggle} toggles @option{-g}.
14000 @item -Q
14001 @opindex Q
14002 Makes the compiler print out each function name as it is compiled, and
14003 print some statistics about each pass when it finishes.
14005 @item -ftime-report
14006 @opindex ftime-report
14007 Makes the compiler print some statistics about the time consumed by each
14008 pass when it finishes.
14010 @item -ftime-report-details
14011 @opindex ftime-report-details
14012 Record the time consumed by infrastructure parts separately for each pass.
14014 @item -fira-verbose=@var{n}
14015 @opindex fira-verbose
14016 Control the verbosity of the dump file for the integrated register allocator.
14017 The default value is 5.  If the value @var{n} is greater or equal to 10,
14018 the dump output is sent to stderr using the same format as @var{n} minus 10.
14020 @item -flto-report
14021 @opindex flto-report
14022 Prints a report with internal details on the workings of the link-time
14023 optimizer.  The contents of this report vary from version to version.
14024 It is meant to be useful to GCC developers when processing object
14025 files in LTO mode (via @option{-flto}).
14027 Disabled by default.
14029 @item -flto-report-wpa
14030 @opindex flto-report-wpa
14031 Like @option{-flto-report}, but only print for the WPA phase of Link
14032 Time Optimization.
14034 @item -fmem-report
14035 @opindex fmem-report
14036 Makes the compiler print some statistics about permanent memory
14037 allocation when it finishes.
14039 @item -fmem-report-wpa
14040 @opindex fmem-report-wpa
14041 Makes the compiler print some statistics about permanent memory
14042 allocation for the WPA phase only.
14044 @item -fpre-ipa-mem-report
14045 @opindex fpre-ipa-mem-report
14046 @item -fpost-ipa-mem-report
14047 @opindex fpost-ipa-mem-report
14048 Makes the compiler print some statistics about permanent memory
14049 allocation before or after interprocedural optimization.
14051 @item -fprofile-report
14052 @opindex fprofile-report
14053 Makes the compiler print some statistics about consistency of the
14054 (estimated) profile and effect of individual passes.
14056 @item -fstack-usage
14057 @opindex fstack-usage
14058 Makes the compiler output stack usage information for the program, on a
14059 per-function basis.  The filename for the dump is made by appending
14060 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
14061 the output file, if explicitly specified and it is not an executable,
14062 otherwise it is the basename of the source file.  An entry is made up
14063 of three fields:
14065 @itemize
14066 @item
14067 The name of the function.
14068 @item
14069 A number of bytes.
14070 @item
14071 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
14072 @end itemize
14074 The qualifier @code{static} means that the function manipulates the stack
14075 statically: a fixed number of bytes are allocated for the frame on function
14076 entry and released on function exit; no stack adjustments are otherwise made
14077 in the function.  The second field is this fixed number of bytes.
14079 The qualifier @code{dynamic} means that the function manipulates the stack
14080 dynamically: in addition to the static allocation described above, stack
14081 adjustments are made in the body of the function, for example to push/pop
14082 arguments around function calls.  If the qualifier @code{bounded} is also
14083 present, the amount of these adjustments is bounded at compile time and
14084 the second field is an upper bound of the total amount of stack used by
14085 the function.  If it is not present, the amount of these adjustments is
14086 not bounded at compile time and the second field only represents the
14087 bounded part.
14089 @item -fstats
14090 @opindex fstats
14091 Emit statistics about front-end processing at the end of the compilation.
14092 This option is supported only by the C++ front end, and
14093 the information is generally only useful to the G++ development team.
14095 @item -fdbg-cnt-list
14096 @opindex fdbg-cnt-list
14097 Print the name and the counter upper bound for all debug counters.
14100 @item -fdbg-cnt=@var{counter-value-list}
14101 @opindex fdbg-cnt
14102 Set the internal debug counter upper bound.  @var{counter-value-list}
14103 is a comma-separated list of @var{name}:@var{value} pairs
14104 which sets the upper bound of each debug counter @var{name} to @var{value}.
14105 All debug counters have the initial upper bound of @code{UINT_MAX};
14106 thus @code{dbg_cnt} returns true always unless the upper bound
14107 is set by this option.
14108 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
14109 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
14111 @item -print-file-name=@var{library}
14112 @opindex print-file-name
14113 Print the full absolute name of the library file @var{library} that
14114 would be used when linking---and don't do anything else.  With this
14115 option, GCC does not compile or link anything; it just prints the
14116 file name.
14118 @item -print-multi-directory
14119 @opindex print-multi-directory
14120 Print the directory name corresponding to the multilib selected by any
14121 other switches present in the command line.  This directory is supposed
14122 to exist in @env{GCC_EXEC_PREFIX}.
14124 @item -print-multi-lib
14125 @opindex print-multi-lib
14126 Print the mapping from multilib directory names to compiler switches
14127 that enable them.  The directory name is separated from the switches by
14128 @samp{;}, and each switch starts with an @samp{@@} instead of the
14129 @samp{-}, without spaces between multiple switches.  This is supposed to
14130 ease shell processing.
14132 @item -print-multi-os-directory
14133 @opindex print-multi-os-directory
14134 Print the path to OS libraries for the selected
14135 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
14136 present in the @file{lib} subdirectory and no multilibs are used, this is
14137 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
14138 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
14139 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
14140 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
14142 @item -print-multiarch
14143 @opindex print-multiarch
14144 Print the path to OS libraries for the selected multiarch,
14145 relative to some @file{lib} subdirectory.
14147 @item -print-prog-name=@var{program}
14148 @opindex print-prog-name
14149 Like @option{-print-file-name}, but searches for a program such as @command{cpp}.
14151 @item -print-libgcc-file-name
14152 @opindex print-libgcc-file-name
14153 Same as @option{-print-file-name=libgcc.a}.
14155 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
14156 but you do want to link with @file{libgcc.a}.  You can do:
14158 @smallexample
14159 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
14160 @end smallexample
14162 @item -print-search-dirs
14163 @opindex print-search-dirs
14164 Print the name of the configured installation directory and a list of
14165 program and library directories @command{gcc} searches---and don't do anything else.
14167 This is useful when @command{gcc} prints the error message
14168 @samp{installation problem, cannot exec cpp0: No such file or directory}.
14169 To resolve this you either need to put @file{cpp0} and the other compiler
14170 components where @command{gcc} expects to find them, or you can set the environment
14171 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
14172 Don't forget the trailing @samp{/}.
14173 @xref{Environment Variables}.
14175 @item -print-sysroot
14176 @opindex print-sysroot
14177 Print the target sysroot directory that is used during
14178 compilation.  This is the target sysroot specified either at configure
14179 time or using the @option{--sysroot} option, possibly with an extra
14180 suffix that depends on compilation options.  If no target sysroot is
14181 specified, the option prints nothing.
14183 @item -print-sysroot-headers-suffix
14184 @opindex print-sysroot-headers-suffix
14185 Print the suffix added to the target sysroot when searching for
14186 headers, or give an error if the compiler is not configured with such
14187 a suffix---and don't do anything else.
14189 @item -dumpmachine
14190 @opindex dumpmachine
14191 Print the compiler's target machine (for example,
14192 @samp{i686-pc-linux-gnu})---and don't do anything else.
14194 @item -dumpversion
14195 @opindex dumpversion
14196 Print the compiler version (for example, @code{3.0}, @code{6.3.0} or @code{7})---and don't do
14197 anything else.  This is the compiler version used in filesystem paths,
14198 specs, can be depending on how the compiler has been configured just
14199 a single number (major version), two numbers separated by dot (major and
14200 minor version) or three numbers separated by dots (major, minor and patchlevel
14201 version).
14203 @item -dumpfullversion
14204 @opindex dumpfullversion
14205 Print the full compiler version, always 3 numbers separated by dots,
14206 major, minor and patchlevel version.
14208 @item -dumpspecs
14209 @opindex dumpspecs
14210 Print the compiler's built-in specs---and don't do anything else.  (This
14211 is used when GCC itself is being built.)  @xref{Spec Files}.
14212 @end table
14214 @node Submodel Options
14215 @section Machine-Dependent Options
14216 @cindex submodel options
14217 @cindex specifying hardware config
14218 @cindex hardware models and configurations, specifying
14219 @cindex target-dependent options
14220 @cindex machine-dependent options
14222 Each target machine supported by GCC can have its own options---for
14223 example, to allow you to compile for a particular processor variant or
14224 ABI, or to control optimizations specific to that machine.  By
14225 convention, the names of machine-specific options start with
14226 @samp{-m}.
14228 Some configurations of the compiler also support additional target-specific
14229 options, usually for compatibility with other compilers on the same
14230 platform.
14232 @c This list is ordered alphanumerically by subsection name.
14233 @c It should be the same order and spelling as these options are listed
14234 @c in Machine Dependent Options
14236 @menu
14237 * AArch64 Options::
14238 * Adapteva Epiphany Options::
14239 * ARC Options::
14240 * ARM Options::
14241 * AVR Options::
14242 * Blackfin Options::
14243 * C6X Options::
14244 * CRIS Options::
14245 * CR16 Options::
14246 * Darwin Options::
14247 * DEC Alpha Options::
14248 * FR30 Options::
14249 * FT32 Options::
14250 * FRV Options::
14251 * GNU/Linux Options::
14252 * H8/300 Options::
14253 * HPPA Options::
14254 * IA-64 Options::
14255 * LM32 Options::
14256 * M32C Options::
14257 * M32R/D Options::
14258 * M680x0 Options::
14259 * MCore Options::
14260 * MeP Options::
14261 * MicroBlaze Options::
14262 * MIPS Options::
14263 * MMIX Options::
14264 * MN10300 Options::
14265 * Moxie Options::
14266 * MSP430 Options::
14267 * NDS32 Options::
14268 * Nios II Options::
14269 * Nvidia PTX Options::
14270 * PDP-11 Options::
14271 * picoChip Options::
14272 * PowerPC Options::
14273 * RISC-V Options::
14274 * RL78 Options::
14275 * RS/6000 and PowerPC Options::
14276 * RX Options::
14277 * S/390 and zSeries Options::
14278 * Score Options::
14279 * SH Options::
14280 * Solaris 2 Options::
14281 * SPARC Options::
14282 * SPU Options::
14283 * System V Options::
14284 * TILE-Gx Options::
14285 * TILEPro Options::
14286 * V850 Options::
14287 * VAX Options::
14288 * Visium Options::
14289 * VMS Options::
14290 * VxWorks Options::
14291 * x86 Options::
14292 * x86 Windows Options::
14293 * Xstormy16 Options::
14294 * Xtensa Options::
14295 * zSeries Options::
14296 @end menu
14298 @node AArch64 Options
14299 @subsection AArch64 Options
14300 @cindex AArch64 Options
14302 These options are defined for AArch64 implementations:
14304 @table @gcctabopt
14306 @item -mabi=@var{name}
14307 @opindex mabi
14308 Generate code for the specified data model.  Permissible values
14309 are @samp{ilp32} for SysV-like data model where int, long int and pointers
14310 are 32 bits, and @samp{lp64} for SysV-like data model where int is 32 bits,
14311 but long int and pointers are 64 bits.
14313 The default depends on the specific target configuration.  Note that
14314 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
14315 entire program with the same ABI, and link with a compatible set of libraries.
14317 @item -mbig-endian
14318 @opindex mbig-endian
14319 Generate big-endian code.  This is the default when GCC is configured for an
14320 @samp{aarch64_be-*-*} target.
14322 @item -mgeneral-regs-only
14323 @opindex mgeneral-regs-only
14324 Generate code which uses only the general-purpose registers.  This will prevent
14325 the compiler from using floating-point and Advanced SIMD registers but will not
14326 impose any restrictions on the assembler.
14328 @item -mlittle-endian
14329 @opindex mlittle-endian
14330 Generate little-endian code.  This is the default when GCC is configured for an
14331 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
14333 @item -mcmodel=tiny
14334 @opindex mcmodel=tiny
14335 Generate code for the tiny code model.  The program and its statically defined
14336 symbols must be within 1MB of each other.  Programs can be statically or
14337 dynamically linked.
14339 @item -mcmodel=small
14340 @opindex mcmodel=small
14341 Generate code for the small code model.  The program and its statically defined
14342 symbols must be within 4GB of each other.  Programs can be statically or
14343 dynamically linked.  This is the default code model.
14345 @item -mcmodel=large
14346 @opindex mcmodel=large
14347 Generate code for the large code model.  This makes no assumptions about
14348 addresses and sizes of sections.  Programs can be statically linked only.
14350 @item -mstrict-align
14351 @opindex mstrict-align
14352 Avoid generating memory accesses that may not be aligned on a natural object
14353 boundary as described in the architecture specification.
14355 @item -momit-leaf-frame-pointer
14356 @itemx -mno-omit-leaf-frame-pointer
14357 @opindex momit-leaf-frame-pointer
14358 @opindex mno-omit-leaf-frame-pointer
14359 Omit or keep the frame pointer in leaf functions.  The former behavior is the
14360 default.
14362 @item -mtls-dialect=desc
14363 @opindex mtls-dialect=desc
14364 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
14365 of TLS variables.  This is the default.
14367 @item -mtls-dialect=traditional
14368 @opindex mtls-dialect=traditional
14369 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
14370 of TLS variables.
14372 @item -mtls-size=@var{size}
14373 @opindex mtls-size
14374 Specify bit size of immediate TLS offsets.  Valid values are 12, 24, 32, 48.
14375 This option requires binutils 2.26 or newer.
14377 @item -mfix-cortex-a53-835769
14378 @itemx -mno-fix-cortex-a53-835769
14379 @opindex mfix-cortex-a53-835769
14380 @opindex mno-fix-cortex-a53-835769
14381 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
14382 This involves inserting a NOP instruction between memory instructions and
14383 64-bit integer multiply-accumulate instructions.
14385 @item -mfix-cortex-a53-843419
14386 @itemx -mno-fix-cortex-a53-843419
14387 @opindex mfix-cortex-a53-843419
14388 @opindex mno-fix-cortex-a53-843419
14389 Enable or disable the workaround for the ARM Cortex-A53 erratum number 843419.
14390 This erratum workaround is made at link time and this will only pass the
14391 corresponding flag to the linker.
14393 @item -mlow-precision-recip-sqrt
14394 @item -mno-low-precision-recip-sqrt
14395 @opindex mlow-precision-recip-sqrt
14396 @opindex mno-low-precision-recip-sqrt
14397 Enable or disable the reciprocal square root approximation.
14398 This option only has an effect if @option{-ffast-math} or
14399 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14400 precision of reciprocal square root results to about 16 bits for
14401 single precision and to 32 bits for double precision.
14403 @item -mlow-precision-sqrt
14404 @item -mno-low-precision-sqrt
14405 @opindex -mlow-precision-sqrt
14406 @opindex -mno-low-precision-sqrt
14407 Enable or disable the square root approximation.
14408 This option only has an effect if @option{-ffast-math} or
14409 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14410 precision of square root results to about 16 bits for
14411 single precision and to 32 bits for double precision.
14412 If enabled, it implies @option{-mlow-precision-recip-sqrt}.
14414 @item -mlow-precision-div
14415 @item -mno-low-precision-div
14416 @opindex -mlow-precision-div
14417 @opindex -mno-low-precision-div
14418 Enable or disable the division approximation.
14419 This option only has an effect if @option{-ffast-math} or
14420 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14421 precision of division results to about 16 bits for
14422 single precision and to 32 bits for double precision.
14424 @item -march=@var{name}
14425 @opindex march
14426 Specify the name of the target architecture and, optionally, one or
14427 more feature modifiers.  This option has the form
14428 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}.
14430 The permissible values for @var{arch} are @samp{armv8-a},
14431 @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a} or @var{native}.
14433 The value @samp{armv8.3-a} implies @samp{armv8.2-a} and enables compiler
14434 support for the ARMv8.3-A architecture extensions.
14436 The value @samp{armv8.2-a} implies @samp{armv8.1-a} and enables compiler
14437 support for the ARMv8.2-A architecture extensions.
14439 The value @samp{armv8.1-a} implies @samp{armv8-a} and enables compiler
14440 support for the ARMv8.1-A architecture extension.  In particular, it
14441 enables the @samp{+crc}, @samp{+lse}, and @samp{+rdma} features.
14443 The value @samp{native} is available on native AArch64 GNU/Linux and
14444 causes the compiler to pick the architecture of the host system.  This
14445 option has no effect if the compiler is unable to recognize the
14446 architecture of the host system,
14448 The permissible values for @var{feature} are listed in the sub-section
14449 on @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14450 Feature Modifiers}.  Where conflicting feature modifiers are
14451 specified, the right-most feature is used.
14453 GCC uses @var{name} to determine what kind of instructions it can emit
14454 when generating assembly code.  If @option{-march} is specified
14455 without either of @option{-mtune} or @option{-mcpu} also being
14456 specified, the code is tuned to perform well across a range of target
14457 processors implementing the target architecture.
14459 @item -mtune=@var{name}
14460 @opindex mtune
14461 Specify the name of the target processor for which GCC should tune the
14462 performance of the code.  Permissible values for this option are:
14463 @samp{generic}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
14464 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
14465 @samp{exynos-m1}, @samp{falkor}, @samp{qdf24xx}, @samp{saphira},
14466 @samp{xgene1}, @samp{vulcan}, @samp{thunderx},
14467 @samp{thunderxt88}, @samp{thunderxt88p1}, @samp{thunderxt81},
14468 @samp{thunderxt83}, @samp{thunderx2t99}, @samp{cortex-a57.cortex-a53},
14469 @samp{cortex-a72.cortex-a53}, @samp{cortex-a73.cortex-a35},
14470 @samp{cortex-a73.cortex-a53}, @samp{cortex-a75.cortex-a55},
14471 @samp{native}.
14473 The values @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
14474 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53},
14475 @samp{cortex-a75.cortex-a55} specify that GCC should tune for a
14476 big.LITTLE system.
14478 Additionally on native AArch64 GNU/Linux systems the value
14479 @samp{native} tunes performance to the host system.  This option has no effect
14480 if the compiler is unable to recognize the processor of the host system.
14482 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
14483 are specified, the code is tuned to perform well across a range
14484 of target processors.
14486 This option cannot be suffixed by feature modifiers.
14488 @item -mcpu=@var{name}
14489 @opindex mcpu
14490 Specify the name of the target processor, optionally suffixed by one
14491 or more feature modifiers.  This option has the form
14492 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where
14493 the permissible values for @var{cpu} are the same as those available
14494 for @option{-mtune}.  The permissible values for @var{feature} are
14495 documented in the sub-section on
14496 @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14497 Feature Modifiers}.  Where conflicting feature modifiers are
14498 specified, the right-most feature is used.
14500 GCC uses @var{name} to determine what kind of instructions it can emit when
14501 generating assembly code (as if by @option{-march}) and to determine
14502 the target processor for which to tune for performance (as if
14503 by @option{-mtune}).  Where this option is used in conjunction
14504 with @option{-march} or @option{-mtune}, those options take precedence
14505 over the appropriate part of this option.
14507 @item -moverride=@var{string}
14508 @opindex moverride
14509 Override tuning decisions made by the back-end in response to a
14510 @option{-mtune=} switch.  The syntax, semantics, and accepted values
14511 for @var{string} in this option are not guaranteed to be consistent
14512 across releases.
14514 This option is only intended to be useful when developing GCC.
14516 @item -mpc-relative-literal-loads
14517 @itemx -mno-pc-relative-literal-loads
14518 @opindex mpc-relative-literal-loads
14519 @opindex mno-pc-relative-literal-loads
14520 Enable or disable PC-relative literal loads.  With this option literal pools are
14521 accessed using a single instruction and emitted after each function.  This
14522 limits the maximum size of functions to 1MB.  This is enabled by default for
14523 @option{-mcmodel=tiny}.
14525 @item -msign-return-address=@var{scope}
14526 @opindex msign-return-address
14527 Select the function scope on which return address signing will be applied.
14528 Permissible values are @samp{none}, which disables return address signing,
14529 @samp{non-leaf}, which enables pointer signing for functions which are not leaf
14530 functions, and @samp{all}, which enables pointer signing for all functions.  The
14531 default value is @samp{none}.
14533 @end table
14535 @subsubsection @option{-march} and @option{-mcpu} Feature Modifiers
14536 @anchor{aarch64-feature-modifiers}
14537 @cindex @option{-march} feature modifiers
14538 @cindex @option{-mcpu} feature modifiers
14539 Feature modifiers used with @option{-march} and @option{-mcpu} can be any of
14540 the following and their inverses @option{no@var{feature}}:
14542 @table @samp
14543 @item crc
14544 Enable CRC extension.  This is on by default for
14545 @option{-march=armv8.1-a}.
14546 @item crypto
14547 Enable Crypto extension.  This also enables Advanced SIMD and floating-point
14548 instructions.
14549 @item fp
14550 Enable floating-point instructions.  This is on by default for all possible
14551 values for options @option{-march} and @option{-mcpu}.
14552 @item simd
14553 Enable Advanced SIMD instructions.  This also enables floating-point
14554 instructions.  This is on by default for all possible values for options
14555 @option{-march} and @option{-mcpu}.
14556 @item lse
14557 Enable Large System Extension instructions.  This is on by default for
14558 @option{-march=armv8.1-a}.
14559 @item rdma
14560 Enable Round Double Multiply Accumulate instructions.  This is on by default
14561 for @option{-march=armv8.1-a}.
14562 @item fp16
14563 Enable FP16 extension.  This also enables floating-point instructions.
14564 @item rcpc
14565 Enable the RcPc extension.  This does not change code generation from GCC,
14566 but is passed on to the assembler, enabling inline asm statements to use
14567 instructions from the RcPc extension.
14568 @item dotprod
14569 Enable the Dot Product extension.  This also enables Advanced SIMD instructions.
14571 @end table
14573 Feature @option{crypto} implies @option{simd}, which implies @option{fp}.
14574 Conversely, @option{nofp} implies @option{nosimd}, which implies
14575 @option{nocrypto}.
14577 @node Adapteva Epiphany Options
14578 @subsection Adapteva Epiphany Options
14580 These @samp{-m} options are defined for Adapteva Epiphany:
14582 @table @gcctabopt
14583 @item -mhalf-reg-file
14584 @opindex mhalf-reg-file
14585 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
14586 That allows code to run on hardware variants that lack these registers.
14588 @item -mprefer-short-insn-regs
14589 @opindex mprefer-short-insn-regs
14590 Preferentially allocate registers that allow short instruction generation.
14591 This can result in increased instruction count, so this may either reduce or
14592 increase overall code size.
14594 @item -mbranch-cost=@var{num}
14595 @opindex mbranch-cost
14596 Set the cost of branches to roughly @var{num} ``simple'' instructions.
14597 This cost is only a heuristic and is not guaranteed to produce
14598 consistent results across releases.
14600 @item -mcmove
14601 @opindex mcmove
14602 Enable the generation of conditional moves.
14604 @item -mnops=@var{num}
14605 @opindex mnops
14606 Emit @var{num} NOPs before every other generated instruction.
14608 @item -mno-soft-cmpsf
14609 @opindex mno-soft-cmpsf
14610 For single-precision floating-point comparisons, emit an @code{fsub} instruction
14611 and test the flags.  This is faster than a software comparison, but can
14612 get incorrect results in the presence of NaNs, or when two different small
14613 numbers are compared such that their difference is calculated as zero.
14614 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
14615 software comparisons.
14617 @item -mstack-offset=@var{num}
14618 @opindex mstack-offset
14619 Set the offset between the top of the stack and the stack pointer.
14620 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
14621 can be used by leaf functions without stack allocation.
14622 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
14623 Note also that this option changes the ABI; compiling a program with a
14624 different stack offset than the libraries have been compiled with
14625 generally does not work.
14626 This option can be useful if you want to evaluate if a different stack
14627 offset would give you better code, but to actually use a different stack
14628 offset to build working programs, it is recommended to configure the
14629 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
14631 @item -mno-round-nearest
14632 @opindex mno-round-nearest
14633 Make the scheduler assume that the rounding mode has been set to
14634 truncating.  The default is @option{-mround-nearest}.
14636 @item -mlong-calls
14637 @opindex mlong-calls
14638 If not otherwise specified by an attribute, assume all calls might be beyond
14639 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
14640 function address into a register before performing a (otherwise direct) call.
14641 This is the default.
14643 @item -mshort-calls
14644 @opindex short-calls
14645 If not otherwise specified by an attribute, assume all direct calls are
14646 in the range of the @code{b} / @code{bl} instructions, so use these instructions
14647 for direct calls.  The default is @option{-mlong-calls}.
14649 @item -msmall16
14650 @opindex msmall16
14651 Assume addresses can be loaded as 16-bit unsigned values.  This does not
14652 apply to function addresses for which @option{-mlong-calls} semantics
14653 are in effect.
14655 @item -mfp-mode=@var{mode}
14656 @opindex mfp-mode
14657 Set the prevailing mode of the floating-point unit.
14658 This determines the floating-point mode that is provided and expected
14659 at function call and return time.  Making this mode match the mode you
14660 predominantly need at function start can make your programs smaller and
14661 faster by avoiding unnecessary mode switches.
14663 @var{mode} can be set to one the following values:
14665 @table @samp
14666 @item caller
14667 Any mode at function entry is valid, and retained or restored when
14668 the function returns, and when it calls other functions.
14669 This mode is useful for compiling libraries or other compilation units
14670 you might want to incorporate into different programs with different
14671 prevailing FPU modes, and the convenience of being able to use a single
14672 object file outweighs the size and speed overhead for any extra
14673 mode switching that might be needed, compared with what would be needed
14674 with a more specific choice of prevailing FPU mode.
14676 @item truncate
14677 This is the mode used for floating-point calculations with
14678 truncating (i.e.@: round towards zero) rounding mode.  That includes
14679 conversion from floating point to integer.
14681 @item round-nearest
14682 This is the mode used for floating-point calculations with
14683 round-to-nearest-or-even rounding mode.
14685 @item int
14686 This is the mode used to perform integer calculations in the FPU, e.g.@:
14687 integer multiply, or integer multiply-and-accumulate.
14688 @end table
14690 The default is @option{-mfp-mode=caller}
14692 @item -mnosplit-lohi
14693 @itemx -mno-postinc
14694 @itemx -mno-postmodify
14695 @opindex mnosplit-lohi
14696 @opindex mno-postinc
14697 @opindex mno-postmodify
14698 Code generation tweaks that disable, respectively, splitting of 32-bit
14699 loads, generation of post-increment addresses, and generation of
14700 post-modify addresses.  The defaults are @option{msplit-lohi},
14701 @option{-mpost-inc}, and @option{-mpost-modify}.
14703 @item -mnovect-double
14704 @opindex mno-vect-double
14705 Change the preferred SIMD mode to SImode.  The default is
14706 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
14708 @item -max-vect-align=@var{num}
14709 @opindex max-vect-align
14710 The maximum alignment for SIMD vector mode types.
14711 @var{num} may be 4 or 8.  The default is 8.
14712 Note that this is an ABI change, even though many library function
14713 interfaces are unaffected if they don't use SIMD vector modes
14714 in places that affect size and/or alignment of relevant types.
14716 @item -msplit-vecmove-early
14717 @opindex msplit-vecmove-early
14718 Split vector moves into single word moves before reload.  In theory this
14719 can give better register allocation, but so far the reverse seems to be
14720 generally the case.
14722 @item -m1reg-@var{reg}
14723 @opindex m1reg-
14724 Specify a register to hold the constant @minus{}1, which makes loading small negative
14725 constants and certain bitmasks faster.
14726 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
14727 which specify use of that register as a fixed register,
14728 and @samp{none}, which means that no register is used for this
14729 purpose.  The default is @option{-m1reg-none}.
14731 @end table
14733 @node ARC Options
14734 @subsection ARC Options
14735 @cindex ARC options
14737 The following options control the architecture variant for which code
14738 is being compiled:
14740 @c architecture variants
14741 @table @gcctabopt
14743 @item -mbarrel-shifter
14744 @opindex mbarrel-shifter
14745 Generate instructions supported by barrel shifter.  This is the default
14746 unless @option{-mcpu=ARC601} or @samp{-mcpu=ARCEM} is in effect.
14748 @item -mcpu=@var{cpu}
14749 @opindex mcpu
14750 Set architecture type, register usage, and instruction scheduling
14751 parameters for @var{cpu}.  There are also shortcut alias options
14752 available for backward compatibility and convenience.  Supported
14753 values for @var{cpu} are
14755 @table @samp
14756 @opindex mA6
14757 @opindex mARC600
14758 @item arc600
14759 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
14761 @item arc601
14762 @opindex mARC601
14763 Compile for ARC601.  Alias: @option{-mARC601}.
14765 @item arc700
14766 @opindex mA7
14767 @opindex mARC700
14768 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
14769 This is the default when configured with @option{--with-cpu=arc700}@.
14771 @item arcem
14772 Compile for ARC EM.
14774 @item archs
14775 Compile for ARC HS.
14777 @item em
14778 Compile for ARC EM CPU with no hardware extensions.
14780 @item em4
14781 Compile for ARC EM4 CPU.
14783 @item em4_dmips
14784 Compile for ARC EM4 DMIPS CPU.
14786 @item em4_fpus
14787 Compile for ARC EM4 DMIPS CPU with the single-precision floating-point
14788 extension.
14790 @item em4_fpuda
14791 Compile for ARC EM4 DMIPS CPU with single-precision floating-point and
14792 double assist instructions.
14794 @item hs
14795 Compile for ARC HS CPU with no hardware extensions except the atomic
14796 instructions.
14798 @item hs34
14799 Compile for ARC HS34 CPU.
14801 @item hs38
14802 Compile for ARC HS38 CPU.
14804 @item hs38_linux
14805 Compile for ARC HS38 CPU with all hardware extensions on.
14807 @item arc600_norm
14808 Compile for ARC 600 CPU with @code{norm} instructions enabled.
14810 @item arc600_mul32x16
14811 Compile for ARC 600 CPU with @code{norm} and 32x16-bit multiply 
14812 instructions enabled.
14814 @item arc600_mul64
14815 Compile for ARC 600 CPU with @code{norm} and @code{mul64}-family 
14816 instructions enabled.
14818 @item arc601_norm
14819 Compile for ARC 601 CPU with @code{norm} instructions enabled.
14821 @item arc601_mul32x16
14822 Compile for ARC 601 CPU with @code{norm} and 32x16-bit multiply
14823 instructions enabled.
14825 @item arc601_mul64
14826 Compile for ARC 601 CPU with @code{norm} and @code{mul64}-family
14827 instructions enabled.
14829 @item nps400
14830 Compile for ARC 700 on NPS400 chip.
14832 @end table
14834 @item -mdpfp
14835 @opindex mdpfp
14836 @itemx -mdpfp-compact
14837 @opindex mdpfp-compact
14838 Generate double-precision FPX instructions, tuned for the compact
14839 implementation.
14841 @item -mdpfp-fast
14842 @opindex mdpfp-fast
14843 Generate double-precision FPX instructions, tuned for the fast
14844 implementation.
14846 @item -mno-dpfp-lrsr
14847 @opindex mno-dpfp-lrsr
14848 Disable @code{lr} and @code{sr} instructions from using FPX extension
14849 aux registers.
14851 @item -mea
14852 @opindex mea
14853 Generate extended arithmetic instructions.  Currently only
14854 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
14855 supported.  This is always enabled for @option{-mcpu=ARC700}.
14857 @item -mno-mpy
14858 @opindex mno-mpy
14859 Do not generate @code{mpy}-family instructions for ARC700.  This option is
14860 deprecated.
14862 @item -mmul32x16
14863 @opindex mmul32x16
14864 Generate 32x16-bit multiply and multiply-accumulate instructions.
14866 @item -mmul64
14867 @opindex mmul64
14868 Generate @code{mul64} and @code{mulu64} instructions.  
14869 Only valid for @option{-mcpu=ARC600}.
14871 @item -mnorm
14872 @opindex mnorm
14873 Generate @code{norm} instructions.  This is the default if @option{-mcpu=ARC700}
14874 is in effect.
14876 @item -mspfp
14877 @opindex mspfp
14878 @itemx -mspfp-compact
14879 @opindex mspfp-compact
14880 Generate single-precision FPX instructions, tuned for the compact
14881 implementation.
14883 @item -mspfp-fast
14884 @opindex mspfp-fast
14885 Generate single-precision FPX instructions, tuned for the fast
14886 implementation.
14888 @item -msimd
14889 @opindex msimd
14890 Enable generation of ARC SIMD instructions via target-specific
14891 builtins.  Only valid for @option{-mcpu=ARC700}.
14893 @item -msoft-float
14894 @opindex msoft-float
14895 This option ignored; it is provided for compatibility purposes only.
14896 Software floating-point code is emitted by default, and this default
14897 can overridden by FPX options; @option{-mspfp}, @option{-mspfp-compact}, or
14898 @option{-mspfp-fast} for single precision, and @option{-mdpfp},
14899 @option{-mdpfp-compact}, or @option{-mdpfp-fast} for double precision.
14901 @item -mswap
14902 @opindex mswap
14903 Generate @code{swap} instructions.
14905 @item -matomic
14906 @opindex matomic
14907 This enables use of the locked load/store conditional extension to implement
14908 atomic memory built-in functions.  Not available for ARC 6xx or ARC
14909 EM cores.
14911 @item -mdiv-rem
14912 @opindex mdiv-rem
14913 Enable @code{div} and @code{rem} instructions for ARCv2 cores.
14915 @item -mcode-density
14916 @opindex mcode-density
14917 Enable code density instructions for ARC EM.  
14918 This option is on by default for ARC HS.
14920 @item -mll64
14921 @opindex mll64
14922 Enable double load/store operations for ARC HS cores.
14924 @item -mtp-regno=@var{regno}
14925 @opindex mtp-regno
14926 Specify thread pointer register number.
14928 @item -mmpy-option=@var{multo}
14929 @opindex mmpy-option
14930 Compile ARCv2 code with a multiplier design option.  You can specify 
14931 the option using either a string or numeric value for @var{multo}.  
14932 @samp{wlh1} is the default value.  The recognized values are:
14934 @table @samp
14935 @item 0
14936 @itemx none
14937 No multiplier available.
14939 @item 1
14940 @itemx w
14941 16x16 multiplier, fully pipelined.
14942 The following instructions are enabled: @code{mpyw} and @code{mpyuw}.
14944 @item 2
14945 @itemx wlh1
14946 32x32 multiplier, fully
14947 pipelined (1 stage).  The following instructions are additionally
14948 enabled: @code{mpy}, @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14950 @item 3
14951 @itemx wlh2
14952 32x32 multiplier, fully pipelined
14953 (2 stages).  The following instructions are additionally enabled: @code{mpy},
14954 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14956 @item 4
14957 @itemx wlh3
14958 Two 16x16 multipliers, blocking,
14959 sequential.  The following instructions are additionally enabled: @code{mpy},
14960 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14962 @item 5
14963 @itemx wlh4
14964 One 16x16 multiplier, blocking,
14965 sequential.  The following instructions are additionally enabled: @code{mpy},
14966 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14968 @item 6
14969 @itemx wlh5
14970 One 32x4 multiplier, blocking,
14971 sequential.  The following instructions are additionally enabled: @code{mpy},
14972 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14974 @item 7
14975 @itemx plus_dmpy
14976 ARC HS SIMD support.
14978 @item 8
14979 @itemx plus_macd
14980 ARC HS SIMD support.
14982 @item 9
14983 @itemx plus_qmacw
14984 ARC HS SIMD support.
14986 @end table
14988 This option is only available for ARCv2 cores@.
14990 @item -mfpu=@var{fpu}
14991 @opindex mfpu
14992 Enables support for specific floating-point hardware extensions for ARCv2
14993 cores.  Supported values for @var{fpu} are:
14995 @table @samp
14997 @item fpus
14998 Enables support for single-precision floating-point hardware
14999 extensions@.
15001 @item fpud
15002 Enables support for double-precision floating-point hardware
15003 extensions.  The single-precision floating-point extension is also
15004 enabled.  Not available for ARC EM@.
15006 @item fpuda
15007 Enables support for double-precision floating-point hardware
15008 extensions using double-precision assist instructions.  The single-precision
15009 floating-point extension is also enabled.  This option is
15010 only available for ARC EM@.
15012 @item fpuda_div
15013 Enables support for double-precision floating-point hardware
15014 extensions using double-precision assist instructions.
15015 The single-precision floating-point, square-root, and divide 
15016 extensions are also enabled.  This option is
15017 only available for ARC EM@.
15019 @item fpuda_fma
15020 Enables support for double-precision floating-point hardware
15021 extensions using double-precision assist instructions.
15022 The single-precision floating-point and fused multiply and add 
15023 hardware extensions are also enabled.  This option is
15024 only available for ARC EM@.
15026 @item fpuda_all
15027 Enables support for double-precision floating-point hardware
15028 extensions using double-precision assist instructions.
15029 All single-precision floating-point hardware extensions are also
15030 enabled.  This option is only available for ARC EM@.
15032 @item fpus_div
15033 Enables support for single-precision floating-point, square-root and divide 
15034 hardware extensions@.
15036 @item fpud_div
15037 Enables support for double-precision floating-point, square-root and divide 
15038 hardware extensions.  This option
15039 includes option @samp{fpus_div}. Not available for ARC EM@.
15041 @item fpus_fma
15042 Enables support for single-precision floating-point and 
15043 fused multiply and add hardware extensions@.
15045 @item fpud_fma
15046 Enables support for double-precision floating-point and 
15047 fused multiply and add hardware extensions.  This option
15048 includes option @samp{fpus_fma}.  Not available for ARC EM@.
15050 @item fpus_all
15051 Enables support for all single-precision floating-point hardware
15052 extensions@.
15054 @item fpud_all
15055 Enables support for all single- and double-precision floating-point
15056 hardware extensions.  Not available for ARC EM@.
15058 @end table
15060 @item -mirq-ctrl-saved=@var{register-range}, @var{blink}, @var{lp_count}
15061 @opindex mirq-ctrl-saved
15062 Specifies general-purposes registers that the processor automatically
15063 saves/restores on interrupt entry and exit.  @var{register-range} is
15064 specified as two registers separated by a dash.  The register range
15065 always starts with @code{r0}, the upper limit is @code{fp} register.
15066 @var{blink} and @var{lp_count} are optional.  This option is only
15067 valid for ARC EM and ARC HS cores.
15069 @item -mrgf-banked-regs=@var{number}
15070 @opindex mrgf-banked-regs
15071 Specifies the number of registers replicated in second register bank
15072 on entry to fast interrupt.  Fast interrupts are interrupts with the
15073 highest priority level P0.  These interrupts save only PC and STATUS32
15074 registers to avoid memory transactions during interrupt entry and exit
15075 sequences.  Use this option when you are using fast interrupts in an
15076 ARC V2 family processor.  Permitted values are 4, 8, 16, and 32.
15078 @item -mlpc-width=@var{width}
15079 @opindex mlpc-width
15080 Specify the width of the @code{lp_count} register.  Valid values for
15081 @var{width} are 8, 16, 20, 24, 28 and 32 bits.  The default width is
15082 fixed to 32 bits.  If the width is less than 32, the compiler does not
15083 attempt to transform loops in your program to use the zero-delay loop
15084 mechanism unless it is known that the @code{lp_count} register can
15085 hold the required loop-counter value.  Depending on the width
15086 specified, the compiler and run-time library might continue to use the
15087 loop mechanism for various needs.  This option defines macro
15088 @code{__ARC_LPC_WIDTH__} with the value of @var{width}.
15090 @end table
15092 The following options are passed through to the assembler, and also
15093 define preprocessor macro symbols.
15095 @c Flags used by the assembler, but for which we define preprocessor
15096 @c macro symbols as well.
15097 @table @gcctabopt
15098 @item -mdsp-packa
15099 @opindex mdsp-packa
15100 Passed down to the assembler to enable the DSP Pack A extensions.
15101 Also sets the preprocessor symbol @code{__Xdsp_packa}.  This option is
15102 deprecated.
15104 @item -mdvbf
15105 @opindex mdvbf
15106 Passed down to the assembler to enable the dual Viterbi butterfly
15107 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.  This
15108 option is deprecated.
15110 @c ARC700 4.10 extension instruction
15111 @item -mlock
15112 @opindex mlock
15113 Passed down to the assembler to enable the locked load/store
15114 conditional extension.  Also sets the preprocessor symbol
15115 @code{__Xlock}.
15117 @item -mmac-d16
15118 @opindex mmac-d16
15119 Passed down to the assembler.  Also sets the preprocessor symbol
15120 @code{__Xxmac_d16}.  This option is deprecated.
15122 @item -mmac-24
15123 @opindex mmac-24
15124 Passed down to the assembler.  Also sets the preprocessor symbol
15125 @code{__Xxmac_24}.  This option is deprecated.
15127 @c ARC700 4.10 extension instruction
15128 @item -mrtsc
15129 @opindex mrtsc
15130 Passed down to the assembler to enable the 64-bit time-stamp counter
15131 extension instruction.  Also sets the preprocessor symbol
15132 @code{__Xrtsc}.  This option is deprecated.
15134 @c ARC700 4.10 extension instruction
15135 @item -mswape
15136 @opindex mswape
15137 Passed down to the assembler to enable the swap byte ordering
15138 extension instruction.  Also sets the preprocessor symbol
15139 @code{__Xswape}.
15141 @item -mtelephony
15142 @opindex mtelephony
15143 Passed down to the assembler to enable dual- and single-operand
15144 instructions for telephony.  Also sets the preprocessor symbol
15145 @code{__Xtelephony}.  This option is deprecated.
15147 @item -mxy
15148 @opindex mxy
15149 Passed down to the assembler to enable the XY memory extension.  Also
15150 sets the preprocessor symbol @code{__Xxy}.
15152 @end table
15154 The following options control how the assembly code is annotated:
15156 @c Assembly annotation options
15157 @table @gcctabopt
15158 @item -misize
15159 @opindex misize
15160 Annotate assembler instructions with estimated addresses.
15162 @item -mannotate-align
15163 @opindex mannotate-align
15164 Explain what alignment considerations lead to the decision to make an
15165 instruction short or long.
15167 @end table
15169 The following options are passed through to the linker:
15171 @c options passed through to the linker
15172 @table @gcctabopt
15173 @item -marclinux
15174 @opindex marclinux
15175 Passed through to the linker, to specify use of the @code{arclinux} emulation.
15176 This option is enabled by default in tool chains built for
15177 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
15178 when profiling is not requested.
15180 @item -marclinux_prof
15181 @opindex marclinux_prof
15182 Passed through to the linker, to specify use of the
15183 @code{arclinux_prof} emulation.  This option is enabled by default in
15184 tool chains built for @w{@code{arc-linux-uclibc}} and
15185 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
15187 @end table
15189 The following options control the semantics of generated code:
15191 @c semantically relevant code generation options
15192 @table @gcctabopt
15193 @item -mlong-calls
15194 @opindex mlong-calls
15195 Generate calls as register indirect calls, thus providing access
15196 to the full 32-bit address range.
15198 @item -mmedium-calls
15199 @opindex mmedium-calls
15200 Don't use less than 25-bit addressing range for calls, which is the
15201 offset available for an unconditional branch-and-link
15202 instruction.  Conditional execution of function calls is suppressed, to
15203 allow use of the 25-bit range, rather than the 21-bit range with
15204 conditional branch-and-link.  This is the default for tool chains built
15205 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
15207 @item -G @var{num}
15208 @opindex G
15209 Put definitions of externally-visible data in a small data section if
15210 that data is no bigger than @var{num} bytes.  The default value of
15211 @var{num} is 4 for any ARC configuration, or 8 when we have double
15212 load/store operations.
15214 @item -mno-sdata
15215 @opindex mno-sdata
15216 Do not generate sdata references.  This is the default for tool chains
15217 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
15218 targets.
15220 @item -mvolatile-cache
15221 @opindex mvolatile-cache
15222 Use ordinarily cached memory accesses for volatile references.  This is the
15223 default.
15225 @item -mno-volatile-cache
15226 @opindex mno-volatile-cache
15227 Enable cache bypass for volatile references.
15229 @end table
15231 The following options fine tune code generation:
15232 @c code generation tuning options
15233 @table @gcctabopt
15234 @item -malign-call
15235 @opindex malign-call
15236 Do alignment optimizations for call instructions.
15238 @item -mauto-modify-reg
15239 @opindex mauto-modify-reg
15240 Enable the use of pre/post modify with register displacement.
15242 @item -mbbit-peephole
15243 @opindex mbbit-peephole
15244 Enable bbit peephole2.
15246 @item -mno-brcc
15247 @opindex mno-brcc
15248 This option disables a target-specific pass in @file{arc_reorg} to
15249 generate compare-and-branch (@code{br@var{cc}}) instructions.  
15250 It has no effect on
15251 generation of these instructions driven by the combiner pass.
15253 @item -mcase-vector-pcrel
15254 @opindex mcase-vector-pcrel
15255 Use PC-relative switch case tables to enable case table shortening.
15256 This is the default for @option{-Os}.
15258 @item -mcompact-casesi
15259 @opindex mcompact-casesi
15260 Enable compact @code{casesi} pattern.  This is the default for @option{-Os},
15261 and only available for ARCv1 cores.
15263 @item -mno-cond-exec
15264 @opindex mno-cond-exec
15265 Disable the ARCompact-specific pass to generate conditional 
15266 execution instructions.
15268 Due to delay slot scheduling and interactions between operand numbers,
15269 literal sizes, instruction lengths, and the support for conditional execution,
15270 the target-independent pass to generate conditional execution is often lacking,
15271 so the ARC port has kept a special pass around that tries to find more
15272 conditional execution generation opportunities after register allocation,
15273 branch shortening, and delay slot scheduling have been done.  This pass
15274 generally, but not always, improves performance and code size, at the cost of
15275 extra compilation time, which is why there is an option to switch it off.
15276 If you have a problem with call instructions exceeding their allowable
15277 offset range because they are conditionalized, you should consider using
15278 @option{-mmedium-calls} instead.
15280 @item -mearly-cbranchsi
15281 @opindex mearly-cbranchsi
15282 Enable pre-reload use of the @code{cbranchsi} pattern.
15284 @item -mexpand-adddi
15285 @opindex mexpand-adddi
15286 Expand @code{adddi3} and @code{subdi3} at RTL generation time into
15287 @code{add.f}, @code{adc} etc.  This option is deprecated.
15289 @item -mindexed-loads
15290 @opindex mindexed-loads
15291 Enable the use of indexed loads.  This can be problematic because some
15292 optimizers then assume that indexed stores exist, which is not
15293 the case.
15295 @opindex mlra
15296 Enable Local Register Allocation.  This is still experimental for ARC,
15297 so by default the compiler uses standard reload
15298 (i.e. @option{-mno-lra}).
15300 @item -mlra-priority-none
15301 @opindex mlra-priority-none
15302 Don't indicate any priority for target registers.
15304 @item -mlra-priority-compact
15305 @opindex mlra-priority-compact
15306 Indicate target register priority for r0..r3 / r12..r15.
15308 @item -mlra-priority-noncompact
15309 @opindex mlra-priority-noncompact
15310 Reduce target register priority for r0..r3 / r12..r15.
15312 @item -mno-millicode
15313 @opindex mno-millicode
15314 When optimizing for size (using @option{-Os}), prologues and epilogues
15315 that have to save or restore a large number of registers are often
15316 shortened by using call to a special function in libgcc; this is
15317 referred to as a @emph{millicode} call.  As these calls can pose
15318 performance issues, and/or cause linking issues when linking in a
15319 nonstandard way, this option is provided to turn off millicode call
15320 generation.
15322 @item -mmixed-code
15323 @opindex mmixed-code
15324 Tweak register allocation to help 16-bit instruction generation.
15325 This generally has the effect of decreasing the average instruction size
15326 while increasing the instruction count.
15328 @item -mq-class
15329 @opindex mq-class
15330 Enable @samp{q} instruction alternatives.
15331 This is the default for @option{-Os}.
15333 @item -mRcq
15334 @opindex mRcq
15335 Enable @samp{Rcq} constraint handling.  
15336 Most short code generation depends on this.
15337 This is the default.
15339 @item -mRcw
15340 @opindex mRcw
15341 Enable @samp{Rcw} constraint handling.  
15342 Most ccfsm condexec mostly depends on this.
15343 This is the default.
15345 @item -msize-level=@var{level}
15346 @opindex msize-level
15347 Fine-tune size optimization with regards to instruction lengths and alignment.
15348 The recognized values for @var{level} are:
15349 @table @samp
15350 @item 0
15351 No size optimization.  This level is deprecated and treated like @samp{1}.
15353 @item 1
15354 Short instructions are used opportunistically.
15356 @item 2
15357 In addition, alignment of loops and of code after barriers are dropped.
15359 @item 3
15360 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
15362 @end table
15364 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
15365 the behavior when this is not set is equivalent to level @samp{1}.
15367 @item -mtune=@var{cpu}
15368 @opindex mtune
15369 Set instruction scheduling parameters for @var{cpu}, overriding any implied
15370 by @option{-mcpu=}.
15372 Supported values for @var{cpu} are
15374 @table @samp
15375 @item ARC600
15376 Tune for ARC600 CPU.
15378 @item ARC601
15379 Tune for ARC601 CPU.
15381 @item ARC700
15382 Tune for ARC700 CPU with standard multiplier block.
15384 @item ARC700-xmac
15385 Tune for ARC700 CPU with XMAC block.
15387 @item ARC725D
15388 Tune for ARC725D CPU.
15390 @item ARC750D
15391 Tune for ARC750D CPU.
15393 @end table
15395 @item -mmultcost=@var{num}
15396 @opindex mmultcost
15397 Cost to assume for a multiply instruction, with @samp{4} being equal to a
15398 normal instruction.
15400 @item -munalign-prob-threshold=@var{probability}
15401 @opindex munalign-prob-threshold
15402 Set probability threshold for unaligning branches.
15403 When tuning for @samp{ARC700} and optimizing for speed, branches without
15404 filled delay slot are preferably emitted unaligned and long, unless
15405 profiling indicates that the probability for the branch to be taken
15406 is below @var{probability}.  @xref{Cross-profiling}.
15407 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
15409 @end table
15411 The following options are maintained for backward compatibility, but
15412 are now deprecated and will be removed in a future release:
15414 @c Deprecated options
15415 @table @gcctabopt
15417 @item -margonaut
15418 @opindex margonaut
15419 Obsolete FPX.
15421 @item -mbig-endian
15422 @opindex mbig-endian
15423 @itemx -EB
15424 @opindex EB
15425 Compile code for big-endian targets.  Use of these options is now
15426 deprecated.  Big-endian code is supported by configuring GCC to build
15427 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets,
15428 for which big endian is the default.
15430 @item -mlittle-endian
15431 @opindex mlittle-endian
15432 @itemx -EL
15433 @opindex EL
15434 Compile code for little-endian targets.  Use of these options is now
15435 deprecated.  Little-endian code is supported by configuring GCC to build 
15436 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets,
15437 for which little endian is the default.
15439 @item -mbarrel_shifter
15440 @opindex mbarrel_shifter
15441 Replaced by @option{-mbarrel-shifter}.
15443 @item -mdpfp_compact
15444 @opindex mdpfp_compact
15445 Replaced by @option{-mdpfp-compact}.
15447 @item -mdpfp_fast
15448 @opindex mdpfp_fast
15449 Replaced by @option{-mdpfp-fast}.
15451 @item -mdsp_packa
15452 @opindex mdsp_packa
15453 Replaced by @option{-mdsp-packa}.
15455 @item -mEA
15456 @opindex mEA
15457 Replaced by @option{-mea}.
15459 @item -mmac_24
15460 @opindex mmac_24
15461 Replaced by @option{-mmac-24}.
15463 @item -mmac_d16
15464 @opindex mmac_d16
15465 Replaced by @option{-mmac-d16}.
15467 @item -mspfp_compact
15468 @opindex mspfp_compact
15469 Replaced by @option{-mspfp-compact}.
15471 @item -mspfp_fast
15472 @opindex mspfp_fast
15473 Replaced by @option{-mspfp-fast}.
15475 @item -mtune=@var{cpu}
15476 @opindex mtune
15477 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
15478 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
15479 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively.
15481 @item -multcost=@var{num}
15482 @opindex multcost
15483 Replaced by @option{-mmultcost}.
15485 @end table
15487 @node ARM Options
15488 @subsection ARM Options
15489 @cindex ARM options
15491 These @samp{-m} options are defined for the ARM port:
15493 @table @gcctabopt
15494 @item -mabi=@var{name}
15495 @opindex mabi
15496 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
15497 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
15499 @item -mapcs-frame
15500 @opindex mapcs-frame
15501 Generate a stack frame that is compliant with the ARM Procedure Call
15502 Standard for all functions, even if this is not strictly necessary for
15503 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
15504 with this option causes the stack frames not to be generated for
15505 leaf functions.  The default is @option{-mno-apcs-frame}.
15506 This option is deprecated.
15508 @item -mapcs
15509 @opindex mapcs
15510 This is a synonym for @option{-mapcs-frame} and is deprecated.
15512 @ignore
15513 @c not currently implemented
15514 @item -mapcs-stack-check
15515 @opindex mapcs-stack-check
15516 Generate code to check the amount of stack space available upon entry to
15517 every function (that actually uses some stack space).  If there is
15518 insufficient space available then either the function
15519 @code{__rt_stkovf_split_small} or @code{__rt_stkovf_split_big} is
15520 called, depending upon the amount of stack space required.  The runtime
15521 system is required to provide these functions.  The default is
15522 @option{-mno-apcs-stack-check}, since this produces smaller code.
15524 @c not currently implemented
15525 @item -mapcs-reentrant
15526 @opindex mapcs-reentrant
15527 Generate reentrant, position-independent code.  The default is
15528 @option{-mno-apcs-reentrant}.
15529 @end ignore
15531 @item -mthumb-interwork
15532 @opindex mthumb-interwork
15533 Generate code that supports calling between the ARM and Thumb
15534 instruction sets.  Without this option, on pre-v5 architectures, the
15535 two instruction sets cannot be reliably used inside one program.  The
15536 default is @option{-mno-thumb-interwork}, since slightly larger code
15537 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
15538 configurations this option is meaningless.
15540 @item -mno-sched-prolog
15541 @opindex mno-sched-prolog
15542 Prevent the reordering of instructions in the function prologue, or the
15543 merging of those instruction with the instructions in the function's
15544 body.  This means that all functions start with a recognizable set
15545 of instructions (or in fact one of a choice from a small set of
15546 different function prologues), and this information can be used to
15547 locate the start of functions inside an executable piece of code.  The
15548 default is @option{-msched-prolog}.
15550 @item -mfloat-abi=@var{name}
15551 @opindex mfloat-abi
15552 Specifies which floating-point ABI to use.  Permissible values
15553 are: @samp{soft}, @samp{softfp} and @samp{hard}.
15555 Specifying @samp{soft} causes GCC to generate output containing
15556 library calls for floating-point operations.
15557 @samp{softfp} allows the generation of code using hardware floating-point
15558 instructions, but still uses the soft-float calling conventions.
15559 @samp{hard} allows generation of floating-point instructions
15560 and uses FPU-specific calling conventions.
15562 The default depends on the specific target configuration.  Note that
15563 the hard-float and soft-float ABIs are not link-compatible; you must
15564 compile your entire program with the same ABI, and link with a
15565 compatible set of libraries.
15567 @item -mlittle-endian
15568 @opindex mlittle-endian
15569 Generate code for a processor running in little-endian mode.  This is
15570 the default for all standard configurations.
15572 @item -mbig-endian
15573 @opindex mbig-endian
15574 Generate code for a processor running in big-endian mode; the default is
15575 to compile code for a little-endian processor.
15577 @item -mbe8
15578 @itemx -mbe32
15579 @opindex mbe8
15580 When linking a big-endian image select between BE8 and BE32 formats.
15581 The option has no effect for little-endian images and is ignored.  The
15582 default is dependent on the selected target architecture.  For ARMv6
15583 and later architectures the default is BE8, for older architectures
15584 the default is BE32.  BE32 format has been deprecated by ARM.
15586 @item -march=@var{name}@r{[}+extension@dots{}@r{]}
15587 @opindex march
15588 This specifies the name of the target ARM architecture.  GCC uses this
15589 name to determine what kind of instructions it can emit when generating
15590 assembly code.  This option can be used in conjunction with or instead
15591 of the @option{-mcpu=} option.
15593 Permissible names are:
15594 @samp{armv4t},
15595 @samp{armv5t}, @samp{armv5te},
15596 @samp{armv6}, @samp{armv6j}, @samp{armv6k}, @samp{armv6kz}, @samp{armv6t2},
15597 @samp{armv6z}, @samp{armv6zk},
15598 @samp{armv7}, @samp{armv7-a}, @samp{armv7ve}, 
15599 @samp{armv8-a}, @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a},
15600 @samp{armv7-r},
15601 @samp{armv8-r},
15602 @samp{armv6-m}, @samp{armv6s-m},
15603 @samp{armv7-m}, @samp{armv7e-m},
15604 @samp{armv8-m.base}, @samp{armv8-m.main},
15605 @samp{iwmmxt} and @samp{iwmmxt2}.
15607 Additionally, the following architectures, which lack support for the
15608 Thumb exection state, are recognized but support is deprecated:
15609 @samp{armv2}, @samp{armv2a}, @samp{armv3}, @samp{armv3m},
15610 @samp{armv4}, @samp{armv5} and @samp{armv5e}.
15612 Many of the architectures support extensions.  These can be added by
15613 appending @samp{+@var{extension}} to the architecture name.  Extension
15614 options are processed in order and capabilities accumulate.  An extension
15615 will also enable any necessary base extensions
15616 upon which it depends.  For example, the @samp{+crypto} extension
15617 will always enable the @samp{+simd} extension.  The exception to the
15618 additive construction is for extensions that are prefixed with
15619 @samp{+no@dots{}}: these extensions disable the specified option and
15620 any other extensions that may depend on the presence of that
15621 extension.
15623 For example, @samp{-march=armv7-a+simd+nofp+vfpv4} is equivalent to
15624 writing @samp{-march=armv7-a+vfpv4} since the @samp{+simd} option is
15625 entirely disabled by the @samp{+nofp} option that follows it.
15627 Most extension names are generically named, but have an effect that is
15628 dependent upon the architecture to which it is applied.  For example,
15629 the @samp{+simd} option can be applied to both @samp{armv7-a} and
15630 @samp{armv8-a} architectures, but will enable the original ARMv7-A
15631 Advanced SIMD (Neon) extensions for @samp{armv7-a} and the ARMv8-A
15632 variant for @samp{armv8-a}.
15634 The table below lists the supported extensions for each architecture.
15635 Architectures not mentioned do not support any extensions.
15637 @table @samp
15638 @item  armv5e
15639 @itemx armv5te
15640 @itemx armv6
15641 @itemx armv6j
15642 @itemx armv6k
15643 @itemx armv6kz
15644 @itemx armv6t2
15645 @itemx armv6z
15646 @itemx armv6zk
15647 @table @samp
15648 @item +fp
15649 The VFPv2 floating-point instructions.  The extension @samp{+vfpv2} can be
15650 used as an alias for this extension.
15652 @item +nofp
15653 Disable the floating-point instructions.
15654 @end table
15656 @item armv7
15657 The common subset of the ARMv7-A, ARMv7-R and ARMv7-M architectures.
15658 @table @samp
15659 @item +fp
15660 The VFPv3 floating-point instructions, with 16 double-precision
15661 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
15662 for this extension.  Note that floating-point is not supported by the
15663 base ARMv7-M architecture, but is compatible with both the ARMv7-A and
15664 ARMv7-R architectures.
15666 @item +nofp
15667 Disable the floating-point instructions.
15668 @end table
15670 @item armv7-a
15671 @table @samp
15672 @item +fp
15673 The VFPv3 floating-point instructions, with 16 double-precision
15674 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
15675 for this extension.
15677 @item +simd
15678 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
15679 The extensions @samp{+neon} and @samp{+neon-vfpv3} can be used as aliases
15680 for this extension.
15682 @item +vfpv3
15683 The VFPv3 floating-point instructions, with 32 double-precision
15684 registers.
15686 @item +vfpv3-d16-fp16
15687 The VFPv3 floating-point instructions, with 16 double-precision
15688 registers and the half-precision floating-point conversion operations.
15690 @item +vfpv3-fp16
15691 The VFPv3 floating-point instructions, with 32 double-precision
15692 registers and the half-precision floating-point conversion operations.
15694 @item +vfpv4-d16
15695 The VFPv4 floating-point instructions, with 16 double-precision
15696 registers.
15698 @item +vfpv4
15699 The VFPv4 floating-point instructions, with 32 double-precision
15700 registers.
15702 @item +neon-fp16
15703 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
15704 the half-precision floating-point conversion operations.
15706 @item +neon-vfpv4
15707 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.
15709 @item +nosimd
15710 Disable the Advanced SIMD instructions (does not disable floating point).
15712 @item +nofp
15713 Disable the floating-point and Advanced SIMD instructions.
15714 @end table
15716 @item armv7ve
15717 The extended version of the ARMv7-A architecture with support for
15718 virtualization.
15719 @table @samp
15720 @item +fp
15721 The VFPv4 floating-point instructions, with 16 double-precision registers.
15722 The extension @samp{+vfpv4-d16} can be used as an alias for this extension.
15724 @item +simd
15725 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.  The
15726 extension @samp{+neon-vfpv4} can be used as an alias for this extension.
15728 @item +vfpv3-d16
15729 The VFPv3 floating-point instructions, with 16 double-precision
15730 registers.
15732 @item +vfpv3
15733 The VFPv3 floating-point instructions, with 32 double-precision
15734 registers.
15736 @item +vfpv3-d16-fp16
15737 The VFPv3 floating-point instructions, with 16 double-precision
15738 registers and the half-precision floating-point conversion operations.
15740 @item +vfpv3-fp16
15741 The VFPv3 floating-point instructions, with 32 double-precision
15742 registers and the half-precision floating-point conversion operations.
15744 @item +vfpv4-d16
15745 The VFPv4 floating-point instructions, with 16 double-precision
15746 registers.
15748 @item +vfpv4
15749 The VFPv4 floating-point instructions, with 32 double-precision
15750 registers.
15752 @item +neon
15753 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
15754 The extension @samp{+neon-vfpv3} can be used as an alias for this extension.
15756 @item +neon-fp16
15757 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
15758 the half-precision floating-point conversion operations.
15760 @item +nosimd
15761 Disable the Advanced SIMD instructions (does not disable floating point).
15763 @item +nofp
15764 Disable the floating-point and Advanced SIMD instructions.
15765 @end table
15767 @item armv8-a
15768 @table @samp
15769 @item +crc
15770 The Cyclic Redundancy Check (CRC) instructions.
15771 @item +simd
15772 The ARMv8-A Advanced SIMD and floating-point instructions.
15773 @item +crypto
15774 The cryptographic instructions.
15775 @item +nocrypto
15776 Disable the cryptographic isntructions.
15777 @item +nofp
15778 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15779 @end table
15781 @item armv8.1-a
15782 @table @samp
15783 @item +simd
15784 The ARMv8.1-A Advanced SIMD and floating-point instructions.
15786 @item +crypto
15787 The cryptographic instructions.  This also enables the Advanced SIMD and
15788 floating-point instructions.
15790 @item +nocrypto
15791 Disable the cryptographic isntructions.
15793 @item +nofp
15794 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15795 @end table
15797 @item armv8.2-a
15798 @table @samp
15799 @item +fp16
15800 The half-precision floating-point data processing instructions.
15801 This also enables the Advanced SIMD and floating-point instructions.
15803 @item +simd
15804 The ARMv8.1-A Advanced SIMD and floating-point instructions.
15806 @item +crypto
15807 The cryptographic instructions.  This also enables the Advanced SIMD and
15808 floating-point instructions.
15810 @item +dotprod
15811 Enable the Dot Product extension.  This also enables Advanced SIMD instructions.
15813 @item +nocrypto
15814 Disable the cryptographic extension.
15816 @item +nofp
15817 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15818 @end table
15820 @item armv7-r
15821 @table @samp
15822 @item +fp.sp
15823 The single-precision VFPv3 floating-point instructions.  The extension
15824 @samp{+vfpv3xd} can be used as an alias for this extension.
15826 @item +fp
15827 The VFPv3 floating-point instructions with 16 double-precision registers.
15828 The extension +vfpv3-d16 can be used as an alias for this extension.
15830 @item +nofp
15831 Disable the floating-point extension.
15833 @item +idiv
15834 The ARM-state integer division instructions.
15836 @item +noidiv
15837 Disable the ARM-state integer division extension.
15838 @end table
15840 @item armv7e-m
15841 @table @samp
15842 @item +fp
15843 The single-precision VFPv4 floating-point instructions.
15845 @item +fpv5
15846 The single-precision FPv5 floating-point instructions.
15848 @item +fp.dp
15849 The single- and double-precision FPv5 floating-point instructions.
15851 @item +nofp
15852 Disable the floating-point extensions.
15853 @end table
15855 @item  armv8-m.main
15856 @table @samp
15857 @item +dsp
15858 The DSP instructions.
15860 @item +nodsp
15861 Disable the DSP extension.
15863 @item +fp
15864 The single-precision floating-point instructions.
15866 @item +fp.dp
15867 The single- and double-precision floating-point instructions.
15869 @item +nofp
15870 Disable the floating-point extension.
15871 @end table
15873 @item armv8-r
15874 @table @samp
15875 @item +crc
15876 The Cyclic Redundancy Check (CRC) instructions.
15877 @item +fp.sp
15878 The single-precision FPv5 floating-point instructions.
15879 @item +simd
15880 The ARMv8-A Advanced SIMD and floating-point instructions.
15881 @item +crypto
15882 The cryptographic instructions.
15883 @item +nocrypto
15884 Disable the cryptographic isntructions.
15885 @item +nofp
15886 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15887 @end table
15889 @end table
15891 @option{-march=native} causes the compiler to auto-detect the architecture
15892 of the build computer.  At present, this feature is only supported on
15893 GNU/Linux, and not all architectures are recognized.  If the auto-detect
15894 is unsuccessful the option has no effect.
15896 @item -mtune=@var{name}
15897 @opindex mtune
15898 This option specifies the name of the target ARM processor for
15899 which GCC should tune the performance of the code.
15900 For some ARM implementations better performance can be obtained by using
15901 this option.
15902 Permissible names are: @samp{arm2}, @samp{arm250},
15903 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
15904 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
15905 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
15906 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
15907 @samp{arm720},
15908 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
15909 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
15910 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
15911 @samp{strongarm1110},
15912 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
15913 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
15914 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
15915 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
15916 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
15917 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
15918 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
15919 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8},
15920 @samp{cortex-a9}, @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a17},
15921 @samp{cortex-a32}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
15922 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
15923 @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7},
15924 @samp{cortex-r8}, @samp{cortex-r52},
15925 @samp{cortex-m33},
15926 @samp{cortex-m23},
15927 @samp{cortex-m7},
15928 @samp{cortex-m4},
15929 @samp{cortex-m3},
15930 @samp{cortex-m1},
15931 @samp{cortex-m0},
15932 @samp{cortex-m0plus},
15933 @samp{cortex-m1.small-multiply},
15934 @samp{cortex-m0.small-multiply},
15935 @samp{cortex-m0plus.small-multiply},
15936 @samp{exynos-m1},
15937 @samp{marvell-pj4},
15938 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
15939 @samp{fa526}, @samp{fa626},
15940 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te},
15941 @samp{xgene1}.
15943 Additionally, this option can specify that GCC should tune the performance
15944 of the code for a big.LITTLE system.  Permissible names are:
15945 @samp{cortex-a15.cortex-a7}, @samp{cortex-a17.cortex-a7},
15946 @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
15947 @samp{cortex-a72.cortex-a35}, @samp{cortex-a73.cortex-a53},
15948 @samp{cortex-a75.cortex-a55}.
15950 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
15951 performance for a blend of processors within architecture @var{arch}.
15952 The aim is to generate code that run well on the current most popular
15953 processors, balancing between optimizations that benefit some CPUs in the
15954 range, and avoiding performance pitfalls of other CPUs.  The effects of
15955 this option may change in future GCC versions as CPU models come and go.
15957 @option{-mtune} permits the same extension options as @option{-mcpu}, but
15958 the extension options do not affect the tuning of the generated code.
15960 @option{-mtune=native} causes the compiler to auto-detect the CPU
15961 of the build computer.  At present, this feature is only supported on
15962 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
15963 unsuccessful the option has no effect.
15965 @item -mcpu=@var{name}@r{[}+extension@dots{}@r{]}
15966 @opindex mcpu
15967 This specifies the name of the target ARM processor.  GCC uses this name
15968 to derive the name of the target ARM architecture (as if specified
15969 by @option{-march}) and the ARM processor type for which to tune for
15970 performance (as if specified by @option{-mtune}).  Where this option
15971 is used in conjunction with @option{-march} or @option{-mtune},
15972 those options take precedence over the appropriate part of this option.
15974 Many of the supported CPUs implement optional architectural
15975 extensions.  Where this is so the architectural extensions are
15976 normally enabled by default.  If implementations that lack the
15977 extension exist, then the extension syntax can be used to disable
15978 those extensions that have been omitted.  For floating-point and
15979 Advanced SIMD (Neon) instructions, the settings of the options
15980 @option{-mfloat-abi} and @option{-mfpu} must also be considered:
15981 floating-point and Advanced SIMD instructions will only be used if
15982 @option{-mfloat-abi} is not set to @samp{soft}; and any setting of
15983 @option{-mfpu} other than @samp{auto} will override the available
15984 floating-point and SIMD extension instructions.
15986 For example, @samp{cortex-a9} can be found in three major
15987 configurations: integer only, with just a floating-point unit or with
15988 floating-point and Advanced SIMD.  The default is to enable all the
15989 instructions, but the extensions @samp{+nosimd} and @samp{+nofp} can
15990 be used to disable just the SIMD or both the SIMD and floating-point
15991 instructions respectively.
15993 Permissible names for this option are the same as those for
15994 @option{-mtune}.
15996 The following extension options are common to the listed CPUs:
15998 @table @samp
15999 @item +nodsp
16000 Disable the DSP instructions on @samp{cortex-m33}.
16002 @item  +nofp
16003 Disables the floating-point instructions on @samp{arm9e},
16004 @samp{arm946e-s}, @samp{arm966e-s}, @samp{arm968e-s}, @samp{arm10e},
16005 @samp{arm1020e}, @samp{arm1022e}, @samp{arm926ej-s},
16006 @samp{arm1026ej-s}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-r8},
16007 @samp{cortex-m4}, @samp{cortex-m7} and @samp{cortex-m33}.
16008 Disables the floating-point and SIMD instructions on
16009 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7},
16010 @samp{cortex-a8}, @samp{cortex-a9}, @samp{cortex-a12},
16011 @samp{cortex-a15}, @samp{cortex-a17}, @samp{cortex-a15.cortex-a7},
16012 @samp{cortex-a17.cortex-a7}, @samp{cortex-a32}, @samp{cortex-a35},
16013 @samp{cortex-a53} and @samp{cortex-a55}.
16015 @item +nofp.dp
16016 Disables the double-precision component of the floating-point instructions
16017 on @samp{cortex-r5}, @samp{cortex-r52} and @samp{cortex-m7}.
16019 @item +nosimd
16020 Disables the SIMD (but not floating-point) instructions on
16021 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}
16022 and @samp{cortex-a9}.
16024 @item +crypto
16025 Enables the cryptographic instructions on @samp{cortex-a32},
16026 @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55}, @samp{cortex-a57},
16027 @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75}, @samp{exynos-m1},
16028 @samp{xgene1}, @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
16029 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53} and
16030 @samp{cortex-a75.cortex-a55}.
16031 @end table
16033 Additionally the @samp{generic-armv7-a} pseudo target defaults to
16034 VFPv3 with 16 double-precision registers.  It supports the following
16035 extension options: @samp{vfpv3-d16}, @samp{vfpv3},
16036 @samp{vfpv3-d16-fp16}, @samp{vfpv3-fp16}, @samp{vfpv4-d16},
16037 @samp{vfpv4}, @samp{neon}, @samp{neon-vfpv3}, @samp{neon-fp16},
16038 @samp{neon-vfpv4}.  The meanings are the same as for the extensions to
16039 @option{-march=armv7-a}.
16041 @option{-mcpu=generic-@var{arch}} is also permissible, and is
16042 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
16043 See @option{-mtune} for more information.
16045 @option{-mcpu=native} causes the compiler to auto-detect the CPU
16046 of the build computer.  At present, this feature is only supported on
16047 GNU/Linux, and not all architectures are recognized.  If the auto-detect
16048 is unsuccessful the option has no effect.
16050 @item -mfpu=@var{name}
16051 @opindex mfpu
16052 This specifies what floating-point hardware (or hardware emulation) is
16053 available on the target.  Permissible names are: @samp{auto}, @samp{vfpv2},
16054 @samp{vfpv3},
16055 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
16056 @samp{vfpv3xd-fp16}, @samp{neon-vfpv3}, @samp{neon-fp16}, @samp{vfpv4},
16057 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
16058 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
16059 @samp{fp-armv8}, @samp{neon-fp-armv8} and @samp{crypto-neon-fp-armv8}.
16060 Note that @samp{neon} is an alias for @samp{neon-vfpv3} and @samp{vfp}
16061 is an alias for @samp{vfpv2}.
16063 The setting @samp{auto} is the default and is special.  It causes the
16064 compiler to select the floating-point and Advanced SIMD instructions
16065 based on the settings of @option{-mcpu} and @option{-march}.
16067 If the selected floating-point hardware includes the NEON extension
16068 (e.g. @option{-mfpu=neon}), note that floating-point
16069 operations are not generated by GCC's auto-vectorization pass unless
16070 @option{-funsafe-math-optimizations} is also specified.  This is
16071 because NEON hardware does not fully implement the IEEE 754 standard for
16072 floating-point arithmetic (in particular denormal values are treated as
16073 zero), so the use of NEON instructions may lead to a loss of precision.
16075 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}).
16077 @item -mfp16-format=@var{name}
16078 @opindex mfp16-format
16079 Specify the format of the @code{__fp16} half-precision floating-point type.
16080 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
16081 the default is @samp{none}, in which case the @code{__fp16} type is not
16082 defined.  @xref{Half-Precision}, for more information.
16084 @item -mstructure-size-boundary=@var{n}
16085 @opindex mstructure-size-boundary
16086 The sizes of all structures and unions are rounded up to a multiple
16087 of the number of bits set by this option.  Permissible values are 8, 32
16088 and 64.  The default value varies for different toolchains.  For the COFF
16089 targeted toolchain the default value is 8.  A value of 64 is only allowed
16090 if the underlying ABI supports it.
16092 Specifying a larger number can produce faster, more efficient code, but
16093 can also increase the size of the program.  Different values are potentially
16094 incompatible.  Code compiled with one value cannot necessarily expect to
16095 work with code or libraries compiled with another value, if they exchange
16096 information using structures or unions.
16098 This option is deprecated.
16100 @item -mabort-on-noreturn
16101 @opindex mabort-on-noreturn
16102 Generate a call to the function @code{abort} at the end of a
16103 @code{noreturn} function.  It is executed if the function tries to
16104 return.
16106 @item -mlong-calls
16107 @itemx -mno-long-calls
16108 @opindex mlong-calls
16109 @opindex mno-long-calls
16110 Tells the compiler to perform function calls by first loading the
16111 address of the function into a register and then performing a subroutine
16112 call on this register.  This switch is needed if the target function
16113 lies outside of the 64-megabyte addressing range of the offset-based
16114 version of subroutine call instruction.
16116 Even if this switch is enabled, not all function calls are turned
16117 into long calls.  The heuristic is that static functions, functions
16118 that have the @code{short_call} attribute, functions that are inside
16119 the scope of a @code{#pragma no_long_calls} directive, and functions whose
16120 definitions have already been compiled within the current compilation
16121 unit are not turned into long calls.  The exceptions to this rule are
16122 that weak function definitions, functions with the @code{long_call}
16123 attribute or the @code{section} attribute, and functions that are within
16124 the scope of a @code{#pragma long_calls} directive are always
16125 turned into long calls.
16127 This feature is not enabled by default.  Specifying
16128 @option{-mno-long-calls} restores the default behavior, as does
16129 placing the function calls within the scope of a @code{#pragma
16130 long_calls_off} directive.  Note these switches have no effect on how
16131 the compiler generates code to handle function calls via function
16132 pointers.
16134 @item -msingle-pic-base
16135 @opindex msingle-pic-base
16136 Treat the register used for PIC addressing as read-only, rather than
16137 loading it in the prologue for each function.  The runtime system is
16138 responsible for initializing this register with an appropriate value
16139 before execution begins.
16141 @item -mpic-register=@var{reg}
16142 @opindex mpic-register
16143 Specify the register to be used for PIC addressing.
16144 For standard PIC base case, the default is any suitable register
16145 determined by compiler.  For single PIC base case, the default is
16146 @samp{R9} if target is EABI based or stack-checking is enabled,
16147 otherwise the default is @samp{R10}.
16149 @item -mpic-data-is-text-relative
16150 @opindex mpic-data-is-text-relative
16151 Assume that the displacement between the text and data segments is fixed
16152 at static link time.  This permits using PC-relative addressing
16153 operations to access data known to be in the data segment.  For
16154 non-VxWorks RTP targets, this option is enabled by default.  When
16155 disabled on such targets, it will enable @option{-msingle-pic-base} by
16156 default.
16158 @item -mpoke-function-name
16159 @opindex mpoke-function-name
16160 Write the name of each function into the text section, directly
16161 preceding the function prologue.  The generated code is similar to this:
16163 @smallexample
16164      t0
16165          .ascii "arm_poke_function_name", 0
16166          .align
16167      t1
16168          .word 0xff000000 + (t1 - t0)
16169      arm_poke_function_name
16170          mov     ip, sp
16171          stmfd   sp!, @{fp, ip, lr, pc@}
16172          sub     fp, ip, #4
16173 @end smallexample
16175 When performing a stack backtrace, code can inspect the value of
16176 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
16177 location @code{pc - 12} and the top 8 bits are set, then we know that
16178 there is a function name embedded immediately preceding this location
16179 and has length @code{((pc[-3]) & 0xff000000)}.
16181 @item -mthumb
16182 @itemx -marm
16183 @opindex marm
16184 @opindex mthumb
16186 Select between generating code that executes in ARM and Thumb
16187 states.  The default for most configurations is to generate code
16188 that executes in ARM state, but the default can be changed by
16189 configuring GCC with the @option{--with-mode=}@var{state}
16190 configure option.
16192 You can also override the ARM and Thumb mode for each function
16193 by using the @code{target("thumb")} and @code{target("arm")} function attributes
16194 (@pxref{ARM Function Attributes}) or pragmas (@pxref{Function Specific Option Pragmas}).
16196 @item -mtpcs-frame
16197 @opindex mtpcs-frame
16198 Generate a stack frame that is compliant with the Thumb Procedure Call
16199 Standard for all non-leaf functions.  (A leaf function is one that does
16200 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
16202 @item -mtpcs-leaf-frame
16203 @opindex mtpcs-leaf-frame
16204 Generate a stack frame that is compliant with the Thumb Procedure Call
16205 Standard for all leaf functions.  (A leaf function is one that does
16206 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
16208 @item -mcallee-super-interworking
16209 @opindex mcallee-super-interworking
16210 Gives all externally visible functions in the file being compiled an ARM
16211 instruction set header which switches to Thumb mode before executing the
16212 rest of the function.  This allows these functions to be called from
16213 non-interworking code.  This option is not valid in AAPCS configurations
16214 because interworking is enabled by default.
16216 @item -mcaller-super-interworking
16217 @opindex mcaller-super-interworking
16218 Allows calls via function pointers (including virtual functions) to
16219 execute correctly regardless of whether the target code has been
16220 compiled for interworking or not.  There is a small overhead in the cost
16221 of executing a function pointer if this option is enabled.  This option
16222 is not valid in AAPCS configurations because interworking is enabled
16223 by default.
16225 @item -mtp=@var{name}
16226 @opindex mtp
16227 Specify the access model for the thread local storage pointer.  The valid
16228 models are @samp{soft}, which generates calls to @code{__aeabi_read_tp},
16229 @samp{cp15}, which fetches the thread pointer from @code{cp15} directly
16230 (supported in the arm6k architecture), and @samp{auto}, which uses the
16231 best available method for the selected processor.  The default setting is
16232 @samp{auto}.
16234 @item -mtls-dialect=@var{dialect}
16235 @opindex mtls-dialect
16236 Specify the dialect to use for accessing thread local storage.  Two
16237 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
16238 @samp{gnu} dialect selects the original GNU scheme for supporting
16239 local and global dynamic TLS models.  The @samp{gnu2} dialect
16240 selects the GNU descriptor scheme, which provides better performance
16241 for shared libraries.  The GNU descriptor scheme is compatible with
16242 the original scheme, but does require new assembler, linker and
16243 library support.  Initial and local exec TLS models are unaffected by
16244 this option and always use the original scheme.
16246 @item -mword-relocations
16247 @opindex mword-relocations
16248 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
16249 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
16250 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
16251 is specified.
16253 @item -mfix-cortex-m3-ldrd
16254 @opindex mfix-cortex-m3-ldrd
16255 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
16256 with overlapping destination and base registers are used.  This option avoids
16257 generating these instructions.  This option is enabled by default when
16258 @option{-mcpu=cortex-m3} is specified.
16260 @item -munaligned-access
16261 @itemx -mno-unaligned-access
16262 @opindex munaligned-access
16263 @opindex mno-unaligned-access
16264 Enables (or disables) reading and writing of 16- and 32- bit values
16265 from addresses that are not 16- or 32- bit aligned.  By default
16266 unaligned access is disabled for all pre-ARMv6, all ARMv6-M and for
16267 ARMv8-M Baseline architectures, and enabled for all other
16268 architectures.  If unaligned access is not enabled then words in packed
16269 data structures are accessed a byte at a time.
16271 The ARM attribute @code{Tag_CPU_unaligned_access} is set in the
16272 generated object file to either true or false, depending upon the
16273 setting of this option.  If unaligned access is enabled then the
16274 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} is also
16275 defined.
16277 @item -mneon-for-64bits
16278 @opindex mneon-for-64bits
16279 Enables using Neon to handle scalar 64-bits operations. This is
16280 disabled by default since the cost of moving data from core registers
16281 to Neon is high.
16283 @item -mslow-flash-data
16284 @opindex mslow-flash-data
16285 Assume loading data from flash is slower than fetching instruction.
16286 Therefore literal load is minimized for better performance.
16287 This option is only supported when compiling for ARMv7 M-profile and
16288 off by default.
16290 @item -masm-syntax-unified
16291 @opindex masm-syntax-unified
16292 Assume inline assembler is using unified asm syntax.  The default is
16293 currently off which implies divided syntax.  This option has no impact
16294 on Thumb2. However, this may change in future releases of GCC.
16295 Divided syntax should be considered deprecated.
16297 @item -mrestrict-it
16298 @opindex mrestrict-it
16299 Restricts generation of IT blocks to conform to the rules of ARMv8-A.
16300 IT blocks can only contain a single 16-bit instruction from a select
16301 set of instructions. This option is on by default for ARMv8-A Thumb mode.
16303 @item -mprint-tune-info
16304 @opindex mprint-tune-info
16305 Print CPU tuning information as comment in assembler file.  This is
16306 an option used only for regression testing of the compiler and not
16307 intended for ordinary use in compiling code.  This option is disabled
16308 by default.
16310 @item -mpure-code
16311 @opindex mpure-code
16312 Do not allow constant data to be placed in code sections.
16313 Additionally, when compiling for ELF object format give all text sections the
16314 ELF processor-specific section attribute @code{SHF_ARM_PURECODE}.  This option
16315 is only available when generating non-pic code for M-profile targets with the
16316 MOVT instruction.
16318 @item -mcmse
16319 @opindex mcmse
16320 Generate secure code as per the "ARMv8-M Security Extensions: Requirements on
16321 Development Tools Engineering Specification", which can be found on
16322 @url{http://infocenter.arm.com/help/topic/com.arm.doc.ecm0359818/ECM0359818_armv8m_security_extensions_reqs_on_dev_tools_1_0.pdf}.
16323 @end table
16325 @node AVR Options
16326 @subsection AVR Options
16327 @cindex AVR Options
16329 These options are defined for AVR implementations:
16331 @table @gcctabopt
16332 @item -mmcu=@var{mcu}
16333 @opindex mmcu
16334 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
16336 The default for this option is@tie{}@samp{avr2}.
16338 GCC supports the following AVR devices and ISAs:
16340 @include avr-mmcu.texi
16342 @item -mabsdata
16343 @opindex mabsdata
16345 Assume that all data in static storage can be accessed by LDS / STS
16346 instructions.  This option has only an effect on reduced Tiny devices like
16347 ATtiny40.  See also the @code{absdata}
16348 @ref{AVR Variable Attributes,variable attribute}.
16350 @item -maccumulate-args
16351 @opindex maccumulate-args
16352 Accumulate outgoing function arguments and acquire/release the needed
16353 stack space for outgoing function arguments once in function
16354 prologue/epilogue.  Without this option, outgoing arguments are pushed
16355 before calling a function and popped afterwards.
16357 Popping the arguments after the function call can be expensive on
16358 AVR so that accumulating the stack space might lead to smaller
16359 executables because arguments need not be removed from the
16360 stack after such a function call.
16362 This option can lead to reduced code size for functions that perform
16363 several calls to functions that get their arguments on the stack like
16364 calls to printf-like functions.
16366 @item -mbranch-cost=@var{cost}
16367 @opindex mbranch-cost
16368 Set the branch costs for conditional branch instructions to
16369 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
16370 integers. The default branch cost is 0.
16372 @item -mcall-prologues
16373 @opindex mcall-prologues
16374 Functions prologues/epilogues are expanded as calls to appropriate
16375 subroutines.  Code size is smaller.
16377 @item -mgas-isr-prologues
16378 @opindex mgas-isr-prologues
16379 Interrupt service routines (ISRs) may use the @code{__gcc_isr} pseudo
16380 instruction supported by GNU Binutils.
16381 If this option is on, the feature can still be disabled for individual
16382 ISRs by means of the @ref{AVR Function Attributes,,@code{no_gccisr}}
16383 function attribute.  This feature is activated per default
16384 if optimization is on (but not with @option{-Og}, @pxref{Optimize Options}),
16385 and if GNU Binutils support @w{@uref{https://sourceware.org/PR21683,PR21683}}.
16387 @item -mint8
16388 @opindex mint8
16389 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
16390 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
16391 and @code{long long} is 4 bytes.  Please note that this option does not
16392 conform to the C standards, but it results in smaller code
16393 size.
16395 @item -mn-flash=@var{num}
16396 @opindex mn-flash
16397 Assume that the flash memory has a size of 
16398 @var{num} times 64@tie{}KiB.
16400 @item -mno-interrupts
16401 @opindex mno-interrupts
16402 Generated code is not compatible with hardware interrupts.
16403 Code size is smaller.
16405 @item -mrelax
16406 @opindex mrelax
16407 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
16408 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
16409 Setting @option{-mrelax} just adds the @option{--mlink-relax} option to
16410 the assembler's command line and the @option{--relax} option to the
16411 linker's command line.
16413 Jump relaxing is performed by the linker because jump offsets are not
16414 known before code is located. Therefore, the assembler code generated by the
16415 compiler is the same, but the instructions in the executable may
16416 differ from instructions in the assembler code.
16418 Relaxing must be turned on if linker stubs are needed, see the
16419 section on @code{EIND} and linker stubs below.
16421 @item -mrmw
16422 @opindex mrmw
16423 Assume that the device supports the Read-Modify-Write
16424 instructions @code{XCH}, @code{LAC}, @code{LAS} and @code{LAT}.
16426 @item -mshort-calls
16427 @opindex mshort-calls
16429 Assume that @code{RJMP} and @code{RCALL} can target the whole
16430 program memory.
16432 This option is used internally for multilib selection.  It is
16433 not an optimization option, and you don't need to set it by hand.
16435 @item -msp8
16436 @opindex msp8
16437 Treat the stack pointer register as an 8-bit register,
16438 i.e.@: assume the high byte of the stack pointer is zero.
16439 In general, you don't need to set this option by hand.
16441 This option is used internally by the compiler to select and
16442 build multilibs for architectures @code{avr2} and @code{avr25}.
16443 These architectures mix devices with and without @code{SPH}.
16444 For any setting other than @option{-mmcu=avr2} or @option{-mmcu=avr25}
16445 the compiler driver adds or removes this option from the compiler
16446 proper's command line, because the compiler then knows if the device
16447 or architecture has an 8-bit stack pointer and thus no @code{SPH}
16448 register or not.
16450 @item -mstrict-X
16451 @opindex mstrict-X
16452 Use address register @code{X} in a way proposed by the hardware.  This means
16453 that @code{X} is only used in indirect, post-increment or
16454 pre-decrement addressing.
16456 Without this option, the @code{X} register may be used in the same way
16457 as @code{Y} or @code{Z} which then is emulated by additional
16458 instructions.  
16459 For example, loading a value with @code{X+const} addressing with a
16460 small non-negative @code{const < 64} to a register @var{Rn} is
16461 performed as
16463 @example
16464 adiw r26, const   ; X += const
16465 ld   @var{Rn}, X        ; @var{Rn} = *X
16466 sbiw r26, const   ; X -= const
16467 @end example
16469 @item -mtiny-stack
16470 @opindex mtiny-stack
16471 Only change the lower 8@tie{}bits of the stack pointer.
16473 @item -mfract-convert-truncate
16474 @opindex mfract-convert-truncate
16475 Allow to use truncation instead of rounding towards zero for fractional fixed-point types.
16477 @item -nodevicelib
16478 @opindex nodevicelib
16479 Don't link against AVR-LibC's device specific library @code{lib<mcu>.a}.
16481 @item -Waddr-space-convert
16482 @opindex Waddr-space-convert
16483 Warn about conversions between address spaces in the case where the
16484 resulting address space is not contained in the incoming address space.
16486 @item -Wmisspelled-isr
16487 @opindex Wmisspelled-isr
16488 Warn if the ISR is misspelled, i.e. without __vector prefix.
16489 Enabled by default.
16490 @end table
16492 @subsubsection @code{EIND} and Devices with More Than 128 Ki Bytes of Flash
16493 @cindex @code{EIND}
16494 Pointers in the implementation are 16@tie{}bits wide.
16495 The address of a function or label is represented as word address so
16496 that indirect jumps and calls can target any code address in the
16497 range of 64@tie{}Ki words.
16499 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
16500 bytes of program memory space, there is a special function register called
16501 @code{EIND} that serves as most significant part of the target address
16502 when @code{EICALL} or @code{EIJMP} instructions are used.
16504 Indirect jumps and calls on these devices are handled as follows by
16505 the compiler and are subject to some limitations:
16507 @itemize @bullet
16509 @item
16510 The compiler never sets @code{EIND}.
16512 @item
16513 The compiler uses @code{EIND} implicitly in @code{EICALL}/@code{EIJMP}
16514 instructions or might read @code{EIND} directly in order to emulate an
16515 indirect call/jump by means of a @code{RET} instruction.
16517 @item
16518 The compiler assumes that @code{EIND} never changes during the startup
16519 code or during the application. In particular, @code{EIND} is not
16520 saved/restored in function or interrupt service routine
16521 prologue/epilogue.
16523 @item
16524 For indirect calls to functions and computed goto, the linker
16525 generates @emph{stubs}. Stubs are jump pads sometimes also called
16526 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
16527 The stub contains a direct jump to the desired address.
16529 @item
16530 Linker relaxation must be turned on so that the linker generates
16531 the stubs correctly in all situations. See the compiler option
16532 @option{-mrelax} and the linker option @option{--relax}.
16533 There are corner cases where the linker is supposed to generate stubs
16534 but aborts without relaxation and without a helpful error message.
16536 @item
16537 The default linker script is arranged for code with @code{EIND = 0}.
16538 If code is supposed to work for a setup with @code{EIND != 0}, a custom
16539 linker script has to be used in order to place the sections whose
16540 name start with @code{.trampolines} into the segment where @code{EIND}
16541 points to.
16543 @item
16544 The startup code from libgcc never sets @code{EIND}.
16545 Notice that startup code is a blend of code from libgcc and AVR-LibC.
16546 For the impact of AVR-LibC on @code{EIND}, see the
16547 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
16549 @item
16550 It is legitimate for user-specific startup code to set up @code{EIND}
16551 early, for example by means of initialization code located in
16552 section @code{.init3}. Such code runs prior to general startup code
16553 that initializes RAM and calls constructors, but after the bit
16554 of startup code from AVR-LibC that sets @code{EIND} to the segment
16555 where the vector table is located.
16556 @example
16557 #include <avr/io.h>
16559 static void
16560 __attribute__((section(".init3"),naked,used,no_instrument_function))
16561 init3_set_eind (void)
16563   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
16564                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
16566 @end example
16568 @noindent
16569 The @code{__trampolines_start} symbol is defined in the linker script.
16571 @item
16572 Stubs are generated automatically by the linker if
16573 the following two conditions are met:
16574 @itemize @minus
16576 @item The address of a label is taken by means of the @code{gs} modifier
16577 (short for @emph{generate stubs}) like so:
16578 @example
16579 LDI r24, lo8(gs(@var{func}))
16580 LDI r25, hi8(gs(@var{func}))
16581 @end example
16582 @item The final location of that label is in a code segment
16583 @emph{outside} the segment where the stubs are located.
16584 @end itemize
16586 @item
16587 The compiler emits such @code{gs} modifiers for code labels in the
16588 following situations:
16589 @itemize @minus
16590 @item Taking address of a function or code label.
16591 @item Computed goto.
16592 @item If prologue-save function is used, see @option{-mcall-prologues}
16593 command-line option.
16594 @item Switch/case dispatch tables. If you do not want such dispatch
16595 tables you can specify the @option{-fno-jump-tables} command-line option.
16596 @item C and C++ constructors/destructors called during startup/shutdown.
16597 @item If the tools hit a @code{gs()} modifier explained above.
16598 @end itemize
16600 @item
16601 Jumping to non-symbolic addresses like so is @emph{not} supported:
16603 @example
16604 int main (void)
16606     /* Call function at word address 0x2 */
16607     return ((int(*)(void)) 0x2)();
16609 @end example
16611 Instead, a stub has to be set up, i.e.@: the function has to be called
16612 through a symbol (@code{func_4} in the example):
16614 @example
16615 int main (void)
16617     extern int func_4 (void);
16619     /* Call function at byte address 0x4 */
16620     return func_4();
16622 @end example
16624 and the application be linked with @option{-Wl,--defsym,func_4=0x4}.
16625 Alternatively, @code{func_4} can be defined in the linker script.
16626 @end itemize
16628 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
16629 @cindex @code{RAMPD}
16630 @cindex @code{RAMPX}
16631 @cindex @code{RAMPY}
16632 @cindex @code{RAMPZ}
16633 Some AVR devices support memories larger than the 64@tie{}KiB range
16634 that can be accessed with 16-bit pointers.  To access memory locations
16635 outside this 64@tie{}KiB range, the content of a @code{RAMP}
16636 register is used as high part of the address:
16637 The @code{X}, @code{Y}, @code{Z} address register is concatenated
16638 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
16639 register, respectively, to get a wide address. Similarly,
16640 @code{RAMPD} is used together with direct addressing.
16642 @itemize
16643 @item
16644 The startup code initializes the @code{RAMP} special function
16645 registers with zero.
16647 @item
16648 If a @ref{AVR Named Address Spaces,named address space} other than
16649 generic or @code{__flash} is used, then @code{RAMPZ} is set
16650 as needed before the operation.
16652 @item
16653 If the device supports RAM larger than 64@tie{}KiB and the compiler
16654 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
16655 is reset to zero after the operation.
16657 @item
16658 If the device comes with a specific @code{RAMP} register, the ISR
16659 prologue/epilogue saves/restores that SFR and initializes it with
16660 zero in case the ISR code might (implicitly) use it.
16662 @item
16663 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
16664 If you use inline assembler to read from locations outside the
16665 16-bit address range and change one of the @code{RAMP} registers,
16666 you must reset it to zero after the access.
16668 @end itemize
16670 @subsubsection AVR Built-in Macros
16672 GCC defines several built-in macros so that the user code can test
16673 for the presence or absence of features.  Almost any of the following
16674 built-in macros are deduced from device capabilities and thus
16675 triggered by the @option{-mmcu=} command-line option.
16677 For even more AVR-specific built-in macros see
16678 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
16680 @table @code
16682 @item __AVR_ARCH__
16683 Build-in macro that resolves to a decimal number that identifies the
16684 architecture and depends on the @option{-mmcu=@var{mcu}} option.
16685 Possible values are:
16687 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
16688 @code{4}, @code{5}, @code{51}, @code{6}
16690 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3}, @code{avr31},
16691 @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51}, @code{avr6},
16693 respectively and
16695 @code{100},
16696 @code{102}, @code{103}, @code{104},
16697 @code{105}, @code{106}, @code{107}
16699 for @var{mcu}=@code{avrtiny},
16700 @code{avrxmega2}, @code{avrxmega3}, @code{avrxmega4},
16701 @code{avrxmega5}, @code{avrxmega6}, @code{avrxmega7}, respectively.
16702 If @var{mcu} specifies a device, this built-in macro is set
16703 accordingly. For example, with @option{-mmcu=atmega8} the macro is
16704 defined to @code{4}.
16706 @item __AVR_@var{Device}__
16707 Setting @option{-mmcu=@var{device}} defines this built-in macro which reflects
16708 the device's name. For example, @option{-mmcu=atmega8} defines the
16709 built-in macro @code{__AVR_ATmega8__}, @option{-mmcu=attiny261a} defines
16710 @code{__AVR_ATtiny261A__}, etc.
16712 The built-in macros' names follow
16713 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
16714 the device name as from the AVR user manual. The difference between
16715 @var{Device} in the built-in macro and @var{device} in
16716 @option{-mmcu=@var{device}} is that the latter is always lowercase.
16718 If @var{device} is not a device but only a core architecture like
16719 @samp{avr51}, this macro is not defined.
16721 @item __AVR_DEVICE_NAME__
16722 Setting @option{-mmcu=@var{device}} defines this built-in macro to
16723 the device's name. For example, with @option{-mmcu=atmega8} the macro
16724 is defined to @code{atmega8}.
16726 If @var{device} is not a device but only a core architecture like
16727 @samp{avr51}, this macro is not defined.
16729 @item __AVR_XMEGA__
16730 The device / architecture belongs to the XMEGA family of devices.
16732 @item __AVR_HAVE_ELPM__
16733 The device has the @code{ELPM} instruction.
16735 @item __AVR_HAVE_ELPMX__
16736 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
16737 R@var{n},Z+} instructions.
16739 @item __AVR_HAVE_MOVW__
16740 The device has the @code{MOVW} instruction to perform 16-bit
16741 register-register moves.
16743 @item __AVR_HAVE_LPMX__
16744 The device has the @code{LPM R@var{n},Z} and
16745 @code{LPM R@var{n},Z+} instructions.
16747 @item __AVR_HAVE_MUL__
16748 The device has a hardware multiplier. 
16750 @item __AVR_HAVE_JMP_CALL__
16751 The device has the @code{JMP} and @code{CALL} instructions.
16752 This is the case for devices with more than 8@tie{}KiB of program
16753 memory.
16755 @item __AVR_HAVE_EIJMP_EICALL__
16756 @itemx __AVR_3_BYTE_PC__
16757 The device has the @code{EIJMP} and @code{EICALL} instructions.
16758 This is the case for devices with more than 128@tie{}KiB of program memory.
16759 This also means that the program counter
16760 (PC) is 3@tie{}bytes wide.
16762 @item __AVR_2_BYTE_PC__
16763 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
16764 with up to 128@tie{}KiB of program memory.
16766 @item __AVR_HAVE_8BIT_SP__
16767 @itemx __AVR_HAVE_16BIT_SP__
16768 The stack pointer (SP) register is treated as 8-bit respectively
16769 16-bit register by the compiler.
16770 The definition of these macros is affected by @option{-mtiny-stack}.
16772 @item __AVR_HAVE_SPH__
16773 @itemx __AVR_SP8__
16774 The device has the SPH (high part of stack pointer) special function
16775 register or has an 8-bit stack pointer, respectively.
16776 The definition of these macros is affected by @option{-mmcu=} and
16777 in the cases of @option{-mmcu=avr2} and @option{-mmcu=avr25} also
16778 by @option{-msp8}.
16780 @item __AVR_HAVE_RAMPD__
16781 @itemx __AVR_HAVE_RAMPX__
16782 @itemx __AVR_HAVE_RAMPY__
16783 @itemx __AVR_HAVE_RAMPZ__
16784 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
16785 @code{RAMPZ} special function register, respectively.
16787 @item __NO_INTERRUPTS__
16788 This macro reflects the @option{-mno-interrupts} command-line option.
16790 @item __AVR_ERRATA_SKIP__
16791 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
16792 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
16793 instructions because of a hardware erratum.  Skip instructions are
16794 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
16795 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
16796 set.
16798 @item __AVR_ISA_RMW__
16799 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
16801 @item __AVR_SFR_OFFSET__=@var{offset}
16802 Instructions that can address I/O special function registers directly
16803 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
16804 address as if addressed by an instruction to access RAM like @code{LD}
16805 or @code{STS}. This offset depends on the device architecture and has
16806 to be subtracted from the RAM address in order to get the
16807 respective I/O@tie{}address.
16809 @item __AVR_SHORT_CALLS__
16810 The @option{-mshort-calls} command line option is set.
16812 @item __AVR_PM_BASE_ADDRESS__=@var{addr}
16813 Some devices support reading from flash memory by means of @code{LD*}
16814 instructions.  The flash memory is seen in the data address space
16815 at an offset of @code{__AVR_PM_BASE_ADDRESS__}.  If this macro
16816 is not defined, this feature is not available.  If defined,
16817 the address space is linear and there is no need to put
16818 @code{.rodata} into RAM.  This is handled by the default linker
16819 description file, and is currently available for
16820 @code{avrtiny} and @code{avrxmega3}.  Even more convenient,
16821 there is no need to use address spaces like @code{__flash} or
16822 features like attribute @code{progmem} and @code{pgm_read_*}.
16824 @item __WITH_AVRLIBC__
16825 The compiler is configured to be used together with AVR-Libc.
16826 See the @option{--with-avrlibc} configure option.
16828 @end table
16830 @node Blackfin Options
16831 @subsection Blackfin Options
16832 @cindex Blackfin Options
16834 @table @gcctabopt
16835 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
16836 @opindex mcpu=
16837 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
16838 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
16839 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
16840 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
16841 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
16842 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
16843 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
16844 @samp{bf561}, @samp{bf592}.
16846 The optional @var{sirevision} specifies the silicon revision of the target
16847 Blackfin processor.  Any workarounds available for the targeted silicon revision
16848 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
16849 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
16850 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
16851 hexadecimal digits representing the major and minor numbers in the silicon
16852 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
16853 is not defined.  If @var{sirevision} is @samp{any}, the
16854 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
16855 If this optional @var{sirevision} is not used, GCC assumes the latest known
16856 silicon revision of the targeted Blackfin processor.
16858 GCC defines a preprocessor macro for the specified @var{cpu}.
16859 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
16860 provided by libgloss to be linked in if @option{-msim} is not given.
16862 Without this option, @samp{bf532} is used as the processor by default.
16864 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
16865 only the preprocessor macro is defined.
16867 @item -msim
16868 @opindex msim
16869 Specifies that the program will be run on the simulator.  This causes
16870 the simulator BSP provided by libgloss to be linked in.  This option
16871 has effect only for @samp{bfin-elf} toolchain.
16872 Certain other options, such as @option{-mid-shared-library} and
16873 @option{-mfdpic}, imply @option{-msim}.
16875 @item -momit-leaf-frame-pointer
16876 @opindex momit-leaf-frame-pointer
16877 Don't keep the frame pointer in a register for leaf functions.  This
16878 avoids the instructions to save, set up and restore frame pointers and
16879 makes an extra register available in leaf functions.
16881 @item -mspecld-anomaly
16882 @opindex mspecld-anomaly
16883 When enabled, the compiler ensures that the generated code does not
16884 contain speculative loads after jump instructions. If this option is used,
16885 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
16887 @item -mno-specld-anomaly
16888 @opindex mno-specld-anomaly
16889 Don't generate extra code to prevent speculative loads from occurring.
16891 @item -mcsync-anomaly
16892 @opindex mcsync-anomaly
16893 When enabled, the compiler ensures that the generated code does not
16894 contain CSYNC or SSYNC instructions too soon after conditional branches.
16895 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
16897 @item -mno-csync-anomaly
16898 @opindex mno-csync-anomaly
16899 Don't generate extra code to prevent CSYNC or SSYNC instructions from
16900 occurring too soon after a conditional branch.
16902 @item -mlow-64k
16903 @opindex mlow-64k
16904 When enabled, the compiler is free to take advantage of the knowledge that
16905 the entire program fits into the low 64k of memory.
16907 @item -mno-low-64k
16908 @opindex mno-low-64k
16909 Assume that the program is arbitrarily large.  This is the default.
16911 @item -mstack-check-l1
16912 @opindex mstack-check-l1
16913 Do stack checking using information placed into L1 scratchpad memory by the
16914 uClinux kernel.
16916 @item -mid-shared-library
16917 @opindex mid-shared-library
16918 Generate code that supports shared libraries via the library ID method.
16919 This allows for execute in place and shared libraries in an environment
16920 without virtual memory management.  This option implies @option{-fPIC}.
16921 With a @samp{bfin-elf} target, this option implies @option{-msim}.
16923 @item -mno-id-shared-library
16924 @opindex mno-id-shared-library
16925 Generate code that doesn't assume ID-based shared libraries are being used.
16926 This is the default.
16928 @item -mleaf-id-shared-library
16929 @opindex mleaf-id-shared-library
16930 Generate code that supports shared libraries via the library ID method,
16931 but assumes that this library or executable won't link against any other
16932 ID shared libraries.  That allows the compiler to use faster code for jumps
16933 and calls.
16935 @item -mno-leaf-id-shared-library
16936 @opindex mno-leaf-id-shared-library
16937 Do not assume that the code being compiled won't link against any ID shared
16938 libraries.  Slower code is generated for jump and call insns.
16940 @item -mshared-library-id=n
16941 @opindex mshared-library-id
16942 Specifies the identification number of the ID-based shared library being
16943 compiled.  Specifying a value of 0 generates more compact code; specifying
16944 other values forces the allocation of that number to the current
16945 library but is no more space- or time-efficient than omitting this option.
16947 @item -msep-data
16948 @opindex msep-data
16949 Generate code that allows the data segment to be located in a different
16950 area of memory from the text segment.  This allows for execute in place in
16951 an environment without virtual memory management by eliminating relocations
16952 against the text section.
16954 @item -mno-sep-data
16955 @opindex mno-sep-data
16956 Generate code that assumes that the data segment follows the text segment.
16957 This is the default.
16959 @item -mlong-calls
16960 @itemx -mno-long-calls
16961 @opindex mlong-calls
16962 @opindex mno-long-calls
16963 Tells the compiler to perform function calls by first loading the
16964 address of the function into a register and then performing a subroutine
16965 call on this register.  This switch is needed if the target function
16966 lies outside of the 24-bit addressing range of the offset-based
16967 version of subroutine call instruction.
16969 This feature is not enabled by default.  Specifying
16970 @option{-mno-long-calls} restores the default behavior.  Note these
16971 switches have no effect on how the compiler generates code to handle
16972 function calls via function pointers.
16974 @item -mfast-fp
16975 @opindex mfast-fp
16976 Link with the fast floating-point library. This library relaxes some of
16977 the IEEE floating-point standard's rules for checking inputs against
16978 Not-a-Number (NAN), in the interest of performance.
16980 @item -minline-plt
16981 @opindex minline-plt
16982 Enable inlining of PLT entries in function calls to functions that are
16983 not known to bind locally.  It has no effect without @option{-mfdpic}.
16985 @item -mmulticore
16986 @opindex mmulticore
16987 Build a standalone application for multicore Blackfin processors. 
16988 This option causes proper start files and link scripts supporting 
16989 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
16990 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
16992 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
16993 selects the one-application-per-core programming model.  Without
16994 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
16995 programming model is used. In this model, the main function of Core B
16996 should be named as @code{coreb_main}.
16998 If this option is not used, the single-core application programming
16999 model is used.
17001 @item -mcorea
17002 @opindex mcorea
17003 Build a standalone application for Core A of BF561 when using
17004 the one-application-per-core programming model. Proper start files
17005 and link scripts are used to support Core A, and the macro
17006 @code{__BFIN_COREA} is defined.
17007 This option can only be used in conjunction with @option{-mmulticore}.
17009 @item -mcoreb
17010 @opindex mcoreb
17011 Build a standalone application for Core B of BF561 when using
17012 the one-application-per-core programming model. Proper start files
17013 and link scripts are used to support Core B, and the macro
17014 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
17015 should be used instead of @code{main}. 
17016 This option can only be used in conjunction with @option{-mmulticore}.
17018 @item -msdram
17019 @opindex msdram
17020 Build a standalone application for SDRAM. Proper start files and
17021 link scripts are used to put the application into SDRAM, and the macro
17022 @code{__BFIN_SDRAM} is defined.
17023 The loader should initialize SDRAM before loading the application.
17025 @item -micplb
17026 @opindex micplb
17027 Assume that ICPLBs are enabled at run time.  This has an effect on certain
17028 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
17029 are enabled; for standalone applications the default is off.
17030 @end table
17032 @node C6X Options
17033 @subsection C6X Options
17034 @cindex C6X Options
17036 @table @gcctabopt
17037 @item -march=@var{name}
17038 @opindex march
17039 This specifies the name of the target architecture.  GCC uses this
17040 name to determine what kind of instructions it can emit when generating
17041 assembly code.  Permissible names are: @samp{c62x},
17042 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
17044 @item -mbig-endian
17045 @opindex mbig-endian
17046 Generate code for a big-endian target.
17048 @item -mlittle-endian
17049 @opindex mlittle-endian
17050 Generate code for a little-endian target.  This is the default.
17052 @item -msim
17053 @opindex msim
17054 Choose startup files and linker script suitable for the simulator.
17056 @item -msdata=default
17057 @opindex msdata=default
17058 Put small global and static data in the @code{.neardata} section,
17059 which is pointed to by register @code{B14}.  Put small uninitialized
17060 global and static data in the @code{.bss} section, which is adjacent
17061 to the @code{.neardata} section.  Put small read-only data into the
17062 @code{.rodata} section.  The corresponding sections used for large
17063 pieces of data are @code{.fardata}, @code{.far} and @code{.const}.
17065 @item -msdata=all
17066 @opindex msdata=all
17067 Put all data, not just small objects, into the sections reserved for
17068 small data, and use addressing relative to the @code{B14} register to
17069 access them.
17071 @item -msdata=none
17072 @opindex msdata=none
17073 Make no use of the sections reserved for small data, and use absolute
17074 addresses to access all data.  Put all initialized global and static
17075 data in the @code{.fardata} section, and all uninitialized data in the
17076 @code{.far} section.  Put all constant data into the @code{.const}
17077 section.
17078 @end table
17080 @node CRIS Options
17081 @subsection CRIS Options
17082 @cindex CRIS Options
17084 These options are defined specifically for the CRIS ports.
17086 @table @gcctabopt
17087 @item -march=@var{architecture-type}
17088 @itemx -mcpu=@var{architecture-type}
17089 @opindex march
17090 @opindex mcpu
17091 Generate code for the specified architecture.  The choices for
17092 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
17093 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
17094 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
17095 @samp{v10}.
17097 @item -mtune=@var{architecture-type}
17098 @opindex mtune
17099 Tune to @var{architecture-type} everything applicable about the generated
17100 code, except for the ABI and the set of available instructions.  The
17101 choices for @var{architecture-type} are the same as for
17102 @option{-march=@var{architecture-type}}.
17104 @item -mmax-stack-frame=@var{n}
17105 @opindex mmax-stack-frame
17106 Warn when the stack frame of a function exceeds @var{n} bytes.
17108 @item -metrax4
17109 @itemx -metrax100
17110 @opindex metrax4
17111 @opindex metrax100
17112 The options @option{-metrax4} and @option{-metrax100} are synonyms for
17113 @option{-march=v3} and @option{-march=v8} respectively.
17115 @item -mmul-bug-workaround
17116 @itemx -mno-mul-bug-workaround
17117 @opindex mmul-bug-workaround
17118 @opindex mno-mul-bug-workaround
17119 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
17120 models where it applies.  This option is active by default.
17122 @item -mpdebug
17123 @opindex mpdebug
17124 Enable CRIS-specific verbose debug-related information in the assembly
17125 code.  This option also has the effect of turning off the @samp{#NO_APP}
17126 formatted-code indicator to the assembler at the beginning of the
17127 assembly file.
17129 @item -mcc-init
17130 @opindex mcc-init
17131 Do not use condition-code results from previous instruction; always emit
17132 compare and test instructions before use of condition codes.
17134 @item -mno-side-effects
17135 @opindex mno-side-effects
17136 Do not emit instructions with side effects in addressing modes other than
17137 post-increment.
17139 @item -mstack-align
17140 @itemx -mno-stack-align
17141 @itemx -mdata-align
17142 @itemx -mno-data-align
17143 @itemx -mconst-align
17144 @itemx -mno-const-align
17145 @opindex mstack-align
17146 @opindex mno-stack-align
17147 @opindex mdata-align
17148 @opindex mno-data-align
17149 @opindex mconst-align
17150 @opindex mno-const-align
17151 These options (@samp{no-} options) arrange (eliminate arrangements) for the
17152 stack frame, individual data and constants to be aligned for the maximum
17153 single data access size for the chosen CPU model.  The default is to
17154 arrange for 32-bit alignment.  ABI details such as structure layout are
17155 not affected by these options.
17157 @item -m32-bit
17158 @itemx -m16-bit
17159 @itemx -m8-bit
17160 @opindex m32-bit
17161 @opindex m16-bit
17162 @opindex m8-bit
17163 Similar to the stack- data- and const-align options above, these options
17164 arrange for stack frame, writable data and constants to all be 32-bit,
17165 16-bit or 8-bit aligned.  The default is 32-bit alignment.
17167 @item -mno-prologue-epilogue
17168 @itemx -mprologue-epilogue
17169 @opindex mno-prologue-epilogue
17170 @opindex mprologue-epilogue
17171 With @option{-mno-prologue-epilogue}, the normal function prologue and
17172 epilogue which set up the stack frame are omitted and no return
17173 instructions or return sequences are generated in the code.  Use this
17174 option only together with visual inspection of the compiled code: no
17175 warnings or errors are generated when call-saved registers must be saved,
17176 or storage for local variables needs to be allocated.
17178 @item -mno-gotplt
17179 @itemx -mgotplt
17180 @opindex mno-gotplt
17181 @opindex mgotplt
17182 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
17183 instruction sequences that load addresses for functions from the PLT part
17184 of the GOT rather than (traditional on other architectures) calls to the
17185 PLT@.  The default is @option{-mgotplt}.
17187 @item -melf
17188 @opindex melf
17189 Legacy no-op option only recognized with the cris-axis-elf and
17190 cris-axis-linux-gnu targets.
17192 @item -mlinux
17193 @opindex mlinux
17194 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
17196 @item -sim
17197 @opindex sim
17198 This option, recognized for the cris-axis-elf, arranges
17199 to link with input-output functions from a simulator library.  Code,
17200 initialized data and zero-initialized data are allocated consecutively.
17202 @item -sim2
17203 @opindex sim2
17204 Like @option{-sim}, but pass linker options to locate initialized data at
17205 0x40000000 and zero-initialized data at 0x80000000.
17206 @end table
17208 @node CR16 Options
17209 @subsection CR16 Options
17210 @cindex CR16 Options
17212 These options are defined specifically for the CR16 ports.
17214 @table @gcctabopt
17216 @item -mmac
17217 @opindex mmac
17218 Enable the use of multiply-accumulate instructions. Disabled by default.
17220 @item -mcr16cplus
17221 @itemx -mcr16c
17222 @opindex mcr16cplus
17223 @opindex mcr16c
17224 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
17225 is default.
17227 @item -msim
17228 @opindex msim
17229 Links the library libsim.a which is in compatible with simulator. Applicable
17230 to ELF compiler only.
17232 @item -mint32
17233 @opindex mint32
17234 Choose integer type as 32-bit wide.
17236 @item -mbit-ops
17237 @opindex mbit-ops
17238 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
17240 @item -mdata-model=@var{model}
17241 @opindex mdata-model
17242 Choose a data model. The choices for @var{model} are @samp{near},
17243 @samp{far} or @samp{medium}. @samp{medium} is default.
17244 However, @samp{far} is not valid with @option{-mcr16c}, as the
17245 CR16C architecture does not support the far data model.
17246 @end table
17248 @node Darwin Options
17249 @subsection Darwin Options
17250 @cindex Darwin options
17252 These options are defined for all architectures running the Darwin operating
17253 system.
17255 FSF GCC on Darwin does not create ``fat'' object files; it creates
17256 an object file for the single architecture that GCC was built to
17257 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
17258 @option{-arch} options are used; it does so by running the compiler or
17259 linker multiple times and joining the results together with
17260 @file{lipo}.
17262 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
17263 @samp{i686}) is determined by the flags that specify the ISA
17264 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
17265 @option{-force_cpusubtype_ALL} option can be used to override this.
17267 The Darwin tools vary in their behavior when presented with an ISA
17268 mismatch.  The assembler, @file{as}, only permits instructions to
17269 be used that are valid for the subtype of the file it is generating,
17270 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
17271 The linker for shared libraries, @file{/usr/bin/libtool}, fails
17272 and prints an error if asked to create a shared library with a less
17273 restrictive subtype than its input files (for instance, trying to put
17274 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
17275 for executables, @command{ld}, quietly gives the executable the most
17276 restrictive subtype of any of its input files.
17278 @table @gcctabopt
17279 @item -F@var{dir}
17280 @opindex F
17281 Add the framework directory @var{dir} to the head of the list of
17282 directories to be searched for header files.  These directories are
17283 interleaved with those specified by @option{-I} options and are
17284 scanned in a left-to-right order.
17286 A framework directory is a directory with frameworks in it.  A
17287 framework is a directory with a @file{Headers} and/or
17288 @file{PrivateHeaders} directory contained directly in it that ends
17289 in @file{.framework}.  The name of a framework is the name of this
17290 directory excluding the @file{.framework}.  Headers associated with
17291 the framework are found in one of those two directories, with
17292 @file{Headers} being searched first.  A subframework is a framework
17293 directory that is in a framework's @file{Frameworks} directory.
17294 Includes of subframework headers can only appear in a header of a
17295 framework that contains the subframework, or in a sibling subframework
17296 header.  Two subframeworks are siblings if they occur in the same
17297 framework.  A subframework should not have the same name as a
17298 framework; a warning is issued if this is violated.  Currently a
17299 subframework cannot have subframeworks; in the future, the mechanism
17300 may be extended to support this.  The standard frameworks can be found
17301 in @file{/System/Library/Frameworks} and
17302 @file{/Library/Frameworks}.  An example include looks like
17303 @code{#include <Framework/header.h>}, where @file{Framework} denotes
17304 the name of the framework and @file{header.h} is found in the
17305 @file{PrivateHeaders} or @file{Headers} directory.
17307 @item -iframework@var{dir}
17308 @opindex iframework
17309 Like @option{-F} except the directory is a treated as a system
17310 directory.  The main difference between this @option{-iframework} and
17311 @option{-F} is that with @option{-iframework} the compiler does not
17312 warn about constructs contained within header files found via
17313 @var{dir}.  This option is valid only for the C family of languages.
17315 @item -gused
17316 @opindex gused
17317 Emit debugging information for symbols that are used.  For stabs
17318 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
17319 This is by default ON@.
17321 @item -gfull
17322 @opindex gfull
17323 Emit debugging information for all symbols and types.
17325 @item -mmacosx-version-min=@var{version}
17326 The earliest version of MacOS X that this executable will run on
17327 is @var{version}.  Typical values of @var{version} include @code{10.1},
17328 @code{10.2}, and @code{10.3.9}.
17330 If the compiler was built to use the system's headers by default,
17331 then the default for this option is the system version on which the
17332 compiler is running, otherwise the default is to make choices that
17333 are compatible with as many systems and code bases as possible.
17335 @item -mkernel
17336 @opindex mkernel
17337 Enable kernel development mode.  The @option{-mkernel} option sets
17338 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
17339 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
17340 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
17341 applicable.  This mode also sets @option{-mno-altivec},
17342 @option{-msoft-float}, @option{-fno-builtin} and
17343 @option{-mlong-branch} for PowerPC targets.
17345 @item -mone-byte-bool
17346 @opindex mone-byte-bool
17347 Override the defaults for @code{bool} so that @code{sizeof(bool)==1}.
17348 By default @code{sizeof(bool)} is @code{4} when compiling for
17349 Darwin/PowerPC and @code{1} when compiling for Darwin/x86, so this
17350 option has no effect on x86.
17352 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
17353 to generate code that is not binary compatible with code generated
17354 without that switch.  Using this switch may require recompiling all
17355 other modules in a program, including system libraries.  Use this
17356 switch to conform to a non-default data model.
17358 @item -mfix-and-continue
17359 @itemx -ffix-and-continue
17360 @itemx -findirect-data
17361 @opindex mfix-and-continue
17362 @opindex ffix-and-continue
17363 @opindex findirect-data
17364 Generate code suitable for fast turnaround development, such as to
17365 allow GDB to dynamically load @file{.o} files into already-running
17366 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
17367 are provided for backwards compatibility.
17369 @item -all_load
17370 @opindex all_load
17371 Loads all members of static archive libraries.
17372 See man ld(1) for more information.
17374 @item -arch_errors_fatal
17375 @opindex arch_errors_fatal
17376 Cause the errors having to do with files that have the wrong architecture
17377 to be fatal.
17379 @item -bind_at_load
17380 @opindex bind_at_load
17381 Causes the output file to be marked such that the dynamic linker will
17382 bind all undefined references when the file is loaded or launched.
17384 @item -bundle
17385 @opindex bundle
17386 Produce a Mach-o bundle format file.
17387 See man ld(1) for more information.
17389 @item -bundle_loader @var{executable}
17390 @opindex bundle_loader
17391 This option specifies the @var{executable} that will load the build
17392 output file being linked.  See man ld(1) for more information.
17394 @item -dynamiclib
17395 @opindex dynamiclib
17396 When passed this option, GCC produces a dynamic library instead of
17397 an executable when linking, using the Darwin @file{libtool} command.
17399 @item -force_cpusubtype_ALL
17400 @opindex force_cpusubtype_ALL
17401 This causes GCC's output file to have the @samp{ALL} subtype, instead of
17402 one controlled by the @option{-mcpu} or @option{-march} option.
17404 @item -allowable_client  @var{client_name}
17405 @itemx -client_name
17406 @itemx -compatibility_version
17407 @itemx -current_version
17408 @itemx -dead_strip
17409 @itemx -dependency-file
17410 @itemx -dylib_file
17411 @itemx -dylinker_install_name
17412 @itemx -dynamic
17413 @itemx -exported_symbols_list
17414 @itemx -filelist
17415 @need 800
17416 @itemx -flat_namespace
17417 @itemx -force_flat_namespace
17418 @itemx -headerpad_max_install_names
17419 @itemx -image_base
17420 @itemx -init
17421 @itemx -install_name
17422 @itemx -keep_private_externs
17423 @itemx -multi_module
17424 @itemx -multiply_defined
17425 @itemx -multiply_defined_unused
17426 @need 800
17427 @itemx -noall_load
17428 @itemx -no_dead_strip_inits_and_terms
17429 @itemx -nofixprebinding
17430 @itemx -nomultidefs
17431 @itemx -noprebind
17432 @itemx -noseglinkedit
17433 @itemx -pagezero_size
17434 @itemx -prebind
17435 @itemx -prebind_all_twolevel_modules
17436 @itemx -private_bundle
17437 @need 800
17438 @itemx -read_only_relocs
17439 @itemx -sectalign
17440 @itemx -sectobjectsymbols
17441 @itemx -whyload
17442 @itemx -seg1addr
17443 @itemx -sectcreate
17444 @itemx -sectobjectsymbols
17445 @itemx -sectorder
17446 @itemx -segaddr
17447 @itemx -segs_read_only_addr
17448 @need 800
17449 @itemx -segs_read_write_addr
17450 @itemx -seg_addr_table
17451 @itemx -seg_addr_table_filename
17452 @itemx -seglinkedit
17453 @itemx -segprot
17454 @itemx -segs_read_only_addr
17455 @itemx -segs_read_write_addr
17456 @itemx -single_module
17457 @itemx -static
17458 @itemx -sub_library
17459 @need 800
17460 @itemx -sub_umbrella
17461 @itemx -twolevel_namespace
17462 @itemx -umbrella
17463 @itemx -undefined
17464 @itemx -unexported_symbols_list
17465 @itemx -weak_reference_mismatches
17466 @itemx -whatsloaded
17467 @opindex allowable_client
17468 @opindex client_name
17469 @opindex compatibility_version
17470 @opindex current_version
17471 @opindex dead_strip
17472 @opindex dependency-file
17473 @opindex dylib_file
17474 @opindex dylinker_install_name
17475 @opindex dynamic
17476 @opindex exported_symbols_list
17477 @opindex filelist
17478 @opindex flat_namespace
17479 @opindex force_flat_namespace
17480 @opindex headerpad_max_install_names
17481 @opindex image_base
17482 @opindex init
17483 @opindex install_name
17484 @opindex keep_private_externs
17485 @opindex multi_module
17486 @opindex multiply_defined
17487 @opindex multiply_defined_unused
17488 @opindex noall_load
17489 @opindex no_dead_strip_inits_and_terms
17490 @opindex nofixprebinding
17491 @opindex nomultidefs
17492 @opindex noprebind
17493 @opindex noseglinkedit
17494 @opindex pagezero_size
17495 @opindex prebind
17496 @opindex prebind_all_twolevel_modules
17497 @opindex private_bundle
17498 @opindex read_only_relocs
17499 @opindex sectalign
17500 @opindex sectobjectsymbols
17501 @opindex whyload
17502 @opindex seg1addr
17503 @opindex sectcreate
17504 @opindex sectobjectsymbols
17505 @opindex sectorder
17506 @opindex segaddr
17507 @opindex segs_read_only_addr
17508 @opindex segs_read_write_addr
17509 @opindex seg_addr_table
17510 @opindex seg_addr_table_filename
17511 @opindex seglinkedit
17512 @opindex segprot
17513 @opindex segs_read_only_addr
17514 @opindex segs_read_write_addr
17515 @opindex single_module
17516 @opindex static
17517 @opindex sub_library
17518 @opindex sub_umbrella
17519 @opindex twolevel_namespace
17520 @opindex umbrella
17521 @opindex undefined
17522 @opindex unexported_symbols_list
17523 @opindex weak_reference_mismatches
17524 @opindex whatsloaded
17525 These options are passed to the Darwin linker.  The Darwin linker man page
17526 describes them in detail.
17527 @end table
17529 @node DEC Alpha Options
17530 @subsection DEC Alpha Options
17532 These @samp{-m} options are defined for the DEC Alpha implementations:
17534 @table @gcctabopt
17535 @item -mno-soft-float
17536 @itemx -msoft-float
17537 @opindex mno-soft-float
17538 @opindex msoft-float
17539 Use (do not use) the hardware floating-point instructions for
17540 floating-point operations.  When @option{-msoft-float} is specified,
17541 functions in @file{libgcc.a} are used to perform floating-point
17542 operations.  Unless they are replaced by routines that emulate the
17543 floating-point operations, or compiled in such a way as to call such
17544 emulations routines, these routines issue floating-point
17545 operations.   If you are compiling for an Alpha without floating-point
17546 operations, you must ensure that the library is built so as not to call
17547 them.
17549 Note that Alpha implementations without floating-point operations are
17550 required to have floating-point registers.
17552 @item -mfp-reg
17553 @itemx -mno-fp-regs
17554 @opindex mfp-reg
17555 @opindex mno-fp-regs
17556 Generate code that uses (does not use) the floating-point register set.
17557 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
17558 register set is not used, floating-point operands are passed in integer
17559 registers as if they were integers and floating-point results are passed
17560 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
17561 so any function with a floating-point argument or return value called by code
17562 compiled with @option{-mno-fp-regs} must also be compiled with that
17563 option.
17565 A typical use of this option is building a kernel that does not use,
17566 and hence need not save and restore, any floating-point registers.
17568 @item -mieee
17569 @opindex mieee
17570 The Alpha architecture implements floating-point hardware optimized for
17571 maximum performance.  It is mostly compliant with the IEEE floating-point
17572 standard.  However, for full compliance, software assistance is
17573 required.  This option generates code fully IEEE-compliant code
17574 @emph{except} that the @var{inexact-flag} is not maintained (see below).
17575 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
17576 defined during compilation.  The resulting code is less efficient but is
17577 able to correctly support denormalized numbers and exceptional IEEE
17578 values such as not-a-number and plus/minus infinity.  Other Alpha
17579 compilers call this option @option{-ieee_with_no_inexact}.
17581 @item -mieee-with-inexact
17582 @opindex mieee-with-inexact
17583 This is like @option{-mieee} except the generated code also maintains
17584 the IEEE @var{inexact-flag}.  Turning on this option causes the
17585 generated code to implement fully-compliant IEEE math.  In addition to
17586 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
17587 macro.  On some Alpha implementations the resulting code may execute
17588 significantly slower than the code generated by default.  Since there is
17589 very little code that depends on the @var{inexact-flag}, you should
17590 normally not specify this option.  Other Alpha compilers call this
17591 option @option{-ieee_with_inexact}.
17593 @item -mfp-trap-mode=@var{trap-mode}
17594 @opindex mfp-trap-mode
17595 This option controls what floating-point related traps are enabled.
17596 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
17597 The trap mode can be set to one of four values:
17599 @table @samp
17600 @item n
17601 This is the default (normal) setting.  The only traps that are enabled
17602 are the ones that cannot be disabled in software (e.g., division by zero
17603 trap).
17605 @item u
17606 In addition to the traps enabled by @samp{n}, underflow traps are enabled
17607 as well.
17609 @item su
17610 Like @samp{u}, but the instructions are marked to be safe for software
17611 completion (see Alpha architecture manual for details).
17613 @item sui
17614 Like @samp{su}, but inexact traps are enabled as well.
17615 @end table
17617 @item -mfp-rounding-mode=@var{rounding-mode}
17618 @opindex mfp-rounding-mode
17619 Selects the IEEE rounding mode.  Other Alpha compilers call this option
17620 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
17623 @table @samp
17624 @item n
17625 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
17626 the nearest machine number or towards the even machine number in case
17627 of a tie.
17629 @item m
17630 Round towards minus infinity.
17632 @item c
17633 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
17635 @item d
17636 Dynamic rounding mode.  A field in the floating-point control register
17637 (@var{fpcr}, see Alpha architecture reference manual) controls the
17638 rounding mode in effect.  The C library initializes this register for
17639 rounding towards plus infinity.  Thus, unless your program modifies the
17640 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
17641 @end table
17643 @item -mtrap-precision=@var{trap-precision}
17644 @opindex mtrap-precision
17645 In the Alpha architecture, floating-point traps are imprecise.  This
17646 means without software assistance it is impossible to recover from a
17647 floating trap and program execution normally needs to be terminated.
17648 GCC can generate code that can assist operating system trap handlers
17649 in determining the exact location that caused a floating-point trap.
17650 Depending on the requirements of an application, different levels of
17651 precisions can be selected:
17653 @table @samp
17654 @item p
17655 Program precision.  This option is the default and means a trap handler
17656 can only identify which program caused a floating-point exception.
17658 @item f
17659 Function precision.  The trap handler can determine the function that
17660 caused a floating-point exception.
17662 @item i
17663 Instruction precision.  The trap handler can determine the exact
17664 instruction that caused a floating-point exception.
17665 @end table
17667 Other Alpha compilers provide the equivalent options called
17668 @option{-scope_safe} and @option{-resumption_safe}.
17670 @item -mieee-conformant
17671 @opindex mieee-conformant
17672 This option marks the generated code as IEEE conformant.  You must not
17673 use this option unless you also specify @option{-mtrap-precision=i} and either
17674 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
17675 is to emit the line @samp{.eflag 48} in the function prologue of the
17676 generated assembly file.
17678 @item -mbuild-constants
17679 @opindex mbuild-constants
17680 Normally GCC examines a 32- or 64-bit integer constant to
17681 see if it can construct it from smaller constants in two or three
17682 instructions.  If it cannot, it outputs the constant as a literal and
17683 generates code to load it from the data segment at run time.
17685 Use this option to require GCC to construct @emph{all} integer constants
17686 using code, even if it takes more instructions (the maximum is six).
17688 You typically use this option to build a shared library dynamic
17689 loader.  Itself a shared library, it must relocate itself in memory
17690 before it can find the variables and constants in its own data segment.
17692 @item -mbwx
17693 @itemx -mno-bwx
17694 @itemx -mcix
17695 @itemx -mno-cix
17696 @itemx -mfix
17697 @itemx -mno-fix
17698 @itemx -mmax
17699 @itemx -mno-max
17700 @opindex mbwx
17701 @opindex mno-bwx
17702 @opindex mcix
17703 @opindex mno-cix
17704 @opindex mfix
17705 @opindex mno-fix
17706 @opindex mmax
17707 @opindex mno-max
17708 Indicate whether GCC should generate code to use the optional BWX,
17709 CIX, FIX and MAX instruction sets.  The default is to use the instruction
17710 sets supported by the CPU type specified via @option{-mcpu=} option or that
17711 of the CPU on which GCC was built if none is specified.
17713 @item -mfloat-vax
17714 @itemx -mfloat-ieee
17715 @opindex mfloat-vax
17716 @opindex mfloat-ieee
17717 Generate code that uses (does not use) VAX F and G floating-point
17718 arithmetic instead of IEEE single and double precision.
17720 @item -mexplicit-relocs
17721 @itemx -mno-explicit-relocs
17722 @opindex mexplicit-relocs
17723 @opindex mno-explicit-relocs
17724 Older Alpha assemblers provided no way to generate symbol relocations
17725 except via assembler macros.  Use of these macros does not allow
17726 optimal instruction scheduling.  GNU binutils as of version 2.12
17727 supports a new syntax that allows the compiler to explicitly mark
17728 which relocations should apply to which instructions.  This option
17729 is mostly useful for debugging, as GCC detects the capabilities of
17730 the assembler when it is built and sets the default accordingly.
17732 @item -msmall-data
17733 @itemx -mlarge-data
17734 @opindex msmall-data
17735 @opindex mlarge-data
17736 When @option{-mexplicit-relocs} is in effect, static data is
17737 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
17738 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
17739 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
17740 16-bit relocations off of the @code{$gp} register.  This limits the
17741 size of the small data area to 64KB, but allows the variables to be
17742 directly accessed via a single instruction.
17744 The default is @option{-mlarge-data}.  With this option the data area
17745 is limited to just below 2GB@.  Programs that require more than 2GB of
17746 data must use @code{malloc} or @code{mmap} to allocate the data in the
17747 heap instead of in the program's data segment.
17749 When generating code for shared libraries, @option{-fpic} implies
17750 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
17752 @item -msmall-text
17753 @itemx -mlarge-text
17754 @opindex msmall-text
17755 @opindex mlarge-text
17756 When @option{-msmall-text} is used, the compiler assumes that the
17757 code of the entire program (or shared library) fits in 4MB, and is
17758 thus reachable with a branch instruction.  When @option{-msmall-data}
17759 is used, the compiler can assume that all local symbols share the
17760 same @code{$gp} value, and thus reduce the number of instructions
17761 required for a function call from 4 to 1.
17763 The default is @option{-mlarge-text}.
17765 @item -mcpu=@var{cpu_type}
17766 @opindex mcpu
17767 Set the instruction set and instruction scheduling parameters for
17768 machine type @var{cpu_type}.  You can specify either the @samp{EV}
17769 style name or the corresponding chip number.  GCC supports scheduling
17770 parameters for the EV4, EV5 and EV6 family of processors and
17771 chooses the default values for the instruction set from the processor
17772 you specify.  If you do not specify a processor type, GCC defaults
17773 to the processor on which the compiler was built.
17775 Supported values for @var{cpu_type} are
17777 @table @samp
17778 @item ev4
17779 @itemx ev45
17780 @itemx 21064
17781 Schedules as an EV4 and has no instruction set extensions.
17783 @item ev5
17784 @itemx 21164
17785 Schedules as an EV5 and has no instruction set extensions.
17787 @item ev56
17788 @itemx 21164a
17789 Schedules as an EV5 and supports the BWX extension.
17791 @item pca56
17792 @itemx 21164pc
17793 @itemx 21164PC
17794 Schedules as an EV5 and supports the BWX and MAX extensions.
17796 @item ev6
17797 @itemx 21264
17798 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
17800 @item ev67
17801 @itemx 21264a
17802 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
17803 @end table
17805 Native toolchains also support the value @samp{native},
17806 which selects the best architecture option for the host processor.
17807 @option{-mcpu=native} has no effect if GCC does not recognize
17808 the processor.
17810 @item -mtune=@var{cpu_type}
17811 @opindex mtune
17812 Set only the instruction scheduling parameters for machine type
17813 @var{cpu_type}.  The instruction set is not changed.
17815 Native toolchains also support the value @samp{native},
17816 which selects the best architecture option for the host processor.
17817 @option{-mtune=native} has no effect if GCC does not recognize
17818 the processor.
17820 @item -mmemory-latency=@var{time}
17821 @opindex mmemory-latency
17822 Sets the latency the scheduler should assume for typical memory
17823 references as seen by the application.  This number is highly
17824 dependent on the memory access patterns used by the application
17825 and the size of the external cache on the machine.
17827 Valid options for @var{time} are
17829 @table @samp
17830 @item @var{number}
17831 A decimal number representing clock cycles.
17833 @item L1
17834 @itemx L2
17835 @itemx L3
17836 @itemx main
17837 The compiler contains estimates of the number of clock cycles for
17838 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
17839 (also called Dcache, Scache, and Bcache), as well as to main memory.
17840 Note that L3 is only valid for EV5.
17842 @end table
17843 @end table
17845 @node FR30 Options
17846 @subsection FR30 Options
17847 @cindex FR30 Options
17849 These options are defined specifically for the FR30 port.
17851 @table @gcctabopt
17853 @item -msmall-model
17854 @opindex msmall-model
17855 Use the small address space model.  This can produce smaller code, but
17856 it does assume that all symbolic values and addresses fit into a
17857 20-bit range.
17859 @item -mno-lsim
17860 @opindex mno-lsim
17861 Assume that runtime support has been provided and so there is no need
17862 to include the simulator library (@file{libsim.a}) on the linker
17863 command line.
17865 @end table
17867 @node FT32 Options
17868 @subsection FT32 Options
17869 @cindex FT32 Options
17871 These options are defined specifically for the FT32 port.
17873 @table @gcctabopt
17875 @item -msim
17876 @opindex msim
17877 Specifies that the program will be run on the simulator.  This causes
17878 an alternate runtime startup and library to be linked.
17879 You must not use this option when generating programs that will run on
17880 real hardware; you must provide your own runtime library for whatever
17881 I/O functions are needed.
17883 @item -mlra
17884 @opindex mlra
17885 Enable Local Register Allocation.  This is still experimental for FT32,
17886 so by default the compiler uses standard reload.
17888 @item -mnodiv
17889 @opindex mnodiv
17890 Do not use div and mod instructions.
17892 @item -mft32b
17893 @opindex mft32b
17894 Enable use of the extended instructions of the FT32B processor.
17896 @item -mcompress
17897 @opindex mcompress
17898 Compress all code using the Ft32B code compression scheme.
17900 @item -mnopm
17901 @opindex  mnopm
17902 Do not generate code that reads program memory.
17904 @end table
17906 @node FRV Options
17907 @subsection FRV Options
17908 @cindex FRV Options
17910 @table @gcctabopt
17911 @item -mgpr-32
17912 @opindex mgpr-32
17914 Only use the first 32 general-purpose registers.
17916 @item -mgpr-64
17917 @opindex mgpr-64
17919 Use all 64 general-purpose registers.
17921 @item -mfpr-32
17922 @opindex mfpr-32
17924 Use only the first 32 floating-point registers.
17926 @item -mfpr-64
17927 @opindex mfpr-64
17929 Use all 64 floating-point registers.
17931 @item -mhard-float
17932 @opindex mhard-float
17934 Use hardware instructions for floating-point operations.
17936 @item -msoft-float
17937 @opindex msoft-float
17939 Use library routines for floating-point operations.
17941 @item -malloc-cc
17942 @opindex malloc-cc
17944 Dynamically allocate condition code registers.
17946 @item -mfixed-cc
17947 @opindex mfixed-cc
17949 Do not try to dynamically allocate condition code registers, only
17950 use @code{icc0} and @code{fcc0}.
17952 @item -mdword
17953 @opindex mdword
17955 Change ABI to use double word insns.
17957 @item -mno-dword
17958 @opindex mno-dword
17960 Do not use double word instructions.
17962 @item -mdouble
17963 @opindex mdouble
17965 Use floating-point double instructions.
17967 @item -mno-double
17968 @opindex mno-double
17970 Do not use floating-point double instructions.
17972 @item -mmedia
17973 @opindex mmedia
17975 Use media instructions.
17977 @item -mno-media
17978 @opindex mno-media
17980 Do not use media instructions.
17982 @item -mmuladd
17983 @opindex mmuladd
17985 Use multiply and add/subtract instructions.
17987 @item -mno-muladd
17988 @opindex mno-muladd
17990 Do not use multiply and add/subtract instructions.
17992 @item -mfdpic
17993 @opindex mfdpic
17995 Select the FDPIC ABI, which uses function descriptors to represent
17996 pointers to functions.  Without any PIC/PIE-related options, it
17997 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
17998 assumes GOT entries and small data are within a 12-bit range from the
17999 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
18000 are computed with 32 bits.
18001 With a @samp{bfin-elf} target, this option implies @option{-msim}.
18003 @item -minline-plt
18004 @opindex minline-plt
18006 Enable inlining of PLT entries in function calls to functions that are
18007 not known to bind locally.  It has no effect without @option{-mfdpic}.
18008 It's enabled by default if optimizing for speed and compiling for
18009 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
18010 optimization option such as @option{-O3} or above is present in the
18011 command line.
18013 @item -mTLS
18014 @opindex mTLS
18016 Assume a large TLS segment when generating thread-local code.
18018 @item -mtls
18019 @opindex mtls
18021 Do not assume a large TLS segment when generating thread-local code.
18023 @item -mgprel-ro
18024 @opindex mgprel-ro
18026 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
18027 that is known to be in read-only sections.  It's enabled by default,
18028 except for @option{-fpic} or @option{-fpie}: even though it may help
18029 make the global offset table smaller, it trades 1 instruction for 4.
18030 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
18031 one of which may be shared by multiple symbols, and it avoids the need
18032 for a GOT entry for the referenced symbol, so it's more likely to be a
18033 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
18035 @item -multilib-library-pic
18036 @opindex multilib-library-pic
18038 Link with the (library, not FD) pic libraries.  It's implied by
18039 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
18040 @option{-fpic} without @option{-mfdpic}.  You should never have to use
18041 it explicitly.
18043 @item -mlinked-fp
18044 @opindex mlinked-fp
18046 Follow the EABI requirement of always creating a frame pointer whenever
18047 a stack frame is allocated.  This option is enabled by default and can
18048 be disabled with @option{-mno-linked-fp}.
18050 @item -mlong-calls
18051 @opindex mlong-calls
18053 Use indirect addressing to call functions outside the current
18054 compilation unit.  This allows the functions to be placed anywhere
18055 within the 32-bit address space.
18057 @item -malign-labels
18058 @opindex malign-labels
18060 Try to align labels to an 8-byte boundary by inserting NOPs into the
18061 previous packet.  This option only has an effect when VLIW packing
18062 is enabled.  It doesn't create new packets; it merely adds NOPs to
18063 existing ones.
18065 @item -mlibrary-pic
18066 @opindex mlibrary-pic
18068 Generate position-independent EABI code.
18070 @item -macc-4
18071 @opindex macc-4
18073 Use only the first four media accumulator registers.
18075 @item -macc-8
18076 @opindex macc-8
18078 Use all eight media accumulator registers.
18080 @item -mpack
18081 @opindex mpack
18083 Pack VLIW instructions.
18085 @item -mno-pack
18086 @opindex mno-pack
18088 Do not pack VLIW instructions.
18090 @item -mno-eflags
18091 @opindex mno-eflags
18093 Do not mark ABI switches in e_flags.
18095 @item -mcond-move
18096 @opindex mcond-move
18098 Enable the use of conditional-move instructions (default).
18100 This switch is mainly for debugging the compiler and will likely be removed
18101 in a future version.
18103 @item -mno-cond-move
18104 @opindex mno-cond-move
18106 Disable the use of conditional-move instructions.
18108 This switch is mainly for debugging the compiler and will likely be removed
18109 in a future version.
18111 @item -mscc
18112 @opindex mscc
18114 Enable the use of conditional set instructions (default).
18116 This switch is mainly for debugging the compiler and will likely be removed
18117 in a future version.
18119 @item -mno-scc
18120 @opindex mno-scc
18122 Disable the use of conditional set instructions.
18124 This switch is mainly for debugging the compiler and will likely be removed
18125 in a future version.
18127 @item -mcond-exec
18128 @opindex mcond-exec
18130 Enable the use of conditional execution (default).
18132 This switch is mainly for debugging the compiler and will likely be removed
18133 in a future version.
18135 @item -mno-cond-exec
18136 @opindex mno-cond-exec
18138 Disable the use of conditional execution.
18140 This switch is mainly for debugging the compiler and will likely be removed
18141 in a future version.
18143 @item -mvliw-branch
18144 @opindex mvliw-branch
18146 Run a pass to pack branches into VLIW instructions (default).
18148 This switch is mainly for debugging the compiler and will likely be removed
18149 in a future version.
18151 @item -mno-vliw-branch
18152 @opindex mno-vliw-branch
18154 Do not run a pass to pack branches into VLIW instructions.
18156 This switch is mainly for debugging the compiler and will likely be removed
18157 in a future version.
18159 @item -mmulti-cond-exec
18160 @opindex mmulti-cond-exec
18162 Enable optimization of @code{&&} and @code{||} in conditional execution
18163 (default).
18165 This switch is mainly for debugging the compiler and will likely be removed
18166 in a future version.
18168 @item -mno-multi-cond-exec
18169 @opindex mno-multi-cond-exec
18171 Disable optimization of @code{&&} and @code{||} in conditional execution.
18173 This switch is mainly for debugging the compiler and will likely be removed
18174 in a future version.
18176 @item -mnested-cond-exec
18177 @opindex mnested-cond-exec
18179 Enable nested conditional execution optimizations (default).
18181 This switch is mainly for debugging the compiler and will likely be removed
18182 in a future version.
18184 @item -mno-nested-cond-exec
18185 @opindex mno-nested-cond-exec
18187 Disable nested conditional execution optimizations.
18189 This switch is mainly for debugging the compiler and will likely be removed
18190 in a future version.
18192 @item -moptimize-membar
18193 @opindex moptimize-membar
18195 This switch removes redundant @code{membar} instructions from the
18196 compiler-generated code.  It is enabled by default.
18198 @item -mno-optimize-membar
18199 @opindex mno-optimize-membar
18201 This switch disables the automatic removal of redundant @code{membar}
18202 instructions from the generated code.
18204 @item -mtomcat-stats
18205 @opindex mtomcat-stats
18207 Cause gas to print out tomcat statistics.
18209 @item -mcpu=@var{cpu}
18210 @opindex mcpu
18212 Select the processor type for which to generate code.  Possible values are
18213 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
18214 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
18216 @end table
18218 @node GNU/Linux Options
18219 @subsection GNU/Linux Options
18221 These @samp{-m} options are defined for GNU/Linux targets:
18223 @table @gcctabopt
18224 @item -mglibc
18225 @opindex mglibc
18226 Use the GNU C library.  This is the default except
18227 on @samp{*-*-linux-*uclibc*}, @samp{*-*-linux-*musl*} and
18228 @samp{*-*-linux-*android*} targets.
18230 @item -muclibc
18231 @opindex muclibc
18232 Use uClibc C library.  This is the default on
18233 @samp{*-*-linux-*uclibc*} targets.
18235 @item -mmusl
18236 @opindex mmusl
18237 Use the musl C library.  This is the default on
18238 @samp{*-*-linux-*musl*} targets.
18240 @item -mbionic
18241 @opindex mbionic
18242 Use Bionic C library.  This is the default on
18243 @samp{*-*-linux-*android*} targets.
18245 @item -mandroid
18246 @opindex mandroid
18247 Compile code compatible with Android platform.  This is the default on
18248 @samp{*-*-linux-*android*} targets.
18250 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
18251 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
18252 this option makes the GCC driver pass Android-specific options to the linker.
18253 Finally, this option causes the preprocessor macro @code{__ANDROID__}
18254 to be defined.
18256 @item -tno-android-cc
18257 @opindex tno-android-cc
18258 Disable compilation effects of @option{-mandroid}, i.e., do not enable
18259 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
18260 @option{-fno-rtti} by default.
18262 @item -tno-android-ld
18263 @opindex tno-android-ld
18264 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
18265 linking options to the linker.
18267 @end table
18269 @node H8/300 Options
18270 @subsection H8/300 Options
18272 These @samp{-m} options are defined for the H8/300 implementations:
18274 @table @gcctabopt
18275 @item -mrelax
18276 @opindex mrelax
18277 Shorten some address references at link time, when possible; uses the
18278 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
18279 ld, Using ld}, for a fuller description.
18281 @item -mh
18282 @opindex mh
18283 Generate code for the H8/300H@.
18285 @item -ms
18286 @opindex ms
18287 Generate code for the H8S@.
18289 @item -mn
18290 @opindex mn
18291 Generate code for the H8S and H8/300H in the normal mode.  This switch
18292 must be used either with @option{-mh} or @option{-ms}.
18294 @item -ms2600
18295 @opindex ms2600
18296 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
18298 @item -mexr
18299 @opindex mexr
18300 Extended registers are stored on stack before execution of function
18301 with monitor attribute. Default option is @option{-mexr}.
18302 This option is valid only for H8S targets.
18304 @item -mno-exr
18305 @opindex mno-exr
18306 Extended registers are not stored on stack before execution of function 
18307 with monitor attribute. Default option is @option{-mno-exr}. 
18308 This option is valid only for H8S targets.
18310 @item -mint32
18311 @opindex mint32
18312 Make @code{int} data 32 bits by default.
18314 @item -malign-300
18315 @opindex malign-300
18316 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
18317 The default for the H8/300H and H8S is to align longs and floats on
18318 4-byte boundaries.
18319 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
18320 This option has no effect on the H8/300.
18321 @end table
18323 @node HPPA Options
18324 @subsection HPPA Options
18325 @cindex HPPA Options
18327 These @samp{-m} options are defined for the HPPA family of computers:
18329 @table @gcctabopt
18330 @item -march=@var{architecture-type}
18331 @opindex march
18332 Generate code for the specified architecture.  The choices for
18333 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
18334 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
18335 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
18336 architecture option for your machine.  Code compiled for lower numbered
18337 architectures runs on higher numbered architectures, but not the
18338 other way around.
18340 @item -mpa-risc-1-0
18341 @itemx -mpa-risc-1-1
18342 @itemx -mpa-risc-2-0
18343 @opindex mpa-risc-1-0
18344 @opindex mpa-risc-1-1
18345 @opindex mpa-risc-2-0
18346 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
18348 @item -mcaller-copies
18349 @opindex mcaller-copies
18350 The caller copies function arguments passed by hidden reference.  This
18351 option should be used with care as it is not compatible with the default
18352 32-bit runtime.  However, only aggregates larger than eight bytes are
18353 passed by hidden reference and the option provides better compatibility
18354 with OpenMP.
18356 @item -mjump-in-delay
18357 @opindex mjump-in-delay
18358 This option is ignored and provided for compatibility purposes only.
18360 @item -mdisable-fpregs
18361 @opindex mdisable-fpregs
18362 Prevent floating-point registers from being used in any manner.  This is
18363 necessary for compiling kernels that perform lazy context switching of
18364 floating-point registers.  If you use this option and attempt to perform
18365 floating-point operations, the compiler aborts.
18367 @item -mdisable-indexing
18368 @opindex mdisable-indexing
18369 Prevent the compiler from using indexing address modes.  This avoids some
18370 rather obscure problems when compiling MIG generated code under MACH@.
18372 @item -mno-space-regs
18373 @opindex mno-space-regs
18374 Generate code that assumes the target has no space registers.  This allows
18375 GCC to generate faster indirect calls and use unscaled index address modes.
18377 Such code is suitable for level 0 PA systems and kernels.
18379 @item -mfast-indirect-calls
18380 @opindex mfast-indirect-calls
18381 Generate code that assumes calls never cross space boundaries.  This
18382 allows GCC to emit code that performs faster indirect calls.
18384 This option does not work in the presence of shared libraries or nested
18385 functions.
18387 @item -mfixed-range=@var{register-range}
18388 @opindex mfixed-range
18389 Generate code treating the given register range as fixed registers.
18390 A fixed register is one that the register allocator cannot use.  This is
18391 useful when compiling kernel code.  A register range is specified as
18392 two registers separated by a dash.  Multiple register ranges can be
18393 specified separated by a comma.
18395 @item -mlong-load-store
18396 @opindex mlong-load-store
18397 Generate 3-instruction load and store sequences as sometimes required by
18398 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
18399 the HP compilers.
18401 @item -mportable-runtime
18402 @opindex mportable-runtime
18403 Use the portable calling conventions proposed by HP for ELF systems.
18405 @item -mgas
18406 @opindex mgas
18407 Enable the use of assembler directives only GAS understands.
18409 @item -mschedule=@var{cpu-type}
18410 @opindex mschedule
18411 Schedule code according to the constraints for the machine type
18412 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
18413 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
18414 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
18415 proper scheduling option for your machine.  The default scheduling is
18416 @samp{8000}.
18418 @item -mlinker-opt
18419 @opindex mlinker-opt
18420 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
18421 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
18422 linkers in which they give bogus error messages when linking some programs.
18424 @item -msoft-float
18425 @opindex msoft-float
18426 Generate output containing library calls for floating point.
18427 @strong{Warning:} the requisite libraries are not available for all HPPA
18428 targets.  Normally the facilities of the machine's usual C compiler are
18429 used, but this cannot be done directly in cross-compilation.  You must make
18430 your own arrangements to provide suitable library functions for
18431 cross-compilation.
18433 @option{-msoft-float} changes the calling convention in the output file;
18434 therefore, it is only useful if you compile @emph{all} of a program with
18435 this option.  In particular, you need to compile @file{libgcc.a}, the
18436 library that comes with GCC, with @option{-msoft-float} in order for
18437 this to work.
18439 @item -msio
18440 @opindex msio
18441 Generate the predefine, @code{_SIO}, for server IO@.  The default is
18442 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
18443 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
18444 options are available under HP-UX and HI-UX@.
18446 @item -mgnu-ld
18447 @opindex mgnu-ld
18448 Use options specific to GNU @command{ld}.
18449 This passes @option{-shared} to @command{ld} when
18450 building a shared library.  It is the default when GCC is configured,
18451 explicitly or implicitly, with the GNU linker.  This option does not
18452 affect which @command{ld} is called; it only changes what parameters
18453 are passed to that @command{ld}.
18454 The @command{ld} that is called is determined by the
18455 @option{--with-ld} configure option, GCC's program search path, and
18456 finally by the user's @env{PATH}.  The linker used by GCC can be printed
18457 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
18458 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
18460 @item -mhp-ld
18461 @opindex mhp-ld
18462 Use options specific to HP @command{ld}.
18463 This passes @option{-b} to @command{ld} when building
18464 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
18465 links.  It is the default when GCC is configured, explicitly or
18466 implicitly, with the HP linker.  This option does not affect
18467 which @command{ld} is called; it only changes what parameters are passed to that
18468 @command{ld}.
18469 The @command{ld} that is called is determined by the @option{--with-ld}
18470 configure option, GCC's program search path, and finally by the user's
18471 @env{PATH}.  The linker used by GCC can be printed using @samp{which
18472 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
18473 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
18475 @item -mlong-calls
18476 @opindex mno-long-calls
18477 Generate code that uses long call sequences.  This ensures that a call
18478 is always able to reach linker generated stubs.  The default is to generate
18479 long calls only when the distance from the call site to the beginning
18480 of the function or translation unit, as the case may be, exceeds a
18481 predefined limit set by the branch type being used.  The limits for
18482 normal calls are 7,600,000 and 240,000 bytes, respectively for the
18483 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
18484 240,000 bytes.
18486 Distances are measured from the beginning of functions when using the
18487 @option{-ffunction-sections} option, or when using the @option{-mgas}
18488 and @option{-mno-portable-runtime} options together under HP-UX with
18489 the SOM linker.
18491 It is normally not desirable to use this option as it degrades
18492 performance.  However, it may be useful in large applications,
18493 particularly when partial linking is used to build the application.
18495 The types of long calls used depends on the capabilities of the
18496 assembler and linker, and the type of code being generated.  The
18497 impact on systems that support long absolute calls, and long pic
18498 symbol-difference or pc-relative calls should be relatively small.
18499 However, an indirect call is used on 32-bit ELF systems in pic code
18500 and it is quite long.
18502 @item -munix=@var{unix-std}
18503 @opindex march
18504 Generate compiler predefines and select a startfile for the specified
18505 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
18506 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
18507 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
18508 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
18509 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
18510 and later.
18512 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
18513 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
18514 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
18515 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
18516 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
18517 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
18519 It is @emph{important} to note that this option changes the interfaces
18520 for various library routines.  It also affects the operational behavior
18521 of the C library.  Thus, @emph{extreme} care is needed in using this
18522 option.
18524 Library code that is intended to operate with more than one UNIX
18525 standard must test, set and restore the variable @code{__xpg4_extended_mask}
18526 as appropriate.  Most GNU software doesn't provide this capability.
18528 @item -nolibdld
18529 @opindex nolibdld
18530 Suppress the generation of link options to search libdld.sl when the
18531 @option{-static} option is specified on HP-UX 10 and later.
18533 @item -static
18534 @opindex static
18535 The HP-UX implementation of setlocale in libc has a dependency on
18536 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
18537 when the @option{-static} option is specified, special link options
18538 are needed to resolve this dependency.
18540 On HP-UX 10 and later, the GCC driver adds the necessary options to
18541 link with libdld.sl when the @option{-static} option is specified.
18542 This causes the resulting binary to be dynamic.  On the 64-bit port,
18543 the linkers generate dynamic binaries by default in any case.  The
18544 @option{-nolibdld} option can be used to prevent the GCC driver from
18545 adding these link options.
18547 @item -threads
18548 @opindex threads
18549 Add support for multithreading with the @dfn{dce thread} library
18550 under HP-UX@.  This option sets flags for both the preprocessor and
18551 linker.
18552 @end table
18554 @node IA-64 Options
18555 @subsection IA-64 Options
18556 @cindex IA-64 Options
18558 These are the @samp{-m} options defined for the Intel IA-64 architecture.
18560 @table @gcctabopt
18561 @item -mbig-endian
18562 @opindex mbig-endian
18563 Generate code for a big-endian target.  This is the default for HP-UX@.
18565 @item -mlittle-endian
18566 @opindex mlittle-endian
18567 Generate code for a little-endian target.  This is the default for AIX5
18568 and GNU/Linux.
18570 @item -mgnu-as
18571 @itemx -mno-gnu-as
18572 @opindex mgnu-as
18573 @opindex mno-gnu-as
18574 Generate (or don't) code for the GNU assembler.  This is the default.
18575 @c Also, this is the default if the configure option @option{--with-gnu-as}
18576 @c is used.
18578 @item -mgnu-ld
18579 @itemx -mno-gnu-ld
18580 @opindex mgnu-ld
18581 @opindex mno-gnu-ld
18582 Generate (or don't) code for the GNU linker.  This is the default.
18583 @c Also, this is the default if the configure option @option{--with-gnu-ld}
18584 @c is used.
18586 @item -mno-pic
18587 @opindex mno-pic
18588 Generate code that does not use a global pointer register.  The result
18589 is not position independent code, and violates the IA-64 ABI@.
18591 @item -mvolatile-asm-stop
18592 @itemx -mno-volatile-asm-stop
18593 @opindex mvolatile-asm-stop
18594 @opindex mno-volatile-asm-stop
18595 Generate (or don't) a stop bit immediately before and after volatile asm
18596 statements.
18598 @item -mregister-names
18599 @itemx -mno-register-names
18600 @opindex mregister-names
18601 @opindex mno-register-names
18602 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
18603 the stacked registers.  This may make assembler output more readable.
18605 @item -mno-sdata
18606 @itemx -msdata
18607 @opindex mno-sdata
18608 @opindex msdata
18609 Disable (or enable) optimizations that use the small data section.  This may
18610 be useful for working around optimizer bugs.
18612 @item -mconstant-gp
18613 @opindex mconstant-gp
18614 Generate code that uses a single constant global pointer value.  This is
18615 useful when compiling kernel code.
18617 @item -mauto-pic
18618 @opindex mauto-pic
18619 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
18620 This is useful when compiling firmware code.
18622 @item -minline-float-divide-min-latency
18623 @opindex minline-float-divide-min-latency
18624 Generate code for inline divides of floating-point values
18625 using the minimum latency algorithm.
18627 @item -minline-float-divide-max-throughput
18628 @opindex minline-float-divide-max-throughput
18629 Generate code for inline divides of floating-point values
18630 using the maximum throughput algorithm.
18632 @item -mno-inline-float-divide
18633 @opindex mno-inline-float-divide
18634 Do not generate inline code for divides of floating-point values.
18636 @item -minline-int-divide-min-latency
18637 @opindex minline-int-divide-min-latency
18638 Generate code for inline divides of integer values
18639 using the minimum latency algorithm.
18641 @item -minline-int-divide-max-throughput
18642 @opindex minline-int-divide-max-throughput
18643 Generate code for inline divides of integer values
18644 using the maximum throughput algorithm.
18646 @item -mno-inline-int-divide
18647 @opindex mno-inline-int-divide
18648 Do not generate inline code for divides of integer values.
18650 @item -minline-sqrt-min-latency
18651 @opindex minline-sqrt-min-latency
18652 Generate code for inline square roots
18653 using the minimum latency algorithm.
18655 @item -minline-sqrt-max-throughput
18656 @opindex minline-sqrt-max-throughput
18657 Generate code for inline square roots
18658 using the maximum throughput algorithm.
18660 @item -mno-inline-sqrt
18661 @opindex mno-inline-sqrt
18662 Do not generate inline code for @code{sqrt}.
18664 @item -mfused-madd
18665 @itemx -mno-fused-madd
18666 @opindex mfused-madd
18667 @opindex mno-fused-madd
18668 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
18669 instructions.  The default is to use these instructions.
18671 @item -mno-dwarf2-asm
18672 @itemx -mdwarf2-asm
18673 @opindex mno-dwarf2-asm
18674 @opindex mdwarf2-asm
18675 Don't (or do) generate assembler code for the DWARF line number debugging
18676 info.  This may be useful when not using the GNU assembler.
18678 @item -mearly-stop-bits
18679 @itemx -mno-early-stop-bits
18680 @opindex mearly-stop-bits
18681 @opindex mno-early-stop-bits
18682 Allow stop bits to be placed earlier than immediately preceding the
18683 instruction that triggered the stop bit.  This can improve instruction
18684 scheduling, but does not always do so.
18686 @item -mfixed-range=@var{register-range}
18687 @opindex mfixed-range
18688 Generate code treating the given register range as fixed registers.
18689 A fixed register is one that the register allocator cannot use.  This is
18690 useful when compiling kernel code.  A register range is specified as
18691 two registers separated by a dash.  Multiple register ranges can be
18692 specified separated by a comma.
18694 @item -mtls-size=@var{tls-size}
18695 @opindex mtls-size
18696 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
18699 @item -mtune=@var{cpu-type}
18700 @opindex mtune
18701 Tune the instruction scheduling for a particular CPU, Valid values are
18702 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
18703 and @samp{mckinley}.
18705 @item -milp32
18706 @itemx -mlp64
18707 @opindex milp32
18708 @opindex mlp64
18709 Generate code for a 32-bit or 64-bit environment.
18710 The 32-bit environment sets int, long and pointer to 32 bits.
18711 The 64-bit environment sets int to 32 bits and long and pointer
18712 to 64 bits.  These are HP-UX specific flags.
18714 @item -mno-sched-br-data-spec
18715 @itemx -msched-br-data-spec
18716 @opindex mno-sched-br-data-spec
18717 @opindex msched-br-data-spec
18718 (Dis/En)able data speculative scheduling before reload.
18719 This results in generation of @code{ld.a} instructions and
18720 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
18721 The default setting is disabled.
18723 @item -msched-ar-data-spec
18724 @itemx -mno-sched-ar-data-spec
18725 @opindex msched-ar-data-spec
18726 @opindex mno-sched-ar-data-spec
18727 (En/Dis)able data speculative scheduling after reload.
18728 This results in generation of @code{ld.a} instructions and
18729 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
18730 The default setting is enabled.
18732 @item -mno-sched-control-spec
18733 @itemx -msched-control-spec
18734 @opindex mno-sched-control-spec
18735 @opindex msched-control-spec
18736 (Dis/En)able control speculative scheduling.  This feature is
18737 available only during region scheduling (i.e.@: before reload).
18738 This results in generation of the @code{ld.s} instructions and
18739 the corresponding check instructions @code{chk.s}.
18740 The default setting is disabled.
18742 @item -msched-br-in-data-spec
18743 @itemx -mno-sched-br-in-data-spec
18744 @opindex msched-br-in-data-spec
18745 @opindex mno-sched-br-in-data-spec
18746 (En/Dis)able speculative scheduling of the instructions that
18747 are dependent on the data speculative loads before reload.
18748 This is effective only with @option{-msched-br-data-spec} enabled.
18749 The default setting is enabled.
18751 @item -msched-ar-in-data-spec
18752 @itemx -mno-sched-ar-in-data-spec
18753 @opindex msched-ar-in-data-spec
18754 @opindex mno-sched-ar-in-data-spec
18755 (En/Dis)able speculative scheduling of the instructions that
18756 are dependent on the data speculative loads after reload.
18757 This is effective only with @option{-msched-ar-data-spec} enabled.
18758 The default setting is enabled.
18760 @item -msched-in-control-spec
18761 @itemx -mno-sched-in-control-spec
18762 @opindex msched-in-control-spec
18763 @opindex mno-sched-in-control-spec
18764 (En/Dis)able speculative scheduling of the instructions that
18765 are dependent on the control speculative loads.
18766 This is effective only with @option{-msched-control-spec} enabled.
18767 The default setting is enabled.
18769 @item -mno-sched-prefer-non-data-spec-insns
18770 @itemx -msched-prefer-non-data-spec-insns
18771 @opindex mno-sched-prefer-non-data-spec-insns
18772 @opindex msched-prefer-non-data-spec-insns
18773 If enabled, data-speculative instructions are chosen for schedule
18774 only if there are no other choices at the moment.  This makes
18775 the use of the data speculation much more conservative.
18776 The default setting is disabled.
18778 @item -mno-sched-prefer-non-control-spec-insns
18779 @itemx -msched-prefer-non-control-spec-insns
18780 @opindex mno-sched-prefer-non-control-spec-insns
18781 @opindex msched-prefer-non-control-spec-insns
18782 If enabled, control-speculative instructions are chosen for schedule
18783 only if there are no other choices at the moment.  This makes
18784 the use of the control speculation much more conservative.
18785 The default setting is disabled.
18787 @item -mno-sched-count-spec-in-critical-path
18788 @itemx -msched-count-spec-in-critical-path
18789 @opindex mno-sched-count-spec-in-critical-path
18790 @opindex msched-count-spec-in-critical-path
18791 If enabled, speculative dependencies are considered during
18792 computation of the instructions priorities.  This makes the use of the
18793 speculation a bit more conservative.
18794 The default setting is disabled.
18796 @item -msched-spec-ldc
18797 @opindex msched-spec-ldc
18798 Use a simple data speculation check.  This option is on by default.
18800 @item -msched-control-spec-ldc
18801 @opindex msched-spec-ldc
18802 Use a simple check for control speculation.  This option is on by default.
18804 @item -msched-stop-bits-after-every-cycle
18805 @opindex msched-stop-bits-after-every-cycle
18806 Place a stop bit after every cycle when scheduling.  This option is on
18807 by default.
18809 @item -msched-fp-mem-deps-zero-cost
18810 @opindex msched-fp-mem-deps-zero-cost
18811 Assume that floating-point stores and loads are not likely to cause a conflict
18812 when placed into the same instruction group.  This option is disabled by
18813 default.
18815 @item -msel-sched-dont-check-control-spec
18816 @opindex msel-sched-dont-check-control-spec
18817 Generate checks for control speculation in selective scheduling.
18818 This flag is disabled by default.
18820 @item -msched-max-memory-insns=@var{max-insns}
18821 @opindex msched-max-memory-insns
18822 Limit on the number of memory insns per instruction group, giving lower
18823 priority to subsequent memory insns attempting to schedule in the same
18824 instruction group. Frequently useful to prevent cache bank conflicts.
18825 The default value is 1.
18827 @item -msched-max-memory-insns-hard-limit
18828 @opindex msched-max-memory-insns-hard-limit
18829 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
18830 disallowing more than that number in an instruction group.
18831 Otherwise, the limit is ``soft'', meaning that non-memory operations
18832 are preferred when the limit is reached, but memory operations may still
18833 be scheduled.
18835 @end table
18837 @node LM32 Options
18838 @subsection LM32 Options
18839 @cindex LM32 options
18841 These @option{-m} options are defined for the LatticeMico32 architecture:
18843 @table @gcctabopt
18844 @item -mbarrel-shift-enabled
18845 @opindex mbarrel-shift-enabled
18846 Enable barrel-shift instructions.
18848 @item -mdivide-enabled
18849 @opindex mdivide-enabled
18850 Enable divide and modulus instructions.
18852 @item -mmultiply-enabled
18853 @opindex multiply-enabled
18854 Enable multiply instructions.
18856 @item -msign-extend-enabled
18857 @opindex msign-extend-enabled
18858 Enable sign extend instructions.
18860 @item -muser-enabled
18861 @opindex muser-enabled
18862 Enable user-defined instructions.
18864 @end table
18866 @node M32C Options
18867 @subsection M32C Options
18868 @cindex M32C options
18870 @table @gcctabopt
18871 @item -mcpu=@var{name}
18872 @opindex mcpu=
18873 Select the CPU for which code is generated.  @var{name} may be one of
18874 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
18875 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
18876 the M32C/80 series.
18878 @item -msim
18879 @opindex msim
18880 Specifies that the program will be run on the simulator.  This causes
18881 an alternate runtime library to be linked in which supports, for
18882 example, file I/O@.  You must not use this option when generating
18883 programs that will run on real hardware; you must provide your own
18884 runtime library for whatever I/O functions are needed.
18886 @item -memregs=@var{number}
18887 @opindex memregs=
18888 Specifies the number of memory-based pseudo-registers GCC uses
18889 during code generation.  These pseudo-registers are used like real
18890 registers, so there is a tradeoff between GCC's ability to fit the
18891 code into available registers, and the performance penalty of using
18892 memory instead of registers.  Note that all modules in a program must
18893 be compiled with the same value for this option.  Because of that, you
18894 must not use this option with GCC's default runtime libraries.
18896 @end table
18898 @node M32R/D Options
18899 @subsection M32R/D Options
18900 @cindex M32R/D options
18902 These @option{-m} options are defined for Renesas M32R/D architectures:
18904 @table @gcctabopt
18905 @item -m32r2
18906 @opindex m32r2
18907 Generate code for the M32R/2@.
18909 @item -m32rx
18910 @opindex m32rx
18911 Generate code for the M32R/X@.
18913 @item -m32r
18914 @opindex m32r
18915 Generate code for the M32R@.  This is the default.
18917 @item -mmodel=small
18918 @opindex mmodel=small
18919 Assume all objects live in the lower 16MB of memory (so that their addresses
18920 can be loaded with the @code{ld24} instruction), and assume all subroutines
18921 are reachable with the @code{bl} instruction.
18922 This is the default.
18924 The addressability of a particular object can be set with the
18925 @code{model} attribute.
18927 @item -mmodel=medium
18928 @opindex mmodel=medium
18929 Assume objects may be anywhere in the 32-bit address space (the compiler
18930 generates @code{seth/add3} instructions to load their addresses), and
18931 assume all subroutines are reachable with the @code{bl} instruction.
18933 @item -mmodel=large
18934 @opindex mmodel=large
18935 Assume objects may be anywhere in the 32-bit address space (the compiler
18936 generates @code{seth/add3} instructions to load their addresses), and
18937 assume subroutines may not be reachable with the @code{bl} instruction
18938 (the compiler generates the much slower @code{seth/add3/jl}
18939 instruction sequence).
18941 @item -msdata=none
18942 @opindex msdata=none
18943 Disable use of the small data area.  Variables are put into
18944 one of @code{.data}, @code{.bss}, or @code{.rodata} (unless the
18945 @code{section} attribute has been specified).
18946 This is the default.
18948 The small data area consists of sections @code{.sdata} and @code{.sbss}.
18949 Objects may be explicitly put in the small data area with the
18950 @code{section} attribute using one of these sections.
18952 @item -msdata=sdata
18953 @opindex msdata=sdata
18954 Put small global and static data in the small data area, but do not
18955 generate special code to reference them.
18957 @item -msdata=use
18958 @opindex msdata=use
18959 Put small global and static data in the small data area, and generate
18960 special instructions to reference them.
18962 @item -G @var{num}
18963 @opindex G
18964 @cindex smaller data references
18965 Put global and static objects less than or equal to @var{num} bytes
18966 into the small data or BSS sections instead of the normal data or BSS
18967 sections.  The default value of @var{num} is 8.
18968 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
18969 for this option to have any effect.
18971 All modules should be compiled with the same @option{-G @var{num}} value.
18972 Compiling with different values of @var{num} may or may not work; if it
18973 doesn't the linker gives an error message---incorrect code is not
18974 generated.
18976 @item -mdebug
18977 @opindex mdebug
18978 Makes the M32R-specific code in the compiler display some statistics
18979 that might help in debugging programs.
18981 @item -malign-loops
18982 @opindex malign-loops
18983 Align all loops to a 32-byte boundary.
18985 @item -mno-align-loops
18986 @opindex mno-align-loops
18987 Do not enforce a 32-byte alignment for loops.  This is the default.
18989 @item -missue-rate=@var{number}
18990 @opindex missue-rate=@var{number}
18991 Issue @var{number} instructions per cycle.  @var{number} can only be 1
18992 or 2.
18994 @item -mbranch-cost=@var{number}
18995 @opindex mbranch-cost=@var{number}
18996 @var{number} can only be 1 or 2.  If it is 1 then branches are
18997 preferred over conditional code, if it is 2, then the opposite applies.
18999 @item -mflush-trap=@var{number}
19000 @opindex mflush-trap=@var{number}
19001 Specifies the trap number to use to flush the cache.  The default is
19002 12.  Valid numbers are between 0 and 15 inclusive.
19004 @item -mno-flush-trap
19005 @opindex mno-flush-trap
19006 Specifies that the cache cannot be flushed by using a trap.
19008 @item -mflush-func=@var{name}
19009 @opindex mflush-func=@var{name}
19010 Specifies the name of the operating system function to call to flush
19011 the cache.  The default is @samp{_flush_cache}, but a function call
19012 is only used if a trap is not available.
19014 @item -mno-flush-func
19015 @opindex mno-flush-func
19016 Indicates that there is no OS function for flushing the cache.
19018 @end table
19020 @node M680x0 Options
19021 @subsection M680x0 Options
19022 @cindex M680x0 options
19024 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
19025 The default settings depend on which architecture was selected when
19026 the compiler was configured; the defaults for the most common choices
19027 are given below.
19029 @table @gcctabopt
19030 @item -march=@var{arch}
19031 @opindex march
19032 Generate code for a specific M680x0 or ColdFire instruction set
19033 architecture.  Permissible values of @var{arch} for M680x0
19034 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
19035 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
19036 architectures are selected according to Freescale's ISA classification
19037 and the permissible values are: @samp{isaa}, @samp{isaaplus},
19038 @samp{isab} and @samp{isac}.
19040 GCC defines a macro @code{__mcf@var{arch}__} whenever it is generating
19041 code for a ColdFire target.  The @var{arch} in this macro is one of the
19042 @option{-march} arguments given above.
19044 When used together, @option{-march} and @option{-mtune} select code
19045 that runs on a family of similar processors but that is optimized
19046 for a particular microarchitecture.
19048 @item -mcpu=@var{cpu}
19049 @opindex mcpu
19050 Generate code for a specific M680x0 or ColdFire processor.
19051 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
19052 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
19053 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
19054 below, which also classifies the CPUs into families:
19056 @multitable @columnfractions 0.20 0.80
19057 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
19058 @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}
19059 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
19060 @item @samp{5206e} @tab @samp{5206e}
19061 @item @samp{5208} @tab @samp{5207} @samp{5208}
19062 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
19063 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
19064 @item @samp{5216} @tab @samp{5214} @samp{5216}
19065 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
19066 @item @samp{5225} @tab @samp{5224} @samp{5225}
19067 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
19068 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
19069 @item @samp{5249} @tab @samp{5249}
19070 @item @samp{5250} @tab @samp{5250}
19071 @item @samp{5271} @tab @samp{5270} @samp{5271}
19072 @item @samp{5272} @tab @samp{5272}
19073 @item @samp{5275} @tab @samp{5274} @samp{5275}
19074 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
19075 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
19076 @item @samp{5307} @tab @samp{5307}
19077 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
19078 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
19079 @item @samp{5407} @tab @samp{5407}
19080 @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}
19081 @end multitable
19083 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
19084 @var{arch} is compatible with @var{cpu}.  Other combinations of
19085 @option{-mcpu} and @option{-march} are rejected.
19087 GCC defines the macro @code{__mcf_cpu_@var{cpu}} when ColdFire target
19088 @var{cpu} is selected.  It also defines @code{__mcf_family_@var{family}},
19089 where the value of @var{family} is given by the table above.
19091 @item -mtune=@var{tune}
19092 @opindex mtune
19093 Tune the code for a particular microarchitecture within the
19094 constraints set by @option{-march} and @option{-mcpu}.
19095 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
19096 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
19097 and @samp{cpu32}.  The ColdFire microarchitectures
19098 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
19100 You can also use @option{-mtune=68020-40} for code that needs
19101 to run relatively well on 68020, 68030 and 68040 targets.
19102 @option{-mtune=68020-60} is similar but includes 68060 targets
19103 as well.  These two options select the same tuning decisions as
19104 @option{-m68020-40} and @option{-m68020-60} respectively.
19106 GCC defines the macros @code{__mc@var{arch}} and @code{__mc@var{arch}__}
19107 when tuning for 680x0 architecture @var{arch}.  It also defines
19108 @code{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
19109 option is used.  If GCC is tuning for a range of architectures,
19110 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
19111 it defines the macros for every architecture in the range.
19113 GCC also defines the macro @code{__m@var{uarch}__} when tuning for
19114 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
19115 of the arguments given above.
19117 @item -m68000
19118 @itemx -mc68000
19119 @opindex m68000
19120 @opindex mc68000
19121 Generate output for a 68000.  This is the default
19122 when the compiler is configured for 68000-based systems.
19123 It is equivalent to @option{-march=68000}.
19125 Use this option for microcontrollers with a 68000 or EC000 core,
19126 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
19128 @item -m68010
19129 @opindex m68010
19130 Generate output for a 68010.  This is the default
19131 when the compiler is configured for 68010-based systems.
19132 It is equivalent to @option{-march=68010}.
19134 @item -m68020
19135 @itemx -mc68020
19136 @opindex m68020
19137 @opindex mc68020
19138 Generate output for a 68020.  This is the default
19139 when the compiler is configured for 68020-based systems.
19140 It is equivalent to @option{-march=68020}.
19142 @item -m68030
19143 @opindex m68030
19144 Generate output for a 68030.  This is the default when the compiler is
19145 configured for 68030-based systems.  It is equivalent to
19146 @option{-march=68030}.
19148 @item -m68040
19149 @opindex m68040
19150 Generate output for a 68040.  This is the default when the compiler is
19151 configured for 68040-based systems.  It is equivalent to
19152 @option{-march=68040}.
19154 This option inhibits the use of 68881/68882 instructions that have to be
19155 emulated by software on the 68040.  Use this option if your 68040 does not
19156 have code to emulate those instructions.
19158 @item -m68060
19159 @opindex m68060
19160 Generate output for a 68060.  This is the default when the compiler is
19161 configured for 68060-based systems.  It is equivalent to
19162 @option{-march=68060}.
19164 This option inhibits the use of 68020 and 68881/68882 instructions that
19165 have to be emulated by software on the 68060.  Use this option if your 68060
19166 does not have code to emulate those instructions.
19168 @item -mcpu32
19169 @opindex mcpu32
19170 Generate output for a CPU32.  This is the default
19171 when the compiler is configured for CPU32-based systems.
19172 It is equivalent to @option{-march=cpu32}.
19174 Use this option for microcontrollers with a
19175 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
19176 68336, 68340, 68341, 68349 and 68360.
19178 @item -m5200
19179 @opindex m5200
19180 Generate output for a 520X ColdFire CPU@.  This is the default
19181 when the compiler is configured for 520X-based systems.
19182 It is equivalent to @option{-mcpu=5206}, and is now deprecated
19183 in favor of that option.
19185 Use this option for microcontroller with a 5200 core, including
19186 the MCF5202, MCF5203, MCF5204 and MCF5206.
19188 @item -m5206e
19189 @opindex m5206e
19190 Generate output for a 5206e ColdFire CPU@.  The option is now
19191 deprecated in favor of the equivalent @option{-mcpu=5206e}.
19193 @item -m528x
19194 @opindex m528x
19195 Generate output for a member of the ColdFire 528X family.
19196 The option is now deprecated in favor of the equivalent
19197 @option{-mcpu=528x}.
19199 @item -m5307
19200 @opindex m5307
19201 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
19202 in favor of the equivalent @option{-mcpu=5307}.
19204 @item -m5407
19205 @opindex m5407
19206 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
19207 in favor of the equivalent @option{-mcpu=5407}.
19209 @item -mcfv4e
19210 @opindex mcfv4e
19211 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
19212 This includes use of hardware floating-point instructions.
19213 The option is equivalent to @option{-mcpu=547x}, and is now
19214 deprecated in favor of that option.
19216 @item -m68020-40
19217 @opindex m68020-40
19218 Generate output for a 68040, without using any of the new instructions.
19219 This results in code that can run relatively efficiently on either a
19220 68020/68881 or a 68030 or a 68040.  The generated code does use the
19221 68881 instructions that are emulated on the 68040.
19223 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
19225 @item -m68020-60
19226 @opindex m68020-60
19227 Generate output for a 68060, without using any of the new instructions.
19228 This results in code that can run relatively efficiently on either a
19229 68020/68881 or a 68030 or a 68040.  The generated code does use the
19230 68881 instructions that are emulated on the 68060.
19232 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
19234 @item -mhard-float
19235 @itemx -m68881
19236 @opindex mhard-float
19237 @opindex m68881
19238 Generate floating-point instructions.  This is the default for 68020
19239 and above, and for ColdFire devices that have an FPU@.  It defines the
19240 macro @code{__HAVE_68881__} on M680x0 targets and @code{__mcffpu__}
19241 on ColdFire targets.
19243 @item -msoft-float
19244 @opindex msoft-float
19245 Do not generate floating-point instructions; use library calls instead.
19246 This is the default for 68000, 68010, and 68832 targets.  It is also
19247 the default for ColdFire devices that have no FPU.
19249 @item -mdiv
19250 @itemx -mno-div
19251 @opindex mdiv
19252 @opindex mno-div
19253 Generate (do not generate) ColdFire hardware divide and remainder
19254 instructions.  If @option{-march} is used without @option{-mcpu},
19255 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
19256 architectures.  Otherwise, the default is taken from the target CPU
19257 (either the default CPU, or the one specified by @option{-mcpu}).  For
19258 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
19259 @option{-mcpu=5206e}.
19261 GCC defines the macro @code{__mcfhwdiv__} when this option is enabled.
19263 @item -mshort
19264 @opindex mshort
19265 Consider type @code{int} to be 16 bits wide, like @code{short int}.
19266 Additionally, parameters passed on the stack are also aligned to a
19267 16-bit boundary even on targets whose API mandates promotion to 32-bit.
19269 @item -mno-short
19270 @opindex mno-short
19271 Do not consider type @code{int} to be 16 bits wide.  This is the default.
19273 @item -mnobitfield
19274 @itemx -mno-bitfield
19275 @opindex mnobitfield
19276 @opindex mno-bitfield
19277 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
19278 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
19280 @item -mbitfield
19281 @opindex mbitfield
19282 Do use the bit-field instructions.  The @option{-m68020} option implies
19283 @option{-mbitfield}.  This is the default if you use a configuration
19284 designed for a 68020.
19286 @item -mrtd
19287 @opindex mrtd
19288 Use a different function-calling convention, in which functions
19289 that take a fixed number of arguments return with the @code{rtd}
19290 instruction, which pops their arguments while returning.  This
19291 saves one instruction in the caller since there is no need to pop
19292 the arguments there.
19294 This calling convention is incompatible with the one normally
19295 used on Unix, so you cannot use it if you need to call libraries
19296 compiled with the Unix compiler.
19298 Also, you must provide function prototypes for all functions that
19299 take variable numbers of arguments (including @code{printf});
19300 otherwise incorrect code is generated for calls to those
19301 functions.
19303 In addition, seriously incorrect code results if you call a
19304 function with too many arguments.  (Normally, extra arguments are
19305 harmlessly ignored.)
19307 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
19308 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
19310 @item -mno-rtd
19311 @opindex mno-rtd
19312 Do not use the calling conventions selected by @option{-mrtd}.
19313 This is the default.
19315 @item -malign-int
19316 @itemx -mno-align-int
19317 @opindex malign-int
19318 @opindex mno-align-int
19319 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
19320 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
19321 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
19322 Aligning variables on 32-bit boundaries produces code that runs somewhat
19323 faster on processors with 32-bit busses at the expense of more memory.
19325 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
19326 aligns structures containing the above types differently than
19327 most published application binary interface specifications for the m68k.
19329 @item -mpcrel
19330 @opindex mpcrel
19331 Use the pc-relative addressing mode of the 68000 directly, instead of
19332 using a global offset table.  At present, this option implies @option{-fpic},
19333 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
19334 not presently supported with @option{-mpcrel}, though this could be supported for
19335 68020 and higher processors.
19337 @item -mno-strict-align
19338 @itemx -mstrict-align
19339 @opindex mno-strict-align
19340 @opindex mstrict-align
19341 Do not (do) assume that unaligned memory references are handled by
19342 the system.
19344 @item -msep-data
19345 Generate code that allows the data segment to be located in a different
19346 area of memory from the text segment.  This allows for execute-in-place in
19347 an environment without virtual memory management.  This option implies
19348 @option{-fPIC}.
19350 @item -mno-sep-data
19351 Generate code that assumes that the data segment follows the text segment.
19352 This is the default.
19354 @item -mid-shared-library
19355 Generate code that supports shared libraries via the library ID method.
19356 This allows for execute-in-place and shared libraries in an environment
19357 without virtual memory management.  This option implies @option{-fPIC}.
19359 @item -mno-id-shared-library
19360 Generate code that doesn't assume ID-based shared libraries are being used.
19361 This is the default.
19363 @item -mshared-library-id=n
19364 Specifies the identification number of the ID-based shared library being
19365 compiled.  Specifying a value of 0 generates more compact code; specifying
19366 other values forces the allocation of that number to the current
19367 library, but is no more space- or time-efficient than omitting this option.
19369 @item -mxgot
19370 @itemx -mno-xgot
19371 @opindex mxgot
19372 @opindex mno-xgot
19373 When generating position-independent code for ColdFire, generate code
19374 that works if the GOT has more than 8192 entries.  This code is
19375 larger and slower than code generated without this option.  On M680x0
19376 processors, this option is not needed; @option{-fPIC} suffices.
19378 GCC normally uses a single instruction to load values from the GOT@.
19379 While this is relatively efficient, it only works if the GOT
19380 is smaller than about 64k.  Anything larger causes the linker
19381 to report an error such as:
19383 @cindex relocation truncated to fit (ColdFire)
19384 @smallexample
19385 relocation truncated to fit: R_68K_GOT16O foobar
19386 @end smallexample
19388 If this happens, you should recompile your code with @option{-mxgot}.
19389 It should then work with very large GOTs.  However, code generated with
19390 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
19391 the value of a global symbol.
19393 Note that some linkers, including newer versions of the GNU linker,
19394 can create multiple GOTs and sort GOT entries.  If you have such a linker,
19395 you should only need to use @option{-mxgot} when compiling a single
19396 object file that accesses more than 8192 GOT entries.  Very few do.
19398 These options have no effect unless GCC is generating
19399 position-independent code.
19401 @item -mlong-jump-table-offsets
19402 @opindex mlong-jump-table-offsets
19403 Use 32-bit offsets in @code{switch} tables.  The default is to use
19404 16-bit offsets.
19406 @end table
19408 @node MCore Options
19409 @subsection MCore Options
19410 @cindex MCore options
19412 These are the @samp{-m} options defined for the Motorola M*Core
19413 processors.
19415 @table @gcctabopt
19417 @item -mhardlit
19418 @itemx -mno-hardlit
19419 @opindex mhardlit
19420 @opindex mno-hardlit
19421 Inline constants into the code stream if it can be done in two
19422 instructions or less.
19424 @item -mdiv
19425 @itemx -mno-div
19426 @opindex mdiv
19427 @opindex mno-div
19428 Use the divide instruction.  (Enabled by default).
19430 @item -mrelax-immediate
19431 @itemx -mno-relax-immediate
19432 @opindex mrelax-immediate
19433 @opindex mno-relax-immediate
19434 Allow arbitrary-sized immediates in bit operations.
19436 @item -mwide-bitfields
19437 @itemx -mno-wide-bitfields
19438 @opindex mwide-bitfields
19439 @opindex mno-wide-bitfields
19440 Always treat bit-fields as @code{int}-sized.
19442 @item -m4byte-functions
19443 @itemx -mno-4byte-functions
19444 @opindex m4byte-functions
19445 @opindex mno-4byte-functions
19446 Force all functions to be aligned to a 4-byte boundary.
19448 @item -mcallgraph-data
19449 @itemx -mno-callgraph-data
19450 @opindex mcallgraph-data
19451 @opindex mno-callgraph-data
19452 Emit callgraph information.
19454 @item -mslow-bytes
19455 @itemx -mno-slow-bytes
19456 @opindex mslow-bytes
19457 @opindex mno-slow-bytes
19458 Prefer word access when reading byte quantities.
19460 @item -mlittle-endian
19461 @itemx -mbig-endian
19462 @opindex mlittle-endian
19463 @opindex mbig-endian
19464 Generate code for a little-endian target.
19466 @item -m210
19467 @itemx -m340
19468 @opindex m210
19469 @opindex m340
19470 Generate code for the 210 processor.
19472 @item -mno-lsim
19473 @opindex mno-lsim
19474 Assume that runtime support has been provided and so omit the
19475 simulator library (@file{libsim.a)} from the linker command line.
19477 @item -mstack-increment=@var{size}
19478 @opindex mstack-increment
19479 Set the maximum amount for a single stack increment operation.  Large
19480 values can increase the speed of programs that contain functions
19481 that need a large amount of stack space, but they can also trigger a
19482 segmentation fault if the stack is extended too much.  The default
19483 value is 0x1000.
19485 @end table
19487 @node MeP Options
19488 @subsection MeP Options
19489 @cindex MeP options
19491 @table @gcctabopt
19493 @item -mabsdiff
19494 @opindex mabsdiff
19495 Enables the @code{abs} instruction, which is the absolute difference
19496 between two registers.
19498 @item -mall-opts
19499 @opindex mall-opts
19500 Enables all the optional instructions---average, multiply, divide, bit
19501 operations, leading zero, absolute difference, min/max, clip, and
19502 saturation.
19505 @item -maverage
19506 @opindex maverage
19507 Enables the @code{ave} instruction, which computes the average of two
19508 registers.
19510 @item -mbased=@var{n}
19511 @opindex mbased=
19512 Variables of size @var{n} bytes or smaller are placed in the
19513 @code{.based} section by default.  Based variables use the @code{$tp}
19514 register as a base register, and there is a 128-byte limit to the
19515 @code{.based} section.
19517 @item -mbitops
19518 @opindex mbitops
19519 Enables the bit operation instructions---bit test (@code{btstm}), set
19520 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
19521 test-and-set (@code{tas}).
19523 @item -mc=@var{name}
19524 @opindex mc=
19525 Selects which section constant data is placed in.  @var{name} may
19526 be @samp{tiny}, @samp{near}, or @samp{far}.
19528 @item -mclip
19529 @opindex mclip
19530 Enables the @code{clip} instruction.  Note that @option{-mclip} is not
19531 useful unless you also provide @option{-mminmax}.
19533 @item -mconfig=@var{name}
19534 @opindex mconfig=
19535 Selects one of the built-in core configurations.  Each MeP chip has
19536 one or more modules in it; each module has a core CPU and a variety of
19537 coprocessors, optional instructions, and peripherals.  The
19538 @code{MeP-Integrator} tool, not part of GCC, provides these
19539 configurations through this option; using this option is the same as
19540 using all the corresponding command-line options.  The default
19541 configuration is @samp{default}.
19543 @item -mcop
19544 @opindex mcop
19545 Enables the coprocessor instructions.  By default, this is a 32-bit
19546 coprocessor.  Note that the coprocessor is normally enabled via the
19547 @option{-mconfig=} option.
19549 @item -mcop32
19550 @opindex mcop32
19551 Enables the 32-bit coprocessor's instructions.
19553 @item -mcop64
19554 @opindex mcop64
19555 Enables the 64-bit coprocessor's instructions.
19557 @item -mivc2
19558 @opindex mivc2
19559 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
19561 @item -mdc
19562 @opindex mdc
19563 Causes constant variables to be placed in the @code{.near} section.
19565 @item -mdiv
19566 @opindex mdiv
19567 Enables the @code{div} and @code{divu} instructions.
19569 @item -meb
19570 @opindex meb
19571 Generate big-endian code.
19573 @item -mel
19574 @opindex mel
19575 Generate little-endian code.
19577 @item -mio-volatile
19578 @opindex mio-volatile
19579 Tells the compiler that any variable marked with the @code{io}
19580 attribute is to be considered volatile.
19582 @item -ml
19583 @opindex ml
19584 Causes variables to be assigned to the @code{.far} section by default.
19586 @item -mleadz
19587 @opindex mleadz
19588 Enables the @code{leadz} (leading zero) instruction.
19590 @item -mm
19591 @opindex mm
19592 Causes variables to be assigned to the @code{.near} section by default.
19594 @item -mminmax
19595 @opindex mminmax
19596 Enables the @code{min} and @code{max} instructions.
19598 @item -mmult
19599 @opindex mmult
19600 Enables the multiplication and multiply-accumulate instructions.
19602 @item -mno-opts
19603 @opindex mno-opts
19604 Disables all the optional instructions enabled by @option{-mall-opts}.
19606 @item -mrepeat
19607 @opindex mrepeat
19608 Enables the @code{repeat} and @code{erepeat} instructions, used for
19609 low-overhead looping.
19611 @item -ms
19612 @opindex ms
19613 Causes all variables to default to the @code{.tiny} section.  Note
19614 that there is a 65536-byte limit to this section.  Accesses to these
19615 variables use the @code{%gp} base register.
19617 @item -msatur
19618 @opindex msatur
19619 Enables the saturation instructions.  Note that the compiler does not
19620 currently generate these itself, but this option is included for
19621 compatibility with other tools, like @code{as}.
19623 @item -msdram
19624 @opindex msdram
19625 Link the SDRAM-based runtime instead of the default ROM-based runtime.
19627 @item -msim
19628 @opindex msim
19629 Link the simulator run-time libraries.
19631 @item -msimnovec
19632 @opindex msimnovec
19633 Link the simulator runtime libraries, excluding built-in support
19634 for reset and exception vectors and tables.
19636 @item -mtf
19637 @opindex mtf
19638 Causes all functions to default to the @code{.far} section.  Without
19639 this option, functions default to the @code{.near} section.
19641 @item -mtiny=@var{n}
19642 @opindex mtiny=
19643 Variables that are @var{n} bytes or smaller are allocated to the
19644 @code{.tiny} section.  These variables use the @code{$gp} base
19645 register.  The default for this option is 4, but note that there's a
19646 65536-byte limit to the @code{.tiny} section.
19648 @end table
19650 @node MicroBlaze Options
19651 @subsection MicroBlaze Options
19652 @cindex MicroBlaze Options
19654 @table @gcctabopt
19656 @item -msoft-float
19657 @opindex msoft-float
19658 Use software emulation for floating point (default).
19660 @item -mhard-float
19661 @opindex mhard-float
19662 Use hardware floating-point instructions.
19664 @item -mmemcpy
19665 @opindex mmemcpy
19666 Do not optimize block moves, use @code{memcpy}.
19668 @item -mno-clearbss
19669 @opindex mno-clearbss
19670 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
19672 @item -mcpu=@var{cpu-type}
19673 @opindex mcpu=
19674 Use features of, and schedule code for, the given CPU.
19675 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
19676 where @var{X} is a major version, @var{YY} is the minor version, and
19677 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
19678 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
19680 @item -mxl-soft-mul
19681 @opindex mxl-soft-mul
19682 Use software multiply emulation (default).
19684 @item -mxl-soft-div
19685 @opindex mxl-soft-div
19686 Use software emulation for divides (default).
19688 @item -mxl-barrel-shift
19689 @opindex mxl-barrel-shift
19690 Use the hardware barrel shifter.
19692 @item -mxl-pattern-compare
19693 @opindex mxl-pattern-compare
19694 Use pattern compare instructions.
19696 @item -msmall-divides
19697 @opindex msmall-divides
19698 Use table lookup optimization for small signed integer divisions.
19700 @item -mxl-stack-check
19701 @opindex mxl-stack-check
19702 This option is deprecated.  Use @option{-fstack-check} instead.
19704 @item -mxl-gp-opt
19705 @opindex mxl-gp-opt
19706 Use GP-relative @code{.sdata}/@code{.sbss} sections.
19708 @item -mxl-multiply-high
19709 @opindex mxl-multiply-high
19710 Use multiply high instructions for high part of 32x32 multiply.
19712 @item -mxl-float-convert
19713 @opindex mxl-float-convert
19714 Use hardware floating-point conversion instructions.
19716 @item -mxl-float-sqrt
19717 @opindex mxl-float-sqrt
19718 Use hardware floating-point square root instruction.
19720 @item -mbig-endian
19721 @opindex mbig-endian
19722 Generate code for a big-endian target.
19724 @item -mlittle-endian
19725 @opindex mlittle-endian
19726 Generate code for a little-endian target.
19728 @item -mxl-reorder
19729 @opindex mxl-reorder
19730 Use reorder instructions (swap and byte reversed load/store).
19732 @item -mxl-mode-@var{app-model}
19733 Select application model @var{app-model}.  Valid models are
19734 @table @samp
19735 @item executable
19736 normal executable (default), uses startup code @file{crt0.o}.
19738 @item xmdstub
19739 for use with Xilinx Microprocessor Debugger (XMD) based
19740 software intrusive debug agent called xmdstub. This uses startup file
19741 @file{crt1.o} and sets the start address of the program to 0x800.
19743 @item bootstrap
19744 for applications that are loaded using a bootloader.
19745 This model uses startup file @file{crt2.o} which does not contain a processor
19746 reset vector handler. This is suitable for transferring control on a
19747 processor reset to the bootloader rather than the application.
19749 @item novectors
19750 for applications that do not require any of the
19751 MicroBlaze vectors. This option may be useful for applications running
19752 within a monitoring application. This model uses @file{crt3.o} as a startup file.
19753 @end table
19755 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
19756 @option{-mxl-mode-@var{app-model}}.
19758 @end table
19760 @node MIPS Options
19761 @subsection MIPS Options
19762 @cindex MIPS options
19764 @table @gcctabopt
19766 @item -EB
19767 @opindex EB
19768 Generate big-endian code.
19770 @item -EL
19771 @opindex EL
19772 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
19773 configurations.
19775 @item -march=@var{arch}
19776 @opindex march
19777 Generate code that runs on @var{arch}, which can be the name of a
19778 generic MIPS ISA, or the name of a particular processor.
19779 The ISA names are:
19780 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
19781 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5},
19782 @samp{mips32r6}, @samp{mips64}, @samp{mips64r2}, @samp{mips64r3},
19783 @samp{mips64r5} and @samp{mips64r6}.
19784 The processor names are:
19785 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
19786 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
19787 @samp{5kc}, @samp{5kf},
19788 @samp{20kc},
19789 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
19790 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
19791 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
19792 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
19793 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
19794 @samp{i6400},
19795 @samp{interaptiv},
19796 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
19797 @samp{m4k},
19798 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
19799 @samp{m5100}, @samp{m5101},
19800 @samp{octeon}, @samp{octeon+}, @samp{octeon2}, @samp{octeon3},
19801 @samp{orion},
19802 @samp{p5600},
19803 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
19804 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
19805 @samp{rm7000}, @samp{rm9000},
19806 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
19807 @samp{sb1},
19808 @samp{sr71000},
19809 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
19810 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
19811 @samp{xlr} and @samp{xlp}.
19812 The special value @samp{from-abi} selects the
19813 most compatible architecture for the selected ABI (that is,
19814 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
19816 The native Linux/GNU toolchain also supports the value @samp{native},
19817 which selects the best architecture option for the host processor.
19818 @option{-march=native} has no effect if GCC does not recognize
19819 the processor.
19821 In processor names, a final @samp{000} can be abbreviated as @samp{k}
19822 (for example, @option{-march=r2k}).  Prefixes are optional, and
19823 @samp{vr} may be written @samp{r}.
19825 Names of the form @samp{@var{n}f2_1} refer to processors with
19826 FPUs clocked at half the rate of the core, names of the form
19827 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
19828 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
19829 processors with FPUs clocked a ratio of 3:2 with respect to the core.
19830 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
19831 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
19832 accepted as synonyms for @samp{@var{n}f1_1}.
19834 GCC defines two macros based on the value of this option.  The first
19835 is @code{_MIPS_ARCH}, which gives the name of target architecture, as
19836 a string.  The second has the form @code{_MIPS_ARCH_@var{foo}},
19837 where @var{foo} is the capitalized value of @code{_MIPS_ARCH}@.
19838 For example, @option{-march=r2000} sets @code{_MIPS_ARCH}
19839 to @code{"r2000"} and defines the macro @code{_MIPS_ARCH_R2000}.
19841 Note that the @code{_MIPS_ARCH} macro uses the processor names given
19842 above.  In other words, it has the full prefix and does not
19843 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
19844 the macro names the resolved architecture (either @code{"mips1"} or
19845 @code{"mips3"}).  It names the default architecture when no
19846 @option{-march} option is given.
19848 @item -mtune=@var{arch}
19849 @opindex mtune
19850 Optimize for @var{arch}.  Among other things, this option controls
19851 the way instructions are scheduled, and the perceived cost of arithmetic
19852 operations.  The list of @var{arch} values is the same as for
19853 @option{-march}.
19855 When this option is not used, GCC optimizes for the processor
19856 specified by @option{-march}.  By using @option{-march} and
19857 @option{-mtune} together, it is possible to generate code that
19858 runs on a family of processors, but optimize the code for one
19859 particular member of that family.
19861 @option{-mtune} defines the macros @code{_MIPS_TUNE} and
19862 @code{_MIPS_TUNE_@var{foo}}, which work in the same way as the
19863 @option{-march} ones described above.
19865 @item -mips1
19866 @opindex mips1
19867 Equivalent to @option{-march=mips1}.
19869 @item -mips2
19870 @opindex mips2
19871 Equivalent to @option{-march=mips2}.
19873 @item -mips3
19874 @opindex mips3
19875 Equivalent to @option{-march=mips3}.
19877 @item -mips4
19878 @opindex mips4
19879 Equivalent to @option{-march=mips4}.
19881 @item -mips32
19882 @opindex mips32
19883 Equivalent to @option{-march=mips32}.
19885 @item -mips32r3
19886 @opindex mips32r3
19887 Equivalent to @option{-march=mips32r3}.
19889 @item -mips32r5
19890 @opindex mips32r5
19891 Equivalent to @option{-march=mips32r5}.
19893 @item -mips32r6
19894 @opindex mips32r6
19895 Equivalent to @option{-march=mips32r6}.
19897 @item -mips64
19898 @opindex mips64
19899 Equivalent to @option{-march=mips64}.
19901 @item -mips64r2
19902 @opindex mips64r2
19903 Equivalent to @option{-march=mips64r2}.
19905 @item -mips64r3
19906 @opindex mips64r3
19907 Equivalent to @option{-march=mips64r3}.
19909 @item -mips64r5
19910 @opindex mips64r5
19911 Equivalent to @option{-march=mips64r5}.
19913 @item -mips64r6
19914 @opindex mips64r6
19915 Equivalent to @option{-march=mips64r6}.
19917 @item -mips16
19918 @itemx -mno-mips16
19919 @opindex mips16
19920 @opindex mno-mips16
19921 Generate (do not generate) MIPS16 code.  If GCC is targeting a
19922 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
19924 MIPS16 code generation can also be controlled on a per-function basis
19925 by means of @code{mips16} and @code{nomips16} attributes.
19926 @xref{Function Attributes}, for more information.
19928 @item -mflip-mips16
19929 @opindex mflip-mips16
19930 Generate MIPS16 code on alternating functions.  This option is provided
19931 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
19932 not intended for ordinary use in compiling user code.
19934 @item -minterlink-compressed
19935 @item -mno-interlink-compressed
19936 @opindex minterlink-compressed
19937 @opindex mno-interlink-compressed
19938 Require (do not require) that code using the standard (uncompressed) MIPS ISA
19939 be link-compatible with MIPS16 and microMIPS code, and vice versa.
19941 For example, code using the standard ISA encoding cannot jump directly
19942 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
19943 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
19944 knows that the target of the jump is not compressed.
19946 @item -minterlink-mips16
19947 @itemx -mno-interlink-mips16
19948 @opindex minterlink-mips16
19949 @opindex mno-interlink-mips16
19950 Aliases of @option{-minterlink-compressed} and
19951 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
19952 and are retained for backwards compatibility.
19954 @item -mabi=32
19955 @itemx -mabi=o64
19956 @itemx -mabi=n32
19957 @itemx -mabi=64
19958 @itemx -mabi=eabi
19959 @opindex mabi=32
19960 @opindex mabi=o64
19961 @opindex mabi=n32
19962 @opindex mabi=64
19963 @opindex mabi=eabi
19964 Generate code for the given ABI@.
19966 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
19967 generates 64-bit code when you select a 64-bit architecture, but you
19968 can use @option{-mgp32} to get 32-bit code instead.
19970 For information about the O64 ABI, see
19971 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
19973 GCC supports a variant of the o32 ABI in which floating-point registers
19974 are 64 rather than 32 bits wide.  You can select this combination with
19975 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
19976 and @code{mfhc1} instructions and is therefore only supported for
19977 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
19979 The register assignments for arguments and return values remain the
19980 same, but each scalar value is passed in a single 64-bit register
19981 rather than a pair of 32-bit registers.  For example, scalar
19982 floating-point values are returned in @samp{$f0} only, not a
19983 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
19984 remains the same in that the even-numbered double-precision registers
19985 are saved.
19987 Two additional variants of the o32 ABI are supported to enable
19988 a transition from 32-bit to 64-bit registers.  These are FPXX
19989 (@option{-mfpxx}) and FP64A (@option{-mfp64} @option{-mno-odd-spreg}).
19990 The FPXX extension mandates that all code must execute correctly
19991 when run using 32-bit or 64-bit registers.  The code can be interlinked
19992 with either FP32 or FP64, but not both.
19993 The FP64A extension is similar to the FP64 extension but forbids the
19994 use of odd-numbered single-precision registers.  This can be used
19995 in conjunction with the @code{FRE} mode of FPUs in MIPS32R5
19996 processors and allows both FP32 and FP64A code to interlink and
19997 run in the same process without changing FPU modes.
19999 @item -mabicalls
20000 @itemx -mno-abicalls
20001 @opindex mabicalls
20002 @opindex mno-abicalls
20003 Generate (do not generate) code that is suitable for SVR4-style
20004 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
20005 systems.
20007 @item -mshared
20008 @itemx -mno-shared
20009 Generate (do not generate) code that is fully position-independent,
20010 and that can therefore be linked into shared libraries.  This option
20011 only affects @option{-mabicalls}.
20013 All @option{-mabicalls} code has traditionally been position-independent,
20014 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
20015 as an extension, the GNU toolchain allows executables to use absolute
20016 accesses for locally-binding symbols.  It can also use shorter GP
20017 initialization sequences and generate direct calls to locally-defined
20018 functions.  This mode is selected by @option{-mno-shared}.
20020 @option{-mno-shared} depends on binutils 2.16 or higher and generates
20021 objects that can only be linked by the GNU linker.  However, the option
20022 does not affect the ABI of the final executable; it only affects the ABI
20023 of relocatable objects.  Using @option{-mno-shared} generally makes
20024 executables both smaller and quicker.
20026 @option{-mshared} is the default.
20028 @item -mplt
20029 @itemx -mno-plt
20030 @opindex mplt
20031 @opindex mno-plt
20032 Assume (do not assume) that the static and dynamic linkers
20033 support PLTs and copy relocations.  This option only affects
20034 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
20035 has no effect without @option{-msym32}.
20037 You can make @option{-mplt} the default by configuring
20038 GCC with @option{--with-mips-plt}.  The default is
20039 @option{-mno-plt} otherwise.
20041 @item -mxgot
20042 @itemx -mno-xgot
20043 @opindex mxgot
20044 @opindex mno-xgot
20045 Lift (do not lift) the usual restrictions on the size of the global
20046 offset table.
20048 GCC normally uses a single instruction to load values from the GOT@.
20049 While this is relatively efficient, it only works if the GOT
20050 is smaller than about 64k.  Anything larger causes the linker
20051 to report an error such as:
20053 @cindex relocation truncated to fit (MIPS)
20054 @smallexample
20055 relocation truncated to fit: R_MIPS_GOT16 foobar
20056 @end smallexample
20058 If this happens, you should recompile your code with @option{-mxgot}.
20059 This works with very large GOTs, although the code is also
20060 less efficient, since it takes three instructions to fetch the
20061 value of a global symbol.
20063 Note that some linkers can create multiple GOTs.  If you have such a
20064 linker, you should only need to use @option{-mxgot} when a single object
20065 file accesses more than 64k's worth of GOT entries.  Very few do.
20067 These options have no effect unless GCC is generating position
20068 independent code.
20070 @item -mgp32
20071 @opindex mgp32
20072 Assume that general-purpose registers are 32 bits wide.
20074 @item -mgp64
20075 @opindex mgp64
20076 Assume that general-purpose registers are 64 bits wide.
20078 @item -mfp32
20079 @opindex mfp32
20080 Assume that floating-point registers are 32 bits wide.
20082 @item -mfp64
20083 @opindex mfp64
20084 Assume that floating-point registers are 64 bits wide.
20086 @item -mfpxx
20087 @opindex mfpxx
20088 Do not assume the width of floating-point registers.
20090 @item -mhard-float
20091 @opindex mhard-float
20092 Use floating-point coprocessor instructions.
20094 @item -msoft-float
20095 @opindex msoft-float
20096 Do not use floating-point coprocessor instructions.  Implement
20097 floating-point calculations using library calls instead.
20099 @item -mno-float
20100 @opindex mno-float
20101 Equivalent to @option{-msoft-float}, but additionally asserts that the
20102 program being compiled does not perform any floating-point operations.
20103 This option is presently supported only by some bare-metal MIPS
20104 configurations, where it may select a special set of libraries
20105 that lack all floating-point support (including, for example, the
20106 floating-point @code{printf} formats).  
20107 If code compiled with @option{-mno-float} accidentally contains
20108 floating-point operations, it is likely to suffer a link-time
20109 or run-time failure.
20111 @item -msingle-float
20112 @opindex msingle-float
20113 Assume that the floating-point coprocessor only supports single-precision
20114 operations.
20116 @item -mdouble-float
20117 @opindex mdouble-float
20118 Assume that the floating-point coprocessor supports double-precision
20119 operations.  This is the default.
20121 @item -modd-spreg
20122 @itemx -mno-odd-spreg
20123 @opindex modd-spreg
20124 @opindex mno-odd-spreg
20125 Enable the use of odd-numbered single-precision floating-point registers
20126 for the o32 ABI.  This is the default for processors that are known to
20127 support these registers.  When using the o32 FPXX ABI, @option{-mno-odd-spreg}
20128 is set by default.
20130 @item -mabs=2008
20131 @itemx -mabs=legacy
20132 @opindex mabs=2008
20133 @opindex mabs=legacy
20134 These options control the treatment of the special not-a-number (NaN)
20135 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
20136 @code{neg.@i{fmt}} machine instructions.
20138 By default or when @option{-mabs=legacy} is used the legacy
20139 treatment is selected.  In this case these instructions are considered
20140 arithmetic and avoided where correct operation is required and the
20141 input operand might be a NaN.  A longer sequence of instructions that
20142 manipulate the sign bit of floating-point datum manually is used
20143 instead unless the @option{-ffinite-math-only} option has also been
20144 specified.
20146 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
20147 this case these instructions are considered non-arithmetic and therefore
20148 operating correctly in all cases, including in particular where the
20149 input operand is a NaN.  These instructions are therefore always used
20150 for the respective operations.
20152 @item -mnan=2008
20153 @itemx -mnan=legacy
20154 @opindex mnan=2008
20155 @opindex mnan=legacy
20156 These options control the encoding of the special not-a-number (NaN)
20157 IEEE 754 floating-point data.
20159 The @option{-mnan=legacy} option selects the legacy encoding.  In this
20160 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
20161 significand field being 0, whereas signaling NaNs (sNaNs) are denoted
20162 by the first bit of their trailing significand field being 1.
20164 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
20165 this case qNaNs are denoted by the first bit of their trailing
20166 significand field being 1, whereas sNaNs are denoted by the first bit of
20167 their trailing significand field being 0.
20169 The default is @option{-mnan=legacy} unless GCC has been configured with
20170 @option{--with-nan=2008}.
20172 @item -mllsc
20173 @itemx -mno-llsc
20174 @opindex mllsc
20175 @opindex mno-llsc
20176 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
20177 implement atomic memory built-in functions.  When neither option is
20178 specified, GCC uses the instructions if the target architecture
20179 supports them.
20181 @option{-mllsc} is useful if the runtime environment can emulate the
20182 instructions and @option{-mno-llsc} can be useful when compiling for
20183 nonstandard ISAs.  You can make either option the default by
20184 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
20185 respectively.  @option{--with-llsc} is the default for some
20186 configurations; see the installation documentation for details.
20188 @item -mdsp
20189 @itemx -mno-dsp
20190 @opindex mdsp
20191 @opindex mno-dsp
20192 Use (do not use) revision 1 of the MIPS DSP ASE@.
20193 @xref{MIPS DSP Built-in Functions}.  This option defines the
20194 preprocessor macro @code{__mips_dsp}.  It also defines
20195 @code{__mips_dsp_rev} to 1.
20197 @item -mdspr2
20198 @itemx -mno-dspr2
20199 @opindex mdspr2
20200 @opindex mno-dspr2
20201 Use (do not use) revision 2 of the MIPS DSP ASE@.
20202 @xref{MIPS DSP Built-in Functions}.  This option defines the
20203 preprocessor macros @code{__mips_dsp} and @code{__mips_dspr2}.
20204 It also defines @code{__mips_dsp_rev} to 2.
20206 @item -msmartmips
20207 @itemx -mno-smartmips
20208 @opindex msmartmips
20209 @opindex mno-smartmips
20210 Use (do not use) the MIPS SmartMIPS ASE.
20212 @item -mpaired-single
20213 @itemx -mno-paired-single
20214 @opindex mpaired-single
20215 @opindex mno-paired-single
20216 Use (do not use) paired-single floating-point instructions.
20217 @xref{MIPS Paired-Single Support}.  This option requires
20218 hardware floating-point support to be enabled.
20220 @item -mdmx
20221 @itemx -mno-mdmx
20222 @opindex mdmx
20223 @opindex mno-mdmx
20224 Use (do not use) MIPS Digital Media Extension instructions.
20225 This option can only be used when generating 64-bit code and requires
20226 hardware floating-point support to be enabled.
20228 @item -mips3d
20229 @itemx -mno-mips3d
20230 @opindex mips3d
20231 @opindex mno-mips3d
20232 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
20233 The option @option{-mips3d} implies @option{-mpaired-single}.
20235 @item -mmicromips
20236 @itemx -mno-micromips
20237 @opindex mmicromips
20238 @opindex mno-mmicromips
20239 Generate (do not generate) microMIPS code.
20241 MicroMIPS code generation can also be controlled on a per-function basis
20242 by means of @code{micromips} and @code{nomicromips} attributes.
20243 @xref{Function Attributes}, for more information.
20245 @item -mmt
20246 @itemx -mno-mt
20247 @opindex mmt
20248 @opindex mno-mt
20249 Use (do not use) MT Multithreading instructions.
20251 @item -mmcu
20252 @itemx -mno-mcu
20253 @opindex mmcu
20254 @opindex mno-mcu
20255 Use (do not use) the MIPS MCU ASE instructions.
20257 @item -meva
20258 @itemx -mno-eva
20259 @opindex meva
20260 @opindex mno-eva
20261 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
20263 @item -mvirt
20264 @itemx -mno-virt
20265 @opindex mvirt
20266 @opindex mno-virt
20267 Use (do not use) the MIPS Virtualization (VZ) instructions.
20269 @item -mxpa
20270 @itemx -mno-xpa
20271 @opindex mxpa
20272 @opindex mno-xpa
20273 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
20275 @item -mlong64
20276 @opindex mlong64
20277 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
20278 an explanation of the default and the way that the pointer size is
20279 determined.
20281 @item -mlong32
20282 @opindex mlong32
20283 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
20285 The default size of @code{int}s, @code{long}s and pointers depends on
20286 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
20287 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
20288 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
20289 or the same size as integer registers, whichever is smaller.
20291 @item -msym32
20292 @itemx -mno-sym32
20293 @opindex msym32
20294 @opindex mno-sym32
20295 Assume (do not assume) that all symbols have 32-bit values, regardless
20296 of the selected ABI@.  This option is useful in combination with
20297 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
20298 to generate shorter and faster references to symbolic addresses.
20300 @item -G @var{num}
20301 @opindex G
20302 Put definitions of externally-visible data in a small data section
20303 if that data is no bigger than @var{num} bytes.  GCC can then generate
20304 more efficient accesses to the data; see @option{-mgpopt} for details.
20306 The default @option{-G} option depends on the configuration.
20308 @item -mlocal-sdata
20309 @itemx -mno-local-sdata
20310 @opindex mlocal-sdata
20311 @opindex mno-local-sdata
20312 Extend (do not extend) the @option{-G} behavior to local data too,
20313 such as to static variables in C@.  @option{-mlocal-sdata} is the
20314 default for all configurations.
20316 If the linker complains that an application is using too much small data,
20317 you might want to try rebuilding the less performance-critical parts with
20318 @option{-mno-local-sdata}.  You might also want to build large
20319 libraries with @option{-mno-local-sdata}, so that the libraries leave
20320 more room for the main program.
20322 @item -mextern-sdata
20323 @itemx -mno-extern-sdata
20324 @opindex mextern-sdata
20325 @opindex mno-extern-sdata
20326 Assume (do not assume) that externally-defined data is in
20327 a small data section if the size of that data is within the @option{-G} limit.
20328 @option{-mextern-sdata} is the default for all configurations.
20330 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
20331 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
20332 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
20333 is placed in a small data section.  If @var{Var} is defined by another
20334 module, you must either compile that module with a high-enough
20335 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
20336 definition.  If @var{Var} is common, you must link the application
20337 with a high-enough @option{-G} setting.
20339 The easiest way of satisfying these restrictions is to compile
20340 and link every module with the same @option{-G} option.  However,
20341 you may wish to build a library that supports several different
20342 small data limits.  You can do this by compiling the library with
20343 the highest supported @option{-G} setting and additionally using
20344 @option{-mno-extern-sdata} to stop the library from making assumptions
20345 about externally-defined data.
20347 @item -mgpopt
20348 @itemx -mno-gpopt
20349 @opindex mgpopt
20350 @opindex mno-gpopt
20351 Use (do not use) GP-relative accesses for symbols that are known to be
20352 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
20353 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
20354 configurations.
20356 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
20357 might not hold the value of @code{_gp}.  For example, if the code is
20358 part of a library that might be used in a boot monitor, programs that
20359 call boot monitor routines pass an unknown value in @code{$gp}.
20360 (In such situations, the boot monitor itself is usually compiled
20361 with @option{-G0}.)
20363 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
20364 @option{-mno-extern-sdata}.
20366 @item -membedded-data
20367 @itemx -mno-embedded-data
20368 @opindex membedded-data
20369 @opindex mno-embedded-data
20370 Allocate variables to the read-only data section first if possible, then
20371 next in the small data section if possible, otherwise in data.  This gives
20372 slightly slower code than the default, but reduces the amount of RAM required
20373 when executing, and thus may be preferred for some embedded systems.
20375 @item -muninit-const-in-rodata
20376 @itemx -mno-uninit-const-in-rodata
20377 @opindex muninit-const-in-rodata
20378 @opindex mno-uninit-const-in-rodata
20379 Put uninitialized @code{const} variables in the read-only data section.
20380 This option is only meaningful in conjunction with @option{-membedded-data}.
20382 @item -mcode-readable=@var{setting}
20383 @opindex mcode-readable
20384 Specify whether GCC may generate code that reads from executable sections.
20385 There are three possible settings:
20387 @table @gcctabopt
20388 @item -mcode-readable=yes
20389 Instructions may freely access executable sections.  This is the
20390 default setting.
20392 @item -mcode-readable=pcrel
20393 MIPS16 PC-relative load instructions can access executable sections,
20394 but other instructions must not do so.  This option is useful on 4KSc
20395 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
20396 It is also useful on processors that can be configured to have a dual
20397 instruction/data SRAM interface and that, like the M4K, automatically
20398 redirect PC-relative loads to the instruction RAM.
20400 @item -mcode-readable=no
20401 Instructions must not access executable sections.  This option can be
20402 useful on targets that are configured to have a dual instruction/data
20403 SRAM interface but that (unlike the M4K) do not automatically redirect
20404 PC-relative loads to the instruction RAM.
20405 @end table
20407 @item -msplit-addresses
20408 @itemx -mno-split-addresses
20409 @opindex msplit-addresses
20410 @opindex mno-split-addresses
20411 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
20412 relocation operators.  This option has been superseded by
20413 @option{-mexplicit-relocs} but is retained for backwards compatibility.
20415 @item -mexplicit-relocs
20416 @itemx -mno-explicit-relocs
20417 @opindex mexplicit-relocs
20418 @opindex mno-explicit-relocs
20419 Use (do not use) assembler relocation operators when dealing with symbolic
20420 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
20421 is to use assembler macros instead.
20423 @option{-mexplicit-relocs} is the default if GCC was configured
20424 to use an assembler that supports relocation operators.
20426 @item -mcheck-zero-division
20427 @itemx -mno-check-zero-division
20428 @opindex mcheck-zero-division
20429 @opindex mno-check-zero-division
20430 Trap (do not trap) on integer division by zero.
20432 The default is @option{-mcheck-zero-division}.
20434 @item -mdivide-traps
20435 @itemx -mdivide-breaks
20436 @opindex mdivide-traps
20437 @opindex mdivide-breaks
20438 MIPS systems check for division by zero by generating either a
20439 conditional trap or a break instruction.  Using traps results in
20440 smaller code, but is only supported on MIPS II and later.  Also, some
20441 versions of the Linux kernel have a bug that prevents trap from
20442 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
20443 allow conditional traps on architectures that support them and
20444 @option{-mdivide-breaks} to force the use of breaks.
20446 The default is usually @option{-mdivide-traps}, but this can be
20447 overridden at configure time using @option{--with-divide=breaks}.
20448 Divide-by-zero checks can be completely disabled using
20449 @option{-mno-check-zero-division}.
20451 @item -mload-store-pairs
20452 @itemx -mno-load-store-pairs
20453 @opindex mload-store-pairs
20454 @opindex mno-load-store-pairs
20455 Enable (disable) an optimization that pairs consecutive load or store
20456 instructions to enable load/store bonding.  This option is enabled by
20457 default but only takes effect when the selected architecture is known
20458 to support bonding.
20460 @item -mmemcpy
20461 @itemx -mno-memcpy
20462 @opindex mmemcpy
20463 @opindex mno-memcpy
20464 Force (do not force) the use of @code{memcpy} for non-trivial block
20465 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
20466 most constant-sized copies.
20468 @item -mlong-calls
20469 @itemx -mno-long-calls
20470 @opindex mlong-calls
20471 @opindex mno-long-calls
20472 Disable (do not disable) use of the @code{jal} instruction.  Calling
20473 functions using @code{jal} is more efficient but requires the caller
20474 and callee to be in the same 256 megabyte segment.
20476 This option has no effect on abicalls code.  The default is
20477 @option{-mno-long-calls}.
20479 @item -mmad
20480 @itemx -mno-mad
20481 @opindex mmad
20482 @opindex mno-mad
20483 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
20484 instructions, as provided by the R4650 ISA@.
20486 @item -mimadd
20487 @itemx -mno-imadd
20488 @opindex mimadd
20489 @opindex mno-imadd
20490 Enable (disable) use of the @code{madd} and @code{msub} integer
20491 instructions.  The default is @option{-mimadd} on architectures
20492 that support @code{madd} and @code{msub} except for the 74k 
20493 architecture where it was found to generate slower code.
20495 @item -mfused-madd
20496 @itemx -mno-fused-madd
20497 @opindex mfused-madd
20498 @opindex mno-fused-madd
20499 Enable (disable) use of the floating-point multiply-accumulate
20500 instructions, when they are available.  The default is
20501 @option{-mfused-madd}.
20503 On the R8000 CPU when multiply-accumulate instructions are used,
20504 the intermediate product is calculated to infinite precision
20505 and is not subject to the FCSR Flush to Zero bit.  This may be
20506 undesirable in some circumstances.  On other processors the result
20507 is numerically identical to the equivalent computation using
20508 separate multiply, add, subtract and negate instructions.
20510 @item -nocpp
20511 @opindex nocpp
20512 Tell the MIPS assembler to not run its preprocessor over user
20513 assembler files (with a @samp{.s} suffix) when assembling them.
20515 @item -mfix-24k
20516 @item -mno-fix-24k
20517 @opindex mfix-24k
20518 @opindex mno-fix-24k
20519 Work around the 24K E48 (lost data on stores during refill) errata.
20520 The workarounds are implemented by the assembler rather than by GCC@.
20522 @item -mfix-r4000
20523 @itemx -mno-fix-r4000
20524 @opindex mfix-r4000
20525 @opindex mno-fix-r4000
20526 Work around certain R4000 CPU errata:
20527 @itemize @minus
20528 @item
20529 A double-word or a variable shift may give an incorrect result if executed
20530 immediately after starting an integer division.
20531 @item
20532 A double-word or a variable shift may give an incorrect result if executed
20533 while an integer multiplication is in progress.
20534 @item
20535 An integer division may give an incorrect result if started in a delay slot
20536 of a taken branch or a jump.
20537 @end itemize
20539 @item -mfix-r4400
20540 @itemx -mno-fix-r4400
20541 @opindex mfix-r4400
20542 @opindex mno-fix-r4400
20543 Work around certain R4400 CPU errata:
20544 @itemize @minus
20545 @item
20546 A double-word or a variable shift may give an incorrect result if executed
20547 immediately after starting an integer division.
20548 @end itemize
20550 @item -mfix-r10000
20551 @itemx -mno-fix-r10000
20552 @opindex mfix-r10000
20553 @opindex mno-fix-r10000
20554 Work around certain R10000 errata:
20555 @itemize @minus
20556 @item
20557 @code{ll}/@code{sc} sequences may not behave atomically on revisions
20558 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
20559 @end itemize
20561 This option can only be used if the target architecture supports
20562 branch-likely instructions.  @option{-mfix-r10000} is the default when
20563 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
20564 otherwise.
20566 @item -mfix-rm7000
20567 @itemx -mno-fix-rm7000
20568 @opindex mfix-rm7000
20569 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
20570 workarounds are implemented by the assembler rather than by GCC@.
20572 @item -mfix-vr4120
20573 @itemx -mno-fix-vr4120
20574 @opindex mfix-vr4120
20575 Work around certain VR4120 errata:
20576 @itemize @minus
20577 @item
20578 @code{dmultu} does not always produce the correct result.
20579 @item
20580 @code{div} and @code{ddiv} do not always produce the correct result if one
20581 of the operands is negative.
20582 @end itemize
20583 The workarounds for the division errata rely on special functions in
20584 @file{libgcc.a}.  At present, these functions are only provided by
20585 the @code{mips64vr*-elf} configurations.
20587 Other VR4120 errata require a NOP to be inserted between certain pairs of
20588 instructions.  These errata are handled by the assembler, not by GCC itself.
20590 @item -mfix-vr4130
20591 @opindex mfix-vr4130
20592 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
20593 workarounds are implemented by the assembler rather than by GCC,
20594 although GCC avoids using @code{mflo} and @code{mfhi} if the
20595 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
20596 instructions are available instead.
20598 @item -mfix-sb1
20599 @itemx -mno-fix-sb1
20600 @opindex mfix-sb1
20601 Work around certain SB-1 CPU core errata.
20602 (This flag currently works around the SB-1 revision 2
20603 ``F1'' and ``F2'' floating-point errata.)
20605 @item -mr10k-cache-barrier=@var{setting}
20606 @opindex mr10k-cache-barrier
20607 Specify whether GCC should insert cache barriers to avoid the
20608 side-effects of speculation on R10K processors.
20610 In common with many processors, the R10K tries to predict the outcome
20611 of a conditional branch and speculatively executes instructions from
20612 the ``taken'' branch.  It later aborts these instructions if the
20613 predicted outcome is wrong.  However, on the R10K, even aborted
20614 instructions can have side effects.
20616 This problem only affects kernel stores and, depending on the system,
20617 kernel loads.  As an example, a speculatively-executed store may load
20618 the target memory into cache and mark the cache line as dirty, even if
20619 the store itself is later aborted.  If a DMA operation writes to the
20620 same area of memory before the ``dirty'' line is flushed, the cached
20621 data overwrites the DMA-ed data.  See the R10K processor manual
20622 for a full description, including other potential problems.
20624 One workaround is to insert cache barrier instructions before every memory
20625 access that might be speculatively executed and that might have side
20626 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
20627 controls GCC's implementation of this workaround.  It assumes that
20628 aborted accesses to any byte in the following regions does not have
20629 side effects:
20631 @enumerate
20632 @item
20633 the memory occupied by the current function's stack frame;
20635 @item
20636 the memory occupied by an incoming stack argument;
20638 @item
20639 the memory occupied by an object with a link-time-constant address.
20640 @end enumerate
20642 It is the kernel's responsibility to ensure that speculative
20643 accesses to these regions are indeed safe.
20645 If the input program contains a function declaration such as:
20647 @smallexample
20648 void foo (void);
20649 @end smallexample
20651 then the implementation of @code{foo} must allow @code{j foo} and
20652 @code{jal foo} to be executed speculatively.  GCC honors this
20653 restriction for functions it compiles itself.  It expects non-GCC
20654 functions (such as hand-written assembly code) to do the same.
20656 The option has three forms:
20658 @table @gcctabopt
20659 @item -mr10k-cache-barrier=load-store
20660 Insert a cache barrier before a load or store that might be
20661 speculatively executed and that might have side effects even
20662 if aborted.
20664 @item -mr10k-cache-barrier=store
20665 Insert a cache barrier before a store that might be speculatively
20666 executed and that might have side effects even if aborted.
20668 @item -mr10k-cache-barrier=none
20669 Disable the insertion of cache barriers.  This is the default setting.
20670 @end table
20672 @item -mflush-func=@var{func}
20673 @itemx -mno-flush-func
20674 @opindex mflush-func
20675 Specifies the function to call to flush the I and D caches, or to not
20676 call any such function.  If called, the function must take the same
20677 arguments as the common @code{_flush_func}, that is, the address of the
20678 memory range for which the cache is being flushed, the size of the
20679 memory range, and the number 3 (to flush both caches).  The default
20680 depends on the target GCC was configured for, but commonly is either
20681 @code{_flush_func} or @code{__cpu_flush}.
20683 @item mbranch-cost=@var{num}
20684 @opindex mbranch-cost
20685 Set the cost of branches to roughly @var{num} ``simple'' instructions.
20686 This cost is only a heuristic and is not guaranteed to produce
20687 consistent results across releases.  A zero cost redundantly selects
20688 the default, which is based on the @option{-mtune} setting.
20690 @item -mbranch-likely
20691 @itemx -mno-branch-likely
20692 @opindex mbranch-likely
20693 @opindex mno-branch-likely
20694 Enable or disable use of Branch Likely instructions, regardless of the
20695 default for the selected architecture.  By default, Branch Likely
20696 instructions may be generated if they are supported by the selected
20697 architecture.  An exception is for the MIPS32 and MIPS64 architectures
20698 and processors that implement those architectures; for those, Branch
20699 Likely instructions are not be generated by default because the MIPS32
20700 and MIPS64 architectures specifically deprecate their use.
20702 @item -mcompact-branches=never
20703 @itemx -mcompact-branches=optimal
20704 @itemx -mcompact-branches=always
20705 @opindex mcompact-branches=never
20706 @opindex mcompact-branches=optimal
20707 @opindex mcompact-branches=always
20708 These options control which form of branches will be generated.  The
20709 default is @option{-mcompact-branches=optimal}.
20711 The @option{-mcompact-branches=never} option ensures that compact branch
20712 instructions will never be generated.
20714 The @option{-mcompact-branches=always} option ensures that a compact
20715 branch instruction will be generated if available.  If a compact branch
20716 instruction is not available, a delay slot form of the branch will be
20717 used instead.
20719 This option is supported from MIPS Release 6 onwards.
20721 The @option{-mcompact-branches=optimal} option will cause a delay slot
20722 branch to be used if one is available in the current ISA and the delay
20723 slot is successfully filled.  If the delay slot is not filled, a compact
20724 branch will be chosen if one is available.
20726 @item -mfp-exceptions
20727 @itemx -mno-fp-exceptions
20728 @opindex mfp-exceptions
20729 Specifies whether FP exceptions are enabled.  This affects how
20730 FP instructions are scheduled for some processors.
20731 The default is that FP exceptions are
20732 enabled.
20734 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
20735 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
20736 FP pipe.
20738 @item -mvr4130-align
20739 @itemx -mno-vr4130-align
20740 @opindex mvr4130-align
20741 The VR4130 pipeline is two-way superscalar, but can only issue two
20742 instructions together if the first one is 8-byte aligned.  When this
20743 option is enabled, GCC aligns pairs of instructions that it
20744 thinks should execute in parallel.
20746 This option only has an effect when optimizing for the VR4130.
20747 It normally makes code faster, but at the expense of making it bigger.
20748 It is enabled by default at optimization level @option{-O3}.
20750 @item -msynci
20751 @itemx -mno-synci
20752 @opindex msynci
20753 Enable (disable) generation of @code{synci} instructions on
20754 architectures that support it.  The @code{synci} instructions (if
20755 enabled) are generated when @code{__builtin___clear_cache} is
20756 compiled.
20758 This option defaults to @option{-mno-synci}, but the default can be
20759 overridden by configuring GCC with @option{--with-synci}.
20761 When compiling code for single processor systems, it is generally safe
20762 to use @code{synci}.  However, on many multi-core (SMP) systems, it
20763 does not invalidate the instruction caches on all cores and may lead
20764 to undefined behavior.
20766 @item -mrelax-pic-calls
20767 @itemx -mno-relax-pic-calls
20768 @opindex mrelax-pic-calls
20769 Try to turn PIC calls that are normally dispatched via register
20770 @code{$25} into direct calls.  This is only possible if the linker can
20771 resolve the destination at link time and if the destination is within
20772 range for a direct call.
20774 @option{-mrelax-pic-calls} is the default if GCC was configured to use
20775 an assembler and a linker that support the @code{.reloc} assembly
20776 directive and @option{-mexplicit-relocs} is in effect.  With
20777 @option{-mno-explicit-relocs}, this optimization can be performed by the
20778 assembler and the linker alone without help from the compiler.
20780 @item -mmcount-ra-address
20781 @itemx -mno-mcount-ra-address
20782 @opindex mmcount-ra-address
20783 @opindex mno-mcount-ra-address
20784 Emit (do not emit) code that allows @code{_mcount} to modify the
20785 calling function's return address.  When enabled, this option extends
20786 the usual @code{_mcount} interface with a new @var{ra-address}
20787 parameter, which has type @code{intptr_t *} and is passed in register
20788 @code{$12}.  @code{_mcount} can then modify the return address by
20789 doing both of the following:
20790 @itemize
20791 @item
20792 Returning the new address in register @code{$31}.
20793 @item
20794 Storing the new address in @code{*@var{ra-address}},
20795 if @var{ra-address} is nonnull.
20796 @end itemize
20798 The default is @option{-mno-mcount-ra-address}.
20800 @item -mframe-header-opt
20801 @itemx -mno-frame-header-opt
20802 @opindex mframe-header-opt
20803 Enable (disable) frame header optimization in the o32 ABI.  When using the
20804 o32 ABI, calling functions will allocate 16 bytes on the stack for the called
20805 function to write out register arguments.  When enabled, this optimization
20806 will suppress the allocation of the frame header if it can be determined that
20807 it is unused.
20809 This optimization is off by default at all optimization levels.
20811 @item -mlxc1-sxc1
20812 @itemx -mno-lxc1-sxc1
20813 @opindex mlxc1-sxc1
20814 When applicable, enable (disable) the generation of @code{lwxc1},
20815 @code{swxc1}, @code{ldxc1}, @code{sdxc1} instructions.  Enabled by default.
20817 @item -mmadd4
20818 @itemx -mno-madd4
20819 @opindex mmadd4
20820 When applicable, enable (disable) the generation of 4-operand @code{madd.s},
20821 @code{madd.d} and related instructions.  Enabled by default.
20823 @end table
20825 @node MMIX Options
20826 @subsection MMIX Options
20827 @cindex MMIX Options
20829 These options are defined for the MMIX:
20831 @table @gcctabopt
20832 @item -mlibfuncs
20833 @itemx -mno-libfuncs
20834 @opindex mlibfuncs
20835 @opindex mno-libfuncs
20836 Specify that intrinsic library functions are being compiled, passing all
20837 values in registers, no matter the size.
20839 @item -mepsilon
20840 @itemx -mno-epsilon
20841 @opindex mepsilon
20842 @opindex mno-epsilon
20843 Generate floating-point comparison instructions that compare with respect
20844 to the @code{rE} epsilon register.
20846 @item -mabi=mmixware
20847 @itemx -mabi=gnu
20848 @opindex mabi=mmixware
20849 @opindex mabi=gnu
20850 Generate code that passes function parameters and return values that (in
20851 the called function) are seen as registers @code{$0} and up, as opposed to
20852 the GNU ABI which uses global registers @code{$231} and up.
20854 @item -mzero-extend
20855 @itemx -mno-zero-extend
20856 @opindex mzero-extend
20857 @opindex mno-zero-extend
20858 When reading data from memory in sizes shorter than 64 bits, use (do not
20859 use) zero-extending load instructions by default, rather than
20860 sign-extending ones.
20862 @item -mknuthdiv
20863 @itemx -mno-knuthdiv
20864 @opindex mknuthdiv
20865 @opindex mno-knuthdiv
20866 Make the result of a division yielding a remainder have the same sign as
20867 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
20868 remainder follows the sign of the dividend.  Both methods are
20869 arithmetically valid, the latter being almost exclusively used.
20871 @item -mtoplevel-symbols
20872 @itemx -mno-toplevel-symbols
20873 @opindex mtoplevel-symbols
20874 @opindex mno-toplevel-symbols
20875 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
20876 code can be used with the @code{PREFIX} assembly directive.
20878 @item -melf
20879 @opindex melf
20880 Generate an executable in the ELF format, rather than the default
20881 @samp{mmo} format used by the @command{mmix} simulator.
20883 @item -mbranch-predict
20884 @itemx -mno-branch-predict
20885 @opindex mbranch-predict
20886 @opindex mno-branch-predict
20887 Use (do not use) the probable-branch instructions, when static branch
20888 prediction indicates a probable branch.
20890 @item -mbase-addresses
20891 @itemx -mno-base-addresses
20892 @opindex mbase-addresses
20893 @opindex mno-base-addresses
20894 Generate (do not generate) code that uses @emph{base addresses}.  Using a
20895 base address automatically generates a request (handled by the assembler
20896 and the linker) for a constant to be set up in a global register.  The
20897 register is used for one or more base address requests within the range 0
20898 to 255 from the value held in the register.  The generally leads to short
20899 and fast code, but the number of different data items that can be
20900 addressed is limited.  This means that a program that uses lots of static
20901 data may require @option{-mno-base-addresses}.
20903 @item -msingle-exit
20904 @itemx -mno-single-exit
20905 @opindex msingle-exit
20906 @opindex mno-single-exit
20907 Force (do not force) generated code to have a single exit point in each
20908 function.
20909 @end table
20911 @node MN10300 Options
20912 @subsection MN10300 Options
20913 @cindex MN10300 options
20915 These @option{-m} options are defined for Matsushita MN10300 architectures:
20917 @table @gcctabopt
20918 @item -mmult-bug
20919 @opindex mmult-bug
20920 Generate code to avoid bugs in the multiply instructions for the MN10300
20921 processors.  This is the default.
20923 @item -mno-mult-bug
20924 @opindex mno-mult-bug
20925 Do not generate code to avoid bugs in the multiply instructions for the
20926 MN10300 processors.
20928 @item -mam33
20929 @opindex mam33
20930 Generate code using features specific to the AM33 processor.
20932 @item -mno-am33
20933 @opindex mno-am33
20934 Do not generate code using features specific to the AM33 processor.  This
20935 is the default.
20937 @item -mam33-2
20938 @opindex mam33-2
20939 Generate code using features specific to the AM33/2.0 processor.
20941 @item -mam34
20942 @opindex mam34
20943 Generate code using features specific to the AM34 processor.
20945 @item -mtune=@var{cpu-type}
20946 @opindex mtune
20947 Use the timing characteristics of the indicated CPU type when
20948 scheduling instructions.  This does not change the targeted processor
20949 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
20950 @samp{am33-2} or @samp{am34}.
20952 @item -mreturn-pointer-on-d0
20953 @opindex mreturn-pointer-on-d0
20954 When generating a function that returns a pointer, return the pointer
20955 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
20956 only in @code{a0}, and attempts to call such functions without a prototype
20957 result in errors.  Note that this option is on by default; use
20958 @option{-mno-return-pointer-on-d0} to disable it.
20960 @item -mno-crt0
20961 @opindex mno-crt0
20962 Do not link in the C run-time initialization object file.
20964 @item -mrelax
20965 @opindex mrelax
20966 Indicate to the linker that it should perform a relaxation optimization pass
20967 to shorten branches, calls and absolute memory addresses.  This option only
20968 has an effect when used on the command line for the final link step.
20970 This option makes symbolic debugging impossible.
20972 @item -mliw
20973 @opindex mliw
20974 Allow the compiler to generate @emph{Long Instruction Word}
20975 instructions if the target is the @samp{AM33} or later.  This is the
20976 default.  This option defines the preprocessor macro @code{__LIW__}.
20978 @item -mnoliw
20979 @opindex mnoliw
20980 Do not allow the compiler to generate @emph{Long Instruction Word}
20981 instructions.  This option defines the preprocessor macro
20982 @code{__NO_LIW__}.
20984 @item -msetlb
20985 @opindex msetlb
20986 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
20987 instructions if the target is the @samp{AM33} or later.  This is the
20988 default.  This option defines the preprocessor macro @code{__SETLB__}.
20990 @item -mnosetlb
20991 @opindex mnosetlb
20992 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
20993 instructions.  This option defines the preprocessor macro
20994 @code{__NO_SETLB__}.
20996 @end table
20998 @node Moxie Options
20999 @subsection Moxie Options
21000 @cindex Moxie Options
21002 @table @gcctabopt
21004 @item -meb
21005 @opindex meb
21006 Generate big-endian code.  This is the default for @samp{moxie-*-*}
21007 configurations.
21009 @item -mel
21010 @opindex mel
21011 Generate little-endian code.
21013 @item -mmul.x
21014 @opindex mmul.x
21015 Generate mul.x and umul.x instructions.  This is the default for
21016 @samp{moxiebox-*-*} configurations.
21018 @item -mno-crt0
21019 @opindex mno-crt0
21020 Do not link in the C run-time initialization object file.
21022 @end table
21024 @node MSP430 Options
21025 @subsection MSP430 Options
21026 @cindex MSP430 Options
21028 These options are defined for the MSP430:
21030 @table @gcctabopt
21032 @item -masm-hex
21033 @opindex masm-hex
21034 Force assembly output to always use hex constants.  Normally such
21035 constants are signed decimals, but this option is available for
21036 testsuite and/or aesthetic purposes.
21038 @item -mmcu=
21039 @opindex mmcu=
21040 Select the MCU to target.  This is used to create a C preprocessor
21041 symbol based upon the MCU name, converted to upper case and pre- and
21042 post-fixed with @samp{__}.  This in turn is used by the
21043 @file{msp430.h} header file to select an MCU-specific supplementary
21044 header file.
21046 The option also sets the ISA to use.  If the MCU name is one that is
21047 known to only support the 430 ISA then that is selected, otherwise the
21048 430X ISA is selected.  A generic MCU name of @samp{msp430} can also be
21049 used to select the 430 ISA.  Similarly the generic @samp{msp430x} MCU
21050 name selects the 430X ISA.
21052 In addition an MCU-specific linker script is added to the linker
21053 command line.  The script's name is the name of the MCU with
21054 @file{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the @command{gcc}
21055 command line defines the C preprocessor symbol @code{__XXX__} and
21056 cause the linker to search for a script called @file{xxx.ld}.
21058 This option is also passed on to the assembler.
21060 @item -mwarn-mcu
21061 @itemx -mno-warn-mcu
21062 @opindex mwarn-mcu
21063 @opindex mno-warn-mcu
21064 This option enables or disables warnings about conflicts between the
21065 MCU name specified by the @option{-mmcu} option and the ISA set by the
21066 @option{-mcpu} option and/or the hardware multiply support set by the
21067 @option{-mhwmult} option.  It also toggles warnings about unrecognized
21068 MCU names.  This option is on by default.
21070 @item -mcpu=
21071 @opindex mcpu=
21072 Specifies the ISA to use.  Accepted values are @samp{msp430},
21073 @samp{msp430x} and @samp{msp430xv2}.  This option is deprecated.  The
21074 @option{-mmcu=} option should be used to select the ISA.
21076 @item -msim
21077 @opindex msim
21078 Link to the simulator runtime libraries and linker script.  Overrides
21079 any scripts that would be selected by the @option{-mmcu=} option.
21081 @item -mlarge
21082 @opindex mlarge
21083 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
21085 @item -msmall
21086 @opindex msmall
21087 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
21089 @item -mrelax
21090 @opindex mrelax
21091 This option is passed to the assembler and linker, and allows the
21092 linker to perform certain optimizations that cannot be done until
21093 the final link.
21095 @item mhwmult=
21096 @opindex mhwmult=
21097 Describes the type of hardware multiply supported by the target.
21098 Accepted values are @samp{none} for no hardware multiply, @samp{16bit}
21099 for the original 16-bit-only multiply supported by early MCUs.
21100 @samp{32bit} for the 16/32-bit multiply supported by later MCUs and
21101 @samp{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
21102 A value of @samp{auto} can also be given.  This tells GCC to deduce
21103 the hardware multiply support based upon the MCU name provided by the
21104 @option{-mmcu} option.  If no @option{-mmcu} option is specified or if
21105 the MCU name is not recognized then no hardware multiply support is
21106 assumed.  @code{auto} is the default setting.
21108 Hardware multiplies are normally performed by calling a library
21109 routine.  This saves space in the generated code.  When compiling at
21110 @option{-O3} or higher however the hardware multiplier is invoked
21111 inline.  This makes for bigger, but faster code.
21113 The hardware multiply routines disable interrupts whilst running and
21114 restore the previous interrupt state when they finish.  This makes
21115 them safe to use inside interrupt handlers as well as in normal code.
21117 @item -minrt
21118 @opindex minrt
21119 Enable the use of a minimum runtime environment - no static
21120 initializers or constructors.  This is intended for memory-constrained
21121 devices.  The compiler includes special symbols in some objects
21122 that tell the linker and runtime which code fragments are required.
21124 @item -mcode-region=
21125 @itemx -mdata-region=
21126 @opindex mcode-region
21127 @opindex mdata-region
21128 These options tell the compiler where to place functions and data that
21129 do not have one of the @code{lower}, @code{upper}, @code{either} or
21130 @code{section} attributes.  Possible values are @code{lower},
21131 @code{upper}, @code{either} or @code{any}.  The first three behave
21132 like the corresponding attribute.  The fourth possible value -
21133 @code{any} - is the default.  It leaves placement entirely up to the
21134 linker script and how it assigns the standard sections
21135 (@code{.text}, @code{.data}, etc) to the memory regions.
21137 @item -msilicon-errata=
21138 @opindex msilicon-errata
21139 This option passes on a request to assembler to enable the fixes for
21140 the named silicon errata.
21142 @item -msilicon-errata-warn=
21143 @opindex msilicon-errata-warn
21144 This option passes on a request to the assembler to enable warning
21145 messages when a silicon errata might need to be applied.
21147 @end table
21149 @node NDS32 Options
21150 @subsection NDS32 Options
21151 @cindex NDS32 Options
21153 These options are defined for NDS32 implementations:
21155 @table @gcctabopt
21157 @item -mbig-endian
21158 @opindex mbig-endian
21159 Generate code in big-endian mode.
21161 @item -mlittle-endian
21162 @opindex mlittle-endian
21163 Generate code in little-endian mode.
21165 @item -mreduced-regs
21166 @opindex mreduced-regs
21167 Use reduced-set registers for register allocation.
21169 @item -mfull-regs
21170 @opindex mfull-regs
21171 Use full-set registers for register allocation.
21173 @item -mcmov
21174 @opindex mcmov
21175 Generate conditional move instructions.
21177 @item -mno-cmov
21178 @opindex mno-cmov
21179 Do not generate conditional move instructions.
21181 @item -mperf-ext
21182 @opindex mperf-ext
21183 Generate performance extension instructions.
21185 @item -mno-perf-ext
21186 @opindex mno-perf-ext
21187 Do not generate performance extension instructions.
21189 @item -mv3push
21190 @opindex mv3push
21191 Generate v3 push25/pop25 instructions.
21193 @item -mno-v3push
21194 @opindex mno-v3push
21195 Do not generate v3 push25/pop25 instructions.
21197 @item -m16-bit
21198 @opindex m16-bit
21199 Generate 16-bit instructions.
21201 @item -mno-16-bit
21202 @opindex mno-16-bit
21203 Do not generate 16-bit instructions.
21205 @item -misr-vector-size=@var{num}
21206 @opindex misr-vector-size
21207 Specify the size of each interrupt vector, which must be 4 or 16.
21209 @item -mcache-block-size=@var{num}
21210 @opindex mcache-block-size
21211 Specify the size of each cache block,
21212 which must be a power of 2 between 4 and 512.
21214 @item -march=@var{arch}
21215 @opindex march
21216 Specify the name of the target architecture.
21218 @item -mcmodel=@var{code-model}
21219 @opindex mcmodel
21220 Set the code model to one of
21221 @table @asis
21222 @item @samp{small}
21223 All the data and read-only data segments must be within 512KB addressing space.
21224 The text segment must be within 16MB addressing space.
21225 @item @samp{medium}
21226 The data segment must be within 512KB while the read-only data segment can be
21227 within 4GB addressing space.  The text segment should be still within 16MB
21228 addressing space.
21229 @item @samp{large}
21230 All the text and data segments can be within 4GB addressing space.
21231 @end table
21233 @item -mctor-dtor
21234 @opindex mctor-dtor
21235 Enable constructor/destructor feature.
21237 @item -mrelax
21238 @opindex mrelax
21239 Guide linker to relax instructions.
21241 @end table
21243 @node Nios II Options
21244 @subsection Nios II Options
21245 @cindex Nios II options
21246 @cindex Altera Nios II options
21248 These are the options defined for the Altera Nios II processor.
21250 @table @gcctabopt
21252 @item -G @var{num}
21253 @opindex G
21254 @cindex smaller data references
21255 Put global and static objects less than or equal to @var{num} bytes
21256 into the small data or BSS sections instead of the normal data or BSS
21257 sections.  The default value of @var{num} is 8.
21259 @item -mgpopt=@var{option}
21260 @item -mgpopt
21261 @itemx -mno-gpopt
21262 @opindex mgpopt
21263 @opindex mno-gpopt
21264 Generate (do not generate) GP-relative accesses.  The following 
21265 @var{option} names are recognized:
21267 @table @samp
21269 @item none
21270 Do not generate GP-relative accesses.
21272 @item local
21273 Generate GP-relative accesses for small data objects that are not 
21274 external, weak, or uninitialized common symbols.  
21275 Also use GP-relative addressing for objects that
21276 have been explicitly placed in a small data section via a @code{section}
21277 attribute.
21279 @item global
21280 As for @samp{local}, but also generate GP-relative accesses for
21281 small data objects that are external, weak, or common.  If you use this option,
21282 you must ensure that all parts of your program (including libraries) are
21283 compiled with the same @option{-G} setting.
21285 @item data
21286 Generate GP-relative accesses for all data objects in the program.  If you
21287 use this option, the entire data and BSS segments
21288 of your program must fit in 64K of memory and you must use an appropriate
21289 linker script to allocate them within the addressable range of the
21290 global pointer.
21292 @item all
21293 Generate GP-relative addresses for function pointers as well as data
21294 pointers.  If you use this option, the entire text, data, and BSS segments
21295 of your program must fit in 64K of memory and you must use an appropriate
21296 linker script to allocate them within the addressable range of the
21297 global pointer.
21299 @end table
21301 @option{-mgpopt} is equivalent to @option{-mgpopt=local}, and
21302 @option{-mno-gpopt} is equivalent to @option{-mgpopt=none}.
21304 The default is @option{-mgpopt} except when @option{-fpic} or
21305 @option{-fPIC} is specified to generate position-independent code.
21306 Note that the Nios II ABI does not permit GP-relative accesses from
21307 shared libraries.
21309 You may need to specify @option{-mno-gpopt} explicitly when building
21310 programs that include large amounts of small data, including large
21311 GOT data sections.  In this case, the 16-bit offset for GP-relative
21312 addressing may not be large enough to allow access to the entire 
21313 small data section.
21315 @item -mgprel-sec=@var{regexp}
21316 @opindex mgprel-sec
21317 This option specifies additional section names that can be accessed via
21318 GP-relative addressing.  It is most useful in conjunction with 
21319 @code{section} attributes on variable declarations 
21320 (@pxref{Common Variable Attributes}) and a custom linker script.  
21321 The @var{regexp} is a POSIX Extended Regular Expression.
21323 This option does not affect the behavior of the @option{-G} option, and 
21324 and the specified sections are in addition to the standard @code{.sdata} 
21325 and @code{.sbss} small-data sections that are recognized by @option{-mgpopt}.
21327 @item -mr0rel-sec=@var{regexp}
21328 @opindex mr0rel-sec
21329 This option specifies names of sections that can be accessed via a 
21330 16-bit offset from @code{r0}; that is, in the low 32K or high 32K 
21331 of the 32-bit address space.  It is most useful in conjunction with 
21332 @code{section} attributes on variable declarations 
21333 (@pxref{Common Variable Attributes}) and a custom linker script.  
21334 The @var{regexp} is a POSIX Extended Regular Expression.
21336 In contrast to the use of GP-relative addressing for small data, 
21337 zero-based addressing is never generated by default and there are no 
21338 conventional section names used in standard linker scripts for sections
21339 in the low or high areas of memory.
21341 @item -mel
21342 @itemx -meb
21343 @opindex mel
21344 @opindex meb
21345 Generate little-endian (default) or big-endian (experimental) code,
21346 respectively.
21348 @item -march=@var{arch}
21349 @opindex march
21350 This specifies the name of the target Nios II architecture.  GCC uses this
21351 name to determine what kind of instructions it can emit when generating
21352 assembly code.  Permissible names are: @samp{r1}, @samp{r2}.
21354 The preprocessor macro @code{__nios2_arch__} is available to programs,
21355 with value 1 or 2, indicating the targeted ISA level.
21357 @item -mbypass-cache
21358 @itemx -mno-bypass-cache
21359 @opindex mno-bypass-cache
21360 @opindex mbypass-cache
21361 Force all load and store instructions to always bypass cache by 
21362 using I/O variants of the instructions. The default is not to
21363 bypass the cache.
21365 @item -mno-cache-volatile 
21366 @itemx -mcache-volatile       
21367 @opindex mcache-volatile 
21368 @opindex mno-cache-volatile
21369 Volatile memory access bypass the cache using the I/O variants of 
21370 the load and store instructions. The default is not to bypass the cache.
21372 @item -mno-fast-sw-div
21373 @itemx -mfast-sw-div
21374 @opindex mno-fast-sw-div
21375 @opindex mfast-sw-div
21376 Do not use table-based fast divide for small numbers. The default 
21377 is to use the fast divide at @option{-O3} and above.
21379 @item -mno-hw-mul
21380 @itemx -mhw-mul
21381 @itemx -mno-hw-mulx
21382 @itemx -mhw-mulx
21383 @itemx -mno-hw-div
21384 @itemx -mhw-div
21385 @opindex mno-hw-mul
21386 @opindex mhw-mul
21387 @opindex mno-hw-mulx
21388 @opindex mhw-mulx
21389 @opindex mno-hw-div
21390 @opindex mhw-div
21391 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
21392 instructions by the compiler. The default is to emit @code{mul}
21393 and not emit @code{div} and @code{mulx}.
21395 @item -mbmx
21396 @itemx -mno-bmx
21397 @itemx -mcdx
21398 @itemx -mno-cdx
21399 Enable or disable generation of Nios II R2 BMX (bit manipulation) and
21400 CDX (code density) instructions.  Enabling these instructions also
21401 requires @option{-march=r2}.  Since these instructions are optional
21402 extensions to the R2 architecture, the default is not to emit them.
21404 @item -mcustom-@var{insn}=@var{N}
21405 @itemx -mno-custom-@var{insn}
21406 @opindex mcustom-@var{insn}
21407 @opindex mno-custom-@var{insn}
21408 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
21409 custom instruction with encoding @var{N} when generating code that uses 
21410 @var{insn}.  For example, @option{-mcustom-fadds=253} generates custom
21411 instruction 253 for single-precision floating-point add operations instead
21412 of the default behavior of using a library call.
21414 The following values of @var{insn} are supported.  Except as otherwise
21415 noted, floating-point operations are expected to be implemented with
21416 normal IEEE 754 semantics and correspond directly to the C operators or the
21417 equivalent GCC built-in functions (@pxref{Other Builtins}).
21419 Single-precision floating point:
21420 @table @asis
21422 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
21423 Binary arithmetic operations.
21425 @item @samp{fnegs}
21426 Unary negation.
21428 @item @samp{fabss}
21429 Unary absolute value.
21431 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
21432 Comparison operations.
21434 @item @samp{fmins}, @samp{fmaxs}
21435 Floating-point minimum and maximum.  These instructions are only
21436 generated if @option{-ffinite-math-only} is specified.
21438 @item @samp{fsqrts}
21439 Unary square root operation.
21441 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
21442 Floating-point trigonometric and exponential functions.  These instructions
21443 are only generated if @option{-funsafe-math-optimizations} is also specified.
21445 @end table
21447 Double-precision floating point:
21448 @table @asis
21450 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
21451 Binary arithmetic operations.
21453 @item @samp{fnegd}
21454 Unary negation.
21456 @item @samp{fabsd}
21457 Unary absolute value.
21459 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
21460 Comparison operations.
21462 @item @samp{fmind}, @samp{fmaxd}
21463 Double-precision minimum and maximum.  These instructions are only
21464 generated if @option{-ffinite-math-only} is specified.
21466 @item @samp{fsqrtd}
21467 Unary square root operation.
21469 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
21470 Double-precision trigonometric and exponential functions.  These instructions
21471 are only generated if @option{-funsafe-math-optimizations} is also specified.
21473 @end table
21475 Conversions:
21476 @table @asis
21477 @item @samp{fextsd}
21478 Conversion from single precision to double precision.
21480 @item @samp{ftruncds}
21481 Conversion from double precision to single precision.
21483 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
21484 Conversion from floating point to signed or unsigned integer types, with
21485 truncation towards zero.
21487 @item @samp{round}
21488 Conversion from single-precision floating point to signed integer,
21489 rounding to the nearest integer and ties away from zero.
21490 This corresponds to the @code{__builtin_lroundf} function when
21491 @option{-fno-math-errno} is used.
21493 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
21494 Conversion from signed or unsigned integer types to floating-point types.
21496 @end table
21498 In addition, all of the following transfer instructions for internal
21499 registers X and Y must be provided to use any of the double-precision
21500 floating-point instructions.  Custom instructions taking two
21501 double-precision source operands expect the first operand in the
21502 64-bit register X.  The other operand (or only operand of a unary
21503 operation) is given to the custom arithmetic instruction with the
21504 least significant half in source register @var{src1} and the most
21505 significant half in @var{src2}.  A custom instruction that returns a
21506 double-precision result returns the most significant 32 bits in the
21507 destination register and the other half in 32-bit register Y.  
21508 GCC automatically generates the necessary code sequences to write
21509 register X and/or read register Y when double-precision floating-point
21510 instructions are used.
21512 @table @asis
21514 @item @samp{fwrx}
21515 Write @var{src1} into the least significant half of X and @var{src2} into
21516 the most significant half of X.
21518 @item @samp{fwry}
21519 Write @var{src1} into Y.
21521 @item @samp{frdxhi}, @samp{frdxlo}
21522 Read the most or least (respectively) significant half of X and store it in
21523 @var{dest}.
21525 @item @samp{frdy}
21526 Read the value of Y and store it into @var{dest}.
21527 @end table
21529 Note that you can gain more local control over generation of Nios II custom
21530 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
21531 and @code{target("no-custom-@var{insn}")} function attributes
21532 (@pxref{Function Attributes})
21533 or pragmas (@pxref{Function Specific Option Pragmas}).
21535 @item -mcustom-fpu-cfg=@var{name}
21536 @opindex mcustom-fpu-cfg
21538 This option enables a predefined, named set of custom instruction encodings
21539 (see @option{-mcustom-@var{insn}} above).  
21540 Currently, the following sets are defined:
21542 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
21543 @gccoptlist{-mcustom-fmuls=252 @gol
21544 -mcustom-fadds=253 @gol
21545 -mcustom-fsubs=254 @gol
21546 -fsingle-precision-constant}
21548 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
21549 @gccoptlist{-mcustom-fmuls=252 @gol
21550 -mcustom-fadds=253 @gol
21551 -mcustom-fsubs=254 @gol
21552 -mcustom-fdivs=255 @gol
21553 -fsingle-precision-constant}
21555 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
21556 @gccoptlist{-mcustom-floatus=243 @gol
21557 -mcustom-fixsi=244 @gol
21558 -mcustom-floatis=245 @gol
21559 -mcustom-fcmpgts=246 @gol
21560 -mcustom-fcmples=249 @gol
21561 -mcustom-fcmpeqs=250 @gol
21562 -mcustom-fcmpnes=251 @gol
21563 -mcustom-fmuls=252 @gol
21564 -mcustom-fadds=253 @gol
21565 -mcustom-fsubs=254 @gol
21566 -mcustom-fdivs=255 @gol
21567 -fsingle-precision-constant}
21569 Custom instruction assignments given by individual
21570 @option{-mcustom-@var{insn}=} options override those given by
21571 @option{-mcustom-fpu-cfg=}, regardless of the
21572 order of the options on the command line.
21574 Note that you can gain more local control over selection of a FPU
21575 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
21576 function attribute (@pxref{Function Attributes})
21577 or pragma (@pxref{Function Specific Option Pragmas}).
21579 @end table
21581 These additional @samp{-m} options are available for the Altera Nios II
21582 ELF (bare-metal) target:
21584 @table @gcctabopt
21586 @item -mhal
21587 @opindex mhal
21588 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
21589 startup and termination code, and is typically used in conjunction with
21590 @option{-msys-crt0=} to specify the location of the alternate startup code
21591 provided by the HAL BSP.
21593 @item -msmallc
21594 @opindex msmallc
21595 Link with a limited version of the C library, @option{-lsmallc}, rather than
21596 Newlib.
21598 @item -msys-crt0=@var{startfile}
21599 @opindex msys-crt0
21600 @var{startfile} is the file name of the startfile (crt0) to use 
21601 when linking.  This option is only useful in conjunction with @option{-mhal}.
21603 @item -msys-lib=@var{systemlib}
21604 @opindex msys-lib
21605 @var{systemlib} is the library name of the library that provides
21606 low-level system calls required by the C library,
21607 e.g. @code{read} and @code{write}.
21608 This option is typically used to link with a library provided by a HAL BSP.
21610 @end table
21612 @node Nvidia PTX Options
21613 @subsection Nvidia PTX Options
21614 @cindex Nvidia PTX options
21615 @cindex nvptx options
21617 These options are defined for Nvidia PTX:
21619 @table @gcctabopt
21621 @item -m32
21622 @itemx -m64
21623 @opindex m32
21624 @opindex m64
21625 Generate code for 32-bit or 64-bit ABI.
21627 @item -mmainkernel
21628 @opindex mmainkernel
21629 Link in code for a __main kernel.  This is for stand-alone instead of
21630 offloading execution.
21632 @item -moptimize
21633 @opindex moptimize
21634 Apply partitioned execution optimizations.  This is the default when any
21635 level of optimization is selected.
21637 @item -msoft-stack
21638 @opindex msoft-stack
21639 Generate code that does not use @code{.local} memory
21640 directly for stack storage. Instead, a per-warp stack pointer is
21641 maintained explicitly. This enables variable-length stack allocation (with
21642 variable-length arrays or @code{alloca}), and when global memory is used for
21643 underlying storage, makes it possible to access automatic variables from other
21644 threads, or with atomic instructions. This code generation variant is used
21645 for OpenMP offloading, but the option is exposed on its own for the purpose
21646 of testing the compiler; to generate code suitable for linking into programs
21647 using OpenMP offloading, use option @option{-mgomp}.
21649 @item -muniform-simt
21650 @opindex muniform-simt
21651 Switch to code generation variant that allows to execute all threads in each
21652 warp, while maintaining memory state and side effects as if only one thread
21653 in each warp was active outside of OpenMP SIMD regions.  All atomic operations
21654 and calls to runtime (malloc, free, vprintf) are conditionally executed (iff
21655 current lane index equals the master lane index), and the register being
21656 assigned is copied via a shuffle instruction from the master lane.  Outside of
21657 SIMD regions lane 0 is the master; inside, each thread sees itself as the
21658 master.  Shared memory array @code{int __nvptx_uni[]} stores all-zeros or
21659 all-ones bitmasks for each warp, indicating current mode (0 outside of SIMD
21660 regions).  Each thread can bitwise-and the bitmask at position @code{tid.y}
21661 with current lane index to compute the master lane index.
21663 @item -mgomp
21664 @opindex mgomp
21665 Generate code for use in OpenMP offloading: enables @option{-msoft-stack} and
21666 @option{-muniform-simt} options, and selects corresponding multilib variant.
21668 @end table
21670 @node PDP-11 Options
21671 @subsection PDP-11 Options
21672 @cindex PDP-11 Options
21674 These options are defined for the PDP-11:
21676 @table @gcctabopt
21677 @item -mfpu
21678 @opindex mfpu
21679 Use hardware FPP floating point.  This is the default.  (FIS floating
21680 point on the PDP-11/40 is not supported.)
21682 @item -msoft-float
21683 @opindex msoft-float
21684 Do not use hardware floating point.
21686 @item -mac0
21687 @opindex mac0
21688 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
21690 @item -mno-ac0
21691 @opindex mno-ac0
21692 Return floating-point results in memory.  This is the default.
21694 @item -m40
21695 @opindex m40
21696 Generate code for a PDP-11/40.
21698 @item -m45
21699 @opindex m45
21700 Generate code for a PDP-11/45.  This is the default.
21702 @item -m10
21703 @opindex m10
21704 Generate code for a PDP-11/10.
21706 @item -mbcopy-builtin
21707 @opindex mbcopy-builtin
21708 Use inline @code{movmemhi} patterns for copying memory.  This is the
21709 default.
21711 @item -mbcopy
21712 @opindex mbcopy
21713 Do not use inline @code{movmemhi} patterns for copying memory.
21715 @item -mint16
21716 @itemx -mno-int32
21717 @opindex mint16
21718 @opindex mno-int32
21719 Use 16-bit @code{int}.  This is the default.
21721 @item -mint32
21722 @itemx -mno-int16
21723 @opindex mint32
21724 @opindex mno-int16
21725 Use 32-bit @code{int}.
21727 @item -mfloat64
21728 @itemx -mno-float32
21729 @opindex mfloat64
21730 @opindex mno-float32
21731 Use 64-bit @code{float}.  This is the default.
21733 @item -mfloat32
21734 @itemx -mno-float64
21735 @opindex mfloat32
21736 @opindex mno-float64
21737 Use 32-bit @code{float}.
21739 @item -mabshi
21740 @opindex mabshi
21741 Use @code{abshi2} pattern.  This is the default.
21743 @item -mno-abshi
21744 @opindex mno-abshi
21745 Do not use @code{abshi2} pattern.
21747 @item -mbranch-expensive
21748 @opindex mbranch-expensive
21749 Pretend that branches are expensive.  This is for experimenting with
21750 code generation only.
21752 @item -mbranch-cheap
21753 @opindex mbranch-cheap
21754 Do not pretend that branches are expensive.  This is the default.
21756 @item -munix-asm
21757 @opindex munix-asm
21758 Use Unix assembler syntax.  This is the default when configured for
21759 @samp{pdp11-*-bsd}.
21761 @item -mdec-asm
21762 @opindex mdec-asm
21763 Use DEC assembler syntax.  This is the default when configured for any
21764 PDP-11 target other than @samp{pdp11-*-bsd}.
21765 @end table
21767 @node picoChip Options
21768 @subsection picoChip Options
21769 @cindex picoChip options
21771 These @samp{-m} options are defined for picoChip implementations:
21773 @table @gcctabopt
21775 @item -mae=@var{ae_type}
21776 @opindex mcpu
21777 Set the instruction set, register set, and instruction scheduling
21778 parameters for array element type @var{ae_type}.  Supported values
21779 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
21781 @option{-mae=ANY} selects a completely generic AE type.  Code
21782 generated with this option runs on any of the other AE types.  The
21783 code is not as efficient as it would be if compiled for a specific
21784 AE type, and some types of operation (e.g., multiplication) do not
21785 work properly on all types of AE.
21787 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
21788 for compiled code, and is the default.
21790 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
21791 option may suffer from poor performance of byte (char) manipulation,
21792 since the DSP AE does not provide hardware support for byte load/stores.
21794 @item -msymbol-as-address
21795 Enable the compiler to directly use a symbol name as an address in a
21796 load/store instruction, without first loading it into a
21797 register.  Typically, the use of this option generates larger
21798 programs, which run faster than when the option isn't used.  However, the
21799 results vary from program to program, so it is left as a user option,
21800 rather than being permanently enabled.
21802 @item -mno-inefficient-warnings
21803 Disables warnings about the generation of inefficient code.  These
21804 warnings can be generated, for example, when compiling code that
21805 performs byte-level memory operations on the MAC AE type.  The MAC AE has
21806 no hardware support for byte-level memory operations, so all byte
21807 load/stores must be synthesized from word load/store operations.  This is
21808 inefficient and a warning is generated to indicate
21809 that you should rewrite the code to avoid byte operations, or to target
21810 an AE type that has the necessary hardware support.  This option disables
21811 these warnings.
21813 @end table
21815 @node PowerPC Options
21816 @subsection PowerPC Options
21817 @cindex PowerPC options
21819 These are listed under @xref{RS/6000 and PowerPC Options}.
21821 @node RISC-V Options
21822 @subsection RISC-V Options
21823 @cindex RISC-V Options
21825 These command-line options are defined for RISC-V targets:
21827 @table @gcctabopt
21828 @item -mbranch-cost=@var{n}
21829 @opindex mbranch-cost
21830 Set the cost of branches to roughly @var{n} instructions.
21832 @item -mplt
21833 @itemx -mno-plt
21834 @opindex plt
21835 When generating PIC code, do or don't allow the use of PLTs. Ignored for
21836 non-PIC.  The default is @option{-mplt}.
21838 @item -mabi=@var{ABI-string}
21839 @opindex mabi
21840 Specify integer and floating-point calling convention.  @var{ABI-string}
21841 contains two parts: the size of integer types and the registers used for
21842 floating-point types.  For example @samp{-march=rv64ifd -mabi=lp64d} means that
21843 @samp{long} and pointers are 64-bit (implicitly defining @samp{int} to be
21844 32-bit), and that floating-point values up to 64 bits wide are passed in F
21845 registers.  Contrast this with @samp{-march=rv64ifd -mabi=lp64f}, which still
21846 allows the compiler to generate code that uses the F and D extensions but only
21847 allows floating-point values up to 32 bits long to be passed in registers; or
21848 @samp{-march=rv64ifd -mabi=lp64}, in which no floating-point arguments will be
21849 passed in registers.
21851 The default for this argument is system dependent, users who want a specific
21852 calling convention should specify one explicitly.  The valid calling
21853 conventions are: @samp{ilp32}, @samp{ilp32f}, @samp{ilp32d}, @samp{lp64},
21854 @samp{lp64f}, and @samp{lp64d}.  Some calling conventions are impossible to
21855 implement on some ISAs: for example, @samp{-march=rv32if -mabi=ilp32d} is
21856 invalid because the ABI requires 64-bit values be passed in F registers, but F
21857 registers are only 32 bits wide.
21859 @item -mfdiv
21860 @itemx -mno-fdiv
21861 @opindex mfdiv
21862 Do or don't use hardware floating-point divide and square root instructions.
21863 This requires the F or D extensions for floating-point registers.  The default
21864 is to use them if the specified architecture has these instructions.
21866 @item -mdiv
21867 @itemx -mno-div
21868 @opindex mdiv
21869 Do or don't use hardware instructions for integer division.  This requires the
21870 M extension.  The default is to use them if the specified architecture has
21871 these instructions.
21873 @item -march=@var{ISA-string}
21874 @opindex march
21875 Generate code for given RISC-V ISA (e.g.@ @samp{rv64im}).  ISA strings must be
21876 lower-case.  Examples include @samp{rv64i}, @samp{rv32g}, and @samp{rv32imaf}.
21878 @item -mtune=@var{processor-string}
21879 @opindex mtune
21880 Optimize the output for the given processor, specified by microarchitecture
21881 name.
21883 @item -msmall-data-limit=@var{n}
21884 @opindex msmall-data-limit
21885 Put global and static data smaller than @var{n} bytes into a special section
21886 (on some targets).
21888 @item -msave-restore
21889 @itemx -mno-save-restore
21890 @opindex msave-restore
21891 Do or don't use smaller but slower prologue and epilogue code that uses
21892 library function calls.  The default is to use fast inline prologues and
21893 epilogues.
21895 @item -mstrict-align
21896 @itemx -mno-strict-align
21897 @opindex mstrict-align
21898 Do not or do generate unaligned memory accesses.  The default is set depending
21899 on whether the processor we are optimizing for supports fast unaligned access
21900 or not.
21902 @item -mcmodel=medlow
21903 @opindex mcmodel=medlow
21904 Generate code for the medium-low code model. The program and its statically
21905 defined symbols must lie within a single 2 GiB address range and must lie
21906 between absolute addresses @minus{}2 GiB and +2 GiB. Programs can be
21907 statically or dynamically linked. This is the default code model.
21909 @item -mcmodel=medany
21910 @opindex mcmodel=medany
21911 Generate code for the medium-any code model. The program and its statically
21912 defined symbols must be within any single 2 GiB address range. Programs can be
21913 statically or dynamically linked.
21915 @item -mexplicit-relocs
21916 @itemx -mno-exlicit-relocs
21917 Use or do not use assembler relocation operators when dealing with symbolic
21918 addresses.  The alternative is to use assembler macros instead, which may
21919 limit optimization.
21921 @end table
21923 @node RL78 Options
21924 @subsection RL78 Options
21925 @cindex RL78 Options
21927 @table @gcctabopt
21929 @item -msim
21930 @opindex msim
21931 Links in additional target libraries to support operation within a
21932 simulator.
21934 @item -mmul=none
21935 @itemx -mmul=g10
21936 @itemx -mmul=g13
21937 @itemx -mmul=g14
21938 @itemx -mmul=rl78
21939 @opindex mmul
21940 Specifies the type of hardware multiplication and division support to
21941 be used.  The simplest is @code{none}, which uses software for both
21942 multiplication and division.  This is the default.  The @code{g13}
21943 value is for the hardware multiply/divide peripheral found on the
21944 RL78/G13 (S2 core) targets.  The @code{g14} value selects the use of
21945 the multiplication and division instructions supported by the RL78/G14
21946 (S3 core) parts.  The value @code{rl78} is an alias for @code{g14} and
21947 the value @code{mg10} is an alias for @code{none}.
21949 In addition a C preprocessor macro is defined, based upon the setting
21950 of this option.  Possible values are: @code{__RL78_MUL_NONE__},
21951 @code{__RL78_MUL_G13__} or @code{__RL78_MUL_G14__}.
21953 @item -mcpu=g10
21954 @itemx -mcpu=g13
21955 @itemx -mcpu=g14
21956 @itemx -mcpu=rl78
21957 @opindex mcpu
21958 Specifies the RL78 core to target.  The default is the G14 core, also
21959 known as an S3 core or just RL78.  The G13 or S2 core does not have
21960 multiply or divide instructions, instead it uses a hardware peripheral
21961 for these operations.  The G10 or S1 core does not have register
21962 banks, so it uses a different calling convention.
21964 If this option is set it also selects the type of hardware multiply
21965 support to use, unless this is overridden by an explicit
21966 @option{-mmul=none} option on the command line.  Thus specifying
21967 @option{-mcpu=g13} enables the use of the G13 hardware multiply
21968 peripheral and specifying @option{-mcpu=g10} disables the use of
21969 hardware multiplications altogether.
21971 Note, although the RL78/G14 core is the default target, specifying
21972 @option{-mcpu=g14} or @option{-mcpu=rl78} on the command line does
21973 change the behavior of the toolchain since it also enables G14
21974 hardware multiply support.  If these options are not specified on the
21975 command line then software multiplication routines will be used even
21976 though the code targets the RL78 core.  This is for backwards
21977 compatibility with older toolchains which did not have hardware
21978 multiply and divide support.
21980 In addition a C preprocessor macro is defined, based upon the setting
21981 of this option.  Possible values are: @code{__RL78_G10__},
21982 @code{__RL78_G13__} or @code{__RL78_G14__}.
21984 @item -mg10
21985 @itemx -mg13
21986 @itemx -mg14
21987 @itemx -mrl78
21988 @opindex mg10
21989 @opindex mg13
21990 @opindex mg14
21991 @opindex mrl78
21992 These are aliases for the corresponding @option{-mcpu=} option.  They
21993 are provided for backwards compatibility.
21995 @item -mallregs
21996 @opindex mallregs
21997 Allow the compiler to use all of the available registers.  By default
21998 registers @code{r24..r31} are reserved for use in interrupt handlers.
21999 With this option enabled these registers can be used in ordinary
22000 functions as well.
22002 @item -m64bit-doubles
22003 @itemx -m32bit-doubles
22004 @opindex m64bit-doubles
22005 @opindex m32bit-doubles
22006 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
22007 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
22008 @option{-m32bit-doubles}.
22010 @item -msave-mduc-in-interrupts
22011 @item -mno-save-mduc-in-interrupts
22012 @opindex msave-mduc-in-interrupts
22013 @opindex mno-save-mduc-in-interrupts
22014 Specifies that interrupt handler functions should preserve the
22015 MDUC registers.  This is only necessary if normal code might use
22016 the MDUC registers, for example because it performs multiplication
22017 and division operations.  The default is to ignore the MDUC registers
22018 as this makes the interrupt handlers faster.  The target option -mg13
22019 needs to be passed for this to work as this feature is only available
22020 on the G13 target (S2 core).  The MDUC registers will only be saved
22021 if the interrupt handler performs a multiplication or division
22022 operation or it calls another function.
22024 @end table
22026 @node RS/6000 and PowerPC Options
22027 @subsection IBM RS/6000 and PowerPC Options
22028 @cindex RS/6000 and PowerPC Options
22029 @cindex IBM RS/6000 and PowerPC Options
22031 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
22032 @table @gcctabopt
22033 @item -mpowerpc-gpopt
22034 @itemx -mno-powerpc-gpopt
22035 @itemx -mpowerpc-gfxopt
22036 @itemx -mno-powerpc-gfxopt
22037 @need 800
22038 @itemx -mpowerpc64
22039 @itemx -mno-powerpc64
22040 @itemx -mmfcrf
22041 @itemx -mno-mfcrf
22042 @itemx -mpopcntb
22043 @itemx -mno-popcntb
22044 @itemx -mpopcntd
22045 @itemx -mno-popcntd
22046 @itemx -mfprnd
22047 @itemx -mno-fprnd
22048 @need 800
22049 @itemx -mcmpb
22050 @itemx -mno-cmpb
22051 @itemx -mmfpgpr
22052 @itemx -mno-mfpgpr
22053 @itemx -mhard-dfp
22054 @itemx -mno-hard-dfp
22055 @opindex mpowerpc-gpopt
22056 @opindex mno-powerpc-gpopt
22057 @opindex mpowerpc-gfxopt
22058 @opindex mno-powerpc-gfxopt
22059 @opindex mpowerpc64
22060 @opindex mno-powerpc64
22061 @opindex mmfcrf
22062 @opindex mno-mfcrf
22063 @opindex mpopcntb
22064 @opindex mno-popcntb
22065 @opindex mpopcntd
22066 @opindex mno-popcntd
22067 @opindex mfprnd
22068 @opindex mno-fprnd
22069 @opindex mcmpb
22070 @opindex mno-cmpb
22071 @opindex mmfpgpr
22072 @opindex mno-mfpgpr
22073 @opindex mhard-dfp
22074 @opindex mno-hard-dfp
22075 You use these options to specify which instructions are available on the
22076 processor you are using.  The default value of these options is
22077 determined when configuring GCC@.  Specifying the
22078 @option{-mcpu=@var{cpu_type}} overrides the specification of these
22079 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
22080 rather than the options listed above.
22082 Specifying @option{-mpowerpc-gpopt} allows
22083 GCC to use the optional PowerPC architecture instructions in the
22084 General Purpose group, including floating-point square root.  Specifying
22085 @option{-mpowerpc-gfxopt} allows GCC to
22086 use the optional PowerPC architecture instructions in the Graphics
22087 group, including floating-point select.
22089 The @option{-mmfcrf} option allows GCC to generate the move from
22090 condition register field instruction implemented on the POWER4
22091 processor and other processors that support the PowerPC V2.01
22092 architecture.
22093 The @option{-mpopcntb} option allows GCC to generate the popcount and
22094 double-precision FP reciprocal estimate instruction implemented on the
22095 POWER5 processor and other processors that support the PowerPC V2.02
22096 architecture.
22097 The @option{-mpopcntd} option allows GCC to generate the popcount
22098 instruction implemented on the POWER7 processor and other processors
22099 that support the PowerPC V2.06 architecture.
22100 The @option{-mfprnd} option allows GCC to generate the FP round to
22101 integer instructions implemented on the POWER5+ processor and other
22102 processors that support the PowerPC V2.03 architecture.
22103 The @option{-mcmpb} option allows GCC to generate the compare bytes
22104 instruction implemented on the POWER6 processor and other processors
22105 that support the PowerPC V2.05 architecture.
22106 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
22107 general-purpose register instructions implemented on the POWER6X
22108 processor and other processors that support the extended PowerPC V2.05
22109 architecture.
22110 The @option{-mhard-dfp} option allows GCC to generate the decimal
22111 floating-point instructions implemented on some POWER processors.
22113 The @option{-mpowerpc64} option allows GCC to generate the additional
22114 64-bit instructions that are found in the full PowerPC64 architecture
22115 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
22116 @option{-mno-powerpc64}.
22118 @item -mcpu=@var{cpu_type}
22119 @opindex mcpu
22120 Set architecture type, register usage, and
22121 instruction scheduling parameters for machine type @var{cpu_type}.
22122 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
22123 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
22124 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
22125 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
22126 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
22127 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
22128 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
22129 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
22130 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
22131 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8},
22132 @samp{power9}, @samp{powerpc}, @samp{powerpc64}, @samp{powerpc64le},
22133 and @samp{rs64}.
22135 @option{-mcpu=powerpc}, @option{-mcpu=powerpc64}, and
22136 @option{-mcpu=powerpc64le} specify pure 32-bit PowerPC (either
22137 endian), 64-bit big endian PowerPC and 64-bit little endian PowerPC
22138 architecture machine types, with an appropriate, generic processor
22139 model assumed for scheduling purposes.
22141 The other options specify a specific processor.  Code generated under
22142 those options runs best on that processor, and may not run at all on
22143 others.
22145 The @option{-mcpu} options automatically enable or disable the
22146 following options:
22148 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
22149 -mpopcntb -mpopcntd  -mpowerpc64 @gol
22150 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
22151 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
22152 -mcrypto -mdirect-move -mhtm -mpower8-fusion -mpower8-vector @gol
22153 -mquad-memory -mquad-memory-atomic -mfloat128 -mfloat128-hardware}
22155 The particular options set for any particular CPU varies between
22156 compiler versions, depending on what setting seems to produce optimal
22157 code for that CPU; it doesn't necessarily reflect the actual hardware's
22158 capabilities.  If you wish to set an individual option to a particular
22159 value, you may specify it after the @option{-mcpu} option, like
22160 @option{-mcpu=970 -mno-altivec}.
22162 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
22163 not enabled or disabled by the @option{-mcpu} option at present because
22164 AIX does not have full support for these options.  You may still
22165 enable or disable them individually if you're sure it'll work in your
22166 environment.
22168 @item -mtune=@var{cpu_type}
22169 @opindex mtune
22170 Set the instruction scheduling parameters for machine type
22171 @var{cpu_type}, but do not set the architecture type or register usage,
22172 as @option{-mcpu=@var{cpu_type}} does.  The same
22173 values for @var{cpu_type} are used for @option{-mtune} as for
22174 @option{-mcpu}.  If both are specified, the code generated uses the
22175 architecture and registers set by @option{-mcpu}, but the
22176 scheduling parameters set by @option{-mtune}.
22178 @item -mcmodel=small
22179 @opindex mcmodel=small
22180 Generate PowerPC64 code for the small model: The TOC is limited to
22181 64k.
22183 @item -mcmodel=medium
22184 @opindex mcmodel=medium
22185 Generate PowerPC64 code for the medium model: The TOC and other static
22186 data may be up to a total of 4G in size.  This is the default for 64-bit
22187 Linux.
22189 @item -mcmodel=large
22190 @opindex mcmodel=large
22191 Generate PowerPC64 code for the large model: The TOC may be up to 4G
22192 in size.  Other data and code is only limited by the 64-bit address
22193 space.
22195 @item -maltivec
22196 @itemx -mno-altivec
22197 @opindex maltivec
22198 @opindex mno-altivec
22199 Generate code that uses (does not use) AltiVec instructions, and also
22200 enable the use of built-in functions that allow more direct access to
22201 the AltiVec instruction set.  You may also need to set
22202 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
22203 enhancements.
22205 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
22206 @option{-maltivec=be}, the element order for AltiVec intrinsics such
22207 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} 
22208 match array element order corresponding to the endianness of the
22209 target.  That is, element zero identifies the leftmost element in a
22210 vector register when targeting a big-endian platform, and identifies
22211 the rightmost element in a vector register when targeting a
22212 little-endian platform.
22214 @item -maltivec=be
22215 @opindex maltivec=be
22216 Generate AltiVec instructions using big-endian element order,
22217 regardless of whether the target is big- or little-endian.  This is
22218 the default when targeting a big-endian platform.
22220 The element order is used to interpret element numbers in AltiVec
22221 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
22222 @code{vec_insert}.  By default, these match array element order
22223 corresponding to the endianness for the target.
22225 @item -maltivec=le
22226 @opindex maltivec=le
22227 Generate AltiVec instructions using little-endian element order,
22228 regardless of whether the target is big- or little-endian.  This is
22229 the default when targeting a little-endian platform.  This option is
22230 currently ignored when targeting a big-endian platform.
22232 The element order is used to interpret element numbers in AltiVec
22233 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
22234 @code{vec_insert}.  By default, these match array element order
22235 corresponding to the endianness for the target.
22237 @item -mvrsave
22238 @itemx -mno-vrsave
22239 @opindex mvrsave
22240 @opindex mno-vrsave
22241 Generate VRSAVE instructions when generating AltiVec code.
22243 @item -msecure-plt
22244 @opindex msecure-plt
22245 Generate code that allows @command{ld} and @command{ld.so}
22246 to build executables and shared
22247 libraries with non-executable @code{.plt} and @code{.got} sections.
22248 This is a PowerPC
22249 32-bit SYSV ABI option.
22251 @item -mbss-plt
22252 @opindex mbss-plt
22253 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
22254 fills in, and
22255 requires @code{.plt} and @code{.got}
22256 sections that are both writable and executable.
22257 This is a PowerPC 32-bit SYSV ABI option.
22259 @item -misel
22260 @itemx -mno-isel
22261 @opindex misel
22262 @opindex mno-isel
22263 This switch enables or disables the generation of ISEL instructions.
22265 @item -misel=@var{yes/no}
22266 This switch has been deprecated.  Use @option{-misel} and
22267 @option{-mno-isel} instead.
22269 @item -mspe
22270 @itemx -mno-spe
22271 @opindex mspe
22272 @opindex mno-spe
22273 This switch enables or disables the generation of SPE simd
22274 instructions.
22276 @item -mpaired
22277 @itemx -mno-paired
22278 @opindex mpaired
22279 @opindex mno-paired
22280 This switch enables or disables the generation of PAIRED simd
22281 instructions.
22283 @item -mspe=@var{yes/no}
22284 This option has been deprecated.  Use @option{-mspe} and
22285 @option{-mno-spe} instead.
22287 @item -mvsx
22288 @itemx -mno-vsx
22289 @opindex mvsx
22290 @opindex mno-vsx
22291 Generate code that uses (does not use) vector/scalar (VSX)
22292 instructions, and also enable the use of built-in functions that allow
22293 more direct access to the VSX instruction set.
22295 @item -mcrypto
22296 @itemx -mno-crypto
22297 @opindex mcrypto
22298 @opindex mno-crypto
22299 Enable the use (disable) of the built-in functions that allow direct
22300 access to the cryptographic instructions that were added in version
22301 2.07 of the PowerPC ISA.
22303 @item -mdirect-move
22304 @itemx -mno-direct-move
22305 @opindex mdirect-move
22306 @opindex mno-direct-move
22307 Generate code that uses (does not use) the instructions to move data
22308 between the general purpose registers and the vector/scalar (VSX)
22309 registers that were added in version 2.07 of the PowerPC ISA.
22311 @item -mhtm
22312 @itemx -mno-htm
22313 @opindex mhtm
22314 @opindex mno-htm
22315 Enable (disable) the use of the built-in functions that allow direct
22316 access to the Hardware Transactional Memory (HTM) instructions that
22317 were added in version 2.07 of the PowerPC ISA.
22319 @item -mpower8-fusion
22320 @itemx -mno-power8-fusion
22321 @opindex mpower8-fusion
22322 @opindex mno-power8-fusion
22323 Generate code that keeps (does not keeps) some integer operations
22324 adjacent so that the instructions can be fused together on power8 and
22325 later processors.
22327 @item -mpower8-vector
22328 @itemx -mno-power8-vector
22329 @opindex mpower8-vector
22330 @opindex mno-power8-vector
22331 Generate code that uses (does not use) the vector and scalar
22332 instructions that were added in version 2.07 of the PowerPC ISA.  Also
22333 enable the use of built-in functions that allow more direct access to
22334 the vector instructions.
22336 @item -mquad-memory
22337 @itemx -mno-quad-memory
22338 @opindex mquad-memory
22339 @opindex mno-quad-memory
22340 Generate code that uses (does not use) the non-atomic quad word memory
22341 instructions.  The @option{-mquad-memory} option requires use of
22342 64-bit mode.
22344 @item -mquad-memory-atomic
22345 @itemx -mno-quad-memory-atomic
22346 @opindex mquad-memory-atomic
22347 @opindex mno-quad-memory-atomic
22348 Generate code that uses (does not use) the atomic quad word memory
22349 instructions.  The @option{-mquad-memory-atomic} option requires use of
22350 64-bit mode.
22352 @item -mfloat128
22353 @itemx -mno-float128
22354 @opindex mfloat128
22355 @opindex mno-float128
22356 Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point
22357 and use either software emulation for IEEE 128-bit floating point or
22358 hardware instructions.
22360 The VSX instruction set (@option{-mvsx}, @option{-mcpu=power7},
22361 @option{-mcpu=power8}), or @option{-mcpu=power9} must be enabled to
22362 use the IEEE 128-bit floating point support.  The IEEE 128-bit
22363 floating point support only works on PowerPC Linux systems.
22365 The default for @option{-mfloat128} is enabled on PowerPC Linux
22366 systems using the VSX instruction set, and disabled on other systems.
22368 If you use the ISA 3.0 instruction set (@option{-mpower9-vector} or
22369 @option{-mcpu=power9}) on a 64-bit system, the IEEE 128-bit floating
22370 point support will also enable the generation of ISA 3.0 IEEE 128-bit
22371 floating point instructions.  Otherwise, if you do not specify to
22372 generate ISA 3.0 instructions or you are targeting a 32-bit big endian
22373 system, IEEE 128-bit floating point will be done with software
22374 emulation.
22376 @item -mfloat128-hardware
22377 @itemx -mno-float128-hardware
22378 @opindex mfloat128-hardware
22379 @opindex mno-float128-hardware
22380 Enable/disable using ISA 3.0 hardware instructions to support the
22381 @var{__float128} data type.
22383 The default for @option{-mfloat128-hardware} is enabled on PowerPC
22384 Linux systems using the ISA 3.0 instruction set, and disabled on other
22385 systems.
22387 @item -mfloat-gprs=@var{yes/single/double/no}
22388 @itemx -mfloat-gprs
22389 @opindex mfloat-gprs
22390 This switch enables or disables the generation of floating-point
22391 operations on the general-purpose registers for architectures that
22392 support it.
22394 The argument @samp{yes} or @samp{single} enables the use of
22395 single-precision floating-point operations.
22397 The argument @samp{double} enables the use of single and
22398 double-precision floating-point operations.
22400 The argument @samp{no} disables floating-point operations on the
22401 general-purpose registers.
22403 This option is currently only available on the MPC854x.
22405 @item -m32
22406 @itemx -m64
22407 @opindex m32
22408 @opindex m64
22409 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
22410 targets (including GNU/Linux).  The 32-bit environment sets int, long
22411 and pointer to 32 bits and generates code that runs on any PowerPC
22412 variant.  The 64-bit environment sets int to 32 bits and long and
22413 pointer to 64 bits, and generates code for PowerPC64, as for
22414 @option{-mpowerpc64}.
22416 @item -mfull-toc
22417 @itemx -mno-fp-in-toc
22418 @itemx -mno-sum-in-toc
22419 @itemx -mminimal-toc
22420 @opindex mfull-toc
22421 @opindex mno-fp-in-toc
22422 @opindex mno-sum-in-toc
22423 @opindex mminimal-toc
22424 Modify generation of the TOC (Table Of Contents), which is created for
22425 every executable file.  The @option{-mfull-toc} option is selected by
22426 default.  In that case, GCC allocates at least one TOC entry for
22427 each unique non-automatic variable reference in your program.  GCC
22428 also places floating-point constants in the TOC@.  However, only
22429 16,384 entries are available in the TOC@.
22431 If you receive a linker error message that saying you have overflowed
22432 the available TOC space, you can reduce the amount of TOC space used
22433 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
22434 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
22435 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
22436 generate code to calculate the sum of an address and a constant at
22437 run time instead of putting that sum into the TOC@.  You may specify one
22438 or both of these options.  Each causes GCC to produce very slightly
22439 slower and larger code at the expense of conserving TOC space.
22441 If you still run out of space in the TOC even when you specify both of
22442 these options, specify @option{-mminimal-toc} instead.  This option causes
22443 GCC to make only one TOC entry for every file.  When you specify this
22444 option, GCC produces code that is slower and larger but which
22445 uses extremely little TOC space.  You may wish to use this option
22446 only on files that contain less frequently-executed code.
22448 @item -maix64
22449 @itemx -maix32
22450 @opindex maix64
22451 @opindex maix32
22452 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
22453 @code{long} type, and the infrastructure needed to support them.
22454 Specifying @option{-maix64} implies @option{-mpowerpc64},
22455 while @option{-maix32} disables the 64-bit ABI and
22456 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
22458 @item -mxl-compat
22459 @itemx -mno-xl-compat
22460 @opindex mxl-compat
22461 @opindex mno-xl-compat
22462 Produce code that conforms more closely to IBM XL compiler semantics
22463 when using AIX-compatible ABI@.  Pass floating-point arguments to
22464 prototyped functions beyond the register save area (RSA) on the stack
22465 in addition to argument FPRs.  Do not assume that most significant
22466 double in 128-bit long double value is properly rounded when comparing
22467 values and converting to double.  Use XL symbol names for long double
22468 support routines.
22470 The AIX calling convention was extended but not initially documented to
22471 handle an obscure K&R C case of calling a function that takes the
22472 address of its arguments with fewer arguments than declared.  IBM XL
22473 compilers access floating-point arguments that do not fit in the
22474 RSA from the stack when a subroutine is compiled without
22475 optimization.  Because always storing floating-point arguments on the
22476 stack is inefficient and rarely needed, this option is not enabled by
22477 default and only is necessary when calling subroutines compiled by IBM
22478 XL compilers without optimization.
22480 @item -mpe
22481 @opindex mpe
22482 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
22483 application written to use message passing with special startup code to
22484 enable the application to run.  The system must have PE installed in the
22485 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
22486 must be overridden with the @option{-specs=} option to specify the
22487 appropriate directory location.  The Parallel Environment does not
22488 support threads, so the @option{-mpe} option and the @option{-pthread}
22489 option are incompatible.
22491 @item -malign-natural
22492 @itemx -malign-power
22493 @opindex malign-natural
22494 @opindex malign-power
22495 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
22496 @option{-malign-natural} overrides the ABI-defined alignment of larger
22497 types, such as floating-point doubles, on their natural size-based boundary.
22498 The option @option{-malign-power} instructs GCC to follow the ABI-specified
22499 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
22501 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
22502 is not supported.
22504 @item -msoft-float
22505 @itemx -mhard-float
22506 @opindex msoft-float
22507 @opindex mhard-float
22508 Generate code that does not use (uses) the floating-point register set.
22509 Software floating-point emulation is provided if you use the
22510 @option{-msoft-float} option, and pass the option to GCC when linking.
22512 @item -msingle-float
22513 @itemx -mdouble-float
22514 @opindex msingle-float
22515 @opindex mdouble-float
22516 Generate code for single- or double-precision floating-point operations.
22517 @option{-mdouble-float} implies @option{-msingle-float}.
22519 @item -msimple-fpu
22520 @opindex msimple-fpu
22521 Do not generate @code{sqrt} and @code{div} instructions for hardware
22522 floating-point unit.
22524 @item -mfpu=@var{name}
22525 @opindex mfpu
22526 Specify type of floating-point unit.  Valid values for @var{name} are
22527 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
22528 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
22529 @samp{sp_full} (equivalent to @option{-msingle-float}),
22530 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
22532 @item -mxilinx-fpu
22533 @opindex mxilinx-fpu
22534 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
22536 @item -mmultiple
22537 @itemx -mno-multiple
22538 @opindex mmultiple
22539 @opindex mno-multiple
22540 Generate code that uses (does not use) the load multiple word
22541 instructions and the store multiple word instructions.  These
22542 instructions are generated by default on POWER systems, and not
22543 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
22544 PowerPC systems, since those instructions do not work when the
22545 processor is in little-endian mode.  The exceptions are PPC740 and
22546 PPC750 which permit these instructions in little-endian mode.
22548 @item -mstring
22549 @itemx -mno-string
22550 @opindex mstring
22551 @opindex mno-string
22552 Generate code that uses (does not use) the load string instructions
22553 and the store string word instructions to save multiple registers and
22554 do small block moves.  These instructions are generated by default on
22555 POWER systems, and not generated on PowerPC systems.  Do not use
22556 @option{-mstring} on little-endian PowerPC systems, since those
22557 instructions do not work when the processor is in little-endian mode.
22558 The exceptions are PPC740 and PPC750 which permit these instructions
22559 in little-endian mode.
22561 @item -mupdate
22562 @itemx -mno-update
22563 @opindex mupdate
22564 @opindex mno-update
22565 Generate code that uses (does not use) the load or store instructions
22566 that update the base register to the address of the calculated memory
22567 location.  These instructions are generated by default.  If you use
22568 @option{-mno-update}, there is a small window between the time that the
22569 stack pointer is updated and the address of the previous frame is
22570 stored, which means code that walks the stack frame across interrupts or
22571 signals may get corrupted data.
22573 @item -mavoid-indexed-addresses
22574 @itemx -mno-avoid-indexed-addresses
22575 @opindex mavoid-indexed-addresses
22576 @opindex mno-avoid-indexed-addresses
22577 Generate code that tries to avoid (not avoid) the use of indexed load
22578 or store instructions. These instructions can incur a performance
22579 penalty on Power6 processors in certain situations, such as when
22580 stepping through large arrays that cross a 16M boundary.  This option
22581 is enabled by default when targeting Power6 and disabled otherwise.
22583 @item -mfused-madd
22584 @itemx -mno-fused-madd
22585 @opindex mfused-madd
22586 @opindex mno-fused-madd
22587 Generate code that uses (does not use) the floating-point multiply and
22588 accumulate instructions.  These instructions are generated by default
22589 if hardware floating point is used.  The machine-dependent
22590 @option{-mfused-madd} option is now mapped to the machine-independent
22591 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
22592 mapped to @option{-ffp-contract=off}.
22594 @item -mmulhw
22595 @itemx -mno-mulhw
22596 @opindex mmulhw
22597 @opindex mno-mulhw
22598 Generate code that uses (does not use) the half-word multiply and
22599 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
22600 These instructions are generated by default when targeting those
22601 processors.
22603 @item -mdlmzb
22604 @itemx -mno-dlmzb
22605 @opindex mdlmzb
22606 @opindex mno-dlmzb
22607 Generate code that uses (does not use) the string-search @samp{dlmzb}
22608 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
22609 generated by default when targeting those processors.
22611 @item -mno-bit-align
22612 @itemx -mbit-align
22613 @opindex mno-bit-align
22614 @opindex mbit-align
22615 On System V.4 and embedded PowerPC systems do not (do) force structures
22616 and unions that contain bit-fields to be aligned to the base type of the
22617 bit-field.
22619 For example, by default a structure containing nothing but 8
22620 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
22621 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
22622 the structure is aligned to a 1-byte boundary and is 1 byte in
22623 size.
22625 @item -mno-strict-align
22626 @itemx -mstrict-align
22627 @opindex mno-strict-align
22628 @opindex mstrict-align
22629 On System V.4 and embedded PowerPC systems do not (do) assume that
22630 unaligned memory references are handled by the system.
22632 @item -mrelocatable
22633 @itemx -mno-relocatable
22634 @opindex mrelocatable
22635 @opindex mno-relocatable
22636 Generate code that allows (does not allow) a static executable to be
22637 relocated to a different address at run time.  A simple embedded
22638 PowerPC system loader should relocate the entire contents of
22639 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
22640 a table of 32-bit addresses generated by this option.  For this to
22641 work, all objects linked together must be compiled with
22642 @option{-mrelocatable} or @option{-mrelocatable-lib}.
22643 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
22645 @item -mrelocatable-lib
22646 @itemx -mno-relocatable-lib
22647 @opindex mrelocatable-lib
22648 @opindex mno-relocatable-lib
22649 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
22650 @code{.fixup} section to allow static executables to be relocated at
22651 run time, but @option{-mrelocatable-lib} does not use the smaller stack
22652 alignment of @option{-mrelocatable}.  Objects compiled with
22653 @option{-mrelocatable-lib} may be linked with objects compiled with
22654 any combination of the @option{-mrelocatable} options.
22656 @item -mno-toc
22657 @itemx -mtoc
22658 @opindex mno-toc
22659 @opindex mtoc
22660 On System V.4 and embedded PowerPC systems do not (do) assume that
22661 register 2 contains a pointer to a global area pointing to the addresses
22662 used in the program.
22664 @item -mlittle
22665 @itemx -mlittle-endian
22666 @opindex mlittle
22667 @opindex mlittle-endian
22668 On System V.4 and embedded PowerPC systems compile code for the
22669 processor in little-endian mode.  The @option{-mlittle-endian} option is
22670 the same as @option{-mlittle}.
22672 @item -mbig
22673 @itemx -mbig-endian
22674 @opindex mbig
22675 @opindex mbig-endian
22676 On System V.4 and embedded PowerPC systems compile code for the
22677 processor in big-endian mode.  The @option{-mbig-endian} option is
22678 the same as @option{-mbig}.
22680 @item -mdynamic-no-pic
22681 @opindex mdynamic-no-pic
22682 On Darwin and Mac OS X systems, compile code so that it is not
22683 relocatable, but that its external references are relocatable.  The
22684 resulting code is suitable for applications, but not shared
22685 libraries.
22687 @item -msingle-pic-base
22688 @opindex msingle-pic-base
22689 Treat the register used for PIC addressing as read-only, rather than
22690 loading it in the prologue for each function.  The runtime system is
22691 responsible for initializing this register with an appropriate value
22692 before execution begins.
22694 @item -mprioritize-restricted-insns=@var{priority}
22695 @opindex mprioritize-restricted-insns
22696 This option controls the priority that is assigned to
22697 dispatch-slot restricted instructions during the second scheduling
22698 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
22699 or @samp{2} to assign no, highest, or second-highest (respectively) 
22700 priority to dispatch-slot restricted
22701 instructions.
22703 @item -msched-costly-dep=@var{dependence_type}
22704 @opindex msched-costly-dep
22705 This option controls which dependences are considered costly
22706 by the target during instruction scheduling.  The argument
22707 @var{dependence_type} takes one of the following values:
22709 @table @asis
22710 @item @samp{no}
22711 No dependence is costly.
22713 @item @samp{all}
22714 All dependences are costly.
22716 @item @samp{true_store_to_load}
22717 A true dependence from store to load is costly.
22719 @item @samp{store_to_load}
22720 Any dependence from store to load is costly.
22722 @item @var{number}
22723 Any dependence for which the latency is greater than or equal to 
22724 @var{number} is costly.
22725 @end table
22727 @item -minsert-sched-nops=@var{scheme}
22728 @opindex minsert-sched-nops
22729 This option controls which NOP insertion scheme is used during
22730 the second scheduling pass.  The argument @var{scheme} takes one of the
22731 following values:
22733 @table @asis
22734 @item @samp{no}
22735 Don't insert NOPs.
22737 @item @samp{pad}
22738 Pad with NOPs any dispatch group that has vacant issue slots,
22739 according to the scheduler's grouping.
22741 @item @samp{regroup_exact}
22742 Insert NOPs to force costly dependent insns into
22743 separate groups.  Insert exactly as many NOPs as needed to force an insn
22744 to a new group, according to the estimated processor grouping.
22746 @item @var{number}
22747 Insert NOPs to force costly dependent insns into
22748 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
22749 @end table
22751 @item -mcall-sysv
22752 @opindex mcall-sysv
22753 On System V.4 and embedded PowerPC systems compile code using calling
22754 conventions that adhere to the March 1995 draft of the System V
22755 Application Binary Interface, PowerPC processor supplement.  This is the
22756 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
22758 @item -mcall-sysv-eabi
22759 @itemx -mcall-eabi
22760 @opindex mcall-sysv-eabi
22761 @opindex mcall-eabi
22762 Specify both @option{-mcall-sysv} and @option{-meabi} options.
22764 @item -mcall-sysv-noeabi
22765 @opindex mcall-sysv-noeabi
22766 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
22768 @item -mcall-aixdesc
22769 @opindex m
22770 On System V.4 and embedded PowerPC systems compile code for the AIX
22771 operating system.
22773 @item -mcall-linux
22774 @opindex mcall-linux
22775 On System V.4 and embedded PowerPC systems compile code for the
22776 Linux-based GNU system.
22778 @item -mcall-freebsd
22779 @opindex mcall-freebsd
22780 On System V.4 and embedded PowerPC systems compile code for the
22781 FreeBSD operating system.
22783 @item -mcall-netbsd
22784 @opindex mcall-netbsd
22785 On System V.4 and embedded PowerPC systems compile code for the
22786 NetBSD operating system.
22788 @item -mcall-openbsd
22789 @opindex mcall-netbsd
22790 On System V.4 and embedded PowerPC systems compile code for the
22791 OpenBSD operating system.
22793 @item -maix-struct-return
22794 @opindex maix-struct-return
22795 Return all structures in memory (as specified by the AIX ABI)@.
22797 @item -msvr4-struct-return
22798 @opindex msvr4-struct-return
22799 Return structures smaller than 8 bytes in registers (as specified by the
22800 SVR4 ABI)@.
22802 @item -mabi=@var{abi-type}
22803 @opindex mabi
22804 Extend the current ABI with a particular extension, or remove such extension.
22805 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
22806 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
22807 @samp{elfv1}, @samp{elfv2}@.
22809 @item -mabi=spe
22810 @opindex mabi=spe
22811 Extend the current ABI with SPE ABI extensions.  This does not change
22812 the default ABI, instead it adds the SPE ABI extensions to the current
22813 ABI@.
22815 @item -mabi=no-spe
22816 @opindex mabi=no-spe
22817 Disable Book-E SPE ABI extensions for the current ABI@.
22819 @item -mabi=ibmlongdouble
22820 @opindex mabi=ibmlongdouble
22821 Change the current ABI to use IBM extended-precision long double.
22822 This is not likely to work if your system defaults to using IEEE
22823 extended-precision long double.  If you change the long double type
22824 from IEEE extended-precision, the compiler will issue a warning unless
22825 you use the @option{-Wno-psabi} option.
22827 @item -mabi=ieeelongdouble
22828 @opindex mabi=ieeelongdouble
22829 Change the current ABI to use IEEE extended-precision long double.
22830 This is not likely to work if your system defaults to using IBM
22831 extended-precision long double.  If you change the long double type
22832 from IBM extended-precision, the compiler will issue a warning unless
22833 you use the @option{-Wno-psabi} option.
22835 @item -mabi=elfv1
22836 @opindex mabi=elfv1
22837 Change the current ABI to use the ELFv1 ABI.
22838 This is the default ABI for big-endian PowerPC 64-bit Linux.
22839 Overriding the default ABI requires special system support and is
22840 likely to fail in spectacular ways.
22842 @item -mabi=elfv2
22843 @opindex mabi=elfv2
22844 Change the current ABI to use the ELFv2 ABI.
22845 This is the default ABI for little-endian PowerPC 64-bit Linux.
22846 Overriding the default ABI requires special system support and is
22847 likely to fail in spectacular ways.
22849 @item -mgnu-attribute
22850 @itemx -mno-gnu-attribute
22851 @opindex mgnu-attribute
22852 @opindex mno-gnu-attribute
22853 Emit .gnu_attribute assembly directives to set tag/value pairs in a
22854 .gnu.attributes section that specify ABI variations in function
22855 parameters or return values.
22857 @item -mprototype
22858 @itemx -mno-prototype
22859 @opindex mprototype
22860 @opindex mno-prototype
22861 On System V.4 and embedded PowerPC systems assume that all calls to
22862 variable argument functions are properly prototyped.  Otherwise, the
22863 compiler must insert an instruction before every non-prototyped call to
22864 set or clear bit 6 of the condition code register (@code{CR}) to
22865 indicate whether floating-point values are passed in the floating-point
22866 registers in case the function takes variable arguments.  With
22867 @option{-mprototype}, only calls to prototyped variable argument functions
22868 set or clear the bit.
22870 @item -msim
22871 @opindex msim
22872 On embedded PowerPC systems, assume that the startup module is called
22873 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
22874 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
22875 configurations.
22877 @item -mmvme
22878 @opindex mmvme
22879 On embedded PowerPC systems, assume that the startup module is called
22880 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
22881 @file{libc.a}.
22883 @item -mads
22884 @opindex mads
22885 On embedded PowerPC systems, assume that the startup module is called
22886 @file{crt0.o} and the standard C libraries are @file{libads.a} and
22887 @file{libc.a}.
22889 @item -myellowknife
22890 @opindex myellowknife
22891 On embedded PowerPC systems, assume that the startup module is called
22892 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
22893 @file{libc.a}.
22895 @item -mvxworks
22896 @opindex mvxworks
22897 On System V.4 and embedded PowerPC systems, specify that you are
22898 compiling for a VxWorks system.
22900 @item -memb
22901 @opindex memb
22902 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
22903 header to indicate that @samp{eabi} extended relocations are used.
22905 @item -meabi
22906 @itemx -mno-eabi
22907 @opindex meabi
22908 @opindex mno-eabi
22909 On System V.4 and embedded PowerPC systems do (do not) adhere to the
22910 Embedded Applications Binary Interface (EABI), which is a set of
22911 modifications to the System V.4 specifications.  Selecting @option{-meabi}
22912 means that the stack is aligned to an 8-byte boundary, a function
22913 @code{__eabi} is called from @code{main} to set up the EABI
22914 environment, and the @option{-msdata} option can use both @code{r2} and
22915 @code{r13} to point to two separate small data areas.  Selecting
22916 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
22917 no EABI initialization function is called from @code{main}, and the
22918 @option{-msdata} option only uses @code{r13} to point to a single
22919 small data area.  The @option{-meabi} option is on by default if you
22920 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
22922 @item -msdata=eabi
22923 @opindex msdata=eabi
22924 On System V.4 and embedded PowerPC systems, put small initialized
22925 @code{const} global and static data in the @code{.sdata2} section, which
22926 is pointed to by register @code{r2}.  Put small initialized
22927 non-@code{const} global and static data in the @code{.sdata} section,
22928 which is pointed to by register @code{r13}.  Put small uninitialized
22929 global and static data in the @code{.sbss} section, which is adjacent to
22930 the @code{.sdata} section.  The @option{-msdata=eabi} option is
22931 incompatible with the @option{-mrelocatable} option.  The
22932 @option{-msdata=eabi} option also sets the @option{-memb} option.
22934 @item -msdata=sysv
22935 @opindex msdata=sysv
22936 On System V.4 and embedded PowerPC systems, put small global and static
22937 data in the @code{.sdata} section, which is pointed to by register
22938 @code{r13}.  Put small uninitialized global and static data in the
22939 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
22940 The @option{-msdata=sysv} option is incompatible with the
22941 @option{-mrelocatable} option.
22943 @item -msdata=default
22944 @itemx -msdata
22945 @opindex msdata=default
22946 @opindex msdata
22947 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
22948 compile code the same as @option{-msdata=eabi}, otherwise compile code the
22949 same as @option{-msdata=sysv}.
22951 @item -msdata=data
22952 @opindex msdata=data
22953 On System V.4 and embedded PowerPC systems, put small global
22954 data in the @code{.sdata} section.  Put small uninitialized global
22955 data in the @code{.sbss} section.  Do not use register @code{r13}
22956 to address small data however.  This is the default behavior unless
22957 other @option{-msdata} options are used.
22959 @item -msdata=none
22960 @itemx -mno-sdata
22961 @opindex msdata=none
22962 @opindex mno-sdata
22963 On embedded PowerPC systems, put all initialized global and static data
22964 in the @code{.data} section, and all uninitialized data in the
22965 @code{.bss} section.
22967 @item -mblock-move-inline-limit=@var{num}
22968 @opindex mblock-move-inline-limit
22969 Inline all block moves (such as calls to @code{memcpy} or structure
22970 copies) less than or equal to @var{num} bytes.  The minimum value for
22971 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
22972 targets.  The default value is target-specific.
22974 @item -G @var{num}
22975 @opindex G
22976 @cindex smaller data references (PowerPC)
22977 @cindex .sdata/.sdata2 references (PowerPC)
22978 On embedded PowerPC systems, put global and static items less than or
22979 equal to @var{num} bytes into the small data or BSS sections instead of
22980 the normal data or BSS section.  By default, @var{num} is 8.  The
22981 @option{-G @var{num}} switch is also passed to the linker.
22982 All modules should be compiled with the same @option{-G @var{num}} value.
22984 @item -mregnames
22985 @itemx -mno-regnames
22986 @opindex mregnames
22987 @opindex mno-regnames
22988 On System V.4 and embedded PowerPC systems do (do not) emit register
22989 names in the assembly language output using symbolic forms.
22991 @item -mlongcall
22992 @itemx -mno-longcall
22993 @opindex mlongcall
22994 @opindex mno-longcall
22995 By default assume that all calls are far away so that a longer and more
22996 expensive calling sequence is required.  This is required for calls
22997 farther than 32 megabytes (33,554,432 bytes) from the current location.
22998 A short call is generated if the compiler knows
22999 the call cannot be that far away.  This setting can be overridden by
23000 the @code{shortcall} function attribute, or by @code{#pragma
23001 longcall(0)}.
23003 Some linkers are capable of detecting out-of-range calls and generating
23004 glue code on the fly.  On these systems, long calls are unnecessary and
23005 generate slower code.  As of this writing, the AIX linker can do this,
23006 as can the GNU linker for PowerPC/64.  It is planned to add this feature
23007 to the GNU linker for 32-bit PowerPC systems as well.
23009 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
23010 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
23011 addresses represent the callee and the branch island.  The
23012 Darwin/PPC linker prefers the first address and generates a @code{bl
23013 callee} if the PPC @code{bl} instruction reaches the callee directly;
23014 otherwise, the linker generates @code{bl L42} to call the branch
23015 island.  The branch island is appended to the body of the
23016 calling function; it computes the full 32-bit address of the callee
23017 and jumps to it.
23019 On Mach-O (Darwin) systems, this option directs the compiler emit to
23020 the glue for every direct call, and the Darwin linker decides whether
23021 to use or discard it.
23023 In the future, GCC may ignore all longcall specifications
23024 when the linker is known to generate glue.
23026 @item -mtls-markers
23027 @itemx -mno-tls-markers
23028 @opindex mtls-markers
23029 @opindex mno-tls-markers
23030 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
23031 specifying the function argument.  The relocation allows the linker to
23032 reliably associate function call with argument setup instructions for
23033 TLS optimization, which in turn allows GCC to better schedule the
23034 sequence.
23036 @item -mrecip
23037 @itemx -mno-recip
23038 @opindex mrecip
23039 This option enables use of the reciprocal estimate and
23040 reciprocal square root estimate instructions with additional
23041 Newton-Raphson steps to increase precision instead of doing a divide or
23042 square root and divide for floating-point arguments.  You should use
23043 the @option{-ffast-math} option when using @option{-mrecip} (or at
23044 least @option{-funsafe-math-optimizations},
23045 @option{-ffinite-math-only}, @option{-freciprocal-math} and
23046 @option{-fno-trapping-math}).  Note that while the throughput of the
23047 sequence is generally higher than the throughput of the non-reciprocal
23048 instruction, the precision of the sequence can be decreased by up to 2
23049 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
23050 roots.
23052 @item -mrecip=@var{opt}
23053 @opindex mrecip=opt
23054 This option controls which reciprocal estimate instructions
23055 may be used.  @var{opt} is a comma-separated list of options, which may
23056 be preceded by a @code{!} to invert the option:
23058 @table @samp
23060 @item all
23061 Enable all estimate instructions.
23063 @item default 
23064 Enable the default instructions, equivalent to @option{-mrecip}.
23066 @item none 
23067 Disable all estimate instructions, equivalent to @option{-mno-recip}.
23069 @item div 
23070 Enable the reciprocal approximation instructions for both 
23071 single and double precision.
23073 @item divf 
23074 Enable the single-precision reciprocal approximation instructions.
23076 @item divd 
23077 Enable the double-precision reciprocal approximation instructions.
23079 @item rsqrt 
23080 Enable the reciprocal square root approximation instructions for both
23081 single and double precision.
23083 @item rsqrtf 
23084 Enable the single-precision reciprocal square root approximation instructions.
23086 @item rsqrtd 
23087 Enable the double-precision reciprocal square root approximation instructions.
23089 @end table
23091 So, for example, @option{-mrecip=all,!rsqrtd} enables
23092 all of the reciprocal estimate instructions, except for the
23093 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
23094 which handle the double-precision reciprocal square root calculations.
23096 @item -mrecip-precision
23097 @itemx -mno-recip-precision
23098 @opindex mrecip-precision
23099 Assume (do not assume) that the reciprocal estimate instructions
23100 provide higher-precision estimates than is mandated by the PowerPC
23101 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
23102 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
23103 The double-precision square root estimate instructions are not generated by
23104 default on low-precision machines, since they do not provide an
23105 estimate that converges after three steps.
23107 @item -mveclibabi=@var{type}
23108 @opindex mveclibabi
23109 Specifies the ABI type to use for vectorizing intrinsics using an
23110 external library.  The only type supported at present is @samp{mass},
23111 which specifies to use IBM's Mathematical Acceleration Subsystem
23112 (MASS) libraries for vectorizing intrinsics using external libraries.
23113 GCC currently emits calls to @code{acosd2}, @code{acosf4},
23114 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
23115 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
23116 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
23117 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
23118 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
23119 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
23120 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
23121 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
23122 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
23123 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
23124 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
23125 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
23126 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
23127 for power7.  Both @option{-ftree-vectorize} and
23128 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
23129 libraries must be specified at link time.
23131 @item -mfriz
23132 @itemx -mno-friz
23133 @opindex mfriz
23134 Generate (do not generate) the @code{friz} instruction when the
23135 @option{-funsafe-math-optimizations} option is used to optimize
23136 rounding of floating-point values to 64-bit integer and back to floating
23137 point.  The @code{friz} instruction does not return the same value if
23138 the floating-point number is too large to fit in an integer.
23140 @item -mpointers-to-nested-functions
23141 @itemx -mno-pointers-to-nested-functions
23142 @opindex mpointers-to-nested-functions
23143 Generate (do not generate) code to load up the static chain register
23144 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
23145 systems where a function pointer points to a 3-word descriptor giving
23146 the function address, TOC value to be loaded in register @code{r2}, and
23147 static chain value to be loaded in register @code{r11}.  The
23148 @option{-mpointers-to-nested-functions} is on by default.  You cannot
23149 call through pointers to nested functions or pointers
23150 to functions compiled in other languages that use the static chain if
23151 you use @option{-mno-pointers-to-nested-functions}.
23153 @item -msave-toc-indirect
23154 @itemx -mno-save-toc-indirect
23155 @opindex msave-toc-indirect
23156 Generate (do not generate) code to save the TOC value in the reserved
23157 stack location in the function prologue if the function calls through
23158 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
23159 saved in the prologue, it is saved just before the call through the
23160 pointer.  The @option{-mno-save-toc-indirect} option is the default.
23162 @item -mcompat-align-parm
23163 @itemx -mno-compat-align-parm
23164 @opindex mcompat-align-parm
23165 Generate (do not generate) code to pass structure parameters with a
23166 maximum alignment of 64 bits, for compatibility with older versions
23167 of GCC.
23169 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
23170 structure parameter on a 128-bit boundary when that structure contained
23171 a member requiring 128-bit alignment.  This is corrected in more
23172 recent versions of GCC.  This option may be used to generate code
23173 that is compatible with functions compiled with older versions of
23174 GCC.
23176 The @option{-mno-compat-align-parm} option is the default.
23178 @item -mstack-protector-guard=@var{guard}
23179 @itemx -mstack-protector-guard-reg=@var{reg}
23180 @itemx -mstack-protector-guard-offset=@var{offset}
23181 @itemx -mstack-protector-guard-symbol=@var{symbol}
23182 @opindex mstack-protector-guard
23183 @opindex mstack-protector-guard-reg
23184 @opindex mstack-protector-guard-offset
23185 @opindex mstack-protector-guard-symbol
23186 Generate stack protection code using canary at @var{guard}.  Supported
23187 locations are @samp{global} for global canary or @samp{tls} for per-thread
23188 canary in the TLS block (the default with GNU libc version 2.4 or later).
23190 With the latter choice the options
23191 @option{-mstack-protector-guard-reg=@var{reg}} and
23192 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
23193 which register to use as base register for reading the canary, and from what
23194 offset from that base register. The default for those is as specified in the
23195 relevant ABI.  @option{-mstack-protector-guard-symbol=@var{symbol}} overrides
23196 the offset with a symbol reference to a canary in the TLS block.
23197 @end table
23199 @node RX Options
23200 @subsection RX Options
23201 @cindex RX Options
23203 These command-line options are defined for RX targets:
23205 @table @gcctabopt
23206 @item -m64bit-doubles
23207 @itemx -m32bit-doubles
23208 @opindex m64bit-doubles
23209 @opindex m32bit-doubles
23210 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
23211 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
23212 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
23213 works on 32-bit values, which is why the default is
23214 @option{-m32bit-doubles}.
23216 @item -fpu
23217 @itemx -nofpu
23218 @opindex fpu
23219 @opindex nofpu
23220 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
23221 floating-point hardware.  The default is enabled for the RX600
23222 series and disabled for the RX200 series.
23224 Floating-point instructions are only generated for 32-bit floating-point 
23225 values, however, so the FPU hardware is not used for doubles if the
23226 @option{-m64bit-doubles} option is used.
23228 @emph{Note} If the @option{-fpu} option is enabled then
23229 @option{-funsafe-math-optimizations} is also enabled automatically.
23230 This is because the RX FPU instructions are themselves unsafe.
23232 @item -mcpu=@var{name}
23233 @opindex mcpu
23234 Selects the type of RX CPU to be targeted.  Currently three types are
23235 supported, the generic @samp{RX600} and @samp{RX200} series hardware and
23236 the specific @samp{RX610} CPU.  The default is @samp{RX600}.
23238 The only difference between @samp{RX600} and @samp{RX610} is that the
23239 @samp{RX610} does not support the @code{MVTIPL} instruction.
23241 The @samp{RX200} series does not have a hardware floating-point unit
23242 and so @option{-nofpu} is enabled by default when this type is
23243 selected.
23245 @item -mbig-endian-data
23246 @itemx -mlittle-endian-data
23247 @opindex mbig-endian-data
23248 @opindex mlittle-endian-data
23249 Store data (but not code) in the big-endian format.  The default is
23250 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
23251 format.
23253 @item -msmall-data-limit=@var{N}
23254 @opindex msmall-data-limit
23255 Specifies the maximum size in bytes of global and static variables
23256 which can be placed into the small data area.  Using the small data
23257 area can lead to smaller and faster code, but the size of area is
23258 limited and it is up to the programmer to ensure that the area does
23259 not overflow.  Also when the small data area is used one of the RX's
23260 registers (usually @code{r13}) is reserved for use pointing to this
23261 area, so it is no longer available for use by the compiler.  This
23262 could result in slower and/or larger code if variables are pushed onto
23263 the stack instead of being held in this register.
23265 Note, common variables (variables that have not been initialized) and
23266 constants are not placed into the small data area as they are assigned
23267 to other sections in the output executable.
23269 The default value is zero, which disables this feature.  Note, this
23270 feature is not enabled by default with higher optimization levels
23271 (@option{-O2} etc) because of the potentially detrimental effects of
23272 reserving a register.  It is up to the programmer to experiment and
23273 discover whether this feature is of benefit to their program.  See the
23274 description of the @option{-mpid} option for a description of how the
23275 actual register to hold the small data area pointer is chosen.
23277 @item -msim
23278 @itemx -mno-sim
23279 @opindex msim
23280 @opindex mno-sim
23281 Use the simulator runtime.  The default is to use the libgloss
23282 board-specific runtime.
23284 @item -mas100-syntax
23285 @itemx -mno-as100-syntax
23286 @opindex mas100-syntax
23287 @opindex mno-as100-syntax
23288 When generating assembler output use a syntax that is compatible with
23289 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
23290 assembler, but it has some restrictions so it is not generated by default.
23292 @item -mmax-constant-size=@var{N}
23293 @opindex mmax-constant-size
23294 Specifies the maximum size, in bytes, of a constant that can be used as
23295 an operand in a RX instruction.  Although the RX instruction set does
23296 allow constants of up to 4 bytes in length to be used in instructions,
23297 a longer value equates to a longer instruction.  Thus in some
23298 circumstances it can be beneficial to restrict the size of constants
23299 that are used in instructions.  Constants that are too big are instead
23300 placed into a constant pool and referenced via register indirection.
23302 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
23303 or 4 means that constants of any size are allowed.
23305 @item -mrelax
23306 @opindex mrelax
23307 Enable linker relaxation.  Linker relaxation is a process whereby the
23308 linker attempts to reduce the size of a program by finding shorter
23309 versions of various instructions.  Disabled by default.
23311 @item -mint-register=@var{N}
23312 @opindex mint-register
23313 Specify the number of registers to reserve for fast interrupt handler
23314 functions.  The value @var{N} can be between 0 and 4.  A value of 1
23315 means that register @code{r13} is reserved for the exclusive use
23316 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
23317 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
23318 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
23319 A value of 0, the default, does not reserve any registers.
23321 @item -msave-acc-in-interrupts
23322 @opindex msave-acc-in-interrupts
23323 Specifies that interrupt handler functions should preserve the
23324 accumulator register.  This is only necessary if normal code might use
23325 the accumulator register, for example because it performs 64-bit
23326 multiplications.  The default is to ignore the accumulator as this
23327 makes the interrupt handlers faster.
23329 @item -mpid
23330 @itemx -mno-pid
23331 @opindex mpid
23332 @opindex mno-pid
23333 Enables the generation of position independent data.  When enabled any
23334 access to constant data is done via an offset from a base address
23335 held in a register.  This allows the location of constant data to be
23336 determined at run time without requiring the executable to be
23337 relocated, which is a benefit to embedded applications with tight
23338 memory constraints.  Data that can be modified is not affected by this
23339 option.
23341 Note, using this feature reserves a register, usually @code{r13}, for
23342 the constant data base address.  This can result in slower and/or
23343 larger code, especially in complicated functions.
23345 The actual register chosen to hold the constant data base address
23346 depends upon whether the @option{-msmall-data-limit} and/or the
23347 @option{-mint-register} command-line options are enabled.  Starting
23348 with register @code{r13} and proceeding downwards, registers are
23349 allocated first to satisfy the requirements of @option{-mint-register},
23350 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
23351 is possible for the small data area register to be @code{r8} if both
23352 @option{-mint-register=4} and @option{-mpid} are specified on the
23353 command line.
23355 By default this feature is not enabled.  The default can be restored
23356 via the @option{-mno-pid} command-line option.
23358 @item -mno-warn-multiple-fast-interrupts
23359 @itemx -mwarn-multiple-fast-interrupts
23360 @opindex mno-warn-multiple-fast-interrupts
23361 @opindex mwarn-multiple-fast-interrupts
23362 Prevents GCC from issuing a warning message if it finds more than one
23363 fast interrupt handler when it is compiling a file.  The default is to
23364 issue a warning for each extra fast interrupt handler found, as the RX
23365 only supports one such interrupt.
23367 @item -mallow-string-insns
23368 @itemx -mno-allow-string-insns
23369 @opindex mallow-string-insns
23370 @opindex mno-allow-string-insns
23371 Enables or disables the use of the string manipulation instructions
23372 @code{SMOVF}, @code{SCMPU}, @code{SMOVB}, @code{SMOVU}, @code{SUNTIL}
23373 @code{SWHILE} and also the @code{RMPA} instruction.  These
23374 instructions may prefetch data, which is not safe to do if accessing
23375 an I/O register.  (See section 12.2.7 of the RX62N Group User's Manual
23376 for more information).
23378 The default is to allow these instructions, but it is not possible for
23379 GCC to reliably detect all circumstances where a string instruction
23380 might be used to access an I/O register, so their use cannot be
23381 disabled automatically.  Instead it is reliant upon the programmer to
23382 use the @option{-mno-allow-string-insns} option if their program
23383 accesses I/O space.
23385 When the instructions are enabled GCC defines the C preprocessor
23386 symbol @code{__RX_ALLOW_STRING_INSNS__}, otherwise it defines the
23387 symbol @code{__RX_DISALLOW_STRING_INSNS__}.
23389 @item -mjsr
23390 @itemx -mno-jsr
23391 @opindex mjsr
23392 @opindex mno-jsr
23393 Use only (or not only) @code{JSR} instructions to access functions.
23394 This option can be used when code size exceeds the range of @code{BSR}
23395 instructions.  Note that @option{-mno-jsr} does not mean to not use
23396 @code{JSR} but instead means that any type of branch may be used.
23397 @end table
23399 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
23400 has special significance to the RX port when used with the
23401 @code{interrupt} function attribute.  This attribute indicates a
23402 function intended to process fast interrupts.  GCC ensures
23403 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
23404 and/or @code{r13} and only provided that the normal use of the
23405 corresponding registers have been restricted via the
23406 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
23407 options.
23409 @node S/390 and zSeries Options
23410 @subsection S/390 and zSeries Options
23411 @cindex S/390 and zSeries Options
23413 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
23415 @table @gcctabopt
23416 @item -mhard-float
23417 @itemx -msoft-float
23418 @opindex mhard-float
23419 @opindex msoft-float
23420 Use (do not use) the hardware floating-point instructions and registers
23421 for floating-point operations.  When @option{-msoft-float} is specified,
23422 functions in @file{libgcc.a} are used to perform floating-point
23423 operations.  When @option{-mhard-float} is specified, the compiler
23424 generates IEEE floating-point instructions.  This is the default.
23426 @item -mhard-dfp
23427 @itemx -mno-hard-dfp
23428 @opindex mhard-dfp
23429 @opindex mno-hard-dfp
23430 Use (do not use) the hardware decimal-floating-point instructions for
23431 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
23432 specified, functions in @file{libgcc.a} are used to perform
23433 decimal-floating-point operations.  When @option{-mhard-dfp} is
23434 specified, the compiler generates decimal-floating-point hardware
23435 instructions.  This is the default for @option{-march=z9-ec} or higher.
23437 @item -mlong-double-64
23438 @itemx -mlong-double-128
23439 @opindex mlong-double-64
23440 @opindex mlong-double-128
23441 These switches control the size of @code{long double} type. A size
23442 of 64 bits makes the @code{long double} type equivalent to the @code{double}
23443 type. This is the default.
23445 @item -mbackchain
23446 @itemx -mno-backchain
23447 @opindex mbackchain
23448 @opindex mno-backchain
23449 Store (do not store) the address of the caller's frame as backchain pointer
23450 into the callee's stack frame.
23451 A backchain may be needed to allow debugging using tools that do not understand
23452 DWARF call frame information.
23453 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
23454 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
23455 the backchain is placed into the topmost word of the 96/160 byte register
23456 save area.
23458 In general, code compiled with @option{-mbackchain} is call-compatible with
23459 code compiled with @option{-mmo-backchain}; however, use of the backchain
23460 for debugging purposes usually requires that the whole binary is built with
23461 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
23462 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
23463 to build a linux kernel use @option{-msoft-float}.
23465 The default is to not maintain the backchain.
23467 @item -mpacked-stack
23468 @itemx -mno-packed-stack
23469 @opindex mpacked-stack
23470 @opindex mno-packed-stack
23471 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
23472 specified, the compiler uses the all fields of the 96/160 byte register save
23473 area only for their default purpose; unused fields still take up stack space.
23474 When @option{-mpacked-stack} is specified, register save slots are densely
23475 packed at the top of the register save area; unused space is reused for other
23476 purposes, allowing for more efficient use of the available stack space.
23477 However, when @option{-mbackchain} is also in effect, the topmost word of
23478 the save area is always used to store the backchain, and the return address
23479 register is always saved two words below the backchain.
23481 As long as the stack frame backchain is not used, code generated with
23482 @option{-mpacked-stack} is call-compatible with code generated with
23483 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
23484 S/390 or zSeries generated code that uses the stack frame backchain at run
23485 time, not just for debugging purposes.  Such code is not call-compatible
23486 with code compiled with @option{-mpacked-stack}.  Also, note that the
23487 combination of @option{-mbackchain},
23488 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
23489 to build a linux kernel use @option{-msoft-float}.
23491 The default is to not use the packed stack layout.
23493 @item -msmall-exec
23494 @itemx -mno-small-exec
23495 @opindex msmall-exec
23496 @opindex mno-small-exec
23497 Generate (or do not generate) code using the @code{bras} instruction
23498 to do subroutine calls.
23499 This only works reliably if the total executable size does not
23500 exceed 64k.  The default is to use the @code{basr} instruction instead,
23501 which does not have this limitation.
23503 @item -m64
23504 @itemx -m31
23505 @opindex m64
23506 @opindex m31
23507 When @option{-m31} is specified, generate code compliant to the
23508 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
23509 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
23510 particular to generate 64-bit instructions.  For the @samp{s390}
23511 targets, the default is @option{-m31}, while the @samp{s390x}
23512 targets default to @option{-m64}.
23514 @item -mzarch
23515 @itemx -mesa
23516 @opindex mzarch
23517 @opindex mesa
23518 When @option{-mzarch} is specified, generate code using the
23519 instructions available on z/Architecture.
23520 When @option{-mesa} is specified, generate code using the
23521 instructions available on ESA/390.  Note that @option{-mesa} is
23522 not possible with @option{-m64}.
23523 When generating code compliant to the GNU/Linux for S/390 ABI,
23524 the default is @option{-mesa}.  When generating code compliant
23525 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
23527 @item -mhtm
23528 @itemx -mno-htm
23529 @opindex mhtm
23530 @opindex mno-htm
23531 The @option{-mhtm} option enables a set of builtins making use of
23532 instructions available with the transactional execution facility
23533 introduced with the IBM zEnterprise EC12 machine generation
23534 @ref{S/390 System z Built-in Functions}.
23535 @option{-mhtm} is enabled by default when using @option{-march=zEC12}.
23537 @item -mvx
23538 @itemx -mno-vx
23539 @opindex mvx
23540 @opindex mno-vx
23541 When @option{-mvx} is specified, generate code using the instructions
23542 available with the vector extension facility introduced with the IBM
23543 z13 machine generation.
23544 This option changes the ABI for some vector type values with regard to
23545 alignment and calling conventions.  In case vector type values are
23546 being used in an ABI-relevant context a GAS @samp{.gnu_attribute}
23547 command will be added to mark the resulting binary with the ABI used.
23548 @option{-mvx} is enabled by default when using @option{-march=z13}.
23550 @item -mzvector
23551 @itemx -mno-zvector
23552 @opindex mzvector
23553 @opindex mno-zvector
23554 The @option{-mzvector} option enables vector language extensions and
23555 builtins using instructions available with the vector extension
23556 facility introduced with the IBM z13 machine generation.
23557 This option adds support for @samp{vector} to be used as a keyword to
23558 define vector type variables and arguments.  @samp{vector} is only
23559 available when GNU extensions are enabled.  It will not be expanded
23560 when requesting strict standard compliance e.g. with @option{-std=c99}.
23561 In addition to the GCC low-level builtins @option{-mzvector} enables
23562 a set of builtins added for compatibility with AltiVec-style
23563 implementations like Power and Cell.  In order to make use of these
23564 builtins the header file @file{vecintrin.h} needs to be included.
23565 @option{-mzvector} is disabled by default.
23567 @item -mmvcle
23568 @itemx -mno-mvcle
23569 @opindex mmvcle
23570 @opindex mno-mvcle
23571 Generate (or do not generate) code using the @code{mvcle} instruction
23572 to perform block moves.  When @option{-mno-mvcle} is specified,
23573 use a @code{mvc} loop instead.  This is the default unless optimizing for
23574 size.
23576 @item -mdebug
23577 @itemx -mno-debug
23578 @opindex mdebug
23579 @opindex mno-debug
23580 Print (or do not print) additional debug information when compiling.
23581 The default is to not print debug information.
23583 @item -march=@var{cpu-type}
23584 @opindex march
23585 Generate code that runs on @var{cpu-type}, which is the name of a
23586 system representing a certain processor type.  Possible values for
23587 @var{cpu-type} are @samp{z900}/@samp{arch5}, @samp{z990}/@samp{arch6},
23588 @samp{z9-109}, @samp{z9-ec}/@samp{arch7}, @samp{z10}/@samp{arch8},
23589 @samp{z196}/@samp{arch9}, @samp{zEC12}, @samp{z13}/@samp{arch11}, and
23590 @samp{native}.
23592 The default is @option{-march=z900}.  @samp{g5}/@samp{arch3} and
23593 @samp{g6} are deprecated and will be removed with future releases.
23595 Specifying @samp{native} as cpu type can be used to select the best
23596 architecture option for the host processor.
23597 @option{-march=native} has no effect if GCC does not recognize the
23598 processor.
23600 @item -mtune=@var{cpu-type}
23601 @opindex mtune
23602 Tune to @var{cpu-type} everything applicable about the generated code,
23603 except for the ABI and the set of available instructions.
23604 The list of @var{cpu-type} values is the same as for @option{-march}.
23605 The default is the value used for @option{-march}.
23607 @item -mtpf-trace
23608 @itemx -mno-tpf-trace
23609 @opindex mtpf-trace
23610 @opindex mno-tpf-trace
23611 Generate code that adds (does not add) in TPF OS specific branches to trace
23612 routines in the operating system.  This option is off by default, even
23613 when compiling for the TPF OS@.
23615 @item -mfused-madd
23616 @itemx -mno-fused-madd
23617 @opindex mfused-madd
23618 @opindex mno-fused-madd
23619 Generate code that uses (does not use) the floating-point multiply and
23620 accumulate instructions.  These instructions are generated by default if
23621 hardware floating point is used.
23623 @item -mwarn-framesize=@var{framesize}
23624 @opindex mwarn-framesize
23625 Emit a warning if the current function exceeds the given frame size.  Because
23626 this is a compile-time check it doesn't need to be a real problem when the program
23627 runs.  It is intended to identify functions that most probably cause
23628 a stack overflow.  It is useful to be used in an environment with limited stack
23629 size e.g.@: the linux kernel.
23631 @item -mwarn-dynamicstack
23632 @opindex mwarn-dynamicstack
23633 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
23634 arrays.  This is generally a bad idea with a limited stack size.
23636 @item -mstack-guard=@var{stack-guard}
23637 @itemx -mstack-size=@var{stack-size}
23638 @opindex mstack-guard
23639 @opindex mstack-size
23640 If these options are provided the S/390 back end emits additional instructions in
23641 the function prologue that trigger a trap if the stack size is @var{stack-guard}
23642 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
23643 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
23644 the frame size of the compiled function is chosen.
23645 These options are intended to be used to help debugging stack overflow problems.
23646 The additionally emitted code causes only little overhead and hence can also be
23647 used in production-like systems without greater performance degradation.  The given
23648 values have to be exact powers of 2 and @var{stack-size} has to be greater than
23649 @var{stack-guard} without exceeding 64k.
23650 In order to be efficient the extra code makes the assumption that the stack starts
23651 at an address aligned to the value given by @var{stack-size}.
23652 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
23654 @item -mhotpatch=@var{pre-halfwords},@var{post-halfwords}
23655 @opindex mhotpatch
23656 If the hotpatch option is enabled, a ``hot-patching'' function
23657 prologue is generated for all functions in the compilation unit.
23658 The funtion label is prepended with the given number of two-byte
23659 NOP instructions (@var{pre-halfwords}, maximum 1000000).  After
23660 the label, 2 * @var{post-halfwords} bytes are appended, using the
23661 largest NOP like instructions the architecture allows (maximum
23662 1000000).
23664 If both arguments are zero, hotpatching is disabled.
23666 This option can be overridden for individual functions with the
23667 @code{hotpatch} attribute.
23668 @end table
23670 @node Score Options
23671 @subsection Score Options
23672 @cindex Score Options
23674 These options are defined for Score implementations:
23676 @table @gcctabopt
23677 @item -meb
23678 @opindex meb
23679 Compile code for big-endian mode.  This is the default.
23681 @item -mel
23682 @opindex mel
23683 Compile code for little-endian mode.
23685 @item -mnhwloop
23686 @opindex mnhwloop
23687 Disable generation of @code{bcnz} instructions.
23689 @item -muls
23690 @opindex muls
23691 Enable generation of unaligned load and store instructions.
23693 @item -mmac
23694 @opindex mmac
23695 Enable the use of multiply-accumulate instructions. Disabled by default.
23697 @item -mscore5
23698 @opindex mscore5
23699 Specify the SCORE5 as the target architecture.
23701 @item -mscore5u
23702 @opindex mscore5u
23703 Specify the SCORE5U of the target architecture.
23705 @item -mscore7
23706 @opindex mscore7
23707 Specify the SCORE7 as the target architecture. This is the default.
23709 @item -mscore7d
23710 @opindex mscore7d
23711 Specify the SCORE7D as the target architecture.
23712 @end table
23714 @node SH Options
23715 @subsection SH Options
23717 These @samp{-m} options are defined for the SH implementations:
23719 @table @gcctabopt
23720 @item -m1
23721 @opindex m1
23722 Generate code for the SH1.
23724 @item -m2
23725 @opindex m2
23726 Generate code for the SH2.
23728 @item -m2e
23729 Generate code for the SH2e.
23731 @item -m2a-nofpu
23732 @opindex m2a-nofpu
23733 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
23734 that the floating-point unit is not used.
23736 @item -m2a-single-only
23737 @opindex m2a-single-only
23738 Generate code for the SH2a-FPU, in such a way that no double-precision
23739 floating-point operations are used.
23741 @item -m2a-single
23742 @opindex m2a-single
23743 Generate code for the SH2a-FPU assuming the floating-point unit is in
23744 single-precision mode by default.
23746 @item -m2a
23747 @opindex m2a
23748 Generate code for the SH2a-FPU assuming the floating-point unit is in
23749 double-precision mode by default.
23751 @item -m3
23752 @opindex m3
23753 Generate code for the SH3.
23755 @item -m3e
23756 @opindex m3e
23757 Generate code for the SH3e.
23759 @item -m4-nofpu
23760 @opindex m4-nofpu
23761 Generate code for the SH4 without a floating-point unit.
23763 @item -m4-single-only
23764 @opindex m4-single-only
23765 Generate code for the SH4 with a floating-point unit that only
23766 supports single-precision arithmetic.
23768 @item -m4-single
23769 @opindex m4-single
23770 Generate code for the SH4 assuming the floating-point unit is in
23771 single-precision mode by default.
23773 @item -m4
23774 @opindex m4
23775 Generate code for the SH4.
23777 @item -m4-100
23778 @opindex m4-100
23779 Generate code for SH4-100.
23781 @item -m4-100-nofpu
23782 @opindex m4-100-nofpu
23783 Generate code for SH4-100 in such a way that the
23784 floating-point unit is not used.
23786 @item -m4-100-single
23787 @opindex m4-100-single
23788 Generate code for SH4-100 assuming the floating-point unit is in
23789 single-precision mode by default.
23791 @item -m4-100-single-only
23792 @opindex m4-100-single-only
23793 Generate code for SH4-100 in such a way that no double-precision
23794 floating-point operations are used.
23796 @item -m4-200
23797 @opindex m4-200
23798 Generate code for SH4-200.
23800 @item -m4-200-nofpu
23801 @opindex m4-200-nofpu
23802 Generate code for SH4-200 without in such a way that the
23803 floating-point unit is not used.
23805 @item -m4-200-single
23806 @opindex m4-200-single
23807 Generate code for SH4-200 assuming the floating-point unit is in
23808 single-precision mode by default.
23810 @item -m4-200-single-only
23811 @opindex m4-200-single-only
23812 Generate code for SH4-200 in such a way that no double-precision
23813 floating-point operations are used.
23815 @item -m4-300
23816 @opindex m4-300
23817 Generate code for SH4-300.
23819 @item -m4-300-nofpu
23820 @opindex m4-300-nofpu
23821 Generate code for SH4-300 without in such a way that the
23822 floating-point unit is not used.
23824 @item -m4-300-single
23825 @opindex m4-300-single
23826 Generate code for SH4-300 in such a way that no double-precision
23827 floating-point operations are used.
23829 @item -m4-300-single-only
23830 @opindex m4-300-single-only
23831 Generate code for SH4-300 in such a way that no double-precision
23832 floating-point operations are used.
23834 @item -m4-340
23835 @opindex m4-340
23836 Generate code for SH4-340 (no MMU, no FPU).
23838 @item -m4-500
23839 @opindex m4-500
23840 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
23841 assembler.
23843 @item -m4a-nofpu
23844 @opindex m4a-nofpu
23845 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
23846 floating-point unit is not used.
23848 @item -m4a-single-only
23849 @opindex m4a-single-only
23850 Generate code for the SH4a, in such a way that no double-precision
23851 floating-point operations are used.
23853 @item -m4a-single
23854 @opindex m4a-single
23855 Generate code for the SH4a assuming the floating-point unit is in
23856 single-precision mode by default.
23858 @item -m4a
23859 @opindex m4a
23860 Generate code for the SH4a.
23862 @item -m4al
23863 @opindex m4al
23864 Same as @option{-m4a-nofpu}, except that it implicitly passes
23865 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
23866 instructions at the moment.
23868 @item -mb
23869 @opindex mb
23870 Compile code for the processor in big-endian mode.
23872 @item -ml
23873 @opindex ml
23874 Compile code for the processor in little-endian mode.
23876 @item -mdalign
23877 @opindex mdalign
23878 Align doubles at 64-bit boundaries.  Note that this changes the calling
23879 conventions, and thus some functions from the standard C library do
23880 not work unless you recompile it first with @option{-mdalign}.
23882 @item -mrelax
23883 @opindex mrelax
23884 Shorten some address references at link time, when possible; uses the
23885 linker option @option{-relax}.
23887 @item -mbigtable
23888 @opindex mbigtable
23889 Use 32-bit offsets in @code{switch} tables.  The default is to use
23890 16-bit offsets.
23892 @item -mbitops
23893 @opindex mbitops
23894 Enable the use of bit manipulation instructions on SH2A.
23896 @item -mfmovd
23897 @opindex mfmovd
23898 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
23899 alignment constraints.
23901 @item -mrenesas
23902 @opindex mrenesas
23903 Comply with the calling conventions defined by Renesas.
23905 @item -mno-renesas
23906 @opindex mno-renesas
23907 Comply with the calling conventions defined for GCC before the Renesas
23908 conventions were available.  This option is the default for all
23909 targets of the SH toolchain.
23911 @item -mnomacsave
23912 @opindex mnomacsave
23913 Mark the @code{MAC} register as call-clobbered, even if
23914 @option{-mrenesas} is given.
23916 @item -mieee
23917 @itemx -mno-ieee
23918 @opindex mieee
23919 @opindex mno-ieee
23920 Control the IEEE compliance of floating-point comparisons, which affects the
23921 handling of cases where the result of a comparison is unordered.  By default
23922 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
23923 enabled @option{-mno-ieee} is implicitly set, which results in faster
23924 floating-point greater-equal and less-equal comparisons.  The implicit settings
23925 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
23927 @item -minline-ic_invalidate
23928 @opindex minline-ic_invalidate
23929 Inline code to invalidate instruction cache entries after setting up
23930 nested function trampolines.
23931 This option has no effect if @option{-musermode} is in effect and the selected
23932 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
23933 instruction.
23934 If the selected code generation option does not allow the use of the @code{icbi}
23935 instruction, and @option{-musermode} is not in effect, the inlined code
23936 manipulates the instruction cache address array directly with an associative
23937 write.  This not only requires privileged mode at run time, but it also
23938 fails if the cache line had been mapped via the TLB and has become unmapped.
23940 @item -misize
23941 @opindex misize
23942 Dump instruction size and location in the assembly code.
23944 @item -mpadstruct
23945 @opindex mpadstruct
23946 This option is deprecated.  It pads structures to multiple of 4 bytes,
23947 which is incompatible with the SH ABI@.
23949 @item -matomic-model=@var{model}
23950 @opindex matomic-model=@var{model}
23951 Sets the model of atomic operations and additional parameters as a comma
23952 separated list.  For details on the atomic built-in functions see
23953 @ref{__atomic Builtins}.  The following models and parameters are supported:
23955 @table @samp
23957 @item none
23958 Disable compiler generated atomic sequences and emit library calls for atomic
23959 operations.  This is the default if the target is not @code{sh*-*-linux*}.
23961 @item soft-gusa
23962 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
23963 built-in functions.  The generated atomic sequences require additional support
23964 from the interrupt/exception handling code of the system and are only suitable
23965 for SH3* and SH4* single-core systems.  This option is enabled by default when
23966 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
23967 this option also partially utilizes the hardware atomic instructions
23968 @code{movli.l} and @code{movco.l} to create more efficient code, unless
23969 @samp{strict} is specified.  
23971 @item soft-tcb
23972 Generate software atomic sequences that use a variable in the thread control
23973 block.  This is a variation of the gUSA sequences which can also be used on
23974 SH1* and SH2* targets.  The generated atomic sequences require additional
23975 support from the interrupt/exception handling code of the system and are only
23976 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
23977 parameter has to be specified as well.
23979 @item soft-imask
23980 Generate software atomic sequences that temporarily disable interrupts by
23981 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
23982 in privileged mode and is only suitable for single-core systems.  Additional
23983 support from the interrupt/exception handling code of the system is not
23984 required.  This model is enabled by default when the target is
23985 @code{sh*-*-linux*} and SH1* or SH2*.
23987 @item hard-llcs
23988 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
23989 instructions only.  This is only available on SH4A and is suitable for
23990 multi-core systems.  Since the hardware instructions support only 32 bit atomic
23991 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
23992 Code compiled with this option is also compatible with other software
23993 atomic model interrupt/exception handling systems if executed on an SH4A
23994 system.  Additional support from the interrupt/exception handling code of the
23995 system is not required for this model.
23997 @item gbr-offset=
23998 This parameter specifies the offset in bytes of the variable in the thread
23999 control block structure that should be used by the generated atomic sequences
24000 when the @samp{soft-tcb} model has been selected.  For other models this
24001 parameter is ignored.  The specified value must be an integer multiple of four
24002 and in the range 0-1020.
24004 @item strict
24005 This parameter prevents mixed usage of multiple atomic models, even if they
24006 are compatible, and makes the compiler generate atomic sequences of the
24007 specified model only.
24009 @end table
24011 @item -mtas
24012 @opindex mtas
24013 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
24014 Notice that depending on the particular hardware and software configuration
24015 this can degrade overall performance due to the operand cache line flushes
24016 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
24017 processors the @code{tas.b} instruction must be used with caution since it
24018 can result in data corruption for certain cache configurations.
24020 @item -mprefergot
24021 @opindex mprefergot
24022 When generating position-independent code, emit function calls using
24023 the Global Offset Table instead of the Procedure Linkage Table.
24025 @item -musermode
24026 @itemx -mno-usermode
24027 @opindex musermode
24028 @opindex mno-usermode
24029 Don't allow (allow) the compiler generating privileged mode code.  Specifying
24030 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
24031 inlined code would not work in user mode.  @option{-musermode} is the default
24032 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
24033 @option{-musermode} has no effect, since there is no user mode.
24035 @item -multcost=@var{number}
24036 @opindex multcost=@var{number}
24037 Set the cost to assume for a multiply insn.
24039 @item -mdiv=@var{strategy}
24040 @opindex mdiv=@var{strategy}
24041 Set the division strategy to be used for integer division operations.
24042 @var{strategy} can be one of: 
24044 @table @samp
24046 @item call-div1
24047 Calls a library function that uses the single-step division instruction
24048 @code{div1} to perform the operation.  Division by zero calculates an
24049 unspecified result and does not trap.  This is the default except for SH4,
24050 SH2A and SHcompact.
24052 @item call-fp
24053 Calls a library function that performs the operation in double precision
24054 floating point.  Division by zero causes a floating-point exception.  This is
24055 the default for SHcompact with FPU.  Specifying this for targets that do not
24056 have a double precision FPU defaults to @code{call-div1}.
24058 @item call-table
24059 Calls a library function that uses a lookup table for small divisors and
24060 the @code{div1} instruction with case distinction for larger divisors.  Division
24061 by zero calculates an unspecified result and does not trap.  This is the default
24062 for SH4.  Specifying this for targets that do not have dynamic shift
24063 instructions defaults to @code{call-div1}.
24065 @end table
24067 When a division strategy has not been specified the default strategy is
24068 selected based on the current target.  For SH2A the default strategy is to
24069 use the @code{divs} and @code{divu} instructions instead of library function
24070 calls.
24072 @item -maccumulate-outgoing-args
24073 @opindex maccumulate-outgoing-args
24074 Reserve space once for outgoing arguments in the function prologue rather
24075 than around each call.  Generally beneficial for performance and size.  Also
24076 needed for unwinding to avoid changing the stack frame around conditional code.
24078 @item -mdivsi3_libfunc=@var{name}
24079 @opindex mdivsi3_libfunc=@var{name}
24080 Set the name of the library function used for 32-bit signed division to
24081 @var{name}.
24082 This only affects the name used in the @samp{call} division strategies, and
24083 the compiler still expects the same sets of input/output/clobbered registers as
24084 if this option were not present.
24086 @item -mfixed-range=@var{register-range}
24087 @opindex mfixed-range
24088 Generate code treating the given register range as fixed registers.
24089 A fixed register is one that the register allocator can not use.  This is
24090 useful when compiling kernel code.  A register range is specified as
24091 two registers separated by a dash.  Multiple register ranges can be
24092 specified separated by a comma.
24094 @item -mbranch-cost=@var{num}
24095 @opindex mbranch-cost=@var{num}
24096 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
24097 make the compiler try to generate more branch-free code if possible.  
24098 If not specified the value is selected depending on the processor type that
24099 is being compiled for.
24101 @item -mzdcbranch
24102 @itemx -mno-zdcbranch
24103 @opindex mzdcbranch
24104 @opindex mno-zdcbranch
24105 Assume (do not assume) that zero displacement conditional branch instructions
24106 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
24107 compiler prefers zero displacement branch code sequences.  This is
24108 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
24109 disabled by specifying @option{-mno-zdcbranch}.
24111 @item -mcbranch-force-delay-slot
24112 @opindex mcbranch-force-delay-slot
24113 Force the usage of delay slots for conditional branches, which stuffs the delay
24114 slot with a @code{nop} if a suitable instruction cannot be found.  By default
24115 this option is disabled.  It can be enabled to work around hardware bugs as
24116 found in the original SH7055.
24118 @item -mfused-madd
24119 @itemx -mno-fused-madd
24120 @opindex mfused-madd
24121 @opindex mno-fused-madd
24122 Generate code that uses (does not use) the floating-point multiply and
24123 accumulate instructions.  These instructions are generated by default
24124 if hardware floating point is used.  The machine-dependent
24125 @option{-mfused-madd} option is now mapped to the machine-independent
24126 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
24127 mapped to @option{-ffp-contract=off}.
24129 @item -mfsca
24130 @itemx -mno-fsca
24131 @opindex mfsca
24132 @opindex mno-fsca
24133 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
24134 and cosine approximations.  The option @option{-mfsca} must be used in
24135 combination with @option{-funsafe-math-optimizations}.  It is enabled by default
24136 when generating code for SH4A.  Using @option{-mno-fsca} disables sine and cosine
24137 approximations even if @option{-funsafe-math-optimizations} is in effect.
24139 @item -mfsrra
24140 @itemx -mno-fsrra
24141 @opindex mfsrra
24142 @opindex mno-fsrra
24143 Allow or disallow the compiler to emit the @code{fsrra} instruction for
24144 reciprocal square root approximations.  The option @option{-mfsrra} must be used
24145 in combination with @option{-funsafe-math-optimizations} and
24146 @option{-ffinite-math-only}.  It is enabled by default when generating code for
24147 SH4A.  Using @option{-mno-fsrra} disables reciprocal square root approximations
24148 even if @option{-funsafe-math-optimizations} and @option{-ffinite-math-only} are
24149 in effect.
24151 @item -mpretend-cmove
24152 @opindex mpretend-cmove
24153 Prefer zero-displacement conditional branches for conditional move instruction
24154 patterns.  This can result in faster code on the SH4 processor.
24156 @item -mfdpic
24157 @opindex fdpic
24158 Generate code using the FDPIC ABI.
24160 @end table
24162 @node Solaris 2 Options
24163 @subsection Solaris 2 Options
24164 @cindex Solaris 2 options
24166 These @samp{-m} options are supported on Solaris 2:
24168 @table @gcctabopt
24169 @item -mclear-hwcap
24170 @opindex mclear-hwcap
24171 @option{-mclear-hwcap} tells the compiler to remove the hardware
24172 capabilities generated by the Solaris assembler.  This is only necessary
24173 when object files use ISA extensions not supported by the current
24174 machine, but check at runtime whether or not to use them.
24176 @item -mimpure-text
24177 @opindex mimpure-text
24178 @option{-mimpure-text}, used in addition to @option{-shared}, tells
24179 the compiler to not pass @option{-z text} to the linker when linking a
24180 shared object.  Using this option, you can link position-dependent
24181 code into a shared object.
24183 @option{-mimpure-text} suppresses the ``relocations remain against
24184 allocatable but non-writable sections'' linker error message.
24185 However, the necessary relocations trigger copy-on-write, and the
24186 shared object is not actually shared across processes.  Instead of
24187 using @option{-mimpure-text}, you should compile all source code with
24188 @option{-fpic} or @option{-fPIC}.
24190 @end table
24192 These switches are supported in addition to the above on Solaris 2:
24194 @table @gcctabopt
24195 @item -pthreads
24196 @opindex pthreads
24197 This is a synonym for @option{-pthread}.
24198 @end table
24200 @node SPARC Options
24201 @subsection SPARC Options
24202 @cindex SPARC options
24204 These @samp{-m} options are supported on the SPARC:
24206 @table @gcctabopt
24207 @item -mno-app-regs
24208 @itemx -mapp-regs
24209 @opindex mno-app-regs
24210 @opindex mapp-regs
24211 Specify @option{-mapp-regs} to generate output using the global registers
24212 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
24213 global register 1, each global register 2 through 4 is then treated as an
24214 allocable register that is clobbered by function calls.  This is the default.
24216 To be fully SVR4 ABI-compliant at the cost of some performance loss,
24217 specify @option{-mno-app-regs}.  You should compile libraries and system
24218 software with this option.
24220 @item -mflat
24221 @itemx -mno-flat
24222 @opindex mflat
24223 @opindex mno-flat
24224 With @option{-mflat}, the compiler does not generate save/restore instructions
24225 and uses a ``flat'' or single register window model.  This model is compatible
24226 with the regular register window model.  The local registers and the input
24227 registers (0--5) are still treated as ``call-saved'' registers and are
24228 saved on the stack as needed.
24230 With @option{-mno-flat} (the default), the compiler generates save/restore
24231 instructions (except for leaf functions).  This is the normal operating mode.
24233 @item -mfpu
24234 @itemx -mhard-float
24235 @opindex mfpu
24236 @opindex mhard-float
24237 Generate output containing floating-point instructions.  This is the
24238 default.
24240 @item -mno-fpu
24241 @itemx -msoft-float
24242 @opindex mno-fpu
24243 @opindex msoft-float
24244 Generate output containing library calls for floating point.
24245 @strong{Warning:} the requisite libraries are not available for all SPARC
24246 targets.  Normally the facilities of the machine's usual C compiler are
24247 used, but this cannot be done directly in cross-compilation.  You must make
24248 your own arrangements to provide suitable library functions for
24249 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
24250 @samp{sparclite-*-*} do provide software floating-point support.
24252 @option{-msoft-float} changes the calling convention in the output file;
24253 therefore, it is only useful if you compile @emph{all} of a program with
24254 this option.  In particular, you need to compile @file{libgcc.a}, the
24255 library that comes with GCC, with @option{-msoft-float} in order for
24256 this to work.
24258 @item -mhard-quad-float
24259 @opindex mhard-quad-float
24260 Generate output containing quad-word (long double) floating-point
24261 instructions.
24263 @item -msoft-quad-float
24264 @opindex msoft-quad-float
24265 Generate output containing library calls for quad-word (long double)
24266 floating-point instructions.  The functions called are those specified
24267 in the SPARC ABI@.  This is the default.
24269 As of this writing, there are no SPARC implementations that have hardware
24270 support for the quad-word floating-point instructions.  They all invoke
24271 a trap handler for one of these instructions, and then the trap handler
24272 emulates the effect of the instruction.  Because of the trap handler overhead,
24273 this is much slower than calling the ABI library routines.  Thus the
24274 @option{-msoft-quad-float} option is the default.
24276 @item -mno-unaligned-doubles
24277 @itemx -munaligned-doubles
24278 @opindex mno-unaligned-doubles
24279 @opindex munaligned-doubles
24280 Assume that doubles have 8-byte alignment.  This is the default.
24282 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
24283 alignment only if they are contained in another type, or if they have an
24284 absolute address.  Otherwise, it assumes they have 4-byte alignment.
24285 Specifying this option avoids some rare compatibility problems with code
24286 generated by other compilers.  It is not the default because it results
24287 in a performance loss, especially for floating-point code.
24289 @item -muser-mode
24290 @itemx -mno-user-mode
24291 @opindex muser-mode
24292 @opindex mno-user-mode
24293 Do not generate code that can only run in supervisor mode.  This is relevant
24294 only for the @code{casa} instruction emitted for the LEON3 processor.  This
24295 is the default.
24297 @item -mfaster-structs
24298 @itemx -mno-faster-structs
24299 @opindex mfaster-structs
24300 @opindex mno-faster-structs
24301 With @option{-mfaster-structs}, the compiler assumes that structures
24302 should have 8-byte alignment.  This enables the use of pairs of
24303 @code{ldd} and @code{std} instructions for copies in structure
24304 assignment, in place of twice as many @code{ld} and @code{st} pairs.
24305 However, the use of this changed alignment directly violates the SPARC
24306 ABI@.  Thus, it's intended only for use on targets where the developer
24307 acknowledges that their resulting code is not directly in line with
24308 the rules of the ABI@.
24310 @item -mstd-struct-return
24311 @itemx -mno-std-struct-return
24312 @opindex mstd-struct-return
24313 @opindex mno-std-struct-return
24314 With @option{-mstd-struct-return}, the compiler generates checking code
24315 in functions returning structures or unions to detect size mismatches
24316 between the two sides of function calls, as per the 32-bit ABI@.
24318 The default is @option{-mno-std-struct-return}.  This option has no effect
24319 in 64-bit mode.
24321 @item -mlra
24322 @itemx -mno-lra
24323 @opindex mlra
24324 @opindex mno-lra
24325 Enable Local Register Allocation.  This is the default for SPARC since GCC 7
24326 so @option{-mno-lra} needs to be passed to get old Reload.
24328 @item -mcpu=@var{cpu_type}
24329 @opindex mcpu
24330 Set the instruction set, register set, and instruction scheduling parameters
24331 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
24332 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
24333 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
24334 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
24335 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
24336 @samp{niagara3}, @samp{niagara4}, @samp{niagara7} and @samp{m8}.
24338 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
24339 which selects the best architecture option for the host processor.
24340 @option{-mcpu=native} has no effect if GCC does not recognize
24341 the processor.
24343 Default instruction scheduling parameters are used for values that select
24344 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
24345 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
24347 Here is a list of each supported architecture and their supported
24348 implementations.
24350 @table @asis
24351 @item v7
24352 cypress, leon3v7
24354 @item v8
24355 supersparc, hypersparc, leon, leon3
24357 @item sparclite
24358 f930, f934, sparclite86x
24360 @item sparclet
24361 tsc701
24363 @item v9
24364 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4,
24365 niagara7, m8
24366 @end table
24368 By default (unless configured otherwise), GCC generates code for the V7
24369 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
24370 additionally optimizes it for the Cypress CY7C602 chip, as used in the
24371 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
24372 SPARCStation 1, 2, IPX etc.
24374 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
24375 architecture.  The only difference from V7 code is that the compiler emits
24376 the integer multiply and integer divide instructions which exist in SPARC-V8
24377 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
24378 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
24379 2000 series.
24381 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
24382 the SPARC architecture.  This adds the integer multiply, integer divide step
24383 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
24384 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
24385 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
24386 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
24387 MB86934 chip, which is the more recent SPARClite with FPU@.
24389 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
24390 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
24391 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
24392 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
24393 optimizes it for the TEMIC SPARClet chip.
24395 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
24396 architecture.  This adds 64-bit integer and floating-point move instructions,
24397 3 additional floating-point condition code registers and conditional move
24398 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
24399 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
24400 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
24401 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
24402 @option{-mcpu=niagara}, the compiler additionally optimizes it for
24403 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
24404 additionally optimizes it for Sun UltraSPARC T2 chips. With
24405 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
24406 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
24407 additionally optimizes it for Sun UltraSPARC T4 chips.  With
24408 @option{-mcpu=niagara7}, the compiler additionally optimizes it for
24409 Oracle SPARC M7 chips.  With @option{-mcpu=m8}, the compiler
24410 additionally optimizes it for Oracle M8 chips.
24412 @item -mtune=@var{cpu_type}
24413 @opindex mtune
24414 Set the instruction scheduling parameters for machine type
24415 @var{cpu_type}, but do not set the instruction set or register set that the
24416 option @option{-mcpu=@var{cpu_type}} does.
24418 The same values for @option{-mcpu=@var{cpu_type}} can be used for
24419 @option{-mtune=@var{cpu_type}}, but the only useful values are those
24420 that select a particular CPU implementation.  Those are
24421 @samp{cypress}, @samp{supersparc}, @samp{hypersparc}, @samp{leon},
24422 @samp{leon3}, @samp{leon3v7}, @samp{f930}, @samp{f934},
24423 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
24424 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3},
24425 @samp{niagara4}, @samp{niagara7} and @samp{m8}.  With native Solaris
24426 and GNU/Linux toolchains, @samp{native} can also be used.
24428 @item -mv8plus
24429 @itemx -mno-v8plus
24430 @opindex mv8plus
24431 @opindex mno-v8plus
24432 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
24433 difference from the V8 ABI is that the global and out registers are
24434 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
24435 mode for all SPARC-V9 processors.
24437 @item -mvis
24438 @itemx -mno-vis
24439 @opindex mvis
24440 @opindex mno-vis
24441 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
24442 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
24444 @item -mvis2
24445 @itemx -mno-vis2
24446 @opindex mvis2
24447 @opindex mno-vis2
24448 With @option{-mvis2}, GCC generates code that takes advantage of
24449 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
24450 default is @option{-mvis2} when targeting a cpu that supports such
24451 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
24452 also sets @option{-mvis}.
24454 @item -mvis3
24455 @itemx -mno-vis3
24456 @opindex mvis3
24457 @opindex mno-vis3
24458 With @option{-mvis3}, GCC generates code that takes advantage of
24459 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
24460 default is @option{-mvis3} when targeting a cpu that supports such
24461 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
24462 also sets @option{-mvis2} and @option{-mvis}.
24464 @item -mvis4
24465 @itemx -mno-vis4
24466 @opindex mvis4
24467 @opindex mno-vis4
24468 With @option{-mvis4}, GCC generates code that takes advantage of
24469 version 4.0 of the UltraSPARC Visual Instruction Set extensions.  The
24470 default is @option{-mvis4} when targeting a cpu that supports such
24471 instructions, such as niagara-7 and later.  Setting @option{-mvis4}
24472 also sets @option{-mvis3}, @option{-mvis2} and @option{-mvis}.
24474 @item -mvis4b
24475 @itemx -mno-vis4b
24476 @opindex mvis4b
24477 @opindex mno-vis4b
24478 With @option{-mvis4b}, GCC generates code that takes advantage of
24479 version 4.0 of the UltraSPARC Visual Instruction Set extensions, plus
24480 the additional VIS instructions introduced in the Oracle SPARC
24481 Architecture 2017.  The default is @option{-mvis4b} when targeting a
24482 cpu that supports such instructions, such as m8 and later.  Setting
24483 @option{-mvis4b} also sets @option{-mvis4}, @option{-mvis3},
24484 @option{-mvis2} and @option{-mvis}.
24486 @item -mcbcond
24487 @itemx -mno-cbcond
24488 @opindex mcbcond
24489 @opindex mno-cbcond
24490 With @option{-mcbcond}, GCC generates code that takes advantage of the UltraSPARC
24491 Compare-and-Branch-on-Condition instructions.  The default is @option{-mcbcond}
24492 when targeting a CPU that supports such instructions, such as Niagara-4 and
24493 later.
24495 @item -mfmaf
24496 @itemx -mno-fmaf
24497 @opindex mfmaf
24498 @opindex mno-fmaf
24499 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
24500 Fused Multiply-Add Floating-point instructions.  The default is @option{-mfmaf}
24501 when targeting a CPU that supports such instructions, such as Niagara-3 and
24502 later.
24504 @item -mfsmuld
24505 @itemx -mno-fsmuld
24506 @opindex mfsmuld
24507 @opindex mno-fsmuld
24508 With @option{-mfsmuld}, GCC generates code that takes advantage of the
24509 Floating-point Multiply Single to Double (FsMULd) instruction.  The default is
24510 @option{-mfsmuld} when targeting a CPU supporting the architecture versions V8
24511 or V9 with FPU except @option{-mcpu=leon}.
24513 @item -mpopc
24514 @itemx -mno-popc
24515 @opindex mpopc
24516 @opindex mno-popc
24517 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
24518 Population Count instruction.  The default is @option{-mpopc}
24519 when targeting a CPU that supports such an instruction, such as Niagara-2 and
24520 later.
24522 @item -msubxc
24523 @itemx -mno-subxc
24524 @opindex msubxc
24525 @opindex mno-subxc
24526 With @option{-msubxc}, GCC generates code that takes advantage of the UltraSPARC
24527 Subtract-Extended-with-Carry instruction.  The default is @option{-msubxc}
24528 when targeting a CPU that supports such an instruction, such as Niagara-7 and
24529 later.
24531 @item -mfix-at697f
24532 @opindex mfix-at697f
24533 Enable the documented workaround for the single erratum of the Atmel AT697F
24534 processor (which corresponds to erratum #13 of the AT697E processor).
24536 @item -mfix-ut699
24537 @opindex mfix-ut699
24538 Enable the documented workarounds for the floating-point errata and the data
24539 cache nullify errata of the UT699 processor.
24541 @item -mfix-ut700
24542 @opindex mfix-ut700
24543 Enable the documented workaround for the back-to-back store errata of
24544 the UT699E/UT700 processor.
24546 @item -mfix-gr712rc
24547 @opindex mfix-gr712rc
24548 Enable the documented workaround for the back-to-back store errata of
24549 the GR712RC processor.
24550 @end table
24552 These @samp{-m} options are supported in addition to the above
24553 on SPARC-V9 processors in 64-bit environments:
24555 @table @gcctabopt
24556 @item -m32
24557 @itemx -m64
24558 @opindex m32
24559 @opindex m64
24560 Generate code for a 32-bit or 64-bit environment.
24561 The 32-bit environment sets int, long and pointer to 32 bits.
24562 The 64-bit environment sets int to 32 bits and long and pointer
24563 to 64 bits.
24565 @item -mcmodel=@var{which}
24566 @opindex mcmodel
24567 Set the code model to one of
24569 @table @samp
24570 @item medlow
24571 The Medium/Low code model: 64-bit addresses, programs
24572 must be linked in the low 32 bits of memory.  Programs can be statically
24573 or dynamically linked.
24575 @item medmid
24576 The Medium/Middle code model: 64-bit addresses, programs
24577 must be linked in the low 44 bits of memory, the text and data segments must
24578 be less than 2GB in size and the data segment must be located within 2GB of
24579 the text segment.
24581 @item medany
24582 The Medium/Anywhere code model: 64-bit addresses, programs
24583 may be linked anywhere in memory, the text and data segments must be less
24584 than 2GB in size and the data segment must be located within 2GB of the
24585 text segment.
24587 @item embmedany
24588 The Medium/Anywhere code model for embedded systems:
24589 64-bit addresses, the text and data segments must be less than 2GB in
24590 size, both starting anywhere in memory (determined at link time).  The
24591 global register %g4 points to the base of the data segment.  Programs
24592 are statically linked and PIC is not supported.
24593 @end table
24595 @item -mmemory-model=@var{mem-model}
24596 @opindex mmemory-model
24597 Set the memory model in force on the processor to one of
24599 @table @samp
24600 @item default
24601 The default memory model for the processor and operating system.
24603 @item rmo
24604 Relaxed Memory Order
24606 @item pso
24607 Partial Store Order
24609 @item tso
24610 Total Store Order
24612 @item sc
24613 Sequential Consistency
24614 @end table
24616 These memory models are formally defined in Appendix D of the SPARC-V9
24617 architecture manual, as set in the processor's @code{PSTATE.MM} field.
24619 @item -mstack-bias
24620 @itemx -mno-stack-bias
24621 @opindex mstack-bias
24622 @opindex mno-stack-bias
24623 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
24624 frame pointer if present, are offset by @minus{}2047 which must be added back
24625 when making stack frame references.  This is the default in 64-bit mode.
24626 Otherwise, assume no such offset is present.
24627 @end table
24629 @node SPU Options
24630 @subsection SPU Options
24631 @cindex SPU options
24633 These @samp{-m} options are supported on the SPU:
24635 @table @gcctabopt
24636 @item -mwarn-reloc
24637 @itemx -merror-reloc
24638 @opindex mwarn-reloc
24639 @opindex merror-reloc
24641 The loader for SPU does not handle dynamic relocations.  By default, GCC
24642 gives an error when it generates code that requires a dynamic
24643 relocation.  @option{-mno-error-reloc} disables the error,
24644 @option{-mwarn-reloc} generates a warning instead.
24646 @item -msafe-dma
24647 @itemx -munsafe-dma
24648 @opindex msafe-dma
24649 @opindex munsafe-dma
24651 Instructions that initiate or test completion of DMA must not be
24652 reordered with respect to loads and stores of the memory that is being
24653 accessed.
24654 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
24655 memory accesses, but that can lead to inefficient code in places where the
24656 memory is known to not change.  Rather than mark the memory as volatile,
24657 you can use @option{-msafe-dma} to tell the compiler to treat
24658 the DMA instructions as potentially affecting all memory.  
24660 @item -mbranch-hints
24661 @opindex mbranch-hints
24663 By default, GCC generates a branch hint instruction to avoid
24664 pipeline stalls for always-taken or probably-taken branches.  A hint
24665 is not generated closer than 8 instructions away from its branch.
24666 There is little reason to disable them, except for debugging purposes,
24667 or to make an object a little bit smaller.
24669 @item -msmall-mem
24670 @itemx -mlarge-mem
24671 @opindex msmall-mem
24672 @opindex mlarge-mem
24674 By default, GCC generates code assuming that addresses are never larger
24675 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
24676 a full 32-bit address.
24678 @item -mstdmain
24679 @opindex mstdmain
24681 By default, GCC links against startup code that assumes the SPU-style
24682 main function interface (which has an unconventional parameter list).
24683 With @option{-mstdmain}, GCC links your program against startup
24684 code that assumes a C99-style interface to @code{main}, including a
24685 local copy of @code{argv} strings.
24687 @item -mfixed-range=@var{register-range}
24688 @opindex mfixed-range
24689 Generate code treating the given register range as fixed registers.
24690 A fixed register is one that the register allocator cannot use.  This is
24691 useful when compiling kernel code.  A register range is specified as
24692 two registers separated by a dash.  Multiple register ranges can be
24693 specified separated by a comma.
24695 @item -mea32
24696 @itemx -mea64
24697 @opindex mea32
24698 @opindex mea64
24699 Compile code assuming that pointers to the PPU address space accessed
24700 via the @code{__ea} named address space qualifier are either 32 or 64
24701 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
24702 all object code in an executable must be compiled with the same setting.
24704 @item -maddress-space-conversion
24705 @itemx -mno-address-space-conversion
24706 @opindex maddress-space-conversion
24707 @opindex mno-address-space-conversion
24708 Allow/disallow treating the @code{__ea} address space as superset
24709 of the generic address space.  This enables explicit type casts
24710 between @code{__ea} and generic pointer as well as implicit
24711 conversions of generic pointers to @code{__ea} pointers.  The
24712 default is to allow address space pointer conversions.
24714 @item -mcache-size=@var{cache-size}
24715 @opindex mcache-size
24716 This option controls the version of libgcc that the compiler links to an
24717 executable and selects a software-managed cache for accessing variables
24718 in the @code{__ea} address space with a particular cache size.  Possible
24719 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
24720 and @samp{128}.  The default cache size is 64KB.
24722 @item -matomic-updates
24723 @itemx -mno-atomic-updates
24724 @opindex matomic-updates
24725 @opindex mno-atomic-updates
24726 This option controls the version of libgcc that the compiler links to an
24727 executable and selects whether atomic updates to the software-managed
24728 cache of PPU-side variables are used.  If you use atomic updates, changes
24729 to a PPU variable from SPU code using the @code{__ea} named address space
24730 qualifier do not interfere with changes to other PPU variables residing
24731 in the same cache line from PPU code.  If you do not use atomic updates,
24732 such interference may occur; however, writing back cache lines is
24733 more efficient.  The default behavior is to use atomic updates.
24735 @item -mdual-nops
24736 @itemx -mdual-nops=@var{n}
24737 @opindex mdual-nops
24738 By default, GCC inserts NOPs to increase dual issue when it expects
24739 it to increase performance.  @var{n} can be a value from 0 to 10.  A
24740 smaller @var{n} inserts fewer NOPs.  10 is the default, 0 is the
24741 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
24743 @item -mhint-max-nops=@var{n}
24744 @opindex mhint-max-nops
24745 Maximum number of NOPs to insert for a branch hint.  A branch hint must
24746 be at least 8 instructions away from the branch it is affecting.  GCC
24747 inserts up to @var{n} NOPs to enforce this, otherwise it does not
24748 generate the branch hint.
24750 @item -mhint-max-distance=@var{n}
24751 @opindex mhint-max-distance
24752 The encoding of the branch hint instruction limits the hint to be within
24753 256 instructions of the branch it is affecting.  By default, GCC makes
24754 sure it is within 125.
24756 @item -msafe-hints
24757 @opindex msafe-hints
24758 Work around a hardware bug that causes the SPU to stall indefinitely.
24759 By default, GCC inserts the @code{hbrp} instruction to make sure
24760 this stall won't happen.
24762 @end table
24764 @node System V Options
24765 @subsection Options for System V
24767 These additional options are available on System V Release 4 for
24768 compatibility with other compilers on those systems:
24770 @table @gcctabopt
24771 @item -G
24772 @opindex G
24773 Create a shared object.
24774 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
24776 @item -Qy
24777 @opindex Qy
24778 Identify the versions of each tool used by the compiler, in a
24779 @code{.ident} assembler directive in the output.
24781 @item -Qn
24782 @opindex Qn
24783 Refrain from adding @code{.ident} directives to the output file (this is
24784 the default).
24786 @item -YP,@var{dirs}
24787 @opindex YP
24788 Search the directories @var{dirs}, and no others, for libraries
24789 specified with @option{-l}.
24791 @item -Ym,@var{dir}
24792 @opindex Ym
24793 Look in the directory @var{dir} to find the M4 preprocessor.
24794 The assembler uses this option.
24795 @c This is supposed to go with a -Yd for predefined M4 macro files, but
24796 @c the generic assembler that comes with Solaris takes just -Ym.
24797 @end table
24799 @node TILE-Gx Options
24800 @subsection TILE-Gx Options
24801 @cindex TILE-Gx options
24803 These @samp{-m} options are supported on the TILE-Gx:
24805 @table @gcctabopt
24806 @item -mcmodel=small
24807 @opindex mcmodel=small
24808 Generate code for the small model.  The distance for direct calls is
24809 limited to 500M in either direction.  PC-relative addresses are 32
24810 bits.  Absolute addresses support the full address range.
24812 @item -mcmodel=large
24813 @opindex mcmodel=large
24814 Generate code for the large model.  There is no limitation on call
24815 distance, pc-relative addresses, or absolute addresses.
24817 @item -mcpu=@var{name}
24818 @opindex mcpu
24819 Selects the type of CPU to be targeted.  Currently the only supported
24820 type is @samp{tilegx}.
24822 @item -m32
24823 @itemx -m64
24824 @opindex m32
24825 @opindex m64
24826 Generate code for a 32-bit or 64-bit environment.  The 32-bit
24827 environment sets int, long, and pointer to 32 bits.  The 64-bit
24828 environment sets int to 32 bits and long and pointer to 64 bits.
24830 @item -mbig-endian
24831 @itemx -mlittle-endian
24832 @opindex mbig-endian
24833 @opindex mlittle-endian
24834 Generate code in big/little endian mode, respectively.
24835 @end table
24837 @node TILEPro Options
24838 @subsection TILEPro Options
24839 @cindex TILEPro options
24841 These @samp{-m} options are supported on the TILEPro:
24843 @table @gcctabopt
24844 @item -mcpu=@var{name}
24845 @opindex mcpu
24846 Selects the type of CPU to be targeted.  Currently the only supported
24847 type is @samp{tilepro}.
24849 @item -m32
24850 @opindex m32
24851 Generate code for a 32-bit environment, which sets int, long, and
24852 pointer to 32 bits.  This is the only supported behavior so the flag
24853 is essentially ignored.
24854 @end table
24856 @node V850 Options
24857 @subsection V850 Options
24858 @cindex V850 Options
24860 These @samp{-m} options are defined for V850 implementations:
24862 @table @gcctabopt
24863 @item -mlong-calls
24864 @itemx -mno-long-calls
24865 @opindex mlong-calls
24866 @opindex mno-long-calls
24867 Treat all calls as being far away (near).  If calls are assumed to be
24868 far away, the compiler always loads the function's address into a
24869 register, and calls indirect through the pointer.
24871 @item -mno-ep
24872 @itemx -mep
24873 @opindex mno-ep
24874 @opindex mep
24875 Do not optimize (do optimize) basic blocks that use the same index
24876 pointer 4 or more times to copy pointer into the @code{ep} register, and
24877 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
24878 option is on by default if you optimize.
24880 @item -mno-prolog-function
24881 @itemx -mprolog-function
24882 @opindex mno-prolog-function
24883 @opindex mprolog-function
24884 Do not use (do use) external functions to save and restore registers
24885 at the prologue and epilogue of a function.  The external functions
24886 are slower, but use less code space if more than one function saves
24887 the same number of registers.  The @option{-mprolog-function} option
24888 is on by default if you optimize.
24890 @item -mspace
24891 @opindex mspace
24892 Try to make the code as small as possible.  At present, this just turns
24893 on the @option{-mep} and @option{-mprolog-function} options.
24895 @item -mtda=@var{n}
24896 @opindex mtda
24897 Put static or global variables whose size is @var{n} bytes or less into
24898 the tiny data area that register @code{ep} points to.  The tiny data
24899 area can hold up to 256 bytes in total (128 bytes for byte references).
24901 @item -msda=@var{n}
24902 @opindex msda
24903 Put static or global variables whose size is @var{n} bytes or less into
24904 the small data area that register @code{gp} points to.  The small data
24905 area can hold up to 64 kilobytes.
24907 @item -mzda=@var{n}
24908 @opindex mzda
24909 Put static or global variables whose size is @var{n} bytes or less into
24910 the first 32 kilobytes of memory.
24912 @item -mv850
24913 @opindex mv850
24914 Specify that the target processor is the V850.
24916 @item -mv850e3v5
24917 @opindex mv850e3v5
24918 Specify that the target processor is the V850E3V5.  The preprocessor
24919 constant @code{__v850e3v5__} is defined if this option is used.
24921 @item -mv850e2v4
24922 @opindex mv850e2v4
24923 Specify that the target processor is the V850E3V5.  This is an alias for
24924 the @option{-mv850e3v5} option.
24926 @item -mv850e2v3
24927 @opindex mv850e2v3
24928 Specify that the target processor is the V850E2V3.  The preprocessor
24929 constant @code{__v850e2v3__} is defined if this option is used.
24931 @item -mv850e2
24932 @opindex mv850e2
24933 Specify that the target processor is the V850E2.  The preprocessor
24934 constant @code{__v850e2__} is defined if this option is used.
24936 @item -mv850e1
24937 @opindex mv850e1
24938 Specify that the target processor is the V850E1.  The preprocessor
24939 constants @code{__v850e1__} and @code{__v850e__} are defined if
24940 this option is used.
24942 @item -mv850es
24943 @opindex mv850es
24944 Specify that the target processor is the V850ES.  This is an alias for
24945 the @option{-mv850e1} option.
24947 @item -mv850e
24948 @opindex mv850e
24949 Specify that the target processor is the V850E@.  The preprocessor
24950 constant @code{__v850e__} is defined if this option is used.
24952 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
24953 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
24954 are defined then a default target processor is chosen and the
24955 relevant @samp{__v850*__} preprocessor constant is defined.
24957 The preprocessor constants @code{__v850} and @code{__v851__} are always
24958 defined, regardless of which processor variant is the target.
24960 @item -mdisable-callt
24961 @itemx -mno-disable-callt
24962 @opindex mdisable-callt
24963 @opindex mno-disable-callt
24964 This option suppresses generation of the @code{CALLT} instruction for the
24965 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
24966 architecture.
24968 This option is enabled by default when the RH850 ABI is
24969 in use (see @option{-mrh850-abi}), and disabled by default when the
24970 GCC ABI is in use.  If @code{CALLT} instructions are being generated
24971 then the C preprocessor symbol @code{__V850_CALLT__} is defined.
24973 @item -mrelax
24974 @itemx -mno-relax
24975 @opindex mrelax
24976 @opindex mno-relax
24977 Pass on (or do not pass on) the @option{-mrelax} command-line option
24978 to the assembler.
24980 @item -mlong-jumps
24981 @itemx -mno-long-jumps
24982 @opindex mlong-jumps
24983 @opindex mno-long-jumps
24984 Disable (or re-enable) the generation of PC-relative jump instructions.
24986 @item -msoft-float
24987 @itemx -mhard-float
24988 @opindex msoft-float
24989 @opindex mhard-float
24990 Disable (or re-enable) the generation of hardware floating point
24991 instructions.  This option is only significant when the target
24992 architecture is @samp{V850E2V3} or higher.  If hardware floating point
24993 instructions are being generated then the C preprocessor symbol
24994 @code{__FPU_OK__} is defined, otherwise the symbol
24995 @code{__NO_FPU__} is defined.
24997 @item -mloop
24998 @opindex mloop
24999 Enables the use of the e3v5 LOOP instruction.  The use of this
25000 instruction is not enabled by default when the e3v5 architecture is
25001 selected because its use is still experimental.
25003 @item -mrh850-abi
25004 @itemx -mghs
25005 @opindex mrh850-abi
25006 @opindex mghs
25007 Enables support for the RH850 version of the V850 ABI.  This is the
25008 default.  With this version of the ABI the following rules apply:
25010 @itemize
25011 @item
25012 Integer sized structures and unions are returned via a memory pointer
25013 rather than a register.
25015 @item
25016 Large structures and unions (more than 8 bytes in size) are passed by
25017 value.
25019 @item
25020 Functions are aligned to 16-bit boundaries.
25022 @item
25023 The @option{-m8byte-align} command-line option is supported.
25025 @item
25026 The @option{-mdisable-callt} command-line option is enabled by
25027 default.  The @option{-mno-disable-callt} command-line option is not
25028 supported.
25029 @end itemize
25031 When this version of the ABI is enabled the C preprocessor symbol
25032 @code{__V850_RH850_ABI__} is defined.
25034 @item -mgcc-abi
25035 @opindex mgcc-abi
25036 Enables support for the old GCC version of the V850 ABI.  With this
25037 version of the ABI the following rules apply:
25039 @itemize
25040 @item
25041 Integer sized structures and unions are returned in register @code{r10}.
25043 @item
25044 Large structures and unions (more than 8 bytes in size) are passed by
25045 reference.
25047 @item
25048 Functions are aligned to 32-bit boundaries, unless optimizing for
25049 size.
25051 @item
25052 The @option{-m8byte-align} command-line option is not supported.
25054 @item
25055 The @option{-mdisable-callt} command-line option is supported but not
25056 enabled by default.
25057 @end itemize
25059 When this version of the ABI is enabled the C preprocessor symbol
25060 @code{__V850_GCC_ABI__} is defined.
25062 @item -m8byte-align
25063 @itemx -mno-8byte-align
25064 @opindex m8byte-align
25065 @opindex mno-8byte-align
25066 Enables support for @code{double} and @code{long long} types to be
25067 aligned on 8-byte boundaries.  The default is to restrict the
25068 alignment of all objects to at most 4-bytes.  When
25069 @option{-m8byte-align} is in effect the C preprocessor symbol
25070 @code{__V850_8BYTE_ALIGN__} is defined.
25072 @item -mbig-switch
25073 @opindex mbig-switch
25074 Generate code suitable for big switch tables.  Use this option only if
25075 the assembler/linker complain about out of range branches within a switch
25076 table.
25078 @item -mapp-regs
25079 @opindex mapp-regs
25080 This option causes r2 and r5 to be used in the code generated by
25081 the compiler.  This setting is the default.
25083 @item -mno-app-regs
25084 @opindex mno-app-regs
25085 This option causes r2 and r5 to be treated as fixed registers.
25087 @end table
25089 @node VAX Options
25090 @subsection VAX Options
25091 @cindex VAX options
25093 These @samp{-m} options are defined for the VAX:
25095 @table @gcctabopt
25096 @item -munix
25097 @opindex munix
25098 Do not output certain jump instructions (@code{aobleq} and so on)
25099 that the Unix assembler for the VAX cannot handle across long
25100 ranges.
25102 @item -mgnu
25103 @opindex mgnu
25104 Do output those jump instructions, on the assumption that the
25105 GNU assembler is being used.
25107 @item -mg
25108 @opindex mg
25109 Output code for G-format floating-point numbers instead of D-format.
25110 @end table
25112 @node Visium Options
25113 @subsection Visium Options
25114 @cindex Visium options
25116 @table @gcctabopt
25118 @item -mdebug
25119 @opindex mdebug
25120 A program which performs file I/O and is destined to run on an MCM target
25121 should be linked with this option.  It causes the libraries libc.a and
25122 libdebug.a to be linked.  The program should be run on the target under
25123 the control of the GDB remote debugging stub.
25125 @item -msim
25126 @opindex msim
25127 A program which performs file I/O and is destined to run on the simulator
25128 should be linked with option.  This causes libraries libc.a and libsim.a to
25129 be linked.
25131 @item -mfpu
25132 @itemx -mhard-float
25133 @opindex mfpu
25134 @opindex mhard-float
25135 Generate code containing floating-point instructions.  This is the
25136 default.
25138 @item -mno-fpu
25139 @itemx -msoft-float
25140 @opindex mno-fpu
25141 @opindex msoft-float
25142 Generate code containing library calls for floating-point.
25144 @option{-msoft-float} changes the calling convention in the output file;
25145 therefore, it is only useful if you compile @emph{all} of a program with
25146 this option.  In particular, you need to compile @file{libgcc.a}, the
25147 library that comes with GCC, with @option{-msoft-float} in order for
25148 this to work.
25150 @item -mcpu=@var{cpu_type}
25151 @opindex mcpu
25152 Set the instruction set, register set, and instruction scheduling parameters
25153 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
25154 @samp{mcm}, @samp{gr5} and @samp{gr6}.
25156 @samp{mcm} is a synonym of @samp{gr5} present for backward compatibility.
25158 By default (unless configured otherwise), GCC generates code for the GR5
25159 variant of the Visium architecture.  
25161 With @option{-mcpu=gr6}, GCC generates code for the GR6 variant of the Visium
25162 architecture.  The only difference from GR5 code is that the compiler will
25163 generate block move instructions.
25165 @item -mtune=@var{cpu_type}
25166 @opindex mtune
25167 Set the instruction scheduling parameters for machine type @var{cpu_type},
25168 but do not set the instruction set or register set that the option
25169 @option{-mcpu=@var{cpu_type}} would.
25171 @item -msv-mode
25172 @opindex msv-mode
25173 Generate code for the supervisor mode, where there are no restrictions on
25174 the access to general registers.  This is the default.
25176 @item -muser-mode
25177 @opindex muser-mode
25178 Generate code for the user mode, where the access to some general registers
25179 is forbidden: on the GR5, registers r24 to r31 cannot be accessed in this
25180 mode; on the GR6, only registers r29 to r31 are affected.
25181 @end table
25183 @node VMS Options
25184 @subsection VMS Options
25186 These @samp{-m} options are defined for the VMS implementations:
25188 @table @gcctabopt
25189 @item -mvms-return-codes
25190 @opindex mvms-return-codes
25191 Return VMS condition codes from @code{main}. The default is to return POSIX-style
25192 condition (e.g.@ error) codes.
25194 @item -mdebug-main=@var{prefix}
25195 @opindex mdebug-main=@var{prefix}
25196 Flag the first routine whose name starts with @var{prefix} as the main
25197 routine for the debugger.
25199 @item -mmalloc64
25200 @opindex mmalloc64
25201 Default to 64-bit memory allocation routines.
25203 @item -mpointer-size=@var{size}
25204 @opindex mpointer-size=@var{size}
25205 Set the default size of pointers. Possible options for @var{size} are
25206 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
25207 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
25208 The later option disables @code{pragma pointer_size}.
25209 @end table
25211 @node VxWorks Options
25212 @subsection VxWorks Options
25213 @cindex VxWorks Options
25215 The options in this section are defined for all VxWorks targets.
25216 Options specific to the target hardware are listed with the other
25217 options for that target.
25219 @table @gcctabopt
25220 @item -mrtp
25221 @opindex mrtp
25222 GCC can generate code for both VxWorks kernels and real time processes
25223 (RTPs).  This option switches from the former to the latter.  It also
25224 defines the preprocessor macro @code{__RTP__}.
25226 @item -non-static
25227 @opindex non-static
25228 Link an RTP executable against shared libraries rather than static
25229 libraries.  The options @option{-static} and @option{-shared} can
25230 also be used for RTPs (@pxref{Link Options}); @option{-static}
25231 is the default.
25233 @item -Bstatic
25234 @itemx -Bdynamic
25235 @opindex Bstatic
25236 @opindex Bdynamic
25237 These options are passed down to the linker.  They are defined for
25238 compatibility with Diab.
25240 @item -Xbind-lazy
25241 @opindex Xbind-lazy
25242 Enable lazy binding of function calls.  This option is equivalent to
25243 @option{-Wl,-z,now} and is defined for compatibility with Diab.
25245 @item -Xbind-now
25246 @opindex Xbind-now
25247 Disable lazy binding of function calls.  This option is the default and
25248 is defined for compatibility with Diab.
25249 @end table
25251 @node x86 Options
25252 @subsection x86 Options
25253 @cindex x86 Options
25255 These @samp{-m} options are defined for the x86 family of computers.
25257 @table @gcctabopt
25259 @item -march=@var{cpu-type}
25260 @opindex march
25261 Generate instructions for the machine type @var{cpu-type}.  In contrast to
25262 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
25263 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
25264 to generate code that may not run at all on processors other than the one
25265 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
25266 @option{-mtune=@var{cpu-type}}.
25268 The choices for @var{cpu-type} are:
25270 @table @samp
25271 @item native
25272 This selects the CPU to generate code for at compilation time by determining
25273 the processor type of the compiling machine.  Using @option{-march=native}
25274 enables all instruction subsets supported by the local machine (hence
25275 the result might not run on different machines).  Using @option{-mtune=native}
25276 produces code optimized for the local machine under the constraints
25277 of the selected instruction set.  
25279 @item i386
25280 Original Intel i386 CPU@.
25282 @item i486
25283 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
25285 @item i586
25286 @itemx pentium
25287 Intel Pentium CPU with no MMX support.
25289 @item lakemont
25290 Intel Lakemont MCU, based on Intel Pentium CPU.
25292 @item pentium-mmx
25293 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
25295 @item pentiumpro
25296 Intel Pentium Pro CPU@.
25298 @item i686
25299 When used with @option{-march}, the Pentium Pro
25300 instruction set is used, so the code runs on all i686 family chips.
25301 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
25303 @item pentium2
25304 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
25305 support.
25307 @item pentium3
25308 @itemx pentium3m
25309 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
25310 set support.
25312 @item pentium-m
25313 Intel Pentium M; low-power version of Intel Pentium III CPU
25314 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
25316 @item pentium4
25317 @itemx pentium4m
25318 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
25320 @item prescott
25321 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
25322 set support.
25324 @item nocona
25325 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
25326 SSE2 and SSE3 instruction set support.
25328 @item core2
25329 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
25330 instruction set support.
25332 @item nehalem
25333 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
25334 SSE4.1, SSE4.2 and POPCNT instruction set support.
25336 @item westmere
25337 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
25338 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
25340 @item sandybridge
25341 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
25342 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
25344 @item ivybridge
25345 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
25346 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
25347 instruction set support.
25349 @item haswell
25350 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
25351 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25352 BMI, BMI2 and F16C instruction set support.
25354 @item broadwell
25355 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
25356 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25357 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
25359 @item skylake
25360 Intel Skylake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
25361 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25362 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC and
25363 XSAVES instruction set support.
25365 @item bonnell
25366 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
25367 instruction set support.
25369 @item silvermont
25370 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
25371 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
25373 @item knl
25374 Intel Knight's Landing CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
25375 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25376 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER and
25377 AVX512CD instruction set support.
25379 @item knm
25380 Intel Knights Mill CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
25381 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25382 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER, AVX512CD,
25383 AVX5124VNNIW, AVX5124FMAPS and AVX512VPOPCNTDQ instruction set support.
25385 @item skylake-avx512
25386 Intel Skylake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
25387 SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25388 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F,
25389 AVX512VL, AVX512BW, AVX512DQ and AVX512CD instruction set support.
25391 @item cannonlake
25392 Intel Cannonlake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2,
25393 SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE,
25394 RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC,
25395 XSAVES, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, AVX512VBMI,
25396 AVX512IFMA, SHA, CLWB and UMIP instruction set support.
25398 @item k6
25399 AMD K6 CPU with MMX instruction set support.
25401 @item k6-2
25402 @itemx k6-3
25403 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
25405 @item athlon
25406 @itemx athlon-tbird
25407 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
25408 support.
25410 @item athlon-4
25411 @itemx athlon-xp
25412 @itemx athlon-mp
25413 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
25414 instruction set support.
25416 @item k8
25417 @itemx opteron
25418 @itemx athlon64
25419 @itemx athlon-fx
25420 Processors based on the AMD K8 core with x86-64 instruction set support,
25421 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
25422 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
25423 instruction set extensions.)
25425 @item k8-sse3
25426 @itemx opteron-sse3
25427 @itemx athlon64-sse3
25428 Improved versions of AMD K8 cores with SSE3 instruction set support.
25430 @item amdfam10
25431 @itemx barcelona
25432 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
25433 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
25434 instruction set extensions.)
25436 @item bdver1
25437 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
25438 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
25439 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
25440 @item bdver2
25441 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
25442 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
25443 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
25444 extensions.)
25445 @item bdver3
25446 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
25447 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
25448 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
25449 64-bit instruction set extensions.
25450 @item bdver4
25451 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
25452 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
25453 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
25454 SSE4.2, ABM and 64-bit instruction set extensions.
25456 @item znver1
25457 AMD Family 17h core based CPUs with x86-64 instruction set support.  (This
25458 supersets BMI, BMI2, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX,
25459 SHA, CLZERO, AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3,
25460 SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, and 64-bit
25461 instruction set extensions.
25463 @item btver1
25464 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
25465 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
25466 instruction set extensions.)
25468 @item btver2
25469 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
25470 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
25471 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
25473 @item winchip-c6
25474 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
25475 set support.
25477 @item winchip2
25478 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
25479 instruction set support.
25481 @item c3
25482 VIA C3 CPU with MMX and 3DNow!@: instruction set support.
25483 (No scheduling is implemented for this chip.)
25485 @item c3-2
25486 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
25487 (No scheduling is implemented for this chip.)
25489 @item c7
25490 VIA C7 (Esther) CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
25491 (No scheduling is implemented for this chip.)
25493 @item samuel-2
25494 VIA Eden Samuel 2 CPU with MMX and 3DNow!@: instruction set support.
25495 (No scheduling is implemented for this chip.)
25497 @item nehemiah
25498 VIA Eden Nehemiah CPU with MMX and SSE instruction set support.
25499 (No scheduling is implemented for this chip.)
25501 @item esther
25502 VIA Eden Esther CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
25503 (No scheduling is implemented for this chip.)
25505 @item eden-x2
25506 VIA Eden X2 CPU with x86-64, MMX, SSE, SSE2 and SSE3 instruction set support.
25507 (No scheduling is implemented for this chip.)
25509 @item eden-x4
25510 VIA Eden X4 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2,
25511 AVX and AVX2 instruction set support.
25512 (No scheduling is implemented for this chip.)
25514 @item nano
25515 Generic VIA Nano CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
25516 instruction set support.
25517 (No scheduling is implemented for this chip.)
25519 @item nano-1000
25520 VIA Nano 1xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
25521 instruction set support.
25522 (No scheduling is implemented for this chip.)
25524 @item nano-2000
25525 VIA Nano 2xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
25526 instruction set support.
25527 (No scheduling is implemented for this chip.)
25529 @item nano-3000
25530 VIA Nano 3xxx CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
25531 instruction set support.
25532 (No scheduling is implemented for this chip.)
25534 @item nano-x2
25535 VIA Nano Dual Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
25536 instruction set support.
25537 (No scheduling is implemented for this chip.)
25539 @item nano-x4
25540 VIA Nano Quad Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
25541 instruction set support.
25542 (No scheduling is implemented for this chip.)
25544 @item geode
25545 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
25546 @end table
25548 @item -mtune=@var{cpu-type}
25549 @opindex mtune
25550 Tune to @var{cpu-type} everything applicable about the generated code, except
25551 for the ABI and the set of available instructions.  
25552 While picking a specific @var{cpu-type} schedules things appropriately
25553 for that particular chip, the compiler does not generate any code that
25554 cannot run on the default machine type unless you use a
25555 @option{-march=@var{cpu-type}} option.
25556 For example, if GCC is configured for i686-pc-linux-gnu
25557 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
25558 but still runs on i686 machines.
25560 The choices for @var{cpu-type} are the same as for @option{-march}.
25561 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
25563 @table @samp
25564 @item generic
25565 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
25566 If you know the CPU on which your code will run, then you should use
25567 the corresponding @option{-mtune} or @option{-march} option instead of
25568 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
25569 of your application will have, then you should use this option.
25571 As new processors are deployed in the marketplace, the behavior of this
25572 option will change.  Therefore, if you upgrade to a newer version of
25573 GCC, code generation controlled by this option will change to reflect
25574 the processors
25575 that are most common at the time that version of GCC is released.
25577 There is no @option{-march=generic} option because @option{-march}
25578 indicates the instruction set the compiler can use, and there is no
25579 generic instruction set applicable to all processors.  In contrast,
25580 @option{-mtune} indicates the processor (or, in this case, collection of
25581 processors) for which the code is optimized.
25583 @item intel
25584 Produce code optimized for the most current Intel processors, which are
25585 Haswell and Silvermont for this version of GCC.  If you know the CPU
25586 on which your code will run, then you should use the corresponding
25587 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
25588 But, if you want your application performs better on both Haswell and
25589 Silvermont, then you should use this option.
25591 As new Intel processors are deployed in the marketplace, the behavior of
25592 this option will change.  Therefore, if you upgrade to a newer version of
25593 GCC, code generation controlled by this option will change to reflect
25594 the most current Intel processors at the time that version of GCC is
25595 released.
25597 There is no @option{-march=intel} option because @option{-march} indicates
25598 the instruction set the compiler can use, and there is no common
25599 instruction set applicable to all processors.  In contrast,
25600 @option{-mtune} indicates the processor (or, in this case, collection of
25601 processors) for which the code is optimized.
25602 @end table
25604 @item -mcpu=@var{cpu-type}
25605 @opindex mcpu
25606 A deprecated synonym for @option{-mtune}.
25608 @item -mfpmath=@var{unit}
25609 @opindex mfpmath
25610 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
25611 for @var{unit} are:
25613 @table @samp
25614 @item 387
25615 Use the standard 387 floating-point coprocessor present on the majority of chips and
25616 emulated otherwise.  Code compiled with this option runs almost everywhere.
25617 The temporary results are computed in 80-bit precision instead of the precision
25618 specified by the type, resulting in slightly different results compared to most
25619 of other chips.  See @option{-ffloat-store} for more detailed description.
25621 This is the default choice for non-Darwin x86-32 targets.
25623 @item sse
25624 Use scalar floating-point instructions present in the SSE instruction set.
25625 This instruction set is supported by Pentium III and newer chips,
25626 and in the AMD line
25627 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
25628 instruction set supports only single-precision arithmetic, thus the double and
25629 extended-precision arithmetic are still done using 387.  A later version, present
25630 only in Pentium 4 and AMD x86-64 chips, supports double-precision
25631 arithmetic too.
25633 For the x86-32 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
25634 or @option{-msse2} switches to enable SSE extensions and make this option
25635 effective.  For the x86-64 compiler, these extensions are enabled by default.
25637 The resulting code should be considerably faster in the majority of cases and avoid
25638 the numerical instability problems of 387 code, but may break some existing
25639 code that expects temporaries to be 80 bits.
25641 This is the default choice for the x86-64 compiler, Darwin x86-32 targets,
25642 and the default choice for x86-32 targets with the SSE2 instruction set
25643 when @option{-ffast-math} is enabled.
25645 @item sse,387
25646 @itemx sse+387
25647 @itemx both
25648 Attempt to utilize both instruction sets at once.  This effectively doubles the
25649 amount of available registers, and on chips with separate execution units for
25650 387 and SSE the execution resources too.  Use this option with care, as it is
25651 still experimental, because the GCC register allocator does not model separate
25652 functional units well, resulting in unstable performance.
25653 @end table
25655 @item -masm=@var{dialect}
25656 @opindex masm=@var{dialect}
25657 Output assembly instructions using selected @var{dialect}.  Also affects
25658 which dialect is used for basic @code{asm} (@pxref{Basic Asm}) and
25659 extended @code{asm} (@pxref{Extended Asm}). Supported choices (in dialect
25660 order) are @samp{att} or @samp{intel}. The default is @samp{att}. Darwin does
25661 not support @samp{intel}.
25663 @item -mieee-fp
25664 @itemx -mno-ieee-fp
25665 @opindex mieee-fp
25666 @opindex mno-ieee-fp
25667 Control whether or not the compiler uses IEEE floating-point
25668 comparisons.  These correctly handle the case where the result of a
25669 comparison is unordered.
25671 @item -m80387
25672 @item -mhard-float
25673 @opindex 80387
25674 @opindex mhard-float
25675 Generate output containing 80387 instructions for floating point.
25677 @item -mno-80387
25678 @item -msoft-float
25679 @opindex no-80387
25680 @opindex msoft-float
25681 Generate output containing library calls for floating point.
25683 @strong{Warning:} the requisite libraries are not part of GCC@.
25684 Normally the facilities of the machine's usual C compiler are used, but
25685 this cannot be done directly in cross-compilation.  You must make your
25686 own arrangements to provide suitable library functions for
25687 cross-compilation.
25689 On machines where a function returns floating-point results in the 80387
25690 register stack, some floating-point opcodes may be emitted even if
25691 @option{-msoft-float} is used.
25693 @item -mno-fp-ret-in-387
25694 @opindex mno-fp-ret-in-387
25695 Do not use the FPU registers for return values of functions.
25697 The usual calling convention has functions return values of types
25698 @code{float} and @code{double} in an FPU register, even if there
25699 is no FPU@.  The idea is that the operating system should emulate
25700 an FPU@.
25702 The option @option{-mno-fp-ret-in-387} causes such values to be returned
25703 in ordinary CPU registers instead.
25705 @item -mno-fancy-math-387
25706 @opindex mno-fancy-math-387
25707 Some 387 emulators do not support the @code{sin}, @code{cos} and
25708 @code{sqrt} instructions for the 387.  Specify this option to avoid
25709 generating those instructions.  This option is the default on
25710 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
25711 indicates that the target CPU always has an FPU and so the
25712 instruction does not need emulation.  These
25713 instructions are not generated unless you also use the
25714 @option{-funsafe-math-optimizations} switch.
25716 @item -malign-double
25717 @itemx -mno-align-double
25718 @opindex malign-double
25719 @opindex mno-align-double
25720 Control whether GCC aligns @code{double}, @code{long double}, and
25721 @code{long long} variables on a two-word boundary or a one-word
25722 boundary.  Aligning @code{double} variables on a two-word boundary
25723 produces code that runs somewhat faster on a Pentium at the
25724 expense of more memory.
25726 On x86-64, @option{-malign-double} is enabled by default.
25728 @strong{Warning:} if you use the @option{-malign-double} switch,
25729 structures containing the above types are aligned differently than
25730 the published application binary interface specifications for the x86-32
25731 and are not binary compatible with structures in code compiled
25732 without that switch.
25734 @item -m96bit-long-double
25735 @itemx -m128bit-long-double
25736 @opindex m96bit-long-double
25737 @opindex m128bit-long-double
25738 These switches control the size of @code{long double} type.  The x86-32
25739 application binary interface specifies the size to be 96 bits,
25740 so @option{-m96bit-long-double} is the default in 32-bit mode.
25742 Modern architectures (Pentium and newer) prefer @code{long double}
25743 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
25744 conforming to the ABI, this is not possible.  So specifying
25745 @option{-m128bit-long-double} aligns @code{long double}
25746 to a 16-byte boundary by padding the @code{long double} with an additional
25747 32-bit zero.
25749 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
25750 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
25752 Notice that neither of these options enable any extra precision over the x87
25753 standard of 80 bits for a @code{long double}.
25755 @strong{Warning:} if you override the default value for your target ABI, this
25756 changes the size of 
25757 structures and arrays containing @code{long double} variables,
25758 as well as modifying the function calling convention for functions taking
25759 @code{long double}.  Hence they are not binary-compatible
25760 with code compiled without that switch.
25762 @item -mlong-double-64
25763 @itemx -mlong-double-80
25764 @itemx -mlong-double-128
25765 @opindex mlong-double-64
25766 @opindex mlong-double-80
25767 @opindex mlong-double-128
25768 These switches control the size of @code{long double} type. A size
25769 of 64 bits makes the @code{long double} type equivalent to the @code{double}
25770 type. This is the default for 32-bit Bionic C library.  A size
25771 of 128 bits makes the @code{long double} type equivalent to the
25772 @code{__float128} type. This is the default for 64-bit Bionic C library.
25774 @strong{Warning:} if you override the default value for your target ABI, this
25775 changes the size of
25776 structures and arrays containing @code{long double} variables,
25777 as well as modifying the function calling convention for functions taking
25778 @code{long double}.  Hence they are not binary-compatible
25779 with code compiled without that switch.
25781 @item -malign-data=@var{type}
25782 @opindex malign-data
25783 Control how GCC aligns variables.  Supported values for @var{type} are
25784 @samp{compat} uses increased alignment value compatible uses GCC 4.8
25785 and earlier, @samp{abi} uses alignment value as specified by the
25786 psABI, and @samp{cacheline} uses increased alignment value to match
25787 the cache line size.  @samp{compat} is the default.
25789 @item -mlarge-data-threshold=@var{threshold}
25790 @opindex mlarge-data-threshold
25791 When @option{-mcmodel=medium} is specified, data objects larger than
25792 @var{threshold} are placed in the large data section.  This value must be the
25793 same across all objects linked into the binary, and defaults to 65535.
25795 @item -mrtd
25796 @opindex mrtd
25797 Use a different function-calling convention, in which functions that
25798 take a fixed number of arguments return with the @code{ret @var{num}}
25799 instruction, which pops their arguments while returning.  This saves one
25800 instruction in the caller since there is no need to pop the arguments
25801 there.
25803 You can specify that an individual function is called with this calling
25804 sequence with the function attribute @code{stdcall}.  You can also
25805 override the @option{-mrtd} option by using the function attribute
25806 @code{cdecl}.  @xref{Function Attributes}.
25808 @strong{Warning:} this calling convention is incompatible with the one
25809 normally used on Unix, so you cannot use it if you need to call
25810 libraries compiled with the Unix compiler.
25812 Also, you must provide function prototypes for all functions that
25813 take variable numbers of arguments (including @code{printf});
25814 otherwise incorrect code is generated for calls to those
25815 functions.
25817 In addition, seriously incorrect code results if you call a
25818 function with too many arguments.  (Normally, extra arguments are
25819 harmlessly ignored.)
25821 @item -mregparm=@var{num}
25822 @opindex mregparm
25823 Control how many registers are used to pass integer arguments.  By
25824 default, no registers are used to pass arguments, and at most 3
25825 registers can be used.  You can control this behavior for a specific
25826 function by using the function attribute @code{regparm}.
25827 @xref{Function Attributes}.
25829 @strong{Warning:} if you use this switch, and
25830 @var{num} is nonzero, then you must build all modules with the same
25831 value, including any libraries.  This includes the system libraries and
25832 startup modules.
25834 @item -msseregparm
25835 @opindex msseregparm
25836 Use SSE register passing conventions for float and double arguments
25837 and return values.  You can control this behavior for a specific
25838 function by using the function attribute @code{sseregparm}.
25839 @xref{Function Attributes}.
25841 @strong{Warning:} if you use this switch then you must build all
25842 modules with the same value, including any libraries.  This includes
25843 the system libraries and startup modules.
25845 @item -mvect8-ret-in-mem
25846 @opindex mvect8-ret-in-mem
25847 Return 8-byte vectors in memory instead of MMX registers.  This is the
25848 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
25849 Studio compilers until version 12.  Later compiler versions (starting
25850 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
25851 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
25852 you need to remain compatible with existing code produced by those
25853 previous compiler versions or older versions of GCC@.
25855 @item -mpc32
25856 @itemx -mpc64
25857 @itemx -mpc80
25858 @opindex mpc32
25859 @opindex mpc64
25860 @opindex mpc80
25862 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
25863 is specified, the significands of results of floating-point operations are
25864 rounded to 24 bits (single precision); @option{-mpc64} rounds the
25865 significands of results of floating-point operations to 53 bits (double
25866 precision) and @option{-mpc80} rounds the significands of results of
25867 floating-point operations to 64 bits (extended double precision), which is
25868 the default.  When this option is used, floating-point operations in higher
25869 precisions are not available to the programmer without setting the FPU
25870 control word explicitly.
25872 Setting the rounding of floating-point operations to less than the default
25873 80 bits can speed some programs by 2% or more.  Note that some mathematical
25874 libraries assume that extended-precision (80-bit) floating-point operations
25875 are enabled by default; routines in such libraries could suffer significant
25876 loss of accuracy, typically through so-called ``catastrophic cancellation'',
25877 when this option is used to set the precision to less than extended precision.
25879 @item -mstackrealign
25880 @opindex mstackrealign
25881 Realign the stack at entry.  On the x86, the @option{-mstackrealign}
25882 option generates an alternate prologue and epilogue that realigns the
25883 run-time stack if necessary.  This supports mixing legacy codes that keep
25884 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
25885 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
25886 applicable to individual functions.
25888 @item -mpreferred-stack-boundary=@var{num}
25889 @opindex mpreferred-stack-boundary
25890 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
25891 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
25892 the default is 4 (16 bytes or 128 bits).
25894 @strong{Warning:} When generating code for the x86-64 architecture with
25895 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
25896 used to keep the stack boundary aligned to 8 byte boundary.  Since
25897 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
25898 intended to be used in controlled environment where stack space is
25899 important limitation.  This option leads to wrong code when functions
25900 compiled with 16 byte stack alignment (such as functions from a standard
25901 library) are called with misaligned stack.  In this case, SSE
25902 instructions may lead to misaligned memory access traps.  In addition,
25903 variable arguments are handled incorrectly for 16 byte aligned
25904 objects (including x87 long double and __int128), leading to wrong
25905 results.  You must build all modules with
25906 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
25907 includes the system libraries and startup modules.
25909 @item -mincoming-stack-boundary=@var{num}
25910 @opindex mincoming-stack-boundary
25911 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
25912 boundary.  If @option{-mincoming-stack-boundary} is not specified,
25913 the one specified by @option{-mpreferred-stack-boundary} is used.
25915 On Pentium and Pentium Pro, @code{double} and @code{long double} values
25916 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
25917 suffer significant run time performance penalties.  On Pentium III, the
25918 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
25919 properly if it is not 16-byte aligned.
25921 To ensure proper alignment of this values on the stack, the stack boundary
25922 must be as aligned as that required by any value stored on the stack.
25923 Further, every function must be generated such that it keeps the stack
25924 aligned.  Thus calling a function compiled with a higher preferred
25925 stack boundary from a function compiled with a lower preferred stack
25926 boundary most likely misaligns the stack.  It is recommended that
25927 libraries that use callbacks always use the default setting.
25929 This extra alignment does consume extra stack space, and generally
25930 increases code size.  Code that is sensitive to stack space usage, such
25931 as embedded systems and operating system kernels, may want to reduce the
25932 preferred alignment to @option{-mpreferred-stack-boundary=2}.
25934 @need 200
25935 @item -mmmx
25936 @opindex mmmx
25937 @need 200
25938 @itemx -msse
25939 @opindex msse
25940 @need 200
25941 @itemx -msse2
25942 @opindex msse2
25943 @need 200
25944 @itemx -msse3
25945 @opindex msse3
25946 @need 200
25947 @itemx -mssse3
25948 @opindex mssse3
25949 @need 200
25950 @itemx -msse4
25951 @opindex msse4
25952 @need 200
25953 @itemx -msse4a
25954 @opindex msse4a
25955 @need 200
25956 @itemx -msse4.1
25957 @opindex msse4.1
25958 @need 200
25959 @itemx -msse4.2
25960 @opindex msse4.2
25961 @need 200
25962 @itemx -mavx
25963 @opindex mavx
25964 @need 200
25965 @itemx -mavx2
25966 @opindex mavx2
25967 @need 200
25968 @itemx -mavx512f
25969 @opindex mavx512f
25970 @need 200
25971 @itemx -mavx512pf
25972 @opindex mavx512pf
25973 @need 200
25974 @itemx -mavx512er
25975 @opindex mavx512er
25976 @need 200
25977 @itemx -mavx512cd
25978 @opindex mavx512cd
25979 @need 200
25980 @itemx -mavx512vl
25981 @opindex mavx512vl
25982 @need 200
25983 @itemx -mavx512bw
25984 @opindex mavx512bw
25985 @need 200
25986 @itemx -mavx512dq
25987 @opindex mavx512dq
25988 @need 200
25989 @itemx -mavx512ifma
25990 @opindex mavx512ifma
25991 @need 200
25992 @itemx -mavx512vbmi
25993 @opindex mavx512vbmi
25994 @need 200
25995 @itemx -msha
25996 @opindex msha
25997 @need 200
25998 @itemx -maes
25999 @opindex maes
26000 @need 200
26001 @itemx -mpclmul
26002 @opindex mpclmul
26003 @need 200
26004 @itemx -mclfushopt
26005 @opindex mclfushopt
26006 @need 200
26007 @itemx -mfsgsbase
26008 @opindex mfsgsbase
26009 @need 200
26010 @itemx -mrdrnd
26011 @opindex mrdrnd
26012 @need 200
26013 @itemx -mf16c
26014 @opindex mf16c
26015 @need 200
26016 @itemx -mfma
26017 @opindex mfma
26018 @need 200
26019 @itemx -mfma4
26020 @opindex mfma4
26021 @need 200
26022 @itemx -mprefetchwt1
26023 @opindex mprefetchwt1
26024 @need 200
26025 @itemx -mxop
26026 @opindex mxop
26027 @need 200
26028 @itemx -mlwp
26029 @opindex mlwp
26030 @need 200
26031 @itemx -m3dnow
26032 @opindex m3dnow
26033 @need 200
26034 @itemx -m3dnowa
26035 @opindex m3dnowa
26036 @need 200
26037 @itemx -mpopcnt
26038 @opindex mpopcnt
26039 @need 200
26040 @itemx -mabm
26041 @opindex mabm
26042 @need 200
26043 @itemx -mbmi
26044 @opindex mbmi
26045 @need 200
26046 @itemx -mbmi2
26047 @need 200
26048 @itemx -mlzcnt
26049 @opindex mlzcnt
26050 @need 200
26051 @itemx -mfxsr
26052 @opindex mfxsr
26053 @need 200
26054 @itemx -mxsave
26055 @opindex mxsave
26056 @need 200
26057 @itemx -mxsaveopt
26058 @opindex mxsaveopt
26059 @need 200
26060 @itemx -mxsavec
26061 @opindex mxsavec
26062 @need 200
26063 @itemx -mxsaves
26064 @opindex mxsaves
26065 @need 200
26066 @itemx -mrtm
26067 @opindex mrtm
26068 @need 200
26069 @itemx -mtbm
26070 @opindex mtbm
26071 @need 200
26072 @itemx -mmpx
26073 @opindex mmpx
26074 @need 200
26075 @itemx -mmwaitx
26076 @opindex mmwaitx
26077 @need 200
26078 @itemx -mclzero
26079 @opindex mclzero
26080 @need 200
26081 @itemx -mpku
26082 @opindex mpku
26083 @need 200
26084 @itemx -mcet
26085 @opindex mcet
26086 @need 200
26087 @itemx -mavx512vbmi2
26088 @opindex mavx512vbmi2
26089 @need 200
26090 @itemx -mgfni
26091 @opindex mgfni
26092 These switches enable the use of instructions in the MMX, SSE,
26093 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
26094 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
26095 AVX512VL, AVX512BW, AVX512DQ, AVX512IFMA, AVX512VBMI, BMI, BMI2,
26096 FXSR, XSAVE, XSAVEOPT, LZCNT, RTM, MPX, MWAITX, PKU, IBT, SHSTK, AVX512VBMI2,
26097 GFNI, 3DNow!@: or enhanced 3DNow!@: extended instruction sets.  Each has a
26098 corresponding @option{-mno-} option to disable use of these instructions.
26100 These extensions are also available as built-in functions: see
26101 @ref{x86 Built-in Functions}, for details of the functions enabled and
26102 disabled by these switches.
26104 To generate SSE/SSE2 instructions automatically from floating-point
26105 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
26107 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
26108 generates new AVX instructions or AVX equivalence for all SSEx instructions
26109 when needed.
26111 These options enable GCC to use these extended instructions in
26112 generated code, even without @option{-mfpmath=sse}.  Applications that
26113 perform run-time CPU detection must compile separate files for each
26114 supported architecture, using the appropriate flags.  In particular,
26115 the file containing the CPU detection code should be compiled without
26116 these options.
26118 The @option{-mcet} option turns on the @option{-mibt} and @option{-mshstk}
26119 options.  The @option{-mibt} option enables indirect branch tracking support
26120 and the @option{-mshstk} option enables shadow stack support from
26121 Intel Control-flow Enforcement Technology (CET).  The compiler also provides
26122 a number of built-in functions for fine-grained control in a CET-based
26123 application.  See @xref{x86 Built-in Functions}, for more information.
26125 @item -mdump-tune-features
26126 @opindex mdump-tune-features
26127 This option instructs GCC to dump the names of the x86 performance 
26128 tuning features and default settings. The names can be used in 
26129 @option{-mtune-ctrl=@var{feature-list}}.
26131 @item -mtune-ctrl=@var{feature-list}
26132 @opindex mtune-ctrl=@var{feature-list}
26133 This option is used to do fine grain control of x86 code generation features.
26134 @var{feature-list} is a comma separated list of @var{feature} names. See also
26135 @option{-mdump-tune-features}. When specified, the @var{feature} is turned
26136 on if it is not preceded with @samp{^}, otherwise, it is turned off. 
26137 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
26138 developers. Using it may lead to code paths not covered by testing and can
26139 potentially result in compiler ICEs or runtime errors.
26141 @item -mno-default
26142 @opindex mno-default
26143 This option instructs GCC to turn off all tunable features. See also 
26144 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
26146 @item -mcld
26147 @opindex mcld
26148 This option instructs GCC to emit a @code{cld} instruction in the prologue
26149 of functions that use string instructions.  String instructions depend on
26150 the DF flag to select between autoincrement or autodecrement mode.  While the
26151 ABI specifies the DF flag to be cleared on function entry, some operating
26152 systems violate this specification by not clearing the DF flag in their
26153 exception dispatchers.  The exception handler can be invoked with the DF flag
26154 set, which leads to wrong direction mode when string instructions are used.
26155 This option can be enabled by default on 32-bit x86 targets by configuring
26156 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
26157 instructions can be suppressed with the @option{-mno-cld} compiler option
26158 in this case.
26160 @item -mvzeroupper
26161 @opindex mvzeroupper
26162 This option instructs GCC to emit a @code{vzeroupper} instruction
26163 before a transfer of control flow out of the function to minimize
26164 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
26165 intrinsics.
26167 @item -mprefer-avx128
26168 @opindex mprefer-avx128
26169 This option instructs GCC to use 128-bit AVX instructions instead of
26170 256-bit AVX instructions in the auto-vectorizer.
26172 @item -mprefer-vector-width=@var{opt}
26173 @opindex mprefer-vector-width
26174 This option instructs GCC to use @var{opt}-bit vector width in instructions
26175 instead of default on the selected platform.
26177 @table @samp
26178 @item none
26179 No extra limitations applied to GCC other than defined by the selected platform.
26181 @item 128
26182 Prefer 128-bit vector width for instructions.
26184 @item 256
26185 Prefer 256-bit vector width for instructions.
26187 @item 512
26188 Prefer 512-bit vector width for instructions.
26189 @end table
26191 @item -mcx16
26192 @opindex mcx16
26193 This option enables GCC to generate @code{CMPXCHG16B} instructions in 64-bit
26194 code to implement compare-and-exchange operations on 16-byte aligned 128-bit
26195 objects.  This is useful for atomic updates of data structures exceeding one
26196 machine word in size.  The compiler uses this instruction to implement
26197 @ref{__sync Builtins}.  However, for @ref{__atomic Builtins} operating on
26198 128-bit integers, a library call is always used.
26200 @item -msahf
26201 @opindex msahf
26202 This option enables generation of @code{SAHF} instructions in 64-bit code.
26203 Early Intel Pentium 4 CPUs with Intel 64 support,
26204 prior to the introduction of Pentium 4 G1 step in December 2005,
26205 lacked the @code{LAHF} and @code{SAHF} instructions
26206 which are supported by AMD64.
26207 These are load and store instructions, respectively, for certain status flags.
26208 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
26209 @code{drem}, and @code{remainder} built-in functions;
26210 see @ref{Other Builtins} for details.
26212 @item -mmovbe
26213 @opindex mmovbe
26214 This option enables use of the @code{movbe} instruction to implement
26215 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
26217 @item -mibt
26218 @opindex mibt
26219 This option tells the compiler to use indirect branch tracking support
26220 (for indirect calls and jumps) from x86 Control-flow Enforcement
26221 Technology (CET).  The option has effect only if the
26222 @option{-fcf-protection=full} or @option{-fcf-protection=branch} option
26223 is specified. The option @option{-mibt} is on by default when the
26224 @code{-mcet} option is specified.
26226 @item -mshstk
26227 @opindex mshstk
26228 This option tells the compiler to use shadow stack support (return
26229 address tracking) from x86 Control-flow Enforcement Technology (CET).
26230 The option has effect only if the @option{-fcf-protection=full} or
26231 @option{-fcf-protection=return} option is specified.  The option
26232 @option{-mshstk} is on by default when the @option{-mcet} option is
26233 specified.
26235 @item -mcrc32
26236 @opindex mcrc32
26237 This option enables built-in functions @code{__builtin_ia32_crc32qi},
26238 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
26239 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
26241 @item -mrecip
26242 @opindex mrecip
26243 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
26244 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
26245 with an additional Newton-Raphson step
26246 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
26247 (and their vectorized
26248 variants) for single-precision floating-point arguments.  These instructions
26249 are generated only when @option{-funsafe-math-optimizations} is enabled
26250 together with @option{-ffinite-math-only} and @option{-fno-trapping-math}.
26251 Note that while the throughput of the sequence is higher than the throughput
26252 of the non-reciprocal instruction, the precision of the sequence can be
26253 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
26255 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
26256 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
26257 combination), and doesn't need @option{-mrecip}.
26259 Also note that GCC emits the above sequence with additional Newton-Raphson step
26260 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
26261 already with @option{-ffast-math} (or the above option combination), and
26262 doesn't need @option{-mrecip}.
26264 @item -mrecip=@var{opt}
26265 @opindex mrecip=opt
26266 This option controls which reciprocal estimate instructions
26267 may be used.  @var{opt} is a comma-separated list of options, which may
26268 be preceded by a @samp{!} to invert the option:
26270 @table @samp
26271 @item all
26272 Enable all estimate instructions.
26274 @item default
26275 Enable the default instructions, equivalent to @option{-mrecip}.
26277 @item none
26278 Disable all estimate instructions, equivalent to @option{-mno-recip}.
26280 @item div
26281 Enable the approximation for scalar division.
26283 @item vec-div
26284 Enable the approximation for vectorized division.
26286 @item sqrt
26287 Enable the approximation for scalar square root.
26289 @item vec-sqrt
26290 Enable the approximation for vectorized square root.
26291 @end table
26293 So, for example, @option{-mrecip=all,!sqrt} enables
26294 all of the reciprocal approximations, except for square root.
26296 @item -mveclibabi=@var{type}
26297 @opindex mveclibabi
26298 Specifies the ABI type to use for vectorizing intrinsics using an
26299 external library.  Supported values for @var{type} are @samp{svml} 
26300 for the Intel short
26301 vector math library and @samp{acml} for the AMD math core library.
26302 To use this option, both @option{-ftree-vectorize} and
26303 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
26304 ABI-compatible library must be specified at link time.
26306 GCC currently emits calls to @code{vmldExp2},
26307 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
26308 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
26309 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
26310 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
26311 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
26312 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
26313 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
26314 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
26315 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
26316 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
26317 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
26318 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
26319 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
26320 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
26321 when @option{-mveclibabi=acml} is used.  
26323 @item -mabi=@var{name}
26324 @opindex mabi
26325 Generate code for the specified calling convention.  Permissible values
26326 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
26327 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
26328 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
26329 You can control this behavior for specific functions by
26330 using the function attributes @code{ms_abi} and @code{sysv_abi}.
26331 @xref{Function Attributes}.
26333 @item -mforce-indirect-call
26334 @opindex mforce-indirect-call
26335 Force all calls to functions to be indirect. This is useful
26336 when using Intel Processor Trace where it generates more precise timing
26337 information for function calls.
26339 @item -mcall-ms2sysv-xlogues
26340 @opindex mcall-ms2sysv-xlogues
26341 @opindex mno-call-ms2sysv-xlogues
26342 Due to differences in 64-bit ABIs, any Microsoft ABI function that calls a
26343 System V ABI function must consider RSI, RDI and XMM6-15 as clobbered.  By
26344 default, the code for saving and restoring these registers is emitted inline,
26345 resulting in fairly lengthy prologues and epilogues.  Using
26346 @option{-mcall-ms2sysv-xlogues} emits prologues and epilogues that
26347 use stubs in the static portion of libgcc to perform these saves and restores,
26348 thus reducing function size at the cost of a few extra instructions.
26350 @item -mtls-dialect=@var{type}
26351 @opindex mtls-dialect
26352 Generate code to access thread-local storage using the @samp{gnu} or
26353 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
26354 @samp{gnu2} is more efficient, but it may add compile- and run-time
26355 requirements that cannot be satisfied on all systems.
26357 @item -mpush-args
26358 @itemx -mno-push-args
26359 @opindex mpush-args
26360 @opindex mno-push-args
26361 Use PUSH operations to store outgoing parameters.  This method is shorter
26362 and usually equally fast as method using SUB/MOV operations and is enabled
26363 by default.  In some cases disabling it may improve performance because of
26364 improved scheduling and reduced dependencies.
26366 @item -maccumulate-outgoing-args
26367 @opindex maccumulate-outgoing-args
26368 If enabled, the maximum amount of space required for outgoing arguments is
26369 computed in the function prologue.  This is faster on most modern CPUs
26370 because of reduced dependencies, improved scheduling and reduced stack usage
26371 when the preferred stack boundary is not equal to 2.  The drawback is a notable
26372 increase in code size.  This switch implies @option{-mno-push-args}.
26374 @item -mthreads
26375 @opindex mthreads
26376 Support thread-safe exception handling on MinGW.  Programs that rely
26377 on thread-safe exception handling must compile and link all code with the
26378 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
26379 @option{-D_MT}; when linking, it links in a special thread helper library
26380 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
26382 @item -mms-bitfields
26383 @itemx -mno-ms-bitfields
26384 @opindex mms-bitfields
26385 @opindex mno-ms-bitfields
26387 Enable/disable bit-field layout compatible with the native Microsoft
26388 Windows compiler.  
26390 If @code{packed} is used on a structure, or if bit-fields are used,
26391 it may be that the Microsoft ABI lays out the structure differently
26392 than the way GCC normally does.  Particularly when moving packed
26393 data between functions compiled with GCC and the native Microsoft compiler
26394 (either via function call or as data in a file), it may be necessary to access
26395 either format.
26397 This option is enabled by default for Microsoft Windows
26398 targets.  This behavior can also be controlled locally by use of variable
26399 or type attributes.  For more information, see @ref{x86 Variable Attributes}
26400 and @ref{x86 Type Attributes}.
26402 The Microsoft structure layout algorithm is fairly simple with the exception
26403 of the bit-field packing.  
26404 The padding and alignment of members of structures and whether a bit-field 
26405 can straddle a storage-unit boundary are determine by these rules:
26407 @enumerate
26408 @item Structure members are stored sequentially in the order in which they are
26409 declared: the first member has the lowest memory address and the last member
26410 the highest.
26412 @item Every data object has an alignment requirement.  The alignment requirement
26413 for all data except structures, unions, and arrays is either the size of the
26414 object or the current packing size (specified with either the
26415 @code{aligned} attribute or the @code{pack} pragma),
26416 whichever is less.  For structures, unions, and arrays,
26417 the alignment requirement is the largest alignment requirement of its members.
26418 Every object is allocated an offset so that:
26420 @smallexample
26421 offset % alignment_requirement == 0
26422 @end smallexample
26424 @item Adjacent bit-fields are packed into the same 1-, 2-, or 4-byte allocation
26425 unit if the integral types are the same size and if the next bit-field fits
26426 into the current allocation unit without crossing the boundary imposed by the
26427 common alignment requirements of the bit-fields.
26428 @end enumerate
26430 MSVC interprets zero-length bit-fields in the following ways:
26432 @enumerate
26433 @item If a zero-length bit-field is inserted between two bit-fields that
26434 are normally coalesced, the bit-fields are not coalesced.
26436 For example:
26438 @smallexample
26439 struct
26440  @{
26441    unsigned long bf_1 : 12;
26442    unsigned long : 0;
26443    unsigned long bf_2 : 12;
26444  @} t1;
26445 @end smallexample
26447 @noindent
26448 The size of @code{t1} is 8 bytes with the zero-length bit-field.  If the
26449 zero-length bit-field were removed, @code{t1}'s size would be 4 bytes.
26451 @item If a zero-length bit-field is inserted after a bit-field, @code{foo}, and the
26452 alignment of the zero-length bit-field is greater than the member that follows it,
26453 @code{bar}, @code{bar} is aligned as the type of the zero-length bit-field.
26455 For example:
26457 @smallexample
26458 struct
26459  @{
26460    char foo : 4;
26461    short : 0;
26462    char bar;
26463  @} t2;
26465 struct
26466  @{
26467    char foo : 4;
26468    short : 0;
26469    double bar;
26470  @} t3;
26471 @end smallexample
26473 @noindent
26474 For @code{t2}, @code{bar} is placed at offset 2, rather than offset 1.
26475 Accordingly, the size of @code{t2} is 4.  For @code{t3}, the zero-length
26476 bit-field does not affect the alignment of @code{bar} or, as a result, the size
26477 of the structure.
26479 Taking this into account, it is important to note the following:
26481 @enumerate
26482 @item If a zero-length bit-field follows a normal bit-field, the type of the
26483 zero-length bit-field may affect the alignment of the structure as whole. For
26484 example, @code{t2} has a size of 4 bytes, since the zero-length bit-field follows a
26485 normal bit-field, and is of type short.
26487 @item Even if a zero-length bit-field is not followed by a normal bit-field, it may
26488 still affect the alignment of the structure:
26490 @smallexample
26491 struct
26492  @{
26493    char foo : 6;
26494    long : 0;
26495  @} t4;
26496 @end smallexample
26498 @noindent
26499 Here, @code{t4} takes up 4 bytes.
26500 @end enumerate
26502 @item Zero-length bit-fields following non-bit-field members are ignored:
26504 @smallexample
26505 struct
26506  @{
26507    char foo;
26508    long : 0;
26509    char bar;
26510  @} t5;
26511 @end smallexample
26513 @noindent
26514 Here, @code{t5} takes up 2 bytes.
26515 @end enumerate
26518 @item -mno-align-stringops
26519 @opindex mno-align-stringops
26520 Do not align the destination of inlined string operations.  This switch reduces
26521 code size and improves performance in case the destination is already aligned,
26522 but GCC doesn't know about it.
26524 @item -minline-all-stringops
26525 @opindex minline-all-stringops
26526 By default GCC inlines string operations only when the destination is 
26527 known to be aligned to least a 4-byte boundary.  
26528 This enables more inlining and increases code
26529 size, but may improve performance of code that depends on fast
26530 @code{memcpy}, @code{strlen},
26531 and @code{memset} for short lengths.
26533 @item -minline-stringops-dynamically
26534 @opindex minline-stringops-dynamically
26535 For string operations of unknown size, use run-time checks with
26536 inline code for small blocks and a library call for large blocks.
26538 @item -mstringop-strategy=@var{alg}
26539 @opindex mstringop-strategy=@var{alg}
26540 Override the internal decision heuristic for the particular algorithm to use
26541 for inlining string operations.  The allowed values for @var{alg} are:
26543 @table @samp
26544 @item rep_byte
26545 @itemx rep_4byte
26546 @itemx rep_8byte
26547 Expand using i386 @code{rep} prefix of the specified size.
26549 @item byte_loop
26550 @itemx loop
26551 @itemx unrolled_loop
26552 Expand into an inline loop.
26554 @item libcall
26555 Always use a library call.
26556 @end table
26558 @item -mmemcpy-strategy=@var{strategy}
26559 @opindex mmemcpy-strategy=@var{strategy}
26560 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
26561 should be inlined and what inline algorithm to use when the expected size
26562 of the copy operation is known. @var{strategy} 
26563 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
26564 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
26565 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
26566 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
26567 in the list must be specified in increasing order.  The minimal byte size for 
26568 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
26569 preceding range.
26571 @item -mmemset-strategy=@var{strategy}
26572 @opindex mmemset-strategy=@var{strategy}
26573 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
26574 @code{__builtin_memset} expansion.
26576 @item -momit-leaf-frame-pointer
26577 @opindex momit-leaf-frame-pointer
26578 Don't keep the frame pointer in a register for leaf functions.  This
26579 avoids the instructions to save, set up, and restore frame pointers and
26580 makes an extra register available in leaf functions.  The option
26581 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
26582 which might make debugging harder.
26584 @item -mtls-direct-seg-refs
26585 @itemx -mno-tls-direct-seg-refs
26586 @opindex mtls-direct-seg-refs
26587 Controls whether TLS variables may be accessed with offsets from the
26588 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
26589 or whether the thread base pointer must be added.  Whether or not this
26590 is valid depends on the operating system, and whether it maps the
26591 segment to cover the entire TLS area.
26593 For systems that use the GNU C Library, the default is on.
26595 @item -msse2avx
26596 @itemx -mno-sse2avx
26597 @opindex msse2avx
26598 Specify that the assembler should encode SSE instructions with VEX
26599 prefix.  The option @option{-mavx} turns this on by default.
26601 @item -mfentry
26602 @itemx -mno-fentry
26603 @opindex mfentry
26604 If profiling is active (@option{-pg}), put the profiling
26605 counter call before the prologue.
26606 Note: On x86 architectures the attribute @code{ms_hook_prologue}
26607 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
26609 @item -mrecord-mcount
26610 @itemx -mno-record-mcount
26611 @opindex mrecord-mcount
26612 If profiling is active (@option{-pg}), generate a __mcount_loc section
26613 that contains pointers to each profiling call. This is useful for
26614 automatically patching and out calls.
26616 @item -mnop-mcount
26617 @itemx -mno-nop-mcount
26618 @opindex mnop-mcount
26619 If profiling is active (@option{-pg}), generate the calls to
26620 the profiling functions as NOPs. This is useful when they
26621 should be patched in later dynamically. This is likely only
26622 useful together with @option{-mrecord-mcount}.
26624 @item -mskip-rax-setup
26625 @itemx -mno-skip-rax-setup
26626 @opindex mskip-rax-setup
26627 When generating code for the x86-64 architecture with SSE extensions
26628 disabled, @option{-mskip-rax-setup} can be used to skip setting up RAX
26629 register when there are no variable arguments passed in vector registers.
26631 @strong{Warning:} Since RAX register is used to avoid unnecessarily
26632 saving vector registers on stack when passing variable arguments, the
26633 impacts of this option are callees may waste some stack space,
26634 misbehave or jump to a random location.  GCC 4.4 or newer don't have
26635 those issues, regardless the RAX register value.
26637 @item -m8bit-idiv
26638 @itemx -mno-8bit-idiv
26639 @opindex m8bit-idiv
26640 On some processors, like Intel Atom, 8-bit unsigned integer divide is
26641 much faster than 32-bit/64-bit integer divide.  This option generates a
26642 run-time check.  If both dividend and divisor are within range of 0
26643 to 255, 8-bit unsigned integer divide is used instead of
26644 32-bit/64-bit integer divide.
26646 @item -mavx256-split-unaligned-load
26647 @itemx -mavx256-split-unaligned-store
26648 @opindex mavx256-split-unaligned-load
26649 @opindex mavx256-split-unaligned-store
26650 Split 32-byte AVX unaligned load and store.
26652 @item -mstack-protector-guard=@var{guard}
26653 @itemx -mstack-protector-guard-reg=@var{reg}
26654 @itemx -mstack-protector-guard-offset=@var{offset}
26655 @opindex mstack-protector-guard
26656 @opindex mstack-protector-guard-reg
26657 @opindex mstack-protector-guard-offset
26658 Generate stack protection code using canary at @var{guard}.  Supported
26659 locations are @samp{global} for global canary or @samp{tls} for per-thread
26660 canary in the TLS block (the default).  This option has effect only when
26661 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
26663 With the latter choice the options
26664 @option{-mstack-protector-guard-reg=@var{reg}} and
26665 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
26666 which segment register (@code{%fs} or @code{%gs}) to use as base register
26667 for reading the canary, and from what offset from that base register.
26668 The default for those is as specified in the relevant ABI.
26670 @item -mmitigate-rop
26671 @opindex mmitigate-rop
26672 Try to avoid generating code sequences that contain unintended return
26673 opcodes, to mitigate against certain forms of attack. At the moment,
26674 this option is limited in what it can do and should not be relied
26675 on to provide serious protection.
26677 @item -mgeneral-regs-only
26678 @opindex mgeneral-regs-only
26679 Generate code that uses only the general-purpose registers.  This
26680 prevents the compiler from using floating-point, vector, mask and bound
26681 registers.
26683 @end table
26685 These @samp{-m} switches are supported in addition to the above
26686 on x86-64 processors in 64-bit environments.
26688 @table @gcctabopt
26689 @item -m32
26690 @itemx -m64
26691 @itemx -mx32
26692 @itemx -m16
26693 @itemx -miamcu
26694 @opindex m32
26695 @opindex m64
26696 @opindex mx32
26697 @opindex m16
26698 @opindex miamcu
26699 Generate code for a 16-bit, 32-bit or 64-bit environment.
26700 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
26701 to 32 bits, and
26702 generates code that runs on any i386 system.
26704 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
26705 types to 64 bits, and generates code for the x86-64 architecture.
26706 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
26707 and @option{-mdynamic-no-pic} options.
26709 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
26710 to 32 bits, and
26711 generates code for the x86-64 architecture.
26713 The @option{-m16} option is the same as @option{-m32}, except for that
26714 it outputs the @code{.code16gcc} assembly directive at the beginning of
26715 the assembly output so that the binary can run in 16-bit mode.
26717 The @option{-miamcu} option generates code which conforms to Intel MCU
26718 psABI.  It requires the @option{-m32} option to be turned on.
26720 @item -mno-red-zone
26721 @opindex mno-red-zone
26722 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
26723 by the x86-64 ABI; it is a 128-byte area beyond the location of the
26724 stack pointer that is not modified by signal or interrupt handlers
26725 and therefore can be used for temporary data without adjusting the stack
26726 pointer.  The flag @option{-mno-red-zone} disables this red zone.
26728 @item -mcmodel=small
26729 @opindex mcmodel=small
26730 Generate code for the small code model: the program and its symbols must
26731 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
26732 Programs can be statically or dynamically linked.  This is the default
26733 code model.
26735 @item -mcmodel=kernel
26736 @opindex mcmodel=kernel
26737 Generate code for the kernel code model.  The kernel runs in the
26738 negative 2 GB of the address space.
26739 This model has to be used for Linux kernel code.
26741 @item -mcmodel=medium
26742 @opindex mcmodel=medium
26743 Generate code for the medium model: the program is linked in the lower 2
26744 GB of the address space.  Small symbols are also placed there.  Symbols
26745 with sizes larger than @option{-mlarge-data-threshold} are put into
26746 large data or BSS sections and can be located above 2GB.  Programs can
26747 be statically or dynamically linked.
26749 @item -mcmodel=large
26750 @opindex mcmodel=large
26751 Generate code for the large model.  This model makes no assumptions
26752 about addresses and sizes of sections.
26754 @item -maddress-mode=long
26755 @opindex maddress-mode=long
26756 Generate code for long address mode.  This is only supported for 64-bit
26757 and x32 environments.  It is the default address mode for 64-bit
26758 environments.
26760 @item -maddress-mode=short
26761 @opindex maddress-mode=short
26762 Generate code for short address mode.  This is only supported for 32-bit
26763 and x32 environments.  It is the default address mode for 32-bit and
26764 x32 environments.
26765 @end table
26767 @node x86 Windows Options
26768 @subsection x86 Windows Options
26769 @cindex x86 Windows Options
26770 @cindex Windows Options for x86
26772 These additional options are available for Microsoft Windows targets:
26774 @table @gcctabopt
26775 @item -mconsole
26776 @opindex mconsole
26777 This option
26778 specifies that a console application is to be generated, by
26779 instructing the linker to set the PE header subsystem type
26780 required for console applications.
26781 This option is available for Cygwin and MinGW targets and is
26782 enabled by default on those targets.
26784 @item -mdll
26785 @opindex mdll
26786 This option is available for Cygwin and MinGW targets.  It
26787 specifies that a DLL---a dynamic link library---is to be
26788 generated, enabling the selection of the required runtime
26789 startup object and entry point.
26791 @item -mnop-fun-dllimport
26792 @opindex mnop-fun-dllimport
26793 This option is available for Cygwin and MinGW targets.  It
26794 specifies that the @code{dllimport} attribute should be ignored.
26796 @item -mthread
26797 @opindex mthread
26798 This option is available for MinGW targets. It specifies
26799 that MinGW-specific thread support is to be used.
26801 @item -municode
26802 @opindex municode
26803 This option is available for MinGW-w64 targets.  It causes
26804 the @code{UNICODE} preprocessor macro to be predefined, and
26805 chooses Unicode-capable runtime startup code.
26807 @item -mwin32
26808 @opindex mwin32
26809 This option is available for Cygwin and MinGW targets.  It
26810 specifies that the typical Microsoft Windows predefined macros are to
26811 be set in the pre-processor, but does not influence the choice
26812 of runtime library/startup code.
26814 @item -mwindows
26815 @opindex mwindows
26816 This option is available for Cygwin and MinGW targets.  It
26817 specifies that a GUI application is to be generated by
26818 instructing the linker to set the PE header subsystem type
26819 appropriately.
26821 @item -fno-set-stack-executable
26822 @opindex fno-set-stack-executable
26823 This option is available for MinGW targets. It specifies that
26824 the executable flag for the stack used by nested functions isn't
26825 set. This is necessary for binaries running in kernel mode of
26826 Microsoft Windows, as there the User32 API, which is used to set executable
26827 privileges, isn't available.
26829 @item -fwritable-relocated-rdata
26830 @opindex fno-writable-relocated-rdata
26831 This option is available for MinGW and Cygwin targets.  It specifies
26832 that relocated-data in read-only section is put into the @code{.data}
26833 section.  This is a necessary for older runtimes not supporting
26834 modification of @code{.rdata} sections for pseudo-relocation.
26836 @item -mpe-aligned-commons
26837 @opindex mpe-aligned-commons
26838 This option is available for Cygwin and MinGW targets.  It
26839 specifies that the GNU extension to the PE file format that
26840 permits the correct alignment of COMMON variables should be
26841 used when generating code.  It is enabled by default if
26842 GCC detects that the target assembler found during configuration
26843 supports the feature.
26844 @end table
26846 See also under @ref{x86 Options} for standard options.
26848 @node Xstormy16 Options
26849 @subsection Xstormy16 Options
26850 @cindex Xstormy16 Options
26852 These options are defined for Xstormy16:
26854 @table @gcctabopt
26855 @item -msim
26856 @opindex msim
26857 Choose startup files and linker script suitable for the simulator.
26858 @end table
26860 @node Xtensa Options
26861 @subsection Xtensa Options
26862 @cindex Xtensa Options
26864 These options are supported for Xtensa targets:
26866 @table @gcctabopt
26867 @item -mconst16
26868 @itemx -mno-const16
26869 @opindex mconst16
26870 @opindex mno-const16
26871 Enable or disable use of @code{CONST16} instructions for loading
26872 constant values.  The @code{CONST16} instruction is currently not a
26873 standard option from Tensilica.  When enabled, @code{CONST16}
26874 instructions are always used in place of the standard @code{L32R}
26875 instructions.  The use of @code{CONST16} is enabled by default only if
26876 the @code{L32R} instruction is not available.
26878 @item -mfused-madd
26879 @itemx -mno-fused-madd
26880 @opindex mfused-madd
26881 @opindex mno-fused-madd
26882 Enable or disable use of fused multiply/add and multiply/subtract
26883 instructions in the floating-point option.  This has no effect if the
26884 floating-point option is not also enabled.  Disabling fused multiply/add
26885 and multiply/subtract instructions forces the compiler to use separate
26886 instructions for the multiply and add/subtract operations.  This may be
26887 desirable in some cases where strict IEEE 754-compliant results are
26888 required: the fused multiply add/subtract instructions do not round the
26889 intermediate result, thereby producing results with @emph{more} bits of
26890 precision than specified by the IEEE standard.  Disabling fused multiply
26891 add/subtract instructions also ensures that the program output is not
26892 sensitive to the compiler's ability to combine multiply and add/subtract
26893 operations.
26895 @item -mserialize-volatile
26896 @itemx -mno-serialize-volatile
26897 @opindex mserialize-volatile
26898 @opindex mno-serialize-volatile
26899 When this option is enabled, GCC inserts @code{MEMW} instructions before
26900 @code{volatile} memory references to guarantee sequential consistency.
26901 The default is @option{-mserialize-volatile}.  Use
26902 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
26904 @item -mforce-no-pic
26905 @opindex mforce-no-pic
26906 For targets, like GNU/Linux, where all user-mode Xtensa code must be
26907 position-independent code (PIC), this option disables PIC for compiling
26908 kernel code.
26910 @item -mtext-section-literals
26911 @itemx -mno-text-section-literals
26912 @opindex mtext-section-literals
26913 @opindex mno-text-section-literals
26914 These options control the treatment of literal pools.  The default is
26915 @option{-mno-text-section-literals}, which places literals in a separate
26916 section in the output file.  This allows the literal pool to be placed
26917 in a data RAM/ROM, and it also allows the linker to combine literal
26918 pools from separate object files to remove redundant literals and
26919 improve code size.  With @option{-mtext-section-literals}, the literals
26920 are interspersed in the text section in order to keep them as close as
26921 possible to their references.  This may be necessary for large assembly
26922 files.  Literals for each function are placed right before that function.
26924 @item -mauto-litpools
26925 @itemx -mno-auto-litpools
26926 @opindex mauto-litpools
26927 @opindex mno-auto-litpools
26928 These options control the treatment of literal pools.  The default is
26929 @option{-mno-auto-litpools}, which places literals in a separate
26930 section in the output file unless @option{-mtext-section-literals} is
26931 used.  With @option{-mauto-litpools} the literals are interspersed in
26932 the text section by the assembler.  Compiler does not produce explicit
26933 @code{.literal} directives and loads literals into registers with
26934 @code{MOVI} instructions instead of @code{L32R} to let the assembler
26935 do relaxation and place literals as necessary.  This option allows
26936 assembler to create several literal pools per function and assemble
26937 very big functions, which may not be possible with
26938 @option{-mtext-section-literals}.
26940 @item -mtarget-align
26941 @itemx -mno-target-align
26942 @opindex mtarget-align
26943 @opindex mno-target-align
26944 When this option is enabled, GCC instructs the assembler to
26945 automatically align instructions to reduce branch penalties at the
26946 expense of some code density.  The assembler attempts to widen density
26947 instructions to align branch targets and the instructions following call
26948 instructions.  If there are not enough preceding safe density
26949 instructions to align a target, no widening is performed.  The
26950 default is @option{-mtarget-align}.  These options do not affect the
26951 treatment of auto-aligned instructions like @code{LOOP}, which the
26952 assembler always aligns, either by widening density instructions or
26953 by inserting NOP instructions.
26955 @item -mlongcalls
26956 @itemx -mno-longcalls
26957 @opindex mlongcalls
26958 @opindex mno-longcalls
26959 When this option is enabled, GCC instructs the assembler to translate
26960 direct calls to indirect calls unless it can determine that the target
26961 of a direct call is in the range allowed by the call instruction.  This
26962 translation typically occurs for calls to functions in other source
26963 files.  Specifically, the assembler translates a direct @code{CALL}
26964 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
26965 The default is @option{-mno-longcalls}.  This option should be used in
26966 programs where the call target can potentially be out of range.  This
26967 option is implemented in the assembler, not the compiler, so the
26968 assembly code generated by GCC still shows direct call
26969 instructions---look at the disassembled object code to see the actual
26970 instructions.  Note that the assembler uses an indirect call for
26971 every cross-file call, not just those that really are out of range.
26972 @end table
26974 @node zSeries Options
26975 @subsection zSeries Options
26976 @cindex zSeries options
26978 These are listed under @xref{S/390 and zSeries Options}.
26981 @c man end
26983 @node Spec Files
26984 @section Specifying Subprocesses and the Switches to Pass to Them
26985 @cindex Spec Files
26987 @command{gcc} is a driver program.  It performs its job by invoking a
26988 sequence of other programs to do the work of compiling, assembling and
26989 linking.  GCC interprets its command-line parameters and uses these to
26990 deduce which programs it should invoke, and which command-line options
26991 it ought to place on their command lines.  This behavior is controlled
26992 by @dfn{spec strings}.  In most cases there is one spec string for each
26993 program that GCC can invoke, but a few programs have multiple spec
26994 strings to control their behavior.  The spec strings built into GCC can
26995 be overridden by using the @option{-specs=} command-line switch to specify
26996 a spec file.
26998 @dfn{Spec files} are plain-text files that are used to construct spec
26999 strings.  They consist of a sequence of directives separated by blank
27000 lines.  The type of directive is determined by the first non-whitespace
27001 character on the line, which can be one of the following:
27003 @table @code
27004 @item %@var{command}
27005 Issues a @var{command} to the spec file processor.  The commands that can
27006 appear here are:
27008 @table @code
27009 @item %include <@var{file}>
27010 @cindex @code{%include}
27011 Search for @var{file} and insert its text at the current point in the
27012 specs file.
27014 @item %include_noerr <@var{file}>
27015 @cindex @code{%include_noerr}
27016 Just like @samp{%include}, but do not generate an error message if the include
27017 file cannot be found.
27019 @item %rename @var{old_name} @var{new_name}
27020 @cindex @code{%rename}
27021 Rename the spec string @var{old_name} to @var{new_name}.
27023 @end table
27025 @item *[@var{spec_name}]:
27026 This tells the compiler to create, override or delete the named spec
27027 string.  All lines after this directive up to the next directive or
27028 blank line are considered to be the text for the spec string.  If this
27029 results in an empty string then the spec is deleted.  (Or, if the
27030 spec did not exist, then nothing happens.)  Otherwise, if the spec
27031 does not currently exist a new spec is created.  If the spec does
27032 exist then its contents are overridden by the text of this
27033 directive, unless the first character of that text is the @samp{+}
27034 character, in which case the text is appended to the spec.
27036 @item [@var{suffix}]:
27037 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
27038 and up to the next directive or blank line are considered to make up the
27039 spec string for the indicated suffix.  When the compiler encounters an
27040 input file with the named suffix, it processes the spec string in
27041 order to work out how to compile that file.  For example:
27043 @smallexample
27044 .ZZ:
27045 z-compile -input %i
27046 @end smallexample
27048 This says that any input file whose name ends in @samp{.ZZ} should be
27049 passed to the program @samp{z-compile}, which should be invoked with the
27050 command-line switch @option{-input} and with the result of performing the
27051 @samp{%i} substitution.  (See below.)
27053 As an alternative to providing a spec string, the text following a
27054 suffix directive can be one of the following:
27056 @table @code
27057 @item @@@var{language}
27058 This says that the suffix is an alias for a known @var{language}.  This is
27059 similar to using the @option{-x} command-line switch to GCC to specify a
27060 language explicitly.  For example:
27062 @smallexample
27063 .ZZ:
27064 @@c++
27065 @end smallexample
27067 Says that .ZZ files are, in fact, C++ source files.
27069 @item #@var{name}
27070 This causes an error messages saying:
27072 @smallexample
27073 @var{name} compiler not installed on this system.
27074 @end smallexample
27075 @end table
27077 GCC already has an extensive list of suffixes built into it.
27078 This directive adds an entry to the end of the list of suffixes, but
27079 since the list is searched from the end backwards, it is effectively
27080 possible to override earlier entries using this technique.
27082 @end table
27084 GCC has the following spec strings built into it.  Spec files can
27085 override these strings or create their own.  Note that individual
27086 targets can also add their own spec strings to this list.
27088 @smallexample
27089 asm          Options to pass to the assembler
27090 asm_final    Options to pass to the assembler post-processor
27091 cpp          Options to pass to the C preprocessor
27092 cc1          Options to pass to the C compiler
27093 cc1plus      Options to pass to the C++ compiler
27094 endfile      Object files to include at the end of the link
27095 link         Options to pass to the linker
27096 lib          Libraries to include on the command line to the linker
27097 libgcc       Decides which GCC support library to pass to the linker
27098 linker       Sets the name of the linker
27099 predefines   Defines to be passed to the C preprocessor
27100 signed_char  Defines to pass to CPP to say whether @code{char} is signed
27101              by default
27102 startfile    Object files to include at the start of the link
27103 @end smallexample
27105 Here is a small example of a spec file:
27107 @smallexample
27108 %rename lib                 old_lib
27110 *lib:
27111 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
27112 @end smallexample
27114 This example renames the spec called @samp{lib} to @samp{old_lib} and
27115 then overrides the previous definition of @samp{lib} with a new one.
27116 The new definition adds in some extra command-line options before
27117 including the text of the old definition.
27119 @dfn{Spec strings} are a list of command-line options to be passed to their
27120 corresponding program.  In addition, the spec strings can contain
27121 @samp{%}-prefixed sequences to substitute variable text or to
27122 conditionally insert text into the command line.  Using these constructs
27123 it is possible to generate quite complex command lines.
27125 Here is a table of all defined @samp{%}-sequences for spec
27126 strings.  Note that spaces are not generated automatically around the
27127 results of expanding these sequences.  Therefore you can concatenate them
27128 together or combine them with constant text in a single argument.
27130 @table @code
27131 @item %%
27132 Substitute one @samp{%} into the program name or argument.
27134 @item %i
27135 Substitute the name of the input file being processed.
27137 @item %b
27138 Substitute the basename of the input file being processed.
27139 This is the substring up to (and not including) the last period
27140 and not including the directory.
27142 @item %B
27143 This is the same as @samp{%b}, but include the file suffix (text after
27144 the last period).
27146 @item %d
27147 Marks the argument containing or following the @samp{%d} as a
27148 temporary file name, so that that file is deleted if GCC exits
27149 successfully.  Unlike @samp{%g}, this contributes no text to the
27150 argument.
27152 @item %g@var{suffix}
27153 Substitute a file name that has suffix @var{suffix} and is chosen
27154 once per compilation, and mark the argument in the same way as
27155 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
27156 name is now chosen in a way that is hard to predict even when previously
27157 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
27158 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
27159 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
27160 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
27161 was simply substituted with a file name chosen once per compilation,
27162 without regard to any appended suffix (which was therefore treated
27163 just like ordinary text), making such attacks more likely to succeed.
27165 @item %u@var{suffix}
27166 Like @samp{%g}, but generates a new temporary file name
27167 each time it appears instead of once per compilation.
27169 @item %U@var{suffix}
27170 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
27171 new one if there is no such last file name.  In the absence of any
27172 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
27173 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
27174 involves the generation of two distinct file names, one
27175 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
27176 simply substituted with a file name chosen for the previous @samp{%u},
27177 without regard to any appended suffix.
27179 @item %j@var{suffix}
27180 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
27181 writable, and if @option{-save-temps} is not used; 
27182 otherwise, substitute the name
27183 of a temporary file, just like @samp{%u}.  This temporary file is not
27184 meant for communication between processes, but rather as a junk
27185 disposal mechanism.
27187 @item %|@var{suffix}
27188 @itemx %m@var{suffix}
27189 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
27190 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
27191 all.  These are the two most common ways to instruct a program that it
27192 should read from standard input or write to standard output.  If you
27193 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
27194 construct: see for example @file{f/lang-specs.h}.
27196 @item %.@var{SUFFIX}
27197 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
27198 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
27199 terminated by the next space or %.
27201 @item %w
27202 Marks the argument containing or following the @samp{%w} as the
27203 designated output file of this compilation.  This puts the argument
27204 into the sequence of arguments that @samp{%o} substitutes.
27206 @item %o
27207 Substitutes the names of all the output files, with spaces
27208 automatically placed around them.  You should write spaces
27209 around the @samp{%o} as well or the results are undefined.
27210 @samp{%o} is for use in the specs for running the linker.
27211 Input files whose names have no recognized suffix are not compiled
27212 at all, but they are included among the output files, so they are
27213 linked.
27215 @item %O
27216 Substitutes the suffix for object files.  Note that this is
27217 handled specially when it immediately follows @samp{%g, %u, or %U},
27218 because of the need for those to form complete file names.  The
27219 handling is such that @samp{%O} is treated exactly as if it had already
27220 been substituted, except that @samp{%g, %u, and %U} do not currently
27221 support additional @var{suffix} characters following @samp{%O} as they do
27222 following, for example, @samp{.o}.
27224 @item %p
27225 Substitutes the standard macro predefinitions for the
27226 current target machine.  Use this when running @command{cpp}.
27228 @item %P
27229 Like @samp{%p}, but puts @samp{__} before and after the name of each
27230 predefined macro, except for macros that start with @samp{__} or with
27231 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
27234 @item %I
27235 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
27236 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
27237 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
27238 and @option{-imultilib} as necessary.
27240 @item %s
27241 Current argument is the name of a library or startup file of some sort.
27242 Search for that file in a standard list of directories and substitute
27243 the full name found.  The current working directory is included in the
27244 list of directories scanned.
27246 @item %T
27247 Current argument is the name of a linker script.  Search for that file
27248 in the current list of directories to scan for libraries. If the file
27249 is located insert a @option{--script} option into the command line
27250 followed by the full path name found.  If the file is not found then
27251 generate an error message.  Note: the current working directory is not
27252 searched.
27254 @item %e@var{str}
27255 Print @var{str} as an error message.  @var{str} is terminated by a newline.
27256 Use this when inconsistent options are detected.
27258 @item %(@var{name})
27259 Substitute the contents of spec string @var{name} at this point.
27261 @item %x@{@var{option}@}
27262 Accumulate an option for @samp{%X}.
27264 @item %X
27265 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
27266 spec string.
27268 @item %Y
27269 Output the accumulated assembler options specified by @option{-Wa}.
27271 @item %Z
27272 Output the accumulated preprocessor options specified by @option{-Wp}.
27274 @item %a
27275 Process the @code{asm} spec.  This is used to compute the
27276 switches to be passed to the assembler.
27278 @item %A
27279 Process the @code{asm_final} spec.  This is a spec string for
27280 passing switches to an assembler post-processor, if such a program is
27281 needed.
27283 @item %l
27284 Process the @code{link} spec.  This is the spec for computing the
27285 command line passed to the linker.  Typically it makes use of the
27286 @samp{%L %G %S %D and %E} sequences.
27288 @item %D
27289 Dump out a @option{-L} option for each directory that GCC believes might
27290 contain startup files.  If the target supports multilibs then the
27291 current multilib directory is prepended to each of these paths.
27293 @item %L
27294 Process the @code{lib} spec.  This is a spec string for deciding which
27295 libraries are included on the command line to the linker.
27297 @item %G
27298 Process the @code{libgcc} spec.  This is a spec string for deciding
27299 which GCC support library is included on the command line to the linker.
27301 @item %S
27302 Process the @code{startfile} spec.  This is a spec for deciding which
27303 object files are the first ones passed to the linker.  Typically
27304 this might be a file named @file{crt0.o}.
27306 @item %E
27307 Process the @code{endfile} spec.  This is a spec string that specifies
27308 the last object files that are passed to the linker.
27310 @item %C
27311 Process the @code{cpp} spec.  This is used to construct the arguments
27312 to be passed to the C preprocessor.
27314 @item %1
27315 Process the @code{cc1} spec.  This is used to construct the options to be
27316 passed to the actual C compiler (@command{cc1}).
27318 @item %2
27319 Process the @code{cc1plus} spec.  This is used to construct the options to be
27320 passed to the actual C++ compiler (@command{cc1plus}).
27322 @item %*
27323 Substitute the variable part of a matched option.  See below.
27324 Note that each comma in the substituted string is replaced by
27325 a single space.
27327 @item %<S
27328 Remove all occurrences of @code{-S} from the command line.  Note---this
27329 command is position dependent.  @samp{%} commands in the spec string
27330 before this one see @code{-S}, @samp{%} commands in the spec string
27331 after this one do not.
27333 @item %:@var{function}(@var{args})
27334 Call the named function @var{function}, passing it @var{args}.
27335 @var{args} is first processed as a nested spec string, then split
27336 into an argument vector in the usual fashion.  The function returns
27337 a string which is processed as if it had appeared literally as part
27338 of the current spec.
27340 The following built-in spec functions are provided:
27342 @table @code
27343 @item @code{getenv}
27344 The @code{getenv} spec function takes two arguments: an environment
27345 variable name and a string.  If the environment variable is not
27346 defined, a fatal error is issued.  Otherwise, the return value is the
27347 value of the environment variable concatenated with the string.  For
27348 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
27350 @smallexample
27351 %:getenv(TOPDIR /include)
27352 @end smallexample
27354 expands to @file{/path/to/top/include}.
27356 @item @code{if-exists}
27357 The @code{if-exists} spec function takes one argument, an absolute
27358 pathname to a file.  If the file exists, @code{if-exists} returns the
27359 pathname.  Here is a small example of its usage:
27361 @smallexample
27362 *startfile:
27363 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
27364 @end smallexample
27366 @item @code{if-exists-else}
27367 The @code{if-exists-else} spec function is similar to the @code{if-exists}
27368 spec function, except that it takes two arguments.  The first argument is
27369 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
27370 returns the pathname.  If it does not exist, it returns the second argument.
27371 This way, @code{if-exists-else} can be used to select one file or another,
27372 based on the existence of the first.  Here is a small example of its usage:
27374 @smallexample
27375 *startfile:
27376 crt0%O%s %:if-exists(crti%O%s) \
27377 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
27378 @end smallexample
27380 @item @code{replace-outfile}
27381 The @code{replace-outfile} spec function takes two arguments.  It looks for the
27382 first argument in the outfiles array and replaces it with the second argument.  Here
27383 is a small example of its usage:
27385 @smallexample
27386 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
27387 @end smallexample
27389 @item @code{remove-outfile}
27390 The @code{remove-outfile} spec function takes one argument.  It looks for the
27391 first argument in the outfiles array and removes it.  Here is a small example
27392 its usage:
27394 @smallexample
27395 %:remove-outfile(-lm)
27396 @end smallexample
27398 @item @code{pass-through-libs}
27399 The @code{pass-through-libs} spec function takes any number of arguments.  It
27400 finds any @option{-l} options and any non-options ending in @file{.a} (which it
27401 assumes are the names of linker input library archive files) and returns a
27402 result containing all the found arguments each prepended by
27403 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
27404 intended to be passed to the LTO linker plugin.
27406 @smallexample
27407 %:pass-through-libs(%G %L %G)
27408 @end smallexample
27410 @item @code{print-asm-header}
27411 The @code{print-asm-header} function takes no arguments and simply
27412 prints a banner like:
27414 @smallexample
27415 Assembler options
27416 =================
27418 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
27419 @end smallexample
27421 It is used to separate compiler options from assembler options
27422 in the @option{--target-help} output.
27423 @end table
27425 @item %@{S@}
27426 Substitutes the @code{-S} switch, if that switch is given to GCC@.
27427 If that switch is not specified, this substitutes nothing.  Note that
27428 the leading dash is omitted when specifying this option, and it is
27429 automatically inserted if the substitution is performed.  Thus the spec
27430 string @samp{%@{foo@}} matches the command-line option @option{-foo}
27431 and outputs the command-line option @option{-foo}.
27433 @item %W@{S@}
27434 Like %@{@code{S}@} but mark last argument supplied within as a file to be
27435 deleted on failure.
27437 @item %@{S*@}
27438 Substitutes all the switches specified to GCC whose names start
27439 with @code{-S}, but which also take an argument.  This is used for
27440 switches like @option{-o}, @option{-D}, @option{-I}, etc.
27441 GCC considers @option{-o foo} as being
27442 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
27443 text, including the space.  Thus two arguments are generated.
27445 @item %@{S*&T*@}
27446 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
27447 (the order of @code{S} and @code{T} in the spec is not significant).
27448 There can be any number of ampersand-separated variables; for each the
27449 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
27451 @item %@{S:X@}
27452 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
27454 @item %@{!S:X@}
27455 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
27457 @item %@{S*:X@}
27458 Substitutes @code{X} if one or more switches whose names start with
27459 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
27460 once, no matter how many such switches appeared.  However, if @code{%*}
27461 appears somewhere in @code{X}, then @code{X} is substituted once
27462 for each matching switch, with the @code{%*} replaced by the part of
27463 that switch matching the @code{*}.
27465 If @code{%*} appears as the last part of a spec sequence then a space
27466 is added after the end of the last substitution.  If there is more
27467 text in the sequence, however, then a space is not generated.  This
27468 allows the @code{%*} substitution to be used as part of a larger
27469 string.  For example, a spec string like this:
27471 @smallexample
27472 %@{mcu=*:--script=%*/memory.ld@}
27473 @end smallexample
27475 @noindent
27476 when matching an option like @option{-mcu=newchip} produces:
27478 @smallexample
27479 --script=newchip/memory.ld
27480 @end smallexample
27482 @item %@{.S:X@}
27483 Substitutes @code{X}, if processing a file with suffix @code{S}.
27485 @item %@{!.S:X@}
27486 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
27488 @item %@{,S:X@}
27489 Substitutes @code{X}, if processing a file for language @code{S}.
27491 @item %@{!,S:X@}
27492 Substitutes @code{X}, if not processing a file for language @code{S}.
27494 @item %@{S|P:X@}
27495 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
27496 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
27497 @code{*} sequences as well, although they have a stronger binding than
27498 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
27499 alternatives must be starred, and only the first matching alternative
27500 is substituted.
27502 For example, a spec string like this:
27504 @smallexample
27505 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
27506 @end smallexample
27508 @noindent
27509 outputs the following command-line options from the following input
27510 command-line options:
27512 @smallexample
27513 fred.c        -foo -baz
27514 jim.d         -bar -boggle
27515 -d fred.c     -foo -baz -boggle
27516 -d jim.d      -bar -baz -boggle
27517 @end smallexample
27519 @item %@{S:X; T:Y; :D@}
27521 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
27522 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
27523 be as many clauses as you need.  This may be combined with @code{.},
27524 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
27527 @end table
27529 The switch matching text @code{S} in a @samp{%@{S@}}, @samp{%@{S:X@}}
27530 or similar construct can use a backslash to ignore the special meaning
27531 of the character following it, thus allowing literal matching of a
27532 character that is otherwise specially treated.  For example,
27533 @samp{%@{std=iso9899\:1999:X@}} substitutes @code{X} if the
27534 @option{-std=iso9899:1999} option is given.
27536 The conditional text @code{X} in a @samp{%@{S:X@}} or similar
27537 construct may contain other nested @samp{%} constructs or spaces, or
27538 even newlines.  They are processed as usual, as described above.
27539 Trailing white space in @code{X} is ignored.  White space may also
27540 appear anywhere on the left side of the colon in these constructs,
27541 except between @code{.} or @code{*} and the corresponding word.
27543 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
27544 handled specifically in these constructs.  If another value of
27545 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
27546 @option{-W} switch is found later in the command line, the earlier
27547 switch value is ignored, except with @{@code{S}*@} where @code{S} is
27548 just one letter, which passes all matching options.
27550 The character @samp{|} at the beginning of the predicate text is used to
27551 indicate that a command should be piped to the following command, but
27552 only if @option{-pipe} is specified.
27554 It is built into GCC which switches take arguments and which do not.
27555 (You might think it would be useful to generalize this to allow each
27556 compiler's spec to say which switches take arguments.  But this cannot
27557 be done in a consistent fashion.  GCC cannot even decide which input
27558 files have been specified without knowing which switches take arguments,
27559 and it must know which input files to compile in order to tell which
27560 compilers to run).
27562 GCC also knows implicitly that arguments starting in @option{-l} are to be
27563 treated as compiler output files, and passed to the linker in their
27564 proper position among the other output files.
27566 @node Environment Variables
27567 @section Environment Variables Affecting GCC
27568 @cindex environment variables
27570 @c man begin ENVIRONMENT
27571 This section describes several environment variables that affect how GCC
27572 operates.  Some of them work by specifying directories or prefixes to use
27573 when searching for various kinds of files.  Some are used to specify other
27574 aspects of the compilation environment.
27576 Note that you can also specify places to search using options such as
27577 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
27578 take precedence over places specified using environment variables, which
27579 in turn take precedence over those specified by the configuration of GCC@.
27580 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
27581 GNU Compiler Collection (GCC) Internals}.
27583 @table @env
27584 @item LANG
27585 @itemx LC_CTYPE
27586 @c @itemx LC_COLLATE
27587 @itemx LC_MESSAGES
27588 @c @itemx LC_MONETARY
27589 @c @itemx LC_NUMERIC
27590 @c @itemx LC_TIME
27591 @itemx LC_ALL
27592 @findex LANG
27593 @findex LC_CTYPE
27594 @c @findex LC_COLLATE
27595 @findex LC_MESSAGES
27596 @c @findex LC_MONETARY
27597 @c @findex LC_NUMERIC
27598 @c @findex LC_TIME
27599 @findex LC_ALL
27600 @cindex locale
27601 These environment variables control the way that GCC uses
27602 localization information which allows GCC to work with different
27603 national conventions.  GCC inspects the locale categories
27604 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
27605 so.  These locale categories can be set to any value supported by your
27606 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
27607 Kingdom encoded in UTF-8.
27609 The @env{LC_CTYPE} environment variable specifies character
27610 classification.  GCC uses it to determine the character boundaries in
27611 a string; this is needed for some multibyte encodings that contain quote
27612 and escape characters that are otherwise interpreted as a string
27613 end or escape.
27615 The @env{LC_MESSAGES} environment variable specifies the language to
27616 use in diagnostic messages.
27618 If the @env{LC_ALL} environment variable is set, it overrides the value
27619 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
27620 and @env{LC_MESSAGES} default to the value of the @env{LANG}
27621 environment variable.  If none of these variables are set, GCC
27622 defaults to traditional C English behavior.
27624 @item TMPDIR
27625 @findex TMPDIR
27626 If @env{TMPDIR} is set, it specifies the directory to use for temporary
27627 files.  GCC uses temporary files to hold the output of one stage of
27628 compilation which is to be used as input to the next stage: for example,
27629 the output of the preprocessor, which is the input to the compiler
27630 proper.
27632 @item GCC_COMPARE_DEBUG
27633 @findex GCC_COMPARE_DEBUG
27634 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
27635 @option{-fcompare-debug} to the compiler driver.  See the documentation
27636 of this option for more details.
27638 @item GCC_EXEC_PREFIX
27639 @findex GCC_EXEC_PREFIX
27640 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
27641 names of the subprograms executed by the compiler.  No slash is added
27642 when this prefix is combined with the name of a subprogram, but you can
27643 specify a prefix that ends with a slash if you wish.
27645 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
27646 an appropriate prefix to use based on the pathname it is invoked with.
27648 If GCC cannot find the subprogram using the specified prefix, it
27649 tries looking in the usual places for the subprogram.
27651 The default value of @env{GCC_EXEC_PREFIX} is
27652 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
27653 the installed compiler. In many cases @var{prefix} is the value
27654 of @code{prefix} when you ran the @file{configure} script.
27656 Other prefixes specified with @option{-B} take precedence over this prefix.
27658 This prefix is also used for finding files such as @file{crt0.o} that are
27659 used for linking.
27661 In addition, the prefix is used in an unusual way in finding the
27662 directories to search for header files.  For each of the standard
27663 directories whose name normally begins with @samp{/usr/local/lib/gcc}
27664 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
27665 replacing that beginning with the specified prefix to produce an
27666 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
27667 @file{foo/bar} just before it searches the standard directory 
27668 @file{/usr/local/lib/bar}.
27669 If a standard directory begins with the configured
27670 @var{prefix} then the value of @var{prefix} is replaced by
27671 @env{GCC_EXEC_PREFIX} when looking for header files.
27673 @item COMPILER_PATH
27674 @findex COMPILER_PATH
27675 The value of @env{COMPILER_PATH} is a colon-separated list of
27676 directories, much like @env{PATH}.  GCC tries the directories thus
27677 specified when searching for subprograms, if it cannot find the
27678 subprograms using @env{GCC_EXEC_PREFIX}.
27680 @item LIBRARY_PATH
27681 @findex LIBRARY_PATH
27682 The value of @env{LIBRARY_PATH} is a colon-separated list of
27683 directories, much like @env{PATH}.  When configured as a native compiler,
27684 GCC tries the directories thus specified when searching for special
27685 linker files, if it cannot find them using @env{GCC_EXEC_PREFIX}.  Linking
27686 using GCC also uses these directories when searching for ordinary
27687 libraries for the @option{-l} option (but directories specified with
27688 @option{-L} come first).
27690 @item LANG
27691 @findex LANG
27692 @cindex locale definition
27693 This variable is used to pass locale information to the compiler.  One way in
27694 which this information is used is to determine the character set to be used
27695 when character literals, string literals and comments are parsed in C and C++.
27696 When the compiler is configured to allow multibyte characters,
27697 the following values for @env{LANG} are recognized:
27699 @table @samp
27700 @item C-JIS
27701 Recognize JIS characters.
27702 @item C-SJIS
27703 Recognize SJIS characters.
27704 @item C-EUCJP
27705 Recognize EUCJP characters.
27706 @end table
27708 If @env{LANG} is not defined, or if it has some other value, then the
27709 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
27710 recognize and translate multibyte characters.
27711 @end table
27713 @noindent
27714 Some additional environment variables affect the behavior of the
27715 preprocessor.
27717 @include cppenv.texi
27719 @c man end
27721 @node Precompiled Headers
27722 @section Using Precompiled Headers
27723 @cindex precompiled headers
27724 @cindex speed of compilation
27726 Often large projects have many header files that are included in every
27727 source file.  The time the compiler takes to process these header files
27728 over and over again can account for nearly all of the time required to
27729 build the project.  To make builds faster, GCC allows you to
27730 @dfn{precompile} a header file.
27732 To create a precompiled header file, simply compile it as you would any
27733 other file, if necessary using the @option{-x} option to make the driver
27734 treat it as a C or C++ header file.  You may want to use a
27735 tool like @command{make} to keep the precompiled header up-to-date when
27736 the headers it contains change.
27738 A precompiled header file is searched for when @code{#include} is
27739 seen in the compilation.  As it searches for the included file
27740 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
27741 compiler looks for a precompiled header in each directory just before it
27742 looks for the include file in that directory.  The name searched for is
27743 the name specified in the @code{#include} with @samp{.gch} appended.  If
27744 the precompiled header file cannot be used, it is ignored.
27746 For instance, if you have @code{#include "all.h"}, and you have
27747 @file{all.h.gch} in the same directory as @file{all.h}, then the
27748 precompiled header file is used if possible, and the original
27749 header is used otherwise.
27751 Alternatively, you might decide to put the precompiled header file in a
27752 directory and use @option{-I} to ensure that directory is searched
27753 before (or instead of) the directory containing the original header.
27754 Then, if you want to check that the precompiled header file is always
27755 used, you can put a file of the same name as the original header in this
27756 directory containing an @code{#error} command.
27758 This also works with @option{-include}.  So yet another way to use
27759 precompiled headers, good for projects not designed with precompiled
27760 header files in mind, is to simply take most of the header files used by
27761 a project, include them from another header file, precompile that header
27762 file, and @option{-include} the precompiled header.  If the header files
27763 have guards against multiple inclusion, they are skipped because
27764 they've already been included (in the precompiled header).
27766 If you need to precompile the same header file for different
27767 languages, targets, or compiler options, you can instead make a
27768 @emph{directory} named like @file{all.h.gch}, and put each precompiled
27769 header in the directory, perhaps using @option{-o}.  It doesn't matter
27770 what you call the files in the directory; every precompiled header in
27771 the directory is considered.  The first precompiled header
27772 encountered in the directory that is valid for this compilation is
27773 used; they're searched in no particular order.
27775 There are many other possibilities, limited only by your imagination,
27776 good sense, and the constraints of your build system.
27778 A precompiled header file can be used only when these conditions apply:
27780 @itemize
27781 @item
27782 Only one precompiled header can be used in a particular compilation.
27784 @item
27785 A precompiled header cannot be used once the first C token is seen.  You
27786 can have preprocessor directives before a precompiled header; you cannot
27787 include a precompiled header from inside another header.
27789 @item
27790 The precompiled header file must be produced for the same language as
27791 the current compilation.  You cannot use a C precompiled header for a C++
27792 compilation.
27794 @item
27795 The precompiled header file must have been produced by the same compiler
27796 binary as the current compilation is using.
27798 @item
27799 Any macros defined before the precompiled header is included must
27800 either be defined in the same way as when the precompiled header was
27801 generated, or must not affect the precompiled header, which usually
27802 means that they don't appear in the precompiled header at all.
27804 The @option{-D} option is one way to define a macro before a
27805 precompiled header is included; using a @code{#define} can also do it.
27806 There are also some options that define macros implicitly, like
27807 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
27808 defined this way.
27810 @item If debugging information is output when using the precompiled
27811 header, using @option{-g} or similar, the same kind of debugging information
27812 must have been output when building the precompiled header.  However,
27813 a precompiled header built using @option{-g} can be used in a compilation
27814 when no debugging information is being output.
27816 @item The same @option{-m} options must generally be used when building
27817 and using the precompiled header.  @xref{Submodel Options},
27818 for any cases where this rule is relaxed.
27820 @item Each of the following options must be the same when building and using
27821 the precompiled header:
27823 @gccoptlist{-fexceptions}
27825 @item
27826 Some other command-line options starting with @option{-f},
27827 @option{-p}, or @option{-O} must be defined in the same way as when
27828 the precompiled header was generated.  At present, it's not clear
27829 which options are safe to change and which are not; the safest choice
27830 is to use exactly the same options when generating and using the
27831 precompiled header.  The following are known to be safe:
27833 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
27834 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
27835 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
27836 -pedantic-errors}
27838 @end itemize
27840 For all of these except the last, the compiler automatically
27841 ignores the precompiled header if the conditions aren't met.  If you
27842 find an option combination that doesn't work and doesn't cause the
27843 precompiled header to be ignored, please consider filing a bug report,
27844 see @ref{Bugs}.
27846 If you do use differing options when generating and using the
27847 precompiled header, the actual behavior is a mixture of the
27848 behavior for the options.  For instance, if you use @option{-g} to
27849 generate the precompiled header but not when using it, you may or may
27850 not get debugging information for routines in the precompiled header.