PR libstdc++/83279 handle sendfile not copying entire file
[official-gcc.git] / gcc / doc / invoke.texi
blob001bbeae5770bbee314193c6d33c4b21c3fc2602
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-function-type  -Wcast-qual  @gol
271 -Wchar-subscripts  -Wchkp  -Wcatch-value  -Wcatch-value=@var{n} @gol
272 -Wclobbered  -Wcomment  -Wconditionally-supported @gol
273 -Wconversion  -Wcoverage-mismatch  -Wno-cpp  -Wdangling-else  -Wdate-time @gol
274 -Wdelete-incomplete @gol
275 -Wno-deprecated  -Wno-deprecated-declarations  -Wno-designated-init @gol
276 -Wdisabled-optimization @gol
277 -Wno-discarded-qualifiers  -Wno-discarded-array-qualifiers @gol
278 -Wno-div-by-zero  -Wdouble-promotion @gol
279 -Wduplicated-branches  -Wduplicated-cond @gol
280 -Wempty-body  -Wenum-compare  -Wno-endif-labels  -Wexpansion-to-defined @gol
281 -Werror  -Werror=*  -Wextra-semi  -Wfatal-errors @gol
282 -Wfloat-equal  -Wformat  -Wformat=2 @gol
283 -Wno-format-contains-nul  -Wno-format-extra-args  @gol
284 -Wformat-nonliteral -Wformat-overflow=@var{n} @gol
285 -Wformat-security  -Wformat-signedness  -Wformat-truncation=@var{n} @gol
286 -Wformat-y2k  -Wframe-address @gol
287 -Wframe-larger-than=@var{len}  -Wno-free-nonheap-object  -Wjump-misses-init @gol
288 -Wif-not-aligned @gol
289 -Wignored-qualifiers  -Wignored-attributes  -Wincompatible-pointer-types @gol
290 -Wimplicit  -Wimplicit-fallthrough  -Wimplicit-fallthrough=@var{n} @gol
291 -Wimplicit-function-declaration  -Wimplicit-int @gol
292 -Winit-self  -Winline  -Wno-int-conversion  -Wint-in-bool-context @gol
293 -Wno-int-to-pointer-cast  -Winvalid-memory-model  -Wno-invalid-offsetof @gol
294 -Winvalid-pch  -Wlarger-than=@var{len} @gol
295 -Wlogical-op  -Wlogical-not-parentheses  -Wlong-long @gol
296 -Wmain  -Wmaybe-uninitialized  -Wmemset-elt-size  -Wmemset-transposed-args @gol
297 -Wmisleading-indentation  -Wmissing-braces @gol
298 -Wmissing-field-initializers  -Wmissing-include-dirs @gol
299 -Wno-multichar  -Wmultistatement-macros  -Wnonnull  -Wnonnull-compare @gol
300 -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]} @gol
301 -Wnull-dereference  -Wodr  -Wno-overflow  -Wopenmp-simd  @gol
302 -Woverride-init-side-effects  -Woverlength-strings @gol
303 -Wpacked  -Wpacked-bitfield-compat -Wpacked-not-aligned -Wpadded @gol
304 -Wparentheses  -Wno-pedantic-ms-format @gol
305 -Wplacement-new  -Wplacement-new=@var{n} @gol
306 -Wpointer-arith  -Wpointer-compare  -Wno-pointer-to-int-cast @gol
307 -Wno-pragmas  -Wredundant-decls  -Wrestrict  -Wno-return-local-addr @gol
308 -Wreturn-type  -Wsequence-point  -Wshadow  -Wno-shadow-ivar @gol
309 -Wshadow=global,  -Wshadow=local,  -Wshadow=compatible-local @gol
310 -Wshift-overflow  -Wshift-overflow=@var{n} @gol
311 -Wshift-count-negative  -Wshift-count-overflow  -Wshift-negative-value @gol
312 -Wsign-compare  -Wsign-conversion  -Wfloat-conversion @gol
313 -Wno-scalar-storage-order  -Wsizeof-pointer-div @gol
314 -Wsizeof-pointer-memaccess  -Wsizeof-array-argument @gol
315 -Wstack-protector  -Wstack-usage=@var{len}  -Wstrict-aliasing @gol
316 -Wstrict-aliasing=n  -Wstrict-overflow  -Wstrict-overflow=@var{n} @gol
317 -Wstringop-overflow=@var{n} -Wstringop-truncation @gol
318 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{|}malloc@r{]} @gol
319 -Wsuggest-final-types @gol  -Wsuggest-final-methods  -Wsuggest-override @gol
320 -Wmissing-format-attribute  -Wsubobject-linkage @gol
321 -Wswitch  -Wswitch-bool  -Wswitch-default  -Wswitch-enum @gol
322 -Wswitch-unreachable  -Wsync-nand @gol
323 -Wsystem-headers  -Wtautological-compare  -Wtrampolines  -Wtrigraphs @gol
324 -Wtype-limits  -Wundef @gol
325 -Wuninitialized  -Wunknown-pragmas  -Wunsafe-loop-optimizations @gol
326 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
327 -Wunused-label  -Wunused-local-typedefs  -Wunused-macros @gol
328 -Wunused-parameter  -Wno-unused-result @gol
329 -Wunused-value  -Wunused-variable @gol
330 -Wunused-const-variable  -Wunused-const-variable=@var{n} @gol
331 -Wunused-but-set-parameter  -Wunused-but-set-variable @gol
332 -Wuseless-cast  -Wvariadic-macros  -Wvector-operation-performance @gol
333 -Wvla  -Wvla-larger-than=@var{n}  -Wvolatile-register-var  -Wwrite-strings @gol
334 -Wzero-as-null-pointer-constant  -Whsa}
336 @item C and Objective-C-only Warning Options
337 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
338 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
339 -Wold-style-declaration  -Wold-style-definition @gol
340 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
341 -Wdeclaration-after-statement  -Wpointer-sign}
343 @item Debugging Options
344 @xref{Debugging Options,,Options for Debugging Your Program}.
345 @gccoptlist{-g  -g@var{level}  -gdwarf  -gdwarf-@var{version} @gol
346 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
347 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
348 -gcolumn-info  -gno-column-info @gol
349 -gstatement-frontiers  -gno-statement-frontiers @gol
350 -gvms  -gxcoff  -gxcoff+  -gz@r{[}=@var{type}@r{]} @gol
351 -fdebug-prefix-map=@var{old}=@var{new}  -fdebug-types-section @gol
352 -fno-eliminate-unused-debug-types @gol
353 -femit-struct-debug-baseonly  -femit-struct-debug-reduced @gol
354 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
355 -feliminate-unused-debug-symbols  -femit-class-debug-always @gol
356 -fno-merge-debug-strings  -fno-dwarf2-cfi-asm @gol
357 -fvar-tracking  -fvar-tracking-assignments}
359 @item Optimization Options
360 @xref{Optimize Options,,Options that Control Optimization}.
361 @gccoptlist{-faggressive-loop-optimizations  -falign-functions[=@var{n}] @gol
362 -falign-jumps[=@var{n}] @gol
363 -falign-labels[=@var{n}]  -falign-loops[=@var{n}] @gol
364 -fassociative-math  -fauto-profile  -fauto-profile[=@var{path}] @gol
365 -fauto-inc-dec  -fbranch-probabilities @gol
366 -fbranch-target-load-optimize  -fbranch-target-load-optimize2 @gol
367 -fbtr-bb-exclusive  -fcaller-saves @gol
368 -fcombine-stack-adjustments  -fconserve-stack @gol
369 -fcompare-elim  -fcprop-registers  -fcrossjumping @gol
370 -fcse-follow-jumps  -fcse-skip-blocks  -fcx-fortran-rules @gol
371 -fcx-limited-range @gol
372 -fdata-sections  -fdce  -fdelayed-branch @gol
373 -fdelete-null-pointer-checks  -fdevirtualize  -fdevirtualize-speculatively @gol
374 -fdevirtualize-at-ltrans  -fdse @gol
375 -fearly-inlining  -fipa-sra  -fexpensive-optimizations  -ffat-lto-objects @gol
376 -ffast-math  -ffinite-math-only  -ffloat-store  -fexcess-precision=@var{style} @gol
377 -fforward-propagate  -ffp-contract=@var{style}  -ffunction-sections @gol
378 -fgcse  -fgcse-after-reload  -fgcse-las  -fgcse-lm  -fgraphite-identity @gol
379 -fgcse-sm  -fhoist-adjacent-loads  -fif-conversion @gol
380 -fif-conversion2  -findirect-inlining @gol
381 -finline-functions  -finline-functions-called-once  -finline-limit=@var{n} @gol
382 -finline-small-functions  -fipa-cp  -fipa-cp-clone @gol
383 -fipa-bit-cp -fipa-vrp @gol
384 -fipa-pta  -fipa-profile  -fipa-pure-const  -fipa-reference  -fipa-icf @gol
385 -fira-algorithm=@var{algorithm} @gol
386 -fira-region=@var{region}  -fira-hoist-pressure @gol
387 -fira-loop-pressure  -fno-ira-share-save-slots @gol
388 -fno-ira-share-spill-slots @gol
389 -fisolate-erroneous-paths-dereference  -fisolate-erroneous-paths-attribute @gol
390 -fivopts  -fkeep-inline-functions  -fkeep-static-functions @gol
391 -fkeep-static-consts  -flimit-function-alignment  -flive-range-shrinkage @gol
392 -floop-block  -floop-interchange  -floop-strip-mine @gol
393 -floop-unroll-and-jam  -floop-nest-optimize @gol
394 -floop-parallelize-all  -flra-remat  -flto  -flto-compression-level @gol
395 -flto-partition=@var{alg}  -fmerge-all-constants @gol
396 -fmerge-constants  -fmodulo-sched  -fmodulo-sched-allow-regmoves @gol
397 -fmove-loop-invariants  -fno-branch-count-reg @gol
398 -fno-defer-pop  -fno-fp-int-builtin-inexact  -fno-function-cse @gol
399 -fno-guess-branch-probability  -fno-inline  -fno-math-errno  -fno-peephole @gol
400 -fno-peephole2  -fno-printf-return-value  -fno-sched-interblock @gol
401 -fno-sched-spec  -fno-signed-zeros @gol
402 -fno-toplevel-reorder  -fno-trapping-math  -fno-zero-initialized-in-bss @gol
403 -fomit-frame-pointer  -foptimize-sibling-calls @gol
404 -fpartial-inlining  -fpeel-loops  -fpredictive-commoning @gol
405 -fprefetch-loop-arrays @gol
406 -fprofile-correction @gol
407 -fprofile-use  -fprofile-use=@var{path}  -fprofile-values @gol
408 -fprofile-reorder-functions @gol
409 -freciprocal-math  -free  -frename-registers  -freorder-blocks @gol
410 -freorder-blocks-algorithm=@var{algorithm} @gol
411 -freorder-blocks-and-partition  -freorder-functions @gol
412 -frerun-cse-after-loop  -freschedule-modulo-scheduled-loops @gol
413 -frounding-math  -fsched2-use-superblocks  -fsched-pressure @gol
414 -fsched-spec-load  -fsched-spec-load-dangerous @gol
415 -fsched-stalled-insns-dep[=@var{n}]  -fsched-stalled-insns[=@var{n}] @gol
416 -fsched-group-heuristic  -fsched-critical-path-heuristic @gol
417 -fsched-spec-insn-heuristic  -fsched-rank-heuristic @gol
418 -fsched-last-insn-heuristic  -fsched-dep-count-heuristic @gol
419 -fschedule-fusion @gol
420 -fschedule-insns  -fschedule-insns2  -fsection-anchors @gol
421 -fselective-scheduling  -fselective-scheduling2 @gol
422 -fsel-sched-pipelining  -fsel-sched-pipelining-outer-loops @gol
423 -fsemantic-interposition  -fshrink-wrap  -fshrink-wrap-separate @gol
424 -fsignaling-nans @gol
425 -fsingle-precision-constant  -fsplit-ivs-in-unroller  -fsplit-loops@gol
426 -fsplit-paths @gol
427 -fsplit-wide-types  -fssa-backprop  -fssa-phiopt @gol
428 -fstdarg-opt  -fstore-merging  -fstrict-aliasing @gol
429 -fthread-jumps  -ftracer  -ftree-bit-ccp @gol
430 -ftree-builtin-call-dce  -ftree-ccp  -ftree-ch @gol
431 -ftree-coalesce-vars  -ftree-copy-prop  -ftree-dce  -ftree-dominator-opts @gol
432 -ftree-dse  -ftree-forwprop  -ftree-fre  -fcode-hoisting @gol
433 -ftree-loop-if-convert  -ftree-loop-im @gol
434 -ftree-phiprop  -ftree-loop-distribution  -ftree-loop-distribute-patterns @gol
435 -ftree-loop-ivcanon  -ftree-loop-linear  -ftree-loop-optimize @gol
436 -ftree-loop-vectorize @gol
437 -ftree-parallelize-loops=@var{n}  -ftree-pre  -ftree-partial-pre  -ftree-pta @gol
438 -ftree-reassoc  -ftree-sink  -ftree-slsr  -ftree-sra @gol
439 -ftree-switch-conversion  -ftree-tail-merge @gol
440 -ftree-ter  -ftree-vectorize  -ftree-vrp  -funconstrained-commons @gol
441 -funit-at-a-time  -funroll-all-loops  -funroll-loops @gol
442 -funsafe-math-optimizations  -funswitch-loops @gol
443 -fipa-ra  -fvariable-expansion-in-unroller  -fvect-cost-model  -fvpt @gol
444 -fweb  -fwhole-program  -fwpa  -fuse-linker-plugin @gol
445 --param @var{name}=@var{value}
446 -O  -O0  -O1  -O2  -O3  -Os  -Ofast  -Og}
448 @item Program Instrumentation Options
449 @xref{Instrumentation Options,,Program Instrumentation Options}.
450 @gccoptlist{-p  -pg  -fprofile-arcs  --coverage  -ftest-coverage @gol
451 -fprofile-abs-path @gol
452 -fprofile-dir=@var{path}  -fprofile-generate  -fprofile-generate=@var{path} @gol
453 -fsanitize=@var{style}  -fsanitize-recover  -fsanitize-recover=@var{style} @gol
454 -fasan-shadow-offset=@var{number}  -fsanitize-sections=@var{s1},@var{s2},... @gol
455 -fsanitize-undefined-trap-on-error  -fbounds-check @gol
456 -fcheck-pointer-bounds  -fchkp-check-incomplete-type @gol
457 -fchkp-first-field-has-own-bounds  -fchkp-narrow-bounds @gol
458 -fchkp-narrow-to-innermost-array  -fchkp-optimize @gol
459 -fchkp-use-fast-string-functions  -fchkp-use-nochk-string-functions @gol
460 -fchkp-use-static-bounds  -fchkp-use-static-const-bounds @gol
461 -fchkp-treat-zero-dynamic-size-as-infinite  -fchkp-check-read @gol
462 -fchkp-check-read  -fchkp-check-write  -fchkp-store-bounds @gol
463 -fchkp-instrument-calls  -fchkp-instrument-marked-only @gol
464 -fchkp-use-wrappers  -fchkp-flexible-struct-trailing-arrays@gol
465 -fcf-protection==@r{[}full@r{|}branch@r{|}return@r{|}none@r{]} @gol
466 -fstack-protector  -fstack-protector-all  -fstack-protector-strong @gol
467 -fstack-protector-explicit  -fstack-check @gol
468 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
469 -fno-stack-limit  -fsplit-stack @gol
470 -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]} @gol
471 -fvtv-counts  -fvtv-debug @gol
472 -finstrument-functions @gol
473 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
474 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}}
476 @item Preprocessor Options
477 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
478 @gccoptlist{-A@var{question}=@var{answer} @gol
479 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
480 -C  -CC  -D@var{macro}@r{[}=@var{defn}@r{]} @gol
481 -dD  -dI  -dM  -dN  -dU @gol
482 -fdebug-cpp  -fdirectives-only  -fdollars-in-identifiers  @gol
483 -fexec-charset=@var{charset}  -fextended-identifiers  @gol
484 -finput-charset=@var{charset}  -fno-canonical-system-headers @gol
485 -fpch-deps  -fpch-preprocess  -fpreprocessed @gol
486 -ftabstop=@var{width}  -ftrack-macro-expansion  @gol
487 -fwide-exec-charset=@var{charset}  -fworking-directory @gol
488 -H  -imacros @var{file}  -include @var{file} @gol
489 -M  -MD  -MF  -MG  -MM  -MMD  -MP  -MQ  -MT @gol
490 -no-integrated-cpp  -P  -pthread  -remap @gol
491 -traditional  -traditional-cpp  -trigraphs @gol
492 -U@var{macro}  -undef  @gol
493 -Wp,@var{option}  -Xpreprocessor @var{option}}
495 @item Assembler Options
496 @xref{Assembler Options,,Passing Options to the Assembler}.
497 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
499 @item Linker Options
500 @xref{Link Options,,Options for Linking}.
501 @gccoptlist{@var{object-file-name}  -fuse-ld=@var{linker}  -l@var{library} @gol
502 -nostartfiles  -nodefaultlibs  -nostdlib  -pie  -pthread  -rdynamic @gol
503 -s  -static -static-pie -static-libgcc  -static-libstdc++ @gol
504 -static-libasan  -static-libtsan  -static-liblsan  -static-libubsan @gol
505 -static-libmpx  -static-libmpxwrappers @gol
506 -shared  -shared-libgcc  -symbolic @gol
507 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
508 -u @var{symbol}  -z @var{keyword}}
510 @item Directory Options
511 @xref{Directory Options,,Options for Directory Search}.
512 @gccoptlist{-B@var{prefix}  -I@var{dir}  -I- @gol
513 -idirafter @var{dir} @gol
514 -imacros @var{file}  -imultilib @var{dir} @gol
515 -iplugindir=@var{dir}  -iprefix @var{file} @gol
516 -iquote @var{dir}  -isysroot @var{dir}  -isystem @var{dir} @gol
517 -iwithprefix @var{dir}  -iwithprefixbefore @var{dir}  @gol
518 -L@var{dir}  -no-canonical-prefixes  --no-sysroot-suffix @gol
519 -nostdinc  -nostdinc++  --sysroot=@var{dir}}
521 @item Code Generation Options
522 @xref{Code Gen Options,,Options for Code Generation Conventions}.
523 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
524 -ffixed-@var{reg}  -fexceptions @gol
525 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
526 -fasynchronous-unwind-tables @gol
527 -fno-gnu-unique @gol
528 -finhibit-size-directive  -fno-common  -fno-ident @gol
529 -fpcc-struct-return  -fpic  -fPIC  -fpie  -fPIE  -fno-plt @gol
530 -fno-jump-tables @gol
531 -frecord-gcc-switches @gol
532 -freg-struct-return  -fshort-enums  -fshort-wchar @gol
533 -fverbose-asm  -fpack-struct[=@var{n}]  @gol
534 -fleading-underscore  -ftls-model=@var{model} @gol
535 -fstack-reuse=@var{reuse_level} @gol
536 -ftrampolines  -ftrapv  -fwrapv @gol
537 -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]} @gol
538 -fstrict-volatile-bitfields  -fsync-libcalls}
540 @item Developer Options
541 @xref{Developer Options,,GCC Developer Options}.
542 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
543 -dumpfullversion  -fchecking  -fchecking=@var{n}  -fdbg-cnt-list @gol
544 -fdbg-cnt=@var{counter-value-list} @gol
545 -fdisable-ipa-@var{pass_name} @gol
546 -fdisable-rtl-@var{pass_name} @gol
547 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
548 -fdisable-tree-@var{pass_name} @gol
549 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
550 -fdump-noaddr  -fdump-unnumbered  -fdump-unnumbered-links @gol
551 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
552 -fdump-final-insns@r{[}=@var{file}@r{]}
553 -fdump-ipa-all  -fdump-ipa-cgraph  -fdump-ipa-inline @gol
554 -fdump-lang-all @gol
555 -fdump-lang-@var{switch} @gol
556 -fdump-lang-@var{switch}-@var{options} @gol
557 -fdump-lang-@var{switch}-@var{options}=@var{filename} @gol
558 -fdump-passes @gol
559 -fdump-rtl-@var{pass}  -fdump-rtl-@var{pass}=@var{filename} @gol
560 -fdump-statistics @gol
561 -fdump-tree-all @gol
562 -fdump-tree-@var{switch} @gol
563 -fdump-tree-@var{switch}-@var{options} @gol
564 -fdump-tree-@var{switch}-@var{options}=@var{filename} @gol
565 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
566 -fenable-@var{kind}-@var{pass} @gol
567 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
568 -fira-verbose=@var{n} @gol
569 -flto-report  -flto-report-wpa  -fmem-report-wpa @gol
570 -fmem-report  -fpre-ipa-mem-report  -fpost-ipa-mem-report @gol
571 -fopt-info  -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
572 -fprofile-report @gol
573 -frandom-seed=@var{string}  -fsched-verbose=@var{n} @gol
574 -fsel-sched-verbose  -fsel-sched-dump-cfg  -fsel-sched-pipelining-verbose @gol
575 -fstats  -fstack-usage  -ftime-report  -ftime-report-details @gol
576 -fvar-tracking-assignments-toggle  -gtoggle @gol
577 -print-file-name=@var{library}  -print-libgcc-file-name @gol
578 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
579 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
580 -print-sysroot  -print-sysroot-headers-suffix @gol
581 -save-temps  -save-temps=cwd  -save-temps=obj  -time@r{[}=@var{file}@r{]}}
583 @item Machine-Dependent Options
584 @xref{Submodel Options,,Machine-Dependent Options}.
585 @c This list is ordered alphanumerically by subsection name.
586 @c Try and put the significant identifier (CPU or system) first,
587 @c so users have a clue at guessing where the ones they want will be.
589 @emph{AArch64 Options}
590 @gccoptlist{-mabi=@var{name}  -mbig-endian  -mlittle-endian @gol
591 -mgeneral-regs-only @gol
592 -mcmodel=tiny  -mcmodel=small  -mcmodel=large @gol
593 -mstrict-align @gol
594 -momit-leaf-frame-pointer @gol
595 -mtls-dialect=desc  -mtls-dialect=traditional @gol
596 -mtls-size=@var{size} @gol
597 -mfix-cortex-a53-835769  -mfix-cortex-a53-843419 @gol
598 -mlow-precision-recip-sqrt  -mlow-precision-sqrt  -mlow-precision-div @gol
599 -mpc-relative-literal-loads @gol
600 -msign-return-address=@var{scope} @gol
601 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}  -moverride=@var{string}}
603 @emph{Adapteva Epiphany Options}
604 @gccoptlist{-mhalf-reg-file  -mprefer-short-insn-regs @gol
605 -mbranch-cost=@var{num}  -mcmove  -mnops=@var{num}  -msoft-cmpsf @gol
606 -msplit-lohi  -mpost-inc  -mpost-modify  -mstack-offset=@var{num} @gol
607 -mround-nearest  -mlong-calls  -mshort-calls  -msmall16 @gol
608 -mfp-mode=@var{mode}  -mvect-double  -max-vect-align=@var{num} @gol
609 -msplit-vecmove-early  -m1reg-@var{reg}}
611 @emph{ARC Options}
612 @gccoptlist{-mbarrel-shifter @gol
613 -mcpu=@var{cpu}  -mA6  -mARC600  -mA7  -mARC700 @gol
614 -mdpfp  -mdpfp-compact  -mdpfp-fast  -mno-dpfp-lrsr @gol
615 -mea  -mno-mpy  -mmul32x16  -mmul64  -matomic @gol
616 -mnorm  -mspfp  -mspfp-compact  -mspfp-fast  -msimd  -msoft-float  -mswap @gol
617 -mcrc  -mdsp-packa  -mdvbf  -mlock  -mmac-d16  -mmac-24  -mrtsc  -mswape @gol
618 -mtelephony  -mxy  -misize  -mannotate-align  -marclinux  -marclinux_prof @gol
619 -mlong-calls  -mmedium-calls  -msdata -mirq-ctrl-saved @gol
620 -mrgf-banked-regs -mlpc-width=@var{width} -G @var{num} @gol
621 -mvolatile-cache  -mtp-regno=@var{regno} @gol
622 -malign-call  -mauto-modify-reg  -mbbit-peephole  -mno-brcc @gol
623 -mcase-vector-pcrel  -mcompact-casesi  -mno-cond-exec  -mearly-cbranchsi @gol
624 -mexpand-adddi  -mindexed-loads  -mlra  -mlra-priority-none @gol
625 -mlra-priority-compact mlra-priority-noncompact  -mno-millicode @gol
626 -mmixed-code  -mq-class  -mRcq  -mRcw  -msize-level=@var{level} @gol
627 -mtune=@var{cpu}  -mmultcost=@var{num} @gol
628 -munalign-prob-threshold=@var{probability}  -mmpy-option=@var{multo} @gol
629 -mdiv-rem  -mcode-density  -mll64  -mfpu=@var{fpu}}
631 @emph{ARM Options}
632 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
633 -mabi=@var{name} @gol
634 -mapcs-stack-check  -mno-apcs-stack-check @gol
635 -mapcs-reentrant  -mno-apcs-reentrant @gol
636 -msched-prolog  -mno-sched-prolog @gol
637 -mlittle-endian  -mbig-endian @gol
638 -mbe8 -mbe32 @gol
639 -mfloat-abi=@var{name} @gol
640 -mfp16-format=@var{name}
641 -mthumb-interwork  -mno-thumb-interwork @gol
642 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
643 -mtune=@var{name}  -mprint-tune-info @gol
644 -mstructure-size-boundary=@var{n} @gol
645 -mabort-on-noreturn @gol
646 -mlong-calls  -mno-long-calls @gol
647 -msingle-pic-base  -mno-single-pic-base @gol
648 -mpic-register=@var{reg} @gol
649 -mnop-fun-dllimport @gol
650 -mpoke-function-name @gol
651 -mthumb  -marm @gol
652 -mtpcs-frame  -mtpcs-leaf-frame @gol
653 -mcaller-super-interworking  -mcallee-super-interworking @gol
654 -mtp=@var{name}  -mtls-dialect=@var{dialect} @gol
655 -mword-relocations @gol
656 -mfix-cortex-m3-ldrd @gol
657 -munaligned-access @gol
658 -mneon-for-64bits @gol
659 -mslow-flash-data @gol
660 -masm-syntax-unified @gol
661 -mrestrict-it @gol
662 -mpure-code @gol
663 -mcmse}
665 @emph{AVR Options}
666 @gccoptlist{-mmcu=@var{mcu}  -mabsdata  -maccumulate-args @gol
667 -mbranch-cost=@var{cost} @gol
668 -mcall-prologues  -mgas-isr-prologues  -mint8 @gol
669 -mn_flash=@var{size}  -mno-interrupts @gol
670 -mrelax  -mrmw  -mstrict-X  -mtiny-stack  -mfract-convert-truncate @gol
671 -mshort-calls  -nodevicelib @gol
672 -Waddr-space-convert  -Wmisspelled-isr}
674 @emph{Blackfin Options}
675 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
676 -msim  -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
677 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
678 -mlow-64k  -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
679 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
680 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
681 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
682 -mfast-fp  -minline-plt  -mmulticore  -mcorea  -mcoreb  -msdram @gol
683 -micplb}
685 @emph{C6X Options}
686 @gccoptlist{-mbig-endian  -mlittle-endian  -march=@var{cpu} @gol
687 -msim  -msdata=@var{sdata-type}}
689 @emph{CRIS Options}
690 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
691 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
692 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
693 -mstack-align  -mdata-align  -mconst-align @gol
694 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
695 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
696 -mmul-bug-workaround  -mno-mul-bug-workaround}
698 @emph{CR16 Options}
699 @gccoptlist{-mmac @gol
700 -mcr16cplus  -mcr16c @gol
701 -msim  -mint32  -mbit-ops
702 -mdata-model=@var{model}}
704 @emph{Darwin Options}
705 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
706 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
707 -client_name  -compatibility_version  -current_version @gol
708 -dead_strip @gol
709 -dependency-file  -dylib_file  -dylinker_install_name @gol
710 -dynamic  -dynamiclib  -exported_symbols_list @gol
711 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
712 -force_flat_namespace  -headerpad_max_install_names @gol
713 -iframework @gol
714 -image_base  -init  -install_name  -keep_private_externs @gol
715 -multi_module  -multiply_defined  -multiply_defined_unused @gol
716 -noall_load   -no_dead_strip_inits_and_terms @gol
717 -nofixprebinding  -nomultidefs  -noprebind  -noseglinkedit @gol
718 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
719 -private_bundle  -read_only_relocs  -sectalign @gol
720 -sectobjectsymbols  -whyload  -seg1addr @gol
721 -sectcreate  -sectobjectsymbols  -sectorder @gol
722 -segaddr  -segs_read_only_addr  -segs_read_write_addr @gol
723 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
724 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
725 -single_module  -static  -sub_library  -sub_umbrella @gol
726 -twolevel_namespace  -umbrella  -undefined @gol
727 -unexported_symbols_list  -weak_reference_mismatches @gol
728 -whatsloaded  -F  -gused  -gfull  -mmacosx-version-min=@var{version} @gol
729 -mkernel  -mone-byte-bool}
731 @emph{DEC Alpha Options}
732 @gccoptlist{-mno-fp-regs  -msoft-float @gol
733 -mieee  -mieee-with-inexact  -mieee-conformant @gol
734 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
735 -mtrap-precision=@var{mode}  -mbuild-constants @gol
736 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
737 -mbwx  -mmax  -mfix  -mcix @gol
738 -mfloat-vax  -mfloat-ieee @gol
739 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
740 -msmall-text  -mlarge-text @gol
741 -mmemory-latency=@var{time}}
743 @emph{FR30 Options}
744 @gccoptlist{-msmall-model  -mno-lsim}
746 @emph{FT32 Options}
747 @gccoptlist{-msim  -mlra  -mnodiv  -mft32b  -mcompress  -mnopm}
749 @emph{FRV Options}
750 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
751 -mhard-float  -msoft-float @gol
752 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
753 -mdouble  -mno-double @gol
754 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
755 -mfdpic  -minline-plt  -mgprel-ro  -multilib-library-pic @gol
756 -mlinked-fp  -mlong-calls  -malign-labels @gol
757 -mlibrary-pic  -macc-4  -macc-8 @gol
758 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
759 -moptimize-membar  -mno-optimize-membar @gol
760 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
761 -mvliw-branch  -mno-vliw-branch @gol
762 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
763 -mno-nested-cond-exec  -mtomcat-stats @gol
764 -mTLS  -mtls @gol
765 -mcpu=@var{cpu}}
767 @emph{GNU/Linux Options}
768 @gccoptlist{-mglibc  -muclibc  -mmusl  -mbionic  -mandroid @gol
769 -tno-android-cc  -tno-android-ld}
771 @emph{H8/300 Options}
772 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr  -mno-exr  -mint32  -malign-300}
774 @emph{HPPA Options}
775 @gccoptlist{-march=@var{architecture-type} @gol
776 -mcaller-copies  -mdisable-fpregs  -mdisable-indexing @gol
777 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
778 -mfixed-range=@var{register-range} @gol
779 -mjump-in-delay  -mlinker-opt  -mlong-calls @gol
780 -mlong-load-store  -mno-disable-fpregs @gol
781 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
782 -mno-jump-in-delay  -mno-long-load-store @gol
783 -mno-portable-runtime  -mno-soft-float @gol
784 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
785 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
786 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
787 -munix=@var{unix-std}  -nolibdld  -static  -threads}
789 @emph{IA-64 Options}
790 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
791 -mvolatile-asm-stop  -mregister-names  -msdata  -mno-sdata @gol
792 -mconstant-gp  -mauto-pic  -mfused-madd @gol
793 -minline-float-divide-min-latency @gol
794 -minline-float-divide-max-throughput @gol
795 -mno-inline-float-divide @gol
796 -minline-int-divide-min-latency @gol
797 -minline-int-divide-max-throughput  @gol
798 -mno-inline-int-divide @gol
799 -minline-sqrt-min-latency  -minline-sqrt-max-throughput @gol
800 -mno-inline-sqrt @gol
801 -mdwarf2-asm  -mearly-stop-bits @gol
802 -mfixed-range=@var{register-range}  -mtls-size=@var{tls-size} @gol
803 -mtune=@var{cpu-type}  -milp32  -mlp64 @gol
804 -msched-br-data-spec  -msched-ar-data-spec  -msched-control-spec @gol
805 -msched-br-in-data-spec  -msched-ar-in-data-spec  -msched-in-control-spec @gol
806 -msched-spec-ldc  -msched-spec-control-ldc @gol
807 -msched-prefer-non-data-spec-insns  -msched-prefer-non-control-spec-insns @gol
808 -msched-stop-bits-after-every-cycle  -msched-count-spec-in-critical-path @gol
809 -msel-sched-dont-check-control-spec  -msched-fp-mem-deps-zero-cost @gol
810 -msched-max-memory-insns-hard-limit  -msched-max-memory-insns=@var{max-insns}}
812 @emph{LM32 Options}
813 @gccoptlist{-mbarrel-shift-enabled  -mdivide-enabled  -mmultiply-enabled @gol
814 -msign-extend-enabled  -muser-enabled}
816 @emph{M32R/D Options}
817 @gccoptlist{-m32r2  -m32rx  -m32r @gol
818 -mdebug @gol
819 -malign-loops  -mno-align-loops @gol
820 -missue-rate=@var{number} @gol
821 -mbranch-cost=@var{number} @gol
822 -mmodel=@var{code-size-model-type} @gol
823 -msdata=@var{sdata-type} @gol
824 -mno-flush-func  -mflush-func=@var{name} @gol
825 -mno-flush-trap  -mflush-trap=@var{number} @gol
826 -G @var{num}}
828 @emph{M32C Options}
829 @gccoptlist{-mcpu=@var{cpu}  -msim  -memregs=@var{number}}
831 @emph{M680x0 Options}
832 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune} @gol
833 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
834 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
835 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
836 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
837 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
838 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
839 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
840 -mxgot  -mno-xgot  -mlong-jump-table-offsets}
842 @emph{MCore Options}
843 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
844 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
845 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
846 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
847 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
849 @emph{MeP Options}
850 @gccoptlist{-mabsdiff  -mall-opts  -maverage  -mbased=@var{n}  -mbitops @gol
851 -mc=@var{n}  -mclip  -mconfig=@var{name}  -mcop  -mcop32  -mcop64  -mivc2 @gol
852 -mdc  -mdiv  -meb  -mel  -mio-volatile  -ml  -mleadz  -mm  -mminmax @gol
853 -mmult  -mno-opts  -mrepeat  -ms  -msatur  -msdram  -msim  -msimnovec  -mtf @gol
854 -mtiny=@var{n}}
856 @emph{MicroBlaze Options}
857 @gccoptlist{-msoft-float  -mhard-float  -msmall-divides  -mcpu=@var{cpu} @gol
858 -mmemcpy  -mxl-soft-mul  -mxl-soft-div  -mxl-barrel-shift @gol
859 -mxl-pattern-compare  -mxl-stack-check  -mxl-gp-opt  -mno-clearbss @gol
860 -mxl-multiply-high  -mxl-float-convert  -mxl-float-sqrt @gol
861 -mbig-endian  -mlittle-endian  -mxl-reorder  -mxl-mode-@var{app-model}}
863 @emph{MIPS Options}
864 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
865 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips32r3  -mips32r5 @gol
866 -mips32r6  -mips64  -mips64r2  -mips64r3  -mips64r5  -mips64r6 @gol
867 -mips16  -mno-mips16  -mflip-mips16 @gol
868 -minterlink-compressed  -mno-interlink-compressed @gol
869 -minterlink-mips16  -mno-interlink-mips16 @gol
870 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
871 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
872 -mgp32  -mgp64  -mfp32  -mfpxx  -mfp64  -mhard-float  -msoft-float @gol
873 -mno-float  -msingle-float  -mdouble-float @gol
874 -modd-spreg  -mno-odd-spreg @gol
875 -mabs=@var{mode}  -mnan=@var{encoding} @gol
876 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
877 -mmcu  -mmno-mcu @gol
878 -meva  -mno-eva @gol
879 -mvirt  -mno-virt @gol
880 -mxpa  -mno-xpa @gol
881 -mmicromips  -mno-micromips @gol
882 -mmsa  -mno-msa @gol
883 -mfpu=@var{fpu-type} @gol
884 -msmartmips  -mno-smartmips @gol
885 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
886 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
887 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
888 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
889 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
890 -membedded-data  -mno-embedded-data @gol
891 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
892 -mcode-readable=@var{setting} @gol
893 -msplit-addresses  -mno-split-addresses @gol
894 -mexplicit-relocs  -mno-explicit-relocs @gol
895 -mcheck-zero-division  -mno-check-zero-division @gol
896 -mdivide-traps  -mdivide-breaks @gol
897 -mload-store-pairs  -mno-load-store-pairs @gol
898 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
899 -mmad  -mno-mad  -mimadd  -mno-imadd  -mfused-madd  -mno-fused-madd  -nocpp @gol
900 -mfix-24k  -mno-fix-24k @gol
901 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
902 -mfix-r10000  -mno-fix-r10000  -mfix-rm7000  -mno-fix-rm7000 @gol
903 -mfix-vr4120  -mno-fix-vr4120 @gol
904 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
905 -mflush-func=@var{func}  -mno-flush-func @gol
906 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
907 -mcompact-branches=@var{policy} @gol
908 -mfp-exceptions  -mno-fp-exceptions @gol
909 -mvr4130-align  -mno-vr4130-align  -msynci  -mno-synci @gol
910 -mlxc1-sxc1 -mno-lxc1-sxc1 -mmadd4 -mno-madd4 @gol
911 -mrelax-pic-calls  -mno-relax-pic-calls  -mmcount-ra-address @gol
912 -mframe-header-opt  -mno-frame-header-opt}
914 @emph{MMIX Options}
915 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
916 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
917 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
918 -mno-base-addresses  -msingle-exit  -mno-single-exit}
920 @emph{MN10300 Options}
921 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
922 -mno-am33  -mam33  -mam33-2  -mam34 @gol
923 -mtune=@var{cpu-type} @gol
924 -mreturn-pointer-on-d0 @gol
925 -mno-crt0  -mrelax  -mliw  -msetlb}
927 @emph{Moxie Options}
928 @gccoptlist{-meb  -mel  -mmul.x  -mno-crt0}
930 @emph{MSP430 Options}
931 @gccoptlist{-msim  -masm-hex  -mmcu=  -mcpu=  -mlarge  -msmall  -mrelax @gol
932 -mwarn-mcu @gol
933 -mcode-region=  -mdata-region= @gol
934 -msilicon-errata=  -msilicon-errata-warn= @gol
935 -mhwmult=  -minrt}
937 @emph{NDS32 Options}
938 @gccoptlist{-mbig-endian  -mlittle-endian @gol
939 -mreduced-regs  -mfull-regs @gol
940 -mcmov  -mno-cmov @gol
941 -mperf-ext  -mno-perf-ext @gol
942 -mv3push  -mno-v3push @gol
943 -m16bit  -mno-16bit @gol
944 -misr-vector-size=@var{num} @gol
945 -mcache-block-size=@var{num} @gol
946 -march=@var{arch} @gol
947 -mcmodel=@var{code-model} @gol
948 -mctor-dtor  -mrelax}
950 @emph{Nios II Options}
951 @gccoptlist{-G @var{num}  -mgpopt=@var{option}  -mgpopt  -mno-gpopt @gol
952 -mgprel-sec=@var{regexp} -mr0rel-sec=@var{regexp} @gol
953 -mel  -meb @gol
954 -mno-bypass-cache  -mbypass-cache @gol
955 -mno-cache-volatile  -mcache-volatile @gol
956 -mno-fast-sw-div  -mfast-sw-div @gol
957 -mhw-mul  -mno-hw-mul  -mhw-mulx  -mno-hw-mulx  -mno-hw-div  -mhw-div @gol
958 -mcustom-@var{insn}=@var{N}  -mno-custom-@var{insn} @gol
959 -mcustom-fpu-cfg=@var{name} @gol
960 -mhal  -msmallc  -msys-crt0=@var{name}  -msys-lib=@var{name} @gol
961 -march=@var{arch}  -mbmx  -mno-bmx  -mcdx  -mno-cdx}
963 @emph{Nvidia PTX Options}
964 @gccoptlist{-m32  -m64  -mmainkernel  -moptimize}
966 @emph{PDP-11 Options}
967 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
968 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
969 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
970 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
971 -mbranch-expensive  -mbranch-cheap @gol
972 -munix-asm  -mdec-asm}
974 @emph{picoChip Options}
975 @gccoptlist{-mae=@var{ae_type}  -mvliw-lookahead=@var{N} @gol
976 -msymbol-as-address  -mno-inefficient-warnings}
978 @emph{PowerPC Options}
979 See RS/6000 and PowerPC Options.
981 @emph{RISC-V Options}
982 @gccoptlist{-mbranch-cost=@var{N-instruction} @gol
983 -mplt  -mno-plt @gol
984 -mabi=@var{ABI-string} @gol
985 -mfdiv  -mno-fdiv @gol
986 -mdiv  -mno-div @gol
987 -march=@var{ISA-string} @gol
988 -mtune=@var{processor-string} @gol
989 -msmall-data-limit=@var{N-bytes} @gol
990 -msave-restore  -mno-save-restore @gol
991 -mstrict-align -mno-strict-align @gol
992 -mcmodel=medlow -mcmodel=medany @gol
993 -mexplicit-relocs  -mno-explicit-relocs @gol}
995 @emph{RL78 Options}
996 @gccoptlist{-msim  -mmul=none  -mmul=g13  -mmul=g14  -mallregs @gol
997 -mcpu=g10  -mcpu=g13  -mcpu=g14  -mg10  -mg13  -mg14 @gol
998 -m64bit-doubles  -m32bit-doubles  -msave-mduc-in-interrupts}
1000 @emph{RS/6000 and PowerPC Options}
1001 @gccoptlist{-mcpu=@var{cpu-type} @gol
1002 -mtune=@var{cpu-type} @gol
1003 -mcmodel=@var{code-model} @gol
1004 -mpowerpc64 @gol
1005 -maltivec  -mno-altivec @gol
1006 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
1007 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
1008 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mpopcntd  -mno-popcntd @gol
1009 -mfprnd  -mno-fprnd @gol
1010 -mcmpb  -mno-cmpb  -mmfpgpr  -mno-mfpgpr  -mhard-dfp  -mno-hard-dfp @gol
1011 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
1012 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
1013 -malign-power  -malign-natural @gol
1014 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
1015 -msingle-float  -mdouble-float  -msimple-fpu @gol
1016 -mstring  -mno-string  -mupdate  -mno-update @gol
1017 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
1018 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
1019 -mstrict-align  -mno-strict-align  -mrelocatable @gol
1020 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
1021 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
1022 -mdynamic-no-pic  -maltivec  -mswdiv  -msingle-pic-base @gol
1023 -mprioritize-restricted-insns=@var{priority} @gol
1024 -msched-costly-dep=@var{dependence_type} @gol
1025 -minsert-sched-nops=@var{scheme} @gol
1026 -mcall-sysv  -mcall-netbsd @gol
1027 -maix-struct-return  -msvr4-struct-return @gol
1028 -mabi=@var{abi-type}  -msecure-plt  -mbss-plt @gol
1029 -mblock-move-inline-limit=@var{num} @gol
1030 -misel  -mno-isel @gol
1031 -misel=yes  -misel=no @gol
1032 -mspe  -mno-spe @gol
1033 -mspe=yes  -mspe=no @gol
1034 -mpaired @gol
1035 -mvrsave  -mno-vrsave @gol
1036 -mmulhw  -mno-mulhw @gol
1037 -mdlmzb  -mno-dlmzb @gol
1038 -mfloat-gprs=yes  -mfloat-gprs=no  -mfloat-gprs=single  -mfloat-gprs=double @gol
1039 -mprototype  -mno-prototype @gol
1040 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
1041 -msdata=@var{opt}  -mvxworks  -G @var{num} @gol
1042 -mrecip  -mrecip=@var{opt}  -mno-recip  -mrecip-precision @gol
1043 -mno-recip-precision @gol
1044 -mveclibabi=@var{type}  -mfriz  -mno-friz @gol
1045 -mpointers-to-nested-functions  -mno-pointers-to-nested-functions @gol
1046 -msave-toc-indirect  -mno-save-toc-indirect @gol
1047 -mpower8-fusion  -mno-mpower8-fusion  -mpower8-vector  -mno-power8-vector @gol
1048 -mcrypto  -mno-crypto  -mhtm  -mno-htm  -mdirect-move  -mno-direct-move @gol
1049 -mquad-memory  -mno-quad-memory @gol
1050 -mquad-memory-atomic  -mno-quad-memory-atomic @gol
1051 -mcompat-align-parm  -mno-compat-align-parm @gol
1052 -mfloat128  -mno-float128  -mfloat128-hardware  -mno-float128-hardware @gol
1053 -mgnu-attribute  -mno-gnu-attribute @gol
1054 -mstack-protector-guard=@var{guard} -mstack-protector-guard-reg=@var{reg} @gol
1055 -mstack-protector-guard-offset=@var{offset}}
1057 @emph{RX Options}
1058 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
1059 -mcpu=@gol
1060 -mbig-endian-data  -mlittle-endian-data @gol
1061 -msmall-data @gol
1062 -msim  -mno-sim@gol
1063 -mas100-syntax  -mno-as100-syntax@gol
1064 -mrelax@gol
1065 -mmax-constant-size=@gol
1066 -mint-register=@gol
1067 -mpid@gol
1068 -mallow-string-insns  -mno-allow-string-insns@gol
1069 -mjsr@gol
1070 -mno-warn-multiple-fast-interrupts@gol
1071 -msave-acc-in-interrupts}
1073 @emph{S/390 and zSeries Options}
1074 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1075 -mhard-float  -msoft-float  -mhard-dfp  -mno-hard-dfp @gol
1076 -mlong-double-64  -mlong-double-128 @gol
1077 -mbackchain  -mno-backchain  -mpacked-stack  -mno-packed-stack @gol
1078 -msmall-exec  -mno-small-exec  -mmvcle  -mno-mvcle @gol
1079 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
1080 -mhtm  -mvx  -mzvector @gol
1081 -mtpf-trace  -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
1082 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size  -mstack-guard @gol
1083 -mhotpatch=@var{halfwords},@var{halfwords}}
1085 @emph{Score Options}
1086 @gccoptlist{-meb  -mel @gol
1087 -mnhwloop @gol
1088 -muls @gol
1089 -mmac @gol
1090 -mscore5  -mscore5u  -mscore7  -mscore7d}
1092 @emph{SH Options}
1093 @gccoptlist{-m1  -m2  -m2e @gol
1094 -m2a-nofpu  -m2a-single-only  -m2a-single  -m2a @gol
1095 -m3  -m3e @gol
1096 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
1097 -m4a-nofpu  -m4a-single-only  -m4a-single  -m4a  -m4al @gol
1098 -mb  -ml  -mdalign  -mrelax @gol
1099 -mbigtable  -mfmovd  -mrenesas  -mno-renesas  -mnomacsave @gol
1100 -mieee  -mno-ieee  -mbitops  -misize  -minline-ic_invalidate  -mpadstruct @gol
1101 -mprefergot  -musermode  -multcost=@var{number}  -mdiv=@var{strategy} @gol
1102 -mdivsi3_libfunc=@var{name}  -mfixed-range=@var{register-range} @gol
1103 -maccumulate-outgoing-args @gol
1104 -matomic-model=@var{atomic-model} @gol
1105 -mbranch-cost=@var{num}  -mzdcbranch  -mno-zdcbranch @gol
1106 -mcbranch-force-delay-slot @gol
1107 -mfused-madd  -mno-fused-madd  -mfsca  -mno-fsca  -mfsrra  -mno-fsrra @gol
1108 -mpretend-cmove  -mtas}
1110 @emph{Solaris 2 Options}
1111 @gccoptlist{-mclear-hwcap  -mno-clear-hwcap  -mimpure-text  -mno-impure-text @gol
1112 -pthreads}
1114 @emph{SPARC Options}
1115 @gccoptlist{-mcpu=@var{cpu-type} @gol
1116 -mtune=@var{cpu-type} @gol
1117 -mcmodel=@var{code-model} @gol
1118 -mmemory-model=@var{mem-model} @gol
1119 -m32  -m64  -mapp-regs  -mno-app-regs @gol
1120 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
1121 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1122 -mhard-quad-float  -msoft-quad-float @gol
1123 -mstack-bias  -mno-stack-bias @gol
1124 -mstd-struct-return  -mno-std-struct-return @gol
1125 -munaligned-doubles  -mno-unaligned-doubles @gol
1126 -muser-mode  -mno-user-mode @gol
1127 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
1128 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
1129 -mvis4 -mno-vis4 -mvis4b -mno-vis4b @gol
1130 -mcbcond  -mno-cbcond  -mfmaf  -mno-fmaf  -mfsmuld  -mno-fsmuld  @gol
1131 -mpopc  -mno-popc  -msubxc  -mno-subxc @gol
1132 -mfix-at697f  -mfix-ut699  -mfix-ut700  -mfix-gr712rc @gol
1133 -mlra  -mno-lra}
1135 @emph{SPU Options}
1136 @gccoptlist{-mwarn-reloc  -merror-reloc @gol
1137 -msafe-dma  -munsafe-dma @gol
1138 -mbranch-hints @gol
1139 -msmall-mem  -mlarge-mem  -mstdmain @gol
1140 -mfixed-range=@var{register-range} @gol
1141 -mea32  -mea64 @gol
1142 -maddress-space-conversion  -mno-address-space-conversion @gol
1143 -mcache-size=@var{cache-size} @gol
1144 -matomic-updates  -mno-atomic-updates}
1146 @emph{System V Options}
1147 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
1149 @emph{TILE-Gx Options}
1150 @gccoptlist{-mcpu=CPU  -m32  -m64  -mbig-endian  -mlittle-endian @gol
1151 -mcmodel=@var{code-model}}
1153 @emph{TILEPro Options}
1154 @gccoptlist{-mcpu=@var{cpu}  -m32}
1156 @emph{V850 Options}
1157 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
1158 -mprolog-function  -mno-prolog-function  -mspace @gol
1159 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
1160 -mapp-regs  -mno-app-regs @gol
1161 -mdisable-callt  -mno-disable-callt @gol
1162 -mv850e2v3  -mv850e2  -mv850e1  -mv850es @gol
1163 -mv850e  -mv850  -mv850e3v5 @gol
1164 -mloop @gol
1165 -mrelax @gol
1166 -mlong-jumps @gol
1167 -msoft-float @gol
1168 -mhard-float @gol
1169 -mgcc-abi @gol
1170 -mrh850-abi @gol
1171 -mbig-switch}
1173 @emph{VAX Options}
1174 @gccoptlist{-mg  -mgnu  -munix}
1176 @emph{Visium Options}
1177 @gccoptlist{-mdebug  -msim  -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1178 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type}  -msv-mode  -muser-mode}
1180 @emph{VMS Options}
1181 @gccoptlist{-mvms-return-codes  -mdebug-main=@var{prefix}  -mmalloc64 @gol
1182 -mpointer-size=@var{size}}
1184 @emph{VxWorks Options}
1185 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1186 -Xbind-lazy  -Xbind-now}
1188 @emph{x86 Options}
1189 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1190 -mtune-ctrl=@var{feature-list}  -mdump-tune-features  -mno-default @gol
1191 -mfpmath=@var{unit} @gol
1192 -masm=@var{dialect}  -mno-fancy-math-387 @gol
1193 -mno-fp-ret-in-387  -m80387  -mhard-float  -msoft-float @gol
1194 -mno-wide-multiply  -mrtd  -malign-double @gol
1195 -mpreferred-stack-boundary=@var{num} @gol
1196 -mincoming-stack-boundary=@var{num} @gol
1197 -mcld  -mcx16  -msahf  -mmovbe  -mcrc32 @gol
1198 -mrecip  -mrecip=@var{opt} @gol
1199 -mvzeroupper  -mprefer-avx128 -mprefer-vector-width=@var{opt} @gol
1200 -mmmx  -msse  -msse2  -msse3  -mssse3  -msse4.1  -msse4.2  -msse4  -mavx @gol
1201 -mavx2  -mavx512f  -mavx512pf  -mavx512er  -mavx512cd  -mavx512vl @gol
1202 -mavx512bw  -mavx512dq  -mavx512ifma  -mavx512vbmi  -msha  -maes @gol
1203 -mpclmul  -mfsgsbase  -mrdrnd  -mf16c  -mfma @gol
1204 -mprefetchwt1  -mclflushopt  -mxsavec  -mxsaves @gol
1205 -msse4a  -m3dnow  -m3dnowa  -mpopcnt  -mabm  -mbmi  -mtbm  -mfma4  -mxop @gol
1206 -mlzcnt  -mbmi2  -mfxsr  -mxsave  -mxsaveopt  -mrtm  -mlwp  -mmpx  @gol
1207 -mmwaitx  -mclzero  -mpku  -mthreads -mgfni  -mvaes  @gol
1208 -mcet -mibt -mshstk -mforce-indirect-call -mavx512vbmi2 @gol
1209 -mms-bitfields  -mno-align-stringops  -minline-all-stringops @gol
1210 -minline-stringops-dynamically  -mstringop-strategy=@var{alg} @gol
1211 -mmemcpy-strategy=@var{strategy}  -mmemset-strategy=@var{strategy} @gol
1212 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
1213 -m96bit-long-double  -mlong-double-64  -mlong-double-80  -mlong-double-128 @gol
1214 -mregparm=@var{num}  -msseregparm @gol
1215 -mveclibabi=@var{type}  -mvect8-ret-in-mem @gol
1216 -mpc32  -mpc64  -mpc80  -mstackrealign @gol
1217 -momit-leaf-frame-pointer  -mno-red-zone  -mno-tls-direct-seg-refs @gol
1218 -mcmodel=@var{code-model}  -mabi=@var{name}  -maddress-mode=@var{mode} @gol
1219 -m32  -m64  -mx32  -m16  -miamcu  -mlarge-data-threshold=@var{num} @gol
1220 -msse2avx  -mfentry  -mrecord-mcount  -mnop-mcount  -m8bit-idiv @gol
1221 -mavx256-split-unaligned-load  -mavx256-split-unaligned-store @gol
1222 -malign-data=@var{type}  -mstack-protector-guard=@var{guard} @gol
1223 -mstack-protector-guard-reg=@var{reg} @gol
1224 -mstack-protector-guard-offset=@var{offset} @gol
1225 -mstack-protector-guard-symbol=@var{symbol} -mmitigate-rop @gol
1226 -mgeneral-regs-only  -mcall-ms2sysv-xlogues}
1228 @emph{x86 Windows Options}
1229 @gccoptlist{-mconsole  -mcygwin  -mno-cygwin  -mdll @gol
1230 -mnop-fun-dllimport  -mthread @gol
1231 -municode  -mwin32  -mwindows  -fno-set-stack-executable}
1233 @emph{Xstormy16 Options}
1234 @gccoptlist{-msim}
1236 @emph{Xtensa Options}
1237 @gccoptlist{-mconst16  -mno-const16 @gol
1238 -mfused-madd  -mno-fused-madd @gol
1239 -mforce-no-pic @gol
1240 -mserialize-volatile  -mno-serialize-volatile @gol
1241 -mtext-section-literals  -mno-text-section-literals @gol
1242 -mauto-litpools  -mno-auto-litpools @gol
1243 -mtarget-align  -mno-target-align @gol
1244 -mlongcalls  -mno-longcalls}
1246 @emph{zSeries Options}
1247 See S/390 and zSeries Options.
1248 @end table
1251 @node Overall Options
1252 @section Options Controlling the Kind of Output
1254 Compilation can involve up to four stages: preprocessing, compilation
1255 proper, assembly and linking, always in that order.  GCC is capable of
1256 preprocessing and compiling several files either into several
1257 assembler input files, or into one assembler input file; then each
1258 assembler input file produces an object file, and linking combines all
1259 the object files (those newly compiled, and those specified as input)
1260 into an executable file.
1262 @cindex file name suffix
1263 For any given input file, the file name suffix determines what kind of
1264 compilation is done:
1266 @table @gcctabopt
1267 @item @var{file}.c
1268 C source code that must be preprocessed.
1270 @item @var{file}.i
1271 C source code that should not be preprocessed.
1273 @item @var{file}.ii
1274 C++ source code that should not be preprocessed.
1276 @item @var{file}.m
1277 Objective-C source code.  Note that you must link with the @file{libobjc}
1278 library to make an Objective-C program work.
1280 @item @var{file}.mi
1281 Objective-C source code that should not be preprocessed.
1283 @item @var{file}.mm
1284 @itemx @var{file}.M
1285 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1286 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1287 to a literal capital M@.
1289 @item @var{file}.mii
1290 Objective-C++ source code that should not be preprocessed.
1292 @item @var{file}.h
1293 C, C++, Objective-C or Objective-C++ header file to be turned into a
1294 precompiled header (default), or C, C++ header file to be turned into an
1295 Ada spec (via the @option{-fdump-ada-spec} switch).
1297 @item @var{file}.cc
1298 @itemx @var{file}.cp
1299 @itemx @var{file}.cxx
1300 @itemx @var{file}.cpp
1301 @itemx @var{file}.CPP
1302 @itemx @var{file}.c++
1303 @itemx @var{file}.C
1304 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1305 the last two letters must both be literally @samp{x}.  Likewise,
1306 @samp{.C} refers to a literal capital C@.
1308 @item @var{file}.mm
1309 @itemx @var{file}.M
1310 Objective-C++ source code that must be preprocessed.
1312 @item @var{file}.mii
1313 Objective-C++ source code that should not be preprocessed.
1315 @item @var{file}.hh
1316 @itemx @var{file}.H
1317 @itemx @var{file}.hp
1318 @itemx @var{file}.hxx
1319 @itemx @var{file}.hpp
1320 @itemx @var{file}.HPP
1321 @itemx @var{file}.h++
1322 @itemx @var{file}.tcc
1323 C++ header file to be turned into a precompiled header or Ada spec.
1325 @item @var{file}.f
1326 @itemx @var{file}.for
1327 @itemx @var{file}.ftn
1328 Fixed form Fortran source code that should not be preprocessed.
1330 @item @var{file}.F
1331 @itemx @var{file}.FOR
1332 @itemx @var{file}.fpp
1333 @itemx @var{file}.FPP
1334 @itemx @var{file}.FTN
1335 Fixed form Fortran source code that must be preprocessed (with the traditional
1336 preprocessor).
1338 @item @var{file}.f90
1339 @itemx @var{file}.f95
1340 @itemx @var{file}.f03
1341 @itemx @var{file}.f08
1342 Free form Fortran source code that should not be preprocessed.
1344 @item @var{file}.F90
1345 @itemx @var{file}.F95
1346 @itemx @var{file}.F03
1347 @itemx @var{file}.F08
1348 Free form Fortran source code that must be preprocessed (with the
1349 traditional preprocessor).
1351 @item @var{file}.go
1352 Go source code.
1354 @item @var{file}.brig
1355 BRIG files (binary representation of HSAIL).
1357 @item @var{file}.ads
1358 Ada source code file that contains a library unit declaration (a
1359 declaration of a package, subprogram, or generic, or a generic
1360 instantiation), or a library unit renaming declaration (a package,
1361 generic, or subprogram renaming declaration).  Such files are also
1362 called @dfn{specs}.
1364 @item @var{file}.adb
1365 Ada source code file containing a library unit body (a subprogram or
1366 package body).  Such files are also called @dfn{bodies}.
1368 @c GCC also knows about some suffixes for languages not yet included:
1369 @c Pascal:
1370 @c @var{file}.p
1371 @c @var{file}.pas
1372 @c Ratfor:
1373 @c @var{file}.r
1375 @item @var{file}.s
1376 Assembler code.
1378 @item @var{file}.S
1379 @itemx @var{file}.sx
1380 Assembler code that must be preprocessed.
1382 @item @var{other}
1383 An object file to be fed straight into linking.
1384 Any file name with no recognized suffix is treated this way.
1385 @end table
1387 @opindex x
1388 You can specify the input language explicitly with the @option{-x} option:
1390 @table @gcctabopt
1391 @item -x @var{language}
1392 Specify explicitly the @var{language} for the following input files
1393 (rather than letting the compiler choose a default based on the file
1394 name suffix).  This option applies to all following input files until
1395 the next @option{-x} option.  Possible values for @var{language} are:
1396 @smallexample
1397 c  c-header  cpp-output
1398 c++  c++-header  c++-cpp-output
1399 objective-c  objective-c-header  objective-c-cpp-output
1400 objective-c++ objective-c++-header objective-c++-cpp-output
1401 assembler  assembler-with-cpp
1403 f77  f77-cpp-input f95  f95-cpp-input
1405 brig
1406 @end smallexample
1408 @item -x none
1409 Turn off any specification of a language, so that subsequent files are
1410 handled according to their file name suffixes (as they are if @option{-x}
1411 has not been used at all).
1412 @end table
1414 If you only want some of the stages of compilation, you can use
1415 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1416 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1417 @command{gcc} is to stop.  Note that some combinations (for example,
1418 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1420 @table @gcctabopt
1421 @item -c
1422 @opindex c
1423 Compile or assemble the source files, but do not link.  The linking
1424 stage simply is not done.  The ultimate output is in the form of an
1425 object file for each source file.
1427 By default, the object file name for a source file is made by replacing
1428 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1430 Unrecognized input files, not requiring compilation or assembly, are
1431 ignored.
1433 @item -S
1434 @opindex S
1435 Stop after the stage of compilation proper; do not assemble.  The output
1436 is in the form of an assembler code file for each non-assembler input
1437 file specified.
1439 By default, the assembler file name for a source file is made by
1440 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1442 Input files that don't require compilation are ignored.
1444 @item -E
1445 @opindex E
1446 Stop after the preprocessing stage; do not run the compiler proper.  The
1447 output is in the form of preprocessed source code, which is sent to the
1448 standard output.
1450 Input files that don't require preprocessing are ignored.
1452 @cindex output file option
1453 @item -o @var{file}
1454 @opindex o
1455 Place output in file @var{file}.  This applies to whatever
1456 sort of output is being produced, whether it be an executable file,
1457 an object file, an assembler file or preprocessed C code.
1459 If @option{-o} is not specified, the default is to put an executable
1460 file in @file{a.out}, the object file for
1461 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1462 assembler file in @file{@var{source}.s}, a precompiled header file in
1463 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1464 standard output.
1466 @item -v
1467 @opindex v
1468 Print (on standard error output) the commands executed to run the stages
1469 of compilation.  Also print the version number of the compiler driver
1470 program and of the preprocessor and the compiler proper.
1472 @item -###
1473 @opindex ###
1474 Like @option{-v} except the commands are not executed and arguments
1475 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1476 This is useful for shell scripts to capture the driver-generated command lines.
1478 @item --help
1479 @opindex help
1480 Print (on the standard output) a description of the command-line options
1481 understood by @command{gcc}.  If the @option{-v} option is also specified
1482 then @option{--help} is also passed on to the various processes
1483 invoked by @command{gcc}, so that they can display the command-line options
1484 they accept.  If the @option{-Wextra} option has also been specified
1485 (prior to the @option{--help} option), then command-line options that
1486 have no documentation associated with them are also displayed.
1488 @item --target-help
1489 @opindex target-help
1490 Print (on the standard output) a description of target-specific command-line
1491 options for each tool.  For some targets extra target-specific
1492 information may also be printed.
1494 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1495 Print (on the standard output) a description of the command-line
1496 options understood by the compiler that fit into all specified classes
1497 and qualifiers.  These are the supported classes:
1499 @table @asis
1500 @item @samp{optimizers}
1501 Display all of the optimization options supported by the
1502 compiler.
1504 @item @samp{warnings}
1505 Display all of the options controlling warning messages
1506 produced by the compiler.
1508 @item @samp{target}
1509 Display target-specific options.  Unlike the
1510 @option{--target-help} option however, target-specific options of the
1511 linker and assembler are not displayed.  This is because those
1512 tools do not currently support the extended @option{--help=} syntax.
1514 @item @samp{params}
1515 Display the values recognized by the @option{--param}
1516 option.
1518 @item @var{language}
1519 Display the options supported for @var{language}, where
1520 @var{language} is the name of one of the languages supported in this
1521 version of GCC@.
1523 @item @samp{common}
1524 Display the options that are common to all languages.
1525 @end table
1527 These are the supported qualifiers:
1529 @table @asis
1530 @item @samp{undocumented}
1531 Display only those options that are undocumented.
1533 @item @samp{joined}
1534 Display options taking an argument that appears after an equal
1535 sign in the same continuous piece of text, such as:
1536 @samp{--help=target}.
1538 @item @samp{separate}
1539 Display options taking an argument that appears as a separate word
1540 following the original option, such as: @samp{-o output-file}.
1541 @end table
1543 Thus for example to display all the undocumented target-specific
1544 switches supported by the compiler, use:
1546 @smallexample
1547 --help=target,undocumented
1548 @end smallexample
1550 The sense of a qualifier can be inverted by prefixing it with the
1551 @samp{^} character, so for example to display all binary warning
1552 options (i.e., ones that are either on or off and that do not take an
1553 argument) that have a description, use:
1555 @smallexample
1556 --help=warnings,^joined,^undocumented
1557 @end smallexample
1559 The argument to @option{--help=} should not consist solely of inverted
1560 qualifiers.
1562 Combining several classes is possible, although this usually
1563 restricts the output so much that there is nothing to display.  One
1564 case where it does work, however, is when one of the classes is
1565 @var{target}.  For example, to display all the target-specific
1566 optimization options, use:
1568 @smallexample
1569 --help=target,optimizers
1570 @end smallexample
1572 The @option{--help=} option can be repeated on the command line.  Each
1573 successive use displays its requested class of options, skipping
1574 those that have already been displayed.
1576 If the @option{-Q} option appears on the command line before the
1577 @option{--help=} option, then the descriptive text displayed by
1578 @option{--help=} is changed.  Instead of describing the displayed
1579 options, an indication is given as to whether the option is enabled,
1580 disabled or set to a specific value (assuming that the compiler
1581 knows this at the point where the @option{--help=} option is used).
1583 Here is a truncated example from the ARM port of @command{gcc}:
1585 @smallexample
1586   % gcc -Q -mabi=2 --help=target -c
1587   The following options are target specific:
1588   -mabi=                                2
1589   -mabort-on-noreturn                   [disabled]
1590   -mapcs                                [disabled]
1591 @end smallexample
1593 The output is sensitive to the effects of previous command-line
1594 options, so for example it is possible to find out which optimizations
1595 are enabled at @option{-O2} by using:
1597 @smallexample
1598 -Q -O2 --help=optimizers
1599 @end smallexample
1601 Alternatively you can discover which binary optimizations are enabled
1602 by @option{-O3} by using:
1604 @smallexample
1605 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1606 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1607 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1608 @end smallexample
1610 @item --version
1611 @opindex version
1612 Display the version number and copyrights of the invoked GCC@.
1614 @item -pass-exit-codes
1615 @opindex pass-exit-codes
1616 Normally the @command{gcc} program exits with the code of 1 if any
1617 phase of the compiler returns a non-success return code.  If you specify
1618 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1619 the numerically highest error produced by any phase returning an error
1620 indication.  The C, C++, and Fortran front ends return 4 if an internal
1621 compiler error is encountered.
1623 @item -pipe
1624 @opindex pipe
1625 Use pipes rather than temporary files for communication between the
1626 various stages of compilation.  This fails to work on some systems where
1627 the assembler is unable to read from a pipe; but the GNU assembler has
1628 no trouble.
1630 @item -specs=@var{file}
1631 @opindex specs
1632 Process @var{file} after the compiler reads in the standard @file{specs}
1633 file, in order to override the defaults which the @command{gcc} driver
1634 program uses when determining what switches to pass to @command{cc1},
1635 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
1636 @option{-specs=@var{file}} can be specified on the command line, and they
1637 are processed in order, from left to right.  @xref{Spec Files}, for
1638 information about the format of the @var{file}.
1640 @item -wrapper
1641 @opindex wrapper
1642 Invoke all subcommands under a wrapper program.  The name of the
1643 wrapper program and its parameters are passed as a comma separated
1644 list.
1646 @smallexample
1647 gcc -c t.c -wrapper gdb,--args
1648 @end smallexample
1650 @noindent
1651 This invokes all subprograms of @command{gcc} under
1652 @samp{gdb --args}, thus the invocation of @command{cc1} is
1653 @samp{gdb --args cc1 @dots{}}.
1655 @item -fplugin=@var{name}.so
1656 @opindex fplugin
1657 Load the plugin code in file @var{name}.so, assumed to be a
1658 shared object to be dlopen'd by the compiler.  The base name of
1659 the shared object file is used to identify the plugin for the
1660 purposes of argument parsing (See
1661 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1662 Each plugin should define the callback functions specified in the
1663 Plugins API.
1665 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1666 @opindex fplugin-arg
1667 Define an argument called @var{key} with a value of @var{value}
1668 for the plugin called @var{name}.
1670 @item -fdump-ada-spec@r{[}-slim@r{]}
1671 @opindex fdump-ada-spec
1672 For C and C++ source and include files, generate corresponding Ada specs.
1673 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1674 GNAT User's Guide}, which provides detailed documentation on this feature.
1676 @item -fada-spec-parent=@var{unit}
1677 @opindex fada-spec-parent
1678 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1679 Ada specs as child units of parent @var{unit}.
1681 @item -fdump-go-spec=@var{file}
1682 @opindex fdump-go-spec
1683 For input files in any language, generate corresponding Go
1684 declarations in @var{file}.  This generates Go @code{const},
1685 @code{type}, @code{var}, and @code{func} declarations which may be a
1686 useful way to start writing a Go interface to code written in some
1687 other language.
1689 @include @value{srcdir}/../libiberty/at-file.texi
1690 @end table
1692 @node Invoking G++
1693 @section Compiling C++ Programs
1695 @cindex suffixes for C++ source
1696 @cindex C++ source file suffixes
1697 C++ source files conventionally use one of the suffixes @samp{.C},
1698 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1699 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1700 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1701 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1702 files with these names and compiles them as C++ programs even if you
1703 call the compiler the same way as for compiling C programs (usually
1704 with the name @command{gcc}).
1706 @findex g++
1707 @findex c++
1708 However, the use of @command{gcc} does not add the C++ library.
1709 @command{g++} is a program that calls GCC and automatically specifies linking
1710 against the C++ library.  It treats @samp{.c},
1711 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1712 files unless @option{-x} is used.  This program is also useful when
1713 precompiling a C header file with a @samp{.h} extension for use in C++
1714 compilations.  On many systems, @command{g++} is also installed with
1715 the name @command{c++}.
1717 @cindex invoking @command{g++}
1718 When you compile C++ programs, you may specify many of the same
1719 command-line options that you use for compiling programs in any
1720 language; or command-line options meaningful for C and related
1721 languages; or options that are meaningful only for C++ programs.
1722 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1723 explanations of options for languages related to C@.
1724 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1725 explanations of options that are meaningful only for C++ programs.
1727 @node C Dialect Options
1728 @section Options Controlling C Dialect
1729 @cindex dialect options
1730 @cindex language dialect options
1731 @cindex options, dialect
1733 The following options control the dialect of C (or languages derived
1734 from C, such as C++, Objective-C and Objective-C++) that the compiler
1735 accepts:
1737 @table @gcctabopt
1738 @cindex ANSI support
1739 @cindex ISO support
1740 @item -ansi
1741 @opindex ansi
1742 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1743 equivalent to @option{-std=c++98}.
1745 This turns off certain features of GCC that are incompatible with ISO
1746 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1747 such as the @code{asm} and @code{typeof} keywords, and
1748 predefined macros such as @code{unix} and @code{vax} that identify the
1749 type of system you are using.  It also enables the undesirable and
1750 rarely used ISO trigraph feature.  For the C compiler,
1751 it disables recognition of C++ style @samp{//} comments as well as
1752 the @code{inline} keyword.
1754 The alternate keywords @code{__asm__}, @code{__extension__},
1755 @code{__inline__} and @code{__typeof__} continue to work despite
1756 @option{-ansi}.  You would not want to use them in an ISO C program, of
1757 course, but it is useful to put them in header files that might be included
1758 in compilations done with @option{-ansi}.  Alternate predefined macros
1759 such as @code{__unix__} and @code{__vax__} are also available, with or
1760 without @option{-ansi}.
1762 The @option{-ansi} option does not cause non-ISO programs to be
1763 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1764 addition to @option{-ansi}.  @xref{Warning Options}.
1766 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1767 option is used.  Some header files may notice this macro and refrain
1768 from declaring certain functions or defining certain macros that the
1769 ISO standard doesn't call for; this is to avoid interfering with any
1770 programs that might use these names for other things.
1772 Functions that are normally built in but do not have semantics
1773 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1774 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1775 built-in functions provided by GCC}, for details of the functions
1776 affected.
1778 @item -std=
1779 @opindex std
1780 Determine the language standard. @xref{Standards,,Language Standards
1781 Supported by GCC}, for details of these standard versions.  This option
1782 is currently only supported when compiling C or C++.
1784 The compiler can accept several base standards, such as @samp{c90} or
1785 @samp{c++98}, and GNU dialects of those standards, such as
1786 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1787 compiler accepts all programs following that standard plus those
1788 using GNU extensions that do not contradict it.  For example,
1789 @option{-std=c90} turns off certain features of GCC that are
1790 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1791 keywords, but not other GNU extensions that do not have a meaning in
1792 ISO C90, such as omitting the middle term of a @code{?:}
1793 expression. On the other hand, when a GNU dialect of a standard is
1794 specified, all features supported by the compiler are enabled, even when
1795 those features change the meaning of the base standard.  As a result, some
1796 strict-conforming programs may be rejected.  The particular standard
1797 is used by @option{-Wpedantic} to identify which features are GNU
1798 extensions given that version of the standard. For example
1799 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1800 comments, while @option{-std=gnu99 -Wpedantic} does not.
1802 A value for this option must be provided; possible values are
1804 @table @samp
1805 @item c90
1806 @itemx c89
1807 @itemx iso9899:1990
1808 Support all ISO C90 programs (certain GNU extensions that conflict
1809 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1811 @item iso9899:199409
1812 ISO C90 as modified in amendment 1.
1814 @item c99
1815 @itemx c9x
1816 @itemx iso9899:1999
1817 @itemx iso9899:199x
1818 ISO C99.  This standard is substantially completely supported, modulo
1819 bugs and floating-point issues
1820 (mainly but not entirely relating to optional C99 features from
1821 Annexes F and G).  See
1822 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1823 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1825 @item c11
1826 @itemx c1x
1827 @itemx iso9899:2011
1828 ISO C11, the 2011 revision of the ISO C standard.  This standard is
1829 substantially completely supported, modulo bugs, floating-point issues
1830 (mainly but not entirely relating to optional C11 features from
1831 Annexes F and G) and the optional Annexes K (Bounds-checking
1832 interfaces) and L (Analyzability).  The name @samp{c1x} is deprecated.
1834 @item c17
1835 @itemx c18
1836 @itemx iso9899:2017
1837 @itemx iso9899:2018
1838 ISO C17, the 2017 revision of the ISO C standard (expected to be
1839 published in 2018).  This standard is
1840 same as C11 except for corrections of defects (all of which are also
1841 applied with @option{-std=c11}) and a new value of
1842 @code{__STDC_VERSION__}, and so is supported to the same extent as C11.
1844 @item gnu90
1845 @itemx gnu89
1846 GNU dialect of ISO C90 (including some C99 features).
1848 @item gnu99
1849 @itemx gnu9x
1850 GNU dialect of ISO C99.  The name @samp{gnu9x} is deprecated.
1852 @item gnu11
1853 @itemx gnu1x
1854 GNU dialect of ISO C11.
1855 The name @samp{gnu1x} is deprecated.
1857 @item gnu17
1858 @itemx gnu18
1859 GNU dialect of ISO C17.  This is the default for C code.
1861 @item c++98
1862 @itemx c++03
1863 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1864 additional defect reports. Same as @option{-ansi} for C++ code.
1866 @item gnu++98
1867 @itemx gnu++03
1868 GNU dialect of @option{-std=c++98}.
1870 @item c++11
1871 @itemx c++0x
1872 The 2011 ISO C++ standard plus amendments.
1873 The name @samp{c++0x} is deprecated.
1875 @item gnu++11
1876 @itemx gnu++0x
1877 GNU dialect of @option{-std=c++11}.
1878 The name @samp{gnu++0x} is deprecated.
1880 @item c++14
1881 @itemx c++1y
1882 The 2014 ISO C++ standard plus amendments.
1883 The name @samp{c++1y} is deprecated.
1885 @item gnu++14
1886 @itemx gnu++1y
1887 GNU dialect of @option{-std=c++14}.
1888 This is the default for C++ code.
1889 The name @samp{gnu++1y} is deprecated.
1891 @item c++17
1892 @itemx c++1z
1893 The 2017 ISO C++ standard plus amendments.
1894 The name @samp{c++1z} is deprecated.
1896 @item gnu++17
1897 @itemx gnu++1z
1898 GNU dialect of @option{-std=c++17}.
1899 The name @samp{gnu++1z} is deprecated.
1901 @item c++2a
1902 The next revision of the ISO C++ standard, tentatively planned for
1903 2020.  Support is highly experimental, and will almost certainly
1904 change in incompatible ways in future releases.
1906 @item gnu++2a
1907 GNU dialect of @option{-std=c++2a}.  Support is highly experimental,
1908 and will almost certainly change in incompatible ways in future
1909 releases.
1910 @end table
1912 @item -fgnu89-inline
1913 @opindex fgnu89-inline
1914 The option @option{-fgnu89-inline} tells GCC to use the traditional
1915 GNU semantics for @code{inline} functions when in C99 mode.
1916 @xref{Inline,,An Inline Function is As Fast As a Macro}.
1917 Using this option is roughly equivalent to adding the
1918 @code{gnu_inline} function attribute to all inline functions
1919 (@pxref{Function Attributes}).
1921 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1922 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1923 specifies the default behavior).
1924 This option is not supported in @option{-std=c90} or
1925 @option{-std=gnu90} mode.
1927 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1928 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1929 in effect for @code{inline} functions.  @xref{Common Predefined
1930 Macros,,,cpp,The C Preprocessor}.
1932 @item -fpermitted-flt-eval-methods=@var{style}
1933 @opindex fpermitted-flt-eval-methods
1934 @opindex fpermitted-flt-eval-methods=c11
1935 @opindex fpermitted-flt-eval-methods=ts-18661-3
1936 ISO/IEC TS 18661-3 defines new permissible values for
1937 @code{FLT_EVAL_METHOD} that indicate that operations and constants with
1938 a semantic type that is an interchange or extended format should be
1939 evaluated to the precision and range of that type.  These new values are
1940 a superset of those permitted under C99/C11, which does not specify the
1941 meaning of other positive values of @code{FLT_EVAL_METHOD}.  As such, code
1942 conforming to C11 may not have been written expecting the possibility of
1943 the new values.
1945 @option{-fpermitted-flt-eval-methods} specifies whether the compiler
1946 should allow only the values of @code{FLT_EVAL_METHOD} specified in C99/C11,
1947 or the extended set of values specified in ISO/IEC TS 18661-3.
1949 @var{style} is either @code{c11} or @code{ts-18661-3} as appropriate.
1951 The default when in a standards compliant mode (@option{-std=c11} or similar)
1952 is @option{-fpermitted-flt-eval-methods=c11}.  The default when in a GNU
1953 dialect (@option{-std=gnu11} or similar) is
1954 @option{-fpermitted-flt-eval-methods=ts-18661-3}.
1956 @item -aux-info @var{filename}
1957 @opindex aux-info
1958 Output to the given filename prototyped declarations for all functions
1959 declared and/or defined in a translation unit, including those in header
1960 files.  This option is silently ignored in any language other than C@.
1962 Besides declarations, the file indicates, in comments, the origin of
1963 each declaration (source file and line), whether the declaration was
1964 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1965 @samp{O} for old, respectively, in the first character after the line
1966 number and the colon), and whether it came from a declaration or a
1967 definition (@samp{C} or @samp{F}, respectively, in the following
1968 character).  In the case of function definitions, a K&R-style list of
1969 arguments followed by their declarations is also provided, inside
1970 comments, after the declaration.
1972 @item -fallow-parameterless-variadic-functions
1973 @opindex fallow-parameterless-variadic-functions
1974 Accept variadic functions without named parameters.
1976 Although it is possible to define such a function, this is not very
1977 useful as it is not possible to read the arguments.  This is only
1978 supported for C as this construct is allowed by C++.
1980 @item -fno-asm
1981 @opindex fno-asm
1982 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1983 keyword, so that code can use these words as identifiers.  You can use
1984 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1985 instead.  @option{-ansi} implies @option{-fno-asm}.
1987 In C++, this switch only affects the @code{typeof} keyword, since
1988 @code{asm} and @code{inline} are standard keywords.  You may want to
1989 use the @option{-fno-gnu-keywords} flag instead, which has the same
1990 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1991 switch only affects the @code{asm} and @code{typeof} keywords, since
1992 @code{inline} is a standard keyword in ISO C99.
1994 @item -fno-builtin
1995 @itemx -fno-builtin-@var{function}
1996 @opindex fno-builtin
1997 @cindex built-in functions
1998 Don't recognize built-in functions that do not begin with
1999 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
2000 functions provided by GCC}, for details of the functions affected,
2001 including those which are not built-in functions when @option{-ansi} or
2002 @option{-std} options for strict ISO C conformance are used because they
2003 do not have an ISO standard meaning.
2005 GCC normally generates special code to handle certain built-in functions
2006 more efficiently; for instance, calls to @code{alloca} may become single
2007 instructions which adjust the stack directly, and calls to @code{memcpy}
2008 may become inline copy loops.  The resulting code is often both smaller
2009 and faster, but since the function calls no longer appear as such, you
2010 cannot set a breakpoint on those calls, nor can you change the behavior
2011 of the functions by linking with a different library.  In addition,
2012 when a function is recognized as a built-in function, GCC may use
2013 information about that function to warn about problems with calls to
2014 that function, or to generate more efficient code, even if the
2015 resulting code still contains calls to that function.  For example,
2016 warnings are given with @option{-Wformat} for bad calls to
2017 @code{printf} when @code{printf} is built in and @code{strlen} is
2018 known not to modify global memory.
2020 With the @option{-fno-builtin-@var{function}} option
2021 only the built-in function @var{function} is
2022 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
2023 function is named that is not built-in in this version of GCC, this
2024 option is ignored.  There is no corresponding
2025 @option{-fbuiltin-@var{function}} option; if you wish to enable
2026 built-in functions selectively when using @option{-fno-builtin} or
2027 @option{-ffreestanding}, you may define macros such as:
2029 @smallexample
2030 #define abs(n)          __builtin_abs ((n))
2031 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
2032 @end smallexample
2034 @item -fgimple
2035 @opindex fgimple
2037 Enable parsing of function definitions marked with @code{__GIMPLE}.
2038 This is an experimental feature that allows unit testing of GIMPLE
2039 passes.
2041 @item -fhosted
2042 @opindex fhosted
2043 @cindex hosted environment
2045 Assert that compilation targets a hosted environment.  This implies
2046 @option{-fbuiltin}.  A hosted environment is one in which the
2047 entire standard library is available, and in which @code{main} has a return
2048 type of @code{int}.  Examples are nearly everything except a kernel.
2049 This is equivalent to @option{-fno-freestanding}.
2051 @item -ffreestanding
2052 @opindex ffreestanding
2053 @cindex hosted environment
2055 Assert that compilation targets a freestanding environment.  This
2056 implies @option{-fno-builtin}.  A freestanding environment
2057 is one in which the standard library may not exist, and program startup may
2058 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
2059 This is equivalent to @option{-fno-hosted}.
2061 @xref{Standards,,Language Standards Supported by GCC}, for details of
2062 freestanding and hosted environments.
2064 @item -fopenacc
2065 @opindex fopenacc
2066 @cindex OpenACC accelerator programming
2067 Enable handling of OpenACC directives @code{#pragma acc} in C/C++ and
2068 @code{!$acc} in Fortran.  When @option{-fopenacc} is specified, the
2069 compiler generates accelerated code according to the OpenACC Application
2070 Programming Interface v2.0 @w{@uref{https://www.openacc.org}}.  This option
2071 implies @option{-pthread}, and thus is only supported on targets that
2072 have support for @option{-pthread}.
2074 @item -fopenacc-dim=@var{geom}
2075 @opindex fopenacc-dim
2076 @cindex OpenACC accelerator programming
2077 Specify default compute dimensions for parallel offload regions that do
2078 not explicitly specify.  The @var{geom} value is a triple of
2079 ':'-separated sizes, in order 'gang', 'worker' and, 'vector'.  A size
2080 can be omitted, to use a target-specific default value.
2082 @item -fopenmp
2083 @opindex fopenmp
2084 @cindex OpenMP parallel
2085 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
2086 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
2087 compiler generates parallel code according to the OpenMP Application
2088 Program Interface v4.5 @w{@uref{http://www.openmp.org/}}.  This option
2089 implies @option{-pthread}, and thus is only supported on targets that
2090 have support for @option{-pthread}. @option{-fopenmp} implies
2091 @option{-fopenmp-simd}.
2093 @item -fopenmp-simd
2094 @opindex fopenmp-simd
2095 @cindex OpenMP SIMD
2096 @cindex SIMD
2097 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
2098 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
2099 are ignored.
2101 @item -fgnu-tm
2102 @opindex fgnu-tm
2103 When the option @option{-fgnu-tm} is specified, the compiler
2104 generates code for the Linux variant of Intel's current Transactional
2105 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
2106 an experimental feature whose interface may change in future versions
2107 of GCC, as the official specification changes.  Please note that not
2108 all architectures are supported for this feature.
2110 For more information on GCC's support for transactional memory,
2111 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
2112 Transactional Memory Library}.
2114 Note that the transactional memory feature is not supported with
2115 non-call exceptions (@option{-fnon-call-exceptions}).
2117 @item -fms-extensions
2118 @opindex fms-extensions
2119 Accept some non-standard constructs used in Microsoft header files.
2121 In C++ code, this allows member names in structures to be similar
2122 to previous types declarations.
2124 @smallexample
2125 typedef int UOW;
2126 struct ABC @{
2127   UOW UOW;
2129 @end smallexample
2131 Some cases of unnamed fields in structures and unions are only
2132 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
2133 fields within structs/unions}, for details.
2135 Note that this option is off for all targets but x86 
2136 targets using ms-abi.
2138 @item -fplan9-extensions
2139 @opindex fplan9-extensions
2140 Accept some non-standard constructs used in Plan 9 code.
2142 This enables @option{-fms-extensions}, permits passing pointers to
2143 structures with anonymous fields to functions that expect pointers to
2144 elements of the type of the field, and permits referring to anonymous
2145 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
2146 struct/union fields within structs/unions}, for details.  This is only
2147 supported for C, not C++.
2149 @item -fcond-mismatch
2150 @opindex fcond-mismatch
2151 Allow conditional expressions with mismatched types in the second and
2152 third arguments.  The value of such an expression is void.  This option
2153 is not supported for C++.
2155 @item -flax-vector-conversions
2156 @opindex flax-vector-conversions
2157 Allow implicit conversions between vectors with differing numbers of
2158 elements and/or incompatible element types.  This option should not be
2159 used for new code.
2161 @item -funsigned-char
2162 @opindex funsigned-char
2163 Let the type @code{char} be unsigned, like @code{unsigned char}.
2165 Each kind of machine has a default for what @code{char} should
2166 be.  It is either like @code{unsigned char} by default or like
2167 @code{signed char} by default.
2169 Ideally, a portable program should always use @code{signed char} or
2170 @code{unsigned char} when it depends on the signedness of an object.
2171 But many programs have been written to use plain @code{char} and
2172 expect it to be signed, or expect it to be unsigned, depending on the
2173 machines they were written for.  This option, and its inverse, let you
2174 make such a program work with the opposite default.
2176 The type @code{char} is always a distinct type from each of
2177 @code{signed char} or @code{unsigned char}, even though its behavior
2178 is always just like one of those two.
2180 @item -fsigned-char
2181 @opindex fsigned-char
2182 Let the type @code{char} be signed, like @code{signed char}.
2184 Note that this is equivalent to @option{-fno-unsigned-char}, which is
2185 the negative form of @option{-funsigned-char}.  Likewise, the option
2186 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
2188 @item -fsigned-bitfields
2189 @itemx -funsigned-bitfields
2190 @itemx -fno-signed-bitfields
2191 @itemx -fno-unsigned-bitfields
2192 @opindex fsigned-bitfields
2193 @opindex funsigned-bitfields
2194 @opindex fno-signed-bitfields
2195 @opindex fno-unsigned-bitfields
2196 These options control whether a bit-field is signed or unsigned, when the
2197 declaration does not use either @code{signed} or @code{unsigned}.  By
2198 default, such a bit-field is signed, because this is consistent: the
2199 basic integer types such as @code{int} are signed types.
2201 @item -fsso-struct=@var{endianness}
2202 @opindex fsso-struct
2203 Set the default scalar storage order of structures and unions to the
2204 specified endianness.  The accepted values are @samp{big-endian},
2205 @samp{little-endian} and @samp{native} for the native endianness of
2206 the target (the default).  This option is not supported for C++.
2208 @strong{Warning:} the @option{-fsso-struct} switch causes GCC to generate
2209 code that is not binary compatible with code generated without it if the
2210 specified endianness is not the native endianness of the target.
2211 @end table
2213 @node C++ Dialect Options
2214 @section Options Controlling C++ Dialect
2216 @cindex compiler options, C++
2217 @cindex C++ options, command-line
2218 @cindex options, C++
2219 This section describes the command-line options that are only meaningful
2220 for C++ programs.  You can also use most of the GNU compiler options
2221 regardless of what language your program is in.  For example, you
2222 might compile a file @file{firstClass.C} like this:
2224 @smallexample
2225 g++ -g -fstrict-enums -O -c firstClass.C
2226 @end smallexample
2228 @noindent
2229 In this example, only @option{-fstrict-enums} is an option meant
2230 only for C++ programs; you can use the other options with any
2231 language supported by GCC@.
2233 Some options for compiling C programs, such as @option{-std}, are also
2234 relevant for C++ programs.
2235 @xref{C Dialect Options,,Options Controlling C Dialect}.
2237 Here is a list of options that are @emph{only} for compiling C++ programs:
2239 @table @gcctabopt
2241 @item -fabi-version=@var{n}
2242 @opindex fabi-version
2243 Use version @var{n} of the C++ ABI@.  The default is version 0.
2245 Version 0 refers to the version conforming most closely to
2246 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2247 will change in different versions of G++ as ABI bugs are fixed.
2249 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.
2251 Version 2 is the version of the C++ ABI that first appeared in G++
2252 3.4, and was the default through G++ 4.9.
2254 Version 3 corrects an error in mangling a constant address as a
2255 template argument.
2257 Version 4, which first appeared in G++ 4.5, implements a standard
2258 mangling for vector types.
2260 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2261 attribute const/volatile on function pointer types, decltype of a
2262 plain decl, and use of a function parameter in the declaration of
2263 another parameter.
2265 Version 6, which first appeared in G++ 4.7, corrects the promotion
2266 behavior of C++11 scoped enums and the mangling of template argument
2267 packs, const/static_cast, prefix ++ and --, and a class scope function
2268 used as a template argument.
2270 Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a
2271 builtin type and corrects the mangling of lambdas in default argument
2272 scope.
2274 Version 8, which first appeared in G++ 4.9, corrects the substitution
2275 behavior of function types with function-cv-qualifiers.
2277 Version 9, which first appeared in G++ 5.2, corrects the alignment of
2278 @code{nullptr_t}.
2280 Version 10, which first appeared in G++ 6.1, adds mangling of
2281 attributes that affect type identity, such as ia32 calling convention
2282 attributes (e.g. @samp{stdcall}).
2284 Version 11, which first appeared in G++ 7, corrects the mangling of
2285 sizeof... expressions and operator names.  For multiple entities with
2286 the same name within a function, that are declared in different scopes,
2287 the mangling now changes starting with the twelfth occurrence.  It also
2288 implies @option{-fnew-inheriting-ctors}.
2290 See also @option{-Wabi}.
2292 @item -fabi-compat-version=@var{n}
2293 @opindex fabi-compat-version
2294 On targets that support strong aliases, G++
2295 works around mangling changes by creating an alias with the correct
2296 mangled name when defining a symbol with an incorrect mangled name.
2297 This switch specifies which ABI version to use for the alias.
2299 With @option{-fabi-version=0} (the default), this defaults to 8 (GCC 5
2300 compatibility).  If another ABI version is explicitly selected, this
2301 defaults to 0.  For compatibility with GCC versions 3.2 through 4.9,
2302 use @option{-fabi-compat-version=2}.
2304 If this option is not provided but @option{-Wabi=@var{n}} is, that
2305 version is used for compatibility aliases.  If this option is provided
2306 along with @option{-Wabi} (without the version), the version from this
2307 option is used for the warning.
2309 @item -fno-access-control
2310 @opindex fno-access-control
2311 Turn off all access checking.  This switch is mainly useful for working
2312 around bugs in the access control code.
2314 @item -faligned-new
2315 @opindex faligned-new
2316 Enable support for C++17 @code{new} of types that require more
2317 alignment than @code{void* ::operator new(std::size_t)} provides.  A
2318 numeric argument such as @code{-faligned-new=32} can be used to
2319 specify how much alignment (in bytes) is provided by that function,
2320 but few users will need to override the default of
2321 @code{alignof(std::max_align_t)}.
2323 This flag is enabled by default for @option{-std=c++17}.
2325 @item -fcheck-new
2326 @opindex fcheck-new
2327 Check that the pointer returned by @code{operator new} is non-null
2328 before attempting to modify the storage allocated.  This check is
2329 normally unnecessary because the C++ standard specifies that
2330 @code{operator new} only returns @code{0} if it is declared
2331 @code{throw()}, in which case the compiler always checks the
2332 return value even without this option.  In all other cases, when
2333 @code{operator new} has a non-empty exception specification, memory
2334 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2335 @samp{new (nothrow)}.
2337 @item -fconcepts
2338 @opindex fconcepts
2339 Enable support for the C++ Extensions for Concepts Technical
2340 Specification, ISO 19217 (2015), which allows code like
2342 @smallexample
2343 template <class T> concept bool Addable = requires (T t) @{ t + t; @};
2344 template <Addable T> T add (T a, T b) @{ return a + b; @}
2345 @end smallexample
2347 @item -fconstexpr-depth=@var{n}
2348 @opindex fconstexpr-depth
2349 Set the maximum nested evaluation depth for C++11 constexpr functions
2350 to @var{n}.  A limit is needed to detect endless recursion during
2351 constant expression evaluation.  The minimum specified by the standard
2352 is 512.
2354 @item -fconstexpr-loop-limit=@var{n}
2355 @opindex fconstexpr-loop-limit
2356 Set the maximum number of iterations for a loop in C++14 constexpr functions
2357 to @var{n}.  A limit is needed to detect infinite loops during
2358 constant expression evaluation.  The default is 262144 (1<<18).
2360 @item -fdeduce-init-list
2361 @opindex fdeduce-init-list
2362 Enable deduction of a template type parameter as
2363 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2365 @smallexample
2366 template <class T> auto forward(T t) -> decltype (realfn (t))
2368   return realfn (t);
2371 void f()
2373   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2375 @end smallexample
2377 This deduction was implemented as a possible extension to the
2378 originally proposed semantics for the C++11 standard, but was not part
2379 of the final standard, so it is disabled by default.  This option is
2380 deprecated, and may be removed in a future version of G++.
2382 @item -ffriend-injection
2383 @opindex ffriend-injection
2384 Inject friend functions into the enclosing namespace, so that they are
2385 visible outside the scope of the class in which they are declared.
2386 Friend functions were documented to work this way in the old Annotated
2387 C++ Reference Manual.  
2388 However, in ISO C++ a friend function that is not declared
2389 in an enclosing scope can only be found using argument dependent
2390 lookup.  GCC defaults to the standard behavior.
2392 This option is for compatibility, and may be removed in a future
2393 release of G++.
2395 @item -fno-elide-constructors
2396 @opindex fno-elide-constructors
2397 The C++ standard allows an implementation to omit creating a temporary
2398 that is only used to initialize another object of the same type.
2399 Specifying this option disables that optimization, and forces G++ to
2400 call the copy constructor in all cases.  This option also causes G++
2401 to call trivial member functions which otherwise would be expanded inline.
2403 In C++17, the compiler is required to omit these temporaries, but this
2404 option still affects trivial member functions.
2406 @item -fno-enforce-eh-specs
2407 @opindex fno-enforce-eh-specs
2408 Don't generate code to check for violation of exception specifications
2409 at run time.  This option violates the C++ standard, but may be useful
2410 for reducing code size in production builds, much like defining
2411 @code{NDEBUG}.  This does not give user code permission to throw
2412 exceptions in violation of the exception specifications; the compiler
2413 still optimizes based on the specifications, so throwing an
2414 unexpected exception results in undefined behavior at run time.
2416 @item -fextern-tls-init
2417 @itemx -fno-extern-tls-init
2418 @opindex fextern-tls-init
2419 @opindex fno-extern-tls-init
2420 The C++11 and OpenMP standards allow @code{thread_local} and
2421 @code{threadprivate} variables to have dynamic (runtime)
2422 initialization.  To support this, any use of such a variable goes
2423 through a wrapper function that performs any necessary initialization.
2424 When the use and definition of the variable are in the same
2425 translation unit, this overhead can be optimized away, but when the
2426 use is in a different translation unit there is significant overhead
2427 even if the variable doesn't actually need dynamic initialization.  If
2428 the programmer can be sure that no use of the variable in a
2429 non-defining TU needs to trigger dynamic initialization (either
2430 because the variable is statically initialized, or a use of the
2431 variable in the defining TU will be executed before any uses in
2432 another TU), they can avoid this overhead with the
2433 @option{-fno-extern-tls-init} option.
2435 On targets that support symbol aliases, the default is
2436 @option{-fextern-tls-init}.  On targets that do not support symbol
2437 aliases, the default is @option{-fno-extern-tls-init}.
2439 @item -ffor-scope
2440 @itemx -fno-for-scope
2441 @opindex ffor-scope
2442 @opindex fno-for-scope
2443 If @option{-ffor-scope} is specified, the scope of variables declared in
2444 a @i{for-init-statement} is limited to the @code{for} loop itself,
2445 as specified by the C++ standard.
2446 If @option{-fno-for-scope} is specified, the scope of variables declared in
2447 a @i{for-init-statement} extends to the end of the enclosing scope,
2448 as was the case in old versions of G++, and other (traditional)
2449 implementations of C++.
2451 If neither flag is given, the default is to follow the standard,
2452 but to allow and give a warning for old-style code that would
2453 otherwise be invalid, or have different behavior.
2455 @item -fno-gnu-keywords
2456 @opindex fno-gnu-keywords
2457 Do not recognize @code{typeof} as a keyword, so that code can use this
2458 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2459 This option is implied by the strict ISO C++ dialects: @option{-ansi},
2460 @option{-std=c++98}, @option{-std=c++11}, etc.
2462 @item -fno-implicit-templates
2463 @opindex fno-implicit-templates
2464 Never emit code for non-inline templates that are instantiated
2465 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2466 @xref{Template Instantiation}, for more information.
2468 @item -fno-implicit-inline-templates
2469 @opindex fno-implicit-inline-templates
2470 Don't emit code for implicit instantiations of inline templates, either.
2471 The default is to handle inlines differently so that compiles with and
2472 without optimization need the same set of explicit instantiations.
2474 @item -fno-implement-inlines
2475 @opindex fno-implement-inlines
2476 To save space, do not emit out-of-line copies of inline functions
2477 controlled by @code{#pragma implementation}.  This causes linker
2478 errors if these functions are not inlined everywhere they are called.
2480 @item -fms-extensions
2481 @opindex fms-extensions
2482 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2483 int and getting a pointer to member function via non-standard syntax.
2485 @item -fnew-inheriting-ctors
2486 @opindex fnew-inheriting-ctors
2487 Enable the P0136 adjustment to the semantics of C++11 constructor
2488 inheritance.  This is part of C++17 but also considered to be a Defect
2489 Report against C++11 and C++14.  This flag is enabled by default
2490 unless @option{-fabi-version=10} or lower is specified.
2492 @item -fnew-ttp-matching
2493 @opindex fnew-ttp-matching
2494 Enable the P0522 resolution to Core issue 150, template template
2495 parameters and default arguments: this allows a template with default
2496 template arguments as an argument for a template template parameter
2497 with fewer template parameters.  This flag is enabled by default for
2498 @option{-std=c++17}.
2500 @item -fno-nonansi-builtins
2501 @opindex fno-nonansi-builtins
2502 Disable built-in declarations of functions that are not mandated by
2503 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2504 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2506 @item -fnothrow-opt
2507 @opindex fnothrow-opt
2508 Treat a @code{throw()} exception specification as if it were a
2509 @code{noexcept} specification to reduce or eliminate the text size
2510 overhead relative to a function with no exception specification.  If
2511 the function has local variables of types with non-trivial
2512 destructors, the exception specification actually makes the
2513 function smaller because the EH cleanups for those variables can be
2514 optimized away.  The semantic effect is that an exception thrown out of
2515 a function with such an exception specification results in a call
2516 to @code{terminate} rather than @code{unexpected}.
2518 @item -fno-operator-names
2519 @opindex fno-operator-names
2520 Do not treat the operator name keywords @code{and}, @code{bitand},
2521 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2522 synonyms as keywords.
2524 @item -fno-optional-diags
2525 @opindex fno-optional-diags
2526 Disable diagnostics that the standard says a compiler does not need to
2527 issue.  Currently, the only such diagnostic issued by G++ is the one for
2528 a name having multiple meanings within a class.
2530 @item -fpermissive
2531 @opindex fpermissive
2532 Downgrade some diagnostics about nonconformant code from errors to
2533 warnings.  Thus, using @option{-fpermissive} allows some
2534 nonconforming code to compile.
2536 @item -fno-pretty-templates
2537 @opindex fno-pretty-templates
2538 When an error message refers to a specialization of a function
2539 template, the compiler normally prints the signature of the
2540 template followed by the template arguments and any typedefs or
2541 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2542 rather than @code{void f(int)}) so that it's clear which template is
2543 involved.  When an error message refers to a specialization of a class
2544 template, the compiler omits any template arguments that match
2545 the default template arguments for that template.  If either of these
2546 behaviors make it harder to understand the error message rather than
2547 easier, you can use @option{-fno-pretty-templates} to disable them.
2549 @item -frepo
2550 @opindex frepo
2551 Enable automatic template instantiation at link time.  This option also
2552 implies @option{-fno-implicit-templates}.  @xref{Template
2553 Instantiation}, for more information.
2555 @item -fno-rtti
2556 @opindex fno-rtti
2557 Disable generation of information about every class with virtual
2558 functions for use by the C++ run-time type identification features
2559 (@code{dynamic_cast} and @code{typeid}).  If you don't use those parts
2560 of the language, you can save some space by using this flag.  Note that
2561 exception handling uses the same information, but G++ generates it as
2562 needed. The @code{dynamic_cast} operator can still be used for casts that
2563 do not require run-time type information, i.e.@: casts to @code{void *} or to
2564 unambiguous base classes.
2566 @item -fsized-deallocation
2567 @opindex fsized-deallocation
2568 Enable the built-in global declarations
2569 @smallexample
2570 void operator delete (void *, std::size_t) noexcept;
2571 void operator delete[] (void *, std::size_t) noexcept;
2572 @end smallexample
2573 as introduced in C++14.  This is useful for user-defined replacement
2574 deallocation functions that, for example, use the size of the object
2575 to make deallocation faster.  Enabled by default under
2576 @option{-std=c++14} and above.  The flag @option{-Wsized-deallocation}
2577 warns about places that might want to add a definition.
2579 @item -fstrict-enums
2580 @opindex fstrict-enums
2581 Allow the compiler to optimize using the assumption that a value of
2582 enumerated type can only be one of the values of the enumeration (as
2583 defined in the C++ standard; basically, a value that can be
2584 represented in the minimum number of bits needed to represent all the
2585 enumerators).  This assumption may not be valid if the program uses a
2586 cast to convert an arbitrary integer value to the enumerated type.
2588 @item -fstrong-eval-order
2589 @opindex fstrong-eval-order
2590 Evaluate member access, array subscripting, and shift expressions in
2591 left-to-right order, and evaluate assignment in right-to-left order,
2592 as adopted for C++17.  Enabled by default with @option{-std=c++17}.
2593 @option{-fstrong-eval-order=some} enables just the ordering of member
2594 access and shift expressions, and is the default without
2595 @option{-std=c++17}.
2597 @item -ftemplate-backtrace-limit=@var{n}
2598 @opindex ftemplate-backtrace-limit
2599 Set the maximum number of template instantiation notes for a single
2600 warning or error to @var{n}.  The default value is 10.
2602 @item -ftemplate-depth=@var{n}
2603 @opindex ftemplate-depth
2604 Set the maximum instantiation depth for template classes to @var{n}.
2605 A limit on the template instantiation depth is needed to detect
2606 endless recursions during template class instantiation.  ANSI/ISO C++
2607 conforming programs must not rely on a maximum depth greater than 17
2608 (changed to 1024 in C++11).  The default value is 900, as the compiler
2609 can run out of stack space before hitting 1024 in some situations.
2611 @item -fno-threadsafe-statics
2612 @opindex fno-threadsafe-statics
2613 Do not emit the extra code to use the routines specified in the C++
2614 ABI for thread-safe initialization of local statics.  You can use this
2615 option to reduce code size slightly in code that doesn't need to be
2616 thread-safe.
2618 @item -fuse-cxa-atexit
2619 @opindex fuse-cxa-atexit
2620 Register destructors for objects with static storage duration with the
2621 @code{__cxa_atexit} function rather than the @code{atexit} function.
2622 This option is required for fully standards-compliant handling of static
2623 destructors, but only works if your C library supports
2624 @code{__cxa_atexit}.
2626 @item -fno-use-cxa-get-exception-ptr
2627 @opindex fno-use-cxa-get-exception-ptr
2628 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2629 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2630 if the runtime routine is not available.
2632 @item -fvisibility-inlines-hidden
2633 @opindex fvisibility-inlines-hidden
2634 This switch declares that the user does not attempt to compare
2635 pointers to inline functions or methods where the addresses of the two functions
2636 are taken in different shared objects.
2638 The effect of this is that GCC may, effectively, mark inline methods with
2639 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2640 appear in the export table of a DSO and do not require a PLT indirection
2641 when used within the DSO@.  Enabling this option can have a dramatic effect
2642 on load and link times of a DSO as it massively reduces the size of the
2643 dynamic export table when the library makes heavy use of templates.
2645 The behavior of this switch is not quite the same as marking the
2646 methods as hidden directly, because it does not affect static variables
2647 local to the function or cause the compiler to deduce that
2648 the function is defined in only one shared object.
2650 You may mark a method as having a visibility explicitly to negate the
2651 effect of the switch for that method.  For example, if you do want to
2652 compare pointers to a particular inline method, you might mark it as
2653 having default visibility.  Marking the enclosing class with explicit
2654 visibility has no effect.
2656 Explicitly instantiated inline methods are unaffected by this option
2657 as their linkage might otherwise cross a shared library boundary.
2658 @xref{Template Instantiation}.
2660 @item -fvisibility-ms-compat
2661 @opindex fvisibility-ms-compat
2662 This flag attempts to use visibility settings to make GCC's C++
2663 linkage model compatible with that of Microsoft Visual Studio.
2665 The flag makes these changes to GCC's linkage model:
2667 @enumerate
2668 @item
2669 It sets the default visibility to @code{hidden}, like
2670 @option{-fvisibility=hidden}.
2672 @item
2673 Types, but not their members, are not hidden by default.
2675 @item
2676 The One Definition Rule is relaxed for types without explicit
2677 visibility specifications that are defined in more than one
2678 shared object: those declarations are permitted if they are
2679 permitted when this option is not used.
2680 @end enumerate
2682 In new code it is better to use @option{-fvisibility=hidden} and
2683 export those classes that are intended to be externally visible.
2684 Unfortunately it is possible for code to rely, perhaps accidentally,
2685 on the Visual Studio behavior.
2687 Among the consequences of these changes are that static data members
2688 of the same type with the same name but defined in different shared
2689 objects are different, so changing one does not change the other;
2690 and that pointers to function members defined in different shared
2691 objects may not compare equal.  When this flag is given, it is a
2692 violation of the ODR to define types with the same name differently.
2694 @item -fno-weak
2695 @opindex fno-weak
2696 Do not use weak symbol support, even if it is provided by the linker.
2697 By default, G++ uses weak symbols if they are available.  This
2698 option exists only for testing, and should not be used by end-users;
2699 it results in inferior code and has no benefits.  This option may
2700 be removed in a future release of G++.
2702 @item -nostdinc++
2703 @opindex nostdinc++
2704 Do not search for header files in the standard directories specific to
2705 C++, but do still search the other standard directories.  (This option
2706 is used when building the C++ library.)
2707 @end table
2709 In addition, these optimization, warning, and code generation options
2710 have meanings only for C++ programs:
2712 @table @gcctabopt
2713 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2714 @opindex Wabi
2715 @opindex Wno-abi
2716 Warn when G++ it generates code that is probably not compatible with
2717 the vendor-neutral C++ ABI@.  Since G++ now defaults to updating the
2718 ABI with each major release, normally @option{-Wabi} will warn only if
2719 there is a check added later in a release series for an ABI issue
2720 discovered since the initial release.  @option{-Wabi} will warn about
2721 more things if an older ABI version is selected (with
2722 @option{-fabi-version=@var{n}}).
2724 @option{-Wabi} can also be used with an explicit version number to
2725 warn about compatibility with a particular @option{-fabi-version}
2726 level, e.g. @option{-Wabi=2} to warn about changes relative to
2727 @option{-fabi-version=2}.
2729 If an explicit version number is provided and
2730 @option{-fabi-compat-version} is not specified, the version number
2731 from this option is used for compatibility aliases.  If no explicit
2732 version number is provided with this option, but
2733 @option{-fabi-compat-version} is specified, that version number is
2734 used for ABI warnings.
2736 Although an effort has been made to warn about
2737 all such cases, there are probably some cases that are not warned about,
2738 even though G++ is generating incompatible code.  There may also be
2739 cases where warnings are emitted even though the code that is generated
2740 is compatible.
2742 You should rewrite your code to avoid these warnings if you are
2743 concerned about the fact that code generated by G++ may not be binary
2744 compatible with code generated by other compilers.
2746 Known incompatibilities in @option{-fabi-version=2} (which was the
2747 default from GCC 3.4 to 4.9) include:
2749 @itemize @bullet
2751 @item
2752 A template with a non-type template parameter of reference type was
2753 mangled incorrectly:
2754 @smallexample
2755 extern int N;
2756 template <int &> struct S @{@};
2757 void n (S<N>) @{2@}
2758 @end smallexample
2760 This was fixed in @option{-fabi-version=3}.
2762 @item
2763 SIMD vector types declared using @code{__attribute ((vector_size))} were
2764 mangled in a non-standard way that does not allow for overloading of
2765 functions taking vectors of different sizes.
2767 The mangling was changed in @option{-fabi-version=4}.
2769 @item
2770 @code{__attribute ((const))} and @code{noreturn} were mangled as type
2771 qualifiers, and @code{decltype} of a plain declaration was folded away.
2773 These mangling issues were fixed in @option{-fabi-version=5}.
2775 @item
2776 Scoped enumerators passed as arguments to a variadic function are
2777 promoted like unscoped enumerators, causing @code{va_arg} to complain.
2778 On most targets this does not actually affect the parameter passing
2779 ABI, as there is no way to pass an argument smaller than @code{int}.
2781 Also, the ABI changed the mangling of template argument packs,
2782 @code{const_cast}, @code{static_cast}, prefix increment/decrement, and
2783 a class scope function used as a template argument.
2785 These issues were corrected in @option{-fabi-version=6}.
2787 @item
2788 Lambdas in default argument scope were mangled incorrectly, and the
2789 ABI changed the mangling of @code{nullptr_t}.
2791 These issues were corrected in @option{-fabi-version=7}.
2793 @item
2794 When mangling a function type with function-cv-qualifiers, the
2795 un-qualified function type was incorrectly treated as a substitution
2796 candidate.
2798 This was fixed in @option{-fabi-version=8}, the default for GCC 5.1.
2800 @item
2801 @code{decltype(nullptr)} incorrectly had an alignment of 1, leading to
2802 unaligned accesses.  Note that this did not affect the ABI of a
2803 function with a @code{nullptr_t} parameter, as parameters have a
2804 minimum alignment.
2806 This was fixed in @option{-fabi-version=9}, the default for GCC 5.2.
2808 @item
2809 Target-specific attributes that affect the identity of a type, such as
2810 ia32 calling conventions on a function type (stdcall, regparm, etc.),
2811 did not affect the mangled name, leading to name collisions when
2812 function pointers were used as template arguments.
2814 This was fixed in @option{-fabi-version=10}, the default for GCC 6.1.
2816 @end itemize
2818 It also warns about psABI-related changes.  The known psABI changes at this
2819 point include:
2821 @itemize @bullet
2823 @item
2824 For SysV/x86-64, unions with @code{long double} members are 
2825 passed in memory as specified in psABI.  For example:
2827 @smallexample
2828 union U @{
2829   long double ld;
2830   int i;
2832 @end smallexample
2834 @noindent
2835 @code{union U} is always passed in memory.
2837 @end itemize
2839 @item -Wabi-tag @r{(C++ and Objective-C++ only)}
2840 @opindex Wabi-tag
2841 @opindex -Wabi-tag
2842 Warn when a type with an ABI tag is used in a context that does not
2843 have that ABI tag.  See @ref{C++ Attributes} for more information
2844 about ABI tags.
2846 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2847 @opindex Wctor-dtor-privacy
2848 @opindex Wno-ctor-dtor-privacy
2849 Warn when a class seems unusable because all the constructors or
2850 destructors in that class are private, and it has neither friends nor
2851 public static member functions.  Also warn if there are no non-private
2852 methods, and there's at least one private member function that isn't
2853 a constructor or destructor.
2855 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2856 @opindex Wdelete-non-virtual-dtor
2857 @opindex Wno-delete-non-virtual-dtor
2858 Warn when @code{delete} is used to destroy an instance of a class that
2859 has virtual functions and non-virtual destructor. It is unsafe to delete
2860 an instance of a derived class through a pointer to a base class if the
2861 base class does not have a virtual destructor.  This warning is enabled
2862 by @option{-Wall}.
2864 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2865 @opindex Wliteral-suffix
2866 @opindex Wno-literal-suffix
2867 Warn when a string or character literal is followed by a ud-suffix which does
2868 not begin with an underscore.  As a conforming extension, GCC treats such
2869 suffixes as separate preprocessing tokens in order to maintain backwards
2870 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2871 For example:
2873 @smallexample
2874 #define __STDC_FORMAT_MACROS
2875 #include <inttypes.h>
2876 #include <stdio.h>
2878 int main() @{
2879   int64_t i64 = 123;
2880   printf("My int64: %" PRId64"\n", i64);
2882 @end smallexample
2884 In this case, @code{PRId64} is treated as a separate preprocessing token.
2886 Additionally, warn when a user-defined literal operator is declared with
2887 a literal suffix identifier that doesn't begin with an underscore. Literal
2888 suffix identifiers that don't begin with an underscore are reserved for
2889 future standardization.
2891 This warning is enabled by default.
2893 @item -Wlto-type-mismatch
2894 @opindex Wlto-type-mismatch
2895 @opindex Wno-lto-type-mismatch
2897 During the link-time optimization warn about type mismatches in
2898 global declarations from different compilation units.
2899 Requires @option{-flto} to be enabled.  Enabled by default.
2901 @item -Wno-narrowing @r{(C++ and Objective-C++ only)}
2902 @opindex Wnarrowing
2903 @opindex Wno-narrowing
2904 For C++11 and later standards, narrowing conversions are diagnosed by default,
2905 as required by the standard.  A narrowing conversion from a constant produces
2906 an error, and a narrowing conversion from a non-constant produces a warning,
2907 but @option{-Wno-narrowing} suppresses the diagnostic.
2908 Note that this does not affect the meaning of well-formed code;
2909 narrowing conversions are still considered ill-formed in SFINAE contexts.
2911 With @option{-Wnarrowing} in C++98, warn when a narrowing
2912 conversion prohibited by C++11 occurs within
2913 @samp{@{ @}}, e.g.
2915 @smallexample
2916 int i = @{ 2.2 @}; // error: narrowing from double to int
2917 @end smallexample
2919 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2921 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2922 @opindex Wnoexcept
2923 @opindex Wno-noexcept
2924 Warn when a noexcept-expression evaluates to false because of a call
2925 to a function that does not have a non-throwing exception
2926 specification (i.e. @code{throw()} or @code{noexcept}) but is known by
2927 the compiler to never throw an exception.
2929 @item -Wnoexcept-type @r{(C++ and Objective-C++ only)}
2930 @opindex Wnoexcept-type
2931 @opindex Wno-noexcept-type
2932 Warn if the C++17 feature making @code{noexcept} part of a function
2933 type changes the mangled name of a symbol relative to C++14.  Enabled
2934 by @option{-Wabi} and @option{-Wc++17-compat}.
2936 @smallexample
2937 template <class T> void f(T t) @{ t(); @};
2938 void g() noexcept;
2939 void h() @{ f(g); @} // in C++14 calls f<void(*)()>, in C++17 calls f<void(*)()noexcept>
2940 @end smallexample
2942 @item -Wclass-memaccess @r{(C++ and Objective-C++ only)}
2943 @opindex Wclass-memaccess
2944 Warn when the destination of a call to a raw memory function such as
2945 @code{memset} or @code{memcpy} is an object of class type writing into which
2946 might bypass the class non-trivial or deleted constructor or copy assignment,
2947 violate const-correctness or encapsulation, or corrupt the virtual table.
2948 Modifying the representation of such objects may violate invariants maintained
2949 by member functions of the class.  For example, the call to @code{memset}
2950 below is undefined becase it modifies a non-trivial class object and is,
2951 therefore, diagnosed.  The safe way to either initialize or clear the storage
2952 of objects of such types is by using the appropriate constructor or assignment
2953 operator, if one is available.
2954 @smallexample
2955 std::string str = "abc";
2956 memset (&str, 0, 3);
2957 @end smallexample
2958 The @option{-Wclass-memaccess} option is enabled by @option{-Wall}.
2960 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2961 @opindex Wnon-virtual-dtor
2962 @opindex Wno-non-virtual-dtor
2963 Warn when a class has virtual functions and an accessible non-virtual
2964 destructor itself or in an accessible polymorphic base class, in which
2965 case it is possible but unsafe to delete an instance of a derived
2966 class through a pointer to the class itself or base class.  This
2967 warning is automatically enabled if @option{-Weffc++} is specified.
2969 @item -Wregister @r{(C++ and Objective-C++ only)}
2970 @opindex Wregister
2971 @opindex Wno-register
2972 Warn on uses of the @code{register} storage class specifier, except
2973 when it is part of the GNU @ref{Explicit Register Variables} extension.
2974 The use of the @code{register} keyword as storage class specifier has
2975 been deprecated in C++11 and removed in C++17.
2976 Enabled by default with @option{-std=c++17}.
2978 @item -Wreorder @r{(C++ and Objective-C++ only)}
2979 @opindex Wreorder
2980 @opindex Wno-reorder
2981 @cindex reordering, warning
2982 @cindex warning for reordering of member initializers
2983 Warn when the order of member initializers given in the code does not
2984 match the order in which they must be executed.  For instance:
2986 @smallexample
2987 struct A @{
2988   int i;
2989   int j;
2990   A(): j (0), i (1) @{ @}
2992 @end smallexample
2994 @noindent
2995 The compiler rearranges the member initializers for @code{i}
2996 and @code{j} to match the declaration order of the members, emitting
2997 a warning to that effect.  This warning is enabled by @option{-Wall}.
2999 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
3000 @opindex fext-numeric-literals
3001 @opindex fno-ext-numeric-literals
3002 Accept imaginary, fixed-point, or machine-defined
3003 literal number suffixes as GNU extensions.
3004 When this option is turned off these suffixes are treated
3005 as C++11 user-defined literal numeric suffixes.
3006 This is on by default for all pre-C++11 dialects and all GNU dialects:
3007 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
3008 @option{-std=gnu++14}.
3009 This option is off by default
3010 for ISO C++11 onwards (@option{-std=c++11}, ...).
3011 @end table
3013 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
3015 @table @gcctabopt
3016 @item -Weffc++ @r{(C++ and Objective-C++ only)}
3017 @opindex Weffc++
3018 @opindex Wno-effc++
3019 Warn about violations of the following style guidelines from Scott Meyers'
3020 @cite{Effective C++} series of books:
3022 @itemize @bullet
3023 @item
3024 Define a copy constructor and an assignment operator for classes
3025 with dynamically-allocated memory.
3027 @item
3028 Prefer initialization to assignment in constructors.
3030 @item
3031 Have @code{operator=} return a reference to @code{*this}.
3033 @item
3034 Don't try to return a reference when you must return an object.
3036 @item
3037 Distinguish between prefix and postfix forms of increment and
3038 decrement operators.
3040 @item
3041 Never overload @code{&&}, @code{||}, or @code{,}.
3043 @end itemize
3045 This option also enables @option{-Wnon-virtual-dtor}, which is also
3046 one of the effective C++ recommendations.  However, the check is
3047 extended to warn about the lack of virtual destructor in accessible
3048 non-polymorphic bases classes too.
3050 When selecting this option, be aware that the standard library
3051 headers do not obey all of these guidelines; use @samp{grep -v}
3052 to filter out those warnings.
3054 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
3055 @opindex Wstrict-null-sentinel
3056 @opindex Wno-strict-null-sentinel
3057 Warn about the use of an uncasted @code{NULL} as sentinel.  When
3058 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
3059 to @code{__null}.  Although it is a null pointer constant rather than a
3060 null pointer, it is guaranteed to be of the same size as a pointer.
3061 But this use is not portable across different compilers.
3063 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
3064 @opindex Wno-non-template-friend
3065 @opindex Wnon-template-friend
3066 Disable warnings when non-template friend functions are declared
3067 within a template.  In very old versions of GCC that predate implementation
3068 of the ISO standard, declarations such as 
3069 @samp{friend int foo(int)}, where the name of the friend is an unqualified-id,
3070 could be interpreted as a particular specialization of a template
3071 function; the warning exists to diagnose compatibility problems, 
3072 and is enabled by default.
3074 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
3075 @opindex Wold-style-cast
3076 @opindex Wno-old-style-cast
3077 Warn if an old-style (C-style) cast to a non-void type is used within
3078 a C++ program.  The new-style casts (@code{dynamic_cast},
3079 @code{static_cast}, @code{reinterpret_cast}, and @code{const_cast}) are
3080 less vulnerable to unintended effects and much easier to search for.
3082 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
3083 @opindex Woverloaded-virtual
3084 @opindex Wno-overloaded-virtual
3085 @cindex overloaded virtual function, warning
3086 @cindex warning for overloaded virtual function
3087 Warn when a function declaration hides virtual functions from a
3088 base class.  For example, in:
3090 @smallexample
3091 struct A @{
3092   virtual void f();
3095 struct B: public A @{
3096   void f(int);
3098 @end smallexample
3100 the @code{A} class version of @code{f} is hidden in @code{B}, and code
3101 like:
3103 @smallexample
3104 B* b;
3105 b->f();
3106 @end smallexample
3108 @noindent
3109 fails to compile.
3111 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
3112 @opindex Wno-pmf-conversions
3113 @opindex Wpmf-conversions
3114 Disable the diagnostic for converting a bound pointer to member function
3115 to a plain pointer.
3117 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
3118 @opindex Wsign-promo
3119 @opindex Wno-sign-promo
3120 Warn when overload resolution chooses a promotion from unsigned or
3121 enumerated type to a signed type, over a conversion to an unsigned type of
3122 the same size.  Previous versions of G++ tried to preserve
3123 unsignedness, but the standard mandates the current behavior.
3125 @item -Wtemplates @r{(C++ and Objective-C++ only)}
3126 @opindex Wtemplates
3127 Warn when a primary template declaration is encountered.  Some coding
3128 rules disallow templates, and this may be used to enforce that rule.
3129 The warning is inactive inside a system header file, such as the STL, so
3130 one can still use the STL.  One may also instantiate or specialize
3131 templates.
3133 @item -Wmultiple-inheritance @r{(C++ and Objective-C++ only)}
3134 @opindex Wmultiple-inheritance
3135 Warn when a class is defined with multiple direct base classes.  Some
3136 coding rules disallow multiple inheritance, and this may be used to
3137 enforce that rule.  The warning is inactive inside a system header file,
3138 such as the STL, so one can still use the STL.  One may also define
3139 classes that indirectly use multiple inheritance.
3141 @item -Wvirtual-inheritance
3142 @opindex Wvirtual-inheritance
3143 Warn when a class is defined with a virtual direct base class.  Some
3144 coding rules disallow multiple inheritance, and this may be used to
3145 enforce that rule.  The warning is inactive inside a system header file,
3146 such as the STL, so one can still use the STL.  One may also define
3147 classes that indirectly use virtual inheritance.
3149 @item -Wnamespaces
3150 @opindex Wnamespaces
3151 Warn when a namespace definition is opened.  Some coding rules disallow
3152 namespaces, and this may be used to enforce that rule.  The warning is
3153 inactive inside a system header file, such as the STL, so one can still
3154 use the STL.  One may also use using directives and qualified names.
3156 @item -Wno-terminate @r{(C++ and Objective-C++ only)}
3157 @opindex Wterminate
3158 @opindex Wno-terminate
3159 Disable the warning about a throw-expression that will immediately
3160 result in a call to @code{terminate}.
3161 @end table
3163 @node Objective-C and Objective-C++ Dialect Options
3164 @section Options Controlling Objective-C and Objective-C++ Dialects
3166 @cindex compiler options, Objective-C and Objective-C++
3167 @cindex Objective-C and Objective-C++ options, command-line
3168 @cindex options, Objective-C and Objective-C++
3169 (NOTE: This manual does not describe the Objective-C and Objective-C++
3170 languages themselves.  @xref{Standards,,Language Standards
3171 Supported by GCC}, for references.)
3173 This section describes the command-line options that are only meaningful
3174 for Objective-C and Objective-C++ programs.  You can also use most of
3175 the language-independent GNU compiler options.
3176 For example, you might compile a file @file{some_class.m} like this:
3178 @smallexample
3179 gcc -g -fgnu-runtime -O -c some_class.m
3180 @end smallexample
3182 @noindent
3183 In this example, @option{-fgnu-runtime} is an option meant only for
3184 Objective-C and Objective-C++ programs; you can use the other options with
3185 any language supported by GCC@.
3187 Note that since Objective-C is an extension of the C language, Objective-C
3188 compilations may also use options specific to the C front-end (e.g.,
3189 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
3190 C++-specific options (e.g., @option{-Wabi}).
3192 Here is a list of options that are @emph{only} for compiling Objective-C
3193 and Objective-C++ programs:
3195 @table @gcctabopt
3196 @item -fconstant-string-class=@var{class-name}
3197 @opindex fconstant-string-class
3198 Use @var{class-name} as the name of the class to instantiate for each
3199 literal string specified with the syntax @code{@@"@dots{}"}.  The default
3200 class name is @code{NXConstantString} if the GNU runtime is being used, and
3201 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
3202 @option{-fconstant-cfstrings} option, if also present, overrides the
3203 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
3204 to be laid out as constant CoreFoundation strings.
3206 @item -fgnu-runtime
3207 @opindex fgnu-runtime
3208 Generate object code compatible with the standard GNU Objective-C
3209 runtime.  This is the default for most types of systems.
3211 @item -fnext-runtime
3212 @opindex fnext-runtime
3213 Generate output compatible with the NeXT runtime.  This is the default
3214 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
3215 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
3216 used.
3218 @item -fno-nil-receivers
3219 @opindex fno-nil-receivers
3220 Assume that all Objective-C message dispatches (@code{[receiver
3221 message:arg]}) in this translation unit ensure that the receiver is
3222 not @code{nil}.  This allows for more efficient entry points in the
3223 runtime to be used.  This option is only available in conjunction with
3224 the NeXT runtime and ABI version 0 or 1.
3226 @item -fobjc-abi-version=@var{n}
3227 @opindex fobjc-abi-version
3228 Use version @var{n} of the Objective-C ABI for the selected runtime.
3229 This option is currently supported only for the NeXT runtime.  In that
3230 case, Version 0 is the traditional (32-bit) ABI without support for
3231 properties and other Objective-C 2.0 additions.  Version 1 is the
3232 traditional (32-bit) ABI with support for properties and other
3233 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
3234 nothing is specified, the default is Version 0 on 32-bit target
3235 machines, and Version 2 on 64-bit target machines.
3237 @item -fobjc-call-cxx-cdtors
3238 @opindex fobjc-call-cxx-cdtors
3239 For each Objective-C class, check if any of its instance variables is a
3240 C++ object with a non-trivial default constructor.  If so, synthesize a
3241 special @code{- (id) .cxx_construct} instance method which runs
3242 non-trivial default constructors on any such instance variables, in order,
3243 and then return @code{self}.  Similarly, check if any instance variable
3244 is a C++ object with a non-trivial destructor, and if so, synthesize a
3245 special @code{- (void) .cxx_destruct} method which runs
3246 all such default destructors, in reverse order.
3248 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
3249 methods thusly generated only operate on instance variables
3250 declared in the current Objective-C class, and not those inherited
3251 from superclasses.  It is the responsibility of the Objective-C
3252 runtime to invoke all such methods in an object's inheritance
3253 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
3254 by the runtime immediately after a new object instance is allocated;
3255 the @code{- (void) .cxx_destruct} methods are invoked immediately
3256 before the runtime deallocates an object instance.
3258 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
3259 support for invoking the @code{- (id) .cxx_construct} and
3260 @code{- (void) .cxx_destruct} methods.
3262 @item -fobjc-direct-dispatch
3263 @opindex fobjc-direct-dispatch
3264 Allow fast jumps to the message dispatcher.  On Darwin this is
3265 accomplished via the comm page.
3267 @item -fobjc-exceptions
3268 @opindex fobjc-exceptions
3269 Enable syntactic support for structured exception handling in
3270 Objective-C, similar to what is offered by C++.  This option
3271 is required to use the Objective-C keywords @code{@@try},
3272 @code{@@throw}, @code{@@catch}, @code{@@finally} and
3273 @code{@@synchronized}.  This option is available with both the GNU
3274 runtime and the NeXT runtime (but not available in conjunction with
3275 the NeXT runtime on Mac OS X 10.2 and earlier).
3277 @item -fobjc-gc
3278 @opindex fobjc-gc
3279 Enable garbage collection (GC) in Objective-C and Objective-C++
3280 programs.  This option is only available with the NeXT runtime; the
3281 GNU runtime has a different garbage collection implementation that
3282 does not require special compiler flags.
3284 @item -fobjc-nilcheck
3285 @opindex fobjc-nilcheck
3286 For the NeXT runtime with version 2 of the ABI, check for a nil
3287 receiver in method invocations before doing the actual method call.
3288 This is the default and can be disabled using
3289 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
3290 checked for nil in this way no matter what this flag is set to.
3291 Currently this flag does nothing when the GNU runtime, or an older
3292 version of the NeXT runtime ABI, is used.
3294 @item -fobjc-std=objc1
3295 @opindex fobjc-std
3296 Conform to the language syntax of Objective-C 1.0, the language
3297 recognized by GCC 4.0.  This only affects the Objective-C additions to
3298 the C/C++ language; it does not affect conformance to C/C++ standards,
3299 which is controlled by the separate C/C++ dialect option flags.  When
3300 this option is used with the Objective-C or Objective-C++ compiler,
3301 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
3302 This is useful if you need to make sure that your Objective-C code can
3303 be compiled with older versions of GCC@.
3305 @item -freplace-objc-classes
3306 @opindex freplace-objc-classes
3307 Emit a special marker instructing @command{ld(1)} not to statically link in
3308 the resulting object file, and allow @command{dyld(1)} to load it in at
3309 run time instead.  This is used in conjunction with the Fix-and-Continue
3310 debugging mode, where the object file in question may be recompiled and
3311 dynamically reloaded in the course of program execution, without the need
3312 to restart the program itself.  Currently, Fix-and-Continue functionality
3313 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
3314 and later.
3316 @item -fzero-link
3317 @opindex fzero-link
3318 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
3319 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
3320 compile time) with static class references that get initialized at load time,
3321 which improves run-time performance.  Specifying the @option{-fzero-link} flag
3322 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
3323 to be retained.  This is useful in Zero-Link debugging mode, since it allows
3324 for individual class implementations to be modified during program execution.
3325 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
3326 regardless of command-line options.
3328 @item -fno-local-ivars
3329 @opindex fno-local-ivars
3330 @opindex flocal-ivars
3331 By default instance variables in Objective-C can be accessed as if
3332 they were local variables from within the methods of the class they're
3333 declared in.  This can lead to shadowing between instance variables
3334 and other variables declared either locally inside a class method or
3335 globally with the same name.  Specifying the @option{-fno-local-ivars}
3336 flag disables this behavior thus avoiding variable shadowing issues.
3338 @item -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]}
3339 @opindex fivar-visibility
3340 Set the default instance variable visibility to the specified option
3341 so that instance variables declared outside the scope of any access
3342 modifier directives default to the specified visibility.
3344 @item -gen-decls
3345 @opindex gen-decls
3346 Dump interface declarations for all classes seen in the source file to a
3347 file named @file{@var{sourcename}.decl}.
3349 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
3350 @opindex Wassign-intercept
3351 @opindex Wno-assign-intercept
3352 Warn whenever an Objective-C assignment is being intercepted by the
3353 garbage collector.
3355 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
3356 @opindex Wno-protocol
3357 @opindex Wprotocol
3358 If a class is declared to implement a protocol, a warning is issued for
3359 every method in the protocol that is not implemented by the class.  The
3360 default behavior is to issue a warning for every method not explicitly
3361 implemented in the class, even if a method implementation is inherited
3362 from the superclass.  If you use the @option{-Wno-protocol} option, then
3363 methods inherited from the superclass are considered to be implemented,
3364 and no warning is issued for them.
3366 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3367 @opindex Wselector
3368 @opindex Wno-selector
3369 Warn if multiple methods of different types for the same selector are
3370 found during compilation.  The check is performed on the list of methods
3371 in the final stage of compilation.  Additionally, a check is performed
3372 for each selector appearing in a @code{@@selector(@dots{})}
3373 expression, and a corresponding method for that selector has been found
3374 during compilation.  Because these checks scan the method table only at
3375 the end of compilation, these warnings are not produced if the final
3376 stage of compilation is not reached, for example because an error is
3377 found during compilation, or because the @option{-fsyntax-only} option is
3378 being used.
3380 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3381 @opindex Wstrict-selector-match
3382 @opindex Wno-strict-selector-match
3383 Warn if multiple methods with differing argument and/or return types are
3384 found for a given selector when attempting to send a message using this
3385 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3386 is off (which is the default behavior), the compiler omits such warnings
3387 if any differences found are confined to types that share the same size
3388 and alignment.
3390 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3391 @opindex Wundeclared-selector
3392 @opindex Wno-undeclared-selector
3393 Warn if a @code{@@selector(@dots{})} expression referring to an
3394 undeclared selector is found.  A selector is considered undeclared if no
3395 method with that name has been declared before the
3396 @code{@@selector(@dots{})} expression, either explicitly in an
3397 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3398 an @code{@@implementation} section.  This option always performs its
3399 checks as soon as a @code{@@selector(@dots{})} expression is found,
3400 while @option{-Wselector} only performs its checks in the final stage of
3401 compilation.  This also enforces the coding style convention
3402 that methods and selectors must be declared before being used.
3404 @item -print-objc-runtime-info
3405 @opindex print-objc-runtime-info
3406 Generate C header describing the largest structure that is passed by
3407 value, if any.
3409 @end table
3411 @node Diagnostic Message Formatting Options
3412 @section Options to Control Diagnostic Messages Formatting
3413 @cindex options to control diagnostics formatting
3414 @cindex diagnostic messages
3415 @cindex message formatting
3417 Traditionally, diagnostic messages have been formatted irrespective of
3418 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3419 options described below
3420 to control the formatting algorithm for diagnostic messages, 
3421 e.g.@: how many characters per line, how often source location
3422 information should be reported.  Note that some language front ends may not
3423 honor these options.
3425 @table @gcctabopt
3426 @item -fmessage-length=@var{n}
3427 @opindex fmessage-length
3428 Try to format error messages so that they fit on lines of about
3429 @var{n} characters.  If @var{n} is zero, then no line-wrapping is
3430 done; each error message appears on a single line.  This is the
3431 default for all front ends.
3433 @item -fdiagnostics-show-location=once
3434 @opindex fdiagnostics-show-location
3435 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3436 reporter to emit source location information @emph{once}; that is, in
3437 case the message is too long to fit on a single physical line and has to
3438 be wrapped, the source location won't be emitted (as prefix) again,
3439 over and over, in subsequent continuation lines.  This is the default
3440 behavior.
3442 @item -fdiagnostics-show-location=every-line
3443 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3444 messages reporter to emit the same source location information (as
3445 prefix) for physical lines that result from the process of breaking
3446 a message which is too long to fit on a single line.
3448 @item -fdiagnostics-color[=@var{WHEN}]
3449 @itemx -fno-diagnostics-color
3450 @opindex fdiagnostics-color
3451 @cindex highlight, color
3452 @vindex GCC_COLORS @r{environment variable}
3453 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3454 or @samp{auto}.  The default depends on how the compiler has been configured,
3455 it can be any of the above @var{WHEN} options or also @samp{never}
3456 if @env{GCC_COLORS} environment variable isn't present in the environment,
3457 and @samp{auto} otherwise.
3458 @samp{auto} means to use color only when the standard error is a terminal.
3459 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3460 aliases for @option{-fdiagnostics-color=always} and
3461 @option{-fdiagnostics-color=never}, respectively.
3463 The colors are defined by the environment variable @env{GCC_COLORS}.
3464 Its value is a colon-separated list of capabilities and Select Graphic
3465 Rendition (SGR) substrings. SGR commands are interpreted by the
3466 terminal or terminal emulator.  (See the section in the documentation
3467 of your text terminal for permitted values and their meanings as
3468 character attributes.)  These substring values are integers in decimal
3469 representation and can be concatenated with semicolons.
3470 Common values to concatenate include
3471 @samp{1} for bold,
3472 @samp{4} for underline,
3473 @samp{5} for blink,
3474 @samp{7} for inverse,
3475 @samp{39} for default foreground color,
3476 @samp{30} to @samp{37} for foreground colors,
3477 @samp{90} to @samp{97} for 16-color mode foreground colors,
3478 @samp{38;5;0} to @samp{38;5;255}
3479 for 88-color and 256-color modes foreground colors,
3480 @samp{49} for default background color,
3481 @samp{40} to @samp{47} for background colors,
3482 @samp{100} to @samp{107} for 16-color mode background colors,
3483 and @samp{48;5;0} to @samp{48;5;255}
3484 for 88-color and 256-color modes background colors.
3486 The default @env{GCC_COLORS} is
3487 @smallexample
3488 error=01;31:warning=01;35:note=01;36:range1=32:range2=34:locus=01:\
3489 quote=01:fixit-insert=32:fixit-delete=31:\
3490 diff-filename=01:diff-hunk=32:diff-delete=31:diff-insert=32:\
3491 type-diff=01;32
3492 @end smallexample
3493 @noindent
3494 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3495 @samp{01;36} is bold cyan, @samp{32} is green, @samp{34} is blue,
3496 @samp{01} is bold, and @samp{31} is red.
3497 Setting @env{GCC_COLORS} to the empty string disables colors.
3498 Supported capabilities are as follows.
3500 @table @code
3501 @item error=
3502 @vindex error GCC_COLORS @r{capability}
3503 SGR substring for error: markers.
3505 @item warning=
3506 @vindex warning GCC_COLORS @r{capability}
3507 SGR substring for warning: markers.
3509 @item note=
3510 @vindex note GCC_COLORS @r{capability}
3511 SGR substring for note: markers.
3513 @item range1=
3514 @vindex range1 GCC_COLORS @r{capability}
3515 SGR substring for first additional range.
3517 @item range2=
3518 @vindex range2 GCC_COLORS @r{capability}
3519 SGR substring for second additional range.
3521 @item locus=
3522 @vindex locus GCC_COLORS @r{capability}
3523 SGR substring for location information, @samp{file:line} or
3524 @samp{file:line:column} etc.
3526 @item quote=
3527 @vindex quote GCC_COLORS @r{capability}
3528 SGR substring for information printed within quotes.
3530 @item fixit-insert=
3531 @vindex fixit-insert GCC_COLORS @r{capability}
3532 SGR substring for fix-it hints suggesting text to
3533 be inserted or replaced.
3535 @item fixit-delete=
3536 @vindex fixit-delete GCC_COLORS @r{capability}
3537 SGR substring for fix-it hints suggesting text to
3538 be deleted.
3540 @item diff-filename=
3541 @vindex diff-filename GCC_COLORS @r{capability}
3542 SGR substring for filename headers within generated patches.
3544 @item diff-hunk=
3545 @vindex diff-hunk GCC_COLORS @r{capability}
3546 SGR substring for the starts of hunks within generated patches.
3548 @item diff-delete=
3549 @vindex diff-delete GCC_COLORS @r{capability}
3550 SGR substring for deleted lines within generated patches.
3552 @item diff-insert=
3553 @vindex diff-insert GCC_COLORS @r{capability}
3554 SGR substring for inserted lines within generated patches.
3556 @item type-diff=
3557 @vindex type-diff GCC_COLORS @r{capability}
3558 SGR substring for highlighting mismatching types within template
3559 arguments in the C++ frontend.
3560 @end table
3562 @item -fno-diagnostics-show-option
3563 @opindex fno-diagnostics-show-option
3564 @opindex fdiagnostics-show-option
3565 By default, each diagnostic emitted includes text indicating the
3566 command-line option that directly controls the diagnostic (if such an
3567 option is known to the diagnostic machinery).  Specifying the
3568 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3570 @item -fno-diagnostics-show-caret
3571 @opindex fno-diagnostics-show-caret
3572 @opindex fdiagnostics-show-caret
3573 By default, each diagnostic emitted includes the original source line
3574 and a caret @samp{^} indicating the column.  This option suppresses this
3575 information.  The source line is truncated to @var{n} characters, if
3576 the @option{-fmessage-length=n} option is given.  When the output is done
3577 to the terminal, the width is limited to the width given by the
3578 @env{COLUMNS} environment variable or, if not set, to the terminal width.
3580 @item -fdiagnostics-parseable-fixits
3581 @opindex fdiagnostics-parseable-fixits
3582 Emit fix-it hints in a machine-parseable format, suitable for consumption
3583 by IDEs.  For each fix-it, a line will be printed after the relevant
3584 diagnostic, starting with the string ``fix-it:''.  For example:
3586 @smallexample
3587 fix-it:"test.c":@{45:3-45:21@}:"gtk_widget_show_all"
3588 @end smallexample
3590 The location is expressed as a half-open range, expressed as a count of
3591 bytes, starting at byte 1 for the initial column.  In the above example,
3592 bytes 3 through 20 of line 45 of ``test.c'' are to be replaced with the
3593 given string:
3595 @smallexample
3596 00000000011111111112222222222
3597 12345678901234567890123456789
3598   gtk_widget_showall (dlg);
3599   ^^^^^^^^^^^^^^^^^^
3600   gtk_widget_show_all
3601 @end smallexample
3603 The filename and replacement string escape backslash as ``\\", tab as ``\t'',
3604 newline as ``\n'', double quotes as ``\"'', non-printable characters as octal
3605 (e.g. vertical tab as ``\013'').
3607 An empty replacement string indicates that the given range is to be removed.
3608 An empty range (e.g. ``45:3-45:3'') indicates that the string is to
3609 be inserted at the given position.
3611 @item -fdiagnostics-generate-patch
3612 @opindex fdiagnostics-generate-patch
3613 Print fix-it hints to stderr in unified diff format, after any diagnostics
3614 are printed.  For example:
3616 @smallexample
3617 --- test.c
3618 +++ test.c
3619 @@ -42,5 +42,5 @@
3621  void show_cb(GtkDialog *dlg)
3622  @{
3623 -  gtk_widget_showall(dlg);
3624 +  gtk_widget_show_all(dlg);
3625  @}
3627 @end smallexample
3629 The diff may or may not be colorized, following the same rules
3630 as for diagnostics (see @option{-fdiagnostics-color}).
3632 @item -fdiagnostics-show-template-tree
3633 @opindex fdiagnostics-show-template-tree
3635 In the C++ frontend, when printing diagnostics showing mismatching
3636 template types, such as:
3638 @smallexample
3639   could not convert 'std::map<int, std::vector<double> >()'
3640     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3641 @end smallexample
3643 the @option{-fdiagnostics-show-template-tree} flag enables printing a
3644 tree-like structure showing the common and differing parts of the types,
3645 such as:
3647 @smallexample
3648   map<
3649     [...],
3650     vector<
3651       [double != float]>>
3652 @end smallexample
3654 The parts that differ are highlighted with color (``double'' and
3655 ``float'' in this case).
3657 @item -fno-elide-type
3658 @opindex fno-elide-type
3659 @opindex felide-type
3660 By default when the C++ frontend prints diagnostics showing mismatching
3661 template types, common parts of the types are printed as ``[...]'' to
3662 simplify the error message.  For example:
3664 @smallexample
3665   could not convert 'std::map<int, std::vector<double> >()'
3666     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3667 @end smallexample
3669 Specifying the @option{-fno-elide-type} flag suppresses that behavior.
3670 This flag also affects the output of the
3671 @option{-fdiagnostics-show-template-tree} flag.
3673 @item -fno-show-column
3674 @opindex fno-show-column
3675 Do not print column numbers in diagnostics.  This may be necessary if
3676 diagnostics are being scanned by a program that does not understand the
3677 column numbers, such as @command{dejagnu}.
3679 @end table
3681 @node Warning Options
3682 @section Options to Request or Suppress Warnings
3683 @cindex options to control warnings
3684 @cindex warning messages
3685 @cindex messages, warning
3686 @cindex suppressing warnings
3688 Warnings are diagnostic messages that report constructions that
3689 are not inherently erroneous but that are risky or suggest there
3690 may have been an error.
3692 The following language-independent options do not enable specific
3693 warnings but control the kinds of diagnostics produced by GCC@.
3695 @table @gcctabopt
3696 @cindex syntax checking
3697 @item -fsyntax-only
3698 @opindex fsyntax-only
3699 Check the code for syntax errors, but don't do anything beyond that.
3701 @item -fmax-errors=@var{n}
3702 @opindex fmax-errors
3703 Limits the maximum number of error messages to @var{n}, at which point
3704 GCC bails out rather than attempting to continue processing the source
3705 code.  If @var{n} is 0 (the default), there is no limit on the number
3706 of error messages produced.  If @option{-Wfatal-errors} is also
3707 specified, then @option{-Wfatal-errors} takes precedence over this
3708 option.
3710 @item -w
3711 @opindex w
3712 Inhibit all warning messages.
3714 @item -Werror
3715 @opindex Werror
3716 @opindex Wno-error
3717 Make all warnings into errors.
3719 @item -Werror=
3720 @opindex Werror=
3721 @opindex Wno-error=
3722 Make the specified warning into an error.  The specifier for a warning
3723 is appended; for example @option{-Werror=switch} turns the warnings
3724 controlled by @option{-Wswitch} into errors.  This switch takes a
3725 negative form, to be used to negate @option{-Werror} for specific
3726 warnings; for example @option{-Wno-error=switch} makes
3727 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3728 is in effect.
3730 The warning message for each controllable warning includes the
3731 option that controls the warning.  That option can then be used with
3732 @option{-Werror=} and @option{-Wno-error=} as described above.
3733 (Printing of the option in the warning message can be disabled using the
3734 @option{-fno-diagnostics-show-option} flag.)
3736 Note that specifying @option{-Werror=}@var{foo} automatically implies
3737 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3738 imply anything.
3740 @item -Wfatal-errors
3741 @opindex Wfatal-errors
3742 @opindex Wno-fatal-errors
3743 This option causes the compiler to abort compilation on the first error
3744 occurred rather than trying to keep going and printing further error
3745 messages.
3747 @end table
3749 You can request many specific warnings with options beginning with
3750 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3751 implicit declarations.  Each of these specific warning options also
3752 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3753 example, @option{-Wno-implicit}.  This manual lists only one of the
3754 two forms, whichever is not the default.  For further
3755 language-specific options also refer to @ref{C++ Dialect Options} and
3756 @ref{Objective-C and Objective-C++ Dialect Options}.
3758 Some options, such as @option{-Wall} and @option{-Wextra}, turn on other
3759 options, such as @option{-Wunused}, which may turn on further options,
3760 such as @option{-Wunused-value}. The combined effect of positive and
3761 negative forms is that more specific options have priority over less
3762 specific ones, independently of their position in the command-line. For
3763 options of the same specificity, the last one takes effect. Options
3764 enabled or disabled via pragmas (@pxref{Diagnostic Pragmas}) take effect
3765 as if they appeared at the end of the command-line.
3767 When an unrecognized warning option is requested (e.g.,
3768 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3769 that the option is not recognized.  However, if the @option{-Wno-} form
3770 is used, the behavior is slightly different: no diagnostic is
3771 produced for @option{-Wno-unknown-warning} unless other diagnostics
3772 are being produced.  This allows the use of new @option{-Wno-} options
3773 with old compilers, but if something goes wrong, the compiler
3774 warns that an unrecognized option is present.
3776 @table @gcctabopt
3777 @item -Wpedantic
3778 @itemx -pedantic
3779 @opindex pedantic
3780 @opindex Wpedantic
3781 Issue all the warnings demanded by strict ISO C and ISO C++;
3782 reject all programs that use forbidden extensions, and some other
3783 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3784 version of the ISO C standard specified by any @option{-std} option used.
3786 Valid ISO C and ISO C++ programs should compile properly with or without
3787 this option (though a rare few require @option{-ansi} or a
3788 @option{-std} option specifying the required version of ISO C)@.  However,
3789 without this option, certain GNU extensions and traditional C and C++
3790 features are supported as well.  With this option, they are rejected.
3792 @option{-Wpedantic} does not cause warning messages for use of the
3793 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3794 warnings are also disabled in the expression that follows
3795 @code{__extension__}.  However, only system header files should use
3796 these escape routes; application programs should avoid them.
3797 @xref{Alternate Keywords}.
3799 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3800 C conformance.  They soon find that it does not do quite what they want:
3801 it finds some non-ISO practices, but not all---only those for which
3802 ISO C @emph{requires} a diagnostic, and some others for which
3803 diagnostics have been added.
3805 A feature to report any failure to conform to ISO C might be useful in
3806 some instances, but would require considerable additional work and would
3807 be quite different from @option{-Wpedantic}.  We don't have plans to
3808 support such a feature in the near future.
3810 Where the standard specified with @option{-std} represents a GNU
3811 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3812 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3813 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3814 where they are required by the base standard.  (It does not make sense
3815 for such warnings to be given only for features not in the specified GNU
3816 C dialect, since by definition the GNU dialects of C include all
3817 features the compiler supports with the given option, and there would be
3818 nothing to warn about.)
3820 @item -pedantic-errors
3821 @opindex pedantic-errors
3822 Give an error whenever the @dfn{base standard} (see @option{-Wpedantic})
3823 requires a diagnostic, in some cases where there is undefined behavior
3824 at compile-time and in some other cases that do not prevent compilation
3825 of programs that are valid according to the standard. This is not
3826 equivalent to @option{-Werror=pedantic}, since there are errors enabled
3827 by this option and not enabled by the latter and vice versa.
3829 @item -Wall
3830 @opindex Wall
3831 @opindex Wno-all
3832 This enables all the warnings about constructions that some users
3833 consider questionable, and that are easy to avoid (or modify to
3834 prevent the warning), even in conjunction with macros.  This also
3835 enables some language-specific warnings described in @ref{C++ Dialect
3836 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3838 @option{-Wall} turns on the following warning flags:
3840 @gccoptlist{-Waddress   @gol
3841 -Warray-bounds=1 @r{(only with} @option{-O2}@r{)}  @gol
3842 -Wbool-compare  @gol
3843 -Wbool-operation  @gol
3844 -Wc++11-compat  -Wc++14-compat  @gol
3845 -Wcatch-value @r{(C++ and Objective-C++ only)}  @gol
3846 -Wchar-subscripts  @gol
3847 -Wcomment  @gol
3848 -Wduplicate-decl-specifier @r{(C and Objective-C only)} @gol
3849 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3850 -Wformat   @gol
3851 -Wint-in-bool-context  @gol
3852 -Wimplicit @r{(C and Objective-C only)} @gol
3853 -Wimplicit-int @r{(C and Objective-C only)} @gol
3854 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3855 -Winit-self @r{(only for C++)} @gol
3856 -Wlogical-not-parentheses @gol
3857 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3858 -Wmaybe-uninitialized @gol
3859 -Wmemset-elt-size @gol
3860 -Wmemset-transposed-args @gol
3861 -Wmisleading-indentation @r{(only for C/C++)} @gol
3862 -Wmissing-braces @r{(only for C/ObjC)} @gol
3863 -Wmultistatement-macros  @gol
3864 -Wnarrowing @r{(only for C++)}  @gol
3865 -Wnonnull  @gol
3866 -Wnonnull-compare  @gol
3867 -Wopenmp-simd @gol
3868 -Wparentheses  @gol
3869 -Wpointer-sign  @gol
3870 -Wreorder   @gol
3871 -Wreturn-type  @gol
3872 -Wsequence-point  @gol
3873 -Wsign-compare @r{(only in C++)}  @gol
3874 -Wsizeof-pointer-div @gol
3875 -Wsizeof-pointer-memaccess @gol
3876 -Wstrict-aliasing  @gol
3877 -Wstrict-overflow=1  @gol
3878 -Wswitch  @gol
3879 -Wtautological-compare  @gol
3880 -Wtrigraphs  @gol
3881 -Wuninitialized  @gol
3882 -Wunknown-pragmas  @gol
3883 -Wunused-function  @gol
3884 -Wunused-label     @gol
3885 -Wunused-value     @gol
3886 -Wunused-variable  @gol
3887 -Wvolatile-register-var @gol
3890 Note that some warning flags are not implied by @option{-Wall}.  Some of
3891 them warn about constructions that users generally do not consider
3892 questionable, but which occasionally you might wish to check for;
3893 others warn about constructions that are necessary or hard to avoid in
3894 some cases, and there is no simple way to modify the code to suppress
3895 the warning. Some of them are enabled by @option{-Wextra} but many of
3896 them must be enabled individually.
3898 @item -Wextra
3899 @opindex W
3900 @opindex Wextra
3901 @opindex Wno-extra
3902 This enables some extra warning flags that are not enabled by
3903 @option{-Wall}. (This option used to be called @option{-W}.  The older
3904 name is still supported, but the newer name is more descriptive.)
3906 @gccoptlist{-Wclobbered  @gol
3907 -Wcast-function-type  @gol
3908 -Wempty-body  @gol
3909 -Wignored-qualifiers @gol
3910 -Wimplicit-fallthrough=3 @gol
3911 -Wmissing-field-initializers  @gol
3912 -Wmissing-parameter-type @r{(C only)}  @gol
3913 -Wold-style-declaration @r{(C only)}  @gol
3914 -Woverride-init  @gol
3915 -Wsign-compare @r{(C only)} @gol
3916 -Wtype-limits  @gol
3917 -Wuninitialized  @gol
3918 -Wshift-negative-value @r{(in C++03 and in C99 and newer)}  @gol
3919 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3920 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3923 The option @option{-Wextra} also prints warning messages for the
3924 following cases:
3926 @itemize @bullet
3928 @item
3929 A pointer is compared against integer zero with @code{<}, @code{<=},
3930 @code{>}, or @code{>=}.
3932 @item
3933 (C++ only) An enumerator and a non-enumerator both appear in a
3934 conditional expression.
3936 @item
3937 (C++ only) Ambiguous virtual bases.
3939 @item
3940 (C++ only) Subscripting an array that has been declared @code{register}.
3942 @item
3943 (C++ only) Taking the address of a variable that has been declared
3944 @code{register}.
3946 @item
3947 (C++ only) A base class is not initialized in the copy constructor
3948 of a derived class.
3950 @end itemize
3952 @item -Wchar-subscripts
3953 @opindex Wchar-subscripts
3954 @opindex Wno-char-subscripts
3955 Warn if an array subscript has type @code{char}.  This is a common cause
3956 of error, as programmers often forget that this type is signed on some
3957 machines.
3958 This warning is enabled by @option{-Wall}.
3960 @item -Wchkp
3961 @opindex Wchkp
3962 Warn about an invalid memory access that is found by Pointer Bounds Checker
3963 (@option{-fcheck-pointer-bounds}).
3965 @item -Wno-coverage-mismatch
3966 @opindex Wno-coverage-mismatch
3967 Warn if feedback profiles do not match when using the
3968 @option{-fprofile-use} option.
3969 If a source file is changed between compiling with @option{-fprofile-gen} and
3970 with @option{-fprofile-use}, the files with the profile feedback can fail
3971 to match the source file and GCC cannot use the profile feedback
3972 information.  By default, this warning is enabled and is treated as an
3973 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3974 warning or @option{-Wno-error=coverage-mismatch} can be used to
3975 disable the error.  Disabling the error for this warning can result in
3976 poorly optimized code and is useful only in the
3977 case of very minor changes such as bug fixes to an existing code-base.
3978 Completely disabling the warning is not recommended.
3980 @item -Wno-cpp
3981 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3983 Suppress warning messages emitted by @code{#warning} directives.
3985 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3986 @opindex Wdouble-promotion
3987 @opindex Wno-double-promotion
3988 Give a warning when a value of type @code{float} is implicitly
3989 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
3990 floating-point unit implement @code{float} in hardware, but emulate
3991 @code{double} in software.  On such a machine, doing computations
3992 using @code{double} values is much more expensive because of the
3993 overhead required for software emulation.
3995 It is easy to accidentally do computations with @code{double} because
3996 floating-point literals are implicitly of type @code{double}.  For
3997 example, in:
3998 @smallexample
3999 @group
4000 float area(float radius)
4002    return 3.14159 * radius * radius;
4004 @end group
4005 @end smallexample
4006 the compiler performs the entire computation with @code{double}
4007 because the floating-point literal is a @code{double}.
4009 @item -Wduplicate-decl-specifier @r{(C and Objective-C only)}
4010 @opindex Wduplicate-decl-specifier
4011 @opindex Wno-duplicate-decl-specifier
4012 Warn if a declaration has duplicate @code{const}, @code{volatile},
4013 @code{restrict} or @code{_Atomic} specifier.  This warning is enabled by
4014 @option{-Wall}.
4016 @item -Wformat
4017 @itemx -Wformat=@var{n}
4018 @opindex Wformat
4019 @opindex Wno-format
4020 @opindex ffreestanding
4021 @opindex fno-builtin
4022 @opindex Wformat=
4023 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
4024 the arguments supplied have types appropriate to the format string
4025 specified, and that the conversions specified in the format string make
4026 sense.  This includes standard functions, and others specified by format
4027 attributes (@pxref{Function Attributes}), in the @code{printf},
4028 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
4029 not in the C standard) families (or other target-specific families).
4030 Which functions are checked without format attributes having been
4031 specified depends on the standard version selected, and such checks of
4032 functions without the attribute specified are disabled by
4033 @option{-ffreestanding} or @option{-fno-builtin}.
4035 The formats are checked against the format features supported by GNU
4036 libc version 2.2.  These include all ISO C90 and C99 features, as well
4037 as features from the Single Unix Specification and some BSD and GNU
4038 extensions.  Other library implementations may not support all these
4039 features; GCC does not support warning about features that go beyond a
4040 particular library's limitations.  However, if @option{-Wpedantic} is used
4041 with @option{-Wformat}, warnings are given about format features not
4042 in the selected standard version (but not for @code{strfmon} formats,
4043 since those are not in any version of the C standard).  @xref{C Dialect
4044 Options,,Options Controlling C Dialect}.
4046 @table @gcctabopt
4047 @item -Wformat=1
4048 @itemx -Wformat
4049 @opindex Wformat
4050 @opindex Wformat=1
4051 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
4052 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
4053 @option{-Wformat} also checks for null format arguments for several
4054 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
4055 aspects of this level of format checking can be disabled by the
4056 options: @option{-Wno-format-contains-nul},
4057 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
4058 @option{-Wformat} is enabled by @option{-Wall}.
4060 @item -Wno-format-contains-nul
4061 @opindex Wno-format-contains-nul
4062 @opindex Wformat-contains-nul
4063 If @option{-Wformat} is specified, do not warn about format strings that
4064 contain NUL bytes.
4066 @item -Wno-format-extra-args
4067 @opindex Wno-format-extra-args
4068 @opindex Wformat-extra-args
4069 If @option{-Wformat} is specified, do not warn about excess arguments to a
4070 @code{printf} or @code{scanf} format function.  The C standard specifies
4071 that such arguments are ignored.
4073 Where the unused arguments lie between used arguments that are
4074 specified with @samp{$} operand number specifications, normally
4075 warnings are still given, since the implementation could not know what
4076 type to pass to @code{va_arg} to skip the unused arguments.  However,
4077 in the case of @code{scanf} formats, this option suppresses the
4078 warning if the unused arguments are all pointers, since the Single
4079 Unix Specification says that such unused arguments are allowed.
4081 @item -Wformat-overflow
4082 @itemx -Wformat-overflow=@var{level}
4083 @opindex Wformat-overflow
4084 @opindex Wno-format-overflow
4085 Warn about calls to formatted input/output functions such as @code{sprintf}
4086 and @code{vsprintf} that might overflow the destination buffer.  When the
4087 exact number of bytes written by a format directive cannot be determined
4088 at compile-time it is estimated based on heuristics that depend on the
4089 @var{level} argument and on optimization.  While enabling optimization
4090 will in most cases improve the accuracy of the warning, it may also
4091 result in false positives.
4093 @table @gcctabopt
4094 @item -Wformat-overflow
4095 @item -Wformat-overflow=1
4096 @opindex Wformat-overflow
4097 @opindex Wno-format-overflow
4098 Level @var{1} of @option{-Wformat-overflow} enabled by @option{-Wformat}
4099 employs a conservative approach that warns only about calls that most
4100 likely overflow the buffer.  At this level, numeric arguments to format
4101 directives with unknown values are assumed to have the value of one, and
4102 strings of unknown length to be empty.  Numeric arguments that are known
4103 to be bounded to a subrange of their type, or string arguments whose output
4104 is bounded either by their directive's precision or by a finite set of
4105 string literals, are assumed to take on the value within the range that
4106 results in the most bytes on output.  For example, the call to @code{sprintf}
4107 below is diagnosed because even with both @var{a} and @var{b} equal to zero,
4108 the terminating NUL character (@code{'\0'}) appended by the function
4109 to the destination buffer will be written past its end.  Increasing
4110 the size of the buffer by a single byte is sufficient to avoid the
4111 warning, though it may not be sufficient to avoid the overflow.
4113 @smallexample
4114 void f (int a, int b)
4116   char buf [12];
4117   sprintf (buf, "a = %i, b = %i\n", a, b);
4119 @end smallexample
4121 @item -Wformat-overflow=2
4122 Level @var{2} warns also about calls that might overflow the destination
4123 buffer given an argument of sufficient length or magnitude.  At level
4124 @var{2}, unknown numeric arguments are assumed to have the minimum
4125 representable value for signed types with a precision greater than 1, and
4126 the maximum representable value otherwise.  Unknown string arguments whose
4127 length cannot be assumed to be bounded either by the directive's precision,
4128 or by a finite set of string literals they may evaluate to, or the character
4129 array they may point to, are assumed to be 1 character long.
4131 At level @var{2}, the call in the example above is again diagnosed, but
4132 this time because with @var{a} equal to a 32-bit @code{INT_MIN} the first
4133 @code{%i} directive will write some of its digits beyond the end of
4134 the destination buffer.  To make the call safe regardless of the values
4135 of the two variables, the size of the destination buffer must be increased
4136 to at least 34 bytes.  GCC includes the minimum size of the buffer in
4137 an informational note following the warning.
4139 An alternative to increasing the size of the destination buffer is to
4140 constrain the range of formatted values.  The maximum length of string
4141 arguments can be bounded by specifying the precision in the format
4142 directive.  When numeric arguments of format directives can be assumed
4143 to be bounded by less than the precision of their type, choosing
4144 an appropriate length modifier to the format specifier will reduce
4145 the required buffer size.  For example, if @var{a} and @var{b} in the
4146 example above can be assumed to be within the precision of
4147 the @code{short int} type then using either the @code{%hi} format
4148 directive or casting the argument to @code{short} reduces the maximum
4149 required size of the buffer to 24 bytes.
4151 @smallexample
4152 void f (int a, int b)
4154   char buf [23];
4155   sprintf (buf, "a = %hi, b = %i\n", a, (short)b);
4157 @end smallexample
4158 @end table
4160 @item -Wno-format-zero-length
4161 @opindex Wno-format-zero-length
4162 @opindex Wformat-zero-length
4163 If @option{-Wformat} is specified, do not warn about zero-length formats.
4164 The C standard specifies that zero-length formats are allowed.
4167 @item -Wformat=2
4168 @opindex Wformat=2
4169 Enable @option{-Wformat} plus additional format checks.  Currently
4170 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
4171 -Wformat-y2k}.
4173 @item -Wformat-nonliteral
4174 @opindex Wformat-nonliteral
4175 @opindex Wno-format-nonliteral
4176 If @option{-Wformat} is specified, also warn if the format string is not a
4177 string literal and so cannot be checked, unless the format function
4178 takes its format arguments as a @code{va_list}.
4180 @item -Wformat-security
4181 @opindex Wformat-security
4182 @opindex Wno-format-security
4183 If @option{-Wformat} is specified, also warn about uses of format
4184 functions that represent possible security problems.  At present, this
4185 warns about calls to @code{printf} and @code{scanf} functions where the
4186 format string is not a string literal and there are no format arguments,
4187 as in @code{printf (foo);}.  This may be a security hole if the format
4188 string came from untrusted input and contains @samp{%n}.  (This is
4189 currently a subset of what @option{-Wformat-nonliteral} warns about, but
4190 in future warnings may be added to @option{-Wformat-security} that are not
4191 included in @option{-Wformat-nonliteral}.)
4193 @item -Wformat-signedness
4194 @opindex Wformat-signedness
4195 @opindex Wno-format-signedness
4196 If @option{-Wformat} is specified, also warn if the format string
4197 requires an unsigned argument and the argument is signed and vice versa.
4199 @item -Wformat-truncation
4200 @itemx -Wformat-truncation=@var{level}
4201 @opindex Wformat-truncation
4202 @opindex Wno-format-truncation
4203 Warn about calls to formatted input/output functions such as @code{snprintf}
4204 and @code{vsnprintf} that might result in output truncation.  When the exact
4205 number of bytes written by a format directive cannot be determined at
4206 compile-time it is estimated based on heuristics that depend on
4207 the @var{level} argument and on optimization.  While enabling optimization
4208 will in most cases improve the accuracy of the warning, it may also result
4209 in false positives.  Except as noted otherwise, the option uses the same
4210 logic @option{-Wformat-overflow}.
4212 @table @gcctabopt
4213 @item -Wformat-truncation
4214 @item -Wformat-truncation=1
4215 @opindex Wformat-truncation
4216 @opindex Wno-format-overflow
4217 Level @var{1} of @option{-Wformat-truncation} enabled by @option{-Wformat}
4218 employs a conservative approach that warns only about calls to bounded
4219 functions whose return value is unused and that will most likely result
4220 in output truncation.
4222 @item -Wformat-truncation=2
4223 Level @var{2} warns also about calls to bounded functions whose return
4224 value is used and that might result in truncation given an argument of
4225 sufficient length or magnitude.
4226 @end table
4228 @item -Wformat-y2k
4229 @opindex Wformat-y2k
4230 @opindex Wno-format-y2k
4231 If @option{-Wformat} is specified, also warn about @code{strftime}
4232 formats that may yield only a two-digit year.
4233 @end table
4235 @item -Wnonnull
4236 @opindex Wnonnull
4237 @opindex Wno-nonnull
4238 Warn about passing a null pointer for arguments marked as
4239 requiring a non-null value by the @code{nonnull} function attribute.
4241 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
4242 can be disabled with the @option{-Wno-nonnull} option.
4244 @item -Wnonnull-compare
4245 @opindex Wnonnull-compare
4246 @opindex Wno-nonnull-compare
4247 Warn when comparing an argument marked with the @code{nonnull}
4248 function attribute against null inside the function.
4250 @option{-Wnonnull-compare} is included in @option{-Wall}.  It
4251 can be disabled with the @option{-Wno-nonnull-compare} option.
4253 @item -Wnull-dereference
4254 @opindex Wnull-dereference
4255 @opindex Wno-null-dereference
4256 Warn if the compiler detects paths that trigger erroneous or
4257 undefined behavior due to dereferencing a null pointer.  This option
4258 is only active when @option{-fdelete-null-pointer-checks} is active,
4259 which is enabled by optimizations in most targets.  The precision of
4260 the warnings depends on the optimization options used.
4262 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
4263 @opindex Winit-self
4264 @opindex Wno-init-self
4265 Warn about uninitialized variables that are initialized with themselves.
4266 Note this option can only be used with the @option{-Wuninitialized} option.
4268 For example, GCC warns about @code{i} being uninitialized in the
4269 following snippet only when @option{-Winit-self} has been specified:
4270 @smallexample
4271 @group
4272 int f()
4274   int i = i;
4275   return i;
4277 @end group
4278 @end smallexample
4280 This warning is enabled by @option{-Wall} in C++.
4282 @item -Wimplicit-int @r{(C and Objective-C only)}
4283 @opindex Wimplicit-int
4284 @opindex Wno-implicit-int
4285 Warn when a declaration does not specify a type.
4286 This warning is enabled by @option{-Wall}.
4288 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
4289 @opindex Wimplicit-function-declaration
4290 @opindex Wno-implicit-function-declaration
4291 Give a warning whenever a function is used before being declared. In
4292 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
4293 enabled by default and it is made into an error by
4294 @option{-pedantic-errors}. This warning is also enabled by
4295 @option{-Wall}.
4297 @item -Wimplicit @r{(C and Objective-C only)}
4298 @opindex Wimplicit
4299 @opindex Wno-implicit
4300 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
4301 This warning is enabled by @option{-Wall}.
4303 @item -Wimplicit-fallthrough
4304 @opindex Wimplicit-fallthrough
4305 @opindex Wno-implicit-fallthrough
4306 @option{-Wimplicit-fallthrough} is the same as @option{-Wimplicit-fallthrough=3}
4307 and @option{-Wno-implicit-fallthrough} is the same as
4308 @option{-Wimplicit-fallthrough=0}.
4310 @item -Wimplicit-fallthrough=@var{n}
4311 @opindex Wimplicit-fallthrough=
4312 Warn when a switch case falls through.  For example:
4314 @smallexample
4315 @group
4316 switch (cond)
4317   @{
4318   case 1:
4319     a = 1;
4320     break;
4321   case 2:
4322     a = 2;
4323   case 3:
4324     a = 3;
4325     break;
4326   @}
4327 @end group
4328 @end smallexample
4330 This warning does not warn when the last statement of a case cannot
4331 fall through, e.g. when there is a return statement or a call to function
4332 declared with the noreturn attribute.  @option{-Wimplicit-fallthrough=}
4333 also takes into account control flow statements, such as ifs, and only
4334 warns when appropriate.  E.g.@:
4336 @smallexample
4337 @group
4338 switch (cond)
4339   @{
4340   case 1:
4341     if (i > 3) @{
4342       bar (5);
4343       break;
4344     @} else if (i < 1) @{
4345       bar (0);
4346     @} else
4347       return;
4348   default:
4349     @dots{}
4350   @}
4351 @end group
4352 @end smallexample
4354 Since there are occasions where a switch case fall through is desirable,
4355 GCC provides an attribute, @code{__attribute__ ((fallthrough))}, that is
4356 to be used along with a null statement to suppress this warning that
4357 would normally occur:
4359 @smallexample
4360 @group
4361 switch (cond)
4362   @{
4363   case 1:
4364     bar (0);
4365     __attribute__ ((fallthrough));
4366   default:
4367     @dots{}
4368   @}
4369 @end group
4370 @end smallexample
4372 C++17 provides a standard way to suppress the @option{-Wimplicit-fallthrough}
4373 warning using @code{[[fallthrough]];} instead of the GNU attribute.  In C++11
4374 or C++14 users can use @code{[[gnu::fallthrough]];}, which is a GNU extension.
4375 Instead of these attributes, it is also possible to add a fallthrough comment
4376 to silence the warning.  The whole body of the C or C++ style comment should
4377 match the given regular expressions listed below.  The option argument @var{n}
4378 specifies what kind of comments are accepted:
4380 @itemize @bullet
4382 @item @option{-Wimplicit-fallthrough=0} disables the warning altogether.
4384 @item @option{-Wimplicit-fallthrough=1} matches @code{.*} regular
4385 expression, any comment is used as fallthrough comment.
4387 @item @option{-Wimplicit-fallthrough=2} case insensitively matches
4388 @code{.*falls?[ \t-]*thr(ough|u).*} regular expression.
4390 @item @option{-Wimplicit-fallthrough=3} case sensitively matches one of the
4391 following regular expressions:
4393 @itemize @bullet
4395 @item @code{-fallthrough}
4397 @item @code{@@fallthrough@@}
4399 @item @code{lint -fallthrough[ \t]*}
4401 @item @code{[ \t.!]*(ELSE,? |INTENTIONAL(LY)? )?@*FALL(S | |-)?THR(OUGH|U)[ \t.!]*(-[^\n\r]*)?}
4403 @item @code{[ \t.!]*(Else,? |Intentional(ly)? )?@*Fall((s | |-)[Tt]|t)hr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4405 @item @code{[ \t.!]*([Ee]lse,? |[Ii]ntentional(ly)? )?@*fall(s | |-)?thr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4407 @end itemize
4409 @item @option{-Wimplicit-fallthrough=4} case sensitively matches one of the
4410 following regular expressions:
4412 @itemize @bullet
4414 @item @code{-fallthrough}
4416 @item @code{@@fallthrough@@}
4418 @item @code{lint -fallthrough[ \t]*}
4420 @item @code{[ \t]*FALLTHR(OUGH|U)[ \t]*}
4422 @end itemize
4424 @item @option{-Wimplicit-fallthrough=5} doesn't recognize any comments as
4425 fallthrough comments, only attributes disable the warning.
4427 @end itemize
4429 The comment needs to be followed after optional whitespace and other comments
4430 by @code{case} or @code{default} keywords or by a user label that precedes some
4431 @code{case} or @code{default} label.
4433 @smallexample
4434 @group
4435 switch (cond)
4436   @{
4437   case 1:
4438     bar (0);
4439     /* FALLTHRU */
4440   default:
4441     @dots{}
4442   @}
4443 @end group
4444 @end smallexample
4446 The @option{-Wimplicit-fallthrough=3} warning is enabled by @option{-Wextra}.
4448 @item -Wif-not-aligned @r{(C, C++, Objective-C and Objective-C++ only)}
4449 @opindex Wif-not-aligned
4450 @opindex Wno-if-not-aligned
4451 Control if warning triggered by the @code{warn_if_not_aligned} attribute
4452 should be issued.  This is is enabled by default.
4453 Use @option{-Wno-if-not-aligned} to disable it.
4455 @item -Wignored-qualifiers @r{(C and C++ only)}
4456 @opindex Wignored-qualifiers
4457 @opindex Wno-ignored-qualifiers
4458 Warn if the return type of a function has a type qualifier
4459 such as @code{const}.  For ISO C such a type qualifier has no effect,
4460 since the value returned by a function is not an lvalue.
4461 For C++, the warning is only emitted for scalar types or @code{void}.
4462 ISO C prohibits qualified @code{void} return types on function
4463 definitions, so such return types always receive a warning
4464 even without this option.
4466 This warning is also enabled by @option{-Wextra}.
4468 @item -Wignored-attributes @r{(C and C++ only)}
4469 @opindex Wignored-attributes
4470 @opindex Wno-ignored-attributes
4471 Warn when an attribute is ignored.  This is different from the
4472 @option{-Wattributes} option in that it warns whenever the compiler decides
4473 to drop an attribute, not that the attribute is either unknown, used in a
4474 wrong place, etc.  This warning is enabled by default.
4476 @item -Wmain
4477 @opindex Wmain
4478 @opindex Wno-main
4479 Warn if the type of @code{main} is suspicious.  @code{main} should be
4480 a function with external linkage, returning int, taking either zero
4481 arguments, two, or three arguments of appropriate types.  This warning
4482 is enabled by default in C++ and is enabled by either @option{-Wall}
4483 or @option{-Wpedantic}.
4485 @item -Wmisleading-indentation @r{(C and C++ only)}
4486 @opindex Wmisleading-indentation
4487 @opindex Wno-misleading-indentation
4488 Warn when the indentation of the code does not reflect the block structure.
4489 Specifically, a warning is issued for @code{if}, @code{else}, @code{while}, and
4490 @code{for} clauses with a guarded statement that does not use braces,
4491 followed by an unguarded statement with the same indentation.
4493 In the following example, the call to ``bar'' is misleadingly indented as
4494 if it were guarded by the ``if'' conditional.
4496 @smallexample
4497   if (some_condition ())
4498     foo ();
4499     bar ();  /* Gotcha: this is not guarded by the "if".  */
4500 @end smallexample
4502 In the case of mixed tabs and spaces, the warning uses the
4503 @option{-ftabstop=} option to determine if the statements line up
4504 (defaulting to 8).
4506 The warning is not issued for code involving multiline preprocessor logic
4507 such as the following example.
4509 @smallexample
4510   if (flagA)
4511     foo (0);
4512 #if SOME_CONDITION_THAT_DOES_NOT_HOLD
4513   if (flagB)
4514 #endif
4515     foo (1);
4516 @end smallexample
4518 The warning is not issued after a @code{#line} directive, since this
4519 typically indicates autogenerated code, and no assumptions can be made
4520 about the layout of the file that the directive references.
4522 This warning is enabled by @option{-Wall} in C and C++.
4524 @item -Wmissing-braces
4525 @opindex Wmissing-braces
4526 @opindex Wno-missing-braces
4527 Warn if an aggregate or union initializer is not fully bracketed.  In
4528 the following example, the initializer for @code{a} is not fully
4529 bracketed, but that for @code{b} is fully bracketed.  This warning is
4530 enabled by @option{-Wall} in C.
4532 @smallexample
4533 int a[2][2] = @{ 0, 1, 2, 3 @};
4534 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
4535 @end smallexample
4537 This warning is enabled by @option{-Wall}.
4539 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
4540 @opindex Wmissing-include-dirs
4541 @opindex Wno-missing-include-dirs
4542 Warn if a user-supplied include directory does not exist.
4544 @item -Wmultistatement-macros
4545 @opindex Wmultistatement-macros
4546 @opindex Wno-multistatement-macros
4547 Warn about unsafe multiple statement macros that appear to be guarded
4548 by a clause such as @code{if}, @code{else}, @code{for}, @code{switch}, or
4549 @code{while}, in which only the first statement is actually guarded after
4550 the macro is expanded.
4552 For example:
4554 @smallexample
4555 #define DOIT x++; y++
4556 if (c)
4557   DOIT;
4558 @end smallexample
4560 will increment @code{y} unconditionally, not just when @code{c} holds.
4561 The can usually be fixed by wrapping the macro in a do-while loop:
4562 @smallexample
4563 #define DOIT do @{ x++; y++; @} while (0)
4564 if (c)
4565   DOIT;
4566 @end smallexample
4568 This warning is enabled by @option{-Wall} in C and C++.
4570 @item -Wparentheses
4571 @opindex Wparentheses
4572 @opindex Wno-parentheses
4573 Warn if parentheses are omitted in certain contexts, such
4574 as when there is an assignment in a context where a truth value
4575 is expected, or when operators are nested whose precedence people
4576 often get confused about.
4578 Also warn if a comparison like @code{x<=y<=z} appears; this is
4579 equivalent to @code{(x<=y ? 1 : 0) <= z}, which is a different
4580 interpretation from that of ordinary mathematical notation.
4582 Also warn for dangerous uses of the GNU extension to
4583 @code{?:} with omitted middle operand. When the condition
4584 in the @code{?}: operator is a boolean expression, the omitted value is
4585 always 1.  Often programmers expect it to be a value computed
4586 inside the conditional expression instead.
4588 For C++ this also warns for some cases of unnecessary parentheses in
4589 declarations, which can indicate an attempt at a function call instead
4590 of a declaration:
4591 @smallexample
4593   // Declares a local variable called mymutex.
4594   std::unique_lock<std::mutex> (mymutex);
4595   // User meant std::unique_lock<std::mutex> lock (mymutex);
4597 @end smallexample
4599 This warning is enabled by @option{-Wall}.
4601 @item -Wsequence-point
4602 @opindex Wsequence-point
4603 @opindex Wno-sequence-point
4604 Warn about code that may have undefined semantics because of violations
4605 of sequence point rules in the C and C++ standards.
4607 The C and C++ standards define the order in which expressions in a C/C++
4608 program are evaluated in terms of @dfn{sequence points}, which represent
4609 a partial ordering between the execution of parts of the program: those
4610 executed before the sequence point, and those executed after it.  These
4611 occur after the evaluation of a full expression (one which is not part
4612 of a larger expression), after the evaluation of the first operand of a
4613 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
4614 function is called (but after the evaluation of its arguments and the
4615 expression denoting the called function), and in certain other places.
4616 Other than as expressed by the sequence point rules, the order of
4617 evaluation of subexpressions of an expression is not specified.  All
4618 these rules describe only a partial order rather than a total order,
4619 since, for example, if two functions are called within one expression
4620 with no sequence point between them, the order in which the functions
4621 are called is not specified.  However, the standards committee have
4622 ruled that function calls do not overlap.
4624 It is not specified when between sequence points modifications to the
4625 values of objects take effect.  Programs whose behavior depends on this
4626 have undefined behavior; the C and C++ standards specify that ``Between
4627 the previous and next sequence point an object shall have its stored
4628 value modified at most once by the evaluation of an expression.
4629 Furthermore, the prior value shall be read only to determine the value
4630 to be stored.''.  If a program breaks these rules, the results on any
4631 particular implementation are entirely unpredictable.
4633 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
4634 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
4635 diagnosed by this option, and it may give an occasional false positive
4636 result, but in general it has been found fairly effective at detecting
4637 this sort of problem in programs.
4639 The C++17 standard will define the order of evaluation of operands in
4640 more cases: in particular it requires that the right-hand side of an
4641 assignment be evaluated before the left-hand side, so the above
4642 examples are no longer undefined.  But this warning will still warn
4643 about them, to help people avoid writing code that is undefined in C
4644 and earlier revisions of C++.
4646 The standard is worded confusingly, therefore there is some debate
4647 over the precise meaning of the sequence point rules in subtle cases.
4648 Links to discussions of the problem, including proposed formal
4649 definitions, may be found on the GCC readings page, at
4650 @uref{http://gcc.gnu.org/@/readings.html}.
4652 This warning is enabled by @option{-Wall} for C and C++.
4654 @item -Wno-return-local-addr
4655 @opindex Wno-return-local-addr
4656 @opindex Wreturn-local-addr
4657 Do not warn about returning a pointer (or in C++, a reference) to a
4658 variable that goes out of scope after the function returns.
4660 @item -Wreturn-type
4661 @opindex Wreturn-type
4662 @opindex Wno-return-type
4663 Warn whenever a function is defined with a return type that defaults
4664 to @code{int}.  Also warn about any @code{return} statement with no
4665 return value in a function whose return type is not @code{void}
4666 (falling off the end of the function body is considered returning
4667 without a value).
4669 For C only, warn about a @code{return} statement with an expression in a
4670 function whose return type is @code{void}, unless the expression type is
4671 also @code{void}.  As a GNU extension, the latter case is accepted
4672 without a warning unless @option{-Wpedantic} is used.
4674 For C++, a function without return type always produces a diagnostic
4675 message, even when @option{-Wno-return-type} is specified.  The only
4676 exceptions are @code{main} and functions defined in system headers.
4678 This warning is enabled by @option{-Wall}.
4680 @item -Wshift-count-negative
4681 @opindex Wshift-count-negative
4682 @opindex Wno-shift-count-negative
4683 Warn if shift count is negative. This warning is enabled by default.
4685 @item -Wshift-count-overflow
4686 @opindex Wshift-count-overflow
4687 @opindex Wno-shift-count-overflow
4688 Warn if shift count >= width of type. This warning is enabled by default.
4690 @item -Wshift-negative-value
4691 @opindex Wshift-negative-value
4692 @opindex Wno-shift-negative-value
4693 Warn if left shifting a negative value.  This warning is enabled by
4694 @option{-Wextra} in C99 and C++11 modes (and newer).
4696 @item -Wshift-overflow
4697 @itemx -Wshift-overflow=@var{n}
4698 @opindex Wshift-overflow
4699 @opindex Wno-shift-overflow
4700 Warn about left shift overflows.  This warning is enabled by
4701 default in C99 and C++11 modes (and newer).
4703 @table @gcctabopt
4704 @item -Wshift-overflow=1
4705 This is the warning level of @option{-Wshift-overflow} and is enabled
4706 by default in C99 and C++11 modes (and newer).  This warning level does
4707 not warn about left-shifting 1 into the sign bit.  (However, in C, such
4708 an overflow is still rejected in contexts where an integer constant expression
4709 is required.)
4711 @item -Wshift-overflow=2
4712 This warning level also warns about left-shifting 1 into the sign bit,
4713 unless C++14 mode is active.
4714 @end table
4716 @item -Wswitch
4717 @opindex Wswitch
4718 @opindex Wno-switch
4719 Warn whenever a @code{switch} statement has an index of enumerated type
4720 and lacks a @code{case} for one or more of the named codes of that
4721 enumeration.  (The presence of a @code{default} label prevents this
4722 warning.)  @code{case} labels outside the enumeration range also
4723 provoke warnings when this option is used (even if there is a
4724 @code{default} label).
4725 This warning is enabled by @option{-Wall}.
4727 @item -Wswitch-default
4728 @opindex Wswitch-default
4729 @opindex Wno-switch-default
4730 Warn whenever a @code{switch} statement does not have a @code{default}
4731 case.
4733 @item -Wswitch-enum
4734 @opindex Wswitch-enum
4735 @opindex Wno-switch-enum
4736 Warn whenever a @code{switch} statement has an index of enumerated type
4737 and lacks a @code{case} for one or more of the named codes of that
4738 enumeration.  @code{case} labels outside the enumeration range also
4739 provoke warnings when this option is used.  The only difference
4740 between @option{-Wswitch} and this option is that this option gives a
4741 warning about an omitted enumeration code even if there is a
4742 @code{default} label.
4744 @item -Wswitch-bool
4745 @opindex Wswitch-bool
4746 @opindex Wno-switch-bool
4747 Warn whenever a @code{switch} statement has an index of boolean type
4748 and the case values are outside the range of a boolean type.
4749 It is possible to suppress this warning by casting the controlling
4750 expression to a type other than @code{bool}.  For example:
4751 @smallexample
4752 @group
4753 switch ((int) (a == 4))
4754   @{
4755   @dots{}
4756   @}
4757 @end group
4758 @end smallexample
4759 This warning is enabled by default for C and C++ programs.
4761 @item -Wswitch-unreachable
4762 @opindex Wswitch-unreachable
4763 @opindex Wno-switch-unreachable
4764 Warn whenever a @code{switch} statement contains statements between the
4765 controlling expression and the first case label, which will never be
4766 executed.  For example:
4767 @smallexample
4768 @group
4769 switch (cond)
4770   @{
4771    i = 15;
4772   @dots{}
4773    case 5:
4774   @dots{}
4775   @}
4776 @end group
4777 @end smallexample
4778 @option{-Wswitch-unreachable} does not warn if the statement between the
4779 controlling expression and the first case label is just a declaration:
4780 @smallexample
4781 @group
4782 switch (cond)
4783   @{
4784    int i;
4785   @dots{}
4786    case 5:
4787    i = 5;
4788   @dots{}
4789   @}
4790 @end group
4791 @end smallexample
4792 This warning is enabled by default for C and C++ programs.
4794 @item -Wsync-nand @r{(C and C++ only)}
4795 @opindex Wsync-nand
4796 @opindex Wno-sync-nand
4797 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
4798 built-in functions are used.  These functions changed semantics in GCC 4.4.
4800 @item -Wunused-but-set-parameter
4801 @opindex Wunused-but-set-parameter
4802 @opindex Wno-unused-but-set-parameter
4803 Warn whenever a function parameter is assigned to, but otherwise unused
4804 (aside from its declaration).
4806 To suppress this warning use the @code{unused} attribute
4807 (@pxref{Variable Attributes}).
4809 This warning is also enabled by @option{-Wunused} together with
4810 @option{-Wextra}.
4812 @item -Wunused-but-set-variable
4813 @opindex Wunused-but-set-variable
4814 @opindex Wno-unused-but-set-variable
4815 Warn whenever a local variable is assigned to, but otherwise unused
4816 (aside from its declaration).
4817 This warning is enabled by @option{-Wall}.
4819 To suppress this warning use the @code{unused} attribute
4820 (@pxref{Variable Attributes}).
4822 This warning is also enabled by @option{-Wunused}, which is enabled
4823 by @option{-Wall}.
4825 @item -Wunused-function
4826 @opindex Wunused-function
4827 @opindex Wno-unused-function
4828 Warn whenever a static function is declared but not defined or a
4829 non-inline static function is unused.
4830 This warning is enabled by @option{-Wall}.
4832 @item -Wunused-label
4833 @opindex Wunused-label
4834 @opindex Wno-unused-label
4835 Warn whenever a label is declared but not used.
4836 This warning is enabled by @option{-Wall}.
4838 To suppress this warning use the @code{unused} attribute
4839 (@pxref{Variable Attributes}).
4841 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
4842 @opindex Wunused-local-typedefs
4843 Warn when a typedef locally defined in a function is not used.
4844 This warning is enabled by @option{-Wall}.
4846 @item -Wunused-parameter
4847 @opindex Wunused-parameter
4848 @opindex Wno-unused-parameter
4849 Warn whenever a function parameter is unused aside from its declaration.
4851 To suppress this warning use the @code{unused} attribute
4852 (@pxref{Variable Attributes}).
4854 @item -Wno-unused-result
4855 @opindex Wunused-result
4856 @opindex Wno-unused-result
4857 Do not warn if a caller of a function marked with attribute
4858 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
4859 its return value. The default is @option{-Wunused-result}.
4861 @item -Wunused-variable
4862 @opindex Wunused-variable
4863 @opindex Wno-unused-variable
4864 Warn whenever a local or static variable is unused aside from its
4865 declaration. This option implies @option{-Wunused-const-variable=1} for C,
4866 but not for C++. This warning is enabled by @option{-Wall}.
4868 To suppress this warning use the @code{unused} attribute
4869 (@pxref{Variable Attributes}).
4871 @item -Wunused-const-variable
4872 @itemx -Wunused-const-variable=@var{n}
4873 @opindex Wunused-const-variable
4874 @opindex Wno-unused-const-variable
4875 Warn whenever a constant static variable is unused aside from its declaration.
4876 @option{-Wunused-const-variable=1} is enabled by @option{-Wunused-variable}
4877 for C, but not for C++. In C this declares variable storage, but in C++ this
4878 is not an error since const variables take the place of @code{#define}s.
4880 To suppress this warning use the @code{unused} attribute
4881 (@pxref{Variable Attributes}).
4883 @table @gcctabopt
4884 @item -Wunused-const-variable=1
4885 This is the warning level that is enabled by @option{-Wunused-variable} for
4886 C.  It warns only about unused static const variables defined in the main
4887 compilation unit, but not about static const variables declared in any
4888 header included.
4890 @item -Wunused-const-variable=2
4891 This warning level also warns for unused constant static variables in
4892 headers (excluding system headers).  This is the warning level of
4893 @option{-Wunused-const-variable} and must be explicitly requested since
4894 in C++ this isn't an error and in C it might be harder to clean up all
4895 headers included.
4896 @end table
4898 @item -Wunused-value
4899 @opindex Wunused-value
4900 @opindex Wno-unused-value
4901 Warn whenever a statement computes a result that is explicitly not
4902 used. To suppress this warning cast the unused expression to
4903 @code{void}. This includes an expression-statement or the left-hand
4904 side of a comma expression that contains no side effects. For example,
4905 an expression such as @code{x[i,j]} causes a warning, while
4906 @code{x[(void)i,j]} does not.
4908 This warning is enabled by @option{-Wall}.
4910 @item -Wunused
4911 @opindex Wunused
4912 @opindex Wno-unused
4913 All the above @option{-Wunused} options combined.
4915 In order to get a warning about an unused function parameter, you must
4916 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
4917 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
4919 @item -Wuninitialized
4920 @opindex Wuninitialized
4921 @opindex Wno-uninitialized
4922 Warn if an automatic variable is used without first being initialized
4923 or if a variable may be clobbered by a @code{setjmp} call. In C++,
4924 warn if a non-static reference or non-static @code{const} member
4925 appears in a class without constructors.
4927 If you want to warn about code that uses the uninitialized value of the
4928 variable in its own initializer, use the @option{-Winit-self} option.
4930 These warnings occur for individual uninitialized or clobbered
4931 elements of structure, union or array variables as well as for
4932 variables that are uninitialized or clobbered as a whole.  They do
4933 not occur for variables or elements declared @code{volatile}.  Because
4934 these warnings depend on optimization, the exact variables or elements
4935 for which there are warnings depends on the precise optimization
4936 options and version of GCC used.
4938 Note that there may be no warning about a variable that is used only
4939 to compute a value that itself is never used, because such
4940 computations may be deleted by data flow analysis before the warnings
4941 are printed.
4943 @item -Winvalid-memory-model
4944 @opindex Winvalid-memory-model
4945 @opindex Wno-invalid-memory-model
4946 Warn for invocations of @ref{__atomic Builtins}, @ref{__sync Builtins},
4947 and the C11 atomic generic functions with a memory consistency argument
4948 that is either invalid for the operation or outside the range of values
4949 of the @code{memory_order} enumeration.  For example, since the
4950 @code{__atomic_store} and @code{__atomic_store_n} built-ins are only
4951 defined for the relaxed, release, and sequentially consistent memory
4952 orders the following code is diagnosed:
4954 @smallexample
4955 void store (int *i)
4957   __atomic_store_n (i, 0, memory_order_consume);
4959 @end smallexample
4961 @option{-Winvalid-memory-model} is enabled by default.
4963 @item -Wmaybe-uninitialized
4964 @opindex Wmaybe-uninitialized
4965 @opindex Wno-maybe-uninitialized
4966 For an automatic (i.e.@ local) variable, if there exists a path from the
4967 function entry to a use of the variable that is initialized, but there exist
4968 some other paths for which the variable is not initialized, the compiler
4969 emits a warning if it cannot prove the uninitialized paths are not
4970 executed at run time.
4972 These warnings are only possible in optimizing compilation, because otherwise
4973 GCC does not keep track of the state of variables.
4975 These warnings are made optional because GCC may not be able to determine when
4976 the code is correct in spite of appearing to have an error.  Here is one
4977 example of how this can happen:
4979 @smallexample
4980 @group
4982   int x;
4983   switch (y)
4984     @{
4985     case 1: x = 1;
4986       break;
4987     case 2: x = 4;
4988       break;
4989     case 3: x = 5;
4990     @}
4991   foo (x);
4993 @end group
4994 @end smallexample
4996 @noindent
4997 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
4998 always initialized, but GCC doesn't know this. To suppress the
4999 warning, you need to provide a default case with assert(0) or
5000 similar code.
5002 @cindex @code{longjmp} warnings
5003 This option also warns when a non-volatile automatic variable might be
5004 changed by a call to @code{longjmp}.
5005 The compiler sees only the calls to @code{setjmp}.  It cannot know
5006 where @code{longjmp} will be called; in fact, a signal handler could
5007 call it at any point in the code.  As a result, you may get a warning
5008 even when there is in fact no problem because @code{longjmp} cannot
5009 in fact be called at the place that would cause a problem.
5011 Some spurious warnings can be avoided if you declare all the functions
5012 you use that never return as @code{noreturn}.  @xref{Function
5013 Attributes}.
5015 This warning is enabled by @option{-Wall} or @option{-Wextra}.
5017 @item -Wunknown-pragmas
5018 @opindex Wunknown-pragmas
5019 @opindex Wno-unknown-pragmas
5020 @cindex warning for unknown pragmas
5021 @cindex unknown pragmas, warning
5022 @cindex pragmas, warning of unknown
5023 Warn when a @code{#pragma} directive is encountered that is not understood by 
5024 GCC@.  If this command-line option is used, warnings are even issued
5025 for unknown pragmas in system header files.  This is not the case if
5026 the warnings are only enabled by the @option{-Wall} command-line option.
5028 @item -Wno-pragmas
5029 @opindex Wno-pragmas
5030 @opindex Wpragmas
5031 Do not warn about misuses of pragmas, such as incorrect parameters,
5032 invalid syntax, or conflicts between pragmas.  See also
5033 @option{-Wunknown-pragmas}.
5035 @item -Wstrict-aliasing
5036 @opindex Wstrict-aliasing
5037 @opindex Wno-strict-aliasing
5038 This option is only active when @option{-fstrict-aliasing} is active.
5039 It warns about code that might break the strict aliasing rules that the
5040 compiler is using for optimization.  The warning does not catch all
5041 cases, but does attempt to catch the more common pitfalls.  It is
5042 included in @option{-Wall}.
5043 It is equivalent to @option{-Wstrict-aliasing=3}
5045 @item -Wstrict-aliasing=n
5046 @opindex Wstrict-aliasing=n
5047 This option is only active when @option{-fstrict-aliasing} is active.
5048 It warns about code that might break the strict aliasing rules that the
5049 compiler is using for optimization.
5050 Higher levels correspond to higher accuracy (fewer false positives).
5051 Higher levels also correspond to more effort, similar to the way @option{-O} 
5052 works.
5053 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
5055 Level 1: Most aggressive, quick, least accurate.
5056 Possibly useful when higher levels
5057 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
5058 false negatives.  However, it has many false positives.
5059 Warns for all pointer conversions between possibly incompatible types,
5060 even if never dereferenced.  Runs in the front end only.
5062 Level 2: Aggressive, quick, not too precise.
5063 May still have many false positives (not as many as level 1 though),
5064 and few false negatives (but possibly more than level 1).
5065 Unlike level 1, it only warns when an address is taken.  Warns about
5066 incomplete types.  Runs in the front end only.
5068 Level 3 (default for @option{-Wstrict-aliasing}):
5069 Should have very few false positives and few false
5070 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
5071 Takes care of the common pun+dereference pattern in the front end:
5072 @code{*(int*)&some_float}.
5073 If optimization is enabled, it also runs in the back end, where it deals
5074 with multiple statement cases using flow-sensitive points-to information.
5075 Only warns when the converted pointer is dereferenced.
5076 Does not warn about incomplete types.
5078 @item -Wstrict-overflow
5079 @itemx -Wstrict-overflow=@var{n}
5080 @opindex Wstrict-overflow
5081 @opindex Wno-strict-overflow
5082 This option is only active when signed overflow is undefined.
5083 It warns about cases where the compiler optimizes based on the
5084 assumption that signed overflow does not occur.  Note that it does not
5085 warn about all cases where the code might overflow: it only warns
5086 about cases where the compiler implements some optimization.  Thus
5087 this warning depends on the optimization level.
5089 An optimization that assumes that signed overflow does not occur is
5090 perfectly safe if the values of the variables involved are such that
5091 overflow never does, in fact, occur.  Therefore this warning can
5092 easily give a false positive: a warning about code that is not
5093 actually a problem.  To help focus on important issues, several
5094 warning levels are defined.  No warnings are issued for the use of
5095 undefined signed overflow when estimating how many iterations a loop
5096 requires, in particular when determining whether a loop will be
5097 executed at all.
5099 @table @gcctabopt
5100 @item -Wstrict-overflow=1
5101 Warn about cases that are both questionable and easy to avoid.  For
5102 example the compiler simplifies
5103 @code{x + 1 > x} to @code{1}.  This level of
5104 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
5105 are not, and must be explicitly requested.
5107 @item -Wstrict-overflow=2
5108 Also warn about other cases where a comparison is simplified to a
5109 constant.  For example: @code{abs (x) >= 0}.  This can only be
5110 simplified when signed integer overflow is undefined, because
5111 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
5112 zero.  @option{-Wstrict-overflow} (with no level) is the same as
5113 @option{-Wstrict-overflow=2}.
5115 @item -Wstrict-overflow=3
5116 Also warn about other cases where a comparison is simplified.  For
5117 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
5119 @item -Wstrict-overflow=4
5120 Also warn about other simplifications not covered by the above cases.
5121 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
5123 @item -Wstrict-overflow=5
5124 Also warn about cases where the compiler reduces the magnitude of a
5125 constant involved in a comparison.  For example: @code{x + 2 > y} is
5126 simplified to @code{x + 1 >= y}.  This is reported only at the
5127 highest warning level because this simplification applies to many
5128 comparisons, so this warning level gives a very large number of
5129 false positives.
5130 @end table
5132 @item -Wstringop-overflow
5133 @itemx -Wstringop-overflow=@var{type}
5134 @opindex Wstringop-overflow
5135 @opindex Wno-stringop-overflow
5136 Warn for calls to string manipulation functions such as @code{memcpy} and
5137 @code{strcpy} that are determined to overflow the destination buffer.  The
5138 optional argument is one greater than the type of Object Size Checking to
5139 perform to determine the size of the destination.  @xref{Object Size Checking}.
5140 The argument is meaningful only for functions that operate on character arrays
5141 but not for raw memory functions like @code{memcpy} which always make use
5142 of Object Size type-0.  The option also warns for calls that specify a size
5143 in excess of the largest possible object or at most @code{SIZE_MAX / 2} bytes.
5144 The option produces the best results with optimization enabled but can detect
5145 a small subset of simple buffer overflows even without optimization in
5146 calls to the GCC built-in functions like @code{__builtin_memcpy} that
5147 correspond to the standard functions.  In any case, the option warns about
5148 just a subset of buffer overflows detected by the corresponding overflow
5149 checking built-ins.  For example, the option will issue a warning for
5150 the @code{strcpy} call below because it copies at least 5 characters
5151 (the string @code{"blue"} including the terminating NUL) into the buffer
5152 of size 4.
5154 @smallexample
5155 enum Color @{ blue, purple, yellow @};
5156 const char* f (enum Color clr)
5158   static char buf [4];
5159   const char *str;
5160   switch (clr)
5161     @{
5162       case blue: str = "blue"; break;
5163       case purple: str = "purple"; break;
5164       case yellow: str = "yellow"; break;
5165     @}
5167   return strcpy (buf, str);   // warning here
5169 @end smallexample
5171 Option @option{-Wstringop-overflow=2} is enabled by default.
5173 @table @gcctabopt
5174 @item -Wstringop-overflow
5175 @item -Wstringop-overflow=1
5176 @opindex Wstringop-overflow
5177 @opindex Wno-stringop-overflow
5178 The @option{-Wstringop-overflow=1} option uses type-zero Object Size Checking
5179 to determine the sizes of destination objects.  This is the default setting
5180 of the option.  At this setting the option will not warn for writes past
5181 the end of subobjects of larger objects accessed by pointers unless the
5182 size of the largest surrounding object is known.  When the destination may
5183 be one of several objects it is assumed to be the largest one of them.  On
5184 Linux systems, when optimization is enabled at this setting the option warns
5185 for the same code as when the @code{_FORTIFY_SOURCE} macro is defined to
5186 a non-zero value.
5188 @item -Wstringop-overflow=2
5189 The @option{-Wstringop-overflow=2} option uses type-one Object Size Checking
5190 to determine the sizes of destination objects.  At this setting the option
5191 will warn about overflows when writing to members of the largest complete
5192 objects whose exact size is known.  It will, however, not warn for excessive
5193 writes to the same members of unknown objects referenced by pointers since
5194 they may point to arrays containing unknown numbers of elements.
5196 @item -Wstringop-overflow=3
5197 The @option{-Wstringop-overflow=3} option uses type-two Object Size Checking
5198 to determine the sizes of destination objects.  At this setting the option
5199 warns about overflowing the smallest object or data member.  This is the
5200 most restrictive setting of the option that may result in warnings for safe
5201 code.
5203 @item -Wstringop-overflow=4
5204 The @option{-Wstringop-overflow=4} option uses type-three Object Size Checking
5205 to determine the sizes of destination objects.  At this setting the option
5206 will warn about overflowing any data members, and when the destination is
5207 one of several objects it uses the size of the largest of them to decide
5208 whether to issue a warning.  Similarly to @option{-Wstringop-overflow=3} this
5209 setting of the option may result in warnings for benign code.
5210 @end table
5212 @item -Wstringop-truncation
5213 @opindex Wstringop-truncation
5214 @opindex Wno-stringop-truncation
5215 Warn for calls to bounded string manipulation functions such as @code{strncat},
5216 @code{strncpy}, and @code{stpncpy} that may either truncate the copied string
5217 or leave the destination unchanged.
5219 In the following example, the call to @code{strncat} specifies a bound that
5220 is less than the length of the source string.  As a result, the copy of
5221 the source will be truncated and so the call is diagnosed.  To avoid the
5222 warning use @code{bufsize - strlen (buf) - 1)} as the bound.
5224 @smallexample
5225 void append (char *buf, size_t bufsize)
5227   strncat (buf, ".txt", 3);
5229 @end smallexample
5231 As another example, the following call to @code{strncpy} results in copying
5232 to @code{d} just the characters preceding the terminating NUL, without
5233 appending the NUL to the end.  Assuming the result of @code{strncpy} is
5234 necessarily a NUL-terminated string is a common mistake, and so the call
5235 is diagnosed.  To avoid the warning when the result is not expected to be
5236 NUL-terminated, call @code{memcpy} instead.
5238 @smallexample
5239 void copy (char *d, const char *s)
5241   strncpy (d, s, strlen (s));
5243 @end smallexample
5245 In the following example, the call to @code{strncpy} specifies the size
5246 of the destination buffer as the bound.  If the length of the source
5247 string is equal to or greater than this size the result of the copy will
5248 not be NUL-terminated.  Therefore, the call is also diagnosed.  To avoid
5249 the warning, specify @code{sizeof buf - 1} as the bound and set the last
5250 element of the buffer to @code{NUL}.
5252 @smallexample
5253 void copy (const char *s)
5255   char buf[80];
5256   strncpy (buf, s, sizeof buf);
5257   @dots{}
5259 @end smallexample
5261 In situations where a character array is intended to store a sequence
5262 of bytes with no terminating @code{NUL} such an array may be annotated
5263 with attribute @code{nonstring} to avoid this warning.  Such arrays,
5264 however, are not suitable arguments to functions that expect
5265 @code{NUL}-terminated strings.  To help detect accidental misuses of
5266 such arrays GCC issues warnings unless it can prove that the use is
5267 safe.  @xref{Common Variable Attributes}.
5269 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{|}cold@r{|}malloc@r{]}
5270 @opindex Wsuggest-attribute=
5271 @opindex Wno-suggest-attribute=
5272 Warn for cases where adding an attribute may be beneficial. The
5273 attributes currently supported are listed below.
5275 @table @gcctabopt
5276 @item -Wsuggest-attribute=pure
5277 @itemx -Wsuggest-attribute=const
5278 @itemx -Wsuggest-attribute=noreturn
5279 @itemx -Wsuggest-attribute=malloc
5280 @opindex Wsuggest-attribute=pure
5281 @opindex Wno-suggest-attribute=pure
5282 @opindex Wsuggest-attribute=const
5283 @opindex Wno-suggest-attribute=const
5284 @opindex Wsuggest-attribute=noreturn
5285 @opindex Wno-suggest-attribute=noreturn
5286 @opindex Wsuggest-attribute=malloc
5287 @opindex Wno-suggest-attribute=malloc
5289 Warn about functions that might be candidates for attributes
5290 @code{pure}, @code{const} or @code{noreturn} or @code{malloc}. The compiler
5291 only warns for functions visible in other compilation units or (in the case of
5292 @code{pure} and @code{const}) if it cannot prove that the function returns
5293 normally. A function returns normally if it doesn't contain an infinite loop or
5294 return abnormally by throwing, calling @code{abort} or trapping.  This analysis
5295 requires option @option{-fipa-pure-const}, which is enabled by default at
5296 @option{-O} and higher.  Higher optimization levels improve the accuracy
5297 of the analysis.
5299 @item -Wsuggest-attribute=format
5300 @itemx -Wmissing-format-attribute
5301 @opindex Wsuggest-attribute=format
5302 @opindex Wmissing-format-attribute
5303 @opindex Wno-suggest-attribute=format
5304 @opindex Wno-missing-format-attribute
5305 @opindex Wformat
5306 @opindex Wno-format
5308 Warn about function pointers that might be candidates for @code{format}
5309 attributes.  Note these are only possible candidates, not absolute ones.
5310 GCC guesses that function pointers with @code{format} attributes that
5311 are used in assignment, initialization, parameter passing or return
5312 statements should have a corresponding @code{format} attribute in the
5313 resulting type.  I.e.@: the left-hand side of the assignment or
5314 initialization, the type of the parameter variable, or the return type
5315 of the containing function respectively should also have a @code{format}
5316 attribute to avoid the warning.
5318 GCC also warns about function definitions that might be
5319 candidates for @code{format} attributes.  Again, these are only
5320 possible candidates.  GCC guesses that @code{format} attributes
5321 might be appropriate for any function that calls a function like
5322 @code{vprintf} or @code{vscanf}, but this might not always be the
5323 case, and some functions for which @code{format} attributes are
5324 appropriate may not be detected.
5326 @item -Wsuggest-attribute=cold
5327 @opindex Wsuggest-attribute=cold
5328 @opindex Wno-suggest-attribute=cold
5330 Warn about functions that might be candidates for @code{cold} attribute.  This
5331 is based on static detection and generally will only warn about functions which
5332 always leads to a call to another @code{cold} function such as wrappers of
5333 C++ @code{throw} or fatal error reporting functions leading to @code{abort}.
5334 @end table
5336 @item -Wsuggest-final-types
5337 @opindex Wno-suggest-final-types
5338 @opindex Wsuggest-final-types
5339 Warn about types with virtual methods where code quality would be improved
5340 if the type were declared with the C++11 @code{final} specifier, 
5341 or, if possible,
5342 declared in an anonymous namespace. This allows GCC to more aggressively
5343 devirtualize the polymorphic calls. This warning is more effective with link
5344 time optimization, where the information about the class hierarchy graph is
5345 more complete.
5347 @item -Wsuggest-final-methods
5348 @opindex Wno-suggest-final-methods
5349 @opindex Wsuggest-final-methods
5350 Warn about virtual methods where code quality would be improved if the method
5351 were declared with the C++11 @code{final} specifier, 
5352 or, if possible, its type were
5353 declared in an anonymous namespace or with the @code{final} specifier.
5354 This warning is
5355 more effective with link-time optimization, where the information about the
5356 class hierarchy graph is more complete. It is recommended to first consider
5357 suggestions of @option{-Wsuggest-final-types} and then rebuild with new
5358 annotations.
5360 @item -Wsuggest-override
5361 Warn about overriding virtual functions that are not marked with the override
5362 keyword.
5364 @item -Walloc-zero
5365 @opindex Wno-alloc-zero
5366 @opindex Walloc-zero
5367 Warn about calls to allocation functions decorated with attribute
5368 @code{alloc_size} that specify zero bytes, including those to the built-in
5369 forms of the functions @code{aligned_alloc}, @code{alloca}, @code{calloc},
5370 @code{malloc}, and @code{realloc}.  Because the behavior of these functions
5371 when called with a zero size differs among implementations (and in the case
5372 of @code{realloc} has been deprecated) relying on it may result in subtle
5373 portability bugs and should be avoided.
5375 @item -Walloc-size-larger-than=@var{n}
5376 Warn about calls to functions decorated with attribute @code{alloc_size}
5377 that attempt to allocate objects larger than the specified number of bytes,
5378 or where the result of the size computation in an integer type with infinite
5379 precision would exceed @code{SIZE_MAX / 2}.  The option argument @var{n}
5380 may end in one of the standard suffixes designating a multiple of bytes
5381 such as @code{kB} and @code{KiB} for kilobyte and kibibyte, respectively,
5382 @code{MB} and @code{MiB} for megabyte and mebibyte, and so on.
5383 @xref{Function Attributes}.
5385 @item -Walloca
5386 @opindex Wno-alloca
5387 @opindex Walloca
5388 This option warns on all uses of @code{alloca} in the source.
5390 @item -Walloca-larger-than=@var{n}
5391 This option warns on calls to @code{alloca} that are not bounded by a
5392 controlling predicate limiting its argument of integer type to at most
5393 @var{n} bytes, or calls to @code{alloca} where the bound is unknown.
5394 Arguments of non-integer types are considered unbounded even if they
5395 appear to be constrained to the expected range.
5397 For example, a bounded case of @code{alloca} could be:
5399 @smallexample
5400 void func (size_t n)
5402   void *p;
5403   if (n <= 1000)
5404     p = alloca (n);
5405   else
5406     p = malloc (n);
5407   f (p);
5409 @end smallexample
5411 In the above example, passing @code{-Walloca-larger-than=1000} would not
5412 issue a warning because the call to @code{alloca} is known to be at most
5413 1000 bytes.  However, if @code{-Walloca-larger-than=500} were passed,
5414 the compiler would emit a warning.
5416 Unbounded uses, on the other hand, are uses of @code{alloca} with no
5417 controlling predicate constraining its integer argument.  For example:
5419 @smallexample
5420 void func ()
5422   void *p = alloca (n);
5423   f (p);
5425 @end smallexample
5427 If @code{-Walloca-larger-than=500} were passed, the above would trigger
5428 a warning, but this time because of the lack of bounds checking.
5430 Note, that even seemingly correct code involving signed integers could
5431 cause a warning:
5433 @smallexample
5434 void func (signed int n)
5436   if (n < 500)
5437     @{
5438       p = alloca (n);
5439       f (p);
5440     @}
5442 @end smallexample
5444 In the above example, @var{n} could be negative, causing a larger than
5445 expected argument to be implicitly cast into the @code{alloca} call.
5447 This option also warns when @code{alloca} is used in a loop.
5449 This warning is not enabled by @option{-Wall}, and is only active when
5450 @option{-ftree-vrp} is active (default for @option{-O2} and above).
5452 See also @option{-Wvla-larger-than=@var{n}}.
5454 @item -Warray-bounds
5455 @itemx -Warray-bounds=@var{n}
5456 @opindex Wno-array-bounds
5457 @opindex Warray-bounds
5458 This option is only active when @option{-ftree-vrp} is active
5459 (default for @option{-O2} and above). It warns about subscripts to arrays
5460 that are always out of bounds. This warning is enabled by @option{-Wall}.
5462 @table @gcctabopt
5463 @item -Warray-bounds=1
5464 This is the warning level of @option{-Warray-bounds} and is enabled
5465 by @option{-Wall}; higher levels are not, and must be explicitly requested.
5467 @item -Warray-bounds=2
5468 This warning level also warns about out of bounds access for
5469 arrays at the end of a struct and for arrays accessed through
5470 pointers. This warning level may give a larger number of
5471 false positives and is deactivated by default.
5472 @end table
5474 @item -Wattribute-alias
5475 Warn about declarations using the @code{alias} and similar attributes whose
5476 target is incompatible with the type of the alias.  @xref{Function Attributes,
5477 ,Declaring Attributes of Functions}.
5479 @item -Wbool-compare
5480 @opindex Wno-bool-compare
5481 @opindex Wbool-compare
5482 Warn about boolean expression compared with an integer value different from
5483 @code{true}/@code{false}.  For instance, the following comparison is
5484 always false:
5485 @smallexample
5486 int n = 5;
5487 @dots{}
5488 if ((n > 1) == 2) @{ @dots{} @}
5489 @end smallexample
5490 This warning is enabled by @option{-Wall}.
5492 @item -Wbool-operation
5493 @opindex Wno-bool-operation
5494 @opindex Wbool-operation
5495 Warn about suspicious operations on expressions of a boolean type.  For
5496 instance, bitwise negation of a boolean is very likely a bug in the program.
5497 For C, this warning also warns about incrementing or decrementing a boolean,
5498 which rarely makes sense.  (In C++, decrementing a boolean is always invalid.
5499 Incrementing a boolean is invalid in C++17, and deprecated otherwise.)
5501 This warning is enabled by @option{-Wall}.
5503 @item -Wduplicated-branches
5504 @opindex Wno-duplicated-branches
5505 @opindex Wduplicated-branches
5506 Warn when an if-else has identical branches.  This warning detects cases like
5507 @smallexample
5508 if (p != NULL)
5509   return 0;
5510 else
5511   return 0;
5512 @end smallexample
5513 It doesn't warn when both branches contain just a null statement.  This warning
5514 also warn for conditional operators:
5515 @smallexample
5516   int i = x ? *p : *p;
5517 @end smallexample
5519 @item -Wduplicated-cond
5520 @opindex Wno-duplicated-cond
5521 @opindex Wduplicated-cond
5522 Warn about duplicated conditions in an if-else-if chain.  For instance,
5523 warn for the following code:
5524 @smallexample
5525 if (p->q != NULL) @{ @dots{} @}
5526 else if (p->q != NULL) @{ @dots{} @}
5527 @end smallexample
5529 @item -Wframe-address
5530 @opindex Wno-frame-address
5531 @opindex Wframe-address
5532 Warn when the @samp{__builtin_frame_address} or @samp{__builtin_return_address}
5533 is called with an argument greater than 0.  Such calls may return indeterminate
5534 values or crash the program.  The warning is included in @option{-Wall}.
5536 @item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
5537 @opindex Wno-discarded-qualifiers
5538 @opindex Wdiscarded-qualifiers
5539 Do not warn if type qualifiers on pointers are being discarded.
5540 Typically, the compiler warns if a @code{const char *} variable is
5541 passed to a function that takes a @code{char *} parameter.  This option
5542 can be used to suppress such a warning.
5544 @item -Wno-discarded-array-qualifiers @r{(C and Objective-C only)}
5545 @opindex Wno-discarded-array-qualifiers
5546 @opindex Wdiscarded-array-qualifiers
5547 Do not warn if type qualifiers on arrays which are pointer targets
5548 are being discarded. Typically, the compiler warns if a
5549 @code{const int (*)[]} variable is passed to a function that
5550 takes a @code{int (*)[]} parameter.  This option can be used to
5551 suppress such a warning.
5553 @item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
5554 @opindex Wno-incompatible-pointer-types
5555 @opindex Wincompatible-pointer-types
5556 Do not warn when there is a conversion between pointers that have incompatible
5557 types.  This warning is for cases not covered by @option{-Wno-pointer-sign},
5558 which warns for pointer argument passing or assignment with different
5559 signedness.
5561 @item -Wno-int-conversion @r{(C and Objective-C only)}
5562 @opindex Wno-int-conversion
5563 @opindex Wint-conversion
5564 Do not warn about incompatible integer to pointer and pointer to integer
5565 conversions.  This warning is about implicit conversions; for explicit
5566 conversions the warnings @option{-Wno-int-to-pointer-cast} and
5567 @option{-Wno-pointer-to-int-cast} may be used.
5569 @item -Wno-div-by-zero
5570 @opindex Wno-div-by-zero
5571 @opindex Wdiv-by-zero
5572 Do not warn about compile-time integer division by zero.  Floating-point
5573 division by zero is not warned about, as it can be a legitimate way of
5574 obtaining infinities and NaNs.
5576 @item -Wsystem-headers
5577 @opindex Wsystem-headers
5578 @opindex Wno-system-headers
5579 @cindex warnings from system headers
5580 @cindex system headers, warnings from
5581 Print warning messages for constructs found in system header files.
5582 Warnings from system headers are normally suppressed, on the assumption
5583 that they usually do not indicate real problems and would only make the
5584 compiler output harder to read.  Using this command-line option tells
5585 GCC to emit warnings from system headers as if they occurred in user
5586 code.  However, note that using @option{-Wall} in conjunction with this
5587 option does @emph{not} warn about unknown pragmas in system
5588 headers---for that, @option{-Wunknown-pragmas} must also be used.
5590 @item -Wtautological-compare
5591 @opindex Wtautological-compare
5592 @opindex Wno-tautological-compare
5593 Warn if a self-comparison always evaluates to true or false.  This
5594 warning detects various mistakes such as:
5595 @smallexample
5596 int i = 1;
5597 @dots{}
5598 if (i > i) @{ @dots{} @}
5599 @end smallexample
5601 This warning also warns about bitwise comparisons that always evaluate
5602 to true or false, for instance:
5603 @smallexample
5604 if ((a & 16) == 10) @{ @dots{} @}
5605 @end smallexample
5606 will always be false.
5608 This warning is enabled by @option{-Wall}.
5610 @item -Wtrampolines
5611 @opindex Wtrampolines
5612 @opindex Wno-trampolines
5613 Warn about trampolines generated for pointers to nested functions.
5614 A trampoline is a small piece of data or code that is created at run
5615 time on the stack when the address of a nested function is taken, and is
5616 used to call the nested function indirectly.  For some targets, it is
5617 made up of data only and thus requires no special treatment.  But, for
5618 most targets, it is made up of code and thus requires the stack to be
5619 made executable in order for the program to work properly.
5621 @item -Wfloat-equal
5622 @opindex Wfloat-equal
5623 @opindex Wno-float-equal
5624 Warn if floating-point values are used in equality comparisons.
5626 The idea behind this is that sometimes it is convenient (for the
5627 programmer) to consider floating-point values as approximations to
5628 infinitely precise real numbers.  If you are doing this, then you need
5629 to compute (by analyzing the code, or in some other way) the maximum or
5630 likely maximum error that the computation introduces, and allow for it
5631 when performing comparisons (and when producing output, but that's a
5632 different problem).  In particular, instead of testing for equality, you
5633 should check to see whether the two values have ranges that overlap; and
5634 this is done with the relational operators, so equality comparisons are
5635 probably mistaken.
5637 @item -Wtraditional @r{(C and Objective-C only)}
5638 @opindex Wtraditional
5639 @opindex Wno-traditional
5640 Warn about certain constructs that behave differently in traditional and
5641 ISO C@.  Also warn about ISO C constructs that have no traditional C
5642 equivalent, and/or problematic constructs that should be avoided.
5644 @itemize @bullet
5645 @item
5646 Macro parameters that appear within string literals in the macro body.
5647 In traditional C macro replacement takes place within string literals,
5648 but in ISO C it does not.
5650 @item
5651 In traditional C, some preprocessor directives did not exist.
5652 Traditional preprocessors only considered a line to be a directive
5653 if the @samp{#} appeared in column 1 on the line.  Therefore
5654 @option{-Wtraditional} warns about directives that traditional C
5655 understands but ignores because the @samp{#} does not appear as the
5656 first character on the line.  It also suggests you hide directives like
5657 @code{#pragma} not understood by traditional C by indenting them.  Some
5658 traditional implementations do not recognize @code{#elif}, so this option
5659 suggests avoiding it altogether.
5661 @item
5662 A function-like macro that appears without arguments.
5664 @item
5665 The unary plus operator.
5667 @item
5668 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
5669 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
5670 constants.)  Note, these suffixes appear in macros defined in the system
5671 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
5672 Use of these macros in user code might normally lead to spurious
5673 warnings, however GCC's integrated preprocessor has enough context to
5674 avoid warning in these cases.
5676 @item
5677 A function declared external in one block and then used after the end of
5678 the block.
5680 @item
5681 A @code{switch} statement has an operand of type @code{long}.
5683 @item
5684 A non-@code{static} function declaration follows a @code{static} one.
5685 This construct is not accepted by some traditional C compilers.
5687 @item
5688 The ISO type of an integer constant has a different width or
5689 signedness from its traditional type.  This warning is only issued if
5690 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
5691 typically represent bit patterns, are not warned about.
5693 @item
5694 Usage of ISO string concatenation is detected.
5696 @item
5697 Initialization of automatic aggregates.
5699 @item
5700 Identifier conflicts with labels.  Traditional C lacks a separate
5701 namespace for labels.
5703 @item
5704 Initialization of unions.  If the initializer is zero, the warning is
5705 omitted.  This is done under the assumption that the zero initializer in
5706 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
5707 initializer warnings and relies on default initialization to zero in the
5708 traditional C case.
5710 @item
5711 Conversions by prototypes between fixed/floating-point values and vice
5712 versa.  The absence of these prototypes when compiling with traditional
5713 C causes serious problems.  This is a subset of the possible
5714 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
5716 @item
5717 Use of ISO C style function definitions.  This warning intentionally is
5718 @emph{not} issued for prototype declarations or variadic functions
5719 because these ISO C features appear in your code when using
5720 libiberty's traditional C compatibility macros, @code{PARAMS} and
5721 @code{VPARAMS}.  This warning is also bypassed for nested functions
5722 because that feature is already a GCC extension and thus not relevant to
5723 traditional C compatibility.
5724 @end itemize
5726 @item -Wtraditional-conversion @r{(C and Objective-C only)}
5727 @opindex Wtraditional-conversion
5728 @opindex Wno-traditional-conversion
5729 Warn if a prototype causes a type conversion that is different from what
5730 would happen to the same argument in the absence of a prototype.  This
5731 includes conversions of fixed point to floating and vice versa, and
5732 conversions changing the width or signedness of a fixed-point argument
5733 except when the same as the default promotion.
5735 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
5736 @opindex Wdeclaration-after-statement
5737 @opindex Wno-declaration-after-statement
5738 Warn when a declaration is found after a statement in a block.  This
5739 construct, known from C++, was introduced with ISO C99 and is by default
5740 allowed in GCC@.  It is not supported by ISO C90.  @xref{Mixed Declarations}.
5742 @item -Wshadow
5743 @opindex Wshadow
5744 @opindex Wno-shadow
5745 Warn whenever a local variable or type declaration shadows another
5746 variable, parameter, type, class member (in C++), or instance variable
5747 (in Objective-C) or whenever a built-in function is shadowed. Note
5748 that in C++, the compiler warns if a local variable shadows an
5749 explicit typedef, but not if it shadows a struct/class/enum.
5750 Same as @option{-Wshadow=global}.
5752 @item -Wno-shadow-ivar @r{(Objective-C only)}
5753 @opindex Wno-shadow-ivar
5754 @opindex Wshadow-ivar
5755 Do not warn whenever a local variable shadows an instance variable in an
5756 Objective-C method.
5758 @item -Wshadow=global
5759 @opindex Wshadow=local
5760 The default for @option{-Wshadow}. Warns for any (global) shadowing.
5762 @item -Wshadow=local
5763 @opindex Wshadow=local
5764 Warn when a local variable shadows another local variable or parameter.
5765 This warning is enabled by @option{-Wshadow=global}.
5767 @item -Wshadow=compatible-local
5768 @opindex Wshadow=compatible-local
5769 Warn when a local variable shadows another local variable or parameter
5770 whose type is compatible with that of the shadowing variable. In C++,
5771 type compatibility here means the type of the shadowing variable can be
5772 converted to that of the shadowed variable. The creation of this flag
5773 (in addition to @option{-Wshadow=local}) is based on the idea that when
5774 a local variable shadows another one of incompatible type, it is most
5775 likely intentional, not a bug or typo, as shown in the following example:
5777 @smallexample
5778 @group
5779 for (SomeIterator i = SomeObj.begin(); i != SomeObj.end(); ++i)
5781   for (int i = 0; i < N; ++i)
5782   @{
5783     ...
5784   @}
5785   ...
5787 @end group
5788 @end smallexample
5790 Since the two variable @code{i} in the example above have incompatible types,
5791 enabling only @option{-Wshadow=compatible-local} will not emit a warning.
5792 Because their types are incompatible, if a programmer accidentally uses one
5793 in place of the other, type checking will catch that and emit an error or
5794 warning. So not warning (about shadowing) in this case will not lead to
5795 undetected bugs. Use of this flag instead of @option{-Wshadow=local} can
5796 possibly reduce the number of warnings triggered by intentional shadowing.
5798 This warning is enabled by @option{-Wshadow=local}.
5800 @item -Wlarger-than=@var{len}
5801 @opindex Wlarger-than=@var{len}
5802 @opindex Wlarger-than-@var{len}
5803 Warn whenever an object of larger than @var{len} bytes is defined.
5805 @item -Wframe-larger-than=@var{len}
5806 @opindex Wframe-larger-than
5807 Warn if the size of a function frame is larger than @var{len} bytes.
5808 The computation done to determine the stack frame size is approximate
5809 and not conservative.
5810 The actual requirements may be somewhat greater than @var{len}
5811 even if you do not get a warning.  In addition, any space allocated
5812 via @code{alloca}, variable-length arrays, or related constructs
5813 is not included by the compiler when determining
5814 whether or not to issue a warning.
5816 @item -Wno-free-nonheap-object
5817 @opindex Wno-free-nonheap-object
5818 @opindex Wfree-nonheap-object
5819 Do not warn when attempting to free an object that was not allocated
5820 on the heap.
5822 @item -Wstack-usage=@var{len}
5823 @opindex Wstack-usage
5824 Warn if the stack usage of a function might be larger than @var{len} bytes.
5825 The computation done to determine the stack usage is conservative.
5826 Any space allocated via @code{alloca}, variable-length arrays, or related
5827 constructs is included by the compiler when determining whether or not to
5828 issue a warning.
5830 The message is in keeping with the output of @option{-fstack-usage}.
5832 @itemize
5833 @item
5834 If the stack usage is fully static but exceeds the specified amount, it's:
5836 @smallexample
5837   warning: stack usage is 1120 bytes
5838 @end smallexample
5839 @item
5840 If the stack usage is (partly) dynamic but bounded, it's:
5842 @smallexample
5843   warning: stack usage might be 1648 bytes
5844 @end smallexample
5845 @item
5846 If the stack usage is (partly) dynamic and not bounded, it's:
5848 @smallexample
5849   warning: stack usage might be unbounded
5850 @end smallexample
5851 @end itemize
5853 @item -Wunsafe-loop-optimizations
5854 @opindex Wunsafe-loop-optimizations
5855 @opindex Wno-unsafe-loop-optimizations
5856 Warn if the loop cannot be optimized because the compiler cannot
5857 assume anything on the bounds of the loop indices.  With
5858 @option{-funsafe-loop-optimizations} warn if the compiler makes
5859 such assumptions.
5861 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
5862 @opindex Wno-pedantic-ms-format
5863 @opindex Wpedantic-ms-format
5864 When used in combination with @option{-Wformat}
5865 and @option{-pedantic} without GNU extensions, this option
5866 disables the warnings about non-ISO @code{printf} / @code{scanf} format
5867 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
5868 which depend on the MS runtime.
5870 @item -Waligned-new
5871 @opindex Waligned-new
5872 @opindex Wno-aligned-new
5873 Warn about a new-expression of a type that requires greater alignment
5874 than the @code{alignof(std::max_align_t)} but uses an allocation
5875 function without an explicit alignment parameter. This option is
5876 enabled by @option{-Wall}.
5878 Normally this only warns about global allocation functions, but
5879 @option{-Waligned-new=all} also warns about class member allocation
5880 functions.
5882 @item -Wplacement-new
5883 @itemx -Wplacement-new=@var{n}
5884 @opindex Wplacement-new
5885 @opindex Wno-placement-new
5886 Warn about placement new expressions with undefined behavior, such as
5887 constructing an object in a buffer that is smaller than the type of
5888 the object.  For example, the placement new expression below is diagnosed
5889 because it attempts to construct an array of 64 integers in a buffer only
5890 64 bytes large.
5891 @smallexample
5892 char buf [64];
5893 new (buf) int[64];
5894 @end smallexample
5895 This warning is enabled by default.
5897 @table @gcctabopt
5898 @item -Wplacement-new=1
5899 This is the default warning level of @option{-Wplacement-new}.  At this
5900 level the warning is not issued for some strictly undefined constructs that
5901 GCC allows as extensions for compatibility with legacy code.  For example,
5902 the following @code{new} expression is not diagnosed at this level even
5903 though it has undefined behavior according to the C++ standard because
5904 it writes past the end of the one-element array.
5905 @smallexample
5906 struct S @{ int n, a[1]; @};
5907 S *s = (S *)malloc (sizeof *s + 31 * sizeof s->a[0]);
5908 new (s->a)int [32]();
5909 @end smallexample
5911 @item -Wplacement-new=2
5912 At this level, in addition to diagnosing all the same constructs as at level
5913 1, a diagnostic is also issued for placement new expressions that construct
5914 an object in the last member of structure whose type is an array of a single
5915 element and whose size is less than the size of the object being constructed.
5916 While the previous example would be diagnosed, the following construct makes
5917 use of the flexible member array extension to avoid the warning at level 2.
5918 @smallexample
5919 struct S @{ int n, a[]; @};
5920 S *s = (S *)malloc (sizeof *s + 32 * sizeof s->a[0]);
5921 new (s->a)int [32]();
5922 @end smallexample
5924 @end table
5926 @item -Wpointer-arith
5927 @opindex Wpointer-arith
5928 @opindex Wno-pointer-arith
5929 Warn about anything that depends on the ``size of'' a function type or
5930 of @code{void}.  GNU C assigns these types a size of 1, for
5931 convenience in calculations with @code{void *} pointers and pointers
5932 to functions.  In C++, warn also when an arithmetic operation involves
5933 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
5935 @item -Wpointer-compare
5936 @opindex Wpointer-compare
5937 @opindex Wno-pointer-compare
5938 Warn if a pointer is compared with a zero character constant.  This usually
5939 means that the pointer was meant to be dereferenced.  For example:
5941 @smallexample
5942 const char *p = foo ();
5943 if (p == '\0')
5944   return 42;
5945 @end smallexample
5947 Note that the code above is invalid in C++11.
5949 This warning is enabled by default.
5951 @item -Wtype-limits
5952 @opindex Wtype-limits
5953 @opindex Wno-type-limits
5954 Warn if a comparison is always true or always false due to the limited
5955 range of the data type, but do not warn for constant expressions.  For
5956 example, warn if an unsigned variable is compared against zero with
5957 @code{<} or @code{>=}.  This warning is also enabled by
5958 @option{-Wextra}.
5960 @include cppwarnopts.texi
5962 @item -Wbad-function-cast @r{(C and Objective-C only)}
5963 @opindex Wbad-function-cast
5964 @opindex Wno-bad-function-cast
5965 Warn when a function call is cast to a non-matching type.
5966 For example, warn if a call to a function returning an integer type 
5967 is cast to a pointer type.
5969 @item -Wc90-c99-compat @r{(C and Objective-C only)}
5970 @opindex Wc90-c99-compat
5971 @opindex Wno-c90-c99-compat
5972 Warn about features not present in ISO C90, but present in ISO C99.
5973 For instance, warn about use of variable length arrays, @code{long long}
5974 type, @code{bool} type, compound literals, designated initializers, and so
5975 on.  This option is independent of the standards mode.  Warnings are disabled
5976 in the expression that follows @code{__extension__}.
5978 @item -Wc99-c11-compat @r{(C and Objective-C only)}
5979 @opindex Wc99-c11-compat
5980 @opindex Wno-c99-c11-compat
5981 Warn about features not present in ISO C99, but present in ISO C11.
5982 For instance, warn about use of anonymous structures and unions,
5983 @code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier,
5984 @code{_Alignas} specifier, @code{Alignof} operator, @code{_Generic} keyword,
5985 and so on.  This option is independent of the standards mode.  Warnings are
5986 disabled in the expression that follows @code{__extension__}.
5988 @item -Wc++-compat @r{(C and Objective-C only)}
5989 @opindex Wc++-compat
5990 Warn about ISO C constructs that are outside of the common subset of
5991 ISO C and ISO C++, e.g.@: request for implicit conversion from
5992 @code{void *} to a pointer to non-@code{void} type.
5994 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
5995 @opindex Wc++11-compat
5996 Warn about C++ constructs whose meaning differs between ISO C++ 1998
5997 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
5998 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
5999 enabled by @option{-Wall}.
6001 @item -Wc++14-compat @r{(C++ and Objective-C++ only)}
6002 @opindex Wc++14-compat
6003 Warn about C++ constructs whose meaning differs between ISO C++ 2011
6004 and ISO C++ 2014.  This warning is enabled by @option{-Wall}.
6006 @item -Wc++17-compat @r{(C++ and Objective-C++ only)}
6007 @opindex Wc++17-compat
6008 Warn about C++ constructs whose meaning differs between ISO C++ 2014
6009 and ISO C++ 2017.  This warning is enabled by @option{-Wall}.
6011 @item -Wcast-qual
6012 @opindex Wcast-qual
6013 @opindex Wno-cast-qual
6014 Warn whenever a pointer is cast so as to remove a type qualifier from
6015 the target type.  For example, warn if a @code{const char *} is cast
6016 to an ordinary @code{char *}.
6018 Also warn when making a cast that introduces a type qualifier in an
6019 unsafe way.  For example, casting @code{char **} to @code{const char **}
6020 is unsafe, as in this example:
6022 @smallexample
6023   /* p is char ** value.  */
6024   const char **q = (const char **) p;
6025   /* Assignment of readonly string to const char * is OK.  */
6026   *q = "string";
6027   /* Now char** pointer points to read-only memory.  */
6028   **p = 'b';
6029 @end smallexample
6031 @item -Wcast-align
6032 @opindex Wcast-align
6033 @opindex Wno-cast-align
6034 Warn whenever a pointer is cast such that the required alignment of the
6035 target is increased.  For example, warn if a @code{char *} is cast to
6036 an @code{int *} on machines where integers can only be accessed at
6037 two- or four-byte boundaries.
6039 @item -Wcast-align=strict
6040 @opindex Wcast-align=strict
6041 Warn whenever a pointer is cast such that the required alignment of the
6042 target is increased.  For example, warn if a @code{char *} is cast to
6043 an @code{int *} regardless of the target machine.
6045 @item -Wcast-function-type
6046 @opindex Wcast-function-type
6047 @opindex Wno-cast-function-type
6048 Warn when a function pointer is cast to an incompatible function pointer.
6049 In a cast involving function types with a variable argument list only
6050 the types of initial arguments that are provided are considered.
6051 Any parameter of pointer-type matches any other pointer-type.  Any benign
6052 differences in integral types are ignored, like @code{int} vs. @code{long}
6053 on ILP32 targets.  Likewise type qualifiers are ignored.  The function
6054 type @code{void (*) (void)} is special and matches everything, which can
6055 be used to suppress this warning.
6056 In a cast involving pointer to member types this warning warns whenever
6057 the type cast is changing the pointer to member type.
6058 This warning is enabled by @option{-Wextra}.
6060 @item -Wwrite-strings
6061 @opindex Wwrite-strings
6062 @opindex Wno-write-strings
6063 When compiling C, give string constants the type @code{const
6064 char[@var{length}]} so that copying the address of one into a
6065 non-@code{const} @code{char *} pointer produces a warning.  These
6066 warnings help you find at compile time code that can try to write
6067 into a string constant, but only if you have been very careful about
6068 using @code{const} in declarations and prototypes.  Otherwise, it is
6069 just a nuisance. This is why we did not make @option{-Wall} request
6070 these warnings.
6072 When compiling C++, warn about the deprecated conversion from string
6073 literals to @code{char *}.  This warning is enabled by default for C++
6074 programs.
6076 @item -Wcatch-value
6077 @itemx -Wcatch-value=@var{n} @r{(C++ and Objective-C++ only)}
6078 @opindex Wcatch-value
6079 @opindex Wno-catch-value
6080 Warn about catch handlers that do not catch via reference.
6081 With @option{-Wcatch-value=1} (or @option{-Wcatch-value} for short)
6082 warn about polymorphic class types that are caught by value.
6083 With @option{-Wcatch-value=2} warn about all class types that are caught
6084 by value. With @option{-Wcatch-value=3} warn about all types that are
6085 not caught by reference. @option{-Wcatch-value} is enabled by @option{-Wall}.
6087 @item -Wclobbered
6088 @opindex Wclobbered
6089 @opindex Wno-clobbered
6090 Warn for variables that might be changed by @code{longjmp} or
6091 @code{vfork}.  This warning is also enabled by @option{-Wextra}.
6093 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
6094 @opindex Wconditionally-supported
6095 @opindex Wno-conditionally-supported
6096 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
6098 @item -Wconversion
6099 @opindex Wconversion
6100 @opindex Wno-conversion
6101 Warn for implicit conversions that may alter a value. This includes
6102 conversions between real and integer, like @code{abs (x)} when
6103 @code{x} is @code{double}; conversions between signed and unsigned,
6104 like @code{unsigned ui = -1}; and conversions to smaller types, like
6105 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
6106 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
6107 changed by the conversion like in @code{abs (2.0)}.  Warnings about
6108 conversions between signed and unsigned integers can be disabled by
6109 using @option{-Wno-sign-conversion}.
6111 For C++, also warn for confusing overload resolution for user-defined
6112 conversions; and conversions that never use a type conversion
6113 operator: conversions to @code{void}, the same type, a base class or a
6114 reference to them. Warnings about conversions between signed and
6115 unsigned integers are disabled by default in C++ unless
6116 @option{-Wsign-conversion} is explicitly enabled.
6118 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
6119 @opindex Wconversion-null
6120 @opindex Wno-conversion-null
6121 Do not warn for conversions between @code{NULL} and non-pointer
6122 types. @option{-Wconversion-null} is enabled by default.
6124 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
6125 @opindex Wzero-as-null-pointer-constant
6126 @opindex Wno-zero-as-null-pointer-constant
6127 Warn when a literal @samp{0} is used as null pointer constant.  This can
6128 be useful to facilitate the conversion to @code{nullptr} in C++11.
6130 @item -Wsubobject-linkage @r{(C++ and Objective-C++ only)}
6131 @opindex Wsubobject-linkage
6132 @opindex Wno-subobject-linkage
6133 Warn if a class type has a base or a field whose type uses the anonymous
6134 namespace or depends on a type with no linkage.  If a type A depends on
6135 a type B with no or internal linkage, defining it in multiple
6136 translation units would be an ODR violation because the meaning of B
6137 is different in each translation unit.  If A only appears in a single
6138 translation unit, the best way to silence the warning is to give it
6139 internal linkage by putting it in an anonymous namespace as well.  The
6140 compiler doesn't give this warning for types defined in the main .C
6141 file, as those are unlikely to have multiple definitions.
6142 @option{-Wsubobject-linkage} is enabled by default.
6144 @item -Wdangling-else
6145 @opindex Wdangling-else
6146 @opindex Wno-dangling-else
6147 Warn about constructions where there may be confusion to which
6148 @code{if} statement an @code{else} branch belongs.  Here is an example of
6149 such a case:
6151 @smallexample
6152 @group
6154   if (a)
6155     if (b)
6156       foo ();
6157   else
6158     bar ();
6160 @end group
6161 @end smallexample
6163 In C/C++, every @code{else} branch belongs to the innermost possible
6164 @code{if} statement, which in this example is @code{if (b)}.  This is
6165 often not what the programmer expected, as illustrated in the above
6166 example by indentation the programmer chose.  When there is the
6167 potential for this confusion, GCC issues a warning when this flag
6168 is specified.  To eliminate the warning, add explicit braces around
6169 the innermost @code{if} statement so there is no way the @code{else}
6170 can belong to the enclosing @code{if}.  The resulting code
6171 looks like this:
6173 @smallexample
6174 @group
6176   if (a)
6177     @{
6178       if (b)
6179         foo ();
6180       else
6181         bar ();
6182     @}
6184 @end group
6185 @end smallexample
6187 This warning is enabled by @option{-Wparentheses}.
6189 @item -Wdate-time
6190 @opindex Wdate-time
6191 @opindex Wno-date-time
6192 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
6193 are encountered as they might prevent bit-wise-identical reproducible
6194 compilations.
6196 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
6197 @opindex Wdelete-incomplete
6198 @opindex Wno-delete-incomplete
6199 Warn when deleting a pointer to incomplete type, which may cause
6200 undefined behavior at runtime.  This warning is enabled by default.
6202 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
6203 @opindex Wuseless-cast
6204 @opindex Wno-useless-cast
6205 Warn when an expression is casted to its own type.
6207 @item -Wempty-body
6208 @opindex Wempty-body
6209 @opindex Wno-empty-body
6210 Warn if an empty body occurs in an @code{if}, @code{else} or @code{do
6211 while} statement.  This warning is also enabled by @option{-Wextra}.
6213 @item -Wenum-compare
6214 @opindex Wenum-compare
6215 @opindex Wno-enum-compare
6216 Warn about a comparison between values of different enumerated types.
6217 In C++ enumerated type mismatches in conditional expressions are also
6218 diagnosed and the warning is enabled by default.  In C this warning is 
6219 enabled by @option{-Wall}.
6221 @item -Wextra-semi @r{(C++, Objective-C++ only)}
6222 @opindex Wextra-semi
6223 @opindex Wno-extra-semi
6224 Warn about redundant semicolon after in-class function definition.
6226 @item -Wjump-misses-init @r{(C, Objective-C only)}
6227 @opindex Wjump-misses-init
6228 @opindex Wno-jump-misses-init
6229 Warn if a @code{goto} statement or a @code{switch} statement jumps
6230 forward across the initialization of a variable, or jumps backward to a
6231 label after the variable has been initialized.  This only warns about
6232 variables that are initialized when they are declared.  This warning is
6233 only supported for C and Objective-C; in C++ this sort of branch is an
6234 error in any case.
6236 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
6237 can be disabled with the @option{-Wno-jump-misses-init} option.
6239 @item -Wsign-compare
6240 @opindex Wsign-compare
6241 @opindex Wno-sign-compare
6242 @cindex warning for comparison of signed and unsigned values
6243 @cindex comparison of signed and unsigned values, warning
6244 @cindex signed and unsigned values, comparison warning
6245 Warn when a comparison between signed and unsigned values could produce
6246 an incorrect result when the signed value is converted to unsigned.
6247 In C++, this warning is also enabled by @option{-Wall}.  In C, it is
6248 also enabled by @option{-Wextra}.
6250 @item -Wsign-conversion
6251 @opindex Wsign-conversion
6252 @opindex Wno-sign-conversion
6253 Warn for implicit conversions that may change the sign of an integer
6254 value, like assigning a signed integer expression to an unsigned
6255 integer variable. An explicit cast silences the warning. In C, this
6256 option is enabled also by @option{-Wconversion}.
6258 @item -Wfloat-conversion
6259 @opindex Wfloat-conversion
6260 @opindex Wno-float-conversion
6261 Warn for implicit conversions that reduce the precision of a real value.
6262 This includes conversions from real to integer, and from higher precision
6263 real to lower precision real values.  This option is also enabled by
6264 @option{-Wconversion}.
6266 @item -Wno-scalar-storage-order
6267 @opindex -Wno-scalar-storage-order
6268 @opindex -Wscalar-storage-order
6269 Do not warn on suspicious constructs involving reverse scalar storage order.
6271 @item -Wsized-deallocation @r{(C++ and Objective-C++ only)}
6272 @opindex Wsized-deallocation
6273 @opindex Wno-sized-deallocation
6274 Warn about a definition of an unsized deallocation function
6275 @smallexample
6276 void operator delete (void *) noexcept;
6277 void operator delete[] (void *) noexcept;
6278 @end smallexample
6279 without a definition of the corresponding sized deallocation function
6280 @smallexample
6281 void operator delete (void *, std::size_t) noexcept;
6282 void operator delete[] (void *, std::size_t) noexcept;
6283 @end smallexample
6284 or vice versa.  Enabled by @option{-Wextra} along with
6285 @option{-fsized-deallocation}.
6287 @item -Wsizeof-pointer-div
6288 @opindex Wsizeof-pointer-div
6289 @opindex Wno-sizeof-pointer-div
6290 Warn for suspicious divisions of two sizeof expressions that divide
6291 the pointer size by the element size, which is the usual way to compute
6292 the array size but won't work out correctly with pointers.  This warning
6293 warns e.g.@: about @code{sizeof (ptr) / sizeof (ptr[0])} if @code{ptr} is
6294 not an array, but a pointer.  This warning is enabled by @option{-Wall}.
6296 @item -Wsizeof-pointer-memaccess
6297 @opindex Wsizeof-pointer-memaccess
6298 @opindex Wno-sizeof-pointer-memaccess
6299 Warn for suspicious length parameters to certain string and memory built-in
6300 functions if the argument uses @code{sizeof}.  This warning triggers for
6301 example for @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not
6302 an array, but a pointer, and suggests a possible fix, or about
6303 @code{memcpy (&foo, ptr, sizeof (&foo));}.  @option{-Wsizeof-pointer-memaccess}
6304 also warns about calls to bounded string copy functions like @code{strncat}
6305 or @code{strncpy} that specify as the bound a @code{sizeof} expression of
6306 the source array.  For example, in the following function the call to
6307 @code{strncat} specifies the size of the source string as the bound.  That
6308 is almost certainly a mistake and so the call is diagnosed.
6309 @smallexample
6310 void make_file (const char *name)
6312   char path[PATH_MAX];
6313   strncpy (path, name, sizeof path - 1);
6314   strncat (path, ".text", sizeof ".text");
6315   @dots{}
6317 @end smallexample
6319 The @option{-Wsizeof-pointer-memaccess} option is enabled by @option{-Wall}.
6321 @item -Wsizeof-array-argument
6322 @opindex Wsizeof-array-argument
6323 @opindex Wno-sizeof-array-argument
6324 Warn when the @code{sizeof} operator is applied to a parameter that is
6325 declared as an array in a function definition.  This warning is enabled by
6326 default for C and C++ programs.
6328 @item -Wmemset-elt-size
6329 @opindex Wmemset-elt-size
6330 @opindex Wno-memset-elt-size
6331 Warn for suspicious calls to the @code{memset} built-in function, if the
6332 first argument references an array, and the third argument is a number
6333 equal to the number of elements, but not equal to the size of the array
6334 in memory.  This indicates that the user has omitted a multiplication by
6335 the element size.  This warning is enabled by @option{-Wall}.
6337 @item -Wmemset-transposed-args
6338 @opindex Wmemset-transposed-args
6339 @opindex Wno-memset-transposed-args
6340 Warn for suspicious calls to the @code{memset} built-in function, if the
6341 second argument is not zero and the third argument is zero.  This warns e.g.@
6342 about @code{memset (buf, sizeof buf, 0)} where most probably
6343 @code{memset (buf, 0, sizeof buf)} was meant instead.  The diagnostics
6344 is only emitted if the third argument is literal zero.  If it is some
6345 expression that is folded to zero, a cast of zero to some type, etc., 
6346 it is far less likely that the user has mistakenly exchanged the arguments 
6347 and no warning is emitted.  This warning is enabled by @option{-Wall}.
6349 @item -Waddress
6350 @opindex Waddress
6351 @opindex Wno-address
6352 Warn about suspicious uses of memory addresses. These include using
6353 the address of a function in a conditional expression, such as
6354 @code{void func(void); if (func)}, and comparisons against the memory
6355 address of a string literal, such as @code{if (x == "abc")}.  Such
6356 uses typically indicate a programmer error: the address of a function
6357 always evaluates to true, so their use in a conditional usually
6358 indicate that the programmer forgot the parentheses in a function
6359 call; and comparisons against string literals result in unspecified
6360 behavior and are not portable in C, so they usually indicate that the
6361 programmer intended to use @code{strcmp}.  This warning is enabled by
6362 @option{-Wall}.
6364 @item -Wlogical-op
6365 @opindex Wlogical-op
6366 @opindex Wno-logical-op
6367 Warn about suspicious uses of logical operators in expressions.
6368 This includes using logical operators in contexts where a
6369 bit-wise operator is likely to be expected.  Also warns when
6370 the operands of a logical operator are the same:
6371 @smallexample
6372 extern int a;
6373 if (a < 0 && a < 0) @{ @dots{} @}
6374 @end smallexample
6376 @item -Wlogical-not-parentheses
6377 @opindex Wlogical-not-parentheses
6378 @opindex Wno-logical-not-parentheses
6379 Warn about logical not used on the left hand side operand of a comparison.
6380 This option does not warn if the right operand is considered to be a boolean
6381 expression.  Its purpose is to detect suspicious code like the following:
6382 @smallexample
6383 int a;
6384 @dots{}
6385 if (!a > 1) @{ @dots{} @}
6386 @end smallexample
6388 It is possible to suppress the warning by wrapping the LHS into
6389 parentheses:
6390 @smallexample
6391 if ((!a) > 1) @{ @dots{} @}
6392 @end smallexample
6394 This warning is enabled by @option{-Wall}.
6396 @item -Waggregate-return
6397 @opindex Waggregate-return
6398 @opindex Wno-aggregate-return
6399 Warn if any functions that return structures or unions are defined or
6400 called.  (In languages where you can return an array, this also elicits
6401 a warning.)
6403 @item -Wno-aggressive-loop-optimizations
6404 @opindex Wno-aggressive-loop-optimizations
6405 @opindex Waggressive-loop-optimizations
6406 Warn if in a loop with constant number of iterations the compiler detects
6407 undefined behavior in some statement during one or more of the iterations.
6409 @item -Wno-attributes
6410 @opindex Wno-attributes
6411 @opindex Wattributes
6412 Do not warn if an unexpected @code{__attribute__} is used, such as
6413 unrecognized attributes, function attributes applied to variables,
6414 etc.  This does not stop errors for incorrect use of supported
6415 attributes.
6417 @item -Wno-builtin-declaration-mismatch
6418 @opindex Wno-builtin-declaration-mismatch
6419 @opindex Wbuiltin-declaration-mismatch
6420 Warn if a built-in function is declared with the wrong signature or 
6421 as non-function.
6422 This warning is enabled by default.
6424 @item -Wno-builtin-macro-redefined
6425 @opindex Wno-builtin-macro-redefined
6426 @opindex Wbuiltin-macro-redefined
6427 Do not warn if certain built-in macros are redefined.  This suppresses
6428 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
6429 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
6431 @item -Wstrict-prototypes @r{(C and Objective-C only)}
6432 @opindex Wstrict-prototypes
6433 @opindex Wno-strict-prototypes
6434 Warn if a function is declared or defined without specifying the
6435 argument types.  (An old-style function definition is permitted without
6436 a warning if preceded by a declaration that specifies the argument
6437 types.)
6439 @item -Wold-style-declaration @r{(C and Objective-C only)}
6440 @opindex Wold-style-declaration
6441 @opindex Wno-old-style-declaration
6442 Warn for obsolescent usages, according to the C Standard, in a
6443 declaration. For example, warn if storage-class specifiers like
6444 @code{static} are not the first things in a declaration.  This warning
6445 is also enabled by @option{-Wextra}.
6447 @item -Wold-style-definition @r{(C and Objective-C only)}
6448 @opindex Wold-style-definition
6449 @opindex Wno-old-style-definition
6450 Warn if an old-style function definition is used.  A warning is given
6451 even if there is a previous prototype.
6453 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
6454 @opindex Wmissing-parameter-type
6455 @opindex Wno-missing-parameter-type
6456 A function parameter is declared without a type specifier in K&R-style
6457 functions:
6459 @smallexample
6460 void foo(bar) @{ @}
6461 @end smallexample
6463 This warning is also enabled by @option{-Wextra}.
6465 @item -Wmissing-prototypes @r{(C and Objective-C only)}
6466 @opindex Wmissing-prototypes
6467 @opindex Wno-missing-prototypes
6468 Warn if a global function is defined without a previous prototype
6469 declaration.  This warning is issued even if the definition itself
6470 provides a prototype.  Use this option to detect global functions
6471 that do not have a matching prototype declaration in a header file.
6472 This option is not valid for C++ because all function declarations
6473 provide prototypes and a non-matching declaration declares an
6474 overload rather than conflict with an earlier declaration.
6475 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
6477 @item -Wmissing-declarations
6478 @opindex Wmissing-declarations
6479 @opindex Wno-missing-declarations
6480 Warn if a global function is defined without a previous declaration.
6481 Do so even if the definition itself provides a prototype.
6482 Use this option to detect global functions that are not declared in
6483 header files.  In C, no warnings are issued for functions with previous
6484 non-prototype declarations; use @option{-Wmissing-prototypes} to detect
6485 missing prototypes.  In C++, no warnings are issued for function templates,
6486 or for inline functions, or for functions in anonymous namespaces.
6488 @item -Wmissing-field-initializers
6489 @opindex Wmissing-field-initializers
6490 @opindex Wno-missing-field-initializers
6491 @opindex W
6492 @opindex Wextra
6493 @opindex Wno-extra
6494 Warn if a structure's initializer has some fields missing.  For
6495 example, the following code causes such a warning, because
6496 @code{x.h} is implicitly zero:
6498 @smallexample
6499 struct s @{ int f, g, h; @};
6500 struct s x = @{ 3, 4 @};
6501 @end smallexample
6503 This option does not warn about designated initializers, so the following
6504 modification does not trigger a warning:
6506 @smallexample
6507 struct s @{ int f, g, h; @};
6508 struct s x = @{ .f = 3, .g = 4 @};
6509 @end smallexample
6511 In C this option does not warn about the universal zero initializer
6512 @samp{@{ 0 @}}:
6514 @smallexample
6515 struct s @{ int f, g, h; @};
6516 struct s x = @{ 0 @};
6517 @end smallexample
6519 Likewise, in C++ this option does not warn about the empty @{ @}
6520 initializer, for example:
6522 @smallexample
6523 struct s @{ int f, g, h; @};
6524 s x = @{ @};
6525 @end smallexample
6527 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
6528 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
6530 @item -Wno-multichar
6531 @opindex Wno-multichar
6532 @opindex Wmultichar
6533 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
6534 Usually they indicate a typo in the user's code, as they have
6535 implementation-defined values, and should not be used in portable code.
6537 @item -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]}
6538 @opindex Wnormalized=
6539 @opindex Wnormalized
6540 @opindex Wno-normalized
6541 @cindex NFC
6542 @cindex NFKC
6543 @cindex character set, input normalization
6544 In ISO C and ISO C++, two identifiers are different if they are
6545 different sequences of characters.  However, sometimes when characters
6546 outside the basic ASCII character set are used, you can have two
6547 different character sequences that look the same.  To avoid confusion,
6548 the ISO 10646 standard sets out some @dfn{normalization rules} which
6549 when applied ensure that two sequences that look the same are turned into
6550 the same sequence.  GCC can warn you if you are using identifiers that
6551 have not been normalized; this option controls that warning.
6553 There are four levels of warning supported by GCC@.  The default is
6554 @option{-Wnormalized=nfc}, which warns about any identifier that is
6555 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
6556 recommended form for most uses.  It is equivalent to
6557 @option{-Wnormalized}.
6559 Unfortunately, there are some characters allowed in identifiers by
6560 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
6561 identifiers.  That is, there's no way to use these symbols in portable
6562 ISO C or C++ and have all your identifiers in NFC@.
6563 @option{-Wnormalized=id} suppresses the warning for these characters.
6564 It is hoped that future versions of the standards involved will correct
6565 this, which is why this option is not the default.
6567 You can switch the warning off for all characters by writing
6568 @option{-Wnormalized=none} or @option{-Wno-normalized}.  You should
6569 only do this if you are using some other normalization scheme (like
6570 ``D''), because otherwise you can easily create bugs that are
6571 literally impossible to see.
6573 Some characters in ISO 10646 have distinct meanings but look identical
6574 in some fonts or display methodologies, especially once formatting has
6575 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
6576 LETTER N'', displays just like a regular @code{n} that has been
6577 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
6578 normalization scheme to convert all these into a standard form as
6579 well, and GCC warns if your code is not in NFKC if you use
6580 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
6581 about every identifier that contains the letter O because it might be
6582 confused with the digit 0, and so is not the default, but may be
6583 useful as a local coding convention if the programming environment 
6584 cannot be fixed to display these characters distinctly.
6586 @item -Wno-deprecated
6587 @opindex Wno-deprecated
6588 @opindex Wdeprecated
6589 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
6591 @item -Wno-deprecated-declarations
6592 @opindex Wno-deprecated-declarations
6593 @opindex Wdeprecated-declarations
6594 Do not warn about uses of functions (@pxref{Function Attributes}),
6595 variables (@pxref{Variable Attributes}), and types (@pxref{Type
6596 Attributes}) marked as deprecated by using the @code{deprecated}
6597 attribute.
6599 @item -Wno-overflow
6600 @opindex Wno-overflow
6601 @opindex Woverflow
6602 Do not warn about compile-time overflow in constant expressions.
6604 @item -Wno-odr
6605 @opindex Wno-odr
6606 @opindex Wodr
6607 Warn about One Definition Rule violations during link-time optimization.
6608 Requires @option{-flto-odr-type-merging} to be enabled.  Enabled by default.
6610 @item -Wopenmp-simd
6611 @opindex Wopenm-simd
6612 Warn if the vectorizer cost model overrides the OpenMP or the Cilk Plus
6613 simd directive set by user.  The @option{-fsimd-cost-model=unlimited}
6614 option can be used to relax the cost model.
6616 @item -Woverride-init @r{(C and Objective-C only)}
6617 @opindex Woverride-init
6618 @opindex Wno-override-init
6619 @opindex W
6620 @opindex Wextra
6621 @opindex Wno-extra
6622 Warn if an initialized field without side effects is overridden when
6623 using designated initializers (@pxref{Designated Inits, , Designated
6624 Initializers}).
6626 This warning is included in @option{-Wextra}.  To get other
6627 @option{-Wextra} warnings without this one, use @option{-Wextra
6628 -Wno-override-init}.
6630 @item -Woverride-init-side-effects @r{(C and Objective-C only)}
6631 @opindex Woverride-init-side-effects
6632 @opindex Wno-override-init-side-effects
6633 Warn if an initialized field with side effects is overridden when
6634 using designated initializers (@pxref{Designated Inits, , Designated
6635 Initializers}).  This warning is enabled by default.
6637 @item -Wpacked
6638 @opindex Wpacked
6639 @opindex Wno-packed
6640 Warn if a structure is given the packed attribute, but the packed
6641 attribute has no effect on the layout or size of the structure.
6642 Such structures may be mis-aligned for little benefit.  For
6643 instance, in this code, the variable @code{f.x} in @code{struct bar}
6644 is misaligned even though @code{struct bar} does not itself
6645 have the packed attribute:
6647 @smallexample
6648 @group
6649 struct foo @{
6650   int x;
6651   char a, b, c, d;
6652 @} __attribute__((packed));
6653 struct bar @{
6654   char z;
6655   struct foo f;
6657 @end group
6658 @end smallexample
6660 @item -Wpacked-bitfield-compat
6661 @opindex Wpacked-bitfield-compat
6662 @opindex Wno-packed-bitfield-compat
6663 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
6664 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
6665 the change can lead to differences in the structure layout.  GCC
6666 informs you when the offset of such a field has changed in GCC 4.4.
6667 For example there is no longer a 4-bit padding between field @code{a}
6668 and @code{b} in this structure:
6670 @smallexample
6671 struct foo
6673   char a:4;
6674   char b:8;
6675 @} __attribute__ ((packed));
6676 @end smallexample
6678 This warning is enabled by default.  Use
6679 @option{-Wno-packed-bitfield-compat} to disable this warning.
6681 @item -Wpacked-not-aligned @r{(C, C++, Objective-C and Objective-C++ only)}
6682 @opindex Wpacked-not-aligned
6683 @opindex Wno-packed-not-aligned
6684 Warn if a structure field with explicitly specified alignment in a
6685 packed struct or union is misaligned.  For example, a warning will
6686 be issued on @code{struct S}, like, @code{warning: alignment 1 of
6687 'struct S' is less than 8}, in this code:
6689 @smallexample
6690 @group
6691 struct __attribute__ ((aligned (8))) S8 @{ char a[8]; @};
6692 struct __attribute__ ((packed)) S @{
6693   struct S8 s8;
6695 @end group
6696 @end smallexample
6698 This warning is enabled by @option{-Wall}.
6700 @item -Wpadded
6701 @opindex Wpadded
6702 @opindex Wno-padded
6703 Warn if padding is included in a structure, either to align an element
6704 of the structure or to align the whole structure.  Sometimes when this
6705 happens it is possible to rearrange the fields of the structure to
6706 reduce the padding and so make the structure smaller.
6708 @item -Wredundant-decls
6709 @opindex Wredundant-decls
6710 @opindex Wno-redundant-decls
6711 Warn if anything is declared more than once in the same scope, even in
6712 cases where multiple declaration is valid and changes nothing.
6714 @item -Wrestrict
6715 @opindex Wrestrict
6716 @opindex Wno-restrict
6717 Warn when an argument passed to a restrict-qualified parameter
6718 aliases with another argument.
6720 @item -Wnested-externs @r{(C and Objective-C only)}
6721 @opindex Wnested-externs
6722 @opindex Wno-nested-externs
6723 Warn if an @code{extern} declaration is encountered within a function.
6725 @item -Wno-inherited-variadic-ctor
6726 @opindex Winherited-variadic-ctor
6727 @opindex Wno-inherited-variadic-ctor
6728 Suppress warnings about use of C++11 inheriting constructors when the
6729 base class inherited from has a C variadic constructor; the warning is
6730 on by default because the ellipsis is not inherited.
6732 @item -Winline
6733 @opindex Winline
6734 @opindex Wno-inline
6735 Warn if a function that is declared as inline cannot be inlined.
6736 Even with this option, the compiler does not warn about failures to
6737 inline functions declared in system headers.
6739 The compiler uses a variety of heuristics to determine whether or not
6740 to inline a function.  For example, the compiler takes into account
6741 the size of the function being inlined and the amount of inlining
6742 that has already been done in the current function.  Therefore,
6743 seemingly insignificant changes in the source program can cause the
6744 warnings produced by @option{-Winline} to appear or disappear.
6746 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
6747 @opindex Wno-invalid-offsetof
6748 @opindex Winvalid-offsetof
6749 Suppress warnings from applying the @code{offsetof} macro to a non-POD
6750 type.  According to the 2014 ISO C++ standard, applying @code{offsetof}
6751 to a non-standard-layout type is undefined.  In existing C++ implementations,
6752 however, @code{offsetof} typically gives meaningful results.
6753 This flag is for users who are aware that they are
6754 writing nonportable code and who have deliberately chosen to ignore the
6755 warning about it.
6757 The restrictions on @code{offsetof} may be relaxed in a future version
6758 of the C++ standard.
6760 @item -Wint-in-bool-context
6761 @opindex Wint-in-bool-context
6762 @opindex Wno-int-in-bool-context
6763 Warn for suspicious use of integer values where boolean values are expected,
6764 such as conditional expressions (?:) using non-boolean integer constants in
6765 boolean context, like @code{if (a <= b ? 2 : 3)}.  Or left shifting of signed
6766 integers in boolean context, like @code{for (a = 0; 1 << a; a++);}.  Likewise
6767 for all kinds of multiplications regardless of the data type.
6768 This warning is enabled by @option{-Wall}.
6770 @item -Wno-int-to-pointer-cast
6771 @opindex Wno-int-to-pointer-cast
6772 @opindex Wint-to-pointer-cast
6773 Suppress warnings from casts to pointer type of an integer of a
6774 different size. In C++, casting to a pointer type of smaller size is
6775 an error. @option{Wint-to-pointer-cast} is enabled by default.
6778 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
6779 @opindex Wno-pointer-to-int-cast
6780 @opindex Wpointer-to-int-cast
6781 Suppress warnings from casts from a pointer to an integer type of a
6782 different size.
6784 @item -Winvalid-pch
6785 @opindex Winvalid-pch
6786 @opindex Wno-invalid-pch
6787 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
6788 the search path but cannot be used.
6790 @item -Wlong-long
6791 @opindex Wlong-long
6792 @opindex Wno-long-long
6793 Warn if @code{long long} type is used.  This is enabled by either
6794 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
6795 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
6797 @item -Wvariadic-macros
6798 @opindex Wvariadic-macros
6799 @opindex Wno-variadic-macros
6800 Warn if variadic macros are used in ISO C90 mode, or if the GNU
6801 alternate syntax is used in ISO C99 mode.  This is enabled by either
6802 @option{-Wpedantic} or @option{-Wtraditional}.  To inhibit the warning
6803 messages, use @option{-Wno-variadic-macros}.
6805 @item -Wvarargs
6806 @opindex Wvarargs
6807 @opindex Wno-varargs
6808 Warn upon questionable usage of the macros used to handle variable
6809 arguments like @code{va_start}.  This is default.  To inhibit the
6810 warning messages, use @option{-Wno-varargs}.
6812 @item -Wvector-operation-performance
6813 @opindex Wvector-operation-performance
6814 @opindex Wno-vector-operation-performance
6815 Warn if vector operation is not implemented via SIMD capabilities of the
6816 architecture.  Mainly useful for the performance tuning.
6817 Vector operation can be implemented @code{piecewise}, which means that the
6818 scalar operation is performed on every vector element; 
6819 @code{in parallel}, which means that the vector operation is implemented
6820 using scalars of wider type, which normally is more performance efficient;
6821 and @code{as a single scalar}, which means that vector fits into a
6822 scalar type.
6824 @item -Wno-virtual-move-assign
6825 @opindex Wvirtual-move-assign
6826 @opindex Wno-virtual-move-assign
6827 Suppress warnings about inheriting from a virtual base with a
6828 non-trivial C++11 move assignment operator.  This is dangerous because
6829 if the virtual base is reachable along more than one path, it is
6830 moved multiple times, which can mean both objects end up in the
6831 moved-from state.  If the move assignment operator is written to avoid
6832 moving from a moved-from object, this warning can be disabled.
6834 @item -Wvla
6835 @opindex Wvla
6836 @opindex Wno-vla
6837 Warn if a variable-length array is used in the code.
6838 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
6839 the variable-length array.
6841 @item -Wvla-larger-than=@var{n}
6842 If this option is used, the compiler will warn on uses of
6843 variable-length arrays where the size is either unbounded, or bounded
6844 by an argument that can be larger than @var{n} bytes.  This is similar
6845 to how @option{-Walloca-larger-than=@var{n}} works, but with
6846 variable-length arrays.
6848 Note that GCC may optimize small variable-length arrays of a known
6849 value into plain arrays, so this warning may not get triggered for
6850 such arrays.
6852 This warning is not enabled by @option{-Wall}, and is only active when
6853 @option{-ftree-vrp} is active (default for @option{-O2} and above).
6855 See also @option{-Walloca-larger-than=@var{n}}.
6857 @item -Wvolatile-register-var
6858 @opindex Wvolatile-register-var
6859 @opindex Wno-volatile-register-var
6860 Warn if a register variable is declared volatile.  The volatile
6861 modifier does not inhibit all optimizations that may eliminate reads
6862 and/or writes to register variables.  This warning is enabled by
6863 @option{-Wall}.
6865 @item -Wdisabled-optimization
6866 @opindex Wdisabled-optimization
6867 @opindex Wno-disabled-optimization
6868 Warn if a requested optimization pass is disabled.  This warning does
6869 not generally indicate that there is anything wrong with your code; it
6870 merely indicates that GCC's optimizers are unable to handle the code
6871 effectively.  Often, the problem is that your code is too big or too
6872 complex; GCC refuses to optimize programs when the optimization
6873 itself is likely to take inordinate amounts of time.
6875 @item -Wpointer-sign @r{(C and Objective-C only)}
6876 @opindex Wpointer-sign
6877 @opindex Wno-pointer-sign
6878 Warn for pointer argument passing or assignment with different signedness.
6879 This option is only supported for C and Objective-C@.  It is implied by
6880 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
6881 @option{-Wno-pointer-sign}.
6883 @item -Wstack-protector
6884 @opindex Wstack-protector
6885 @opindex Wno-stack-protector
6886 This option is only active when @option{-fstack-protector} is active.  It
6887 warns about functions that are not protected against stack smashing.
6889 @item -Woverlength-strings
6890 @opindex Woverlength-strings
6891 @opindex Wno-overlength-strings
6892 Warn about string constants that are longer than the ``minimum
6893 maximum'' length specified in the C standard.  Modern compilers
6894 generally allow string constants that are much longer than the
6895 standard's minimum limit, but very portable programs should avoid
6896 using longer strings.
6898 The limit applies @emph{after} string constant concatenation, and does
6899 not count the trailing NUL@.  In C90, the limit was 509 characters; in
6900 C99, it was raised to 4095.  C++98 does not specify a normative
6901 minimum maximum, so we do not diagnose overlength strings in C++@.
6903 This option is implied by @option{-Wpedantic}, and can be disabled with
6904 @option{-Wno-overlength-strings}.
6906 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
6907 @opindex Wunsuffixed-float-constants
6909 Issue a warning for any floating constant that does not have
6910 a suffix.  When used together with @option{-Wsystem-headers} it
6911 warns about such constants in system header files.  This can be useful
6912 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
6913 from the decimal floating-point extension to C99.
6915 @item -Wno-designated-init @r{(C and Objective-C only)}
6916 Suppress warnings when a positional initializer is used to initialize
6917 a structure that has been marked with the @code{designated_init}
6918 attribute.
6920 @item -Whsa
6921 Issue a warning when HSAIL cannot be emitted for the compiled function or
6922 OpenMP construct.
6924 @end table
6926 @node Debugging Options
6927 @section Options for Debugging Your Program
6928 @cindex options, debugging
6929 @cindex debugging information options
6931 To tell GCC to emit extra information for use by a debugger, in almost 
6932 all cases you need only to add @option{-g} to your other options.
6934 GCC allows you to use @option{-g} with
6935 @option{-O}.  The shortcuts taken by optimized code may occasionally
6936 be surprising: some variables you declared may not exist
6937 at all; flow of control may briefly move where you did not expect it;
6938 some statements may not be executed because they compute constant
6939 results or their values are already at hand; some statements may
6940 execute in different places because they have been moved out of loops.
6941 Nevertheless it is possible to debug optimized output.  This makes
6942 it reasonable to use the optimizer for programs that might have bugs.
6944 If you are not using some other optimization option, consider
6945 using @option{-Og} (@pxref{Optimize Options}) with @option{-g}.  
6946 With no @option{-O} option at all, some compiler passes that collect
6947 information useful for debugging do not run at all, so that
6948 @option{-Og} may result in a better debugging experience.
6950 @table @gcctabopt
6951 @item -g
6952 @opindex g
6953 Produce debugging information in the operating system's native format
6954 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
6955 information.
6957 On most systems that use stabs format, @option{-g} enables use of extra
6958 debugging information that only GDB can use; this extra information
6959 makes debugging work better in GDB but probably makes other debuggers
6960 crash or
6961 refuse to read the program.  If you want to control for certain whether
6962 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
6963 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
6965 @item -ggdb
6966 @opindex ggdb
6967 Produce debugging information for use by GDB@.  This means to use the
6968 most expressive format available (DWARF, stabs, or the native format
6969 if neither of those are supported), including GDB extensions if at all
6970 possible.
6972 @item -gdwarf
6973 @itemx -gdwarf-@var{version}
6974 @opindex gdwarf
6975 Produce debugging information in DWARF format (if that is supported).
6976 The value of @var{version} may be either 2, 3, 4 or 5; the default version
6977 for most targets is 4.  DWARF Version 5 is only experimental.
6979 Note that with DWARF Version 2, some ports require and always
6980 use some non-conflicting DWARF 3 extensions in the unwind tables.
6982 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
6983 for maximum benefit.
6985 GCC no longer supports DWARF Version 1, which is substantially
6986 different than Version 2 and later.  For historical reasons, some
6987 other DWARF-related options such as
6988 @option{-fno-dwarf2-cfi-asm}) retain a reference to DWARF Version 2
6989 in their names, but apply to all currently-supported versions of DWARF.
6991 @item -gstabs
6992 @opindex gstabs
6993 Produce debugging information in stabs format (if that is supported),
6994 without GDB extensions.  This is the format used by DBX on most BSD
6995 systems.  On MIPS, Alpha and System V Release 4 systems this option
6996 produces stabs debugging output that is not understood by DBX@.
6997 On System V Release 4 systems this option requires the GNU assembler.
6999 @item -gstabs+
7000 @opindex gstabs+
7001 Produce debugging information in stabs format (if that is supported),
7002 using GNU extensions understood only by the GNU debugger (GDB)@.  The
7003 use of these extensions is likely to make other debuggers crash or
7004 refuse to read the program.
7006 @item -gxcoff
7007 @opindex gxcoff
7008 Produce debugging information in XCOFF format (if that is supported).
7009 This is the format used by the DBX debugger on IBM RS/6000 systems.
7011 @item -gxcoff+
7012 @opindex gxcoff+
7013 Produce debugging information in XCOFF format (if that is supported),
7014 using GNU extensions understood only by the GNU debugger (GDB)@.  The
7015 use of these extensions is likely to make other debuggers crash or
7016 refuse to read the program, and may cause assemblers other than the GNU
7017 assembler (GAS) to fail with an error.
7019 @item -gvms
7020 @opindex gvms
7021 Produce debugging information in Alpha/VMS debug format (if that is
7022 supported).  This is the format used by DEBUG on Alpha/VMS systems.
7024 @item -g@var{level}
7025 @itemx -ggdb@var{level}
7026 @itemx -gstabs@var{level}
7027 @itemx -gxcoff@var{level}
7028 @itemx -gvms@var{level}
7029 Request debugging information and also use @var{level} to specify how
7030 much information.  The default level is 2.
7032 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
7033 @option{-g}.
7035 Level 1 produces minimal information, enough for making backtraces in
7036 parts of the program that you don't plan to debug.  This includes
7037 descriptions of functions and external variables, and line number
7038 tables, but no information about local variables.
7040 Level 3 includes extra information, such as all the macro definitions
7041 present in the program.  Some debuggers support macro expansion when
7042 you use @option{-g3}.
7044 @option{-gdwarf} does not accept a concatenated debug level, to avoid
7045 confusion with @option{-gdwarf-@var{level}}.
7046 Instead use an additional @option{-g@var{level}} option to change the
7047 debug level for DWARF.
7049 @item -feliminate-unused-debug-symbols
7050 @opindex feliminate-unused-debug-symbols
7051 Produce debugging information in stabs format (if that is supported),
7052 for only symbols that are actually used.
7054 @item -femit-class-debug-always
7055 @opindex femit-class-debug-always
7056 Instead of emitting debugging information for a C++ class in only one
7057 object file, emit it in all object files using the class.  This option
7058 should be used only with debuggers that are unable to handle the way GCC
7059 normally emits debugging information for classes because using this
7060 option increases the size of debugging information by as much as a
7061 factor of two.
7063 @item -fno-merge-debug-strings
7064 @opindex fmerge-debug-strings
7065 @opindex fno-merge-debug-strings
7066 Direct the linker to not merge together strings in the debugging
7067 information that are identical in different object files.  Merging is
7068 not supported by all assemblers or linkers.  Merging decreases the size
7069 of the debug information in the output file at the cost of increasing
7070 link processing time.  Merging is enabled by default.
7072 @item -fdebug-prefix-map=@var{old}=@var{new}
7073 @opindex fdebug-prefix-map
7074 When compiling files in directory @file{@var{old}}, record debugging
7075 information describing them as in @file{@var{new}} instead.  This can be
7076 used to replace a build-time path with an install-time path in the debug info.
7077 It can also be used to change an absolute path to a relative path by using
7078 @file{.} for @var{new}.  This can give more reproducible builds, which are
7079 location independent, but may require an extra command to tell GDB where to
7080 find the source files.
7082 @item -fvar-tracking
7083 @opindex fvar-tracking
7084 Run variable tracking pass.  It computes where variables are stored at each
7085 position in code.  Better debugging information is then generated
7086 (if the debugging information format supports this information).
7088 It is enabled by default when compiling with optimization (@option{-Os},
7089 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
7090 the debug info format supports it.
7092 @item -fvar-tracking-assignments
7093 @opindex fvar-tracking-assignments
7094 @opindex fno-var-tracking-assignments
7095 Annotate assignments to user variables early in the compilation and
7096 attempt to carry the annotations over throughout the compilation all the
7097 way to the end, in an attempt to improve debug information while
7098 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
7100 It can be enabled even if var-tracking is disabled, in which case
7101 annotations are created and maintained, but discarded at the end.
7102 By default, this flag is enabled together with @option{-fvar-tracking},
7103 except when selective scheduling is enabled.
7105 @item -gsplit-dwarf
7106 @opindex gsplit-dwarf
7107 Separate as much DWARF debugging information as possible into a
7108 separate output file with the extension @file{.dwo}.  This option allows
7109 the build system to avoid linking files with debug information.  To
7110 be useful, this option requires a debugger capable of reading @file{.dwo}
7111 files.
7113 @item -gpubnames
7114 @opindex gpubnames
7115 Generate DWARF @code{.debug_pubnames} and @code{.debug_pubtypes} sections.
7117 @item -ggnu-pubnames
7118 @opindex ggnu-pubnames
7119 Generate @code{.debug_pubnames} and @code{.debug_pubtypes} sections in a format
7120 suitable for conversion into a GDB@ index.  This option is only useful
7121 with a linker that can produce GDB@ index version 7.
7123 @item -fdebug-types-section
7124 @opindex fdebug-types-section
7125 @opindex fno-debug-types-section
7126 When using DWARF Version 4 or higher, type DIEs can be put into
7127 their own @code{.debug_types} section instead of making them part of the
7128 @code{.debug_info} section.  It is more efficient to put them in a separate
7129 comdat sections since the linker can then remove duplicates.
7130 But not all DWARF consumers support @code{.debug_types} sections yet
7131 and on some objects @code{.debug_types} produces larger instead of smaller
7132 debugging information.
7134 @item -grecord-gcc-switches
7135 @item -gno-record-gcc-switches
7136 @opindex grecord-gcc-switches
7137 @opindex gno-record-gcc-switches
7138 This switch causes the command-line options used to invoke the
7139 compiler that may affect code generation to be appended to the
7140 DW_AT_producer attribute in DWARF debugging information.  The options
7141 are concatenated with spaces separating them from each other and from
7142 the compiler version.  
7143 It is enabled by default.
7144 See also @option{-frecord-gcc-switches} for another
7145 way of storing compiler options into the object file.  
7147 @item -gstrict-dwarf
7148 @opindex gstrict-dwarf
7149 Disallow using extensions of later DWARF standard version than selected
7150 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
7151 DWARF extensions from later standard versions is allowed.
7153 @item -gno-strict-dwarf
7154 @opindex gno-strict-dwarf
7155 Allow using extensions of later DWARF standard version than selected with
7156 @option{-gdwarf-@var{version}}.
7158 @item -gcolumn-info
7159 @item -gno-column-info
7160 @opindex gcolumn-info
7161 @opindex gno-column-info
7162 Emit location column information into DWARF debugging information, rather
7163 than just file and line.
7164 This option is enabled by default.
7166 @item -gstatement-frontiers
7167 @item -gno-statement-frontiers
7168 @opindex gstatement-frontiers
7169 @opindex gno-statement-frontiers
7170 This option causes GCC to create markers in the internal representation
7171 at the beginning of statements, and to keep them roughly in place
7172 throughout compilation, using them to guide the output of @code{is_stmt}
7173 markers in the line number table.  This is enabled by default when
7174 compiling with optimization (@option{-Os}, @option{-O}, @option{-O2},
7175 @dots{}), and outputting DWARF 2 debug information at the normal level.
7177 @item -gz@r{[}=@var{type}@r{]}
7178 @opindex gz
7179 Produce compressed debug sections in DWARF format, if that is supported.
7180 If @var{type} is not given, the default type depends on the capabilities
7181 of the assembler and linker used.  @var{type} may be one of
7182 @samp{none} (don't compress debug sections), @samp{zlib} (use zlib
7183 compression in ELF gABI format), or @samp{zlib-gnu} (use zlib
7184 compression in traditional GNU format).  If the linker doesn't support
7185 writing compressed debug sections, the option is rejected.  Otherwise,
7186 if the assembler does not support them, @option{-gz} is silently ignored
7187 when producing object files.
7189 @item -femit-struct-debug-baseonly
7190 @opindex femit-struct-debug-baseonly
7191 Emit debug information for struct-like types
7192 only when the base name of the compilation source file
7193 matches the base name of file in which the struct is defined.
7195 This option substantially reduces the size of debugging information,
7196 but at significant potential loss in type information to the debugger.
7197 See @option{-femit-struct-debug-reduced} for a less aggressive option.
7198 See @option{-femit-struct-debug-detailed} for more detailed control.
7200 This option works only with DWARF debug output.
7202 @item -femit-struct-debug-reduced
7203 @opindex femit-struct-debug-reduced
7204 Emit debug information for struct-like types
7205 only when the base name of the compilation source file
7206 matches the base name of file in which the type is defined,
7207 unless the struct is a template or defined in a system header.
7209 This option significantly reduces the size of debugging information,
7210 with some potential loss in type information to the debugger.
7211 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
7212 See @option{-femit-struct-debug-detailed} for more detailed control.
7214 This option works only with DWARF debug output.
7216 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
7217 @opindex femit-struct-debug-detailed
7218 Specify the struct-like types
7219 for which the compiler generates debug information.
7220 The intent is to reduce duplicate struct debug information
7221 between different object files within the same program.
7223 This option is a detailed version of
7224 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
7225 which serves for most needs.
7227 A specification has the syntax@*
7228 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
7230 The optional first word limits the specification to
7231 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
7232 A struct type is used directly when it is the type of a variable, member.
7233 Indirect uses arise through pointers to structs.
7234 That is, when use of an incomplete struct is valid, the use is indirect.
7235 An example is
7236 @samp{struct one direct; struct two * indirect;}.
7238 The optional second word limits the specification to
7239 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
7240 Generic structs are a bit complicated to explain.
7241 For C++, these are non-explicit specializations of template classes,
7242 or non-template classes within the above.
7243 Other programming languages have generics,
7244 but @option{-femit-struct-debug-detailed} does not yet implement them.
7246 The third word specifies the source files for those
7247 structs for which the compiler should emit debug information.
7248 The values @samp{none} and @samp{any} have the normal meaning.
7249 The value @samp{base} means that
7250 the base of name of the file in which the type declaration appears
7251 must match the base of the name of the main compilation file.
7252 In practice, this means that when compiling @file{foo.c}, debug information
7253 is generated for types declared in that file and @file{foo.h},
7254 but not other header files.
7255 The value @samp{sys} means those types satisfying @samp{base}
7256 or declared in system or compiler headers.
7258 You may need to experiment to determine the best settings for your application.
7260 The default is @option{-femit-struct-debug-detailed=all}.
7262 This option works only with DWARF debug output.
7264 @item -fno-dwarf2-cfi-asm
7265 @opindex fdwarf2-cfi-asm
7266 @opindex fno-dwarf2-cfi-asm
7267 Emit DWARF unwind info as compiler generated @code{.eh_frame} section
7268 instead of using GAS @code{.cfi_*} directives.
7270 @item -fno-eliminate-unused-debug-types
7271 @opindex feliminate-unused-debug-types
7272 @opindex fno-eliminate-unused-debug-types
7273 Normally, when producing DWARF output, GCC avoids producing debug symbol 
7274 output for types that are nowhere used in the source file being compiled.
7275 Sometimes it is useful to have GCC emit debugging
7276 information for all types declared in a compilation
7277 unit, regardless of whether or not they are actually used
7278 in that compilation unit, for example 
7279 if, in the debugger, you want to cast a value to a type that is
7280 not actually used in your program (but is declared).  More often,
7281 however, this results in a significant amount of wasted space.
7282 @end table
7284 @node Optimize Options
7285 @section Options That Control Optimization
7286 @cindex optimize options
7287 @cindex options, optimization
7289 These options control various sorts of optimizations.
7291 Without any optimization option, the compiler's goal is to reduce the
7292 cost of compilation and to make debugging produce the expected
7293 results.  Statements are independent: if you stop the program with a
7294 breakpoint between statements, you can then assign a new value to any
7295 variable or change the program counter to any other statement in the
7296 function and get exactly the results you expect from the source
7297 code.
7299 Turning on optimization flags makes the compiler attempt to improve
7300 the performance and/or code size at the expense of compilation time
7301 and possibly the ability to debug the program.
7303 The compiler performs optimization based on the knowledge it has of the
7304 program.  Compiling multiple files at once to a single output file mode allows
7305 the compiler to use information gained from all of the files when compiling
7306 each of them.
7308 Not all optimizations are controlled directly by a flag.  Only
7309 optimizations that have a flag are listed in this section.
7311 Most optimizations are only enabled if an @option{-O} level is set on
7312 the command line.  Otherwise they are disabled, even if individual
7313 optimization flags are specified.
7315 Depending on the target and how GCC was configured, a slightly different
7316 set of optimizations may be enabled at each @option{-O} level than
7317 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
7318 to find out the exact set of optimizations that are enabled at each level.
7319 @xref{Overall Options}, for examples.
7321 @table @gcctabopt
7322 @item -O
7323 @itemx -O1
7324 @opindex O
7325 @opindex O1
7326 Optimize.  Optimizing compilation takes somewhat more time, and a lot
7327 more memory for a large function.
7329 With @option{-O}, the compiler tries to reduce code size and execution
7330 time, without performing any optimizations that take a great deal of
7331 compilation time.
7333 @option{-O} turns on the following optimization flags:
7334 @gccoptlist{
7335 -fauto-inc-dec @gol
7336 -fbranch-count-reg @gol
7337 -fcombine-stack-adjustments @gol
7338 -fcompare-elim @gol
7339 -fcprop-registers @gol
7340 -fdce @gol
7341 -fdefer-pop @gol
7342 -fdelayed-branch @gol
7343 -fdse @gol
7344 -fforward-propagate @gol
7345 -fguess-branch-probability @gol
7346 -fif-conversion2 @gol
7347 -fif-conversion @gol
7348 -finline-functions-called-once @gol
7349 -fipa-pure-const @gol
7350 -fipa-profile @gol
7351 -fipa-reference @gol
7352 -fmerge-constants @gol
7353 -fmove-loop-invariants @gol
7354 -fomit-frame-pointer @gol
7355 -freorder-blocks @gol
7356 -fshrink-wrap @gol
7357 -fshrink-wrap-separate @gol
7358 -fsplit-wide-types @gol
7359 -fssa-backprop @gol
7360 -fssa-phiopt @gol
7361 -ftree-bit-ccp @gol
7362 -ftree-ccp @gol
7363 -ftree-ch @gol
7364 -ftree-coalesce-vars @gol
7365 -ftree-copy-prop @gol
7366 -ftree-dce @gol
7367 -ftree-dominator-opts @gol
7368 -ftree-dse @gol
7369 -ftree-forwprop @gol
7370 -ftree-fre @gol
7371 -ftree-phiprop @gol
7372 -ftree-sink @gol
7373 -ftree-slsr @gol
7374 -ftree-sra @gol
7375 -ftree-pta @gol
7376 -ftree-ter @gol
7377 -funit-at-a-time}
7379 @item -O2
7380 @opindex O2
7381 Optimize even more.  GCC performs nearly all supported optimizations
7382 that do not involve a space-speed tradeoff.
7383 As compared to @option{-O}, this option increases both compilation time
7384 and the performance of the generated code.
7386 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
7387 also turns on the following optimization flags:
7388 @gccoptlist{-fthread-jumps @gol
7389 -falign-functions  -falign-jumps @gol
7390 -falign-loops  -falign-labels @gol
7391 -fcaller-saves @gol
7392 -fcrossjumping @gol
7393 -fcse-follow-jumps  -fcse-skip-blocks @gol
7394 -fdelete-null-pointer-checks @gol
7395 -fdevirtualize -fdevirtualize-speculatively @gol
7396 -fexpensive-optimizations @gol
7397 -fgcse  -fgcse-lm  @gol
7398 -fhoist-adjacent-loads @gol
7399 -finline-small-functions @gol
7400 -findirect-inlining @gol
7401 -fipa-cp @gol
7402 -fipa-bit-cp @gol
7403 -fipa-vrp @gol
7404 -fipa-sra @gol
7405 -fipa-icf @gol
7406 -fisolate-erroneous-paths-dereference @gol
7407 -flra-remat @gol
7408 -foptimize-sibling-calls @gol
7409 -foptimize-strlen @gol
7410 -fpartial-inlining @gol
7411 -fpeephole2 @gol
7412 -freorder-blocks-algorithm=stc @gol
7413 -freorder-blocks-and-partition -freorder-functions @gol
7414 -frerun-cse-after-loop  @gol
7415 -fsched-interblock  -fsched-spec @gol
7416 -fschedule-insns  -fschedule-insns2 @gol
7417 -fstore-merging @gol
7418 -fstrict-aliasing @gol
7419 -ftree-builtin-call-dce @gol
7420 -ftree-switch-conversion -ftree-tail-merge @gol
7421 -fcode-hoisting @gol
7422 -ftree-pre @gol
7423 -ftree-vrp @gol
7424 -fipa-ra}
7426 Please note the warning under @option{-fgcse} about
7427 invoking @option{-O2} on programs that use computed gotos.
7429 @item -O3
7430 @opindex O3
7431 Optimize yet more.  @option{-O3} turns on all optimizations specified
7432 by @option{-O2} and also turns on the following optimization flags:
7433 @gccoptlist{-finline-functions @gol
7434 -funswitch-loops @gol
7435 -fpredictive-commoning @gol
7436 -fgcse-after-reload @gol
7437 -ftree-loop-vectorize @gol
7438 -ftree-loop-distribution @gol
7439 -ftree-loop-distribute-patterns @gol
7440 -floop-interchange @gol
7441 -fsplit-paths @gol
7442 -ftree-slp-vectorize @gol
7443 -fvect-cost-model @gol
7444 -ftree-partial-pre @gol
7445 -fpeel-loops @gol
7446 -fipa-cp-clone}
7448 @item -O0
7449 @opindex O0
7450 Reduce compilation time and make debugging produce the expected
7451 results.  This is the default.
7453 @item -Os
7454 @opindex Os
7455 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
7456 do not typically increase code size.  It also performs further
7457 optimizations designed to reduce code size.
7459 @option{-Os} disables the following optimization flags:
7460 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
7461 -falign-labels  -freorder-blocks  -freorder-blocks-algorithm=stc @gol
7462 -freorder-blocks-and-partition  -fprefetch-loop-arrays}
7464 @item -Ofast
7465 @opindex Ofast
7466 Disregard strict standards compliance.  @option{-Ofast} enables all
7467 @option{-O3} optimizations.  It also enables optimizations that are not
7468 valid for all standard-compliant programs.
7469 It turns on @option{-ffast-math} and the Fortran-specific
7470 @option{-fstack-arrays}, unless @option{-fmax-stack-var-size} is
7471 specified, and @option{-fno-protect-parens}.
7473 @item -Og
7474 @opindex Og
7475 Optimize debugging experience.  @option{-Og} enables optimizations
7476 that do not interfere with debugging. It should be the optimization
7477 level of choice for the standard edit-compile-debug cycle, offering
7478 a reasonable level of optimization while maintaining fast compilation
7479 and a good debugging experience.
7480 @end table
7482 If you use multiple @option{-O} options, with or without level numbers,
7483 the last such option is the one that is effective.
7485 Options of the form @option{-f@var{flag}} specify machine-independent
7486 flags.  Most flags have both positive and negative forms; the negative
7487 form of @option{-ffoo} is @option{-fno-foo}.  In the table
7488 below, only one of the forms is listed---the one you typically 
7489 use.  You can figure out the other form by either removing @samp{no-}
7490 or adding it.
7492 The following options control specific optimizations.  They are either
7493 activated by @option{-O} options or are related to ones that are.  You
7494 can use the following flags in the rare cases when ``fine-tuning'' of
7495 optimizations to be performed is desired.
7497 @table @gcctabopt
7498 @item -fno-defer-pop
7499 @opindex fno-defer-pop
7500 Always pop the arguments to each function call as soon as that function
7501 returns.  For machines that must pop arguments after a function call,
7502 the compiler normally lets arguments accumulate on the stack for several
7503 function calls and pops them all at once.
7505 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7507 @item -fforward-propagate
7508 @opindex fforward-propagate
7509 Perform a forward propagation pass on RTL@.  The pass tries to combine two
7510 instructions and checks if the result can be simplified.  If loop unrolling
7511 is active, two passes are performed and the second is scheduled after
7512 loop unrolling.
7514 This option is enabled by default at optimization levels @option{-O},
7515 @option{-O2}, @option{-O3}, @option{-Os}.
7517 @item -ffp-contract=@var{style}
7518 @opindex ffp-contract
7519 @option{-ffp-contract=off} disables floating-point expression contraction.
7520 @option{-ffp-contract=fast} enables floating-point expression contraction
7521 such as forming of fused multiply-add operations if the target has
7522 native support for them.
7523 @option{-ffp-contract=on} enables floating-point expression contraction
7524 if allowed by the language standard.  This is currently not implemented
7525 and treated equal to @option{-ffp-contract=off}.
7527 The default is @option{-ffp-contract=fast}.
7529 @item -fomit-frame-pointer
7530 @opindex fomit-frame-pointer
7531 Omit the frame pointer in functions that don't need one.  This avoids the
7532 instructions to save, set up and restore the frame pointer; on many targets
7533 it also makes an extra register available.
7535 On some targets this flag has no effect because the standard calling sequence
7536 always uses a frame pointer, so it cannot be omitted.
7538 Note that @option{-fno-omit-frame-pointer} doesn't guarantee the frame pointer
7539 is used in all functions.  Several targets always omit the frame pointer in
7540 leaf functions.
7542 Enabled by default at @option{-O} and higher.
7544 @item -foptimize-sibling-calls
7545 @opindex foptimize-sibling-calls
7546 Optimize sibling and tail recursive calls.
7548 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7550 @item -foptimize-strlen
7551 @opindex foptimize-strlen
7552 Optimize various standard C string functions (e.g. @code{strlen},
7553 @code{strchr} or @code{strcpy}) and
7554 their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
7556 Enabled at levels @option{-O2}, @option{-O3}.
7558 @item -fno-inline
7559 @opindex fno-inline
7560 Do not expand any functions inline apart from those marked with
7561 the @code{always_inline} attribute.  This is the default when not
7562 optimizing.
7564 Single functions can be exempted from inlining by marking them
7565 with the @code{noinline} attribute.
7567 @item -finline-small-functions
7568 @opindex finline-small-functions
7569 Integrate functions into their callers when their body is smaller than expected
7570 function call code (so overall size of program gets smaller).  The compiler
7571 heuristically decides which functions are simple enough to be worth integrating
7572 in this way.  This inlining applies to all functions, even those not declared
7573 inline.
7575 Enabled at level @option{-O2}.
7577 @item -findirect-inlining
7578 @opindex findirect-inlining
7579 Inline also indirect calls that are discovered to be known at compile
7580 time thanks to previous inlining.  This option has any effect only
7581 when inlining itself is turned on by the @option{-finline-functions}
7582 or @option{-finline-small-functions} options.
7584 Enabled at level @option{-O2}.
7586 @item -finline-functions
7587 @opindex finline-functions
7588 Consider all functions for inlining, even if they are not declared inline.
7589 The compiler heuristically decides which functions are worth integrating
7590 in this way.
7592 If all calls to a given function are integrated, and the function is
7593 declared @code{static}, then the function is normally not output as
7594 assembler code in its own right.
7596 Enabled at level @option{-O3}.
7598 @item -finline-functions-called-once
7599 @opindex finline-functions-called-once
7600 Consider all @code{static} functions called once for inlining into their
7601 caller even if they are not marked @code{inline}.  If a call to a given
7602 function is integrated, then the function is not output as assembler code
7603 in its own right.
7605 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
7607 @item -fearly-inlining
7608 @opindex fearly-inlining
7609 Inline functions marked by @code{always_inline} and functions whose body seems
7610 smaller than the function call overhead early before doing
7611 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
7612 makes profiling significantly cheaper and usually inlining faster on programs
7613 having large chains of nested wrapper functions.
7615 Enabled by default.
7617 @item -fipa-sra
7618 @opindex fipa-sra
7619 Perform interprocedural scalar replacement of aggregates, removal of
7620 unused parameters and replacement of parameters passed by reference
7621 by parameters passed by value.
7623 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
7625 @item -finline-limit=@var{n}
7626 @opindex finline-limit
7627 By default, GCC limits the size of functions that can be inlined.  This flag
7628 allows coarse control of this limit.  @var{n} is the size of functions that
7629 can be inlined in number of pseudo instructions.
7631 Inlining is actually controlled by a number of parameters, which may be
7632 specified individually by using @option{--param @var{name}=@var{value}}.
7633 The @option{-finline-limit=@var{n}} option sets some of these parameters
7634 as follows:
7636 @table @gcctabopt
7637 @item max-inline-insns-single
7638 is set to @var{n}/2.
7639 @item max-inline-insns-auto
7640 is set to @var{n}/2.
7641 @end table
7643 See below for a documentation of the individual
7644 parameters controlling inlining and for the defaults of these parameters.
7646 @emph{Note:} there may be no value to @option{-finline-limit} that results
7647 in default behavior.
7649 @emph{Note:} pseudo instruction represents, in this particular context, an
7650 abstract measurement of function's size.  In no way does it represent a count
7651 of assembly instructions and as such its exact meaning might change from one
7652 release to an another.
7654 @item -fno-keep-inline-dllexport
7655 @opindex fno-keep-inline-dllexport
7656 This is a more fine-grained version of @option{-fkeep-inline-functions},
7657 which applies only to functions that are declared using the @code{dllexport}
7658 attribute or declspec.  @xref{Function Attributes,,Declaring Attributes of
7659 Functions}.
7661 @item -fkeep-inline-functions
7662 @opindex fkeep-inline-functions
7663 In C, emit @code{static} functions that are declared @code{inline}
7664 into the object file, even if the function has been inlined into all
7665 of its callers.  This switch does not affect functions using the
7666 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
7667 inline functions into the object file.
7669 @item -fkeep-static-functions
7670 @opindex fkeep-static-functions
7671 Emit @code{static} functions into the object file, even if the function
7672 is never used.
7674 @item -fkeep-static-consts
7675 @opindex fkeep-static-consts
7676 Emit variables declared @code{static const} when optimization isn't turned
7677 on, even if the variables aren't referenced.
7679 GCC enables this option by default.  If you want to force the compiler to
7680 check if a variable is referenced, regardless of whether or not
7681 optimization is turned on, use the @option{-fno-keep-static-consts} option.
7683 @item -fmerge-constants
7684 @opindex fmerge-constants
7685 Attempt to merge identical constants (string constants and floating-point
7686 constants) across compilation units.
7688 This option is the default for optimized compilation if the assembler and
7689 linker support it.  Use @option{-fno-merge-constants} to inhibit this
7690 behavior.
7692 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7694 @item -fmerge-all-constants
7695 @opindex fmerge-all-constants
7696 Attempt to merge identical constants and identical variables.
7698 This option implies @option{-fmerge-constants}.  In addition to
7699 @option{-fmerge-constants} this considers e.g.@: even constant initialized
7700 arrays or initialized constant variables with integral or floating-point
7701 types.  Languages like C or C++ require each variable, including multiple
7702 instances of the same variable in recursive calls, to have distinct locations,
7703 so using this option results in non-conforming
7704 behavior.
7706 @item -fmodulo-sched
7707 @opindex fmodulo-sched
7708 Perform swing modulo scheduling immediately before the first scheduling
7709 pass.  This pass looks at innermost loops and reorders their
7710 instructions by overlapping different iterations.
7712 @item -fmodulo-sched-allow-regmoves
7713 @opindex fmodulo-sched-allow-regmoves
7714 Perform more aggressive SMS-based modulo scheduling with register moves
7715 allowed.  By setting this flag certain anti-dependences edges are
7716 deleted, which triggers the generation of reg-moves based on the
7717 life-range analysis.  This option is effective only with
7718 @option{-fmodulo-sched} enabled.
7720 @item -fno-branch-count-reg
7721 @opindex fno-branch-count-reg
7722 Avoid running a pass scanning for opportunities to use ``decrement and
7723 branch'' instructions on a count register instead of generating sequences
7724 of instructions that decrement a register, compare it against zero, and
7725 then branch based upon the result.  This option is only meaningful on
7726 architectures that support such instructions, which include x86, PowerPC,
7727 IA-64 and S/390.  Note that the @option{-fno-branch-count-reg} option
7728 doesn't remove the decrement and branch instructions from the generated
7729 instruction stream introduced by other optimization passes.
7731 Enabled by default at @option{-O1} and higher.
7733 The default is @option{-fbranch-count-reg}.
7735 @item -fno-function-cse
7736 @opindex fno-function-cse
7737 Do not put function addresses in registers; make each instruction that
7738 calls a constant function contain the function's address explicitly.
7740 This option results in less efficient code, but some strange hacks
7741 that alter the assembler output may be confused by the optimizations
7742 performed when this option is not used.
7744 The default is @option{-ffunction-cse}
7746 @item -fno-zero-initialized-in-bss
7747 @opindex fno-zero-initialized-in-bss
7748 If the target supports a BSS section, GCC by default puts variables that
7749 are initialized to zero into BSS@.  This can save space in the resulting
7750 code.
7752 This option turns off this behavior because some programs explicitly
7753 rely on variables going to the data section---e.g., so that the
7754 resulting executable can find the beginning of that section and/or make
7755 assumptions based on that.
7757 The default is @option{-fzero-initialized-in-bss}.
7759 @item -fthread-jumps
7760 @opindex fthread-jumps
7761 Perform optimizations that check to see if a jump branches to a
7762 location where another comparison subsumed by the first is found.  If
7763 so, the first branch is redirected to either the destination of the
7764 second branch or a point immediately following it, depending on whether
7765 the condition is known to be true or false.
7767 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7769 @item -fsplit-wide-types
7770 @opindex fsplit-wide-types
7771 When using a type that occupies multiple registers, such as @code{long
7772 long} on a 32-bit system, split the registers apart and allocate them
7773 independently.  This normally generates better code for those types,
7774 but may make debugging more difficult.
7776 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
7777 @option{-Os}.
7779 @item -fcse-follow-jumps
7780 @opindex fcse-follow-jumps
7781 In common subexpression elimination (CSE), scan through jump instructions
7782 when the target of the jump is not reached by any other path.  For
7783 example, when CSE encounters an @code{if} statement with an
7784 @code{else} clause, CSE follows the jump when the condition
7785 tested is false.
7787 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7789 @item -fcse-skip-blocks
7790 @opindex fcse-skip-blocks
7791 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
7792 follow jumps that conditionally skip over blocks.  When CSE
7793 encounters a simple @code{if} statement with no else clause,
7794 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
7795 body of the @code{if}.
7797 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7799 @item -frerun-cse-after-loop
7800 @opindex frerun-cse-after-loop
7801 Re-run common subexpression elimination after loop optimizations are
7802 performed.
7804 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7806 @item -fgcse
7807 @opindex fgcse
7808 Perform a global common subexpression elimination pass.
7809 This pass also performs global constant and copy propagation.
7811 @emph{Note:} When compiling a program using computed gotos, a GCC
7812 extension, you may get better run-time performance if you disable
7813 the global common subexpression elimination pass by adding
7814 @option{-fno-gcse} to the command line.
7816 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7818 @item -fgcse-lm
7819 @opindex fgcse-lm
7820 When @option{-fgcse-lm} is enabled, global common subexpression elimination
7821 attempts to move loads that are only killed by stores into themselves.  This
7822 allows a loop containing a load/store sequence to be changed to a load outside
7823 the loop, and a copy/store within the loop.
7825 Enabled by default when @option{-fgcse} is enabled.
7827 @item -fgcse-sm
7828 @opindex fgcse-sm
7829 When @option{-fgcse-sm} is enabled, a store motion pass is run after
7830 global common subexpression elimination.  This pass attempts to move
7831 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
7832 loops containing a load/store sequence can be changed to a load before
7833 the loop and a store after the loop.
7835 Not enabled at any optimization level.
7837 @item -fgcse-las
7838 @opindex fgcse-las
7839 When @option{-fgcse-las} is enabled, the global common subexpression
7840 elimination pass eliminates redundant loads that come after stores to the
7841 same memory location (both partial and full redundancies).
7843 Not enabled at any optimization level.
7845 @item -fgcse-after-reload
7846 @opindex fgcse-after-reload
7847 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
7848 pass is performed after reload.  The purpose of this pass is to clean up
7849 redundant spilling.
7851 @item -faggressive-loop-optimizations
7852 @opindex faggressive-loop-optimizations
7853 This option tells the loop optimizer to use language constraints to
7854 derive bounds for the number of iterations of a loop.  This assumes that
7855 loop code does not invoke undefined behavior by for example causing signed
7856 integer overflows or out-of-bound array accesses.  The bounds for the
7857 number of iterations of a loop are used to guide loop unrolling and peeling
7858 and loop exit test optimizations.
7859 This option is enabled by default.
7861 @item -funconstrained-commons
7862 @opindex funconstrained-commons
7863 This option tells the compiler that variables declared in common blocks
7864 (e.g. Fortran) may later be overridden with longer trailing arrays. This
7865 prevents certain optimizations that depend on knowing the array bounds.
7867 @item -fcrossjumping
7868 @opindex fcrossjumping
7869 Perform cross-jumping transformation.
7870 This transformation unifies equivalent code and saves code size.  The
7871 resulting code may or may not perform better than without cross-jumping.
7873 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7875 @item -fauto-inc-dec
7876 @opindex fauto-inc-dec
7877 Combine increments or decrements of addresses with memory accesses.
7878 This pass is always skipped on architectures that do not have
7879 instructions to support this.  Enabled by default at @option{-O} and
7880 higher on architectures that support this.
7882 @item -fdce
7883 @opindex fdce
7884 Perform dead code elimination (DCE) on RTL@.
7885 Enabled by default at @option{-O} and higher.
7887 @item -fdse
7888 @opindex fdse
7889 Perform dead store elimination (DSE) on RTL@.
7890 Enabled by default at @option{-O} and higher.
7892 @item -fif-conversion
7893 @opindex fif-conversion
7894 Attempt to transform conditional jumps into branch-less equivalents.  This
7895 includes use of conditional moves, min, max, set flags and abs instructions, and
7896 some tricks doable by standard arithmetics.  The use of conditional execution
7897 on chips where it is available is controlled by @option{-fif-conversion2}.
7899 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7901 @item -fif-conversion2
7902 @opindex fif-conversion2
7903 Use conditional execution (where available) to transform conditional jumps into
7904 branch-less equivalents.
7906 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7908 @item -fdeclone-ctor-dtor
7909 @opindex fdeclone-ctor-dtor
7910 The C++ ABI requires multiple entry points for constructors and
7911 destructors: one for a base subobject, one for a complete object, and
7912 one for a virtual destructor that calls operator delete afterwards.
7913 For a hierarchy with virtual bases, the base and complete variants are
7914 clones, which means two copies of the function.  With this option, the
7915 base and complete variants are changed to be thunks that call a common
7916 implementation.
7918 Enabled by @option{-Os}.
7920 @item -fdelete-null-pointer-checks
7921 @opindex fdelete-null-pointer-checks
7922 Assume that programs cannot safely dereference null pointers, and that
7923 no code or data element resides at address zero.
7924 This option enables simple constant
7925 folding optimizations at all optimization levels.  In addition, other
7926 optimization passes in GCC use this flag to control global dataflow
7927 analyses that eliminate useless checks for null pointers; these assume
7928 that a memory access to address zero always results in a trap, so
7929 that if a pointer is checked after it has already been dereferenced,
7930 it cannot be null.
7932 Note however that in some environments this assumption is not true.
7933 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
7934 for programs that depend on that behavior.
7936 This option is enabled by default on most targets.  On Nios II ELF, it
7937 defaults to off.  On AVR, CR16, and MSP430, this option is completely disabled.
7939 Passes that use the dataflow information
7940 are enabled independently at different optimization levels.
7942 @item -fdevirtualize
7943 @opindex fdevirtualize
7944 Attempt to convert calls to virtual functions to direct calls.  This
7945 is done both within a procedure and interprocedurally as part of
7946 indirect inlining (@option{-findirect-inlining}) and interprocedural constant
7947 propagation (@option{-fipa-cp}).
7948 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7950 @item -fdevirtualize-speculatively
7951 @opindex fdevirtualize-speculatively
7952 Attempt to convert calls to virtual functions to speculative direct calls.
7953 Based on the analysis of the type inheritance graph, determine for a given call
7954 the set of likely targets. If the set is small, preferably of size 1, change
7955 the call into a conditional deciding between direct and indirect calls.  The
7956 speculative calls enable more optimizations, such as inlining.  When they seem
7957 useless after further optimization, they are converted back into original form.
7959 @item -fdevirtualize-at-ltrans
7960 @opindex fdevirtualize-at-ltrans
7961 Stream extra information needed for aggressive devirtualization when running
7962 the link-time optimizer in local transformation mode.  
7963 This option enables more devirtualization but
7964 significantly increases the size of streamed data. For this reason it is
7965 disabled by default.
7967 @item -fexpensive-optimizations
7968 @opindex fexpensive-optimizations
7969 Perform a number of minor optimizations that are relatively expensive.
7971 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7973 @item -free
7974 @opindex free
7975 Attempt to remove redundant extension instructions.  This is especially
7976 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
7977 registers after writing to their lower 32-bit half.
7979 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
7980 @option{-O3}, @option{-Os}.
7982 @item -fno-lifetime-dse
7983 @opindex fno-lifetime-dse
7984 In C++ the value of an object is only affected by changes within its
7985 lifetime: when the constructor begins, the object has an indeterminate
7986 value, and any changes during the lifetime of the object are dead when
7987 the object is destroyed.  Normally dead store elimination will take
7988 advantage of this; if your code relies on the value of the object
7989 storage persisting beyond the lifetime of the object, you can use this
7990 flag to disable this optimization.  To preserve stores before the
7991 constructor starts (e.g. because your operator new clears the object
7992 storage) but still treat the object as dead after the destructor you,
7993 can use @option{-flifetime-dse=1}.  The default behavior can be
7994 explicitly selected with @option{-flifetime-dse=2}.
7995 @option{-flifetime-dse=0} is equivalent to @option{-fno-lifetime-dse}.
7997 @item -flive-range-shrinkage
7998 @opindex flive-range-shrinkage
7999 Attempt to decrease register pressure through register live range
8000 shrinkage.  This is helpful for fast processors with small or moderate
8001 size register sets.
8003 @item -fira-algorithm=@var{algorithm}
8004 @opindex fira-algorithm
8005 Use the specified coloring algorithm for the integrated register
8006 allocator.  The @var{algorithm} argument can be @samp{priority}, which
8007 specifies Chow's priority coloring, or @samp{CB}, which specifies
8008 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
8009 for all architectures, but for those targets that do support it, it is
8010 the default because it generates better code.
8012 @item -fira-region=@var{region}
8013 @opindex fira-region
8014 Use specified regions for the integrated register allocator.  The
8015 @var{region} argument should be one of the following:
8017 @table @samp
8019 @item all
8020 Use all loops as register allocation regions.
8021 This can give the best results for machines with a small and/or
8022 irregular register set.
8024 @item mixed
8025 Use all loops except for loops with small register pressure 
8026 as the regions.  This value usually gives
8027 the best results in most cases and for most architectures,
8028 and is enabled by default when compiling with optimization for speed
8029 (@option{-O}, @option{-O2}, @dots{}).
8031 @item one
8032 Use all functions as a single region.  
8033 This typically results in the smallest code size, and is enabled by default for
8034 @option{-Os} or @option{-O0}.
8036 @end table
8038 @item -fira-hoist-pressure
8039 @opindex fira-hoist-pressure
8040 Use IRA to evaluate register pressure in the code hoisting pass for
8041 decisions to hoist expressions.  This option usually results in smaller
8042 code, but it can slow the compiler down.
8044 This option is enabled at level @option{-Os} for all targets.
8046 @item -fira-loop-pressure
8047 @opindex fira-loop-pressure
8048 Use IRA to evaluate register pressure in loops for decisions to move
8049 loop invariants.  This option usually results in generation
8050 of faster and smaller code on machines with large register files (>= 32
8051 registers), but it can slow the compiler down.
8053 This option is enabled at level @option{-O3} for some targets.
8055 @item -fno-ira-share-save-slots
8056 @opindex fno-ira-share-save-slots
8057 Disable sharing of stack slots used for saving call-used hard
8058 registers living through a call.  Each hard register gets a
8059 separate stack slot, and as a result function stack frames are
8060 larger.
8062 @item -fno-ira-share-spill-slots
8063 @opindex fno-ira-share-spill-slots
8064 Disable sharing of stack slots allocated for pseudo-registers.  Each
8065 pseudo-register that does not get a hard register gets a separate
8066 stack slot, and as a result function stack frames are larger.
8068 @item -flra-remat
8069 @opindex flra-remat
8070 Enable CFG-sensitive rematerialization in LRA.  Instead of loading
8071 values of spilled pseudos, LRA tries to rematerialize (recalculate)
8072 values if it is profitable.
8074 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8076 @item -fdelayed-branch
8077 @opindex fdelayed-branch
8078 If supported for the target machine, attempt to reorder instructions
8079 to exploit instruction slots available after delayed branch
8080 instructions.
8082 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8084 @item -fschedule-insns
8085 @opindex fschedule-insns
8086 If supported for the target machine, attempt to reorder instructions to
8087 eliminate execution stalls due to required data being unavailable.  This
8088 helps machines that have slow floating point or memory load instructions
8089 by allowing other instructions to be issued until the result of the load
8090 or floating-point instruction is required.
8092 Enabled at levels @option{-O2}, @option{-O3}.
8094 @item -fschedule-insns2
8095 @opindex fschedule-insns2
8096 Similar to @option{-fschedule-insns}, but requests an additional pass of
8097 instruction scheduling after register allocation has been done.  This is
8098 especially useful on machines with a relatively small number of
8099 registers and where memory load instructions take more than one cycle.
8101 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8103 @item -fno-sched-interblock
8104 @opindex fno-sched-interblock
8105 Don't schedule instructions across basic blocks.  This is normally
8106 enabled by default when scheduling before register allocation, i.e.@:
8107 with @option{-fschedule-insns} or at @option{-O2} or higher.
8109 @item -fno-sched-spec
8110 @opindex fno-sched-spec
8111 Don't allow speculative motion of non-load instructions.  This is normally
8112 enabled by default when scheduling before register allocation, i.e.@:
8113 with @option{-fschedule-insns} or at @option{-O2} or higher.
8115 @item -fsched-pressure
8116 @opindex fsched-pressure
8117 Enable register pressure sensitive insn scheduling before register
8118 allocation.  This only makes sense when scheduling before register
8119 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
8120 @option{-O2} or higher.  Usage of this option can improve the
8121 generated code and decrease its size by preventing register pressure
8122 increase above the number of available hard registers and subsequent
8123 spills in register allocation.
8125 @item -fsched-spec-load
8126 @opindex fsched-spec-load
8127 Allow speculative motion of some load instructions.  This only makes
8128 sense when scheduling before register allocation, i.e.@: with
8129 @option{-fschedule-insns} or at @option{-O2} or higher.
8131 @item -fsched-spec-load-dangerous
8132 @opindex fsched-spec-load-dangerous
8133 Allow speculative motion of more load instructions.  This only makes
8134 sense when scheduling before register allocation, i.e.@: with
8135 @option{-fschedule-insns} or at @option{-O2} or higher.
8137 @item -fsched-stalled-insns
8138 @itemx -fsched-stalled-insns=@var{n}
8139 @opindex fsched-stalled-insns
8140 Define how many insns (if any) can be moved prematurely from the queue
8141 of stalled insns into the ready list during the second scheduling pass.
8142 @option{-fno-sched-stalled-insns} means that no insns are moved
8143 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
8144 on how many queued insns can be moved prematurely.
8145 @option{-fsched-stalled-insns} without a value is equivalent to
8146 @option{-fsched-stalled-insns=1}.
8148 @item -fsched-stalled-insns-dep
8149 @itemx -fsched-stalled-insns-dep=@var{n}
8150 @opindex fsched-stalled-insns-dep
8151 Define how many insn groups (cycles) are examined for a dependency
8152 on a stalled insn that is a candidate for premature removal from the queue
8153 of stalled insns.  This has an effect only during the second scheduling pass,
8154 and only if @option{-fsched-stalled-insns} is used.
8155 @option{-fno-sched-stalled-insns-dep} is equivalent to
8156 @option{-fsched-stalled-insns-dep=0}.
8157 @option{-fsched-stalled-insns-dep} without a value is equivalent to
8158 @option{-fsched-stalled-insns-dep=1}.
8160 @item -fsched2-use-superblocks
8161 @opindex fsched2-use-superblocks
8162 When scheduling after register allocation, use superblock scheduling.
8163 This allows motion across basic block boundaries,
8164 resulting in faster schedules.  This option is experimental, as not all machine
8165 descriptions used by GCC model the CPU closely enough to avoid unreliable
8166 results from the algorithm.
8168 This only makes sense when scheduling after register allocation, i.e.@: with
8169 @option{-fschedule-insns2} or at @option{-O2} or higher.
8171 @item -fsched-group-heuristic
8172 @opindex fsched-group-heuristic
8173 Enable the group heuristic in the scheduler.  This heuristic favors
8174 the instruction that belongs to a schedule group.  This is enabled
8175 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8176 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8178 @item -fsched-critical-path-heuristic
8179 @opindex fsched-critical-path-heuristic
8180 Enable the critical-path heuristic in the scheduler.  This heuristic favors
8181 instructions on the critical path.  This is enabled by default when
8182 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8183 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8185 @item -fsched-spec-insn-heuristic
8186 @opindex fsched-spec-insn-heuristic
8187 Enable the speculative instruction heuristic in the scheduler.  This
8188 heuristic favors speculative instructions with greater dependency weakness.
8189 This is enabled by default when scheduling is enabled, i.e.@:
8190 with @option{-fschedule-insns} or @option{-fschedule-insns2}
8191 or at @option{-O2} or higher.
8193 @item -fsched-rank-heuristic
8194 @opindex fsched-rank-heuristic
8195 Enable the rank heuristic in the scheduler.  This heuristic favors
8196 the instruction belonging to a basic block with greater size or frequency.
8197 This is enabled by default when scheduling is enabled, i.e.@:
8198 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8199 at @option{-O2} or higher.
8201 @item -fsched-last-insn-heuristic
8202 @opindex fsched-last-insn-heuristic
8203 Enable the last-instruction heuristic in the scheduler.  This heuristic
8204 favors the instruction that is less dependent on the last instruction
8205 scheduled.  This is enabled by default when scheduling is enabled,
8206 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8207 at @option{-O2} or higher.
8209 @item -fsched-dep-count-heuristic
8210 @opindex fsched-dep-count-heuristic
8211 Enable the dependent-count heuristic in the scheduler.  This heuristic
8212 favors the instruction that has more instructions depending on it.
8213 This is enabled by default when scheduling is enabled, i.e.@:
8214 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8215 at @option{-O2} or higher.
8217 @item -freschedule-modulo-scheduled-loops
8218 @opindex freschedule-modulo-scheduled-loops
8219 Modulo scheduling is performed before traditional scheduling.  If a loop
8220 is modulo scheduled, later scheduling passes may change its schedule.  
8221 Use this option to control that behavior.
8223 @item -fselective-scheduling
8224 @opindex fselective-scheduling
8225 Schedule instructions using selective scheduling algorithm.  Selective
8226 scheduling runs instead of the first scheduler pass.
8228 @item -fselective-scheduling2
8229 @opindex fselective-scheduling2
8230 Schedule instructions using selective scheduling algorithm.  Selective
8231 scheduling runs instead of the second scheduler pass.
8233 @item -fsel-sched-pipelining
8234 @opindex fsel-sched-pipelining
8235 Enable software pipelining of innermost loops during selective scheduling.
8236 This option has no effect unless one of @option{-fselective-scheduling} or
8237 @option{-fselective-scheduling2} is turned on.
8239 @item -fsel-sched-pipelining-outer-loops
8240 @opindex fsel-sched-pipelining-outer-loops
8241 When pipelining loops during selective scheduling, also pipeline outer loops.
8242 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
8244 @item -fsemantic-interposition
8245 @opindex fsemantic-interposition
8246 Some object formats, like ELF, allow interposing of symbols by the 
8247 dynamic linker.
8248 This means that for symbols exported from the DSO, the compiler cannot perform
8249 interprocedural propagation, inlining and other optimizations in anticipation
8250 that the function or variable in question may change. While this feature is
8251 useful, for example, to rewrite memory allocation functions by a debugging
8252 implementation, it is expensive in the terms of code quality.
8253 With @option{-fno-semantic-interposition} the compiler assumes that 
8254 if interposition happens for functions the overwriting function will have 
8255 precisely the same semantics (and side effects). 
8256 Similarly if interposition happens
8257 for variables, the constructor of the variable will be the same. The flag
8258 has no effect for functions explicitly declared inline 
8259 (where it is never allowed for interposition to change semantics) 
8260 and for symbols explicitly declared weak.
8262 @item -fshrink-wrap
8263 @opindex fshrink-wrap
8264 Emit function prologues only before parts of the function that need it,
8265 rather than at the top of the function.  This flag is enabled by default at
8266 @option{-O} and higher.
8268 @item -fshrink-wrap-separate
8269 @opindex fshrink-wrap-separate
8270 Shrink-wrap separate parts of the prologue and epilogue separately, so that
8271 those parts are only executed when needed.
8272 This option is on by default, but has no effect unless @option{-fshrink-wrap}
8273 is also turned on and the target supports this.
8275 @item -fcaller-saves
8276 @opindex fcaller-saves
8277 Enable allocation of values to registers that are clobbered by
8278 function calls, by emitting extra instructions to save and restore the
8279 registers around such calls.  Such allocation is done only when it
8280 seems to result in better code.
8282 This option is always enabled by default on certain machines, usually
8283 those which have no call-preserved registers to use instead.
8285 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8287 @item -fcombine-stack-adjustments
8288 @opindex fcombine-stack-adjustments
8289 Tracks stack adjustments (pushes and pops) and stack memory references
8290 and then tries to find ways to combine them.
8292 Enabled by default at @option{-O1} and higher.
8294 @item -fipa-ra
8295 @opindex fipa-ra
8296 Use caller save registers for allocation if those registers are not used by
8297 any called function.  In that case it is not necessary to save and restore
8298 them around calls.  This is only possible if called functions are part of
8299 same compilation unit as current function and they are compiled before it.
8301 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}, however the option
8302 is disabled if generated code will be instrumented for profiling
8303 (@option{-p}, or @option{-pg}) or if callee's register usage cannot be known
8304 exactly (this happens on targets that do not expose prologues
8305 and epilogues in RTL).
8307 @item -fconserve-stack
8308 @opindex fconserve-stack
8309 Attempt to minimize stack usage.  The compiler attempts to use less
8310 stack space, even if that makes the program slower.  This option
8311 implies setting the @option{large-stack-frame} parameter to 100
8312 and the @option{large-stack-frame-growth} parameter to 400.
8314 @item -ftree-reassoc
8315 @opindex ftree-reassoc
8316 Perform reassociation on trees.  This flag is enabled by default
8317 at @option{-O} and higher.
8319 @item -fcode-hoisting
8320 @opindex fcode-hoisting
8321 Perform code hoisting.  Code hoisting tries to move the
8322 evaluation of expressions executed on all paths to the function exit
8323 as early as possible.  This is especially useful as a code size
8324 optimization, but it often helps for code speed as well.
8325 This flag is enabled by default at @option{-O2} and higher.
8327 @item -ftree-pre
8328 @opindex ftree-pre
8329 Perform partial redundancy elimination (PRE) on trees.  This flag is
8330 enabled by default at @option{-O2} and @option{-O3}.
8332 @item -ftree-partial-pre
8333 @opindex ftree-partial-pre
8334 Make partial redundancy elimination (PRE) more aggressive.  This flag is
8335 enabled by default at @option{-O3}.
8337 @item -ftree-forwprop
8338 @opindex ftree-forwprop
8339 Perform forward propagation on trees.  This flag is enabled by default
8340 at @option{-O} and higher.
8342 @item -ftree-fre
8343 @opindex ftree-fre
8344 Perform full redundancy elimination (FRE) on trees.  The difference
8345 between FRE and PRE is that FRE only considers expressions
8346 that are computed on all paths leading to the redundant computation.
8347 This analysis is faster than PRE, though it exposes fewer redundancies.
8348 This flag is enabled by default at @option{-O} and higher.
8350 @item -ftree-phiprop
8351 @opindex ftree-phiprop
8352 Perform hoisting of loads from conditional pointers on trees.  This
8353 pass is enabled by default at @option{-O} and higher.
8355 @item -fhoist-adjacent-loads
8356 @opindex fhoist-adjacent-loads
8357 Speculatively hoist loads from both branches of an if-then-else if the
8358 loads are from adjacent locations in the same structure and the target
8359 architecture has a conditional move instruction.  This flag is enabled
8360 by default at @option{-O2} and higher.
8362 @item -ftree-copy-prop
8363 @opindex ftree-copy-prop
8364 Perform copy propagation on trees.  This pass eliminates unnecessary
8365 copy operations.  This flag is enabled by default at @option{-O} and
8366 higher.
8368 @item -fipa-pure-const
8369 @opindex fipa-pure-const
8370 Discover which functions are pure or constant.
8371 Enabled by default at @option{-O} and higher.
8373 @item -fipa-reference
8374 @opindex fipa-reference
8375 Discover which static variables do not escape the
8376 compilation unit.
8377 Enabled by default at @option{-O} and higher.
8379 @item -fipa-pta
8380 @opindex fipa-pta
8381 Perform interprocedural pointer analysis and interprocedural modification
8382 and reference analysis.  This option can cause excessive memory and
8383 compile-time usage on large compilation units.  It is not enabled by
8384 default at any optimization level.
8386 @item -fipa-profile
8387 @opindex fipa-profile
8388 Perform interprocedural profile propagation.  The functions called only from
8389 cold functions are marked as cold. Also functions executed once (such as
8390 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
8391 functions and loop less parts of functions executed once are then optimized for
8392 size.
8393 Enabled by default at @option{-O} and higher.
8395 @item -fipa-cp
8396 @opindex fipa-cp
8397 Perform interprocedural constant propagation.
8398 This optimization analyzes the program to determine when values passed
8399 to functions are constants and then optimizes accordingly.
8400 This optimization can substantially increase performance
8401 if the application has constants passed to functions.
8402 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
8404 @item -fipa-cp-clone
8405 @opindex fipa-cp-clone
8406 Perform function cloning to make interprocedural constant propagation stronger.
8407 When enabled, interprocedural constant propagation performs function cloning
8408 when externally visible function can be called with constant arguments.
8409 Because this optimization can create multiple copies of functions,
8410 it may significantly increase code size
8411 (see @option{--param ipcp-unit-growth=@var{value}}).
8412 This flag is enabled by default at @option{-O3}.
8414 @item -fipa-bit-cp
8415 @opindex -fipa-bit-cp
8416 When enabled, perform interprocedural bitwise constant
8417 propagation. This flag is enabled by default at @option{-O2}. It
8418 requires that @option{-fipa-cp} is enabled.
8420 @item -fipa-vrp
8421 @opindex -fipa-vrp
8422 When enabled, perform interprocedural propagation of value
8423 ranges. This flag is enabled by default at @option{-O2}. It requires
8424 that @option{-fipa-cp} is enabled.
8426 @item -fipa-icf
8427 @opindex fipa-icf
8428 Perform Identical Code Folding for functions and read-only variables.
8429 The optimization reduces code size and may disturb unwind stacks by replacing
8430 a function by equivalent one with a different name. The optimization works
8431 more effectively with link-time optimization enabled.
8433 Nevertheless the behavior is similar to Gold Linker ICF optimization, GCC ICF
8434 works on different levels and thus the optimizations are not same - there are
8435 equivalences that are found only by GCC and equivalences found only by Gold.
8437 This flag is enabled by default at @option{-O2} and @option{-Os}.
8439 @item -fisolate-erroneous-paths-dereference
8440 @opindex fisolate-erroneous-paths-dereference
8441 Detect paths that trigger erroneous or undefined behavior due to
8442 dereferencing a null pointer.  Isolate those paths from the main control
8443 flow and turn the statement with erroneous or undefined behavior into a trap.
8444 This flag is enabled by default at @option{-O2} and higher and depends on
8445 @option{-fdelete-null-pointer-checks} also being enabled.
8447 @item -fisolate-erroneous-paths-attribute
8448 @opindex fisolate-erroneous-paths-attribute
8449 Detect paths that trigger erroneous or undefined behavior due a null value
8450 being used in a way forbidden by a @code{returns_nonnull} or @code{nonnull}
8451 attribute.  Isolate those paths from the main control flow and turn the
8452 statement with erroneous or undefined behavior into a trap.  This is not
8453 currently enabled, but may be enabled by @option{-O2} in the future.
8455 @item -ftree-sink
8456 @opindex ftree-sink
8457 Perform forward store motion on trees.  This flag is
8458 enabled by default at @option{-O} and higher.
8460 @item -ftree-bit-ccp
8461 @opindex ftree-bit-ccp
8462 Perform sparse conditional bit constant propagation on trees and propagate
8463 pointer alignment information.
8464 This pass only operates on local scalar variables and is enabled by default
8465 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
8467 @item -ftree-ccp
8468 @opindex ftree-ccp
8469 Perform sparse conditional constant propagation (CCP) on trees.  This
8470 pass only operates on local scalar variables and is enabled by default
8471 at @option{-O} and higher.
8473 @item -fssa-backprop
8474 @opindex fssa-backprop
8475 Propagate information about uses of a value up the definition chain
8476 in order to simplify the definitions.  For example, this pass strips
8477 sign operations if the sign of a value never matters.  The flag is
8478 enabled by default at @option{-O} and higher.
8480 @item -fssa-phiopt
8481 @opindex fssa-phiopt
8482 Perform pattern matching on SSA PHI nodes to optimize conditional
8483 code.  This pass is enabled by default at @option{-O} and higher.
8485 @item -ftree-switch-conversion
8486 @opindex ftree-switch-conversion
8487 Perform conversion of simple initializations in a switch to
8488 initializations from a scalar array.  This flag is enabled by default
8489 at @option{-O2} and higher.
8491 @item -ftree-tail-merge
8492 @opindex ftree-tail-merge
8493 Look for identical code sequences.  When found, replace one with a jump to the
8494 other.  This optimization is known as tail merging or cross jumping.  This flag
8495 is enabled by default at @option{-O2} and higher.  The compilation time
8496 in this pass can
8497 be limited using @option{max-tail-merge-comparisons} parameter and
8498 @option{max-tail-merge-iterations} parameter.
8500 @item -ftree-dce
8501 @opindex ftree-dce
8502 Perform dead code elimination (DCE) on trees.  This flag is enabled by
8503 default at @option{-O} and higher.
8505 @item -ftree-builtin-call-dce
8506 @opindex ftree-builtin-call-dce
8507 Perform conditional dead code elimination (DCE) for calls to built-in functions
8508 that may set @code{errno} but are otherwise side-effect free.  This flag is
8509 enabled by default at @option{-O2} and higher if @option{-Os} is not also
8510 specified.
8512 @item -ftree-dominator-opts
8513 @opindex ftree-dominator-opts
8514 Perform a variety of simple scalar cleanups (constant/copy
8515 propagation, redundancy elimination, range propagation and expression
8516 simplification) based on a dominator tree traversal.  This also
8517 performs jump threading (to reduce jumps to jumps). This flag is
8518 enabled by default at @option{-O} and higher.
8520 @item -ftree-dse
8521 @opindex ftree-dse
8522 Perform dead store elimination (DSE) on trees.  A dead store is a store into
8523 a memory location that is later overwritten by another store without
8524 any intervening loads.  In this case the earlier store can be deleted.  This
8525 flag is enabled by default at @option{-O} and higher.
8527 @item -ftree-ch
8528 @opindex ftree-ch
8529 Perform loop header copying on trees.  This is beneficial since it increases
8530 effectiveness of code motion optimizations.  It also saves one jump.  This flag
8531 is enabled by default at @option{-O} and higher.  It is not enabled
8532 for @option{-Os}, since it usually increases code size.
8534 @item -ftree-loop-optimize
8535 @opindex ftree-loop-optimize
8536 Perform loop optimizations on trees.  This flag is enabled by default
8537 at @option{-O} and higher.
8539 @item -ftree-loop-linear
8540 @itemx -floop-strip-mine
8541 @itemx -floop-block
8542 @opindex ftree-loop-linear
8543 @opindex floop-strip-mine
8544 @opindex floop-block
8545 Perform loop nest optimizations.  Same as
8546 @option{-floop-nest-optimize}.  To use this code transformation, GCC has
8547 to be configured with @option{--with-isl} to enable the Graphite loop
8548 transformation infrastructure.
8550 @item -fgraphite-identity
8551 @opindex fgraphite-identity
8552 Enable the identity transformation for graphite.  For every SCoP we generate
8553 the polyhedral representation and transform it back to gimple.  Using
8554 @option{-fgraphite-identity} we can check the costs or benefits of the
8555 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
8556 are also performed by the code generator isl, like index splitting and
8557 dead code elimination in loops.
8559 @item -floop-nest-optimize
8560 @opindex floop-nest-optimize
8561 Enable the isl based loop nest optimizer.  This is a generic loop nest
8562 optimizer based on the Pluto optimization algorithms.  It calculates a loop
8563 structure optimized for data-locality and parallelism.  This option
8564 is experimental.
8566 @item -floop-parallelize-all
8567 @opindex floop-parallelize-all
8568 Use the Graphite data dependence analysis to identify loops that can
8569 be parallelized.  Parallelize all the loops that can be analyzed to
8570 not contain loop carried dependences without checking that it is
8571 profitable to parallelize the loops.
8573 @item -ftree-coalesce-vars
8574 @opindex ftree-coalesce-vars
8575 While transforming the program out of the SSA representation, attempt to
8576 reduce copying by coalescing versions of different user-defined
8577 variables, instead of just compiler temporaries.  This may severely
8578 limit the ability to debug an optimized program compiled with
8579 @option{-fno-var-tracking-assignments}.  In the negated form, this flag
8580 prevents SSA coalescing of user variables.  This option is enabled by
8581 default if optimization is enabled, and it does very little otherwise.
8583 @item -ftree-loop-if-convert
8584 @opindex ftree-loop-if-convert
8585 Attempt to transform conditional jumps in the innermost loops to
8586 branch-less equivalents.  The intent is to remove control-flow from
8587 the innermost loops in order to improve the ability of the
8588 vectorization pass to handle these loops.  This is enabled by default
8589 if vectorization is enabled.
8591 @item -ftree-loop-distribution
8592 @opindex ftree-loop-distribution
8593 Perform loop distribution.  This flag can improve cache performance on
8594 big loop bodies and allow further loop optimizations, like
8595 parallelization or vectorization, to take place.  For example, the loop
8596 @smallexample
8597 DO I = 1, N
8598   A(I) = B(I) + C
8599   D(I) = E(I) * F
8600 ENDDO
8601 @end smallexample
8602 is transformed to
8603 @smallexample
8604 DO I = 1, N
8605    A(I) = B(I) + C
8606 ENDDO
8607 DO I = 1, N
8608    D(I) = E(I) * F
8609 ENDDO
8610 @end smallexample
8612 @item -ftree-loop-distribute-patterns
8613 @opindex ftree-loop-distribute-patterns
8614 Perform loop distribution of patterns that can be code generated with
8615 calls to a library.  This flag is enabled by default at @option{-O3}.
8617 This pass distributes the initialization loops and generates a call to
8618 memset zero.  For example, the loop
8619 @smallexample
8620 DO I = 1, N
8621   A(I) = 0
8622   B(I) = A(I) + I
8623 ENDDO
8624 @end smallexample
8625 is transformed to
8626 @smallexample
8627 DO I = 1, N
8628    A(I) = 0
8629 ENDDO
8630 DO I = 1, N
8631    B(I) = A(I) + I
8632 ENDDO
8633 @end smallexample
8634 and the initialization loop is transformed into a call to memset zero.
8636 @item -floop-interchange
8637 @opindex floop-interchange
8638 Perform loop interchange outside of graphite.  This flag can improve cache
8639 performance on loop nest and allow further loop optimizations, like
8640 vectorization, to take place.  For example, the loop
8641 @smallexample
8642 for (int i = 0; i < N; i++)
8643   for (int j = 0; j < N; j++)
8644     for (int k = 0; k < N; k++)
8645       c[i][j] = c[i][j] + a[i][k]*b[k][j];
8646 @end smallexample
8647 is transformed to
8648 @smallexample
8649 for (int i = 0; i < N; i++)
8650   for (int k = 0; k < N; k++)
8651     for (int j = 0; j < N; j++)
8652       c[i][j] = c[i][j] + a[i][k]*b[k][j];
8653 @end smallexample
8655 @item -ftree-loop-im
8656 @opindex ftree-loop-im
8657 Perform loop invariant motion on trees.  This pass moves only invariants that
8658 are hard to handle at RTL level (function calls, operations that expand to
8659 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
8660 operands of conditions that are invariant out of the loop, so that we can use
8661 just trivial invariantness analysis in loop unswitching.  The pass also includes
8662 store motion.
8664 @item -ftree-loop-ivcanon
8665 @opindex ftree-loop-ivcanon
8666 Create a canonical counter for number of iterations in loops for which
8667 determining number of iterations requires complicated analysis.  Later
8668 optimizations then may determine the number easily.  Useful especially
8669 in connection with unrolling.
8671 @item -fivopts
8672 @opindex fivopts
8673 Perform induction variable optimizations (strength reduction, induction
8674 variable merging and induction variable elimination) on trees.
8676 @item -ftree-parallelize-loops=n
8677 @opindex ftree-parallelize-loops
8678 Parallelize loops, i.e., split their iteration space to run in n threads.
8679 This is only possible for loops whose iterations are independent
8680 and can be arbitrarily reordered.  The optimization is only
8681 profitable on multiprocessor machines, for loops that are CPU-intensive,
8682 rather than constrained e.g.@: by memory bandwidth.  This option
8683 implies @option{-pthread}, and thus is only supported on targets
8684 that have support for @option{-pthread}.
8686 @item -ftree-pta
8687 @opindex ftree-pta
8688 Perform function-local points-to analysis on trees.  This flag is
8689 enabled by default at @option{-O} and higher.
8691 @item -ftree-sra
8692 @opindex ftree-sra
8693 Perform scalar replacement of aggregates.  This pass replaces structure
8694 references with scalars to prevent committing structures to memory too
8695 early.  This flag is enabled by default at @option{-O} and higher.
8697 @item -fstore-merging
8698 @opindex fstore-merging
8699 Perform merging of narrow stores to consecutive memory addresses.  This pass
8700 merges contiguous stores of immediate values narrower than a word into fewer
8701 wider stores to reduce the number of instructions.  This is enabled by default
8702 at @option{-O2} and higher as well as @option{-Os}.
8704 @item -ftree-ter
8705 @opindex ftree-ter
8706 Perform temporary expression replacement during the SSA->normal phase.  Single
8707 use/single def temporaries are replaced at their use location with their
8708 defining expression.  This results in non-GIMPLE code, but gives the expanders
8709 much more complex trees to work on resulting in better RTL generation.  This is
8710 enabled by default at @option{-O} and higher.
8712 @item -ftree-slsr
8713 @opindex ftree-slsr
8714 Perform straight-line strength reduction on trees.  This recognizes related
8715 expressions involving multiplications and replaces them by less expensive
8716 calculations when possible.  This is enabled by default at @option{-O} and
8717 higher.
8719 @item -ftree-vectorize
8720 @opindex ftree-vectorize
8721 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
8722 and @option{-ftree-slp-vectorize} if not explicitly specified.
8724 @item -ftree-loop-vectorize
8725 @opindex ftree-loop-vectorize
8726 Perform loop vectorization on trees. This flag is enabled by default at
8727 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8729 @item -ftree-slp-vectorize
8730 @opindex ftree-slp-vectorize
8731 Perform basic block vectorization on trees. This flag is enabled by default at
8732 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8734 @item -fvect-cost-model=@var{model}
8735 @opindex fvect-cost-model
8736 Alter the cost model used for vectorization.  The @var{model} argument
8737 should be one of @samp{unlimited}, @samp{dynamic} or @samp{cheap}.
8738 With the @samp{unlimited} model the vectorized code-path is assumed
8739 to be profitable while with the @samp{dynamic} model a runtime check
8740 guards the vectorized code-path to enable it only for iteration
8741 counts that will likely execute faster than when executing the original
8742 scalar loop.  The @samp{cheap} model disables vectorization of
8743 loops where doing so would be cost prohibitive for example due to
8744 required runtime checks for data dependence or alignment but otherwise
8745 is equal to the @samp{dynamic} model.
8746 The default cost model depends on other optimization flags and is
8747 either @samp{dynamic} or @samp{cheap}.
8749 @item -fsimd-cost-model=@var{model}
8750 @opindex fsimd-cost-model
8751 Alter the cost model used for vectorization of loops marked with the OpenMP
8752 or Cilk Plus simd directive.  The @var{model} argument should be one of
8753 @samp{unlimited}, @samp{dynamic}, @samp{cheap}.  All values of @var{model}
8754 have the same meaning as described in @option{-fvect-cost-model} and by
8755 default a cost model defined with @option{-fvect-cost-model} is used.
8757 @item -ftree-vrp
8758 @opindex ftree-vrp
8759 Perform Value Range Propagation on trees.  This is similar to the
8760 constant propagation pass, but instead of values, ranges of values are
8761 propagated.  This allows the optimizers to remove unnecessary range
8762 checks like array bound checks and null pointer checks.  This is
8763 enabled by default at @option{-O2} and higher.  Null pointer check
8764 elimination is only done if @option{-fdelete-null-pointer-checks} is
8765 enabled.
8767 @item -fsplit-paths
8768 @opindex fsplit-paths
8769 Split paths leading to loop backedges.  This can improve dead code
8770 elimination and common subexpression elimination.  This is enabled by
8771 default at @option{-O2} and above.
8773 @item -fsplit-ivs-in-unroller
8774 @opindex fsplit-ivs-in-unroller
8775 Enables expression of values of induction variables in later iterations
8776 of the unrolled loop using the value in the first iteration.  This breaks
8777 long dependency chains, thus improving efficiency of the scheduling passes.
8779 A combination of @option{-fweb} and CSE is often sufficient to obtain the
8780 same effect.  However, that is not reliable in cases where the loop body
8781 is more complicated than a single basic block.  It also does not work at all
8782 on some architectures due to restrictions in the CSE pass.
8784 This optimization is enabled by default.
8786 @item -fvariable-expansion-in-unroller
8787 @opindex fvariable-expansion-in-unroller
8788 With this option, the compiler creates multiple copies of some
8789 local variables when unrolling a loop, which can result in superior code.
8791 @item -fpartial-inlining
8792 @opindex fpartial-inlining
8793 Inline parts of functions.  This option has any effect only
8794 when inlining itself is turned on by the @option{-finline-functions}
8795 or @option{-finline-small-functions} options.
8797 Enabled at level @option{-O2}.
8799 @item -fpredictive-commoning
8800 @opindex fpredictive-commoning
8801 Perform predictive commoning optimization, i.e., reusing computations
8802 (especially memory loads and stores) performed in previous
8803 iterations of loops.
8805 This option is enabled at level @option{-O3}.
8807 @item -fprefetch-loop-arrays
8808 @opindex fprefetch-loop-arrays
8809 If supported by the target machine, generate instructions to prefetch
8810 memory to improve the performance of loops that access large arrays.
8812 This option may generate better or worse code; results are highly
8813 dependent on the structure of loops within the source code.
8815 Disabled at level @option{-Os}.
8817 @item -fno-printf-return-value
8818 @opindex fno-printf-return-value
8819 Do not substitute constants for known return value of formatted output
8820 functions such as @code{sprintf}, @code{snprintf}, @code{vsprintf}, and
8821 @code{vsnprintf} (but not @code{printf} of @code{fprintf}).  This
8822 transformation allows GCC to optimize or even eliminate branches based
8823 on the known return value of these functions called with arguments that
8824 are either constant, or whose values are known to be in a range that
8825 makes determining the exact return value possible.  For example, when
8826 @option{-fprintf-return-value} is in effect, both the branch and the
8827 body of the @code{if} statement (but not the call to @code{snprint})
8828 can be optimized away when @code{i} is a 32-bit or smaller integer
8829 because the return value is guaranteed to be at most 8.
8831 @smallexample
8832 char buf[9];
8833 if (snprintf (buf, "%08x", i) >= sizeof buf)
8834   @dots{}
8835 @end smallexample
8837 The @option{-fprintf-return-value} option relies on other optimizations
8838 and yields best results with @option{-O2}.  It works in tandem with the
8839 @option{-Wformat-overflow} and @option{-Wformat-truncation} options.
8840 The @option{-fprintf-return-value} option is enabled by default.
8842 @item -fno-peephole
8843 @itemx -fno-peephole2
8844 @opindex fno-peephole
8845 @opindex fno-peephole2
8846 Disable any machine-specific peephole optimizations.  The difference
8847 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
8848 are implemented in the compiler; some targets use one, some use the
8849 other, a few use both.
8851 @option{-fpeephole} is enabled by default.
8852 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8854 @item -fno-guess-branch-probability
8855 @opindex fno-guess-branch-probability
8856 Do not guess branch probabilities using heuristics.
8858 GCC uses heuristics to guess branch probabilities if they are
8859 not provided by profiling feedback (@option{-fprofile-arcs}).  These
8860 heuristics are based on the control flow graph.  If some branch probabilities
8861 are specified by @code{__builtin_expect}, then the heuristics are
8862 used to guess branch probabilities for the rest of the control flow graph,
8863 taking the @code{__builtin_expect} info into account.  The interactions
8864 between the heuristics and @code{__builtin_expect} can be complex, and in
8865 some cases, it may be useful to disable the heuristics so that the effects
8866 of @code{__builtin_expect} are easier to understand.
8868 The default is @option{-fguess-branch-probability} at levels
8869 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8871 @item -freorder-blocks
8872 @opindex freorder-blocks
8873 Reorder basic blocks in the compiled function in order to reduce number of
8874 taken branches and improve code locality.
8876 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8878 @item -freorder-blocks-algorithm=@var{algorithm}
8879 @opindex freorder-blocks-algorithm
8880 Use the specified algorithm for basic block reordering.  The
8881 @var{algorithm} argument can be @samp{simple}, which does not increase
8882 code size (except sometimes due to secondary effects like alignment),
8883 or @samp{stc}, the ``software trace cache'' algorithm, which tries to
8884 put all often executed code together, minimizing the number of branches
8885 executed by making extra copies of code.
8887 The default is @samp{simple} at levels @option{-O}, @option{-Os}, and
8888 @samp{stc} at levels @option{-O2}, @option{-O3}.
8890 @item -freorder-blocks-and-partition
8891 @opindex freorder-blocks-and-partition
8892 In addition to reordering basic blocks in the compiled function, in order
8893 to reduce number of taken branches, partitions hot and cold basic blocks
8894 into separate sections of the assembly and @file{.o} files, to improve
8895 paging and cache locality performance.
8897 This optimization is automatically turned off in the presence of
8898 exception handling or unwind tables (on targets using setjump/longjump or target specific scheme), for linkonce sections, for functions with a user-defined
8899 section attribute and on any architecture that does not support named
8900 sections.  When @option{-fsplit-stack} is used this option is not
8901 enabled by default (to avoid linker errors), but may be enabled
8902 explicitly (if using a working linker).
8904 Enabled for x86 at levels @option{-O2}, @option{-O3}.
8906 @item -freorder-functions
8907 @opindex freorder-functions
8908 Reorder functions in the object file in order to
8909 improve code locality.  This is implemented by using special
8910 subsections @code{.text.hot} for most frequently executed functions and
8911 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
8912 the linker so object file format must support named sections and linker must
8913 place them in a reasonable way.
8915 Also profile feedback must be available to make this option effective.  See
8916 @option{-fprofile-arcs} for details.
8918 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8920 @item -fstrict-aliasing
8921 @opindex fstrict-aliasing
8922 Allow the compiler to assume the strictest aliasing rules applicable to
8923 the language being compiled.  For C (and C++), this activates
8924 optimizations based on the type of expressions.  In particular, an
8925 object of one type is assumed never to reside at the same address as an
8926 object of a different type, unless the types are almost the same.  For
8927 example, an @code{unsigned int} can alias an @code{int}, but not a
8928 @code{void*} or a @code{double}.  A character type may alias any other
8929 type.
8931 @anchor{Type-punning}Pay special attention to code like this:
8932 @smallexample
8933 union a_union @{
8934   int i;
8935   double d;
8938 int f() @{
8939   union a_union t;
8940   t.d = 3.0;
8941   return t.i;
8943 @end smallexample
8944 The practice of reading from a different union member than the one most
8945 recently written to (called ``type-punning'') is common.  Even with
8946 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
8947 is accessed through the union type.  So, the code above works as
8948 expected.  @xref{Structures unions enumerations and bit-fields
8949 implementation}.  However, this code might not:
8950 @smallexample
8951 int f() @{
8952   union a_union t;
8953   int* ip;
8954   t.d = 3.0;
8955   ip = &t.i;
8956   return *ip;
8958 @end smallexample
8960 Similarly, access by taking the address, casting the resulting pointer
8961 and dereferencing the result has undefined behavior, even if the cast
8962 uses a union type, e.g.:
8963 @smallexample
8964 int f() @{
8965   double d = 3.0;
8966   return ((union a_union *) &d)->i;
8968 @end smallexample
8970 The @option{-fstrict-aliasing} option is enabled at levels
8971 @option{-O2}, @option{-O3}, @option{-Os}.
8973 @item -falign-functions
8974 @itemx -falign-functions=@var{n}
8975 @opindex falign-functions
8976 Align the start of functions to the next power-of-two greater than
8977 @var{n}, skipping up to @var{n} bytes.  For instance,
8978 @option{-falign-functions=32} aligns functions to the next 32-byte
8979 boundary, but @option{-falign-functions=24} aligns to the next
8980 32-byte boundary only if this can be done by skipping 23 bytes or less.
8982 @option{-fno-align-functions} and @option{-falign-functions=1} are
8983 equivalent and mean that functions are not aligned.
8985 Some assemblers only support this flag when @var{n} is a power of two;
8986 in that case, it is rounded up.
8988 If @var{n} is not specified or is zero, use a machine-dependent default.
8990 Enabled at levels @option{-O2}, @option{-O3}.
8992 @item -flimit-function-alignment
8993 If this option is enabled, the compiler tries to avoid unnecessarily
8994 overaligning functions. It attempts to instruct the assembler to align
8995 by the amount specified by @option{-falign-functions}, but not to
8996 skip more bytes than the size of the function.
8998 @item -falign-labels
8999 @itemx -falign-labels=@var{n}
9000 @opindex falign-labels
9001 Align all branch targets to a power-of-two boundary, skipping up to
9002 @var{n} bytes like @option{-falign-functions}.  This option can easily
9003 make code slower, because it must insert dummy operations for when the
9004 branch target is reached in the usual flow of the code.
9006 @option{-fno-align-labels} and @option{-falign-labels=1} are
9007 equivalent and mean that labels are not aligned.
9009 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
9010 are greater than this value, then their values are used instead.
9012 If @var{n} is not specified or is zero, use a machine-dependent default
9013 which is very likely to be @samp{1}, meaning no alignment.
9015 Enabled at levels @option{-O2}, @option{-O3}.
9017 @item -falign-loops
9018 @itemx -falign-loops=@var{n}
9019 @opindex falign-loops
9020 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
9021 like @option{-falign-functions}.  If the loops are
9022 executed many times, this makes up for any execution of the dummy
9023 operations.
9025 @option{-fno-align-loops} and @option{-falign-loops=1} are
9026 equivalent and mean that loops are not aligned.
9028 If @var{n} is not specified or is zero, use a machine-dependent default.
9030 Enabled at levels @option{-O2}, @option{-O3}.
9032 @item -falign-jumps
9033 @itemx -falign-jumps=@var{n}
9034 @opindex falign-jumps
9035 Align branch targets to a power-of-two boundary, for branch targets
9036 where the targets can only be reached by jumping, skipping up to @var{n}
9037 bytes like @option{-falign-functions}.  In this case, no dummy operations
9038 need be executed.
9040 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
9041 equivalent and mean that loops are not aligned.
9043 If @var{n} is not specified or is zero, use a machine-dependent default.
9045 Enabled at levels @option{-O2}, @option{-O3}.
9047 @item -funit-at-a-time
9048 @opindex funit-at-a-time
9049 This option is left for compatibility reasons. @option{-funit-at-a-time}
9050 has no effect, while @option{-fno-unit-at-a-time} implies
9051 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
9053 Enabled by default.
9055 @item -fno-toplevel-reorder
9056 @opindex fno-toplevel-reorder
9057 Do not reorder top-level functions, variables, and @code{asm}
9058 statements.  Output them in the same order that they appear in the
9059 input file.  When this option is used, unreferenced static variables
9060 are not removed.  This option is intended to support existing code
9061 that relies on a particular ordering.  For new code, it is better to
9062 use attributes when possible.
9064 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
9065 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
9066 targets.
9068 @item -fweb
9069 @opindex fweb
9070 Constructs webs as commonly used for register allocation purposes and assign
9071 each web individual pseudo register.  This allows the register allocation pass
9072 to operate on pseudos directly, but also strengthens several other optimization
9073 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
9074 however, make debugging impossible, since variables no longer stay in a
9075 ``home register''.
9077 Enabled by default with @option{-funroll-loops}.
9079 @item -fwhole-program
9080 @opindex fwhole-program
9081 Assume that the current compilation unit represents the whole program being
9082 compiled.  All public functions and variables with the exception of @code{main}
9083 and those merged by attribute @code{externally_visible} become static functions
9084 and in effect are optimized more aggressively by interprocedural optimizers.
9086 This option should not be used in combination with @option{-flto}.
9087 Instead relying on a linker plugin should provide safer and more precise
9088 information.
9090 @item -flto[=@var{n}]
9091 @opindex flto
9092 This option runs the standard link-time optimizer.  When invoked
9093 with source code, it generates GIMPLE (one of GCC's internal
9094 representations) and writes it to special ELF sections in the object
9095 file.  When the object files are linked together, all the function
9096 bodies are read from these ELF sections and instantiated as if they
9097 had been part of the same translation unit.
9099 To use the link-time optimizer, @option{-flto} and optimization
9100 options should be specified at compile time and during the final link.
9101 It is recommended that you compile all the files participating in the
9102 same link with the same options and also specify those options at
9103 link time.  
9104 For example:
9106 @smallexample
9107 gcc -c -O2 -flto foo.c
9108 gcc -c -O2 -flto bar.c
9109 gcc -o myprog -flto -O2 foo.o bar.o
9110 @end smallexample
9112 The first two invocations to GCC save a bytecode representation
9113 of GIMPLE into special ELF sections inside @file{foo.o} and
9114 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
9115 @file{foo.o} and @file{bar.o}, merges the two files into a single
9116 internal image, and compiles the result as usual.  Since both
9117 @file{foo.o} and @file{bar.o} are merged into a single image, this
9118 causes all the interprocedural analyses and optimizations in GCC to
9119 work across the two files as if they were a single one.  This means,
9120 for example, that the inliner is able to inline functions in
9121 @file{bar.o} into functions in @file{foo.o} and vice-versa.
9123 Another (simpler) way to enable link-time optimization is:
9125 @smallexample
9126 gcc -o myprog -flto -O2 foo.c bar.c
9127 @end smallexample
9129 The above generates bytecode for @file{foo.c} and @file{bar.c},
9130 merges them together into a single GIMPLE representation and optimizes
9131 them as usual to produce @file{myprog}.
9133 The only important thing to keep in mind is that to enable link-time
9134 optimizations you need to use the GCC driver to perform the link step.
9135 GCC then automatically performs link-time optimization if any of the
9136 objects involved were compiled with the @option{-flto} command-line option.  
9137 You generally
9138 should specify the optimization options to be used for link-time
9139 optimization though GCC tries to be clever at guessing an
9140 optimization level to use from the options used at compile time
9141 if you fail to specify one at link time.  You can always override
9142 the automatic decision to do link-time optimization
9143 by passing @option{-fno-lto} to the link command.
9145 To make whole program optimization effective, it is necessary to make
9146 certain whole program assumptions.  The compiler needs to know
9147 what functions and variables can be accessed by libraries and runtime
9148 outside of the link-time optimized unit.  When supported by the linker,
9149 the linker plugin (see @option{-fuse-linker-plugin}) passes information
9150 to the compiler about used and externally visible symbols.  When
9151 the linker plugin is not available, @option{-fwhole-program} should be
9152 used to allow the compiler to make these assumptions, which leads
9153 to more aggressive optimization decisions.
9155 When @option{-fuse-linker-plugin} is not enabled, when a file is
9156 compiled with @option{-flto}, the generated object file is larger than
9157 a regular object file because it contains GIMPLE bytecodes and the usual
9158 final code (see @option{-ffat-lto-objects}.  This means that
9159 object files with LTO information can be linked as normal object
9160 files; if @option{-fno-lto} is passed to the linker, no
9161 interprocedural optimizations are applied.  Note that when
9162 @option{-fno-fat-lto-objects} is enabled the compile stage is faster
9163 but you cannot perform a regular, non-LTO link on them.
9165 Additionally, the optimization flags used to compile individual files
9166 are not necessarily related to those used at link time.  For instance,
9168 @smallexample
9169 gcc -c -O0 -ffat-lto-objects -flto foo.c
9170 gcc -c -O0 -ffat-lto-objects -flto bar.c
9171 gcc -o myprog -O3 foo.o bar.o
9172 @end smallexample
9174 This produces individual object files with unoptimized assembler
9175 code, but the resulting binary @file{myprog} is optimized at
9176 @option{-O3}.  If, instead, the final binary is generated with
9177 @option{-fno-lto}, then @file{myprog} is not optimized.
9179 When producing the final binary, GCC only
9180 applies link-time optimizations to those files that contain bytecode.
9181 Therefore, you can mix and match object files and libraries with
9182 GIMPLE bytecodes and final object code.  GCC automatically selects
9183 which files to optimize in LTO mode and which files to link without
9184 further processing.
9186 There are some code generation flags preserved by GCC when
9187 generating bytecodes, as they need to be used during the final link
9188 stage.  Generally options specified at link time override those
9189 specified at compile time.
9191 If you do not specify an optimization level option @option{-O} at
9192 link time, then GCC uses the highest optimization level 
9193 used when compiling the object files.
9195 Currently, the following options and their settings are taken from
9196 the first object file that explicitly specifies them: 
9197 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
9198 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
9199 and all the @option{-m} target flags.
9201 Certain ABI-changing flags are required to match in all compilation units,
9202 and trying to override this at link time with a conflicting value
9203 is ignored.  This includes options such as @option{-freg-struct-return}
9204 and @option{-fpcc-struct-return}. 
9206 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
9207 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
9208 are passed through to the link stage and merged conservatively for
9209 conflicting translation units.  Specifically
9210 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
9211 precedence; and for example @option{-ffp-contract=off} takes precedence
9212 over @option{-ffp-contract=fast}.  You can override them at link time.
9214 If LTO encounters objects with C linkage declared with incompatible
9215 types in separate translation units to be linked together (undefined
9216 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
9217 issued.  The behavior is still undefined at run time.  Similar
9218 diagnostics may be raised for other languages.
9220 Another feature of LTO is that it is possible to apply interprocedural
9221 optimizations on files written in different languages:
9223 @smallexample
9224 gcc -c -flto foo.c
9225 g++ -c -flto bar.cc
9226 gfortran -c -flto baz.f90
9227 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
9228 @end smallexample
9230 Notice that the final link is done with @command{g++} to get the C++
9231 runtime libraries and @option{-lgfortran} is added to get the Fortran
9232 runtime libraries.  In general, when mixing languages in LTO mode, you
9233 should use the same link command options as when mixing languages in a
9234 regular (non-LTO) compilation.
9236 If object files containing GIMPLE bytecode are stored in a library archive, say
9237 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
9238 are using a linker with plugin support.  To create static libraries suitable
9239 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
9240 and @command{ranlib}; 
9241 to show the symbols of object files with GIMPLE bytecode, use
9242 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
9243 and @command{nm} have been compiled with plugin support.  At link time, use the the
9244 flag @option{-fuse-linker-plugin} to ensure that the library participates in
9245 the LTO optimization process:
9247 @smallexample
9248 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
9249 @end smallexample
9251 With the linker plugin enabled, the linker extracts the needed
9252 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
9253 to make them part of the aggregated GIMPLE image to be optimized.
9255 If you are not using a linker with plugin support and/or do not
9256 enable the linker plugin, then the objects inside @file{libfoo.a}
9257 are extracted and linked as usual, but they do not participate
9258 in the LTO optimization process.  In order to make a static library suitable
9259 for both LTO optimization and usual linkage, compile its object files with
9260 @option{-flto} @option{-ffat-lto-objects}.
9262 Link-time optimizations do not require the presence of the whole program to
9263 operate.  If the program does not require any symbols to be exported, it is
9264 possible to combine @option{-flto} and @option{-fwhole-program} to allow
9265 the interprocedural optimizers to use more aggressive assumptions which may
9266 lead to improved optimization opportunities.
9267 Use of @option{-fwhole-program} is not needed when linker plugin is
9268 active (see @option{-fuse-linker-plugin}).
9270 The current implementation of LTO makes no
9271 attempt to generate bytecode that is portable between different
9272 types of hosts.  The bytecode files are versioned and there is a
9273 strict version check, so bytecode files generated in one version of
9274 GCC do not work with an older or newer version of GCC.
9276 Link-time optimization does not work well with generation of debugging
9277 information.  Combining @option{-flto} with
9278 @option{-g} is currently experimental and expected to produce unexpected
9279 results.
9281 If you specify the optional @var{n}, the optimization and code
9282 generation done at link time is executed in parallel using @var{n}
9283 parallel jobs by utilizing an installed @command{make} program.  The
9284 environment variable @env{MAKE} may be used to override the program
9285 used.  The default value for @var{n} is 1.
9287 You can also specify @option{-flto=jobserver} to use GNU make's
9288 job server mode to determine the number of parallel jobs. This
9289 is useful when the Makefile calling GCC is already executing in parallel.
9290 You must prepend a @samp{+} to the command recipe in the parent Makefile
9291 for this to work.  This option likely only works if @env{MAKE} is
9292 GNU make.
9294 @item -flto-partition=@var{alg}
9295 @opindex flto-partition
9296 Specify the partitioning algorithm used by the link-time optimizer.
9297 The value is either @samp{1to1} to specify a partitioning mirroring
9298 the original source files or @samp{balanced} to specify partitioning
9299 into equally sized chunks (whenever possible) or @samp{max} to create
9300 new partition for every symbol where possible.  Specifying @samp{none}
9301 as an algorithm disables partitioning and streaming completely. 
9302 The default value is @samp{balanced}. While @samp{1to1} can be used
9303 as an workaround for various code ordering issues, the @samp{max}
9304 partitioning is intended for internal testing only.
9305 The value @samp{one} specifies that exactly one partition should be
9306 used while the value @samp{none} bypasses partitioning and executes
9307 the link-time optimization step directly from the WPA phase.
9309 @item -flto-odr-type-merging
9310 @opindex flto-odr-type-merging
9311 Enable streaming of mangled types names of C++ types and their unification
9312 at link time.  This increases size of LTO object files, but enables
9313 diagnostics about One Definition Rule violations.
9315 @item -flto-compression-level=@var{n}
9316 @opindex flto-compression-level
9317 This option specifies the level of compression used for intermediate
9318 language written to LTO object files, and is only meaningful in
9319 conjunction with LTO mode (@option{-flto}).  Valid
9320 values are 0 (no compression) to 9 (maximum compression).  Values
9321 outside this range are clamped to either 0 or 9.  If the option is not
9322 given, a default balanced compression setting is used.
9324 @item -fuse-linker-plugin
9325 @opindex fuse-linker-plugin
9326 Enables the use of a linker plugin during link-time optimization.  This
9327 option relies on plugin support in the linker, which is available in gold
9328 or in GNU ld 2.21 or newer.
9330 This option enables the extraction of object files with GIMPLE bytecode out
9331 of library archives. This improves the quality of optimization by exposing
9332 more code to the link-time optimizer.  This information specifies what
9333 symbols can be accessed externally (by non-LTO object or during dynamic
9334 linking).  Resulting code quality improvements on binaries (and shared
9335 libraries that use hidden visibility) are similar to @option{-fwhole-program}.
9336 See @option{-flto} for a description of the effect of this flag and how to
9337 use it.
9339 This option is enabled by default when LTO support in GCC is enabled
9340 and GCC was configured for use with
9341 a linker supporting plugins (GNU ld 2.21 or newer or gold).
9343 @item -ffat-lto-objects
9344 @opindex ffat-lto-objects
9345 Fat LTO objects are object files that contain both the intermediate language
9346 and the object code. This makes them usable for both LTO linking and normal
9347 linking. This option is effective only when compiling with @option{-flto}
9348 and is ignored at link time.
9350 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
9351 requires the complete toolchain to be aware of LTO. It requires a linker with
9352 linker plugin support for basic functionality.  Additionally,
9353 @command{nm}, @command{ar} and @command{ranlib}
9354 need to support linker plugins to allow a full-featured build environment
9355 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
9356 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
9357 to these tools. With non fat LTO makefiles need to be modified to use them.
9359 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
9360 support.
9362 @item -fcompare-elim
9363 @opindex fcompare-elim
9364 After register allocation and post-register allocation instruction splitting,
9365 identify arithmetic instructions that compute processor flags similar to a
9366 comparison operation based on that arithmetic.  If possible, eliminate the
9367 explicit comparison operation.
9369 This pass only applies to certain targets that cannot explicitly represent
9370 the comparison operation before register allocation is complete.
9372 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9374 @item -fcprop-registers
9375 @opindex fcprop-registers
9376 After register allocation and post-register allocation instruction splitting,
9377 perform a copy-propagation pass to try to reduce scheduling dependencies
9378 and occasionally eliminate the copy.
9380 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9382 @item -fprofile-correction
9383 @opindex fprofile-correction
9384 Profiles collected using an instrumented binary for multi-threaded programs may
9385 be inconsistent due to missed counter updates. When this option is specified,
9386 GCC uses heuristics to correct or smooth out such inconsistencies. By
9387 default, GCC emits an error message when an inconsistent profile is detected.
9389 @item -fprofile-use
9390 @itemx -fprofile-use=@var{path}
9391 @opindex fprofile-use
9392 Enable profile feedback-directed optimizations, 
9393 and the following optimizations
9394 which are generally profitable only with profile feedback available:
9395 @option{-fbranch-probabilities}, @option{-fvpt},
9396 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9397 @option{-ftree-vectorize}, and @option{ftree-loop-distribute-patterns}.
9399 Before you can use this option, you must first generate profiling information.
9400 @xref{Instrumentation Options}, for information about the
9401 @option{-fprofile-generate} option.
9403 By default, GCC emits an error message if the feedback profiles do not
9404 match the source code.  This error can be turned into a warning by using
9405 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
9406 code.
9408 If @var{path} is specified, GCC looks at the @var{path} to find
9409 the profile feedback data files. See @option{-fprofile-dir}.
9411 @item -fauto-profile
9412 @itemx -fauto-profile=@var{path}
9413 @opindex fauto-profile
9414 Enable sampling-based feedback-directed optimizations, 
9415 and the following optimizations
9416 which are generally profitable only with profile feedback available:
9417 @option{-fbranch-probabilities}, @option{-fvpt},
9418 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9419 @option{-ftree-vectorize},
9420 @option{-finline-functions}, @option{-fipa-cp}, @option{-fipa-cp-clone},
9421 @option{-fpredictive-commoning}, @option{-funswitch-loops},
9422 @option{-fgcse-after-reload}, and @option{-ftree-loop-distribute-patterns}.
9424 @var{path} is the name of a file containing AutoFDO profile information.
9425 If omitted, it defaults to @file{fbdata.afdo} in the current directory.
9427 Producing an AutoFDO profile data file requires running your program
9428 with the @command{perf} utility on a supported GNU/Linux target system.
9429 For more information, see @uref{https://perf.wiki.kernel.org/}.
9431 E.g.
9432 @smallexample
9433 perf record -e br_inst_retired:near_taken -b -o perf.data \
9434     -- your_program
9435 @end smallexample
9437 Then use the @command{create_gcov} tool to convert the raw profile data
9438 to a format that can be used by GCC.@  You must also supply the 
9439 unstripped binary for your program to this tool.  
9440 See @uref{https://github.com/google/autofdo}.
9442 E.g.
9443 @smallexample
9444 create_gcov --binary=your_program.unstripped --profile=perf.data \
9445     --gcov=profile.afdo
9446 @end smallexample
9447 @end table
9449 The following options control compiler behavior regarding floating-point 
9450 arithmetic.  These options trade off between speed and
9451 correctness.  All must be specifically enabled.
9453 @table @gcctabopt
9454 @item -ffloat-store
9455 @opindex ffloat-store
9456 Do not store floating-point variables in registers, and inhibit other
9457 options that might change whether a floating-point value is taken from a
9458 register or memory.
9460 @cindex floating-point precision
9461 This option prevents undesirable excess precision on machines such as
9462 the 68000 where the floating registers (of the 68881) keep more
9463 precision than a @code{double} is supposed to have.  Similarly for the
9464 x86 architecture.  For most programs, the excess precision does only
9465 good, but a few programs rely on the precise definition of IEEE floating
9466 point.  Use @option{-ffloat-store} for such programs, after modifying
9467 them to store all pertinent intermediate computations into variables.
9469 @item -fexcess-precision=@var{style}
9470 @opindex fexcess-precision
9471 This option allows further control over excess precision on machines
9472 where floating-point operations occur in a format with more precision or
9473 range than the IEEE standard and interchange floating-point types.  By
9474 default, @option{-fexcess-precision=fast} is in effect; this means that
9475 operations may be carried out in a wider precision than the types specified
9476 in the source if that would result in faster code, and it is unpredictable
9477 when rounding to the types specified in the source code takes place.
9478 When compiling C, if @option{-fexcess-precision=standard} is specified then
9479 excess precision follows the rules specified in ISO C99; in particular,
9480 both casts and assignments cause values to be rounded to their
9481 semantic types (whereas @option{-ffloat-store} only affects
9482 assignments).  This option is enabled by default for C if a strict
9483 conformance option such as @option{-std=c99} is used.
9484 @option{-ffast-math} enables @option{-fexcess-precision=fast} by default
9485 regardless of whether a strict conformance option is used.
9487 @opindex mfpmath
9488 @option{-fexcess-precision=standard} is not implemented for languages
9489 other than C.  On the x86, it has no effect if @option{-mfpmath=sse}
9490 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
9491 semantics apply without excess precision, and in the latter, rounding
9492 is unpredictable.
9494 @item -ffast-math
9495 @opindex ffast-math
9496 Sets the options @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
9497 @option{-ffinite-math-only}, @option{-fno-rounding-math},
9498 @option{-fno-signaling-nans}, @option{-fcx-limited-range} and
9499 @option{-fexcess-precision=fast}.
9501 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
9503 This option is not turned on by any @option{-O} option besides
9504 @option{-Ofast} since it can result in incorrect output for programs
9505 that depend on an exact implementation of IEEE or ISO rules/specifications
9506 for math functions. It may, however, yield faster code for programs
9507 that do not require the guarantees of these specifications.
9509 @item -fno-math-errno
9510 @opindex fno-math-errno
9511 Do not set @code{errno} after calling math functions that are executed
9512 with a single instruction, e.g., @code{sqrt}.  A program that relies on
9513 IEEE exceptions for math error handling may want to use this flag
9514 for speed while maintaining IEEE arithmetic compatibility.
9516 This option is not turned on by any @option{-O} option since
9517 it can result in incorrect output for programs that depend on
9518 an exact implementation of IEEE or ISO rules/specifications for
9519 math functions. It may, however, yield faster code for programs
9520 that do not require the guarantees of these specifications.
9522 The default is @option{-fmath-errno}.
9524 On Darwin systems, the math library never sets @code{errno}.  There is
9525 therefore no reason for the compiler to consider the possibility that
9526 it might, and @option{-fno-math-errno} is the default.
9528 @item -funsafe-math-optimizations
9529 @opindex funsafe-math-optimizations
9531 Allow optimizations for floating-point arithmetic that (a) assume
9532 that arguments and results are valid and (b) may violate IEEE or
9533 ANSI standards.  When used at link time, it may include libraries
9534 or startup files that change the default FPU control word or other
9535 similar optimizations.
9537 This option is not turned on by any @option{-O} option since
9538 it can result in incorrect output for programs that depend on
9539 an exact implementation of IEEE or ISO rules/specifications for
9540 math functions. It may, however, yield faster code for programs
9541 that do not require the guarantees of these specifications.
9542 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
9543 @option{-fassociative-math} and @option{-freciprocal-math}.
9545 The default is @option{-fno-unsafe-math-optimizations}.
9547 @item -fassociative-math
9548 @opindex fassociative-math
9550 Allow re-association of operands in series of floating-point operations.
9551 This violates the ISO C and C++ language standard by possibly changing
9552 computation result.  NOTE: re-ordering may change the sign of zero as
9553 well as ignore NaNs and inhibit or create underflow or overflow (and
9554 thus cannot be used on code that relies on rounding behavior like
9555 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
9556 and thus may not be used when ordered comparisons are required.
9557 This option requires that both @option{-fno-signed-zeros} and
9558 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
9559 much sense with @option{-frounding-math}. For Fortran the option
9560 is automatically enabled when both @option{-fno-signed-zeros} and
9561 @option{-fno-trapping-math} are in effect.
9563 The default is @option{-fno-associative-math}.
9565 @item -freciprocal-math
9566 @opindex freciprocal-math
9568 Allow the reciprocal of a value to be used instead of dividing by
9569 the value if this enables optimizations.  For example @code{x / y}
9570 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
9571 is subject to common subexpression elimination.  Note that this loses
9572 precision and increases the number of flops operating on the value.
9574 The default is @option{-fno-reciprocal-math}.
9576 @item -ffinite-math-only
9577 @opindex ffinite-math-only
9578 Allow optimizations for floating-point arithmetic that assume
9579 that arguments and results are not NaNs or +-Infs.
9581 This option is not turned on by any @option{-O} option since
9582 it can result in incorrect output for programs that depend on
9583 an exact implementation of IEEE or ISO rules/specifications for
9584 math functions. It may, however, yield faster code for programs
9585 that do not require the guarantees of these specifications.
9587 The default is @option{-fno-finite-math-only}.
9589 @item -fno-signed-zeros
9590 @opindex fno-signed-zeros
9591 Allow optimizations for floating-point arithmetic that ignore the
9592 signedness of zero.  IEEE arithmetic specifies the behavior of
9593 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
9594 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
9595 This option implies that the sign of a zero result isn't significant.
9597 The default is @option{-fsigned-zeros}.
9599 @item -fno-trapping-math
9600 @opindex fno-trapping-math
9601 Compile code assuming that floating-point operations cannot generate
9602 user-visible traps.  These traps include division by zero, overflow,
9603 underflow, inexact result and invalid operation.  This option requires
9604 that @option{-fno-signaling-nans} be in effect.  Setting this option may
9605 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
9607 This option should never be turned on by any @option{-O} option since
9608 it can result in incorrect output for programs that depend on
9609 an exact implementation of IEEE or ISO rules/specifications for
9610 math functions.
9612 The default is @option{-ftrapping-math}.
9614 @item -frounding-math
9615 @opindex frounding-math
9616 Disable transformations and optimizations that assume default floating-point
9617 rounding behavior.  This is round-to-zero for all floating point
9618 to integer conversions, and round-to-nearest for all other arithmetic
9619 truncations.  This option should be specified for programs that change
9620 the FP rounding mode dynamically, or that may be executed with a
9621 non-default rounding mode.  This option disables constant folding of
9622 floating-point expressions at compile time (which may be affected by
9623 rounding mode) and arithmetic transformations that are unsafe in the
9624 presence of sign-dependent rounding modes.
9626 The default is @option{-fno-rounding-math}.
9628 This option is experimental and does not currently guarantee to
9629 disable all GCC optimizations that are affected by rounding mode.
9630 Future versions of GCC may provide finer control of this setting
9631 using C99's @code{FENV_ACCESS} pragma.  This command-line option
9632 will be used to specify the default state for @code{FENV_ACCESS}.
9634 @item -fsignaling-nans
9635 @opindex fsignaling-nans
9636 Compile code assuming that IEEE signaling NaNs may generate user-visible
9637 traps during floating-point operations.  Setting this option disables
9638 optimizations that may change the number of exceptions visible with
9639 signaling NaNs.  This option implies @option{-ftrapping-math}.
9641 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
9642 be defined.
9644 The default is @option{-fno-signaling-nans}.
9646 This option is experimental and does not currently guarantee to
9647 disable all GCC optimizations that affect signaling NaN behavior.
9649 @item -fno-fp-int-builtin-inexact
9650 @opindex fno-fp-int-builtin-inexact
9651 Do not allow the built-in functions @code{ceil}, @code{floor},
9652 @code{round} and @code{trunc}, and their @code{float} and @code{long
9653 double} variants, to generate code that raises the ``inexact''
9654 floating-point exception for noninteger arguments.  ISO C99 and C11
9655 allow these functions to raise the ``inexact'' exception, but ISO/IEC
9656 TS 18661-1:2014, the C bindings to IEEE 754-2008, does not allow these
9657 functions to do so.
9659 The default is @option{-ffp-int-builtin-inexact}, allowing the
9660 exception to be raised.  This option does nothing unless
9661 @option{-ftrapping-math} is in effect.
9663 Even if @option{-fno-fp-int-builtin-inexact} is used, if the functions
9664 generate a call to a library function then the ``inexact'' exception
9665 may be raised if the library implementation does not follow TS 18661.
9667 @item -fsingle-precision-constant
9668 @opindex fsingle-precision-constant
9669 Treat floating-point constants as single precision instead of
9670 implicitly converting them to double-precision constants.
9672 @item -fcx-limited-range
9673 @opindex fcx-limited-range
9674 When enabled, this option states that a range reduction step is not
9675 needed when performing complex division.  Also, there is no checking
9676 whether the result of a complex multiplication or division is @code{NaN
9677 + I*NaN}, with an attempt to rescue the situation in that case.  The
9678 default is @option{-fno-cx-limited-range}, but is enabled by
9679 @option{-ffast-math}.
9681 This option controls the default setting of the ISO C99
9682 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
9683 all languages.
9685 @item -fcx-fortran-rules
9686 @opindex fcx-fortran-rules
9687 Complex multiplication and division follow Fortran rules.  Range
9688 reduction is done as part of complex division, but there is no checking
9689 whether the result of a complex multiplication or division is @code{NaN
9690 + I*NaN}, with an attempt to rescue the situation in that case.
9692 The default is @option{-fno-cx-fortran-rules}.
9694 @end table
9696 The following options control optimizations that may improve
9697 performance, but are not enabled by any @option{-O} options.  This
9698 section includes experimental options that may produce broken code.
9700 @table @gcctabopt
9701 @item -fbranch-probabilities
9702 @opindex fbranch-probabilities
9703 After running a program compiled with @option{-fprofile-arcs}
9704 (@pxref{Instrumentation Options}),
9705 you can compile it a second time using
9706 @option{-fbranch-probabilities}, to improve optimizations based on
9707 the number of times each branch was taken.  When a program
9708 compiled with @option{-fprofile-arcs} exits, it saves arc execution
9709 counts to a file called @file{@var{sourcename}.gcda} for each source
9710 file.  The information in this data file is very dependent on the
9711 structure of the generated code, so you must use the same source code
9712 and the same optimization options for both compilations.
9714 With @option{-fbranch-probabilities}, GCC puts a
9715 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
9716 These can be used to improve optimization.  Currently, they are only
9717 used in one place: in @file{reorg.c}, instead of guessing which path a
9718 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
9719 exactly determine which path is taken more often.
9721 @item -fprofile-values
9722 @opindex fprofile-values
9723 If combined with @option{-fprofile-arcs}, it adds code so that some
9724 data about values of expressions in the program is gathered.
9726 With @option{-fbranch-probabilities}, it reads back the data gathered
9727 from profiling values of expressions for usage in optimizations.
9729 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
9731 @item -fprofile-reorder-functions
9732 @opindex fprofile-reorder-functions
9733 Function reordering based on profile instrumentation collects
9734 first time of execution of a function and orders these functions
9735 in ascending order.
9737 Enabled with @option{-fprofile-use}.
9739 @item -fvpt
9740 @opindex fvpt
9741 If combined with @option{-fprofile-arcs}, this option instructs the compiler
9742 to add code to gather information about values of expressions.
9744 With @option{-fbranch-probabilities}, it reads back the data gathered
9745 and actually performs the optimizations based on them.
9746 Currently the optimizations include specialization of division operations
9747 using the knowledge about the value of the denominator.
9749 @item -frename-registers
9750 @opindex frename-registers
9751 Attempt to avoid false dependencies in scheduled code by making use
9752 of registers left over after register allocation.  This optimization
9753 most benefits processors with lots of registers.  Depending on the
9754 debug information format adopted by the target, however, it can
9755 make debugging impossible, since variables no longer stay in
9756 a ``home register''.
9758 Enabled by default with @option{-funroll-loops}.
9760 @item -fschedule-fusion
9761 @opindex fschedule-fusion
9762 Performs a target dependent pass over the instruction stream to schedule
9763 instructions of same type together because target machine can execute them
9764 more efficiently if they are adjacent to each other in the instruction flow.
9766 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9768 @item -ftracer
9769 @opindex ftracer
9770 Perform tail duplication to enlarge superblock size.  This transformation
9771 simplifies the control flow of the function allowing other optimizations to do
9772 a better job.
9774 Enabled with @option{-fprofile-use}.
9776 @item -funroll-loops
9777 @opindex funroll-loops
9778 Unroll loops whose number of iterations can be determined at compile time or
9779 upon entry to the loop.  @option{-funroll-loops} implies
9780 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
9781 It also turns on complete loop peeling (i.e.@: complete removal of loops with
9782 a small constant number of iterations).  This option makes code larger, and may
9783 or may not make it run faster.
9785 Enabled with @option{-fprofile-use}.
9787 @item -funroll-all-loops
9788 @opindex funroll-all-loops
9789 Unroll all loops, even if their number of iterations is uncertain when
9790 the loop is entered.  This usually makes programs run more slowly.
9791 @option{-funroll-all-loops} implies the same options as
9792 @option{-funroll-loops}.
9794 @item -fpeel-loops
9795 @opindex fpeel-loops
9796 Peels loops for which there is enough information that they do not
9797 roll much (from profile feedback or static analysis).  It also turns on
9798 complete loop peeling (i.e.@: complete removal of loops with small constant
9799 number of iterations).
9801 Enabled with @option{-O3} and/or @option{-fprofile-use}.
9803 @item -fmove-loop-invariants
9804 @opindex fmove-loop-invariants
9805 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
9806 at level @option{-O1}
9808 @item -fsplit-loops
9809 @opindex fsplit-loops
9810 Split a loop into two if it contains a condition that's always true
9811 for one side of the iteration space and false for the other.
9813 @item -funswitch-loops
9814 @opindex funswitch-loops
9815 Move branches with loop invariant conditions out of the loop, with duplicates
9816 of the loop on both branches (modified according to result of the condition).
9818 @item -floop-unroll-and-jam
9819 @opindex floop-unroll-and-jam
9820 Apply unroll and jam transoformations on feasible loops.  In a loop
9821 nest this unrolls the outer loop by some factor and fuses the resulting
9822 multiple inner loops.
9824 @item -ffunction-sections
9825 @itemx -fdata-sections
9826 @opindex ffunction-sections
9827 @opindex fdata-sections
9828 Place each function or data item into its own section in the output
9829 file if the target supports arbitrary sections.  The name of the
9830 function or the name of the data item determines the section's name
9831 in the output file.
9833 Use these options on systems where the linker can perform optimizations to
9834 improve locality of reference in the instruction space.  Most systems using the
9835 ELF object format have linkers with such optimizations.  On AIX, the linker
9836 rearranges sections (CSECTs) based on the call graph.  The performance impact
9837 varies.
9839 Together with a linker garbage collection (linker @option{--gc-sections}
9840 option) these options may lead to smaller statically-linked executables (after
9841 stripping).
9843 On ELF/DWARF systems these options do not degenerate the quality of the debug
9844 information.  There could be issues with other object files/debug info formats.
9846 Only use these options when there are significant benefits from doing so.  When
9847 you specify these options, the assembler and linker create larger object and
9848 executable files and are also slower.  These options affect code generation.
9849 They prevent optimizations by the compiler and assembler using relative
9850 locations inside a translation unit since the locations are unknown until
9851 link time.  An example of such an optimization is relaxing calls to short call
9852 instructions.
9854 @item -fbranch-target-load-optimize
9855 @opindex fbranch-target-load-optimize
9856 Perform branch target register load optimization before prologue / epilogue
9857 threading.
9858 The use of target registers can typically be exposed only during reload,
9859 thus hoisting loads out of loops and doing inter-block scheduling needs
9860 a separate optimization pass.
9862 @item -fbranch-target-load-optimize2
9863 @opindex fbranch-target-load-optimize2
9864 Perform branch target register load optimization after prologue / epilogue
9865 threading.
9867 @item -fbtr-bb-exclusive
9868 @opindex fbtr-bb-exclusive
9869 When performing branch target register load optimization, don't reuse
9870 branch target registers within any basic block.
9872 @item -fstdarg-opt
9873 @opindex fstdarg-opt
9874 Optimize the prologue of variadic argument functions with respect to usage of
9875 those arguments.
9877 @item -fsection-anchors
9878 @opindex fsection-anchors
9879 Try to reduce the number of symbolic address calculations by using
9880 shared ``anchor'' symbols to address nearby objects.  This transformation
9881 can help to reduce the number of GOT entries and GOT accesses on some
9882 targets.
9884 For example, the implementation of the following function @code{foo}:
9886 @smallexample
9887 static int a, b, c;
9888 int foo (void) @{ return a + b + c; @}
9889 @end smallexample
9891 @noindent
9892 usually calculates the addresses of all three variables, but if you
9893 compile it with @option{-fsection-anchors}, it accesses the variables
9894 from a common anchor point instead.  The effect is similar to the
9895 following pseudocode (which isn't valid C):
9897 @smallexample
9898 int foo (void)
9900   register int *xr = &x;
9901   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
9903 @end smallexample
9905 Not all targets support this option.
9907 @item --param @var{name}=@var{value}
9908 @opindex param
9909 In some places, GCC uses various constants to control the amount of
9910 optimization that is done.  For example, GCC does not inline functions
9911 that contain more than a certain number of instructions.  You can
9912 control some of these constants on the command line using the
9913 @option{--param} option.
9915 The names of specific parameters, and the meaning of the values, are
9916 tied to the internals of the compiler, and are subject to change
9917 without notice in future releases.
9919 In each case, the @var{value} is an integer.  The allowable choices for
9920 @var{name} are:
9922 @table @gcctabopt
9923 @item predictable-branch-outcome
9924 When branch is predicted to be taken with probability lower than this threshold
9925 (in percent), then it is considered well predictable. The default is 10.
9927 @item max-rtl-if-conversion-insns
9928 RTL if-conversion tries to remove conditional branches around a block and
9929 replace them with conditionally executed instructions.  This parameter
9930 gives the maximum number of instructions in a block which should be
9931 considered for if-conversion.  The default is 10, though the compiler will
9932 also use other heuristics to decide whether if-conversion is likely to be
9933 profitable.
9935 @item max-rtl-if-conversion-predictable-cost
9936 @item max-rtl-if-conversion-unpredictable-cost
9937 RTL if-conversion will try to remove conditional branches around a block
9938 and replace them with conditionally executed instructions.  These parameters
9939 give the maximum permissible cost for the sequence that would be generated
9940 by if-conversion depending on whether the branch is statically determined
9941 to be predictable or not.  The units for this parameter are the same as
9942 those for the GCC internal seq_cost metric.  The compiler will try to
9943 provide a reasonable default for this parameter using the BRANCH_COST
9944 target macro.
9946 @item max-crossjump-edges
9947 The maximum number of incoming edges to consider for cross-jumping.
9948 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
9949 the number of edges incoming to each block.  Increasing values mean
9950 more aggressive optimization, making the compilation time increase with
9951 probably small improvement in executable size.
9953 @item min-crossjump-insns
9954 The minimum number of instructions that must be matched at the end
9955 of two blocks before cross-jumping is performed on them.  This
9956 value is ignored in the case where all instructions in the block being
9957 cross-jumped from are matched.  The default value is 5.
9959 @item max-grow-copy-bb-insns
9960 The maximum code size expansion factor when copying basic blocks
9961 instead of jumping.  The expansion is relative to a jump instruction.
9962 The default value is 8.
9964 @item max-goto-duplication-insns
9965 The maximum number of instructions to duplicate to a block that jumps
9966 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
9967 passes, GCC factors computed gotos early in the compilation process,
9968 and unfactors them as late as possible.  Only computed jumps at the
9969 end of a basic blocks with no more than max-goto-duplication-insns are
9970 unfactored.  The default value is 8.
9972 @item max-delay-slot-insn-search
9973 The maximum number of instructions to consider when looking for an
9974 instruction to fill a delay slot.  If more than this arbitrary number of
9975 instructions are searched, the time savings from filling the delay slot
9976 are minimal, so stop searching.  Increasing values mean more
9977 aggressive optimization, making the compilation time increase with probably
9978 small improvement in execution time.
9980 @item max-delay-slot-live-search
9981 When trying to fill delay slots, the maximum number of instructions to
9982 consider when searching for a block with valid live register
9983 information.  Increasing this arbitrarily chosen value means more
9984 aggressive optimization, increasing the compilation time.  This parameter
9985 should be removed when the delay slot code is rewritten to maintain the
9986 control-flow graph.
9988 @item max-gcse-memory
9989 The approximate maximum amount of memory that can be allocated in
9990 order to perform the global common subexpression elimination
9991 optimization.  If more memory than specified is required, the
9992 optimization is not done.
9994 @item max-gcse-insertion-ratio
9995 If the ratio of expression insertions to deletions is larger than this value
9996 for any expression, then RTL PRE inserts or removes the expression and thus
9997 leaves partially redundant computations in the instruction stream.  The default value is 20.
9999 @item max-pending-list-length
10000 The maximum number of pending dependencies scheduling allows
10001 before flushing the current state and starting over.  Large functions
10002 with few branches or calls can create excessively large lists which
10003 needlessly consume memory and resources.
10005 @item max-modulo-backtrack-attempts
10006 The maximum number of backtrack attempts the scheduler should make
10007 when modulo scheduling a loop.  Larger values can exponentially increase
10008 compilation time.
10010 @item max-inline-insns-single
10011 Several parameters control the tree inliner used in GCC@.
10012 This number sets the maximum number of instructions (counted in GCC's
10013 internal representation) in a single function that the tree inliner
10014 considers for inlining.  This only affects functions declared
10015 inline and methods implemented in a class declaration (C++).
10016 The default value is 400.
10018 @item max-inline-insns-auto
10019 When you use @option{-finline-functions} (included in @option{-O3}),
10020 a lot of functions that would otherwise not be considered for inlining
10021 by the compiler are investigated.  To those functions, a different
10022 (more restrictive) limit compared to functions declared inline can
10023 be applied.
10024 The default value is 40.
10026 @item inline-min-speedup
10027 When estimated performance improvement of caller + callee runtime exceeds this
10028 threshold (in percent), the function can be inlined regardless of the limit on
10029 @option{--param max-inline-insns-single} and @option{--param
10030 max-inline-insns-auto}.
10032 @item large-function-insns
10033 The limit specifying really large functions.  For functions larger than this
10034 limit after inlining, inlining is constrained by
10035 @option{--param large-function-growth}.  This parameter is useful primarily
10036 to avoid extreme compilation time caused by non-linear algorithms used by the
10037 back end.
10038 The default value is 2700.
10040 @item large-function-growth
10041 Specifies maximal growth of large function caused by inlining in percents.
10042 The default value is 100 which limits large function growth to 2.0 times
10043 the original size.
10045 @item large-unit-insns
10046 The limit specifying large translation unit.  Growth caused by inlining of
10047 units larger than this limit is limited by @option{--param inline-unit-growth}.
10048 For small units this might be too tight.
10049 For example, consider a unit consisting of function A
10050 that is inline and B that just calls A three times.  If B is small relative to
10051 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
10052 large units consisting of small inlineable functions, however, the overall unit
10053 growth limit is needed to avoid exponential explosion of code size.  Thus for
10054 smaller units, the size is increased to @option{--param large-unit-insns}
10055 before applying @option{--param inline-unit-growth}.  The default is 10000.
10057 @item inline-unit-growth
10058 Specifies maximal overall growth of the compilation unit caused by inlining.
10059 The default value is 20 which limits unit growth to 1.2 times the original
10060 size. Cold functions (either marked cold via an attribute or by profile
10061 feedback) are not accounted into the unit size.
10063 @item ipcp-unit-growth
10064 Specifies maximal overall growth of the compilation unit caused by
10065 interprocedural constant propagation.  The default value is 10 which limits
10066 unit growth to 1.1 times the original size.
10068 @item large-stack-frame
10069 The limit specifying large stack frames.  While inlining the algorithm is trying
10070 to not grow past this limit too much.  The default value is 256 bytes.
10072 @item large-stack-frame-growth
10073 Specifies maximal growth of large stack frames caused by inlining in percents.
10074 The default value is 1000 which limits large stack frame growth to 11 times
10075 the original size.
10077 @item max-inline-insns-recursive
10078 @itemx max-inline-insns-recursive-auto
10079 Specifies the maximum number of instructions an out-of-line copy of a
10080 self-recursive inline
10081 function can grow into by performing recursive inlining.
10083 @option{--param max-inline-insns-recursive} applies to functions
10084 declared inline.
10085 For functions not declared inline, recursive inlining
10086 happens only when @option{-finline-functions} (included in @option{-O3}) is
10087 enabled; @option{--param max-inline-insns-recursive-auto} applies instead.  The
10088 default value is 450.
10090 @item max-inline-recursive-depth
10091 @itemx max-inline-recursive-depth-auto
10092 Specifies the maximum recursion depth used for recursive inlining.
10094 @option{--param max-inline-recursive-depth} applies to functions
10095 declared inline.  For functions not declared inline, recursive inlining
10096 happens only when @option{-finline-functions} (included in @option{-O3}) is
10097 enabled; @option{--param max-inline-recursive-depth-auto} applies instead.  The
10098 default value is 8.
10100 @item min-inline-recursive-probability
10101 Recursive inlining is profitable only for function having deep recursion
10102 in average and can hurt for function having little recursion depth by
10103 increasing the prologue size or complexity of function body to other
10104 optimizers.
10106 When profile feedback is available (see @option{-fprofile-generate}) the actual
10107 recursion depth can be guessed from the probability that function recurses
10108 via a given call expression.  This parameter limits inlining only to call
10109 expressions whose probability exceeds the given threshold (in percents).
10110 The default value is 10.
10112 @item early-inlining-insns
10113 Specify growth that the early inliner can make.  In effect it increases
10114 the amount of inlining for code having a large abstraction penalty.
10115 The default value is 14.
10117 @item max-early-inliner-iterations
10118 Limit of iterations of the early inliner.  This basically bounds
10119 the number of nested indirect calls the early inliner can resolve.
10120 Deeper chains are still handled by late inlining.
10122 @item comdat-sharing-probability
10123 Probability (in percent) that C++ inline function with comdat visibility
10124 are shared across multiple compilation units.  The default value is 20.
10126 @item profile-func-internal-id
10127 A parameter to control whether to use function internal id in profile
10128 database lookup. If the value is 0, the compiler uses an id that
10129 is based on function assembler name and filename, which makes old profile
10130 data more tolerant to source changes such as function reordering etc.
10131 The default value is 0.
10133 @item min-vect-loop-bound
10134 The minimum number of iterations under which loops are not vectorized
10135 when @option{-ftree-vectorize} is used.  The number of iterations after
10136 vectorization needs to be greater than the value specified by this option
10137 to allow vectorization.  The default value is 0.
10139 @item gcse-cost-distance-ratio
10140 Scaling factor in calculation of maximum distance an expression
10141 can be moved by GCSE optimizations.  This is currently supported only in the
10142 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
10143 is with simple expressions, i.e., the expressions that have cost
10144 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
10145 hoisting of simple expressions.  The default value is 10.
10147 @item gcse-unrestricted-cost
10148 Cost, roughly measured as the cost of a single typical machine
10149 instruction, at which GCSE optimizations do not constrain
10150 the distance an expression can travel.  This is currently
10151 supported only in the code hoisting pass.  The lesser the cost,
10152 the more aggressive code hoisting is.  Specifying 0 
10153 allows all expressions to travel unrestricted distances.
10154 The default value is 3.
10156 @item max-hoist-depth
10157 The depth of search in the dominator tree for expressions to hoist.
10158 This is used to avoid quadratic behavior in hoisting algorithm.
10159 The value of 0 does not limit on the search, but may slow down compilation
10160 of huge functions.  The default value is 30.
10162 @item max-tail-merge-comparisons
10163 The maximum amount of similar bbs to compare a bb with.  This is used to
10164 avoid quadratic behavior in tree tail merging.  The default value is 10.
10166 @item max-tail-merge-iterations
10167 The maximum amount of iterations of the pass over the function.  This is used to
10168 limit compilation time in tree tail merging.  The default value is 2.
10170 @item store-merging-allow-unaligned
10171 Allow the store merging pass to introduce unaligned stores if it is legal to
10172 do so.  The default value is 1.
10174 @item max-stores-to-merge
10175 The maximum number of stores to attempt to merge into wider stores in the store
10176 merging pass.  The minimum value is 2 and the default is 64.
10178 @item max-unrolled-insns
10179 The maximum number of instructions that a loop may have to be unrolled.
10180 If a loop is unrolled, this parameter also determines how many times
10181 the loop code is unrolled.
10183 @item max-average-unrolled-insns
10184 The maximum number of instructions biased by probabilities of their execution
10185 that a loop may have to be unrolled.  If a loop is unrolled,
10186 this parameter also determines how many times the loop code is unrolled.
10188 @item max-unroll-times
10189 The maximum number of unrollings of a single loop.
10191 @item max-peeled-insns
10192 The maximum number of instructions that a loop may have to be peeled.
10193 If a loop is peeled, this parameter also determines how many times
10194 the loop code is peeled.
10196 @item max-peel-times
10197 The maximum number of peelings of a single loop.
10199 @item max-peel-branches
10200 The maximum number of branches on the hot path through the peeled sequence.
10202 @item max-completely-peeled-insns
10203 The maximum number of insns of a completely peeled loop.
10205 @item max-completely-peel-times
10206 The maximum number of iterations of a loop to be suitable for complete peeling.
10208 @item max-completely-peel-loop-nest-depth
10209 The maximum depth of a loop nest suitable for complete peeling.
10211 @item max-unswitch-insns
10212 The maximum number of insns of an unswitched loop.
10214 @item max-unswitch-level
10215 The maximum number of branches unswitched in a single loop.
10217 @item max-loop-headers-insns
10218 The maximum number of insns in loop header duplicated by the copy loop headers
10219 pass.
10221 @item lim-expensive
10222 The minimum cost of an expensive expression in the loop invariant motion.
10224 @item iv-consider-all-candidates-bound
10225 Bound on number of candidates for induction variables, below which
10226 all candidates are considered for each use in induction variable
10227 optimizations.  If there are more candidates than this,
10228 only the most relevant ones are considered to avoid quadratic time complexity.
10230 @item iv-max-considered-uses
10231 The induction variable optimizations give up on loops that contain more
10232 induction variable uses.
10234 @item iv-always-prune-cand-set-bound
10235 If the number of candidates in the set is smaller than this value,
10236 always try to remove unnecessary ivs from the set
10237 when adding a new one.
10239 @item avg-loop-niter
10240 Average number of iterations of a loop.
10242 @item dse-max-object-size
10243 Maximum size (in bytes) of objects tracked bytewise by dead store elimination.
10244 Larger values may result in larger compilation times.
10246 @item scev-max-expr-size
10247 Bound on size of expressions used in the scalar evolutions analyzer.
10248 Large expressions slow the analyzer.
10250 @item scev-max-expr-complexity
10251 Bound on the complexity of the expressions in the scalar evolutions analyzer.
10252 Complex expressions slow the analyzer.
10254 @item max-tree-if-conversion-phi-args
10255 Maximum number of arguments in a PHI supported by TREE if conversion
10256 unless the loop is marked with simd pragma.
10258 @item vect-max-version-for-alignment-checks
10259 The maximum number of run-time checks that can be performed when
10260 doing loop versioning for alignment in the vectorizer.
10262 @item vect-max-version-for-alias-checks
10263 The maximum number of run-time checks that can be performed when
10264 doing loop versioning for alias in the vectorizer.
10266 @item vect-max-peeling-for-alignment
10267 The maximum number of loop peels to enhance access alignment
10268 for vectorizer. Value -1 means no limit.
10270 @item max-iterations-to-track
10271 The maximum number of iterations of a loop the brute-force algorithm
10272 for analysis of the number of iterations of the loop tries to evaluate.
10274 @item hot-bb-count-ws-permille
10275 A basic block profile count is considered hot if it contributes to 
10276 the given permillage (i.e. 0...1000) of the entire profiled execution.
10278 @item hot-bb-frequency-fraction
10279 Select fraction of the entry block frequency of executions of basic block in
10280 function given basic block needs to have to be considered hot.
10282 @item max-predicted-iterations
10283 The maximum number of loop iterations we predict statically.  This is useful
10284 in cases where a function contains a single loop with known bound and
10285 another loop with unknown bound.
10286 The known number of iterations is predicted correctly, while
10287 the unknown number of iterations average to roughly 10.  This means that the
10288 loop without bounds appears artificially cold relative to the other one.
10290 @item builtin-expect-probability
10291 Control the probability of the expression having the specified value. This
10292 parameter takes a percentage (i.e. 0 ... 100) as input.
10293 The default probability of 90 is obtained empirically.
10295 @item align-threshold
10297 Select fraction of the maximal frequency of executions of a basic block in
10298 a function to align the basic block.
10300 @item align-loop-iterations
10302 A loop expected to iterate at least the selected number of iterations is
10303 aligned.
10305 @item tracer-dynamic-coverage
10306 @itemx tracer-dynamic-coverage-feedback
10308 This value is used to limit superblock formation once the given percentage of
10309 executed instructions is covered.  This limits unnecessary code size
10310 expansion.
10312 The @option{tracer-dynamic-coverage-feedback} parameter
10313 is used only when profile
10314 feedback is available.  The real profiles (as opposed to statically estimated
10315 ones) are much less balanced allowing the threshold to be larger value.
10317 @item tracer-max-code-growth
10318 Stop tail duplication once code growth has reached given percentage.  This is
10319 a rather artificial limit, as most of the duplicates are eliminated later in
10320 cross jumping, so it may be set to much higher values than is the desired code
10321 growth.
10323 @item tracer-min-branch-ratio
10325 Stop reverse growth when the reverse probability of best edge is less than this
10326 threshold (in percent).
10328 @item tracer-min-branch-probability
10329 @itemx tracer-min-branch-probability-feedback
10331 Stop forward growth if the best edge has probability lower than this
10332 threshold.
10334 Similarly to @option{tracer-dynamic-coverage} two parameters are
10335 provided.  @option{tracer-min-branch-probability-feedback} is used for
10336 compilation with profile feedback and @option{tracer-min-branch-probability}
10337 compilation without.  The value for compilation with profile feedback
10338 needs to be more conservative (higher) in order to make tracer
10339 effective.
10341 @item stack-clash-protection-guard-size
10342 Specify the size of the operating system provided stack guard as
10343 2 raised to @var{num} bytes.  The default value is 12 (4096 bytes).
10344 Acceptable values are between 12 and 30.  Higher values may reduce the
10345 number of explicit probes, but a value larger than the operating system
10346 provided guard will leave code vulnerable to stack clash style attacks.
10348 @item stack-clash-protection-probe-interval
10349 Stack clash protection involves probing stack space as it is allocated.  This
10350 param controls the maximum distance between probes into the stack as 2 raised
10351 to @var{num} bytes.  Acceptable values are between 10 and 16 and defaults to
10352 12.  Higher values may reduce the number of explicit probes, but a value
10353 larger than the operating system provided guard will leave code vulnerable to
10354 stack clash style attacks.
10356 @item max-cse-path-length
10358 The maximum number of basic blocks on path that CSE considers.
10359 The default is 10.
10361 @item max-cse-insns
10362 The maximum number of instructions CSE processes before flushing.
10363 The default is 1000.
10365 @item ggc-min-expand
10367 GCC uses a garbage collector to manage its own memory allocation.  This
10368 parameter specifies the minimum percentage by which the garbage
10369 collector's heap should be allowed to expand between collections.
10370 Tuning this may improve compilation speed; it has no effect on code
10371 generation.
10373 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
10374 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
10375 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
10376 GCC is not able to calculate RAM on a particular platform, the lower
10377 bound of 30% is used.  Setting this parameter and
10378 @option{ggc-min-heapsize} to zero causes a full collection to occur at
10379 every opportunity.  This is extremely slow, but can be useful for
10380 debugging.
10382 @item ggc-min-heapsize
10384 Minimum size of the garbage collector's heap before it begins bothering
10385 to collect garbage.  The first collection occurs after the heap expands
10386 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
10387 tuning this may improve compilation speed, and has no effect on code
10388 generation.
10390 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
10391 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
10392 with a lower bound of 4096 (four megabytes) and an upper bound of
10393 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
10394 particular platform, the lower bound is used.  Setting this parameter
10395 very large effectively disables garbage collection.  Setting this
10396 parameter and @option{ggc-min-expand} to zero causes a full collection
10397 to occur at every opportunity.
10399 @item max-reload-search-insns
10400 The maximum number of instruction reload should look backward for equivalent
10401 register.  Increasing values mean more aggressive optimization, making the
10402 compilation time increase with probably slightly better performance.
10403 The default value is 100.
10405 @item max-cselib-memory-locations
10406 The maximum number of memory locations cselib should take into account.
10407 Increasing values mean more aggressive optimization, making the compilation time
10408 increase with probably slightly better performance.  The default value is 500.
10410 @item max-sched-ready-insns
10411 The maximum number of instructions ready to be issued the scheduler should
10412 consider at any given time during the first scheduling pass.  Increasing
10413 values mean more thorough searches, making the compilation time increase
10414 with probably little benefit.  The default value is 100.
10416 @item max-sched-region-blocks
10417 The maximum number of blocks in a region to be considered for
10418 interblock scheduling.  The default value is 10.
10420 @item max-pipeline-region-blocks
10421 The maximum number of blocks in a region to be considered for
10422 pipelining in the selective scheduler.  The default value is 15.
10424 @item max-sched-region-insns
10425 The maximum number of insns in a region to be considered for
10426 interblock scheduling.  The default value is 100.
10428 @item max-pipeline-region-insns
10429 The maximum number of insns in a region to be considered for
10430 pipelining in the selective scheduler.  The default value is 200.
10432 @item min-spec-prob
10433 The minimum probability (in percents) of reaching a source block
10434 for interblock speculative scheduling.  The default value is 40.
10436 @item max-sched-extend-regions-iters
10437 The maximum number of iterations through CFG to extend regions.
10438 A value of 0 (the default) disables region extensions.
10440 @item max-sched-insn-conflict-delay
10441 The maximum conflict delay for an insn to be considered for speculative motion.
10442 The default value is 3.
10444 @item sched-spec-prob-cutoff
10445 The minimal probability of speculation success (in percents), so that
10446 speculative insns are scheduled.
10447 The default value is 40.
10449 @item sched-state-edge-prob-cutoff
10450 The minimum probability an edge must have for the scheduler to save its
10451 state across it.
10452 The default value is 10.
10454 @item sched-mem-true-dep-cost
10455 Minimal distance (in CPU cycles) between store and load targeting same
10456 memory locations.  The default value is 1.
10458 @item selsched-max-lookahead
10459 The maximum size of the lookahead window of selective scheduling.  It is a
10460 depth of search for available instructions.
10461 The default value is 50.
10463 @item selsched-max-sched-times
10464 The maximum number of times that an instruction is scheduled during
10465 selective scheduling.  This is the limit on the number of iterations
10466 through which the instruction may be pipelined.  The default value is 2.
10468 @item selsched-insns-to-rename
10469 The maximum number of best instructions in the ready list that are considered
10470 for renaming in the selective scheduler.  The default value is 2.
10472 @item sms-min-sc
10473 The minimum value of stage count that swing modulo scheduler
10474 generates.  The default value is 2.
10476 @item max-last-value-rtl
10477 The maximum size measured as number of RTLs that can be recorded in an expression
10478 in combiner for a pseudo register as last known value of that register.  The default
10479 is 10000.
10481 @item max-combine-insns
10482 The maximum number of instructions the RTL combiner tries to combine.
10483 The default value is 2 at @option{-Og} and 4 otherwise.
10485 @item integer-share-limit
10486 Small integer constants can use a shared data structure, reducing the
10487 compiler's memory usage and increasing its speed.  This sets the maximum
10488 value of a shared integer constant.  The default value is 256.
10490 @item ssp-buffer-size
10491 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
10492 protection when @option{-fstack-protection} is used.
10494 @item min-size-for-stack-sharing
10495 The minimum size of variables taking part in stack slot sharing when not
10496 optimizing. The default value is 32.
10498 @item max-jump-thread-duplication-stmts
10499 Maximum number of statements allowed in a block that needs to be
10500 duplicated when threading jumps.
10502 @item max-fields-for-field-sensitive
10503 Maximum number of fields in a structure treated in
10504 a field sensitive manner during pointer analysis.  The default is zero
10505 for @option{-O0} and @option{-O1},
10506 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
10508 @item prefetch-latency
10509 Estimate on average number of instructions that are executed before
10510 prefetch finishes.  The distance prefetched ahead is proportional
10511 to this constant.  Increasing this number may also lead to less
10512 streams being prefetched (see @option{simultaneous-prefetches}).
10514 @item simultaneous-prefetches
10515 Maximum number of prefetches that can run at the same time.
10517 @item l1-cache-line-size
10518 The size of cache line in L1 cache, in bytes.
10520 @item l1-cache-size
10521 The size of L1 cache, in kilobytes.
10523 @item l2-cache-size
10524 The size of L2 cache, in kilobytes.
10526 @item loop-interchange-max-num-stmts
10527 The maximum number of stmts in a loop to be interchanged.
10529 @item loop-interchange-stride-ratio
10530 The minimum ratio between stride of two loops for interchange to be profitable.
10532 @item min-insn-to-prefetch-ratio
10533 The minimum ratio between the number of instructions and the
10534 number of prefetches to enable prefetching in a loop.
10536 @item prefetch-min-insn-to-mem-ratio
10537 The minimum ratio between the number of instructions and the
10538 number of memory references to enable prefetching in a loop.
10540 @item use-canonical-types
10541 Whether the compiler should use the ``canonical'' type system.  By
10542 default, this should always be 1, which uses a more efficient internal
10543 mechanism for comparing types in C++ and Objective-C++.  However, if
10544 bugs in the canonical type system are causing compilation failures,
10545 set this value to 0 to disable canonical types.
10547 @item switch-conversion-max-branch-ratio
10548 Switch initialization conversion refuses to create arrays that are
10549 bigger than @option{switch-conversion-max-branch-ratio} times the number of
10550 branches in the switch.
10552 @item max-partial-antic-length
10553 Maximum length of the partial antic set computed during the tree
10554 partial redundancy elimination optimization (@option{-ftree-pre}) when
10555 optimizing at @option{-O3} and above.  For some sorts of source code
10556 the enhanced partial redundancy elimination optimization can run away,
10557 consuming all of the memory available on the host machine.  This
10558 parameter sets a limit on the length of the sets that are computed,
10559 which prevents the runaway behavior.  Setting a value of 0 for
10560 this parameter allows an unlimited set length.
10562 @item sccvn-max-scc-size
10563 Maximum size of a strongly connected component (SCC) during SCCVN
10564 processing.  If this limit is hit, SCCVN processing for the whole
10565 function is not done and optimizations depending on it are
10566 disabled.  The default maximum SCC size is 10000.
10568 @item sccvn-max-alias-queries-per-access
10569 Maximum number of alias-oracle queries we perform when looking for
10570 redundancies for loads and stores.  If this limit is hit the search
10571 is aborted and the load or store is not considered redundant.  The
10572 number of queries is algorithmically limited to the number of
10573 stores on all paths from the load to the function entry.
10574 The default maximum number of queries is 1000.
10576 @item ira-max-loops-num
10577 IRA uses regional register allocation by default.  If a function
10578 contains more loops than the number given by this parameter, only at most
10579 the given number of the most frequently-executed loops form regions
10580 for regional register allocation.  The default value of the
10581 parameter is 100.
10583 @item ira-max-conflict-table-size 
10584 Although IRA uses a sophisticated algorithm to compress the conflict
10585 table, the table can still require excessive amounts of memory for
10586 huge functions.  If the conflict table for a function could be more
10587 than the size in MB given by this parameter, the register allocator
10588 instead uses a faster, simpler, and lower-quality
10589 algorithm that does not require building a pseudo-register conflict table.  
10590 The default value of the parameter is 2000.
10592 @item ira-loop-reserved-regs
10593 IRA can be used to evaluate more accurate register pressure in loops
10594 for decisions to move loop invariants (see @option{-O3}).  The number
10595 of available registers reserved for some other purposes is given
10596 by this parameter.  The default value of the parameter is 2, which is
10597 the minimal number of registers needed by typical instructions.
10598 This value is the best found from numerous experiments.
10600 @item lra-inheritance-ebb-probability-cutoff
10601 LRA tries to reuse values reloaded in registers in subsequent insns.
10602 This optimization is called inheritance.  EBB is used as a region to
10603 do this optimization.  The parameter defines a minimal fall-through
10604 edge probability in percentage used to add BB to inheritance EBB in
10605 LRA.  The default value of the parameter is 40.  The value was chosen
10606 from numerous runs of SPEC2000 on x86-64.
10608 @item loop-invariant-max-bbs-in-loop
10609 Loop invariant motion can be very expensive, both in compilation time and
10610 in amount of needed compile-time memory, with very large loops.  Loops
10611 with more basic blocks than this parameter won't have loop invariant
10612 motion optimization performed on them.  The default value of the
10613 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
10615 @item loop-max-datarefs-for-datadeps
10616 Building data dependencies is expensive for very large loops.  This
10617 parameter limits the number of data references in loops that are
10618 considered for data dependence analysis.  These large loops are no
10619 handled by the optimizations using loop data dependencies.
10620 The default value is 1000.
10622 @item max-vartrack-size
10623 Sets a maximum number of hash table slots to use during variable
10624 tracking dataflow analysis of any function.  If this limit is exceeded
10625 with variable tracking at assignments enabled, analysis for that
10626 function is retried without it, after removing all debug insns from
10627 the function.  If the limit is exceeded even without debug insns, var
10628 tracking analysis is completely disabled for the function.  Setting
10629 the parameter to zero makes it unlimited.
10631 @item max-vartrack-expr-depth
10632 Sets a maximum number of recursion levels when attempting to map
10633 variable names or debug temporaries to value expressions.  This trades
10634 compilation time for more complete debug information.  If this is set too
10635 low, value expressions that are available and could be represented in
10636 debug information may end up not being used; setting this higher may
10637 enable the compiler to find more complex debug expressions, but compile
10638 time and memory use may grow.  The default is 12.
10640 @item max-debug-marker-count
10641 Sets a threshold on the number of debug markers (e.g. begin stmt
10642 markers) to avoid complexity explosion at inlining or expanding to RTL.
10643 If a function has more such gimple stmts than the set limit, such stmts
10644 will be dropped from the inlined copy of a function, and from its RTL
10645 expansion.  The default is 100000.
10647 @item min-nondebug-insn-uid
10648 Use uids starting at this parameter for nondebug insns.  The range below
10649 the parameter is reserved exclusively for debug insns created by
10650 @option{-fvar-tracking-assignments}, but debug insns may get
10651 (non-overlapping) uids above it if the reserved range is exhausted.
10653 @item ipa-sra-ptr-growth-factor
10654 IPA-SRA replaces a pointer to an aggregate with one or more new
10655 parameters only when their cumulative size is less or equal to
10656 @option{ipa-sra-ptr-growth-factor} times the size of the original
10657 pointer parameter.
10659 @item sra-max-scalarization-size-Ospeed
10660 @item sra-max-scalarization-size-Osize
10661 The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to
10662 replace scalar parts of aggregates with uses of independent scalar
10663 variables.  These parameters control the maximum size, in storage units,
10664 of aggregate which is considered for replacement when compiling for
10665 speed
10666 (@option{sra-max-scalarization-size-Ospeed}) or size
10667 (@option{sra-max-scalarization-size-Osize}) respectively.
10669 @item tm-max-aggregate-size
10670 When making copies of thread-local variables in a transaction, this
10671 parameter specifies the size in bytes after which variables are
10672 saved with the logging functions as opposed to save/restore code
10673 sequence pairs.  This option only applies when using
10674 @option{-fgnu-tm}.
10676 @item graphite-max-nb-scop-params
10677 To avoid exponential effects in the Graphite loop transforms, the
10678 number of parameters in a Static Control Part (SCoP) is bounded.  The
10679 default value is 10 parameters, a value of zero can be used to lift
10680 the bound.  A variable whose value is unknown at compilation time and
10681 defined outside a SCoP is a parameter of the SCoP.
10683 @item loop-block-tile-size
10684 Loop blocking or strip mining transforms, enabled with
10685 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
10686 loop in the loop nest by a given number of iterations.  The strip
10687 length can be changed using the @option{loop-block-tile-size}
10688 parameter.  The default value is 51 iterations.
10690 @item loop-unroll-jam-size
10691 Specify the unroll factor for the @option{-floop-unroll-and-jam} option.  The 
10692 default value is 4.
10694 @item loop-unroll-jam-depth
10695 Specify the dimension to be unrolled (counting from the most inner loop)
10696 for the  @option{-floop-unroll-and-jam}.  The default value is 2.
10698 @item ipa-cp-value-list-size
10699 IPA-CP attempts to track all possible values and types passed to a function's
10700 parameter in order to propagate them and perform devirtualization.
10701 @option{ipa-cp-value-list-size} is the maximum number of values and types it
10702 stores per one formal parameter of a function.
10704 @item ipa-cp-eval-threshold
10705 IPA-CP calculates its own score of cloning profitability heuristics
10706 and performs those cloning opportunities with scores that exceed
10707 @option{ipa-cp-eval-threshold}.
10709 @item ipa-cp-recursion-penalty
10710 Percentage penalty the recursive functions will receive when they
10711 are evaluated for cloning.
10713 @item ipa-cp-single-call-penalty
10714 Percentage penalty functions containing a single call to another
10715 function will receive when they are evaluated for cloning.
10718 @item ipa-max-agg-items
10719 IPA-CP is also capable to propagate a number of scalar values passed
10720 in an aggregate. @option{ipa-max-agg-items} controls the maximum
10721 number of such values per one parameter.
10723 @item ipa-cp-loop-hint-bonus
10724 When IPA-CP determines that a cloning candidate would make the number
10725 of iterations of a loop known, it adds a bonus of
10726 @option{ipa-cp-loop-hint-bonus} to the profitability score of
10727 the candidate.
10729 @item ipa-cp-array-index-hint-bonus
10730 When IPA-CP determines that a cloning candidate would make the index of
10731 an array access known, it adds a bonus of
10732 @option{ipa-cp-array-index-hint-bonus} to the profitability
10733 score of the candidate.
10735 @item ipa-max-aa-steps
10736 During its analysis of function bodies, IPA-CP employs alias analysis
10737 in order to track values pointed to by function parameters.  In order
10738 not spend too much time analyzing huge functions, it gives up and
10739 consider all memory clobbered after examining
10740 @option{ipa-max-aa-steps} statements modifying memory.
10742 @item lto-partitions
10743 Specify desired number of partitions produced during WHOPR compilation.
10744 The number of partitions should exceed the number of CPUs used for compilation.
10745 The default value is 32.
10747 @item lto-min-partition
10748 Size of minimal partition for WHOPR (in estimated instructions).
10749 This prevents expenses of splitting very small programs into too many
10750 partitions.
10752 @item lto-max-partition
10753 Size of max partition for WHOPR (in estimated instructions).
10754 to provide an upper bound for individual size of partition.
10755 Meant to be used only with balanced partitioning.
10757 @item cxx-max-namespaces-for-diagnostic-help
10758 The maximum number of namespaces to consult for suggestions when C++
10759 name lookup fails for an identifier.  The default is 1000.
10761 @item sink-frequency-threshold
10762 The maximum relative execution frequency (in percents) of the target block
10763 relative to a statement's original block to allow statement sinking of a
10764 statement.  Larger numbers result in more aggressive statement sinking.
10765 The default value is 75.  A small positive adjustment is applied for
10766 statements with memory operands as those are even more profitable so sink.
10768 @item max-stores-to-sink
10769 The maximum number of conditional store pairs that can be sunk.  Set to 0
10770 if either vectorization (@option{-ftree-vectorize}) or if-conversion
10771 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
10773 @item allow-store-data-races
10774 Allow optimizers to introduce new data races on stores.
10775 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10776 at optimization level @option{-Ofast}.
10778 @item case-values-threshold
10779 The smallest number of different values for which it is best to use a
10780 jump-table instead of a tree of conditional branches.  If the value is
10781 0, use the default for the machine.  The default is 0.
10783 @item tree-reassoc-width
10784 Set the maximum number of instructions executed in parallel in
10785 reassociated tree. This parameter overrides target dependent
10786 heuristics used by default if has non zero value.
10788 @item sched-pressure-algorithm
10789 Choose between the two available implementations of
10790 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
10791 and is the more likely to prevent instructions from being reordered.
10792 Algorithm 2 was designed to be a compromise between the relatively
10793 conservative approach taken by algorithm 1 and the rather aggressive
10794 approach taken by the default scheduler.  It relies more heavily on
10795 having a regular register file and accurate register pressure classes.
10796 See @file{haifa-sched.c} in the GCC sources for more details.
10798 The default choice depends on the target.
10800 @item max-slsr-cand-scan
10801 Set the maximum number of existing candidates that are considered when
10802 seeking a basis for a new straight-line strength reduction candidate.
10804 @item asan-globals
10805 Enable buffer overflow detection for global objects.  This kind
10806 of protection is enabled by default if you are using
10807 @option{-fsanitize=address} option.
10808 To disable global objects protection use @option{--param asan-globals=0}.
10810 @item asan-stack
10811 Enable buffer overflow detection for stack objects.  This kind of
10812 protection is enabled by default when using @option{-fsanitize=address}.
10813 To disable stack protection use @option{--param asan-stack=0} option.
10815 @item asan-instrument-reads
10816 Enable buffer overflow detection for memory reads.  This kind of
10817 protection is enabled by default when using @option{-fsanitize=address}.
10818 To disable memory reads protection use
10819 @option{--param asan-instrument-reads=0}.
10821 @item asan-instrument-writes
10822 Enable buffer overflow detection for memory writes.  This kind of
10823 protection is enabled by default when using @option{-fsanitize=address}.
10824 To disable memory writes protection use
10825 @option{--param asan-instrument-writes=0} option.
10827 @item asan-memintrin
10828 Enable detection for built-in functions.  This kind of protection
10829 is enabled by default when using @option{-fsanitize=address}.
10830 To disable built-in functions protection use
10831 @option{--param asan-memintrin=0}.
10833 @item asan-use-after-return
10834 Enable detection of use-after-return.  This kind of protection
10835 is enabled by default when using the @option{-fsanitize=address} option.
10836 To disable it use @option{--param asan-use-after-return=0}.
10838 Note: By default the check is disabled at run time.  To enable it,
10839 add @code{detect_stack_use_after_return=1} to the environment variable
10840 @env{ASAN_OPTIONS}.
10842 @item asan-instrumentation-with-call-threshold
10843 If number of memory accesses in function being instrumented
10844 is greater or equal to this number, use callbacks instead of inline checks.
10845 E.g. to disable inline code use
10846 @option{--param asan-instrumentation-with-call-threshold=0}.
10848 @item use-after-scope-direct-emission-threshold
10849 If the size of a local variable in bytes is smaller or equal to this
10850 number, directly poison (or unpoison) shadow memory instead of using
10851 run-time callbacks.  The default value is 256.
10853 @item chkp-max-ctor-size
10854 Static constructors generated by Pointer Bounds Checker may become very
10855 large and significantly increase compile time at optimization level
10856 @option{-O1} and higher.  This parameter is a maximum number of statements
10857 in a single generated constructor.  Default value is 5000.
10859 @item max-fsm-thread-path-insns
10860 Maximum number of instructions to copy when duplicating blocks on a
10861 finite state automaton jump thread path.  The default is 100.
10863 @item max-fsm-thread-length
10864 Maximum number of basic blocks on a finite state automaton jump thread
10865 path.  The default is 10.
10867 @item max-fsm-thread-paths
10868 Maximum number of new jump thread paths to create for a finite state
10869 automaton.  The default is 50.
10871 @item parloops-chunk-size
10872 Chunk size of omp schedule for loops parallelized by parloops.  The default
10873 is 0.
10875 @item parloops-schedule
10876 Schedule type of omp schedule for loops parallelized by parloops (static,
10877 dynamic, guided, auto, runtime).  The default is static.
10879 @item parloops-min-per-thread
10880 The minimum number of iterations per thread of an innermost parallelized
10881 loop for which the parallelized variant is prefered over the single threaded
10882 one.  The default is 100.  Note that for a parallelized loop nest the
10883 minimum number of iterations of the outermost loop per thread is two.
10885 @item max-ssa-name-query-depth
10886 Maximum depth of recursion when querying properties of SSA names in things
10887 like fold routines.  One level of recursion corresponds to following a
10888 use-def chain.
10890 @item hsa-gen-debug-stores
10891 Enable emission of special debug stores within HSA kernels which are
10892 then read and reported by libgomp plugin.  Generation of these stores
10893 is disabled by default, use @option{--param hsa-gen-debug-stores=1} to
10894 enable it.
10896 @item max-speculative-devirt-maydefs
10897 The maximum number of may-defs we analyze when looking for a must-def
10898 specifying the dynamic type of an object that invokes a virtual call
10899 we may be able to devirtualize speculatively.
10901 @item max-vrp-switch-assertions
10902 The maximum number of assertions to add along the default edge of a switch
10903 statement during VRP.  The default is 10.
10905 @item unroll-jam-min-percent
10906 The minimum percentage of memory references that must be optimized
10907 away for the unroll-and-jam transformation to be considered profitable.
10909 @item unroll-jam-max-unroll
10910 The maximum number of times the outer loop should be unrolled by
10911 the unroll-and-jam transformation.
10912 @end table
10913 @end table
10915 @node Instrumentation Options
10916 @section Program Instrumentation Options
10917 @cindex instrumentation options
10918 @cindex program instrumentation options
10919 @cindex run-time error checking options
10920 @cindex profiling options
10921 @cindex options, program instrumentation
10922 @cindex options, run-time error checking
10923 @cindex options, profiling
10925 GCC supports a number of command-line options that control adding
10926 run-time instrumentation to the code it normally generates.  
10927 For example, one purpose of instrumentation is collect profiling
10928 statistics for use in finding program hot spots, code coverage
10929 analysis, or profile-guided optimizations.
10930 Another class of program instrumentation is adding run-time checking 
10931 to detect programming errors like invalid pointer
10932 dereferences or out-of-bounds array accesses, as well as deliberately
10933 hostile attacks such as stack smashing or C++ vtable hijacking.
10934 There is also a general hook which can be used to implement other
10935 forms of tracing or function-level instrumentation for debug or
10936 program analysis purposes.
10938 @table @gcctabopt
10939 @cindex @command{prof}
10940 @item -p
10941 @opindex p
10942 Generate extra code to write profile information suitable for the
10943 analysis program @command{prof}.  You must use this option when compiling
10944 the source files you want data about, and you must also use it when
10945 linking.
10947 @cindex @command{gprof}
10948 @item -pg
10949 @opindex pg
10950 Generate extra code to write profile information suitable for the
10951 analysis program @command{gprof}.  You must use this option when compiling
10952 the source files you want data about, and you must also use it when
10953 linking.
10955 @item -fprofile-arcs
10956 @opindex fprofile-arcs
10957 Add code so that program flow @dfn{arcs} are instrumented.  During
10958 execution the program records how many times each branch and call is
10959 executed and how many times it is taken or returns.  On targets that support
10960 constructors with priority support, profiling properly handles constructors,
10961 destructors and C++ constructors (and destructors) of classes which are used
10962 as a type of a global variable.
10964 When the compiled
10965 program exits it saves this data to a file called
10966 @file{@var{auxname}.gcda} for each source file.  The data may be used for
10967 profile-directed optimizations (@option{-fbranch-probabilities}), or for
10968 test coverage analysis (@option{-ftest-coverage}).  Each object file's
10969 @var{auxname} is generated from the name of the output file, if
10970 explicitly specified and it is not the final executable, otherwise it is
10971 the basename of the source file.  In both cases any suffix is removed
10972 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
10973 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
10974 @xref{Cross-profiling}.
10976 @cindex @command{gcov}
10977 @item --coverage
10978 @opindex coverage
10980 This option is used to compile and link code instrumented for coverage
10981 analysis.  The option is a synonym for @option{-fprofile-arcs}
10982 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
10983 linking).  See the documentation for those options for more details.
10985 @itemize
10987 @item
10988 Compile the source files with @option{-fprofile-arcs} plus optimization
10989 and code generation options.  For test coverage analysis, use the
10990 additional @option{-ftest-coverage} option.  You do not need to profile
10991 every source file in a program.
10993 @item
10994 Compile the source files additionally with @option{-fprofile-abs-path}
10995 to create absolute path names in the @file{.gcno} files.  This allows
10996 @command{gcov} to find the correct sources in projects where compilations
10997 occur with different working directories.
10999 @item
11000 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
11001 (the latter implies the former).
11003 @item
11004 Run the program on a representative workload to generate the arc profile
11005 information.  This may be repeated any number of times.  You can run
11006 concurrent instances of your program, and provided that the file system
11007 supports locking, the data files will be correctly updated.  Unless
11008 a strict ISO C dialect option is in effect, @code{fork} calls are
11009 detected and correctly handled without double counting.
11011 @item
11012 For profile-directed optimizations, compile the source files again with
11013 the same optimization and code generation options plus
11014 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
11015 Control Optimization}).
11017 @item
11018 For test coverage analysis, use @command{gcov} to produce human readable
11019 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
11020 @command{gcov} documentation for further information.
11022 @end itemize
11024 With @option{-fprofile-arcs}, for each function of your program GCC
11025 creates a program flow graph, then finds a spanning tree for the graph.
11026 Only arcs that are not on the spanning tree have to be instrumented: the
11027 compiler adds code to count the number of times that these arcs are
11028 executed.  When an arc is the only exit or only entrance to a block, the
11029 instrumentation code can be added to the block; otherwise, a new basic
11030 block must be created to hold the instrumentation code.
11032 @need 2000
11033 @item -ftest-coverage
11034 @opindex ftest-coverage
11035 Produce a notes file that the @command{gcov} code-coverage utility
11036 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
11037 show program coverage.  Each source file's note file is called
11038 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
11039 above for a description of @var{auxname} and instructions on how to
11040 generate test coverage data.  Coverage data matches the source files
11041 more closely if you do not optimize.
11043 @item -fprofile-abs-path
11044 @opindex fprofile-abs-path
11045 Automatically convert relative source file names to absolute path names
11046 in the @file{.gcno} files.  This allows @command{gcov} to find the correct
11047 sources in projects where compilations occur with different working
11048 directories.
11050 @item -fprofile-dir=@var{path}
11051 @opindex fprofile-dir
11053 Set the directory to search for the profile data files in to @var{path}.
11054 This option affects only the profile data generated by
11055 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
11056 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
11057 and its related options.  Both absolute and relative paths can be used.
11058 By default, GCC uses the current directory as @var{path}, thus the
11059 profile data file appears in the same directory as the object file.
11061 @item -fprofile-generate
11062 @itemx -fprofile-generate=@var{path}
11063 @opindex fprofile-generate
11065 Enable options usually used for instrumenting application to produce
11066 profile useful for later recompilation with profile feedback based
11067 optimization.  You must use @option{-fprofile-generate} both when
11068 compiling and when linking your program.
11070 The following options are enabled: @option{-fprofile-arcs}, @option{-fprofile-values}, @option{-fvpt}.
11072 If @var{path} is specified, GCC looks at the @var{path} to find
11073 the profile feedback data files. See @option{-fprofile-dir}.
11075 To optimize the program based on the collected profile information, use
11076 @option{-fprofile-use}.  @xref{Optimize Options}, for more information.
11078 @item -fprofile-update=@var{method}
11079 @opindex fprofile-update
11081 Alter the update method for an application instrumented for profile
11082 feedback based optimization.  The @var{method} argument should be one of
11083 @samp{single}, @samp{atomic} or @samp{prefer-atomic}.
11084 The first one is useful for single-threaded applications,
11085 while the second one prevents profile corruption by emitting thread-safe code.
11087 @strong{Warning:} When an application does not properly join all threads
11088 (or creates an detached thread), a profile file can be still corrupted.
11090 Using @samp{prefer-atomic} would be transformed either to @samp{atomic},
11091 when supported by a target, or to @samp{single} otherwise.  The GCC driver
11092 automatically selects @samp{prefer-atomic} when @option{-pthread}
11093 is present in the command line.
11095 @item -fsanitize=address
11096 @opindex fsanitize=address
11097 Enable AddressSanitizer, a fast memory error detector.
11098 Memory access instructions are instrumented to detect
11099 out-of-bounds and use-after-free bugs.
11100 The option enables @option{-fsanitize-address-use-after-scope}.
11101 See @uref{https://github.com/google/sanitizers/wiki/AddressSanitizer} for
11102 more details.  The run-time behavior can be influenced using the
11103 @env{ASAN_OPTIONS} environment variable.  When set to @code{help=1},
11104 the available options are shown at startup of the instrumented program.  See
11105 @url{https://github.com/google/sanitizers/wiki/AddressSanitizerFlags#run-time-flags}
11106 for a list of supported options.
11107 The option cannot be combined with @option{-fsanitize=thread}
11108 and/or @option{-fcheck-pointer-bounds}.
11110 @item -fsanitize=kernel-address
11111 @opindex fsanitize=kernel-address
11112 Enable AddressSanitizer for Linux kernel.
11113 See @uref{https://github.com/google/kasan/wiki} for more details.
11114 The option cannot be combined with @option{-fcheck-pointer-bounds}.
11116 @item -fsanitize=pointer-compare
11117 @opindex fsanitize=pointer-compare
11118 Instrument comparison operation (<, <=, >, >=) with pointer operands.
11119 The option must be combined with either @option{-fsanitize=kernel-address} or
11120 @option{-fsanitize=address}
11121 The option cannot be combined with @option{-fsanitize=thread}
11122 and/or @option{-fcheck-pointer-bounds}.
11123 Note: By default the check is disabled at run time.  To enable it,
11124 add @code{detect_invalid_pointer_pairs=1} to the environment variable
11125 @env{ASAN_OPTIONS}.
11127 @item -fsanitize=pointer-subtract
11128 @opindex fsanitize=pointer-subtract
11129 Instrument subtraction with pointer operands.
11130 The option must be combined with either @option{-fsanitize=kernel-address} or
11131 @option{-fsanitize=address}
11132 The option cannot be combined with @option{-fsanitize=thread}
11133 and/or @option{-fcheck-pointer-bounds}.
11134 Note: By default the check is disabled at run time.  To enable it,
11135 add @code{detect_invalid_pointer_pairs=1} to the environment variable
11136 @env{ASAN_OPTIONS}.
11138 @item -fsanitize=thread
11139 @opindex fsanitize=thread
11140 Enable ThreadSanitizer, a fast data race detector.
11141 Memory access instructions are instrumented to detect
11142 data race bugs.  See @uref{https://github.com/google/sanitizers/wiki#threadsanitizer} for more
11143 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
11144 environment variable; see
11145 @url{https://github.com/google/sanitizers/wiki/ThreadSanitizerFlags} for a list of
11146 supported options.
11147 The option cannot be combined with @option{-fsanitize=address},
11148 @option{-fsanitize=leak} and/or @option{-fcheck-pointer-bounds}.
11150 Note that sanitized atomic builtins cannot throw exceptions when
11151 operating on invalid memory addresses with non-call exceptions
11152 (@option{-fnon-call-exceptions}).
11154 @item -fsanitize=leak
11155 @opindex fsanitize=leak
11156 Enable LeakSanitizer, a memory leak detector.
11157 This option only matters for linking of executables and
11158 the executable is linked against a library that overrides @code{malloc}
11159 and other allocator functions.  See
11160 @uref{https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer} for more
11161 details.  The run-time behavior can be influenced using the
11162 @env{LSAN_OPTIONS} environment variable.
11163 The option cannot be combined with @option{-fsanitize=thread}.
11165 @item -fsanitize=undefined
11166 @opindex fsanitize=undefined
11167 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
11168 Various computations are instrumented to detect undefined behavior
11169 at runtime.  Current suboptions are:
11171 @table @gcctabopt
11173 @item -fsanitize=shift
11174 @opindex fsanitize=shift
11175 This option enables checking that the result of a shift operation is
11176 not undefined.  Note that what exactly is considered undefined differs
11177 slightly between C and C++, as well as between ISO C90 and C99, etc.
11178 This option has two suboptions, @option{-fsanitize=shift-base} and
11179 @option{-fsanitize=shift-exponent}.
11181 @item -fsanitize=shift-exponent
11182 @opindex fsanitize=shift-exponent
11183 This option enables checking that the second argument of a shift operation
11184 is not negative and is smaller than the precision of the promoted first
11185 argument.
11187 @item -fsanitize=shift-base
11188 @opindex fsanitize=shift-base
11189 If the second argument of a shift operation is within range, check that the
11190 result of a shift operation is not undefined.  Note that what exactly is
11191 considered undefined differs slightly between C and C++, as well as between
11192 ISO C90 and C99, etc.
11194 @item -fsanitize=integer-divide-by-zero
11195 @opindex fsanitize=integer-divide-by-zero
11196 Detect integer division by zero as well as @code{INT_MIN / -1} division.
11198 @item -fsanitize=unreachable
11199 @opindex fsanitize=unreachable
11200 With this option, the compiler turns the @code{__builtin_unreachable}
11201 call into a diagnostics message call instead.  When reaching the
11202 @code{__builtin_unreachable} call, the behavior is undefined.
11204 @item -fsanitize=vla-bound
11205 @opindex fsanitize=vla-bound
11206 This option instructs the compiler to check that the size of a variable
11207 length array is positive.
11209 @item -fsanitize=null
11210 @opindex fsanitize=null
11211 This option enables pointer checking.  Particularly, the application
11212 built with this option turned on will issue an error message when it
11213 tries to dereference a NULL pointer, or if a reference (possibly an
11214 rvalue reference) is bound to a NULL pointer, or if a method is invoked
11215 on an object pointed by a NULL pointer.
11217 @item -fsanitize=return
11218 @opindex fsanitize=return
11219 This option enables return statement checking.  Programs
11220 built with this option turned on will issue an error message
11221 when the end of a non-void function is reached without actually
11222 returning a value.  This option works in C++ only.
11224 @item -fsanitize=signed-integer-overflow
11225 @opindex fsanitize=signed-integer-overflow
11226 This option enables signed integer overflow checking.  We check that
11227 the result of @code{+}, @code{*}, and both unary and binary @code{-}
11228 does not overflow in the signed arithmetics.  Note, integer promotion
11229 rules must be taken into account.  That is, the following is not an
11230 overflow:
11231 @smallexample
11232 signed char a = SCHAR_MAX;
11233 a++;
11234 @end smallexample
11236 @item -fsanitize=bounds
11237 @opindex fsanitize=bounds
11238 This option enables instrumentation of array bounds.  Various out of bounds
11239 accesses are detected.  Flexible array members, flexible array member-like
11240 arrays, and initializers of variables with static storage are not instrumented.
11241 The option cannot be combined with @option{-fcheck-pointer-bounds}.
11243 @item -fsanitize=bounds-strict
11244 @opindex fsanitize=bounds-strict
11245 This option enables strict instrumentation of array bounds.  Most out of bounds
11246 accesses are detected, including flexible array members and flexible array
11247 member-like arrays.  Initializers of variables with static storage are not
11248 instrumented.  The option cannot be combined
11249 with @option{-fcheck-pointer-bounds}.
11251 @item -fsanitize=alignment
11252 @opindex fsanitize=alignment
11254 This option enables checking of alignment of pointers when they are
11255 dereferenced, or when a reference is bound to insufficiently aligned target,
11256 or when a method or constructor is invoked on insufficiently aligned object.
11258 @item -fsanitize=object-size
11259 @opindex fsanitize=object-size
11260 This option enables instrumentation of memory references using the
11261 @code{__builtin_object_size} function.  Various out of bounds pointer
11262 accesses are detected.
11264 @item -fsanitize=float-divide-by-zero
11265 @opindex fsanitize=float-divide-by-zero
11266 Detect floating-point division by zero.  Unlike other similar options,
11267 @option{-fsanitize=float-divide-by-zero} is not enabled by
11268 @option{-fsanitize=undefined}, since floating-point division by zero can
11269 be a legitimate way of obtaining infinities and NaNs.
11271 @item -fsanitize=float-cast-overflow
11272 @opindex fsanitize=float-cast-overflow
11273 This option enables floating-point type to integer conversion checking.
11274 We check that the result of the conversion does not overflow.
11275 Unlike other similar options, @option{-fsanitize=float-cast-overflow} is
11276 not enabled by @option{-fsanitize=undefined}.
11277 This option does not work well with @code{FE_INVALID} exceptions enabled.
11279 @item -fsanitize=nonnull-attribute
11280 @opindex fsanitize=nonnull-attribute
11282 This option enables instrumentation of calls, checking whether null values
11283 are not passed to arguments marked as requiring a non-null value by the
11284 @code{nonnull} function attribute.
11286 @item -fsanitize=returns-nonnull-attribute
11287 @opindex fsanitize=returns-nonnull-attribute
11289 This option enables instrumentation of return statements in functions
11290 marked with @code{returns_nonnull} function attribute, to detect returning
11291 of null values from such functions.
11293 @item -fsanitize=bool
11294 @opindex fsanitize=bool
11296 This option enables instrumentation of loads from bool.  If a value other
11297 than 0/1 is loaded, a run-time error is issued.
11299 @item -fsanitize=enum
11300 @opindex fsanitize=enum
11302 This option enables instrumentation of loads from an enum type.  If
11303 a value outside the range of values for the enum type is loaded,
11304 a run-time error is issued.
11306 @item -fsanitize=vptr
11307 @opindex fsanitize=vptr
11309 This option enables instrumentation of C++ member function calls, member
11310 accesses and some conversions between pointers to base and derived classes,
11311 to verify the referenced object has the correct dynamic type.
11313 @item -fsanitize=pointer-overflow
11314 @opindex fsanitize=pointer-overflow
11316 This option enables instrumentation of pointer arithmetics.  If the pointer
11317 arithmetics overflows, a run-time error is issued.
11319 @item -fsanitize=builtin
11320 @opindex fsanitize=builtin
11322 This option enables instrumentation of arguments to selected builtin
11323 functions.  If an invalid value is passed to such arguments, a run-time
11324 error is issued.  E.g.@ passing 0 as the argument to @code{__builtin_ctz}
11325 or @code{__builtin_clz} invokes undefined behavior and is diagnosed
11326 by this option.
11328 @end table
11330 While @option{-ftrapv} causes traps for signed overflows to be emitted,
11331 @option{-fsanitize=undefined} gives a diagnostic message.
11332 This currently works only for the C family of languages.
11334 @item -fno-sanitize=all
11335 @opindex fno-sanitize=all
11337 This option disables all previously enabled sanitizers.
11338 @option{-fsanitize=all} is not allowed, as some sanitizers cannot be used
11339 together.
11341 @item -fasan-shadow-offset=@var{number}
11342 @opindex fasan-shadow-offset
11343 This option forces GCC to use custom shadow offset in AddressSanitizer checks.
11344 It is useful for experimenting with different shadow memory layouts in
11345 Kernel AddressSanitizer.
11347 @item -fsanitize-sections=@var{s1},@var{s2},...
11348 @opindex fsanitize-sections
11349 Sanitize global variables in selected user-defined sections.  @var{si} may
11350 contain wildcards.
11352 @item -fsanitize-recover@r{[}=@var{opts}@r{]}
11353 @opindex fsanitize-recover
11354 @opindex fno-sanitize-recover
11355 @option{-fsanitize-recover=} controls error recovery mode for sanitizers
11356 mentioned in comma-separated list of @var{opts}.  Enabling this option
11357 for a sanitizer component causes it to attempt to continue
11358 running the program as if no error happened.  This means multiple
11359 runtime errors can be reported in a single program run, and the exit
11360 code of the program may indicate success even when errors
11361 have been reported.  The @option{-fno-sanitize-recover=} option
11362 can be used to alter
11363 this behavior: only the first detected error is reported
11364 and program then exits with a non-zero exit code.
11366 Currently this feature only works for @option{-fsanitize=undefined} (and its suboptions
11367 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return}),
11368 @option{-fsanitize=float-cast-overflow}, @option{-fsanitize=float-divide-by-zero},
11369 @option{-fsanitize=bounds-strict},
11370 @option{-fsanitize=kernel-address} and @option{-fsanitize=address}.
11371 For these sanitizers error recovery is turned on by default,
11372 except @option{-fsanitize=address}, for which this feature is experimental.
11373 @option{-fsanitize-recover=all} and @option{-fno-sanitize-recover=all} is also
11374 accepted, the former enables recovery for all sanitizers that support it,
11375 the latter disables recovery for all sanitizers that support it.
11377 Even if a recovery mode is turned on the compiler side, it needs to be also
11378 enabled on the runtime library side, otherwise the failures are still fatal.
11379 The runtime library defaults to @code{halt_on_error=0} for
11380 ThreadSanitizer and UndefinedBehaviorSanitizer, while default value for
11381 AddressSanitizer is @code{halt_on_error=1}. This can be overridden through
11382 setting the @code{halt_on_error} flag in the corresponding environment variable.
11384 Syntax without an explicit @var{opts} parameter is deprecated.  It is
11385 equivalent to specifying an @var{opts} list of:
11387 @smallexample
11388 undefined,float-cast-overflow,float-divide-by-zero,bounds-strict
11389 @end smallexample
11391 @item -fsanitize-address-use-after-scope
11392 @opindex fsanitize-address-use-after-scope
11393 Enable sanitization of local variables to detect use-after-scope bugs.
11394 The option sets @option{-fstack-reuse} to @samp{none}.
11396 @item -fsanitize-undefined-trap-on-error
11397 @opindex fsanitize-undefined-trap-on-error
11398 The @option{-fsanitize-undefined-trap-on-error} option instructs the compiler to
11399 report undefined behavior using @code{__builtin_trap} rather than
11400 a @code{libubsan} library routine.  The advantage of this is that the
11401 @code{libubsan} library is not needed and is not linked in, so this
11402 is usable even in freestanding environments.
11404 @item -fsanitize-coverage=trace-pc
11405 @opindex fsanitize-coverage=trace-pc
11406 Enable coverage-guided fuzzing code instrumentation.
11407 Inserts a call to @code{__sanitizer_cov_trace_pc} into every basic block.
11409 @item -fsanitize-coverage=trace-cmp
11410 @opindex fsanitize-coverage=trace-cmp
11411 Enable dataflow guided fuzzing code instrumentation.
11412 Inserts a call to @code{__sanitizer_cov_trace_cmp1},
11413 @code{__sanitizer_cov_trace_cmp2}, @code{__sanitizer_cov_trace_cmp4} or
11414 @code{__sanitizer_cov_trace_cmp8} for integral comparison with both operands
11415 variable or @code{__sanitizer_cov_trace_const_cmp1},
11416 @code{__sanitizer_cov_trace_const_cmp2},
11417 @code{__sanitizer_cov_trace_const_cmp4} or
11418 @code{__sanitizer_cov_trace_const_cmp8} for integral comparison with one
11419 operand constant, @code{__sanitizer_cov_trace_cmpf} or
11420 @code{__sanitizer_cov_trace_cmpd} for float or double comparisons and
11421 @code{__sanitizer_cov_trace_switch} for switch statements.
11423 @item -fbounds-check
11424 @opindex fbounds-check
11425 For front ends that support it, generate additional code to check that
11426 indices used to access arrays are within the declared range.  This is
11427 currently only supported by the Fortran front end, where this option
11428 defaults to false.
11430 @item -fcheck-pointer-bounds
11431 @opindex fcheck-pointer-bounds
11432 @opindex fno-check-pointer-bounds
11433 @cindex Pointer Bounds Checker options
11434 Enable Pointer Bounds Checker instrumentation.  Each memory reference
11435 is instrumented with checks of the pointer used for memory access against
11436 bounds associated with that pointer.  
11438 Currently there
11439 is only an implementation for Intel MPX available, thus x86 GNU/Linux target
11440 and @option{-mmpx} are required to enable this feature.  
11441 MPX-based instrumentation requires
11442 a runtime library to enable MPX in hardware and handle bounds
11443 violation signals.  By default when @option{-fcheck-pointer-bounds}
11444 and @option{-mmpx} options are used to link a program, the GCC driver
11445 links against the @file{libmpx} and @file{libmpxwrappers} libraries.
11446 Bounds checking on calls to dynamic libraries requires a linker
11447 with @option{-z bndplt} support; if GCC was configured with a linker
11448 without support for this option (including the Gold linker and older
11449 versions of ld), a warning is given if you link with @option{-mmpx}
11450 without also specifying @option{-static}, since the overall effectiveness
11451 of the bounds checking protection is reduced.
11452 See also @option{-static-libmpxwrappers}.
11454 MPX-based instrumentation
11455 may be used for debugging and also may be included in production code
11456 to increase program security.  Depending on usage, you may
11457 have different requirements for the runtime library.  The current version
11458 of the MPX runtime library is more oriented for use as a debugging
11459 tool.  MPX runtime library usage implies @option{-lpthread}.  See
11460 also @option{-static-libmpx}.  The runtime library  behavior can be
11461 influenced using various @env{CHKP_RT_*} environment variables.  See
11462 @uref{https://gcc.gnu.org/wiki/Intel%20MPX%20support%20in%20the%20GCC%20compiler}
11463 for more details.
11465 Generated instrumentation may be controlled by various
11466 @option{-fchkp-*} options and by the @code{bnd_variable_size}
11467 structure field attribute (@pxref{Type Attributes}) and
11468 @code{bnd_legacy}, and @code{bnd_instrument} function attributes
11469 (@pxref{Function Attributes}).  GCC also provides a number of built-in
11470 functions for controlling the Pointer Bounds Checker.  @xref{Pointer
11471 Bounds Checker builtins}, for more information.
11473 @item -fchkp-check-incomplete-type
11474 @opindex fchkp-check-incomplete-type
11475 @opindex fno-chkp-check-incomplete-type
11476 Generate pointer bounds checks for variables with incomplete type.
11477 Enabled by default.
11479 @item -fchkp-narrow-bounds
11480 @opindex fchkp-narrow-bounds
11481 @opindex fno-chkp-narrow-bounds
11482 Controls bounds used by Pointer Bounds Checker for pointers to object
11483 fields.  If narrowing is enabled then field bounds are used.  Otherwise
11484 object bounds are used.  See also @option{-fchkp-narrow-to-innermost-array}
11485 and @option{-fchkp-first-field-has-own-bounds}.  Enabled by default.
11487 @item -fchkp-first-field-has-own-bounds
11488 @opindex fchkp-first-field-has-own-bounds
11489 @opindex fno-chkp-first-field-has-own-bounds
11490 Forces Pointer Bounds Checker to use narrowed bounds for the address of the
11491 first field in the structure.  By default a pointer to the first field has
11492 the same bounds as a pointer to the whole structure.
11494 @item -fchkp-flexible-struct-trailing-arrays
11495 @opindex fchkp-flexible-struct-trailing-arrays
11496 @opindex fno-chkp-flexible-struct-trailing-arrays
11497 Forces Pointer Bounds Checker to treat all trailing arrays in structures as
11498 possibly flexible.  By default only array fields with zero length or that are
11499 marked with attribute bnd_variable_size are treated as flexible.
11501 @item -fchkp-narrow-to-innermost-array
11502 @opindex fchkp-narrow-to-innermost-array
11503 @opindex fno-chkp-narrow-to-innermost-array
11504 Forces Pointer Bounds Checker to use bounds of the innermost arrays in
11505 case of nested static array access.  By default this option is disabled and
11506 bounds of the outermost array are used.
11508 @item -fchkp-optimize
11509 @opindex fchkp-optimize
11510 @opindex fno-chkp-optimize
11511 Enables Pointer Bounds Checker optimizations.  Enabled by default at
11512 optimization levels @option{-O}, @option{-O2}, @option{-O3}.
11514 @item -fchkp-use-fast-string-functions
11515 @opindex fchkp-use-fast-string-functions
11516 @opindex fno-chkp-use-fast-string-functions
11517 Enables use of @code{*_nobnd} versions of string functions (not copying bounds)
11518 by Pointer Bounds Checker.  Disabled by default.
11520 @item -fchkp-use-nochk-string-functions
11521 @opindex fchkp-use-nochk-string-functions
11522 @opindex fno-chkp-use-nochk-string-functions
11523 Enables use of @code{*_nochk} versions of string functions (not checking bounds)
11524 by Pointer Bounds Checker.  Disabled by default.
11526 @item -fchkp-use-static-bounds
11527 @opindex fchkp-use-static-bounds
11528 @opindex fno-chkp-use-static-bounds
11529 Allow Pointer Bounds Checker to generate static bounds holding
11530 bounds of static variables.  Enabled by default.
11532 @item -fchkp-use-static-const-bounds
11533 @opindex fchkp-use-static-const-bounds
11534 @opindex fno-chkp-use-static-const-bounds
11535 Use statically-initialized bounds for constant bounds instead of
11536 generating them each time they are required.  By default enabled when
11537 @option{-fchkp-use-static-bounds} is enabled.
11539 @item -fchkp-treat-zero-dynamic-size-as-infinite
11540 @opindex fchkp-treat-zero-dynamic-size-as-infinite
11541 @opindex fno-chkp-treat-zero-dynamic-size-as-infinite
11542 With this option, objects with incomplete type whose
11543 dynamically-obtained size is zero are treated as having infinite size
11544 instead by Pointer Bounds
11545 Checker.  This option may be helpful if a program is linked with a library
11546 missing size information for some symbols.  Disabled by default.
11548 @item -fchkp-check-read
11549 @opindex fchkp-check-read
11550 @opindex fno-chkp-check-read
11551 Instructs Pointer Bounds Checker to generate checks for all read
11552 accesses to memory.  Enabled by default.
11554 @item -fchkp-check-write
11555 @opindex fchkp-check-write
11556 @opindex fno-chkp-check-write
11557 Instructs Pointer Bounds Checker to generate checks for all write
11558 accesses to memory.  Enabled by default.
11560 @item -fchkp-store-bounds
11561 @opindex fchkp-store-bounds
11562 @opindex fno-chkp-store-bounds
11563 Instructs Pointer Bounds Checker to generate bounds stores for
11564 pointer writes.  Enabled by default.
11566 @item -fchkp-instrument-calls
11567 @opindex fchkp-instrument-calls
11568 @opindex fno-chkp-instrument-calls
11569 Instructs Pointer Bounds Checker to pass pointer bounds to calls.
11570 Enabled by default.
11572 @item -fchkp-instrument-marked-only
11573 @opindex fchkp-instrument-marked-only
11574 @opindex fno-chkp-instrument-marked-only
11575 Instructs Pointer Bounds Checker to instrument only functions
11576 marked with the @code{bnd_instrument} attribute
11577 (@pxref{Function Attributes}).  Disabled by default.
11579 @item -fchkp-use-wrappers
11580 @opindex fchkp-use-wrappers
11581 @opindex fno-chkp-use-wrappers
11582 Allows Pointer Bounds Checker to replace calls to built-in functions
11583 with calls to wrapper functions.  When @option{-fchkp-use-wrappers}
11584 is used to link a program, the GCC driver automatically links
11585 against @file{libmpxwrappers}.  See also @option{-static-libmpxwrappers}.
11586 Enabled by default.
11588 @item -fcf-protection==@r{[}full@r{|}branch@r{|}return@r{|}none@r{]}
11589 @opindex fcf-protection
11590 Enable code instrumentation of control-flow transfers to increase
11591 program security by checking that target addresses of control-flow
11592 transfer instructions (such as indirect function call, function return,
11593 indirect jump) are valid.  This prevents diverting the flow of control
11594 to an unexpected target.  This is intended to protect against such
11595 threats as Return-oriented Programming (ROP), and similarly
11596 call/jmp-oriented programming (COP/JOP).
11598 The value @code{branch} tells the compiler to implement checking of
11599 validity of control-flow transfer at the point of indirect branch
11600 instructions, i.e. call/jmp instructions.  The value @code{return}
11601 implements checking of validity at the point of returning from a
11602 function.  The value @code{full} is an alias for specifying both
11603 @code{branch} and @code{return}. The value @code{none} turns off
11604 instrumentation.
11606 You can also use the @code{nocf_check} attribute to identify
11607 which functions and calls should be skipped from instrumentation
11608 (@pxref{Function Attributes}).
11610 Currently the x86 GNU/Linux target provides an implementation based
11611 on Intel Control-flow Enforcement Technology (CET).  Instrumentation
11612 for x86 is controlled by target-specific options @option{-mcet},
11613 @option{-mibt} and @option{-mshstk} (@pxref{x86 Options}).
11615 @item -fstack-protector
11616 @opindex fstack-protector
11617 Emit extra code to check for buffer overflows, such as stack smashing
11618 attacks.  This is done by adding a guard variable to functions with
11619 vulnerable objects.  This includes functions that call @code{alloca}, and
11620 functions with buffers larger than 8 bytes.  The guards are initialized
11621 when a function is entered and then checked when the function exits.
11622 If a guard check fails, an error message is printed and the program exits.
11624 @item -fstack-protector-all
11625 @opindex fstack-protector-all
11626 Like @option{-fstack-protector} except that all functions are protected.
11628 @item -fstack-protector-strong
11629 @opindex fstack-protector-strong
11630 Like @option{-fstack-protector} but includes additional functions to
11631 be protected --- those that have local array definitions, or have
11632 references to local frame addresses.
11634 @item -fstack-protector-explicit
11635 @opindex fstack-protector-explicit
11636 Like @option{-fstack-protector} but only protects those functions which
11637 have the @code{stack_protect} attribute.
11639 @item -fstack-check
11640 @opindex fstack-check
11641 Generate code to verify that you do not go beyond the boundary of the
11642 stack.  You should specify this flag if you are running in an
11643 environment with multiple threads, but you only rarely need to specify it in
11644 a single-threaded environment since stack overflow is automatically
11645 detected on nearly all systems if there is only one stack.
11647 Note that this switch does not actually cause checking to be done; the
11648 operating system or the language runtime must do that.  The switch causes
11649 generation of code to ensure that they see the stack being extended.
11651 You can additionally specify a string parameter: @samp{no} means no
11652 checking, @samp{generic} means force the use of old-style checking,
11653 @samp{specific} means use the best checking method and is equivalent
11654 to bare @option{-fstack-check}.
11656 Old-style checking is a generic mechanism that requires no specific
11657 target support in the compiler but comes with the following drawbacks:
11659 @enumerate
11660 @item
11661 Modified allocation strategy for large objects: they are always
11662 allocated dynamically if their size exceeds a fixed threshold.  Note this
11663 may change the semantics of some code.
11665 @item
11666 Fixed limit on the size of the static frame of functions: when it is
11667 topped by a particular function, stack checking is not reliable and
11668 a warning is issued by the compiler.
11670 @item
11671 Inefficiency: because of both the modified allocation strategy and the
11672 generic implementation, code performance is hampered.
11673 @end enumerate
11675 Note that old-style stack checking is also the fallback method for
11676 @samp{specific} if no target support has been added in the compiler.
11678 @samp{-fstack-check=} is designed for Ada's needs to detect infinite recursion
11679 and stack overflows.  @samp{specific} is an excellent choice when compiling
11680 Ada code.  It is not generally sufficient to protect against stack-clash
11681 attacks.  To protect against those you want @samp{-fstack-clash-protection}.
11683 @item -fstack-clash-protection
11684 @opindex fstack-clash-protection
11685 Generate code to prevent stack clash style attacks.  When this option is
11686 enabled, the compiler will only allocate one page of stack space at a time
11687 and each page is accessed immediately after allocation.  Thus, it prevents
11688 allocations from jumping over any stack guard page provided by the
11689 operating system.
11691 Most targets do not fully support stack clash protection.  However, on
11692 those targets @option{-fstack-clash-protection} will protect dynamic stack
11693 allocations.  @option{-fstack-clash-protection} may also provide limited
11694 protection for static stack allocations if the target supports
11695 @option{-fstack-check=specific}.
11697 @item -fstack-limit-register=@var{reg}
11698 @itemx -fstack-limit-symbol=@var{sym}
11699 @itemx -fno-stack-limit
11700 @opindex fstack-limit-register
11701 @opindex fstack-limit-symbol
11702 @opindex fno-stack-limit
11703 Generate code to ensure that the stack does not grow beyond a certain value,
11704 either the value of a register or the address of a symbol.  If a larger
11705 stack is required, a signal is raised at run time.  For most targets,
11706 the signal is raised before the stack overruns the boundary, so
11707 it is possible to catch the signal without taking special precautions.
11709 For instance, if the stack starts at absolute address @samp{0x80000000}
11710 and grows downwards, you can use the flags
11711 @option{-fstack-limit-symbol=__stack_limit} and
11712 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11713 of 128KB@.  Note that this may only work with the GNU linker.
11715 You can locally override stack limit checking by using the
11716 @code{no_stack_limit} function attribute (@pxref{Function Attributes}).
11718 @item -fsplit-stack
11719 @opindex fsplit-stack
11720 Generate code to automatically split the stack before it overflows.
11721 The resulting program has a discontiguous stack which can only
11722 overflow if the program is unable to allocate any more memory.  This
11723 is most useful when running threaded programs, as it is no longer
11724 necessary to calculate a good stack size to use for each thread.  This
11725 is currently only implemented for the x86 targets running
11726 GNU/Linux.
11728 When code compiled with @option{-fsplit-stack} calls code compiled
11729 without @option{-fsplit-stack}, there may not be much stack space
11730 available for the latter code to run.  If compiling all code,
11731 including library code, with @option{-fsplit-stack} is not an option,
11732 then the linker can fix up these calls so that the code compiled
11733 without @option{-fsplit-stack} always has a large stack.  Support for
11734 this is implemented in the gold linker in GNU binutils release 2.21
11735 and later.
11737 @item -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]}
11738 @opindex fvtable-verify
11739 This option is only available when compiling C++ code.
11740 It turns on (or off, if using @option{-fvtable-verify=none}) the security
11741 feature that verifies at run time, for every virtual call, that
11742 the vtable pointer through which the call is made is valid for the type of
11743 the object, and has not been corrupted or overwritten.  If an invalid vtable
11744 pointer is detected at run time, an error is reported and execution of the
11745 program is immediately halted.
11747 This option causes run-time data structures to be built at program startup,
11748 which are used for verifying the vtable pointers.  
11749 The options @samp{std} and @samp{preinit}
11750 control the timing of when these data structures are built.  In both cases the
11751 data structures are built before execution reaches @code{main}.  Using
11752 @option{-fvtable-verify=std} causes the data structures to be built after
11753 shared libraries have been loaded and initialized.
11754 @option{-fvtable-verify=preinit} causes them to be built before shared
11755 libraries have been loaded and initialized.
11757 If this option appears multiple times in the command line with different
11758 values specified, @samp{none} takes highest priority over both @samp{std} and
11759 @samp{preinit}; @samp{preinit} takes priority over @samp{std}.
11761 @item -fvtv-debug
11762 @opindex fvtv-debug
11763 When used in conjunction with @option{-fvtable-verify=std} or 
11764 @option{-fvtable-verify=preinit}, causes debug versions of the 
11765 runtime functions for the vtable verification feature to be called.  
11766 This flag also causes the compiler to log information about which 
11767 vtable pointers it finds for each class.
11768 This information is written to a file named @file{vtv_set_ptr_data.log} 
11769 in the directory named by the environment variable @env{VTV_LOGS_DIR} 
11770 if that is defined or the current working directory otherwise.
11772 Note:  This feature @emph{appends} data to the log file. If you want a fresh log
11773 file, be sure to delete any existing one.
11775 @item -fvtv-counts
11776 @opindex fvtv-counts
11777 This is a debugging flag.  When used in conjunction with
11778 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
11779 causes the compiler to keep track of the total number of virtual calls
11780 it encounters and the number of verifications it inserts.  It also
11781 counts the number of calls to certain run-time library functions
11782 that it inserts and logs this information for each compilation unit.
11783 The compiler writes this information to a file named
11784 @file{vtv_count_data.log} in the directory named by the environment
11785 variable @env{VTV_LOGS_DIR} if that is defined or the current working
11786 directory otherwise.  It also counts the size of the vtable pointer sets
11787 for each class, and writes this information to @file{vtv_class_set_sizes.log}
11788 in the same directory.
11790 Note:  This feature @emph{appends} data to the log files.  To get fresh log
11791 files, be sure to delete any existing ones.
11793 @item -finstrument-functions
11794 @opindex finstrument-functions
11795 Generate instrumentation calls for entry and exit to functions.  Just
11796 after function entry and just before function exit, the following
11797 profiling functions are called with the address of the current
11798 function and its call site.  (On some platforms,
11799 @code{__builtin_return_address} does not work beyond the current
11800 function, so the call site information may not be available to the
11801 profiling functions otherwise.)
11803 @smallexample
11804 void __cyg_profile_func_enter (void *this_fn,
11805                                void *call_site);
11806 void __cyg_profile_func_exit  (void *this_fn,
11807                                void *call_site);
11808 @end smallexample
11810 The first argument is the address of the start of the current function,
11811 which may be looked up exactly in the symbol table.
11813 This instrumentation is also done for functions expanded inline in other
11814 functions.  The profiling calls indicate where, conceptually, the
11815 inline function is entered and exited.  This means that addressable
11816 versions of such functions must be available.  If all your uses of a
11817 function are expanded inline, this may mean an additional expansion of
11818 code size.  If you use @code{extern inline} in your C code, an
11819 addressable version of such functions must be provided.  (This is
11820 normally the case anyway, but if you get lucky and the optimizer always
11821 expands the functions inline, you might have gotten away without
11822 providing static copies.)
11824 A function may be given the attribute @code{no_instrument_function}, in
11825 which case this instrumentation is not done.  This can be used, for
11826 example, for the profiling functions listed above, high-priority
11827 interrupt routines, and any functions from which the profiling functions
11828 cannot safely be called (perhaps signal handlers, if the profiling
11829 routines generate output or allocate memory).
11831 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
11832 @opindex finstrument-functions-exclude-file-list
11834 Set the list of functions that are excluded from instrumentation (see
11835 the description of @option{-finstrument-functions}).  If the file that
11836 contains a function definition matches with one of @var{file}, then
11837 that function is not instrumented.  The match is done on substrings:
11838 if the @var{file} parameter is a substring of the file name, it is
11839 considered to be a match.
11841 For example:
11843 @smallexample
11844 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
11845 @end smallexample
11847 @noindent
11848 excludes any inline function defined in files whose pathnames
11849 contain @file{/bits/stl} or @file{include/sys}.
11851 If, for some reason, you want to include letter @samp{,} in one of
11852 @var{sym}, write @samp{\,}. For example,
11853 @option{-finstrument-functions-exclude-file-list='\,\,tmp'}
11854 (note the single quote surrounding the option).
11856 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
11857 @opindex finstrument-functions-exclude-function-list
11859 This is similar to @option{-finstrument-functions-exclude-file-list},
11860 but this option sets the list of function names to be excluded from
11861 instrumentation.  The function name to be matched is its user-visible
11862 name, such as @code{vector<int> blah(const vector<int> &)}, not the
11863 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
11864 match is done on substrings: if the @var{sym} parameter is a substring
11865 of the function name, it is considered to be a match.  For C99 and C++
11866 extended identifiers, the function name must be given in UTF-8, not
11867 using universal character names.
11869 @item -fpatchable-function-entry=@var{N}[,@var{M}]
11870 @opindex fpatchable-function-entry
11871 Generate @var{N} NOPs right at the beginning
11872 of each function, with the function entry point before the @var{M}th NOP.
11873 If @var{M} is omitted, it defaults to @code{0} so the
11874 function entry points to the address just at the first NOP.
11875 The NOP instructions reserve extra space which can be used to patch in
11876 any desired instrumentation at run time, provided that the code segment
11877 is writable.  The amount of space is controllable indirectly via
11878 the number of NOPs; the NOP instruction used corresponds to the instruction
11879 emitted by the internal GCC back-end interface @code{gen_nop}.  This behavior
11880 is target-specific and may also depend on the architecture variant and/or
11881 other compilation options.
11883 For run-time identification, the starting addresses of these areas,
11884 which correspond to their respective function entries minus @var{M},
11885 are additionally collected in the @code{__patchable_function_entries}
11886 section of the resulting binary.
11888 Note that the value of @code{__attribute__ ((patchable_function_entry
11889 (N,M)))} takes precedence over command-line option
11890 @option{-fpatchable-function-entry=N,M}.  This can be used to increase
11891 the area size or to remove it completely on a single function.
11892 If @code{N=0}, no pad location is recorded.
11894 The NOP instructions are inserted at---and maybe before, depending on
11895 @var{M}---the function entry address, even before the prologue.
11897 @end table
11900 @node Preprocessor Options
11901 @section Options Controlling the Preprocessor
11902 @cindex preprocessor options
11903 @cindex options, preprocessor
11905 These options control the C preprocessor, which is run on each C source
11906 file before actual compilation.
11908 If you use the @option{-E} option, nothing is done except preprocessing.
11909 Some of these options make sense only together with @option{-E} because
11910 they cause the preprocessor output to be unsuitable for actual
11911 compilation.
11913 In addition to the options listed here, there are a number of options 
11914 to control search paths for include files documented in 
11915 @ref{Directory Options}.  
11916 Options to control preprocessor diagnostics are listed in 
11917 @ref{Warning Options}.
11919 @table @gcctabopt
11920 @include cppopts.texi
11922 @item -Wp,@var{option}
11923 @opindex Wp
11924 You can use @option{-Wp,@var{option}} to bypass the compiler driver
11925 and pass @var{option} directly through to the preprocessor.  If
11926 @var{option} contains commas, it is split into multiple options at the
11927 commas.  However, many options are modified, translated or interpreted
11928 by the compiler driver before being passed to the preprocessor, and
11929 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
11930 interface is undocumented and subject to change, so whenever possible
11931 you should avoid using @option{-Wp} and let the driver handle the
11932 options instead.
11934 @item -Xpreprocessor @var{option}
11935 @opindex Xpreprocessor
11936 Pass @var{option} as an option to the preprocessor.  You can use this to
11937 supply system-specific preprocessor options that GCC does not 
11938 recognize.
11940 If you want to pass an option that takes an argument, you must use
11941 @option{-Xpreprocessor} twice, once for the option and once for the argument.
11943 @item -no-integrated-cpp
11944 @opindex no-integrated-cpp
11945 Perform preprocessing as a separate pass before compilation.
11946 By default, GCC performs preprocessing as an integrated part of
11947 input tokenization and parsing.
11948 If this option is provided, the appropriate language front end
11949 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
11950 and Objective-C, respectively) is instead invoked twice,
11951 once for preprocessing only and once for actual compilation
11952 of the preprocessed input.
11953 This option may be useful in conjunction with the @option{-B} or
11954 @option{-wrapper} options to specify an alternate preprocessor or
11955 perform additional processing of the program source between
11956 normal preprocessing and compilation.
11958 @end table
11960 @node Assembler Options
11961 @section Passing Options to the Assembler
11963 @c prevent bad page break with this line
11964 You can pass options to the assembler.
11966 @table @gcctabopt
11967 @item -Wa,@var{option}
11968 @opindex Wa
11969 Pass @var{option} as an option to the assembler.  If @var{option}
11970 contains commas, it is split into multiple options at the commas.
11972 @item -Xassembler @var{option}
11973 @opindex Xassembler
11974 Pass @var{option} as an option to the assembler.  You can use this to
11975 supply system-specific assembler options that GCC does not
11976 recognize.
11978 If you want to pass an option that takes an argument, you must use
11979 @option{-Xassembler} twice, once for the option and once for the argument.
11981 @end table
11983 @node Link Options
11984 @section Options for Linking
11985 @cindex link options
11986 @cindex options, linking
11988 These options come into play when the compiler links object files into
11989 an executable output file.  They are meaningless if the compiler is
11990 not doing a link step.
11992 @table @gcctabopt
11993 @cindex file names
11994 @item @var{object-file-name}
11995 A file name that does not end in a special recognized suffix is
11996 considered to name an object file or library.  (Object files are
11997 distinguished from libraries by the linker according to the file
11998 contents.)  If linking is done, these object files are used as input
11999 to the linker.
12001 @item -c
12002 @itemx -S
12003 @itemx -E
12004 @opindex c
12005 @opindex S
12006 @opindex E
12007 If any of these options is used, then the linker is not run, and
12008 object file names should not be used as arguments.  @xref{Overall
12009 Options}.
12011 @item -fuse-ld=bfd
12012 @opindex fuse-ld=bfd
12013 Use the @command{bfd} linker instead of the default linker.
12015 @item -fuse-ld=gold
12016 @opindex fuse-ld=gold
12017 Use the @command{gold} linker instead of the default linker.
12019 @cindex Libraries
12020 @item -l@var{library}
12021 @itemx -l @var{library}
12022 @opindex l
12023 Search the library named @var{library} when linking.  (The second
12024 alternative with the library as a separate argument is only for
12025 POSIX compliance and is not recommended.)
12027 It makes a difference where in the command you write this option; the
12028 linker searches and processes libraries and object files in the order they
12029 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
12030 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
12031 to functions in @samp{z}, those functions may not be loaded.
12033 The linker searches a standard list of directories for the library,
12034 which is actually a file named @file{lib@var{library}.a}.  The linker
12035 then uses this file as if it had been specified precisely by name.
12037 The directories searched include several standard system directories
12038 plus any that you specify with @option{-L}.
12040 Normally the files found this way are library files---archive files
12041 whose members are object files.  The linker handles an archive file by
12042 scanning through it for members which define symbols that have so far
12043 been referenced but not defined.  But if the file that is found is an
12044 ordinary object file, it is linked in the usual fashion.  The only
12045 difference between using an @option{-l} option and specifying a file name
12046 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
12047 and searches several directories.
12049 @item -lobjc
12050 @opindex lobjc
12051 You need this special case of the @option{-l} option in order to
12052 link an Objective-C or Objective-C++ program.
12054 @item -nostartfiles
12055 @opindex nostartfiles
12056 Do not use the standard system startup files when linking.
12057 The standard system libraries are used normally, unless @option{-nostdlib}
12058 or @option{-nodefaultlibs} is used.
12060 @item -nodefaultlibs
12061 @opindex nodefaultlibs
12062 Do not use the standard system libraries when linking.
12063 Only the libraries you specify are passed to the linker, and options
12064 specifying linkage of the system libraries, such as @option{-static-libgcc}
12065 or @option{-shared-libgcc}, are ignored.  
12066 The standard startup files are used normally, unless @option{-nostartfiles}
12067 is used.  
12069 The compiler may generate calls to @code{memcmp},
12070 @code{memset}, @code{memcpy} and @code{memmove}.
12071 These entries are usually resolved by entries in
12072 libc.  These entry points should be supplied through some other
12073 mechanism when this option is specified.
12075 @item -nostdlib
12076 @opindex nostdlib
12077 Do not use the standard system startup files or libraries when linking.
12078 No startup files and only the libraries you specify are passed to
12079 the linker, and options specifying linkage of the system libraries, such as
12080 @option{-static-libgcc} or @option{-shared-libgcc}, are ignored.
12082 The compiler may generate calls to @code{memcmp}, @code{memset},
12083 @code{memcpy} and @code{memmove}.
12084 These entries are usually resolved by entries in
12085 libc.  These entry points should be supplied through some other
12086 mechanism when this option is specified.
12088 @cindex @option{-lgcc}, use with @option{-nostdlib}
12089 @cindex @option{-nostdlib} and unresolved references
12090 @cindex unresolved references and @option{-nostdlib}
12091 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
12092 @cindex @option{-nodefaultlibs} and unresolved references
12093 @cindex unresolved references and @option{-nodefaultlibs}
12094 One of the standard libraries bypassed by @option{-nostdlib} and
12095 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
12096 which GCC uses to overcome shortcomings of particular machines, or special
12097 needs for some languages.
12098 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
12099 Collection (GCC) Internals},
12100 for more discussion of @file{libgcc.a}.)
12101 In most cases, you need @file{libgcc.a} even when you want to avoid
12102 other standard libraries.  In other words, when you specify @option{-nostdlib}
12103 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
12104 This ensures that you have no unresolved references to internal GCC
12105 library subroutines.
12106 (An example of such an internal subroutine is @code{__main}, used to ensure C++
12107 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
12108 GNU Compiler Collection (GCC) Internals}.)
12110 @item -pie
12111 @opindex pie
12112 Produce a dynamically linked position independent executable on targets
12113 that support it.  For predictable results, you must also specify the same
12114 set of options used for compilation (@option{-fpie}, @option{-fPIE},
12115 or model suboptions) when you specify this linker option.
12117 @item -no-pie
12118 @opindex no-pie
12119 Don't produce a dynamically linked position independent executable.
12121 @item -static-pie
12122 @opindex static-pie
12123 Produce a static position independent executable on targets that support
12124 it.  A static position independent executable is similar to a static
12125 executable, but can be loaded at any address without a dynamic linker.
12126 For predictable results, you must also specify the same set of options
12127 used for compilation (@option{-fpie}, @option{-fPIE}, or model
12128 suboptions) when you specify this linker option.
12130 @item -pthread
12131 @opindex pthread
12132 Link with the POSIX threads library.  This option is supported on 
12133 GNU/Linux targets, most other Unix derivatives, and also on 
12134 x86 Cygwin and MinGW targets.  On some targets this option also sets 
12135 flags for the preprocessor, so it should be used consistently for both
12136 compilation and linking.
12138 @item -rdynamic
12139 @opindex rdynamic
12140 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
12141 that support it. This instructs the linker to add all symbols, not
12142 only used ones, to the dynamic symbol table. This option is needed
12143 for some uses of @code{dlopen} or to allow obtaining backtraces
12144 from within a program.
12146 @item -s
12147 @opindex s
12148 Remove all symbol table and relocation information from the executable.
12150 @item -static
12151 @opindex static
12152 On systems that support dynamic linking, this overrides @option{-pie}
12153 and prevents linking with the shared libraries.  On other systems, this
12154 option has no effect.
12156 @item -shared
12157 @opindex shared
12158 Produce a shared object which can then be linked with other objects to
12159 form an executable.  Not all systems support this option.  For predictable
12160 results, you must also specify the same set of options used for compilation
12161 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
12162 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
12163 needs to build supplementary stub code for constructors to work.  On
12164 multi-libbed systems, @samp{gcc -shared} must select the correct support
12165 libraries to link against.  Failing to supply the correct flags may lead
12166 to subtle defects.  Supplying them in cases where they are not necessary
12167 is innocuous.}
12169 @item -shared-libgcc
12170 @itemx -static-libgcc
12171 @opindex shared-libgcc
12172 @opindex static-libgcc
12173 On systems that provide @file{libgcc} as a shared library, these options
12174 force the use of either the shared or static version, respectively.
12175 If no shared version of @file{libgcc} was built when the compiler was
12176 configured, these options have no effect.
12178 There are several situations in which an application should use the
12179 shared @file{libgcc} instead of the static version.  The most common
12180 of these is when the application wishes to throw and catch exceptions
12181 across different shared libraries.  In that case, each of the libraries
12182 as well as the application itself should use the shared @file{libgcc}.
12184 Therefore, the G++ and driver automatically adds @option{-shared-libgcc}
12185  whenever you build a shared library or a main executable, because C++
12186  programs typically use exceptions, so this is the right thing to do.
12188 If, instead, you use the GCC driver to create shared libraries, you may
12189 find that they are not always linked with the shared @file{libgcc}.
12190 If GCC finds, at its configuration time, that you have a non-GNU linker
12191 or a GNU linker that does not support option @option{--eh-frame-hdr},
12192 it links the shared version of @file{libgcc} into shared libraries
12193 by default.  Otherwise, it takes advantage of the linker and optimizes
12194 away the linking with the shared version of @file{libgcc}, linking with
12195 the static version of libgcc by default.  This allows exceptions to
12196 propagate through such shared libraries, without incurring relocation
12197 costs at library load time.
12199 However, if a library or main executable is supposed to throw or catch
12200 exceptions, you must link it using the G++ driver, as appropriate
12201 for the languages used in the program, or using the option
12202 @option{-shared-libgcc}, such that it is linked with the shared
12203 @file{libgcc}.
12205 @item -static-libasan
12206 @opindex static-libasan
12207 When the @option{-fsanitize=address} option is used to link a program,
12208 the GCC driver automatically links against @option{libasan}.  If
12209 @file{libasan} is available as a shared library, and the @option{-static}
12210 option is not used, then this links against the shared version of
12211 @file{libasan}.  The @option{-static-libasan} option directs the GCC
12212 driver to link @file{libasan} statically, without necessarily linking
12213 other libraries statically.
12215 @item -static-libtsan
12216 @opindex static-libtsan
12217 When the @option{-fsanitize=thread} option is used to link a program,
12218 the GCC driver automatically links against @option{libtsan}.  If
12219 @file{libtsan} is available as a shared library, and the @option{-static}
12220 option is not used, then this links against the shared version of
12221 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
12222 driver to link @file{libtsan} statically, without necessarily linking
12223 other libraries statically.
12225 @item -static-liblsan
12226 @opindex static-liblsan
12227 When the @option{-fsanitize=leak} option is used to link a program,
12228 the GCC driver automatically links against @option{liblsan}.  If
12229 @file{liblsan} is available as a shared library, and the @option{-static}
12230 option is not used, then this links against the shared version of
12231 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
12232 driver to link @file{liblsan} statically, without necessarily linking
12233 other libraries statically.
12235 @item -static-libubsan
12236 @opindex static-libubsan
12237 When the @option{-fsanitize=undefined} option is used to link a program,
12238 the GCC driver automatically links against @option{libubsan}.  If
12239 @file{libubsan} is available as a shared library, and the @option{-static}
12240 option is not used, then this links against the shared version of
12241 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
12242 driver to link @file{libubsan} statically, without necessarily linking
12243 other libraries statically.
12245 @item -static-libmpx
12246 @opindex static-libmpx
12247 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are
12248 used to link a program, the GCC driver automatically links against
12249 @file{libmpx}.  If @file{libmpx} is available as a shared library,
12250 and the @option{-static} option is not used, then this links against
12251 the shared version of @file{libmpx}.  The @option{-static-libmpx}
12252 option directs the GCC driver to link @file{libmpx} statically,
12253 without necessarily linking other libraries statically.
12255 @item -static-libmpxwrappers
12256 @opindex static-libmpxwrappers
12257 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are used
12258 to link a program without also using @option{-fno-chkp-use-wrappers}, the
12259 GCC driver automatically links against @file{libmpxwrappers}.  If
12260 @file{libmpxwrappers} is available as a shared library, and the
12261 @option{-static} option is not used, then this links against the shared
12262 version of @file{libmpxwrappers}.  The @option{-static-libmpxwrappers}
12263 option directs the GCC driver to link @file{libmpxwrappers} statically,
12264 without necessarily linking other libraries statically.
12266 @item -static-libstdc++
12267 @opindex static-libstdc++
12268 When the @command{g++} program is used to link a C++ program, it
12269 normally automatically links against @option{libstdc++}.  If
12270 @file{libstdc++} is available as a shared library, and the
12271 @option{-static} option is not used, then this links against the
12272 shared version of @file{libstdc++}.  That is normally fine.  However, it
12273 is sometimes useful to freeze the version of @file{libstdc++} used by
12274 the program without going all the way to a fully static link.  The
12275 @option{-static-libstdc++} option directs the @command{g++} driver to
12276 link @file{libstdc++} statically, without necessarily linking other
12277 libraries statically.
12279 @item -symbolic
12280 @opindex symbolic
12281 Bind references to global symbols when building a shared object.  Warn
12282 about any unresolved references (unless overridden by the link editor
12283 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
12284 this option.
12286 @item -T @var{script}
12287 @opindex T
12288 @cindex linker script
12289 Use @var{script} as the linker script.  This option is supported by most
12290 systems using the GNU linker.  On some targets, such as bare-board
12291 targets without an operating system, the @option{-T} option may be required
12292 when linking to avoid references to undefined symbols.
12294 @item -Xlinker @var{option}
12295 @opindex Xlinker
12296 Pass @var{option} as an option to the linker.  You can use this to
12297 supply system-specific linker options that GCC does not recognize.
12299 If you want to pass an option that takes a separate argument, you must use
12300 @option{-Xlinker} twice, once for the option and once for the argument.
12301 For example, to pass @option{-assert definitions}, you must write
12302 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
12303 @option{-Xlinker "-assert definitions"}, because this passes the entire
12304 string as a single argument, which is not what the linker expects.
12306 When using the GNU linker, it is usually more convenient to pass
12307 arguments to linker options using the @option{@var{option}=@var{value}}
12308 syntax than as separate arguments.  For example, you can specify
12309 @option{-Xlinker -Map=output.map} rather than
12310 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
12311 this syntax for command-line options.
12313 @item -Wl,@var{option}
12314 @opindex Wl
12315 Pass @var{option} as an option to the linker.  If @var{option} contains
12316 commas, it is split into multiple options at the commas.  You can use this
12317 syntax to pass an argument to the option.
12318 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
12319 linker.  When using the GNU linker, you can also get the same effect with
12320 @option{-Wl,-Map=output.map}.
12322 @item -u @var{symbol}
12323 @opindex u
12324 Pretend the symbol @var{symbol} is undefined, to force linking of
12325 library modules to define it.  You can use @option{-u} multiple times with
12326 different symbols to force loading of additional library modules.
12328 @item -z @var{keyword}
12329 @opindex z
12330 @option{-z} is passed directly on to the linker along with the keyword
12331 @var{keyword}. See the section in the documentation of your linker for
12332 permitted values and their meanings.
12333 @end table
12335 @node Directory Options
12336 @section Options for Directory Search
12337 @cindex directory options
12338 @cindex options, directory search
12339 @cindex search path
12341 These options specify directories to search for header files, for
12342 libraries and for parts of the compiler:
12344 @table @gcctabopt
12345 @include cppdiropts.texi
12347 @item -iplugindir=@var{dir}
12348 @opindex iplugindir=
12349 Set the directory to search for plugins that are passed
12350 by @option{-fplugin=@var{name}} instead of
12351 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
12352 to be used by the user, but only passed by the driver.
12354 @item -L@var{dir}
12355 @opindex L
12356 Add directory @var{dir} to the list of directories to be searched
12357 for @option{-l}.
12359 @item -B@var{prefix}
12360 @opindex B
12361 This option specifies where to find the executables, libraries,
12362 include files, and data files of the compiler itself.
12364 The compiler driver program runs one or more of the subprograms
12365 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
12366 @var{prefix} as a prefix for each program it tries to run, both with and
12367 without @samp{@var{machine}/@var{version}/} for the corresponding target
12368 machine and compiler version.
12370 For each subprogram to be run, the compiler driver first tries the
12371 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
12372 is not specified, the driver tries two standard prefixes, 
12373 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
12374 those results in a file name that is found, the unmodified program
12375 name is searched for using the directories specified in your
12376 @env{PATH} environment variable.
12378 The compiler checks to see if the path provided by @option{-B}
12379 refers to a directory, and if necessary it adds a directory
12380 separator character at the end of the path.
12382 @option{-B} prefixes that effectively specify directory names also apply
12383 to libraries in the linker, because the compiler translates these
12384 options into @option{-L} options for the linker.  They also apply to
12385 include files in the preprocessor, because the compiler translates these
12386 options into @option{-isystem} options for the preprocessor.  In this case,
12387 the compiler appends @samp{include} to the prefix.
12389 The runtime support file @file{libgcc.a} can also be searched for using
12390 the @option{-B} prefix, if needed.  If it is not found there, the two
12391 standard prefixes above are tried, and that is all.  The file is left
12392 out of the link if it is not found by those means.
12394 Another way to specify a prefix much like the @option{-B} prefix is to use
12395 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
12396 Variables}.
12398 As a special kludge, if the path provided by @option{-B} is
12399 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
12400 9, then it is replaced by @file{[dir/]include}.  This is to help
12401 with boot-strapping the compiler.
12403 @item -no-canonical-prefixes
12404 @opindex no-canonical-prefixes
12405 Do not expand any symbolic links, resolve references to @samp{/../}
12406 or @samp{/./}, or make the path absolute when generating a relative
12407 prefix.
12409 @item --sysroot=@var{dir}
12410 @opindex sysroot
12411 Use @var{dir} as the logical root directory for headers and libraries.
12412 For example, if the compiler normally searches for headers in
12413 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
12414 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
12416 If you use both this option and the @option{-isysroot} option, then
12417 the @option{--sysroot} option applies to libraries, but the
12418 @option{-isysroot} option applies to header files.
12420 The GNU linker (beginning with version 2.16) has the necessary support
12421 for this option.  If your linker does not support this option, the
12422 header file aspect of @option{--sysroot} still works, but the
12423 library aspect does not.
12425 @item --no-sysroot-suffix
12426 @opindex no-sysroot-suffix
12427 For some targets, a suffix is added to the root directory specified
12428 with @option{--sysroot}, depending on the other options used, so that
12429 headers may for example be found in
12430 @file{@var{dir}/@var{suffix}/usr/include} instead of
12431 @file{@var{dir}/usr/include}.  This option disables the addition of
12432 such a suffix.
12434 @end table
12436 @node Code Gen Options
12437 @section Options for Code Generation Conventions
12438 @cindex code generation conventions
12439 @cindex options, code generation
12440 @cindex run-time options
12442 These machine-independent options control the interface conventions
12443 used in code generation.
12445 Most of them have both positive and negative forms; the negative form
12446 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
12447 one of the forms is listed---the one that is not the default.  You
12448 can figure out the other form by either removing @samp{no-} or adding
12451 @table @gcctabopt
12452 @item -fstack-reuse=@var{reuse-level}
12453 @opindex fstack_reuse
12454 This option controls stack space reuse for user declared local/auto variables
12455 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
12456 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
12457 local variables and temporaries, @samp{named_vars} enables the reuse only for
12458 user defined local variables with names, and @samp{none} disables stack reuse
12459 completely. The default value is @samp{all}. The option is needed when the
12460 program extends the lifetime of a scoped local variable or a compiler generated
12461 temporary beyond the end point defined by the language.  When a lifetime of
12462 a variable ends, and if the variable lives in memory, the optimizing compiler
12463 has the freedom to reuse its stack space with other temporaries or scoped
12464 local variables whose live range does not overlap with it. Legacy code extending
12465 local lifetime is likely to break with the stack reuse optimization.
12467 For example,
12469 @smallexample
12470    int *p;
12471    @{
12472      int local1;
12474      p = &local1;
12475      local1 = 10;
12476      ....
12477    @}
12478    @{
12479       int local2;
12480       local2 = 20;
12481       ...
12482    @}
12484    if (*p == 10)  // out of scope use of local1
12485      @{
12487      @}
12488 @end smallexample
12490 Another example:
12491 @smallexample
12493    struct A
12494    @{
12495        A(int k) : i(k), j(k) @{ @}
12496        int i;
12497        int j;
12498    @};
12500    A *ap;
12502    void foo(const A& ar)
12503    @{
12504       ap = &ar;
12505    @}
12507    void bar()
12508    @{
12509       foo(A(10)); // temp object's lifetime ends when foo returns
12511       @{
12512         A a(20);
12513         ....
12514       @}
12515       ap->i+= 10;  // ap references out of scope temp whose space
12516                    // is reused with a. What is the value of ap->i?
12517    @}
12519 @end smallexample
12521 The lifetime of a compiler generated temporary is well defined by the C++
12522 standard. When a lifetime of a temporary ends, and if the temporary lives
12523 in memory, the optimizing compiler has the freedom to reuse its stack
12524 space with other temporaries or scoped local variables whose live range
12525 does not overlap with it. However some of the legacy code relies on
12526 the behavior of older compilers in which temporaries' stack space is
12527 not reused, the aggressive stack reuse can lead to runtime errors. This
12528 option is used to control the temporary stack reuse optimization.
12530 @item -ftrapv
12531 @opindex ftrapv
12532 This option generates traps for signed overflow on addition, subtraction,
12533 multiplication operations.
12534 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12535 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12536 @option{-fwrapv} being effective.  Note that only active options override, so
12537 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12538 results in @option{-ftrapv} being effective.
12540 @item -fwrapv
12541 @opindex fwrapv
12542 This option instructs the compiler to assume that signed arithmetic
12543 overflow of addition, subtraction and multiplication wraps around
12544 using twos-complement representation.  This flag enables some optimizations
12545 and disables others.
12546 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12547 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12548 @option{-fwrapv} being effective.  Note that only active options override, so
12549 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12550 results in @option{-ftrapv} being effective.
12552 @item -fexceptions
12553 @opindex fexceptions
12554 Enable exception handling.  Generates extra code needed to propagate
12555 exceptions.  For some targets, this implies GCC generates frame
12556 unwind information for all functions, which can produce significant data
12557 size overhead, although it does not affect execution.  If you do not
12558 specify this option, GCC enables it by default for languages like
12559 C++ that normally require exception handling, and disables it for
12560 languages like C that do not normally require it.  However, you may need
12561 to enable this option when compiling C code that needs to interoperate
12562 properly with exception handlers written in C++.  You may also wish to
12563 disable this option if you are compiling older C++ programs that don't
12564 use exception handling.
12566 @item -fnon-call-exceptions
12567 @opindex fnon-call-exceptions
12568 Generate code that allows trapping instructions to throw exceptions.
12569 Note that this requires platform-specific runtime support that does
12570 not exist everywhere.  Moreover, it only allows @emph{trapping}
12571 instructions to throw exceptions, i.e.@: memory references or floating-point
12572 instructions.  It does not allow exceptions to be thrown from
12573 arbitrary signal handlers such as @code{SIGALRM}.
12575 @item -fdelete-dead-exceptions
12576 @opindex fdelete-dead-exceptions
12577 Consider that instructions that may throw exceptions but don't otherwise
12578 contribute to the execution of the program can be optimized away.
12579 This option is enabled by default for the Ada front end, as permitted by
12580 the Ada language specification.
12581 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
12583 @item -funwind-tables
12584 @opindex funwind-tables
12585 Similar to @option{-fexceptions}, except that it just generates any needed
12586 static data, but does not affect the generated code in any other way.
12587 You normally do not need to enable this option; instead, a language processor
12588 that needs this handling enables it on your behalf.
12590 @item -fasynchronous-unwind-tables
12591 @opindex fasynchronous-unwind-tables
12592 Generate unwind table in DWARF format, if supported by target machine.  The
12593 table is exact at each instruction boundary, so it can be used for stack
12594 unwinding from asynchronous events (such as debugger or garbage collector).
12596 @item -fno-gnu-unique
12597 @opindex fno-gnu-unique
12598 On systems with recent GNU assembler and C library, the C++ compiler
12599 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
12600 of template static data members and static local variables in inline
12601 functions are unique even in the presence of @code{RTLD_LOCAL}; this
12602 is necessary to avoid problems with a library used by two different
12603 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
12604 therefore disagreeing with the other one about the binding of the
12605 symbol.  But this causes @code{dlclose} to be ignored for affected
12606 DSOs; if your program relies on reinitialization of a DSO via
12607 @code{dlclose} and @code{dlopen}, you can use
12608 @option{-fno-gnu-unique}.
12610 @item -fpcc-struct-return
12611 @opindex fpcc-struct-return
12612 Return ``short'' @code{struct} and @code{union} values in memory like
12613 longer ones, rather than in registers.  This convention is less
12614 efficient, but it has the advantage of allowing intercallability between
12615 GCC-compiled files and files compiled with other compilers, particularly
12616 the Portable C Compiler (pcc).
12618 The precise convention for returning structures in memory depends
12619 on the target configuration macros.
12621 Short structures and unions are those whose size and alignment match
12622 that of some integer type.
12624 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12625 switch is not binary compatible with code compiled with the
12626 @option{-freg-struct-return} switch.
12627 Use it to conform to a non-default application binary interface.
12629 @item -freg-struct-return
12630 @opindex freg-struct-return
12631 Return @code{struct} and @code{union} values in registers when possible.
12632 This is more efficient for small structures than
12633 @option{-fpcc-struct-return}.
12635 If you specify neither @option{-fpcc-struct-return} nor
12636 @option{-freg-struct-return}, GCC defaults to whichever convention is
12637 standard for the target.  If there is no standard convention, GCC
12638 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12639 the principal compiler.  In those cases, we can choose the standard, and
12640 we chose the more efficient register return alternative.
12642 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12643 switch is not binary compatible with code compiled with the
12644 @option{-fpcc-struct-return} switch.
12645 Use it to conform to a non-default application binary interface.
12647 @item -fshort-enums
12648 @opindex fshort-enums
12649 Allocate to an @code{enum} type only as many bytes as it needs for the
12650 declared range of possible values.  Specifically, the @code{enum} type
12651 is equivalent to the smallest integer type that has enough room.
12653 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12654 code that is not binary compatible with code generated without that switch.
12655 Use it to conform to a non-default application binary interface.
12657 @item -fshort-wchar
12658 @opindex fshort-wchar
12659 Override the underlying type for @code{wchar_t} to be @code{short
12660 unsigned int} instead of the default for the target.  This option is
12661 useful for building programs to run under WINE@.
12663 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12664 code that is not binary compatible with code generated without that switch.
12665 Use it to conform to a non-default application binary interface.
12667 @item -fno-common
12668 @opindex fno-common
12669 @cindex tentative definitions
12670 In C code, this option controls the placement of global variables 
12671 defined without an initializer, known as @dfn{tentative definitions} 
12672 in the C standard.  Tentative definitions are distinct from declarations 
12673 of a variable with the @code{extern} keyword, which do not allocate storage.
12675 Unix C compilers have traditionally allocated storage for
12676 uninitialized global variables in a common block.  This allows the
12677 linker to resolve all tentative definitions of the same variable
12678 in different compilation units to the same object, or to a non-tentative
12679 definition.  
12680 This is the behavior specified by @option{-fcommon}, and is the default for 
12681 GCC on most targets.  
12682 On the other hand, this behavior is not required by ISO
12683 C, and on some targets may carry a speed or code size penalty on
12684 variable references.
12686 The @option{-fno-common} option specifies that the compiler should instead
12687 place uninitialized global variables in the data section of the object file.
12688 This inhibits the merging of tentative definitions by the linker so
12689 you get a multiple-definition error if the same 
12690 variable is defined in more than one compilation unit.
12691 Compiling with @option{-fno-common} is useful on targets for which
12692 it provides better performance, or if you wish to verify that the
12693 program will work on other systems that always treat uninitialized
12694 variable definitions this way.
12696 @item -fno-ident
12697 @opindex fno-ident
12698 Ignore the @code{#ident} directive.
12700 @item -finhibit-size-directive
12701 @opindex finhibit-size-directive
12702 Don't output a @code{.size} assembler directive, or anything else that
12703 would cause trouble if the function is split in the middle, and the
12704 two halves are placed at locations far apart in memory.  This option is
12705 used when compiling @file{crtstuff.c}; you should not need to use it
12706 for anything else.
12708 @item -fverbose-asm
12709 @opindex fverbose-asm
12710 Put extra commentary information in the generated assembly code to
12711 make it more readable.  This option is generally only of use to those
12712 who actually need to read the generated assembly code (perhaps while
12713 debugging the compiler itself).
12715 @option{-fno-verbose-asm}, the default, causes the
12716 extra information to be omitted and is useful when comparing two assembler
12717 files.
12719 The added comments include:
12721 @itemize @bullet
12723 @item
12724 information on the compiler version and command-line options,
12726 @item
12727 the source code lines associated with the assembly instructions,
12728 in the form FILENAME:LINENUMBER:CONTENT OF LINE,
12730 @item
12731 hints on which high-level expressions correspond to
12732 the various assembly instruction operands.
12734 @end itemize
12736 For example, given this C source file:
12738 @smallexample
12739 int test (int n)
12741   int i;
12742   int total = 0;
12744   for (i = 0; i < n; i++)
12745     total += i * i;
12747   return total;
12749 @end smallexample
12751 compiling to (x86_64) assembly via @option{-S} and emitting the result
12752 direct to stdout via @option{-o} @option{-}
12754 @smallexample
12755 gcc -S test.c -fverbose-asm -Os -o -
12756 @end smallexample
12758 gives output similar to this:
12760 @smallexample
12761         .file   "test.c"
12762 # GNU C11 (GCC) version 7.0.0 20160809 (experimental) (x86_64-pc-linux-gnu)
12763   [...snip...]
12764 # options passed:
12765   [...snip...]
12767         .text
12768         .globl  test
12769         .type   test, @@function
12770 test:
12771 .LFB0:
12772         .cfi_startproc
12773 # test.c:4:   int total = 0;
12774         xorl    %eax, %eax      # <retval>
12775 # test.c:6:   for (i = 0; i < n; i++)
12776         xorl    %edx, %edx      # i
12777 .L2:
12778 # test.c:6:   for (i = 0; i < n; i++)
12779         cmpl    %edi, %edx      # n, i
12780         jge     .L5     #,
12781 # test.c:7:     total += i * i;
12782         movl    %edx, %ecx      # i, tmp92
12783         imull   %edx, %ecx      # i, tmp92
12784 # test.c:6:   for (i = 0; i < n; i++)
12785         incl    %edx    # i
12786 # test.c:7:     total += i * i;
12787         addl    %ecx, %eax      # tmp92, <retval>
12788         jmp     .L2     #
12789 .L5:
12790 # test.c:10: @}
12791         ret
12792         .cfi_endproc
12793 .LFE0:
12794         .size   test, .-test
12795         .ident  "GCC: (GNU) 7.0.0 20160809 (experimental)"
12796         .section        .note.GNU-stack,"",@@progbits
12797 @end smallexample
12799 The comments are intended for humans rather than machines and hence the
12800 precise format of the comments is subject to change.
12802 @item -frecord-gcc-switches
12803 @opindex frecord-gcc-switches
12804 This switch causes the command line used to invoke the
12805 compiler to be recorded into the object file that is being created.
12806 This switch is only implemented on some targets and the exact format
12807 of the recording is target and binary file format dependent, but it
12808 usually takes the form of a section containing ASCII text.  This
12809 switch is related to the @option{-fverbose-asm} switch, but that
12810 switch only records information in the assembler output file as
12811 comments, so it never reaches the object file.
12812 See also @option{-grecord-gcc-switches} for another
12813 way of storing compiler options into the object file.
12815 @item -fpic
12816 @opindex fpic
12817 @cindex global offset table
12818 @cindex PIC
12819 Generate position-independent code (PIC) suitable for use in a shared
12820 library, if supported for the target machine.  Such code accesses all
12821 constant addresses through a global offset table (GOT)@.  The dynamic
12822 loader resolves the GOT entries when the program starts (the dynamic
12823 loader is not part of GCC; it is part of the operating system).  If
12824 the GOT size for the linked executable exceeds a machine-specific
12825 maximum size, you get an error message from the linker indicating that
12826 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
12827 instead.  (These maximums are 8k on the SPARC, 28k on AArch64 and 32k
12828 on the m68k and RS/6000.  The x86 has no such limit.)
12830 Position-independent code requires special support, and therefore works
12831 only on certain machines.  For the x86, GCC supports PIC for System V
12832 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
12833 position-independent.
12835 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12836 are defined to 1.
12838 @item -fPIC
12839 @opindex fPIC
12840 If supported for the target machine, emit position-independent code,
12841 suitable for dynamic linking and avoiding any limit on the size of the
12842 global offset table.  This option makes a difference on AArch64, m68k,
12843 PowerPC and SPARC@.
12845 Position-independent code requires special support, and therefore works
12846 only on certain machines.
12848 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12849 are defined to 2.
12851 @item -fpie
12852 @itemx -fPIE
12853 @opindex fpie
12854 @opindex fPIE
12855 These options are similar to @option{-fpic} and @option{-fPIC}, but
12856 generated position independent code can be only linked into executables.
12857 Usually these options are used when @option{-pie} GCC option is
12858 used during linking.
12860 @option{-fpie} and @option{-fPIE} both define the macros
12861 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
12862 for @option{-fpie} and 2 for @option{-fPIE}.
12864 @item -fno-plt
12865 @opindex fno-plt
12866 Do not use the PLT for external function calls in position-independent code.
12867 Instead, load the callee address at call sites from the GOT and branch to it.
12868 This leads to more efficient code by eliminating PLT stubs and exposing
12869 GOT loads to optimizations.  On architectures such as 32-bit x86 where
12870 PLT stubs expect the GOT pointer in a specific register, this gives more
12871 register allocation freedom to the compiler.
12872 Lazy binding requires use of the PLT; 
12873 with @option{-fno-plt} all external symbols are resolved at load time.
12875 Alternatively, the function attribute @code{noplt} can be used to avoid calls
12876 through the PLT for specific external functions.
12878 In position-dependent code, a few targets also convert calls to
12879 functions that are marked to not use the PLT to use the GOT instead.
12881 @item -fno-jump-tables
12882 @opindex fno-jump-tables
12883 Do not use jump tables for switch statements even where it would be
12884 more efficient than other code generation strategies.  This option is
12885 of use in conjunction with @option{-fpic} or @option{-fPIC} for
12886 building code that forms part of a dynamic linker and cannot
12887 reference the address of a jump table.  On some targets, jump tables
12888 do not require a GOT and this option is not needed.
12890 @item -ffixed-@var{reg}
12891 @opindex ffixed
12892 Treat the register named @var{reg} as a fixed register; generated code
12893 should never refer to it (except perhaps as a stack pointer, frame
12894 pointer or in some other fixed role).
12896 @var{reg} must be the name of a register.  The register names accepted
12897 are machine-specific and are defined in the @code{REGISTER_NAMES}
12898 macro in the machine description macro file.
12900 This flag does not have a negative form, because it specifies a
12901 three-way choice.
12903 @item -fcall-used-@var{reg}
12904 @opindex fcall-used
12905 Treat the register named @var{reg} as an allocable register that is
12906 clobbered by function calls.  It may be allocated for temporaries or
12907 variables that do not live across a call.  Functions compiled this way
12908 do not save and restore the register @var{reg}.
12910 It is an error to use this flag with the frame pointer or stack pointer.
12911 Use of this flag for other registers that have fixed pervasive roles in
12912 the machine's execution model produces disastrous results.
12914 This flag does not have a negative form, because it specifies a
12915 three-way choice.
12917 @item -fcall-saved-@var{reg}
12918 @opindex fcall-saved
12919 Treat the register named @var{reg} as an allocable register saved by
12920 functions.  It may be allocated even for temporaries or variables that
12921 live across a call.  Functions compiled this way save and restore
12922 the register @var{reg} if they use it.
12924 It is an error to use this flag with the frame pointer or stack pointer.
12925 Use of this flag for other registers that have fixed pervasive roles in
12926 the machine's execution model produces disastrous results.
12928 A different sort of disaster results from the use of this flag for
12929 a register in which function values may be returned.
12931 This flag does not have a negative form, because it specifies a
12932 three-way choice.
12934 @item -fpack-struct[=@var{n}]
12935 @opindex fpack-struct
12936 Without a value specified, pack all structure members together without
12937 holes.  When a value is specified (which must be a small power of two), pack
12938 structure members according to this value, representing the maximum
12939 alignment (that is, objects with default alignment requirements larger than
12940 this are output potentially unaligned at the next fitting location.
12942 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
12943 code that is not binary compatible with code generated without that switch.
12944 Additionally, it makes the code suboptimal.
12945 Use it to conform to a non-default application binary interface.
12947 @item -fleading-underscore
12948 @opindex fleading-underscore
12949 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
12950 change the way C symbols are represented in the object file.  One use
12951 is to help link with legacy assembly code.
12953 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
12954 generate code that is not binary compatible with code generated without that
12955 switch.  Use it to conform to a non-default application binary interface.
12956 Not all targets provide complete support for this switch.
12958 @item -ftls-model=@var{model}
12959 @opindex ftls-model
12960 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
12961 The @var{model} argument should be one of @samp{global-dynamic},
12962 @samp{local-dynamic}, @samp{initial-exec} or @samp{local-exec}.
12963 Note that the choice is subject to optimization: the compiler may use
12964 a more efficient model for symbols not visible outside of the translation
12965 unit, or if @option{-fpic} is not given on the command line.
12967 The default without @option{-fpic} is @samp{initial-exec}; with
12968 @option{-fpic} the default is @samp{global-dynamic}.
12970 @item -ftrampolines
12971 @opindex ftrampolines
12972 For targets that normally need trampolines for nested functions, always
12973 generate them instead of using descriptors.  Otherwise, for targets that
12974 do not need them, like for example HP-PA or IA-64, do nothing.
12976 A trampoline is a small piece of code that is created at run time on the
12977 stack when the address of a nested function is taken, and is used to call
12978 the nested function indirectly.  Therefore, it requires the stack to be
12979 made executable in order for the program to work properly.
12981 @option{-fno-trampolines} is enabled by default on a language by language
12982 basis to let the compiler avoid generating them, if it computes that this
12983 is safe, and replace them with descriptors.  Descriptors are made up of data
12984 only, but the generated code must be prepared to deal with them.  As of this
12985 writing, @option{-fno-trampolines} is enabled by default only for Ada.
12987 Moreover, code compiled with @option{-ftrampolines} and code compiled with
12988 @option{-fno-trampolines} are not binary compatible if nested functions are
12989 present.  This option must therefore be used on a program-wide basis and be
12990 manipulated with extreme care.
12992 @item -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]}
12993 @opindex fvisibility
12994 Set the default ELF image symbol visibility to the specified option---all
12995 symbols are marked with this unless overridden within the code.
12996 Using this feature can very substantially improve linking and
12997 load times of shared object libraries, produce more optimized
12998 code, provide near-perfect API export and prevent symbol clashes.
12999 It is @strong{strongly} recommended that you use this in any shared objects
13000 you distribute.
13002 Despite the nomenclature, @samp{default} always means public; i.e.,
13003 available to be linked against from outside the shared object.
13004 @samp{protected} and @samp{internal} are pretty useless in real-world
13005 usage so the only other commonly used option is @samp{hidden}.
13006 The default if @option{-fvisibility} isn't specified is
13007 @samp{default}, i.e., make every symbol public.
13009 A good explanation of the benefits offered by ensuring ELF
13010 symbols have the correct visibility is given by ``How To Write
13011 Shared Libraries'' by Ulrich Drepper (which can be found at
13012 @w{@uref{https://www.akkadia.org/drepper/}})---however a superior
13013 solution made possible by this option to marking things hidden when
13014 the default is public is to make the default hidden and mark things
13015 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
13016 and @code{__attribute__ ((visibility("default")))} instead of
13017 @code{__declspec(dllexport)} you get almost identical semantics with
13018 identical syntax.  This is a great boon to those working with
13019 cross-platform projects.
13021 For those adding visibility support to existing code, you may find
13022 @code{#pragma GCC visibility} of use.  This works by you enclosing
13023 the declarations you wish to set visibility for with (for example)
13024 @code{#pragma GCC visibility push(hidden)} and
13025 @code{#pragma GCC visibility pop}.
13026 Bear in mind that symbol visibility should be viewed @strong{as
13027 part of the API interface contract} and thus all new code should
13028 always specify visibility when it is not the default; i.e., declarations
13029 only for use within the local DSO should @strong{always} be marked explicitly
13030 as hidden as so to avoid PLT indirection overheads---making this
13031 abundantly clear also aids readability and self-documentation of the code.
13032 Note that due to ISO C++ specification requirements, @code{operator new} and
13033 @code{operator delete} must always be of default visibility.
13035 Be aware that headers from outside your project, in particular system
13036 headers and headers from any other library you use, may not be
13037 expecting to be compiled with visibility other than the default.  You
13038 may need to explicitly say @code{#pragma GCC visibility push(default)}
13039 before including any such headers.
13041 @code{extern} declarations are not affected by @option{-fvisibility}, so
13042 a lot of code can be recompiled with @option{-fvisibility=hidden} with
13043 no modifications.  However, this means that calls to @code{extern}
13044 functions with no explicit visibility use the PLT, so it is more
13045 effective to use @code{__attribute ((visibility))} and/or
13046 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
13047 declarations should be treated as hidden.
13049 Note that @option{-fvisibility} does affect C++ vague linkage
13050 entities. This means that, for instance, an exception class that is
13051 be thrown between DSOs must be explicitly marked with default
13052 visibility so that the @samp{type_info} nodes are unified between
13053 the DSOs.
13055 An overview of these techniques, their benefits and how to use them
13056 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
13058 @item -fstrict-volatile-bitfields
13059 @opindex fstrict-volatile-bitfields
13060 This option should be used if accesses to volatile bit-fields (or other
13061 structure fields, although the compiler usually honors those types
13062 anyway) should use a single access of the width of the
13063 field's type, aligned to a natural alignment if possible.  For
13064 example, targets with memory-mapped peripheral registers might require
13065 all such accesses to be 16 bits wide; with this flag you can
13066 declare all peripheral bit-fields as @code{unsigned short} (assuming short
13067 is 16 bits on these targets) to force GCC to use 16-bit accesses
13068 instead of, perhaps, a more efficient 32-bit access.
13070 If this option is disabled, the compiler uses the most efficient
13071 instruction.  In the previous example, that might be a 32-bit load
13072 instruction, even though that accesses bytes that do not contain
13073 any portion of the bit-field, or memory-mapped registers unrelated to
13074 the one being updated.
13076 In some cases, such as when the @code{packed} attribute is applied to a 
13077 structure field, it may not be possible to access the field with a single
13078 read or write that is correctly aligned for the target machine.  In this
13079 case GCC falls back to generating multiple accesses rather than code that 
13080 will fault or truncate the result at run time.
13082 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
13083 not allowed to touch non bit-field members.  It is therefore recommended
13084 to define all bits of the field's type as bit-field members.
13086 The default value of this option is determined by the application binary
13087 interface for the target processor.
13089 @item -fsync-libcalls
13090 @opindex fsync-libcalls
13091 This option controls whether any out-of-line instance of the @code{__sync}
13092 family of functions may be used to implement the C++11 @code{__atomic}
13093 family of functions.
13095 The default value of this option is enabled, thus the only useful form
13096 of the option is @option{-fno-sync-libcalls}.  This option is used in
13097 the implementation of the @file{libatomic} runtime library.
13099 @end table
13101 @node Developer Options
13102 @section GCC Developer Options
13103 @cindex developer options
13104 @cindex debugging GCC
13105 @cindex debug dump options
13106 @cindex dump options
13107 @cindex compilation statistics
13109 This section describes command-line options that are primarily of
13110 interest to GCC developers, including options to support compiler
13111 testing and investigation of compiler bugs and compile-time
13112 performance problems.  This includes options that produce debug dumps
13113 at various points in the compilation; that print statistics such as
13114 memory use and execution time; and that print information about GCC's
13115 configuration, such as where it searches for libraries.  You should
13116 rarely need to use any of these options for ordinary compilation and
13117 linking tasks.
13119 @table @gcctabopt
13121 @item -d@var{letters}
13122 @itemx -fdump-rtl-@var{pass}
13123 @itemx -fdump-rtl-@var{pass}=@var{filename}
13124 @opindex d
13125 @opindex fdump-rtl-@var{pass}
13126 Says to make debugging dumps during compilation at times specified by
13127 @var{letters}.  This is used for debugging the RTL-based passes of the
13128 compiler.  The file names for most of the dumps are made by appending
13129 a pass number and a word to the @var{dumpname}, and the files are
13130 created in the directory of the output file.  In case of
13131 @option{=@var{filename}} option, the dump is output on the given file
13132 instead of the pass numbered dump files.  Note that the pass number is
13133 assigned as passes are registered into the pass manager.  Most passes
13134 are registered in the order that they will execute and for these passes
13135 the number corresponds to the pass execution order.  However, passes
13136 registered by plugins, passes specific to compilation targets, or
13137 passes that are otherwise registered after all the other passes are
13138 numbered higher than a pass named "final", even if they are executed
13139 earlier.  @var{dumpname} is generated from the name of the output
13140 file if explicitly specified and not an executable, otherwise it is
13141 the basename of the source file.  
13143 Some @option{-d@var{letters}} switches have different meaning when
13144 @option{-E} is used for preprocessing.  @xref{Preprocessor Options},
13145 for information about preprocessor-specific dump options.
13147 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
13148 @option{-d} option @var{letters}.  Here are the possible
13149 letters for use in @var{pass} and @var{letters}, and their meanings:
13151 @table @gcctabopt
13153 @item -fdump-rtl-alignments
13154 @opindex fdump-rtl-alignments
13155 Dump after branch alignments have been computed.
13157 @item -fdump-rtl-asmcons
13158 @opindex fdump-rtl-asmcons
13159 Dump after fixing rtl statements that have unsatisfied in/out constraints.
13161 @item -fdump-rtl-auto_inc_dec
13162 @opindex fdump-rtl-auto_inc_dec
13163 Dump after auto-inc-dec discovery.  This pass is only run on
13164 architectures that have auto inc or auto dec instructions.
13166 @item -fdump-rtl-barriers
13167 @opindex fdump-rtl-barriers
13168 Dump after cleaning up the barrier instructions.
13170 @item -fdump-rtl-bbpart
13171 @opindex fdump-rtl-bbpart
13172 Dump after partitioning hot and cold basic blocks.
13174 @item -fdump-rtl-bbro
13175 @opindex fdump-rtl-bbro
13176 Dump after block reordering.
13178 @item -fdump-rtl-btl1
13179 @itemx -fdump-rtl-btl2
13180 @opindex fdump-rtl-btl2
13181 @opindex fdump-rtl-btl2
13182 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
13183 after the two branch
13184 target load optimization passes.
13186 @item -fdump-rtl-bypass
13187 @opindex fdump-rtl-bypass
13188 Dump after jump bypassing and control flow optimizations.
13190 @item -fdump-rtl-combine
13191 @opindex fdump-rtl-combine
13192 Dump after the RTL instruction combination pass.
13194 @item -fdump-rtl-compgotos
13195 @opindex fdump-rtl-compgotos
13196 Dump after duplicating the computed gotos.
13198 @item -fdump-rtl-ce1
13199 @itemx -fdump-rtl-ce2
13200 @itemx -fdump-rtl-ce3
13201 @opindex fdump-rtl-ce1
13202 @opindex fdump-rtl-ce2
13203 @opindex fdump-rtl-ce3
13204 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
13205 @option{-fdump-rtl-ce3} enable dumping after the three
13206 if conversion passes.
13208 @item -fdump-rtl-cprop_hardreg
13209 @opindex fdump-rtl-cprop_hardreg
13210 Dump after hard register copy propagation.
13212 @item -fdump-rtl-csa
13213 @opindex fdump-rtl-csa
13214 Dump after combining stack adjustments.
13216 @item -fdump-rtl-cse1
13217 @itemx -fdump-rtl-cse2
13218 @opindex fdump-rtl-cse1
13219 @opindex fdump-rtl-cse2
13220 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
13221 the two common subexpression elimination passes.
13223 @item -fdump-rtl-dce
13224 @opindex fdump-rtl-dce
13225 Dump after the standalone dead code elimination passes.
13227 @item -fdump-rtl-dbr
13228 @opindex fdump-rtl-dbr
13229 Dump after delayed branch scheduling.
13231 @item -fdump-rtl-dce1
13232 @itemx -fdump-rtl-dce2
13233 @opindex fdump-rtl-dce1
13234 @opindex fdump-rtl-dce2
13235 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
13236 the two dead store elimination passes.
13238 @item -fdump-rtl-eh
13239 @opindex fdump-rtl-eh
13240 Dump after finalization of EH handling code.
13242 @item -fdump-rtl-eh_ranges
13243 @opindex fdump-rtl-eh_ranges
13244 Dump after conversion of EH handling range regions.
13246 @item -fdump-rtl-expand
13247 @opindex fdump-rtl-expand
13248 Dump after RTL generation.
13250 @item -fdump-rtl-fwprop1
13251 @itemx -fdump-rtl-fwprop2
13252 @opindex fdump-rtl-fwprop1
13253 @opindex fdump-rtl-fwprop2
13254 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
13255 dumping after the two forward propagation passes.
13257 @item -fdump-rtl-gcse1
13258 @itemx -fdump-rtl-gcse2
13259 @opindex fdump-rtl-gcse1
13260 @opindex fdump-rtl-gcse2
13261 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
13262 after global common subexpression elimination.
13264 @item -fdump-rtl-init-regs
13265 @opindex fdump-rtl-init-regs
13266 Dump after the initialization of the registers.
13268 @item -fdump-rtl-initvals
13269 @opindex fdump-rtl-initvals
13270 Dump after the computation of the initial value sets.
13272 @item -fdump-rtl-into_cfglayout
13273 @opindex fdump-rtl-into_cfglayout
13274 Dump after converting to cfglayout mode.
13276 @item -fdump-rtl-ira
13277 @opindex fdump-rtl-ira
13278 Dump after iterated register allocation.
13280 @item -fdump-rtl-jump
13281 @opindex fdump-rtl-jump
13282 Dump after the second jump optimization.
13284 @item -fdump-rtl-loop2
13285 @opindex fdump-rtl-loop2
13286 @option{-fdump-rtl-loop2} enables dumping after the rtl
13287 loop optimization passes.
13289 @item -fdump-rtl-mach
13290 @opindex fdump-rtl-mach
13291 Dump after performing the machine dependent reorganization pass, if that
13292 pass exists.
13294 @item -fdump-rtl-mode_sw
13295 @opindex fdump-rtl-mode_sw
13296 Dump after removing redundant mode switches.
13298 @item -fdump-rtl-rnreg
13299 @opindex fdump-rtl-rnreg
13300 Dump after register renumbering.
13302 @item -fdump-rtl-outof_cfglayout
13303 @opindex fdump-rtl-outof_cfglayout
13304 Dump after converting from cfglayout mode.
13306 @item -fdump-rtl-peephole2
13307 @opindex fdump-rtl-peephole2
13308 Dump after the peephole pass.
13310 @item -fdump-rtl-postreload
13311 @opindex fdump-rtl-postreload
13312 Dump after post-reload optimizations.
13314 @item -fdump-rtl-pro_and_epilogue
13315 @opindex fdump-rtl-pro_and_epilogue
13316 Dump after generating the function prologues and epilogues.
13318 @item -fdump-rtl-sched1
13319 @itemx -fdump-rtl-sched2
13320 @opindex fdump-rtl-sched1
13321 @opindex fdump-rtl-sched2
13322 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
13323 after the basic block scheduling passes.
13325 @item -fdump-rtl-ree
13326 @opindex fdump-rtl-ree
13327 Dump after sign/zero extension elimination.
13329 @item -fdump-rtl-seqabstr
13330 @opindex fdump-rtl-seqabstr
13331 Dump after common sequence discovery.
13333 @item -fdump-rtl-shorten
13334 @opindex fdump-rtl-shorten
13335 Dump after shortening branches.
13337 @item -fdump-rtl-sibling
13338 @opindex fdump-rtl-sibling
13339 Dump after sibling call optimizations.
13341 @item -fdump-rtl-split1
13342 @itemx -fdump-rtl-split2
13343 @itemx -fdump-rtl-split3
13344 @itemx -fdump-rtl-split4
13345 @itemx -fdump-rtl-split5
13346 @opindex fdump-rtl-split1
13347 @opindex fdump-rtl-split2
13348 @opindex fdump-rtl-split3
13349 @opindex fdump-rtl-split4
13350 @opindex fdump-rtl-split5
13351 These options enable dumping after five rounds of
13352 instruction splitting.
13354 @item -fdump-rtl-sms
13355 @opindex fdump-rtl-sms
13356 Dump after modulo scheduling.  This pass is only run on some
13357 architectures.
13359 @item -fdump-rtl-stack
13360 @opindex fdump-rtl-stack
13361 Dump after conversion from GCC's ``flat register file'' registers to the
13362 x87's stack-like registers.  This pass is only run on x86 variants.
13364 @item -fdump-rtl-subreg1
13365 @itemx -fdump-rtl-subreg2
13366 @opindex fdump-rtl-subreg1
13367 @opindex fdump-rtl-subreg2
13368 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
13369 the two subreg expansion passes.
13371 @item -fdump-rtl-unshare
13372 @opindex fdump-rtl-unshare
13373 Dump after all rtl has been unshared.
13375 @item -fdump-rtl-vartrack
13376 @opindex fdump-rtl-vartrack
13377 Dump after variable tracking.
13379 @item -fdump-rtl-vregs
13380 @opindex fdump-rtl-vregs
13381 Dump after converting virtual registers to hard registers.
13383 @item -fdump-rtl-web
13384 @opindex fdump-rtl-web
13385 Dump after live range splitting.
13387 @item -fdump-rtl-regclass
13388 @itemx -fdump-rtl-subregs_of_mode_init
13389 @itemx -fdump-rtl-subregs_of_mode_finish
13390 @itemx -fdump-rtl-dfinit
13391 @itemx -fdump-rtl-dfinish
13392 @opindex fdump-rtl-regclass
13393 @opindex fdump-rtl-subregs_of_mode_init
13394 @opindex fdump-rtl-subregs_of_mode_finish
13395 @opindex fdump-rtl-dfinit
13396 @opindex fdump-rtl-dfinish
13397 These dumps are defined but always produce empty files.
13399 @item -da
13400 @itemx -fdump-rtl-all
13401 @opindex da
13402 @opindex fdump-rtl-all
13403 Produce all the dumps listed above.
13405 @item -dA
13406 @opindex dA
13407 Annotate the assembler output with miscellaneous debugging information.
13409 @item -dD
13410 @opindex dD
13411 Dump all macro definitions, at the end of preprocessing, in addition to
13412 normal output.
13414 @item -dH
13415 @opindex dH
13416 Produce a core dump whenever an error occurs.
13418 @item -dp
13419 @opindex dp
13420 Annotate the assembler output with a comment indicating which
13421 pattern and alternative is used.  The length and cost of each instruction are
13422 also printed.
13424 @item -dP
13425 @opindex dP
13426 Dump the RTL in the assembler output as a comment before each instruction.
13427 Also turns on @option{-dp} annotation.
13429 @item -dx
13430 @opindex dx
13431 Just generate RTL for a function instead of compiling it.  Usually used
13432 with @option{-fdump-rtl-expand}.
13433 @end table
13435 @item -fdump-noaddr
13436 @opindex fdump-noaddr
13437 When doing debugging dumps, suppress address output.  This makes it more
13438 feasible to use diff on debugging dumps for compiler invocations with
13439 different compiler binaries and/or different
13440 text / bss / data / heap / stack / dso start locations.
13442 @item -freport-bug
13443 @opindex freport-bug
13444 Collect and dump debug information into a temporary file if an
13445 internal compiler error (ICE) occurs.
13447 @item -fdump-unnumbered
13448 @opindex fdump-unnumbered
13449 When doing debugging dumps, suppress instruction numbers and address output.
13450 This makes it more feasible to use diff on debugging dumps for compiler
13451 invocations with different options, in particular with and without
13452 @option{-g}.
13454 @item -fdump-unnumbered-links
13455 @opindex fdump-unnumbered-links
13456 When doing debugging dumps (see @option{-d} option above), suppress
13457 instruction numbers for the links to the previous and next instructions
13458 in a sequence.
13460 @item -fdump-ipa-@var{switch}
13461 @opindex fdump-ipa
13462 Control the dumping at various stages of inter-procedural analysis
13463 language tree to a file.  The file name is generated by appending a
13464 switch specific suffix to the source file name, and the file is created
13465 in the same directory as the output file.  The following dumps are
13466 possible:
13468 @table @samp
13469 @item all
13470 Enables all inter-procedural analysis dumps.
13472 @item cgraph
13473 Dumps information about call-graph optimization, unused function removal,
13474 and inlining decisions.
13476 @item inline
13477 Dump after function inlining.
13479 @end table
13481 @item -fdump-lang-all
13482 @itemx -fdump-lang-@var{switch}
13483 @itemx -fdump-lang-@var{switch}-@var{options}
13484 @itemx -fdump-lang-@var{switch}-@var{options}=@var{filename}
13485 @opindex fdump-lang-all
13486 @opindex fdump-lang
13487 Control the dumping of language-specific information.  The @var{options}
13488 and @var{filename} portions behave as described in the
13489 @option{-fdump-tree} option.  The following @var{switch} values are
13490 accepted:
13492 @table @samp
13493 @item all
13495 Enable all language-specific dumps.
13497 @item class
13498 Dump class hierarchy information.  Virtual table information is emitted
13499 unless '@option{slim}' is specified.  This option is applicable to C++ only.
13501 @item raw
13502 Dump the raw internal tree data.  This option is applicable to C++ only.
13504 @end table
13506 @item -fdump-passes
13507 @opindex fdump-passes
13508 Print on @file{stderr} the list of optimization passes that are turned
13509 on and off by the current command-line options.
13511 @item -fdump-statistics-@var{option}
13512 @opindex fdump-statistics
13513 Enable and control dumping of pass statistics in a separate file.  The
13514 file name is generated by appending a suffix ending in
13515 @samp{.statistics} to the source file name, and the file is created in
13516 the same directory as the output file.  If the @samp{-@var{option}}
13517 form is used, @samp{-stats} causes counters to be summed over the
13518 whole compilation unit while @samp{-details} dumps every event as
13519 the passes generate them.  The default with no option is to sum
13520 counters for each function compiled.
13522 @item -fdump-tree-all
13523 @itemx -fdump-tree-@var{switch}
13524 @itemx -fdump-tree-@var{switch}-@var{options}
13525 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
13526 @opindex fdump-tree-all
13527 @opindex fdump-tree
13528 Control the dumping at various stages of processing the intermediate
13529 language tree to a file.  The file name is generated by appending a
13530 switch-specific suffix to the source file name, and the file is
13531 created in the same directory as the output file. In case of
13532 @option{=@var{filename}} option, the dump is output on the given file
13533 instead of the auto named dump files.  If the @samp{-@var{options}}
13534 form is used, @var{options} is a list of @samp{-} separated options
13535 which control the details of the dump.  Not all options are applicable
13536 to all dumps; those that are not meaningful are ignored.  The
13537 following options are available
13539 @table @samp
13540 @item address
13541 Print the address of each node.  Usually this is not meaningful as it
13542 changes according to the environment and source file.  Its primary use
13543 is for tying up a dump file with a debug environment.
13544 @item asmname
13545 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
13546 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
13547 use working backward from mangled names in the assembly file.
13548 @item slim
13549 When dumping front-end intermediate representations, inhibit dumping
13550 of members of a scope or body of a function merely because that scope
13551 has been reached.  Only dump such items when they are directly reachable
13552 by some other path.
13554 When dumping pretty-printed trees, this option inhibits dumping the
13555 bodies of control structures.
13557 When dumping RTL, print the RTL in slim (condensed) form instead of
13558 the default LISP-like representation.
13559 @item raw
13560 Print a raw representation of the tree.  By default, trees are
13561 pretty-printed into a C-like representation.
13562 @item details
13563 Enable more detailed dumps (not honored by every dump option). Also
13564 include information from the optimization passes.
13565 @item stats
13566 Enable dumping various statistics about the pass (not honored by every dump
13567 option).
13568 @item blocks
13569 Enable showing basic block boundaries (disabled in raw dumps).
13570 @item graph
13571 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
13572 dump a representation of the control flow graph suitable for viewing with
13573 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
13574 the file is pretty-printed as a subgraph, so that GraphViz can render them
13575 all in a single plot.
13577 This option currently only works for RTL dumps, and the RTL is always
13578 dumped in slim form.
13579 @item vops
13580 Enable showing virtual operands for every statement.
13581 @item lineno
13582 Enable showing line numbers for statements.
13583 @item uid
13584 Enable showing the unique ID (@code{DECL_UID}) for each variable.
13585 @item verbose
13586 Enable showing the tree dump for each statement.
13587 @item eh
13588 Enable showing the EH region number holding each statement.
13589 @item scev
13590 Enable showing scalar evolution analysis details.
13591 @item optimized
13592 Enable showing optimization information (only available in certain
13593 passes).
13594 @item missed
13595 Enable showing missed optimization information (only available in certain
13596 passes).
13597 @item note
13598 Enable other detailed optimization information (only available in
13599 certain passes).
13600 @item =@var{filename}
13601 Instead of an auto named dump file, output into the given file
13602 name. The file names @file{stdout} and @file{stderr} are treated
13603 specially and are considered already open standard streams. For
13604 example,
13606 @smallexample
13607 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
13608      -fdump-tree-pre=/dev/stderr file.c
13609 @end smallexample
13611 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
13612 output on to @file{stderr}. If two conflicting dump filenames are
13613 given for the same pass, then the latter option overrides the earlier
13614 one.
13616 @item all
13617 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
13618 and @option{lineno}.
13620 @item optall
13621 Turn on all optimization options, i.e., @option{optimized},
13622 @option{missed}, and @option{note}.
13623 @end table
13625 To determine what tree dumps are available or find the dump for a pass
13626 of interest follow the steps below.
13628 @enumerate
13629 @item
13630 Invoke GCC with @option{-fdump-passes} and in the @file{stderr} output
13631 look for a code that corresponds to the pass you are interested in.
13632 For example, the codes @code{tree-evrp}, @code{tree-vrp1}, and
13633 @code{tree-vrp2} correspond to the three Value Range Propagation passes.
13634 The number at the end distinguishes distinct invocations of the same pass.
13635 @item
13636 To enable the creation of the dump file, append the pass code to
13637 the @option{-fdump-} option prefix and invoke GCC with it.  For example,
13638 to enable the dump from the Early Value Range Propagation pass, invoke
13639 GCC with the @option{-fdump-tree-evrp} option.  Optionally, you may
13640 specify the name of the dump file.  If you don't specify one, GCC
13641 creates as described below.
13642 @item
13643 Find the pass dump in a file whose name is composed of three components
13644 separated by a period: the name of the source file GCC was invoked to
13645 compile, a numeric suffix indicating the pass number followed by the
13646 letter @samp{t} for tree passes (and the letter @samp{r} for RTL passes),
13647 and finally the pass code.  For example, the Early VRP pass dump might
13648 be in a file named @file{myfile.c.038t.evrp} in the current working
13649 directory.  Note that the numeric codes are not stable and may change
13650 from one version of GCC to another.
13651 @end enumerate
13653 @item -fopt-info
13654 @itemx -fopt-info-@var{options}
13655 @itemx -fopt-info-@var{options}=@var{filename}
13656 @opindex fopt-info
13657 Controls optimization dumps from various optimization passes. If the
13658 @samp{-@var{options}} form is used, @var{options} is a list of
13659 @samp{-} separated option keywords to select the dump details and
13660 optimizations.  
13662 The @var{options} can be divided into two groups: options describing the
13663 verbosity of the dump, and options describing which optimizations
13664 should be included. The options from both the groups can be freely
13665 mixed as they are non-overlapping. However, in case of any conflicts,
13666 the later options override the earlier options on the command
13667 line. 
13669 The following options control the dump verbosity:
13671 @table @samp
13672 @item optimized
13673 Print information when an optimization is successfully applied. It is
13674 up to a pass to decide which information is relevant. For example, the
13675 vectorizer passes print the source location of loops which are
13676 successfully vectorized.
13677 @item missed
13678 Print information about missed optimizations. Individual passes
13679 control which information to include in the output. 
13680 @item note
13681 Print verbose information about optimizations, such as certain
13682 transformations, more detailed messages about decisions etc.
13683 @item all
13684 Print detailed optimization information. This includes
13685 @samp{optimized}, @samp{missed}, and @samp{note}.
13686 @end table
13688 One or more of the following option keywords can be used to describe a
13689 group of optimizations:
13691 @table @samp
13692 @item ipa
13693 Enable dumps from all interprocedural optimizations.
13694 @item loop
13695 Enable dumps from all loop optimizations.
13696 @item inline
13697 Enable dumps from all inlining optimizations.
13698 @item omp
13699 Enable dumps from all OMP (Offloading and Multi Processing) optimizations.
13700 @item vec
13701 Enable dumps from all vectorization optimizations.
13702 @item optall
13703 Enable dumps from all optimizations. This is a superset of
13704 the optimization groups listed above.
13705 @end table
13707 If @var{options} is
13708 omitted, it defaults to @samp{optimized-optall}, which means to dump all
13709 info about successful optimizations from all the passes.  
13711 If the @var{filename} is provided, then the dumps from all the
13712 applicable optimizations are concatenated into the @var{filename}.
13713 Otherwise the dump is output onto @file{stderr}. Though multiple
13714 @option{-fopt-info} options are accepted, only one of them can include
13715 a @var{filename}. If other filenames are provided then all but the
13716 first such option are ignored.
13718 Note that the output @var{filename} is overwritten
13719 in case of multiple translation units. If a combined output from
13720 multiple translation units is desired, @file{stderr} should be used
13721 instead.
13723 In the following example, the optimization info is output to
13724 @file{stderr}:
13726 @smallexample
13727 gcc -O3 -fopt-info
13728 @end smallexample
13730 This example:
13731 @smallexample
13732 gcc -O3 -fopt-info-missed=missed.all
13733 @end smallexample
13735 @noindent
13736 outputs missed optimization report from all the passes into
13737 @file{missed.all}, and this one:
13739 @smallexample
13740 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
13741 @end smallexample
13743 @noindent
13744 prints information about missed optimization opportunities from
13745 vectorization passes on @file{stderr}.  
13746 Note that @option{-fopt-info-vec-missed} is equivalent to 
13747 @option{-fopt-info-missed-vec}.  The order of the optimization group
13748 names and message types listed after @option{-fopt-info} does not matter.
13750 As another example,
13751 @smallexample
13752 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
13753 @end smallexample
13755 @noindent
13756 outputs information about missed optimizations as well as
13757 optimized locations from all the inlining passes into
13758 @file{inline.txt}.
13760 Finally, consider:
13762 @smallexample
13763 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
13764 @end smallexample
13766 @noindent
13767 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
13768 in conflict since only one output file is allowed. In this case, only
13769 the first option takes effect and the subsequent options are
13770 ignored. Thus only @file{vec.miss} is produced which contains
13771 dumps from the vectorizer about missed opportunities.
13773 @item -fsched-verbose=@var{n}
13774 @opindex fsched-verbose
13775 On targets that use instruction scheduling, this option controls the
13776 amount of debugging output the scheduler prints to the dump files.
13778 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
13779 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
13780 For @var{n} greater than one, it also output basic block probabilities,
13781 detailed ready list information and unit/insn info.  For @var{n} greater
13782 than two, it includes RTL at abort point, control-flow and regions info.
13783 And for @var{n} over four, @option{-fsched-verbose} also includes
13784 dependence info.
13788 @item -fenable-@var{kind}-@var{pass}
13789 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
13790 @opindex fdisable-
13791 @opindex fenable-
13793 This is a set of options that are used to explicitly disable/enable
13794 optimization passes.  These options are intended for use for debugging GCC.
13795 Compiler users should use regular options for enabling/disabling
13796 passes instead.
13798 @table @gcctabopt
13800 @item -fdisable-ipa-@var{pass}
13801 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
13802 statically invoked in the compiler multiple times, the pass name should be
13803 appended with a sequential number starting from 1.
13805 @item -fdisable-rtl-@var{pass}
13806 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
13807 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
13808 statically invoked in the compiler multiple times, the pass name should be
13809 appended with a sequential number starting from 1.  @var{range-list} is a 
13810 comma-separated list of function ranges or assembler names.  Each range is a number
13811 pair separated by a colon.  The range is inclusive in both ends.  If the range
13812 is trivial, the number pair can be simplified as a single number.  If the
13813 function's call graph node's @var{uid} falls within one of the specified ranges,
13814 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
13815 function header of a dump file, and the pass names can be dumped by using
13816 option @option{-fdump-passes}.
13818 @item -fdisable-tree-@var{pass}
13819 @itemx -fdisable-tree-@var{pass}=@var{range-list}
13820 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
13821 option arguments.
13823 @item -fenable-ipa-@var{pass}
13824 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
13825 statically invoked in the compiler multiple times, the pass name should be
13826 appended with a sequential number starting from 1.
13828 @item -fenable-rtl-@var{pass}
13829 @itemx -fenable-rtl-@var{pass}=@var{range-list}
13830 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
13831 description and examples.
13833 @item -fenable-tree-@var{pass}
13834 @itemx -fenable-tree-@var{pass}=@var{range-list}
13835 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
13836 of option arguments.
13838 @end table
13840 Here are some examples showing uses of these options.
13842 @smallexample
13844 # disable ccp1 for all functions
13845    -fdisable-tree-ccp1
13846 # disable complete unroll for function whose cgraph node uid is 1
13847    -fenable-tree-cunroll=1
13848 # disable gcse2 for functions at the following ranges [1,1],
13849 # [300,400], and [400,1000]
13850 # disable gcse2 for functions foo and foo2
13851    -fdisable-rtl-gcse2=foo,foo2
13852 # disable early inlining
13853    -fdisable-tree-einline
13854 # disable ipa inlining
13855    -fdisable-ipa-inline
13856 # enable tree full unroll
13857    -fenable-tree-unroll
13859 @end smallexample
13861 @item -fchecking
13862 @itemx -fchecking=@var{n}
13863 @opindex fchecking
13864 @opindex fno-checking
13865 Enable internal consistency checking.  The default depends on
13866 the compiler configuration.  @option{-fchecking=2} enables further
13867 internal consistency checking that might affect code generation.
13869 @item -frandom-seed=@var{string}
13870 @opindex frandom-seed
13871 This option provides a seed that GCC uses in place of
13872 random numbers in generating certain symbol names
13873 that have to be different in every compiled file.  It is also used to
13874 place unique stamps in coverage data files and the object files that
13875 produce them.  You can use the @option{-frandom-seed} option to produce
13876 reproducibly identical object files.
13878 The @var{string} can either be a number (decimal, octal or hex) or an
13879 arbitrary string (in which case it's converted to a number by
13880 computing CRC32).
13882 The @var{string} should be different for every file you compile.
13884 @item -save-temps
13885 @itemx -save-temps=cwd
13886 @opindex save-temps
13887 Store the usual ``temporary'' intermediate files permanently; place them
13888 in the current directory and name them based on the source file.  Thus,
13889 compiling @file{foo.c} with @option{-c -save-temps} produces files
13890 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
13891 preprocessed @file{foo.i} output file even though the compiler now
13892 normally uses an integrated preprocessor.
13894 When used in combination with the @option{-x} command-line option,
13895 @option{-save-temps} is sensible enough to avoid over writing an
13896 input source file with the same extension as an intermediate file.
13897 The corresponding intermediate file may be obtained by renaming the
13898 source file before using @option{-save-temps}.
13900 If you invoke GCC in parallel, compiling several different source
13901 files that share a common base name in different subdirectories or the
13902 same source file compiled for multiple output destinations, it is
13903 likely that the different parallel compilers will interfere with each
13904 other, and overwrite the temporary files.  For instance:
13906 @smallexample
13907 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
13908 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
13909 @end smallexample
13911 may result in @file{foo.i} and @file{foo.o} being written to
13912 simultaneously by both compilers.
13914 @item -save-temps=obj
13915 @opindex save-temps=obj
13916 Store the usual ``temporary'' intermediate files permanently.  If the
13917 @option{-o} option is used, the temporary files are based on the
13918 object file.  If the @option{-o} option is not used, the
13919 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
13921 For example:
13923 @smallexample
13924 gcc -save-temps=obj -c foo.c
13925 gcc -save-temps=obj -c bar.c -o dir/xbar.o
13926 gcc -save-temps=obj foobar.c -o dir2/yfoobar
13927 @end smallexample
13929 @noindent
13930 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
13931 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
13932 @file{dir2/yfoobar.o}.
13934 @item -time@r{[}=@var{file}@r{]}
13935 @opindex time
13936 Report the CPU time taken by each subprocess in the compilation
13937 sequence.  For C source files, this is the compiler proper and assembler
13938 (plus the linker if linking is done).
13940 Without the specification of an output file, the output looks like this:
13942 @smallexample
13943 # cc1 0.12 0.01
13944 # as 0.00 0.01
13945 @end smallexample
13947 The first number on each line is the ``user time'', that is time spent
13948 executing the program itself.  The second number is ``system time'',
13949 time spent executing operating system routines on behalf of the program.
13950 Both numbers are in seconds.
13952 With the specification of an output file, the output is appended to the
13953 named file, and it looks like this:
13955 @smallexample
13956 0.12 0.01 cc1 @var{options}
13957 0.00 0.01 as @var{options}
13958 @end smallexample
13960 The ``user time'' and the ``system time'' are moved before the program
13961 name, and the options passed to the program are displayed, so that one
13962 can later tell what file was being compiled, and with which options.
13964 @item -fdump-final-insns@r{[}=@var{file}@r{]}
13965 @opindex fdump-final-insns
13966 Dump the final internal representation (RTL) to @var{file}.  If the
13967 optional argument is omitted (or if @var{file} is @code{.}), the name
13968 of the dump file is determined by appending @code{.gkd} to the
13969 compilation output file name.
13971 @item -fcompare-debug@r{[}=@var{opts}@r{]}
13972 @opindex fcompare-debug
13973 @opindex fno-compare-debug
13974 If no error occurs during compilation, run the compiler a second time,
13975 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
13976 passed to the second compilation.  Dump the final internal
13977 representation in both compilations, and print an error if they differ.
13979 If the equal sign is omitted, the default @option{-gtoggle} is used.
13981 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
13982 and nonzero, implicitly enables @option{-fcompare-debug}.  If
13983 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
13984 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
13985 is used.
13987 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
13988 is equivalent to @option{-fno-compare-debug}, which disables the dumping
13989 of the final representation and the second compilation, preventing even
13990 @env{GCC_COMPARE_DEBUG} from taking effect.
13992 To verify full coverage during @option{-fcompare-debug} testing, set
13993 @env{GCC_COMPARE_DEBUG} to say @option{-fcompare-debug-not-overridden},
13994 which GCC rejects as an invalid option in any actual compilation
13995 (rather than preprocessing, assembly or linking).  To get just a
13996 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
13997 not overridden} will do.
13999 @item -fcompare-debug-second
14000 @opindex fcompare-debug-second
14001 This option is implicitly passed to the compiler for the second
14002 compilation requested by @option{-fcompare-debug}, along with options to
14003 silence warnings, and omitting other options that would cause
14004 side-effect compiler outputs to files or to the standard output.  Dump
14005 files and preserved temporary files are renamed so as to contain the
14006 @code{.gk} additional extension during the second compilation, to avoid
14007 overwriting those generated by the first.
14009 When this option is passed to the compiler driver, it causes the
14010 @emph{first} compilation to be skipped, which makes it useful for little
14011 other than debugging the compiler proper.
14013 @item -gtoggle
14014 @opindex gtoggle
14015 Turn off generation of debug info, if leaving out this option
14016 generates it, or turn it on at level 2 otherwise.  The position of this
14017 argument in the command line does not matter; it takes effect after all
14018 other options are processed, and it does so only once, no matter how
14019 many times it is given.  This is mainly intended to be used with
14020 @option{-fcompare-debug}.
14022 @item -fvar-tracking-assignments-toggle
14023 @opindex fvar-tracking-assignments-toggle
14024 @opindex fno-var-tracking-assignments-toggle
14025 Toggle @option{-fvar-tracking-assignments}, in the same way that
14026 @option{-gtoggle} toggles @option{-g}.
14028 @item -Q
14029 @opindex Q
14030 Makes the compiler print out each function name as it is compiled, and
14031 print some statistics about each pass when it finishes.
14033 @item -ftime-report
14034 @opindex ftime-report
14035 Makes the compiler print some statistics about the time consumed by each
14036 pass when it finishes.
14038 @item -ftime-report-details
14039 @opindex ftime-report-details
14040 Record the time consumed by infrastructure parts separately for each pass.
14042 @item -fira-verbose=@var{n}
14043 @opindex fira-verbose
14044 Control the verbosity of the dump file for the integrated register allocator.
14045 The default value is 5.  If the value @var{n} is greater or equal to 10,
14046 the dump output is sent to stderr using the same format as @var{n} minus 10.
14048 @item -flto-report
14049 @opindex flto-report
14050 Prints a report with internal details on the workings of the link-time
14051 optimizer.  The contents of this report vary from version to version.
14052 It is meant to be useful to GCC developers when processing object
14053 files in LTO mode (via @option{-flto}).
14055 Disabled by default.
14057 @item -flto-report-wpa
14058 @opindex flto-report-wpa
14059 Like @option{-flto-report}, but only print for the WPA phase of Link
14060 Time Optimization.
14062 @item -fmem-report
14063 @opindex fmem-report
14064 Makes the compiler print some statistics about permanent memory
14065 allocation when it finishes.
14067 @item -fmem-report-wpa
14068 @opindex fmem-report-wpa
14069 Makes the compiler print some statistics about permanent memory
14070 allocation for the WPA phase only.
14072 @item -fpre-ipa-mem-report
14073 @opindex fpre-ipa-mem-report
14074 @item -fpost-ipa-mem-report
14075 @opindex fpost-ipa-mem-report
14076 Makes the compiler print some statistics about permanent memory
14077 allocation before or after interprocedural optimization.
14079 @item -fprofile-report
14080 @opindex fprofile-report
14081 Makes the compiler print some statistics about consistency of the
14082 (estimated) profile and effect of individual passes.
14084 @item -fstack-usage
14085 @opindex fstack-usage
14086 Makes the compiler output stack usage information for the program, on a
14087 per-function basis.  The filename for the dump is made by appending
14088 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
14089 the output file, if explicitly specified and it is not an executable,
14090 otherwise it is the basename of the source file.  An entry is made up
14091 of three fields:
14093 @itemize
14094 @item
14095 The name of the function.
14096 @item
14097 A number of bytes.
14098 @item
14099 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
14100 @end itemize
14102 The qualifier @code{static} means that the function manipulates the stack
14103 statically: a fixed number of bytes are allocated for the frame on function
14104 entry and released on function exit; no stack adjustments are otherwise made
14105 in the function.  The second field is this fixed number of bytes.
14107 The qualifier @code{dynamic} means that the function manipulates the stack
14108 dynamically: in addition to the static allocation described above, stack
14109 adjustments are made in the body of the function, for example to push/pop
14110 arguments around function calls.  If the qualifier @code{bounded} is also
14111 present, the amount of these adjustments is bounded at compile time and
14112 the second field is an upper bound of the total amount of stack used by
14113 the function.  If it is not present, the amount of these adjustments is
14114 not bounded at compile time and the second field only represents the
14115 bounded part.
14117 @item -fstats
14118 @opindex fstats
14119 Emit statistics about front-end processing at the end of the compilation.
14120 This option is supported only by the C++ front end, and
14121 the information is generally only useful to the G++ development team.
14123 @item -fdbg-cnt-list
14124 @opindex fdbg-cnt-list
14125 Print the name and the counter upper bound for all debug counters.
14128 @item -fdbg-cnt=@var{counter-value-list}
14129 @opindex fdbg-cnt
14130 Set the internal debug counter upper bound.  @var{counter-value-list}
14131 is a comma-separated list of @var{name}:@var{value} pairs
14132 which sets the upper bound of each debug counter @var{name} to @var{value}.
14133 All debug counters have the initial upper bound of @code{UINT_MAX};
14134 thus @code{dbg_cnt} returns true always unless the upper bound
14135 is set by this option.
14136 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
14137 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
14139 @item -print-file-name=@var{library}
14140 @opindex print-file-name
14141 Print the full absolute name of the library file @var{library} that
14142 would be used when linking---and don't do anything else.  With this
14143 option, GCC does not compile or link anything; it just prints the
14144 file name.
14146 @item -print-multi-directory
14147 @opindex print-multi-directory
14148 Print the directory name corresponding to the multilib selected by any
14149 other switches present in the command line.  This directory is supposed
14150 to exist in @env{GCC_EXEC_PREFIX}.
14152 @item -print-multi-lib
14153 @opindex print-multi-lib
14154 Print the mapping from multilib directory names to compiler switches
14155 that enable them.  The directory name is separated from the switches by
14156 @samp{;}, and each switch starts with an @samp{@@} instead of the
14157 @samp{-}, without spaces between multiple switches.  This is supposed to
14158 ease shell processing.
14160 @item -print-multi-os-directory
14161 @opindex print-multi-os-directory
14162 Print the path to OS libraries for the selected
14163 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
14164 present in the @file{lib} subdirectory and no multilibs are used, this is
14165 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
14166 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
14167 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
14168 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
14170 @item -print-multiarch
14171 @opindex print-multiarch
14172 Print the path to OS libraries for the selected multiarch,
14173 relative to some @file{lib} subdirectory.
14175 @item -print-prog-name=@var{program}
14176 @opindex print-prog-name
14177 Like @option{-print-file-name}, but searches for a program such as @command{cpp}.
14179 @item -print-libgcc-file-name
14180 @opindex print-libgcc-file-name
14181 Same as @option{-print-file-name=libgcc.a}.
14183 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
14184 but you do want to link with @file{libgcc.a}.  You can do:
14186 @smallexample
14187 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
14188 @end smallexample
14190 @item -print-search-dirs
14191 @opindex print-search-dirs
14192 Print the name of the configured installation directory and a list of
14193 program and library directories @command{gcc} searches---and don't do anything else.
14195 This is useful when @command{gcc} prints the error message
14196 @samp{installation problem, cannot exec cpp0: No such file or directory}.
14197 To resolve this you either need to put @file{cpp0} and the other compiler
14198 components where @command{gcc} expects to find them, or you can set the environment
14199 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
14200 Don't forget the trailing @samp{/}.
14201 @xref{Environment Variables}.
14203 @item -print-sysroot
14204 @opindex print-sysroot
14205 Print the target sysroot directory that is used during
14206 compilation.  This is the target sysroot specified either at configure
14207 time or using the @option{--sysroot} option, possibly with an extra
14208 suffix that depends on compilation options.  If no target sysroot is
14209 specified, the option prints nothing.
14211 @item -print-sysroot-headers-suffix
14212 @opindex print-sysroot-headers-suffix
14213 Print the suffix added to the target sysroot when searching for
14214 headers, or give an error if the compiler is not configured with such
14215 a suffix---and don't do anything else.
14217 @item -dumpmachine
14218 @opindex dumpmachine
14219 Print the compiler's target machine (for example,
14220 @samp{i686-pc-linux-gnu})---and don't do anything else.
14222 @item -dumpversion
14223 @opindex dumpversion
14224 Print the compiler version (for example, @code{3.0}, @code{6.3.0} or @code{7})---and don't do
14225 anything else.  This is the compiler version used in filesystem paths,
14226 specs, can be depending on how the compiler has been configured just
14227 a single number (major version), two numbers separated by dot (major and
14228 minor version) or three numbers separated by dots (major, minor and patchlevel
14229 version).
14231 @item -dumpfullversion
14232 @opindex dumpfullversion
14233 Print the full compiler version, always 3 numbers separated by dots,
14234 major, minor and patchlevel version.
14236 @item -dumpspecs
14237 @opindex dumpspecs
14238 Print the compiler's built-in specs---and don't do anything else.  (This
14239 is used when GCC itself is being built.)  @xref{Spec Files}.
14240 @end table
14242 @node Submodel Options
14243 @section Machine-Dependent Options
14244 @cindex submodel options
14245 @cindex specifying hardware config
14246 @cindex hardware models and configurations, specifying
14247 @cindex target-dependent options
14248 @cindex machine-dependent options
14250 Each target machine supported by GCC can have its own options---for
14251 example, to allow you to compile for a particular processor variant or
14252 ABI, or to control optimizations specific to that machine.  By
14253 convention, the names of machine-specific options start with
14254 @samp{-m}.
14256 Some configurations of the compiler also support additional target-specific
14257 options, usually for compatibility with other compilers on the same
14258 platform.
14260 @c This list is ordered alphanumerically by subsection name.
14261 @c It should be the same order and spelling as these options are listed
14262 @c in Machine Dependent Options
14264 @menu
14265 * AArch64 Options::
14266 * Adapteva Epiphany Options::
14267 * ARC Options::
14268 * ARM Options::
14269 * AVR Options::
14270 * Blackfin Options::
14271 * C6X Options::
14272 * CRIS Options::
14273 * CR16 Options::
14274 * Darwin Options::
14275 * DEC Alpha Options::
14276 * FR30 Options::
14277 * FT32 Options::
14278 * FRV Options::
14279 * GNU/Linux Options::
14280 * H8/300 Options::
14281 * HPPA Options::
14282 * IA-64 Options::
14283 * LM32 Options::
14284 * M32C Options::
14285 * M32R/D Options::
14286 * M680x0 Options::
14287 * MCore Options::
14288 * MeP Options::
14289 * MicroBlaze Options::
14290 * MIPS Options::
14291 * MMIX Options::
14292 * MN10300 Options::
14293 * Moxie Options::
14294 * MSP430 Options::
14295 * NDS32 Options::
14296 * Nios II Options::
14297 * Nvidia PTX Options::
14298 * PDP-11 Options::
14299 * picoChip Options::
14300 * PowerPC Options::
14301 * RISC-V Options::
14302 * RL78 Options::
14303 * RS/6000 and PowerPC Options::
14304 * RX Options::
14305 * S/390 and zSeries Options::
14306 * Score Options::
14307 * SH Options::
14308 * Solaris 2 Options::
14309 * SPARC Options::
14310 * SPU Options::
14311 * System V Options::
14312 * TILE-Gx Options::
14313 * TILEPro Options::
14314 * V850 Options::
14315 * VAX Options::
14316 * Visium Options::
14317 * VMS Options::
14318 * VxWorks Options::
14319 * x86 Options::
14320 * x86 Windows Options::
14321 * Xstormy16 Options::
14322 * Xtensa Options::
14323 * zSeries Options::
14324 @end menu
14326 @node AArch64 Options
14327 @subsection AArch64 Options
14328 @cindex AArch64 Options
14330 These options are defined for AArch64 implementations:
14332 @table @gcctabopt
14334 @item -mabi=@var{name}
14335 @opindex mabi
14336 Generate code for the specified data model.  Permissible values
14337 are @samp{ilp32} for SysV-like data model where int, long int and pointers
14338 are 32 bits, and @samp{lp64} for SysV-like data model where int is 32 bits,
14339 but long int and pointers are 64 bits.
14341 The default depends on the specific target configuration.  Note that
14342 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
14343 entire program with the same ABI, and link with a compatible set of libraries.
14345 @item -mbig-endian
14346 @opindex mbig-endian
14347 Generate big-endian code.  This is the default when GCC is configured for an
14348 @samp{aarch64_be-*-*} target.
14350 @item -mgeneral-regs-only
14351 @opindex mgeneral-regs-only
14352 Generate code which uses only the general-purpose registers.  This will prevent
14353 the compiler from using floating-point and Advanced SIMD registers but will not
14354 impose any restrictions on the assembler.
14356 @item -mlittle-endian
14357 @opindex mlittle-endian
14358 Generate little-endian code.  This is the default when GCC is configured for an
14359 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
14361 @item -mcmodel=tiny
14362 @opindex mcmodel=tiny
14363 Generate code for the tiny code model.  The program and its statically defined
14364 symbols must be within 1MB of each other.  Programs can be statically or
14365 dynamically linked.
14367 @item -mcmodel=small
14368 @opindex mcmodel=small
14369 Generate code for the small code model.  The program and its statically defined
14370 symbols must be within 4GB of each other.  Programs can be statically or
14371 dynamically linked.  This is the default code model.
14373 @item -mcmodel=large
14374 @opindex mcmodel=large
14375 Generate code for the large code model.  This makes no assumptions about
14376 addresses and sizes of sections.  Programs can be statically linked only.
14378 @item -mstrict-align
14379 @opindex mstrict-align
14380 Avoid generating memory accesses that may not be aligned on a natural object
14381 boundary as described in the architecture specification.
14383 @item -momit-leaf-frame-pointer
14384 @itemx -mno-omit-leaf-frame-pointer
14385 @opindex momit-leaf-frame-pointer
14386 @opindex mno-omit-leaf-frame-pointer
14387 Omit or keep the frame pointer in leaf functions.  The former behavior is the
14388 default.
14390 @item -mtls-dialect=desc
14391 @opindex mtls-dialect=desc
14392 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
14393 of TLS variables.  This is the default.
14395 @item -mtls-dialect=traditional
14396 @opindex mtls-dialect=traditional
14397 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
14398 of TLS variables.
14400 @item -mtls-size=@var{size}
14401 @opindex mtls-size
14402 Specify bit size of immediate TLS offsets.  Valid values are 12, 24, 32, 48.
14403 This option requires binutils 2.26 or newer.
14405 @item -mfix-cortex-a53-835769
14406 @itemx -mno-fix-cortex-a53-835769
14407 @opindex mfix-cortex-a53-835769
14408 @opindex mno-fix-cortex-a53-835769
14409 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
14410 This involves inserting a NOP instruction between memory instructions and
14411 64-bit integer multiply-accumulate instructions.
14413 @item -mfix-cortex-a53-843419
14414 @itemx -mno-fix-cortex-a53-843419
14415 @opindex mfix-cortex-a53-843419
14416 @opindex mno-fix-cortex-a53-843419
14417 Enable or disable the workaround for the ARM Cortex-A53 erratum number 843419.
14418 This erratum workaround is made at link time and this will only pass the
14419 corresponding flag to the linker.
14421 @item -mlow-precision-recip-sqrt
14422 @item -mno-low-precision-recip-sqrt
14423 @opindex mlow-precision-recip-sqrt
14424 @opindex mno-low-precision-recip-sqrt
14425 Enable or disable the reciprocal square root approximation.
14426 This option only has an effect if @option{-ffast-math} or
14427 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14428 precision of reciprocal square root results to about 16 bits for
14429 single precision and to 32 bits for double precision.
14431 @item -mlow-precision-sqrt
14432 @item -mno-low-precision-sqrt
14433 @opindex -mlow-precision-sqrt
14434 @opindex -mno-low-precision-sqrt
14435 Enable or disable the square root approximation.
14436 This option only has an effect if @option{-ffast-math} or
14437 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14438 precision of square root results to about 16 bits for
14439 single precision and to 32 bits for double precision.
14440 If enabled, it implies @option{-mlow-precision-recip-sqrt}.
14442 @item -mlow-precision-div
14443 @item -mno-low-precision-div
14444 @opindex -mlow-precision-div
14445 @opindex -mno-low-precision-div
14446 Enable or disable the division approximation.
14447 This option only has an effect if @option{-ffast-math} or
14448 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14449 precision of division results to about 16 bits for
14450 single precision and to 32 bits for double precision.
14452 @item -march=@var{name}
14453 @opindex march
14454 Specify the name of the target architecture and, optionally, one or
14455 more feature modifiers.  This option has the form
14456 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}.
14458 The permissible values for @var{arch} are @samp{armv8-a},
14459 @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a} or @var{native}.
14461 The value @samp{armv8.3-a} implies @samp{armv8.2-a} and enables compiler
14462 support for the ARMv8.3-A architecture extensions.
14464 The value @samp{armv8.2-a} implies @samp{armv8.1-a} and enables compiler
14465 support for the ARMv8.2-A architecture extensions.
14467 The value @samp{armv8.1-a} implies @samp{armv8-a} and enables compiler
14468 support for the ARMv8.1-A architecture extension.  In particular, it
14469 enables the @samp{+crc}, @samp{+lse}, and @samp{+rdma} features.
14471 The value @samp{native} is available on native AArch64 GNU/Linux and
14472 causes the compiler to pick the architecture of the host system.  This
14473 option has no effect if the compiler is unable to recognize the
14474 architecture of the host system,
14476 The permissible values for @var{feature} are listed in the sub-section
14477 on @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14478 Feature Modifiers}.  Where conflicting feature modifiers are
14479 specified, the right-most feature is used.
14481 GCC uses @var{name} to determine what kind of instructions it can emit
14482 when generating assembly code.  If @option{-march} is specified
14483 without either of @option{-mtune} or @option{-mcpu} also being
14484 specified, the code is tuned to perform well across a range of target
14485 processors implementing the target architecture.
14487 @item -mtune=@var{name}
14488 @opindex mtune
14489 Specify the name of the target processor for which GCC should tune the
14490 performance of the code.  Permissible values for this option are:
14491 @samp{generic}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
14492 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
14493 @samp{exynos-m1}, @samp{falkor}, @samp{qdf24xx}, @samp{saphira},
14494 @samp{xgene1}, @samp{vulcan}, @samp{thunderx},
14495 @samp{thunderxt88}, @samp{thunderxt88p1}, @samp{thunderxt81},
14496 @samp{thunderxt83}, @samp{thunderx2t99}, @samp{cortex-a57.cortex-a53},
14497 @samp{cortex-a72.cortex-a53}, @samp{cortex-a73.cortex-a35},
14498 @samp{cortex-a73.cortex-a53}, @samp{cortex-a75.cortex-a55},
14499 @samp{native}.
14501 The values @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
14502 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53},
14503 @samp{cortex-a75.cortex-a55} specify that GCC should tune for a
14504 big.LITTLE system.
14506 Additionally on native AArch64 GNU/Linux systems the value
14507 @samp{native} tunes performance to the host system.  This option has no effect
14508 if the compiler is unable to recognize the processor of the host system.
14510 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
14511 are specified, the code is tuned to perform well across a range
14512 of target processors.
14514 This option cannot be suffixed by feature modifiers.
14516 @item -mcpu=@var{name}
14517 @opindex mcpu
14518 Specify the name of the target processor, optionally suffixed by one
14519 or more feature modifiers.  This option has the form
14520 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where
14521 the permissible values for @var{cpu} are the same as those available
14522 for @option{-mtune}.  The permissible values for @var{feature} are
14523 documented in the sub-section on
14524 @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14525 Feature Modifiers}.  Where conflicting feature modifiers are
14526 specified, the right-most feature is used.
14528 GCC uses @var{name} to determine what kind of instructions it can emit when
14529 generating assembly code (as if by @option{-march}) and to determine
14530 the target processor for which to tune for performance (as if
14531 by @option{-mtune}).  Where this option is used in conjunction
14532 with @option{-march} or @option{-mtune}, those options take precedence
14533 over the appropriate part of this option.
14535 @item -moverride=@var{string}
14536 @opindex moverride
14537 Override tuning decisions made by the back-end in response to a
14538 @option{-mtune=} switch.  The syntax, semantics, and accepted values
14539 for @var{string} in this option are not guaranteed to be consistent
14540 across releases.
14542 This option is only intended to be useful when developing GCC.
14544 @item -mpc-relative-literal-loads
14545 @itemx -mno-pc-relative-literal-loads
14546 @opindex mpc-relative-literal-loads
14547 @opindex mno-pc-relative-literal-loads
14548 Enable or disable PC-relative literal loads.  With this option literal pools are
14549 accessed using a single instruction and emitted after each function.  This
14550 limits the maximum size of functions to 1MB.  This is enabled by default for
14551 @option{-mcmodel=tiny}.
14553 @item -msign-return-address=@var{scope}
14554 @opindex msign-return-address
14555 Select the function scope on which return address signing will be applied.
14556 Permissible values are @samp{none}, which disables return address signing,
14557 @samp{non-leaf}, which enables pointer signing for functions which are not leaf
14558 functions, and @samp{all}, which enables pointer signing for all functions.  The
14559 default value is @samp{none}.
14561 @end table
14563 @subsubsection @option{-march} and @option{-mcpu} Feature Modifiers
14564 @anchor{aarch64-feature-modifiers}
14565 @cindex @option{-march} feature modifiers
14566 @cindex @option{-mcpu} feature modifiers
14567 Feature modifiers used with @option{-march} and @option{-mcpu} can be any of
14568 the following and their inverses @option{no@var{feature}}:
14570 @table @samp
14571 @item crc
14572 Enable CRC extension.  This is on by default for
14573 @option{-march=armv8.1-a}.
14574 @item crypto
14575 Enable Crypto extension.  This also enables Advanced SIMD and floating-point
14576 instructions.
14577 @item fp
14578 Enable floating-point instructions.  This is on by default for all possible
14579 values for options @option{-march} and @option{-mcpu}.
14580 @item simd
14581 Enable Advanced SIMD instructions.  This also enables floating-point
14582 instructions.  This is on by default for all possible values for options
14583 @option{-march} and @option{-mcpu}.
14584 @item lse
14585 Enable Large System Extension instructions.  This is on by default for
14586 @option{-march=armv8.1-a}.
14587 @item rdma
14588 Enable Round Double Multiply Accumulate instructions.  This is on by default
14589 for @option{-march=armv8.1-a}.
14590 @item fp16
14591 Enable FP16 extension.  This also enables floating-point instructions.
14592 @item rcpc
14593 Enable the RcPc extension.  This does not change code generation from GCC,
14594 but is passed on to the assembler, enabling inline asm statements to use
14595 instructions from the RcPc extension.
14596 @item dotprod
14597 Enable the Dot Product extension.  This also enables Advanced SIMD instructions.
14599 @end table
14601 Feature @option{crypto} implies @option{simd}, which implies @option{fp}.
14602 Conversely, @option{nofp} implies @option{nosimd}, which implies
14603 @option{nocrypto}.
14605 @node Adapteva Epiphany Options
14606 @subsection Adapteva Epiphany Options
14608 These @samp{-m} options are defined for Adapteva Epiphany:
14610 @table @gcctabopt
14611 @item -mhalf-reg-file
14612 @opindex mhalf-reg-file
14613 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
14614 That allows code to run on hardware variants that lack these registers.
14616 @item -mprefer-short-insn-regs
14617 @opindex mprefer-short-insn-regs
14618 Preferentially allocate registers that allow short instruction generation.
14619 This can result in increased instruction count, so this may either reduce or
14620 increase overall code size.
14622 @item -mbranch-cost=@var{num}
14623 @opindex mbranch-cost
14624 Set the cost of branches to roughly @var{num} ``simple'' instructions.
14625 This cost is only a heuristic and is not guaranteed to produce
14626 consistent results across releases.
14628 @item -mcmove
14629 @opindex mcmove
14630 Enable the generation of conditional moves.
14632 @item -mnops=@var{num}
14633 @opindex mnops
14634 Emit @var{num} NOPs before every other generated instruction.
14636 @item -mno-soft-cmpsf
14637 @opindex mno-soft-cmpsf
14638 For single-precision floating-point comparisons, emit an @code{fsub} instruction
14639 and test the flags.  This is faster than a software comparison, but can
14640 get incorrect results in the presence of NaNs, or when two different small
14641 numbers are compared such that their difference is calculated as zero.
14642 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
14643 software comparisons.
14645 @item -mstack-offset=@var{num}
14646 @opindex mstack-offset
14647 Set the offset between the top of the stack and the stack pointer.
14648 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
14649 can be used by leaf functions without stack allocation.
14650 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
14651 Note also that this option changes the ABI; compiling a program with a
14652 different stack offset than the libraries have been compiled with
14653 generally does not work.
14654 This option can be useful if you want to evaluate if a different stack
14655 offset would give you better code, but to actually use a different stack
14656 offset to build working programs, it is recommended to configure the
14657 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
14659 @item -mno-round-nearest
14660 @opindex mno-round-nearest
14661 Make the scheduler assume that the rounding mode has been set to
14662 truncating.  The default is @option{-mround-nearest}.
14664 @item -mlong-calls
14665 @opindex mlong-calls
14666 If not otherwise specified by an attribute, assume all calls might be beyond
14667 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
14668 function address into a register before performing a (otherwise direct) call.
14669 This is the default.
14671 @item -mshort-calls
14672 @opindex short-calls
14673 If not otherwise specified by an attribute, assume all direct calls are
14674 in the range of the @code{b} / @code{bl} instructions, so use these instructions
14675 for direct calls.  The default is @option{-mlong-calls}.
14677 @item -msmall16
14678 @opindex msmall16
14679 Assume addresses can be loaded as 16-bit unsigned values.  This does not
14680 apply to function addresses for which @option{-mlong-calls} semantics
14681 are in effect.
14683 @item -mfp-mode=@var{mode}
14684 @opindex mfp-mode
14685 Set the prevailing mode of the floating-point unit.
14686 This determines the floating-point mode that is provided and expected
14687 at function call and return time.  Making this mode match the mode you
14688 predominantly need at function start can make your programs smaller and
14689 faster by avoiding unnecessary mode switches.
14691 @var{mode} can be set to one the following values:
14693 @table @samp
14694 @item caller
14695 Any mode at function entry is valid, and retained or restored when
14696 the function returns, and when it calls other functions.
14697 This mode is useful for compiling libraries or other compilation units
14698 you might want to incorporate into different programs with different
14699 prevailing FPU modes, and the convenience of being able to use a single
14700 object file outweighs the size and speed overhead for any extra
14701 mode switching that might be needed, compared with what would be needed
14702 with a more specific choice of prevailing FPU mode.
14704 @item truncate
14705 This is the mode used for floating-point calculations with
14706 truncating (i.e.@: round towards zero) rounding mode.  That includes
14707 conversion from floating point to integer.
14709 @item round-nearest
14710 This is the mode used for floating-point calculations with
14711 round-to-nearest-or-even rounding mode.
14713 @item int
14714 This is the mode used to perform integer calculations in the FPU, e.g.@:
14715 integer multiply, or integer multiply-and-accumulate.
14716 @end table
14718 The default is @option{-mfp-mode=caller}
14720 @item -mnosplit-lohi
14721 @itemx -mno-postinc
14722 @itemx -mno-postmodify
14723 @opindex mnosplit-lohi
14724 @opindex mno-postinc
14725 @opindex mno-postmodify
14726 Code generation tweaks that disable, respectively, splitting of 32-bit
14727 loads, generation of post-increment addresses, and generation of
14728 post-modify addresses.  The defaults are @option{msplit-lohi},
14729 @option{-mpost-inc}, and @option{-mpost-modify}.
14731 @item -mnovect-double
14732 @opindex mno-vect-double
14733 Change the preferred SIMD mode to SImode.  The default is
14734 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
14736 @item -max-vect-align=@var{num}
14737 @opindex max-vect-align
14738 The maximum alignment for SIMD vector mode types.
14739 @var{num} may be 4 or 8.  The default is 8.
14740 Note that this is an ABI change, even though many library function
14741 interfaces are unaffected if they don't use SIMD vector modes
14742 in places that affect size and/or alignment of relevant types.
14744 @item -msplit-vecmove-early
14745 @opindex msplit-vecmove-early
14746 Split vector moves into single word moves before reload.  In theory this
14747 can give better register allocation, but so far the reverse seems to be
14748 generally the case.
14750 @item -m1reg-@var{reg}
14751 @opindex m1reg-
14752 Specify a register to hold the constant @minus{}1, which makes loading small negative
14753 constants and certain bitmasks faster.
14754 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
14755 which specify use of that register as a fixed register,
14756 and @samp{none}, which means that no register is used for this
14757 purpose.  The default is @option{-m1reg-none}.
14759 @end table
14761 @node ARC Options
14762 @subsection ARC Options
14763 @cindex ARC options
14765 The following options control the architecture variant for which code
14766 is being compiled:
14768 @c architecture variants
14769 @table @gcctabopt
14771 @item -mbarrel-shifter
14772 @opindex mbarrel-shifter
14773 Generate instructions supported by barrel shifter.  This is the default
14774 unless @option{-mcpu=ARC601} or @samp{-mcpu=ARCEM} is in effect.
14776 @item -mcpu=@var{cpu}
14777 @opindex mcpu
14778 Set architecture type, register usage, and instruction scheduling
14779 parameters for @var{cpu}.  There are also shortcut alias options
14780 available for backward compatibility and convenience.  Supported
14781 values for @var{cpu} are
14783 @table @samp
14784 @opindex mA6
14785 @opindex mARC600
14786 @item arc600
14787 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
14789 @item arc601
14790 @opindex mARC601
14791 Compile for ARC601.  Alias: @option{-mARC601}.
14793 @item arc700
14794 @opindex mA7
14795 @opindex mARC700
14796 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
14797 This is the default when configured with @option{--with-cpu=arc700}@.
14799 @item arcem
14800 Compile for ARC EM.
14802 @item archs
14803 Compile for ARC HS.
14805 @item em
14806 Compile for ARC EM CPU with no hardware extensions.
14808 @item em4
14809 Compile for ARC EM4 CPU.
14811 @item em4_dmips
14812 Compile for ARC EM4 DMIPS CPU.
14814 @item em4_fpus
14815 Compile for ARC EM4 DMIPS CPU with the single-precision floating-point
14816 extension.
14818 @item em4_fpuda
14819 Compile for ARC EM4 DMIPS CPU with single-precision floating-point and
14820 double assist instructions.
14822 @item hs
14823 Compile for ARC HS CPU with no hardware extensions except the atomic
14824 instructions.
14826 @item hs34
14827 Compile for ARC HS34 CPU.
14829 @item hs38
14830 Compile for ARC HS38 CPU.
14832 @item hs38_linux
14833 Compile for ARC HS38 CPU with all hardware extensions on.
14835 @item arc600_norm
14836 Compile for ARC 600 CPU with @code{norm} instructions enabled.
14838 @item arc600_mul32x16
14839 Compile for ARC 600 CPU with @code{norm} and 32x16-bit multiply 
14840 instructions enabled.
14842 @item arc600_mul64
14843 Compile for ARC 600 CPU with @code{norm} and @code{mul64}-family 
14844 instructions enabled.
14846 @item arc601_norm
14847 Compile for ARC 601 CPU with @code{norm} instructions enabled.
14849 @item arc601_mul32x16
14850 Compile for ARC 601 CPU with @code{norm} and 32x16-bit multiply
14851 instructions enabled.
14853 @item arc601_mul64
14854 Compile for ARC 601 CPU with @code{norm} and @code{mul64}-family
14855 instructions enabled.
14857 @item nps400
14858 Compile for ARC 700 on NPS400 chip.
14860 @end table
14862 @item -mdpfp
14863 @opindex mdpfp
14864 @itemx -mdpfp-compact
14865 @opindex mdpfp-compact
14866 Generate double-precision FPX instructions, tuned for the compact
14867 implementation.
14869 @item -mdpfp-fast
14870 @opindex mdpfp-fast
14871 Generate double-precision FPX instructions, tuned for the fast
14872 implementation.
14874 @item -mno-dpfp-lrsr
14875 @opindex mno-dpfp-lrsr
14876 Disable @code{lr} and @code{sr} instructions from using FPX extension
14877 aux registers.
14879 @item -mea
14880 @opindex mea
14881 Generate extended arithmetic instructions.  Currently only
14882 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
14883 supported.  This is always enabled for @option{-mcpu=ARC700}.
14885 @item -mno-mpy
14886 @opindex mno-mpy
14887 Do not generate @code{mpy}-family instructions for ARC700.  This option is
14888 deprecated.
14890 @item -mmul32x16
14891 @opindex mmul32x16
14892 Generate 32x16-bit multiply and multiply-accumulate instructions.
14894 @item -mmul64
14895 @opindex mmul64
14896 Generate @code{mul64} and @code{mulu64} instructions.  
14897 Only valid for @option{-mcpu=ARC600}.
14899 @item -mnorm
14900 @opindex mnorm
14901 Generate @code{norm} instructions.  This is the default if @option{-mcpu=ARC700}
14902 is in effect.
14904 @item -mspfp
14905 @opindex mspfp
14906 @itemx -mspfp-compact
14907 @opindex mspfp-compact
14908 Generate single-precision FPX instructions, tuned for the compact
14909 implementation.
14911 @item -mspfp-fast
14912 @opindex mspfp-fast
14913 Generate single-precision FPX instructions, tuned for the fast
14914 implementation.
14916 @item -msimd
14917 @opindex msimd
14918 Enable generation of ARC SIMD instructions via target-specific
14919 builtins.  Only valid for @option{-mcpu=ARC700}.
14921 @item -msoft-float
14922 @opindex msoft-float
14923 This option ignored; it is provided for compatibility purposes only.
14924 Software floating-point code is emitted by default, and this default
14925 can overridden by FPX options; @option{-mspfp}, @option{-mspfp-compact}, or
14926 @option{-mspfp-fast} for single precision, and @option{-mdpfp},
14927 @option{-mdpfp-compact}, or @option{-mdpfp-fast} for double precision.
14929 @item -mswap
14930 @opindex mswap
14931 Generate @code{swap} instructions.
14933 @item -matomic
14934 @opindex matomic
14935 This enables use of the locked load/store conditional extension to implement
14936 atomic memory built-in functions.  Not available for ARC 6xx or ARC
14937 EM cores.
14939 @item -mdiv-rem
14940 @opindex mdiv-rem
14941 Enable @code{div} and @code{rem} instructions for ARCv2 cores.
14943 @item -mcode-density
14944 @opindex mcode-density
14945 Enable code density instructions for ARC EM.  
14946 This option is on by default for ARC HS.
14948 @item -mll64
14949 @opindex mll64
14950 Enable double load/store operations for ARC HS cores.
14952 @item -mtp-regno=@var{regno}
14953 @opindex mtp-regno
14954 Specify thread pointer register number.
14956 @item -mmpy-option=@var{multo}
14957 @opindex mmpy-option
14958 Compile ARCv2 code with a multiplier design option.  You can specify 
14959 the option using either a string or numeric value for @var{multo}.  
14960 @samp{wlh1} is the default value.  The recognized values are:
14962 @table @samp
14963 @item 0
14964 @itemx none
14965 No multiplier available.
14967 @item 1
14968 @itemx w
14969 16x16 multiplier, fully pipelined.
14970 The following instructions are enabled: @code{mpyw} and @code{mpyuw}.
14972 @item 2
14973 @itemx wlh1
14974 32x32 multiplier, fully
14975 pipelined (1 stage).  The following instructions are additionally
14976 enabled: @code{mpy}, @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14978 @item 3
14979 @itemx wlh2
14980 32x32 multiplier, fully pipelined
14981 (2 stages).  The following instructions are additionally enabled: @code{mpy},
14982 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14984 @item 4
14985 @itemx wlh3
14986 Two 16x16 multipliers, blocking,
14987 sequential.  The following instructions are additionally enabled: @code{mpy},
14988 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14990 @item 5
14991 @itemx wlh4
14992 One 16x16 multiplier, blocking,
14993 sequential.  The following instructions are additionally enabled: @code{mpy},
14994 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14996 @item 6
14997 @itemx wlh5
14998 One 32x4 multiplier, blocking,
14999 sequential.  The following instructions are additionally enabled: @code{mpy},
15000 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15002 @item 7
15003 @itemx plus_dmpy
15004 ARC HS SIMD support.
15006 @item 8
15007 @itemx plus_macd
15008 ARC HS SIMD support.
15010 @item 9
15011 @itemx plus_qmacw
15012 ARC HS SIMD support.
15014 @end table
15016 This option is only available for ARCv2 cores@.
15018 @item -mfpu=@var{fpu}
15019 @opindex mfpu
15020 Enables support for specific floating-point hardware extensions for ARCv2
15021 cores.  Supported values for @var{fpu} are:
15023 @table @samp
15025 @item fpus
15026 Enables support for single-precision floating-point hardware
15027 extensions@.
15029 @item fpud
15030 Enables support for double-precision floating-point hardware
15031 extensions.  The single-precision floating-point extension is also
15032 enabled.  Not available for ARC EM@.
15034 @item fpuda
15035 Enables support for double-precision floating-point hardware
15036 extensions using double-precision assist instructions.  The single-precision
15037 floating-point extension is also enabled.  This option is
15038 only available for ARC EM@.
15040 @item fpuda_div
15041 Enables support for double-precision floating-point hardware
15042 extensions using double-precision assist instructions.
15043 The single-precision floating-point, square-root, and divide 
15044 extensions are also enabled.  This option is
15045 only available for ARC EM@.
15047 @item fpuda_fma
15048 Enables support for double-precision floating-point hardware
15049 extensions using double-precision assist instructions.
15050 The single-precision floating-point and fused multiply and add 
15051 hardware extensions are also enabled.  This option is
15052 only available for ARC EM@.
15054 @item fpuda_all
15055 Enables support for double-precision floating-point hardware
15056 extensions using double-precision assist instructions.
15057 All single-precision floating-point hardware extensions are also
15058 enabled.  This option is only available for ARC EM@.
15060 @item fpus_div
15061 Enables support for single-precision floating-point, square-root and divide 
15062 hardware extensions@.
15064 @item fpud_div
15065 Enables support for double-precision floating-point, square-root and divide 
15066 hardware extensions.  This option
15067 includes option @samp{fpus_div}. Not available for ARC EM@.
15069 @item fpus_fma
15070 Enables support for single-precision floating-point and 
15071 fused multiply and add hardware extensions@.
15073 @item fpud_fma
15074 Enables support for double-precision floating-point and 
15075 fused multiply and add hardware extensions.  This option
15076 includes option @samp{fpus_fma}.  Not available for ARC EM@.
15078 @item fpus_all
15079 Enables support for all single-precision floating-point hardware
15080 extensions@.
15082 @item fpud_all
15083 Enables support for all single- and double-precision floating-point
15084 hardware extensions.  Not available for ARC EM@.
15086 @end table
15088 @item -mirq-ctrl-saved=@var{register-range}, @var{blink}, @var{lp_count}
15089 @opindex mirq-ctrl-saved
15090 Specifies general-purposes registers that the processor automatically
15091 saves/restores on interrupt entry and exit.  @var{register-range} is
15092 specified as two registers separated by a dash.  The register range
15093 always starts with @code{r0}, the upper limit is @code{fp} register.
15094 @var{blink} and @var{lp_count} are optional.  This option is only
15095 valid for ARC EM and ARC HS cores.
15097 @item -mrgf-banked-regs=@var{number}
15098 @opindex mrgf-banked-regs
15099 Specifies the number of registers replicated in second register bank
15100 on entry to fast interrupt.  Fast interrupts are interrupts with the
15101 highest priority level P0.  These interrupts save only PC and STATUS32
15102 registers to avoid memory transactions during interrupt entry and exit
15103 sequences.  Use this option when you are using fast interrupts in an
15104 ARC V2 family processor.  Permitted values are 4, 8, 16, and 32.
15106 @item -mlpc-width=@var{width}
15107 @opindex mlpc-width
15108 Specify the width of the @code{lp_count} register.  Valid values for
15109 @var{width} are 8, 16, 20, 24, 28 and 32 bits.  The default width is
15110 fixed to 32 bits.  If the width is less than 32, the compiler does not
15111 attempt to transform loops in your program to use the zero-delay loop
15112 mechanism unless it is known that the @code{lp_count} register can
15113 hold the required loop-counter value.  Depending on the width
15114 specified, the compiler and run-time library might continue to use the
15115 loop mechanism for various needs.  This option defines macro
15116 @code{__ARC_LPC_WIDTH__} with the value of @var{width}.
15118 @end table
15120 The following options are passed through to the assembler, and also
15121 define preprocessor macro symbols.
15123 @c Flags used by the assembler, but for which we define preprocessor
15124 @c macro symbols as well.
15125 @table @gcctabopt
15126 @item -mdsp-packa
15127 @opindex mdsp-packa
15128 Passed down to the assembler to enable the DSP Pack A extensions.
15129 Also sets the preprocessor symbol @code{__Xdsp_packa}.  This option is
15130 deprecated.
15132 @item -mdvbf
15133 @opindex mdvbf
15134 Passed down to the assembler to enable the dual Viterbi butterfly
15135 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.  This
15136 option is deprecated.
15138 @c ARC700 4.10 extension instruction
15139 @item -mlock
15140 @opindex mlock
15141 Passed down to the assembler to enable the locked load/store
15142 conditional extension.  Also sets the preprocessor symbol
15143 @code{__Xlock}.
15145 @item -mmac-d16
15146 @opindex mmac-d16
15147 Passed down to the assembler.  Also sets the preprocessor symbol
15148 @code{__Xxmac_d16}.  This option is deprecated.
15150 @item -mmac-24
15151 @opindex mmac-24
15152 Passed down to the assembler.  Also sets the preprocessor symbol
15153 @code{__Xxmac_24}.  This option is deprecated.
15155 @c ARC700 4.10 extension instruction
15156 @item -mrtsc
15157 @opindex mrtsc
15158 Passed down to the assembler to enable the 64-bit time-stamp counter
15159 extension instruction.  Also sets the preprocessor symbol
15160 @code{__Xrtsc}.  This option is deprecated.
15162 @c ARC700 4.10 extension instruction
15163 @item -mswape
15164 @opindex mswape
15165 Passed down to the assembler to enable the swap byte ordering
15166 extension instruction.  Also sets the preprocessor symbol
15167 @code{__Xswape}.
15169 @item -mtelephony
15170 @opindex mtelephony
15171 Passed down to the assembler to enable dual- and single-operand
15172 instructions for telephony.  Also sets the preprocessor symbol
15173 @code{__Xtelephony}.  This option is deprecated.
15175 @item -mxy
15176 @opindex mxy
15177 Passed down to the assembler to enable the XY memory extension.  Also
15178 sets the preprocessor symbol @code{__Xxy}.
15180 @end table
15182 The following options control how the assembly code is annotated:
15184 @c Assembly annotation options
15185 @table @gcctabopt
15186 @item -misize
15187 @opindex misize
15188 Annotate assembler instructions with estimated addresses.
15190 @item -mannotate-align
15191 @opindex mannotate-align
15192 Explain what alignment considerations lead to the decision to make an
15193 instruction short or long.
15195 @end table
15197 The following options are passed through to the linker:
15199 @c options passed through to the linker
15200 @table @gcctabopt
15201 @item -marclinux
15202 @opindex marclinux
15203 Passed through to the linker, to specify use of the @code{arclinux} emulation.
15204 This option is enabled by default in tool chains built for
15205 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
15206 when profiling is not requested.
15208 @item -marclinux_prof
15209 @opindex marclinux_prof
15210 Passed through to the linker, to specify use of the
15211 @code{arclinux_prof} emulation.  This option is enabled by default in
15212 tool chains built for @w{@code{arc-linux-uclibc}} and
15213 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
15215 @end table
15217 The following options control the semantics of generated code:
15219 @c semantically relevant code generation options
15220 @table @gcctabopt
15221 @item -mlong-calls
15222 @opindex mlong-calls
15223 Generate calls as register indirect calls, thus providing access
15224 to the full 32-bit address range.
15226 @item -mmedium-calls
15227 @opindex mmedium-calls
15228 Don't use less than 25-bit addressing range for calls, which is the
15229 offset available for an unconditional branch-and-link
15230 instruction.  Conditional execution of function calls is suppressed, to
15231 allow use of the 25-bit range, rather than the 21-bit range with
15232 conditional branch-and-link.  This is the default for tool chains built
15233 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
15235 @item -G @var{num}
15236 @opindex G
15237 Put definitions of externally-visible data in a small data section if
15238 that data is no bigger than @var{num} bytes.  The default value of
15239 @var{num} is 4 for any ARC configuration, or 8 when we have double
15240 load/store operations.
15242 @item -mno-sdata
15243 @opindex mno-sdata
15244 Do not generate sdata references.  This is the default for tool chains
15245 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
15246 targets.
15248 @item -mvolatile-cache
15249 @opindex mvolatile-cache
15250 Use ordinarily cached memory accesses for volatile references.  This is the
15251 default.
15253 @item -mno-volatile-cache
15254 @opindex mno-volatile-cache
15255 Enable cache bypass for volatile references.
15257 @end table
15259 The following options fine tune code generation:
15260 @c code generation tuning options
15261 @table @gcctabopt
15262 @item -malign-call
15263 @opindex malign-call
15264 Do alignment optimizations for call instructions.
15266 @item -mauto-modify-reg
15267 @opindex mauto-modify-reg
15268 Enable the use of pre/post modify with register displacement.
15270 @item -mbbit-peephole
15271 @opindex mbbit-peephole
15272 Enable bbit peephole2.
15274 @item -mno-brcc
15275 @opindex mno-brcc
15276 This option disables a target-specific pass in @file{arc_reorg} to
15277 generate compare-and-branch (@code{br@var{cc}}) instructions.  
15278 It has no effect on
15279 generation of these instructions driven by the combiner pass.
15281 @item -mcase-vector-pcrel
15282 @opindex mcase-vector-pcrel
15283 Use PC-relative switch case tables to enable case table shortening.
15284 This is the default for @option{-Os}.
15286 @item -mcompact-casesi
15287 @opindex mcompact-casesi
15288 Enable compact @code{casesi} pattern.  This is the default for @option{-Os},
15289 and only available for ARCv1 cores.
15291 @item -mno-cond-exec
15292 @opindex mno-cond-exec
15293 Disable the ARCompact-specific pass to generate conditional 
15294 execution instructions.
15296 Due to delay slot scheduling and interactions between operand numbers,
15297 literal sizes, instruction lengths, and the support for conditional execution,
15298 the target-independent pass to generate conditional execution is often lacking,
15299 so the ARC port has kept a special pass around that tries to find more
15300 conditional execution generation opportunities after register allocation,
15301 branch shortening, and delay slot scheduling have been done.  This pass
15302 generally, but not always, improves performance and code size, at the cost of
15303 extra compilation time, which is why there is an option to switch it off.
15304 If you have a problem with call instructions exceeding their allowable
15305 offset range because they are conditionalized, you should consider using
15306 @option{-mmedium-calls} instead.
15308 @item -mearly-cbranchsi
15309 @opindex mearly-cbranchsi
15310 Enable pre-reload use of the @code{cbranchsi} pattern.
15312 @item -mexpand-adddi
15313 @opindex mexpand-adddi
15314 Expand @code{adddi3} and @code{subdi3} at RTL generation time into
15315 @code{add.f}, @code{adc} etc.  This option is deprecated.
15317 @item -mindexed-loads
15318 @opindex mindexed-loads
15319 Enable the use of indexed loads.  This can be problematic because some
15320 optimizers then assume that indexed stores exist, which is not
15321 the case.
15323 @opindex mlra
15324 Enable Local Register Allocation.  This is still experimental for ARC,
15325 so by default the compiler uses standard reload
15326 (i.e. @option{-mno-lra}).
15328 @item -mlra-priority-none
15329 @opindex mlra-priority-none
15330 Don't indicate any priority for target registers.
15332 @item -mlra-priority-compact
15333 @opindex mlra-priority-compact
15334 Indicate target register priority for r0..r3 / r12..r15.
15336 @item -mlra-priority-noncompact
15337 @opindex mlra-priority-noncompact
15338 Reduce target register priority for r0..r3 / r12..r15.
15340 @item -mno-millicode
15341 @opindex mno-millicode
15342 When optimizing for size (using @option{-Os}), prologues and epilogues
15343 that have to save or restore a large number of registers are often
15344 shortened by using call to a special function in libgcc; this is
15345 referred to as a @emph{millicode} call.  As these calls can pose
15346 performance issues, and/or cause linking issues when linking in a
15347 nonstandard way, this option is provided to turn off millicode call
15348 generation.
15350 @item -mmixed-code
15351 @opindex mmixed-code
15352 Tweak register allocation to help 16-bit instruction generation.
15353 This generally has the effect of decreasing the average instruction size
15354 while increasing the instruction count.
15356 @item -mq-class
15357 @opindex mq-class
15358 Enable @samp{q} instruction alternatives.
15359 This is the default for @option{-Os}.
15361 @item -mRcq
15362 @opindex mRcq
15363 Enable @samp{Rcq} constraint handling.  
15364 Most short code generation depends on this.
15365 This is the default.
15367 @item -mRcw
15368 @opindex mRcw
15369 Enable @samp{Rcw} constraint handling.  
15370 Most ccfsm condexec mostly depends on this.
15371 This is the default.
15373 @item -msize-level=@var{level}
15374 @opindex msize-level
15375 Fine-tune size optimization with regards to instruction lengths and alignment.
15376 The recognized values for @var{level} are:
15377 @table @samp
15378 @item 0
15379 No size optimization.  This level is deprecated and treated like @samp{1}.
15381 @item 1
15382 Short instructions are used opportunistically.
15384 @item 2
15385 In addition, alignment of loops and of code after barriers are dropped.
15387 @item 3
15388 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
15390 @end table
15392 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
15393 the behavior when this is not set is equivalent to level @samp{1}.
15395 @item -mtune=@var{cpu}
15396 @opindex mtune
15397 Set instruction scheduling parameters for @var{cpu}, overriding any implied
15398 by @option{-mcpu=}.
15400 Supported values for @var{cpu} are
15402 @table @samp
15403 @item ARC600
15404 Tune for ARC600 CPU.
15406 @item ARC601
15407 Tune for ARC601 CPU.
15409 @item ARC700
15410 Tune for ARC700 CPU with standard multiplier block.
15412 @item ARC700-xmac
15413 Tune for ARC700 CPU with XMAC block.
15415 @item ARC725D
15416 Tune for ARC725D CPU.
15418 @item ARC750D
15419 Tune for ARC750D CPU.
15421 @end table
15423 @item -mmultcost=@var{num}
15424 @opindex mmultcost
15425 Cost to assume for a multiply instruction, with @samp{4} being equal to a
15426 normal instruction.
15428 @item -munalign-prob-threshold=@var{probability}
15429 @opindex munalign-prob-threshold
15430 Set probability threshold for unaligning branches.
15431 When tuning for @samp{ARC700} and optimizing for speed, branches without
15432 filled delay slot are preferably emitted unaligned and long, unless
15433 profiling indicates that the probability for the branch to be taken
15434 is below @var{probability}.  @xref{Cross-profiling}.
15435 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
15437 @end table
15439 The following options are maintained for backward compatibility, but
15440 are now deprecated and will be removed in a future release:
15442 @c Deprecated options
15443 @table @gcctabopt
15445 @item -margonaut
15446 @opindex margonaut
15447 Obsolete FPX.
15449 @item -mbig-endian
15450 @opindex mbig-endian
15451 @itemx -EB
15452 @opindex EB
15453 Compile code for big-endian targets.  Use of these options is now
15454 deprecated.  Big-endian code is supported by configuring GCC to build
15455 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets,
15456 for which big endian is the default.
15458 @item -mlittle-endian
15459 @opindex mlittle-endian
15460 @itemx -EL
15461 @opindex EL
15462 Compile code for little-endian targets.  Use of these options is now
15463 deprecated.  Little-endian code is supported by configuring GCC to build 
15464 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets,
15465 for which little endian is the default.
15467 @item -mbarrel_shifter
15468 @opindex mbarrel_shifter
15469 Replaced by @option{-mbarrel-shifter}.
15471 @item -mdpfp_compact
15472 @opindex mdpfp_compact
15473 Replaced by @option{-mdpfp-compact}.
15475 @item -mdpfp_fast
15476 @opindex mdpfp_fast
15477 Replaced by @option{-mdpfp-fast}.
15479 @item -mdsp_packa
15480 @opindex mdsp_packa
15481 Replaced by @option{-mdsp-packa}.
15483 @item -mEA
15484 @opindex mEA
15485 Replaced by @option{-mea}.
15487 @item -mmac_24
15488 @opindex mmac_24
15489 Replaced by @option{-mmac-24}.
15491 @item -mmac_d16
15492 @opindex mmac_d16
15493 Replaced by @option{-mmac-d16}.
15495 @item -mspfp_compact
15496 @opindex mspfp_compact
15497 Replaced by @option{-mspfp-compact}.
15499 @item -mspfp_fast
15500 @opindex mspfp_fast
15501 Replaced by @option{-mspfp-fast}.
15503 @item -mtune=@var{cpu}
15504 @opindex mtune
15505 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
15506 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
15507 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively.
15509 @item -multcost=@var{num}
15510 @opindex multcost
15511 Replaced by @option{-mmultcost}.
15513 @end table
15515 @node ARM Options
15516 @subsection ARM Options
15517 @cindex ARM options
15519 These @samp{-m} options are defined for the ARM port:
15521 @table @gcctabopt
15522 @item -mabi=@var{name}
15523 @opindex mabi
15524 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
15525 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
15527 @item -mapcs-frame
15528 @opindex mapcs-frame
15529 Generate a stack frame that is compliant with the ARM Procedure Call
15530 Standard for all functions, even if this is not strictly necessary for
15531 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
15532 with this option causes the stack frames not to be generated for
15533 leaf functions.  The default is @option{-mno-apcs-frame}.
15534 This option is deprecated.
15536 @item -mapcs
15537 @opindex mapcs
15538 This is a synonym for @option{-mapcs-frame} and is deprecated.
15540 @ignore
15541 @c not currently implemented
15542 @item -mapcs-stack-check
15543 @opindex mapcs-stack-check
15544 Generate code to check the amount of stack space available upon entry to
15545 every function (that actually uses some stack space).  If there is
15546 insufficient space available then either the function
15547 @code{__rt_stkovf_split_small} or @code{__rt_stkovf_split_big} is
15548 called, depending upon the amount of stack space required.  The runtime
15549 system is required to provide these functions.  The default is
15550 @option{-mno-apcs-stack-check}, since this produces smaller code.
15552 @c not currently implemented
15553 @item -mapcs-reentrant
15554 @opindex mapcs-reentrant
15555 Generate reentrant, position-independent code.  The default is
15556 @option{-mno-apcs-reentrant}.
15557 @end ignore
15559 @item -mthumb-interwork
15560 @opindex mthumb-interwork
15561 Generate code that supports calling between the ARM and Thumb
15562 instruction sets.  Without this option, on pre-v5 architectures, the
15563 two instruction sets cannot be reliably used inside one program.  The
15564 default is @option{-mno-thumb-interwork}, since slightly larger code
15565 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
15566 configurations this option is meaningless.
15568 @item -mno-sched-prolog
15569 @opindex mno-sched-prolog
15570 Prevent the reordering of instructions in the function prologue, or the
15571 merging of those instruction with the instructions in the function's
15572 body.  This means that all functions start with a recognizable set
15573 of instructions (or in fact one of a choice from a small set of
15574 different function prologues), and this information can be used to
15575 locate the start of functions inside an executable piece of code.  The
15576 default is @option{-msched-prolog}.
15578 @item -mfloat-abi=@var{name}
15579 @opindex mfloat-abi
15580 Specifies which floating-point ABI to use.  Permissible values
15581 are: @samp{soft}, @samp{softfp} and @samp{hard}.
15583 Specifying @samp{soft} causes GCC to generate output containing
15584 library calls for floating-point operations.
15585 @samp{softfp} allows the generation of code using hardware floating-point
15586 instructions, but still uses the soft-float calling conventions.
15587 @samp{hard} allows generation of floating-point instructions
15588 and uses FPU-specific calling conventions.
15590 The default depends on the specific target configuration.  Note that
15591 the hard-float and soft-float ABIs are not link-compatible; you must
15592 compile your entire program with the same ABI, and link with a
15593 compatible set of libraries.
15595 @item -mlittle-endian
15596 @opindex mlittle-endian
15597 Generate code for a processor running in little-endian mode.  This is
15598 the default for all standard configurations.
15600 @item -mbig-endian
15601 @opindex mbig-endian
15602 Generate code for a processor running in big-endian mode; the default is
15603 to compile code for a little-endian processor.
15605 @item -mbe8
15606 @itemx -mbe32
15607 @opindex mbe8
15608 When linking a big-endian image select between BE8 and BE32 formats.
15609 The option has no effect for little-endian images and is ignored.  The
15610 default is dependent on the selected target architecture.  For ARMv6
15611 and later architectures the default is BE8, for older architectures
15612 the default is BE32.  BE32 format has been deprecated by ARM.
15614 @item -march=@var{name}@r{[}+extension@dots{}@r{]}
15615 @opindex march
15616 This specifies the name of the target ARM architecture.  GCC uses this
15617 name to determine what kind of instructions it can emit when generating
15618 assembly code.  This option can be used in conjunction with or instead
15619 of the @option{-mcpu=} option.
15621 Permissible names are:
15622 @samp{armv4t},
15623 @samp{armv5t}, @samp{armv5te},
15624 @samp{armv6}, @samp{armv6j}, @samp{armv6k}, @samp{armv6kz}, @samp{armv6t2},
15625 @samp{armv6z}, @samp{armv6zk},
15626 @samp{armv7}, @samp{armv7-a}, @samp{armv7ve}, 
15627 @samp{armv8-a}, @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a},
15628 @samp{armv7-r},
15629 @samp{armv8-r},
15630 @samp{armv6-m}, @samp{armv6s-m},
15631 @samp{armv7-m}, @samp{armv7e-m},
15632 @samp{armv8-m.base}, @samp{armv8-m.main},
15633 @samp{iwmmxt} and @samp{iwmmxt2}.
15635 Additionally, the following architectures, which lack support for the
15636 Thumb exection state, are recognized but support is deprecated:
15637 @samp{armv2}, @samp{armv2a}, @samp{armv3}, @samp{armv3m},
15638 @samp{armv4}, @samp{armv5} and @samp{armv5e}.
15640 Many of the architectures support extensions.  These can be added by
15641 appending @samp{+@var{extension}} to the architecture name.  Extension
15642 options are processed in order and capabilities accumulate.  An extension
15643 will also enable any necessary base extensions
15644 upon which it depends.  For example, the @samp{+crypto} extension
15645 will always enable the @samp{+simd} extension.  The exception to the
15646 additive construction is for extensions that are prefixed with
15647 @samp{+no@dots{}}: these extensions disable the specified option and
15648 any other extensions that may depend on the presence of that
15649 extension.
15651 For example, @samp{-march=armv7-a+simd+nofp+vfpv4} is equivalent to
15652 writing @samp{-march=armv7-a+vfpv4} since the @samp{+simd} option is
15653 entirely disabled by the @samp{+nofp} option that follows it.
15655 Most extension names are generically named, but have an effect that is
15656 dependent upon the architecture to which it is applied.  For example,
15657 the @samp{+simd} option can be applied to both @samp{armv7-a} and
15658 @samp{armv8-a} architectures, but will enable the original ARMv7-A
15659 Advanced SIMD (Neon) extensions for @samp{armv7-a} and the ARMv8-A
15660 variant for @samp{armv8-a}.
15662 The table below lists the supported extensions for each architecture.
15663 Architectures not mentioned do not support any extensions.
15665 @table @samp
15666 @item  armv5e
15667 @itemx armv5te
15668 @itemx armv6
15669 @itemx armv6j
15670 @itemx armv6k
15671 @itemx armv6kz
15672 @itemx armv6t2
15673 @itemx armv6z
15674 @itemx armv6zk
15675 @table @samp
15676 @item +fp
15677 The VFPv2 floating-point instructions.  The extension @samp{+vfpv2} can be
15678 used as an alias for this extension.
15680 @item +nofp
15681 Disable the floating-point instructions.
15682 @end table
15684 @item armv7
15685 The common subset of the ARMv7-A, ARMv7-R and ARMv7-M architectures.
15686 @table @samp
15687 @item +fp
15688 The VFPv3 floating-point instructions, with 16 double-precision
15689 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
15690 for this extension.  Note that floating-point is not supported by the
15691 base ARMv7-M architecture, but is compatible with both the ARMv7-A and
15692 ARMv7-R architectures.
15694 @item +nofp
15695 Disable the floating-point instructions.
15696 @end table
15698 @item armv7-a
15699 @table @samp
15700 @item +fp
15701 The VFPv3 floating-point instructions, with 16 double-precision
15702 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
15703 for this extension.
15705 @item +simd
15706 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
15707 The extensions @samp{+neon} and @samp{+neon-vfpv3} can be used as aliases
15708 for this extension.
15710 @item +vfpv3
15711 The VFPv3 floating-point instructions, with 32 double-precision
15712 registers.
15714 @item +vfpv3-d16-fp16
15715 The VFPv3 floating-point instructions, with 16 double-precision
15716 registers and the half-precision floating-point conversion operations.
15718 @item +vfpv3-fp16
15719 The VFPv3 floating-point instructions, with 32 double-precision
15720 registers and the half-precision floating-point conversion operations.
15722 @item +vfpv4-d16
15723 The VFPv4 floating-point instructions, with 16 double-precision
15724 registers.
15726 @item +vfpv4
15727 The VFPv4 floating-point instructions, with 32 double-precision
15728 registers.
15730 @item +neon-fp16
15731 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
15732 the half-precision floating-point conversion operations.
15734 @item +neon-vfpv4
15735 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.
15737 @item +nosimd
15738 Disable the Advanced SIMD instructions (does not disable floating point).
15740 @item +nofp
15741 Disable the floating-point and Advanced SIMD instructions.
15742 @end table
15744 @item armv7ve
15745 The extended version of the ARMv7-A architecture with support for
15746 virtualization.
15747 @table @samp
15748 @item +fp
15749 The VFPv4 floating-point instructions, with 16 double-precision registers.
15750 The extension @samp{+vfpv4-d16} can be used as an alias for this extension.
15752 @item +simd
15753 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.  The
15754 extension @samp{+neon-vfpv4} can be used as an alias for this extension.
15756 @item +vfpv3-d16
15757 The VFPv3 floating-point instructions, with 16 double-precision
15758 registers.
15760 @item +vfpv3
15761 The VFPv3 floating-point instructions, with 32 double-precision
15762 registers.
15764 @item +vfpv3-d16-fp16
15765 The VFPv3 floating-point instructions, with 16 double-precision
15766 registers and the half-precision floating-point conversion operations.
15768 @item +vfpv3-fp16
15769 The VFPv3 floating-point instructions, with 32 double-precision
15770 registers and the half-precision floating-point conversion operations.
15772 @item +vfpv4-d16
15773 The VFPv4 floating-point instructions, with 16 double-precision
15774 registers.
15776 @item +vfpv4
15777 The VFPv4 floating-point instructions, with 32 double-precision
15778 registers.
15780 @item +neon
15781 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
15782 The extension @samp{+neon-vfpv3} can be used as an alias for this extension.
15784 @item +neon-fp16
15785 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
15786 the half-precision floating-point conversion operations.
15788 @item +nosimd
15789 Disable the Advanced SIMD instructions (does not disable floating point).
15791 @item +nofp
15792 Disable the floating-point and Advanced SIMD instructions.
15793 @end table
15795 @item armv8-a
15796 @table @samp
15797 @item +crc
15798 The Cyclic Redundancy Check (CRC) instructions.
15799 @item +simd
15800 The ARMv8-A Advanced SIMD and floating-point instructions.
15801 @item +crypto
15802 The cryptographic instructions.
15803 @item +nocrypto
15804 Disable the cryptographic isntructions.
15805 @item +nofp
15806 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15807 @end table
15809 @item armv8.1-a
15810 @table @samp
15811 @item +simd
15812 The ARMv8.1-A Advanced SIMD and floating-point instructions.
15814 @item +crypto
15815 The cryptographic instructions.  This also enables the Advanced SIMD and
15816 floating-point instructions.
15818 @item +nocrypto
15819 Disable the cryptographic isntructions.
15821 @item +nofp
15822 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15823 @end table
15825 @item armv8.2-a
15826 @table @samp
15827 @item +fp16
15828 The half-precision floating-point data processing instructions.
15829 This also enables the Advanced SIMD and floating-point instructions.
15831 @item +simd
15832 The ARMv8.1-A Advanced SIMD and floating-point instructions.
15834 @item +crypto
15835 The cryptographic instructions.  This also enables the Advanced SIMD and
15836 floating-point instructions.
15838 @item +dotprod
15839 Enable the Dot Product extension.  This also enables Advanced SIMD instructions.
15841 @item +nocrypto
15842 Disable the cryptographic extension.
15844 @item +nofp
15845 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15846 @end table
15848 @item armv7-r
15849 @table @samp
15850 @item +fp.sp
15851 The single-precision VFPv3 floating-point instructions.  The extension
15852 @samp{+vfpv3xd} can be used as an alias for this extension.
15854 @item +fp
15855 The VFPv3 floating-point instructions with 16 double-precision registers.
15856 The extension +vfpv3-d16 can be used as an alias for this extension.
15858 @item +nofp
15859 Disable the floating-point extension.
15861 @item +idiv
15862 The ARM-state integer division instructions.
15864 @item +noidiv
15865 Disable the ARM-state integer division extension.
15866 @end table
15868 @item armv7e-m
15869 @table @samp
15870 @item +fp
15871 The single-precision VFPv4 floating-point instructions.
15873 @item +fpv5
15874 The single-precision FPv5 floating-point instructions.
15876 @item +fp.dp
15877 The single- and double-precision FPv5 floating-point instructions.
15879 @item +nofp
15880 Disable the floating-point extensions.
15881 @end table
15883 @item  armv8-m.main
15884 @table @samp
15885 @item +dsp
15886 The DSP instructions.
15888 @item +nodsp
15889 Disable the DSP extension.
15891 @item +fp
15892 The single-precision floating-point instructions.
15894 @item +fp.dp
15895 The single- and double-precision floating-point instructions.
15897 @item +nofp
15898 Disable the floating-point extension.
15899 @end table
15901 @item armv8-r
15902 @table @samp
15903 @item +crc
15904 The Cyclic Redundancy Check (CRC) instructions.
15905 @item +fp.sp
15906 The single-precision FPv5 floating-point instructions.
15907 @item +simd
15908 The ARMv8-A Advanced SIMD and floating-point instructions.
15909 @item +crypto
15910 The cryptographic instructions.
15911 @item +nocrypto
15912 Disable the cryptographic isntructions.
15913 @item +nofp
15914 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15915 @end table
15917 @end table
15919 @option{-march=native} causes the compiler to auto-detect the architecture
15920 of the build computer.  At present, this feature is only supported on
15921 GNU/Linux, and not all architectures are recognized.  If the auto-detect
15922 is unsuccessful the option has no effect.
15924 @item -mtune=@var{name}
15925 @opindex mtune
15926 This option specifies the name of the target ARM processor for
15927 which GCC should tune the performance of the code.
15928 For some ARM implementations better performance can be obtained by using
15929 this option.
15930 Permissible names are: @samp{arm2}, @samp{arm250},
15931 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
15932 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
15933 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
15934 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
15935 @samp{arm720},
15936 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
15937 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
15938 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
15939 @samp{strongarm1110},
15940 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
15941 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
15942 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
15943 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
15944 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
15945 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
15946 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
15947 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8},
15948 @samp{cortex-a9}, @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a17},
15949 @samp{cortex-a32}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
15950 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
15951 @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7},
15952 @samp{cortex-r8}, @samp{cortex-r52},
15953 @samp{cortex-m33},
15954 @samp{cortex-m23},
15955 @samp{cortex-m7},
15956 @samp{cortex-m4},
15957 @samp{cortex-m3},
15958 @samp{cortex-m1},
15959 @samp{cortex-m0},
15960 @samp{cortex-m0plus},
15961 @samp{cortex-m1.small-multiply},
15962 @samp{cortex-m0.small-multiply},
15963 @samp{cortex-m0plus.small-multiply},
15964 @samp{exynos-m1},
15965 @samp{marvell-pj4},
15966 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
15967 @samp{fa526}, @samp{fa626},
15968 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te},
15969 @samp{xgene1}.
15971 Additionally, this option can specify that GCC should tune the performance
15972 of the code for a big.LITTLE system.  Permissible names are:
15973 @samp{cortex-a15.cortex-a7}, @samp{cortex-a17.cortex-a7},
15974 @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
15975 @samp{cortex-a72.cortex-a35}, @samp{cortex-a73.cortex-a53},
15976 @samp{cortex-a75.cortex-a55}.
15978 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
15979 performance for a blend of processors within architecture @var{arch}.
15980 The aim is to generate code that run well on the current most popular
15981 processors, balancing between optimizations that benefit some CPUs in the
15982 range, and avoiding performance pitfalls of other CPUs.  The effects of
15983 this option may change in future GCC versions as CPU models come and go.
15985 @option{-mtune} permits the same extension options as @option{-mcpu}, but
15986 the extension options do not affect the tuning of the generated code.
15988 @option{-mtune=native} causes the compiler to auto-detect the CPU
15989 of the build computer.  At present, this feature is only supported on
15990 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
15991 unsuccessful the option has no effect.
15993 @item -mcpu=@var{name}@r{[}+extension@dots{}@r{]}
15994 @opindex mcpu
15995 This specifies the name of the target ARM processor.  GCC uses this name
15996 to derive the name of the target ARM architecture (as if specified
15997 by @option{-march}) and the ARM processor type for which to tune for
15998 performance (as if specified by @option{-mtune}).  Where this option
15999 is used in conjunction with @option{-march} or @option{-mtune},
16000 those options take precedence over the appropriate part of this option.
16002 Many of the supported CPUs implement optional architectural
16003 extensions.  Where this is so the architectural extensions are
16004 normally enabled by default.  If implementations that lack the
16005 extension exist, then the extension syntax can be used to disable
16006 those extensions that have been omitted.  For floating-point and
16007 Advanced SIMD (Neon) instructions, the settings of the options
16008 @option{-mfloat-abi} and @option{-mfpu} must also be considered:
16009 floating-point and Advanced SIMD instructions will only be used if
16010 @option{-mfloat-abi} is not set to @samp{soft}; and any setting of
16011 @option{-mfpu} other than @samp{auto} will override the available
16012 floating-point and SIMD extension instructions.
16014 For example, @samp{cortex-a9} can be found in three major
16015 configurations: integer only, with just a floating-point unit or with
16016 floating-point and Advanced SIMD.  The default is to enable all the
16017 instructions, but the extensions @samp{+nosimd} and @samp{+nofp} can
16018 be used to disable just the SIMD or both the SIMD and floating-point
16019 instructions respectively.
16021 Permissible names for this option are the same as those for
16022 @option{-mtune}.
16024 The following extension options are common to the listed CPUs:
16026 @table @samp
16027 @item +nodsp
16028 Disable the DSP instructions on @samp{cortex-m33}.
16030 @item  +nofp
16031 Disables the floating-point instructions on @samp{arm9e},
16032 @samp{arm946e-s}, @samp{arm966e-s}, @samp{arm968e-s}, @samp{arm10e},
16033 @samp{arm1020e}, @samp{arm1022e}, @samp{arm926ej-s},
16034 @samp{arm1026ej-s}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-r8},
16035 @samp{cortex-m4}, @samp{cortex-m7} and @samp{cortex-m33}.
16036 Disables the floating-point and SIMD instructions on
16037 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7},
16038 @samp{cortex-a8}, @samp{cortex-a9}, @samp{cortex-a12},
16039 @samp{cortex-a15}, @samp{cortex-a17}, @samp{cortex-a15.cortex-a7},
16040 @samp{cortex-a17.cortex-a7}, @samp{cortex-a32}, @samp{cortex-a35},
16041 @samp{cortex-a53} and @samp{cortex-a55}.
16043 @item +nofp.dp
16044 Disables the double-precision component of the floating-point instructions
16045 on @samp{cortex-r5}, @samp{cortex-r52} and @samp{cortex-m7}.
16047 @item +nosimd
16048 Disables the SIMD (but not floating-point) instructions on
16049 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}
16050 and @samp{cortex-a9}.
16052 @item +crypto
16053 Enables the cryptographic instructions on @samp{cortex-a32},
16054 @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55}, @samp{cortex-a57},
16055 @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75}, @samp{exynos-m1},
16056 @samp{xgene1}, @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
16057 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53} and
16058 @samp{cortex-a75.cortex-a55}.
16059 @end table
16061 Additionally the @samp{generic-armv7-a} pseudo target defaults to
16062 VFPv3 with 16 double-precision registers.  It supports the following
16063 extension options: @samp{vfpv3-d16}, @samp{vfpv3},
16064 @samp{vfpv3-d16-fp16}, @samp{vfpv3-fp16}, @samp{vfpv4-d16},
16065 @samp{vfpv4}, @samp{neon}, @samp{neon-vfpv3}, @samp{neon-fp16},
16066 @samp{neon-vfpv4}.  The meanings are the same as for the extensions to
16067 @option{-march=armv7-a}.
16069 @option{-mcpu=generic-@var{arch}} is also permissible, and is
16070 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
16071 See @option{-mtune} for more information.
16073 @option{-mcpu=native} causes the compiler to auto-detect the CPU
16074 of the build computer.  At present, this feature is only supported on
16075 GNU/Linux, and not all architectures are recognized.  If the auto-detect
16076 is unsuccessful the option has no effect.
16078 @item -mfpu=@var{name}
16079 @opindex mfpu
16080 This specifies what floating-point hardware (or hardware emulation) is
16081 available on the target.  Permissible names are: @samp{auto}, @samp{vfpv2},
16082 @samp{vfpv3},
16083 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
16084 @samp{vfpv3xd-fp16}, @samp{neon-vfpv3}, @samp{neon-fp16}, @samp{vfpv4},
16085 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
16086 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
16087 @samp{fp-armv8}, @samp{neon-fp-armv8} and @samp{crypto-neon-fp-armv8}.
16088 Note that @samp{neon} is an alias for @samp{neon-vfpv3} and @samp{vfp}
16089 is an alias for @samp{vfpv2}.
16091 The setting @samp{auto} is the default and is special.  It causes the
16092 compiler to select the floating-point and Advanced SIMD instructions
16093 based on the settings of @option{-mcpu} and @option{-march}.
16095 If the selected floating-point hardware includes the NEON extension
16096 (e.g. @option{-mfpu=neon}), note that floating-point
16097 operations are not generated by GCC's auto-vectorization pass unless
16098 @option{-funsafe-math-optimizations} is also specified.  This is
16099 because NEON hardware does not fully implement the IEEE 754 standard for
16100 floating-point arithmetic (in particular denormal values are treated as
16101 zero), so the use of NEON instructions may lead to a loss of precision.
16103 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}).
16105 @item -mfp16-format=@var{name}
16106 @opindex mfp16-format
16107 Specify the format of the @code{__fp16} half-precision floating-point type.
16108 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
16109 the default is @samp{none}, in which case the @code{__fp16} type is not
16110 defined.  @xref{Half-Precision}, for more information.
16112 @item -mstructure-size-boundary=@var{n}
16113 @opindex mstructure-size-boundary
16114 The sizes of all structures and unions are rounded up to a multiple
16115 of the number of bits set by this option.  Permissible values are 8, 32
16116 and 64.  The default value varies for different toolchains.  For the COFF
16117 targeted toolchain the default value is 8.  A value of 64 is only allowed
16118 if the underlying ABI supports it.
16120 Specifying a larger number can produce faster, more efficient code, but
16121 can also increase the size of the program.  Different values are potentially
16122 incompatible.  Code compiled with one value cannot necessarily expect to
16123 work with code or libraries compiled with another value, if they exchange
16124 information using structures or unions.
16126 This option is deprecated.
16128 @item -mabort-on-noreturn
16129 @opindex mabort-on-noreturn
16130 Generate a call to the function @code{abort} at the end of a
16131 @code{noreturn} function.  It is executed if the function tries to
16132 return.
16134 @item -mlong-calls
16135 @itemx -mno-long-calls
16136 @opindex mlong-calls
16137 @opindex mno-long-calls
16138 Tells the compiler to perform function calls by first loading the
16139 address of the function into a register and then performing a subroutine
16140 call on this register.  This switch is needed if the target function
16141 lies outside of the 64-megabyte addressing range of the offset-based
16142 version of subroutine call instruction.
16144 Even if this switch is enabled, not all function calls are turned
16145 into long calls.  The heuristic is that static functions, functions
16146 that have the @code{short_call} attribute, functions that are inside
16147 the scope of a @code{#pragma no_long_calls} directive, and functions whose
16148 definitions have already been compiled within the current compilation
16149 unit are not turned into long calls.  The exceptions to this rule are
16150 that weak function definitions, functions with the @code{long_call}
16151 attribute or the @code{section} attribute, and functions that are within
16152 the scope of a @code{#pragma long_calls} directive are always
16153 turned into long calls.
16155 This feature is not enabled by default.  Specifying
16156 @option{-mno-long-calls} restores the default behavior, as does
16157 placing the function calls within the scope of a @code{#pragma
16158 long_calls_off} directive.  Note these switches have no effect on how
16159 the compiler generates code to handle function calls via function
16160 pointers.
16162 @item -msingle-pic-base
16163 @opindex msingle-pic-base
16164 Treat the register used for PIC addressing as read-only, rather than
16165 loading it in the prologue for each function.  The runtime system is
16166 responsible for initializing this register with an appropriate value
16167 before execution begins.
16169 @item -mpic-register=@var{reg}
16170 @opindex mpic-register
16171 Specify the register to be used for PIC addressing.
16172 For standard PIC base case, the default is any suitable register
16173 determined by compiler.  For single PIC base case, the default is
16174 @samp{R9} if target is EABI based or stack-checking is enabled,
16175 otherwise the default is @samp{R10}.
16177 @item -mpic-data-is-text-relative
16178 @opindex mpic-data-is-text-relative
16179 Assume that the displacement between the text and data segments is fixed
16180 at static link time.  This permits using PC-relative addressing
16181 operations to access data known to be in the data segment.  For
16182 non-VxWorks RTP targets, this option is enabled by default.  When
16183 disabled on such targets, it will enable @option{-msingle-pic-base} by
16184 default.
16186 @item -mpoke-function-name
16187 @opindex mpoke-function-name
16188 Write the name of each function into the text section, directly
16189 preceding the function prologue.  The generated code is similar to this:
16191 @smallexample
16192      t0
16193          .ascii "arm_poke_function_name", 0
16194          .align
16195      t1
16196          .word 0xff000000 + (t1 - t0)
16197      arm_poke_function_name
16198          mov     ip, sp
16199          stmfd   sp!, @{fp, ip, lr, pc@}
16200          sub     fp, ip, #4
16201 @end smallexample
16203 When performing a stack backtrace, code can inspect the value of
16204 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
16205 location @code{pc - 12} and the top 8 bits are set, then we know that
16206 there is a function name embedded immediately preceding this location
16207 and has length @code{((pc[-3]) & 0xff000000)}.
16209 @item -mthumb
16210 @itemx -marm
16211 @opindex marm
16212 @opindex mthumb
16214 Select between generating code that executes in ARM and Thumb
16215 states.  The default for most configurations is to generate code
16216 that executes in ARM state, but the default can be changed by
16217 configuring GCC with the @option{--with-mode=}@var{state}
16218 configure option.
16220 You can also override the ARM and Thumb mode for each function
16221 by using the @code{target("thumb")} and @code{target("arm")} function attributes
16222 (@pxref{ARM Function Attributes}) or pragmas (@pxref{Function Specific Option Pragmas}).
16224 @item -mtpcs-frame
16225 @opindex mtpcs-frame
16226 Generate a stack frame that is compliant with the Thumb Procedure Call
16227 Standard for all non-leaf functions.  (A leaf function is one that does
16228 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
16230 @item -mtpcs-leaf-frame
16231 @opindex mtpcs-leaf-frame
16232 Generate a stack frame that is compliant with the Thumb Procedure Call
16233 Standard for all leaf functions.  (A leaf function is one that does
16234 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
16236 @item -mcallee-super-interworking
16237 @opindex mcallee-super-interworking
16238 Gives all externally visible functions in the file being compiled an ARM
16239 instruction set header which switches to Thumb mode before executing the
16240 rest of the function.  This allows these functions to be called from
16241 non-interworking code.  This option is not valid in AAPCS configurations
16242 because interworking is enabled by default.
16244 @item -mcaller-super-interworking
16245 @opindex mcaller-super-interworking
16246 Allows calls via function pointers (including virtual functions) to
16247 execute correctly regardless of whether the target code has been
16248 compiled for interworking or not.  There is a small overhead in the cost
16249 of executing a function pointer if this option is enabled.  This option
16250 is not valid in AAPCS configurations because interworking is enabled
16251 by default.
16253 @item -mtp=@var{name}
16254 @opindex mtp
16255 Specify the access model for the thread local storage pointer.  The valid
16256 models are @samp{soft}, which generates calls to @code{__aeabi_read_tp},
16257 @samp{cp15}, which fetches the thread pointer from @code{cp15} directly
16258 (supported in the arm6k architecture), and @samp{auto}, which uses the
16259 best available method for the selected processor.  The default setting is
16260 @samp{auto}.
16262 @item -mtls-dialect=@var{dialect}
16263 @opindex mtls-dialect
16264 Specify the dialect to use for accessing thread local storage.  Two
16265 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
16266 @samp{gnu} dialect selects the original GNU scheme for supporting
16267 local and global dynamic TLS models.  The @samp{gnu2} dialect
16268 selects the GNU descriptor scheme, which provides better performance
16269 for shared libraries.  The GNU descriptor scheme is compatible with
16270 the original scheme, but does require new assembler, linker and
16271 library support.  Initial and local exec TLS models are unaffected by
16272 this option and always use the original scheme.
16274 @item -mword-relocations
16275 @opindex mword-relocations
16276 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
16277 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
16278 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
16279 is specified.
16281 @item -mfix-cortex-m3-ldrd
16282 @opindex mfix-cortex-m3-ldrd
16283 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
16284 with overlapping destination and base registers are used.  This option avoids
16285 generating these instructions.  This option is enabled by default when
16286 @option{-mcpu=cortex-m3} is specified.
16288 @item -munaligned-access
16289 @itemx -mno-unaligned-access
16290 @opindex munaligned-access
16291 @opindex mno-unaligned-access
16292 Enables (or disables) reading and writing of 16- and 32- bit values
16293 from addresses that are not 16- or 32- bit aligned.  By default
16294 unaligned access is disabled for all pre-ARMv6, all ARMv6-M and for
16295 ARMv8-M Baseline architectures, and enabled for all other
16296 architectures.  If unaligned access is not enabled then words in packed
16297 data structures are accessed a byte at a time.
16299 The ARM attribute @code{Tag_CPU_unaligned_access} is set in the
16300 generated object file to either true or false, depending upon the
16301 setting of this option.  If unaligned access is enabled then the
16302 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} is also
16303 defined.
16305 @item -mneon-for-64bits
16306 @opindex mneon-for-64bits
16307 Enables using Neon to handle scalar 64-bits operations. This is
16308 disabled by default since the cost of moving data from core registers
16309 to Neon is high.
16311 @item -mslow-flash-data
16312 @opindex mslow-flash-data
16313 Assume loading data from flash is slower than fetching instruction.
16314 Therefore literal load is minimized for better performance.
16315 This option is only supported when compiling for ARMv7 M-profile and
16316 off by default.
16318 @item -masm-syntax-unified
16319 @opindex masm-syntax-unified
16320 Assume inline assembler is using unified asm syntax.  The default is
16321 currently off which implies divided syntax.  This option has no impact
16322 on Thumb2. However, this may change in future releases of GCC.
16323 Divided syntax should be considered deprecated.
16325 @item -mrestrict-it
16326 @opindex mrestrict-it
16327 Restricts generation of IT blocks to conform to the rules of ARMv8-A.
16328 IT blocks can only contain a single 16-bit instruction from a select
16329 set of instructions. This option is on by default for ARMv8-A Thumb mode.
16331 @item -mprint-tune-info
16332 @opindex mprint-tune-info
16333 Print CPU tuning information as comment in assembler file.  This is
16334 an option used only for regression testing of the compiler and not
16335 intended for ordinary use in compiling code.  This option is disabled
16336 by default.
16338 @item -mpure-code
16339 @opindex mpure-code
16340 Do not allow constant data to be placed in code sections.
16341 Additionally, when compiling for ELF object format give all text sections the
16342 ELF processor-specific section attribute @code{SHF_ARM_PURECODE}.  This option
16343 is only available when generating non-pic code for M-profile targets with the
16344 MOVT instruction.
16346 @item -mcmse
16347 @opindex mcmse
16348 Generate secure code as per the "ARMv8-M Security Extensions: Requirements on
16349 Development Tools Engineering Specification", which can be found on
16350 @url{http://infocenter.arm.com/help/topic/com.arm.doc.ecm0359818/ECM0359818_armv8m_security_extensions_reqs_on_dev_tools_1_0.pdf}.
16351 @end table
16353 @node AVR Options
16354 @subsection AVR Options
16355 @cindex AVR Options
16357 These options are defined for AVR implementations:
16359 @table @gcctabopt
16360 @item -mmcu=@var{mcu}
16361 @opindex mmcu
16362 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
16364 The default for this option is@tie{}@samp{avr2}.
16366 GCC supports the following AVR devices and ISAs:
16368 @include avr-mmcu.texi
16370 @item -mabsdata
16371 @opindex mabsdata
16373 Assume that all data in static storage can be accessed by LDS / STS
16374 instructions.  This option has only an effect on reduced Tiny devices like
16375 ATtiny40.  See also the @code{absdata}
16376 @ref{AVR Variable Attributes,variable attribute}.
16378 @item -maccumulate-args
16379 @opindex maccumulate-args
16380 Accumulate outgoing function arguments and acquire/release the needed
16381 stack space for outgoing function arguments once in function
16382 prologue/epilogue.  Without this option, outgoing arguments are pushed
16383 before calling a function and popped afterwards.
16385 Popping the arguments after the function call can be expensive on
16386 AVR so that accumulating the stack space might lead to smaller
16387 executables because arguments need not be removed from the
16388 stack after such a function call.
16390 This option can lead to reduced code size for functions that perform
16391 several calls to functions that get their arguments on the stack like
16392 calls to printf-like functions.
16394 @item -mbranch-cost=@var{cost}
16395 @opindex mbranch-cost
16396 Set the branch costs for conditional branch instructions to
16397 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
16398 integers. The default branch cost is 0.
16400 @item -mcall-prologues
16401 @opindex mcall-prologues
16402 Functions prologues/epilogues are expanded as calls to appropriate
16403 subroutines.  Code size is smaller.
16405 @item -mgas-isr-prologues
16406 @opindex mgas-isr-prologues
16407 Interrupt service routines (ISRs) may use the @code{__gcc_isr} pseudo
16408 instruction supported by GNU Binutils.
16409 If this option is on, the feature can still be disabled for individual
16410 ISRs by means of the @ref{AVR Function Attributes,,@code{no_gccisr}}
16411 function attribute.  This feature is activated per default
16412 if optimization is on (but not with @option{-Og}, @pxref{Optimize Options}),
16413 and if GNU Binutils support @w{@uref{https://sourceware.org/PR21683,PR21683}}.
16415 @item -mint8
16416 @opindex mint8
16417 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
16418 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
16419 and @code{long long} is 4 bytes.  Please note that this option does not
16420 conform to the C standards, but it results in smaller code
16421 size.
16423 @item -mn-flash=@var{num}
16424 @opindex mn-flash
16425 Assume that the flash memory has a size of 
16426 @var{num} times 64@tie{}KiB.
16428 @item -mno-interrupts
16429 @opindex mno-interrupts
16430 Generated code is not compatible with hardware interrupts.
16431 Code size is smaller.
16433 @item -mrelax
16434 @opindex mrelax
16435 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
16436 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
16437 Setting @option{-mrelax} just adds the @option{--mlink-relax} option to
16438 the assembler's command line and the @option{--relax} option to the
16439 linker's command line.
16441 Jump relaxing is performed by the linker because jump offsets are not
16442 known before code is located. Therefore, the assembler code generated by the
16443 compiler is the same, but the instructions in the executable may
16444 differ from instructions in the assembler code.
16446 Relaxing must be turned on if linker stubs are needed, see the
16447 section on @code{EIND} and linker stubs below.
16449 @item -mrmw
16450 @opindex mrmw
16451 Assume that the device supports the Read-Modify-Write
16452 instructions @code{XCH}, @code{LAC}, @code{LAS} and @code{LAT}.
16454 @item -mshort-calls
16455 @opindex mshort-calls
16457 Assume that @code{RJMP} and @code{RCALL} can target the whole
16458 program memory.
16460 This option is used internally for multilib selection.  It is
16461 not an optimization option, and you don't need to set it by hand.
16463 @item -msp8
16464 @opindex msp8
16465 Treat the stack pointer register as an 8-bit register,
16466 i.e.@: assume the high byte of the stack pointer is zero.
16467 In general, you don't need to set this option by hand.
16469 This option is used internally by the compiler to select and
16470 build multilibs for architectures @code{avr2} and @code{avr25}.
16471 These architectures mix devices with and without @code{SPH}.
16472 For any setting other than @option{-mmcu=avr2} or @option{-mmcu=avr25}
16473 the compiler driver adds or removes this option from the compiler
16474 proper's command line, because the compiler then knows if the device
16475 or architecture has an 8-bit stack pointer and thus no @code{SPH}
16476 register or not.
16478 @item -mstrict-X
16479 @opindex mstrict-X
16480 Use address register @code{X} in a way proposed by the hardware.  This means
16481 that @code{X} is only used in indirect, post-increment or
16482 pre-decrement addressing.
16484 Without this option, the @code{X} register may be used in the same way
16485 as @code{Y} or @code{Z} which then is emulated by additional
16486 instructions.  
16487 For example, loading a value with @code{X+const} addressing with a
16488 small non-negative @code{const < 64} to a register @var{Rn} is
16489 performed as
16491 @example
16492 adiw r26, const   ; X += const
16493 ld   @var{Rn}, X        ; @var{Rn} = *X
16494 sbiw r26, const   ; X -= const
16495 @end example
16497 @item -mtiny-stack
16498 @opindex mtiny-stack
16499 Only change the lower 8@tie{}bits of the stack pointer.
16501 @item -mfract-convert-truncate
16502 @opindex mfract-convert-truncate
16503 Allow to use truncation instead of rounding towards zero for fractional fixed-point types.
16505 @item -nodevicelib
16506 @opindex nodevicelib
16507 Don't link against AVR-LibC's device specific library @code{lib<mcu>.a}.
16509 @item -Waddr-space-convert
16510 @opindex Waddr-space-convert
16511 Warn about conversions between address spaces in the case where the
16512 resulting address space is not contained in the incoming address space.
16514 @item -Wmisspelled-isr
16515 @opindex Wmisspelled-isr
16516 Warn if the ISR is misspelled, i.e. without __vector prefix.
16517 Enabled by default.
16518 @end table
16520 @subsubsection @code{EIND} and Devices with More Than 128 Ki Bytes of Flash
16521 @cindex @code{EIND}
16522 Pointers in the implementation are 16@tie{}bits wide.
16523 The address of a function or label is represented as word address so
16524 that indirect jumps and calls can target any code address in the
16525 range of 64@tie{}Ki words.
16527 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
16528 bytes of program memory space, there is a special function register called
16529 @code{EIND} that serves as most significant part of the target address
16530 when @code{EICALL} or @code{EIJMP} instructions are used.
16532 Indirect jumps and calls on these devices are handled as follows by
16533 the compiler and are subject to some limitations:
16535 @itemize @bullet
16537 @item
16538 The compiler never sets @code{EIND}.
16540 @item
16541 The compiler uses @code{EIND} implicitly in @code{EICALL}/@code{EIJMP}
16542 instructions or might read @code{EIND} directly in order to emulate an
16543 indirect call/jump by means of a @code{RET} instruction.
16545 @item
16546 The compiler assumes that @code{EIND} never changes during the startup
16547 code or during the application. In particular, @code{EIND} is not
16548 saved/restored in function or interrupt service routine
16549 prologue/epilogue.
16551 @item
16552 For indirect calls to functions and computed goto, the linker
16553 generates @emph{stubs}. Stubs are jump pads sometimes also called
16554 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
16555 The stub contains a direct jump to the desired address.
16557 @item
16558 Linker relaxation must be turned on so that the linker generates
16559 the stubs correctly in all situations. See the compiler option
16560 @option{-mrelax} and the linker option @option{--relax}.
16561 There are corner cases where the linker is supposed to generate stubs
16562 but aborts without relaxation and without a helpful error message.
16564 @item
16565 The default linker script is arranged for code with @code{EIND = 0}.
16566 If code is supposed to work for a setup with @code{EIND != 0}, a custom
16567 linker script has to be used in order to place the sections whose
16568 name start with @code{.trampolines} into the segment where @code{EIND}
16569 points to.
16571 @item
16572 The startup code from libgcc never sets @code{EIND}.
16573 Notice that startup code is a blend of code from libgcc and AVR-LibC.
16574 For the impact of AVR-LibC on @code{EIND}, see the
16575 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
16577 @item
16578 It is legitimate for user-specific startup code to set up @code{EIND}
16579 early, for example by means of initialization code located in
16580 section @code{.init3}. Such code runs prior to general startup code
16581 that initializes RAM and calls constructors, but after the bit
16582 of startup code from AVR-LibC that sets @code{EIND} to the segment
16583 where the vector table is located.
16584 @example
16585 #include <avr/io.h>
16587 static void
16588 __attribute__((section(".init3"),naked,used,no_instrument_function))
16589 init3_set_eind (void)
16591   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
16592                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
16594 @end example
16596 @noindent
16597 The @code{__trampolines_start} symbol is defined in the linker script.
16599 @item
16600 Stubs are generated automatically by the linker if
16601 the following two conditions are met:
16602 @itemize @minus
16604 @item The address of a label is taken by means of the @code{gs} modifier
16605 (short for @emph{generate stubs}) like so:
16606 @example
16607 LDI r24, lo8(gs(@var{func}))
16608 LDI r25, hi8(gs(@var{func}))
16609 @end example
16610 @item The final location of that label is in a code segment
16611 @emph{outside} the segment where the stubs are located.
16612 @end itemize
16614 @item
16615 The compiler emits such @code{gs} modifiers for code labels in the
16616 following situations:
16617 @itemize @minus
16618 @item Taking address of a function or code label.
16619 @item Computed goto.
16620 @item If prologue-save function is used, see @option{-mcall-prologues}
16621 command-line option.
16622 @item Switch/case dispatch tables. If you do not want such dispatch
16623 tables you can specify the @option{-fno-jump-tables} command-line option.
16624 @item C and C++ constructors/destructors called during startup/shutdown.
16625 @item If the tools hit a @code{gs()} modifier explained above.
16626 @end itemize
16628 @item
16629 Jumping to non-symbolic addresses like so is @emph{not} supported:
16631 @example
16632 int main (void)
16634     /* Call function at word address 0x2 */
16635     return ((int(*)(void)) 0x2)();
16637 @end example
16639 Instead, a stub has to be set up, i.e.@: the function has to be called
16640 through a symbol (@code{func_4} in the example):
16642 @example
16643 int main (void)
16645     extern int func_4 (void);
16647     /* Call function at byte address 0x4 */
16648     return func_4();
16650 @end example
16652 and the application be linked with @option{-Wl,--defsym,func_4=0x4}.
16653 Alternatively, @code{func_4} can be defined in the linker script.
16654 @end itemize
16656 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
16657 @cindex @code{RAMPD}
16658 @cindex @code{RAMPX}
16659 @cindex @code{RAMPY}
16660 @cindex @code{RAMPZ}
16661 Some AVR devices support memories larger than the 64@tie{}KiB range
16662 that can be accessed with 16-bit pointers.  To access memory locations
16663 outside this 64@tie{}KiB range, the content of a @code{RAMP}
16664 register is used as high part of the address:
16665 The @code{X}, @code{Y}, @code{Z} address register is concatenated
16666 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
16667 register, respectively, to get a wide address. Similarly,
16668 @code{RAMPD} is used together with direct addressing.
16670 @itemize
16671 @item
16672 The startup code initializes the @code{RAMP} special function
16673 registers with zero.
16675 @item
16676 If a @ref{AVR Named Address Spaces,named address space} other than
16677 generic or @code{__flash} is used, then @code{RAMPZ} is set
16678 as needed before the operation.
16680 @item
16681 If the device supports RAM larger than 64@tie{}KiB and the compiler
16682 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
16683 is reset to zero after the operation.
16685 @item
16686 If the device comes with a specific @code{RAMP} register, the ISR
16687 prologue/epilogue saves/restores that SFR and initializes it with
16688 zero in case the ISR code might (implicitly) use it.
16690 @item
16691 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
16692 If you use inline assembler to read from locations outside the
16693 16-bit address range and change one of the @code{RAMP} registers,
16694 you must reset it to zero after the access.
16696 @end itemize
16698 @subsubsection AVR Built-in Macros
16700 GCC defines several built-in macros so that the user code can test
16701 for the presence or absence of features.  Almost any of the following
16702 built-in macros are deduced from device capabilities and thus
16703 triggered by the @option{-mmcu=} command-line option.
16705 For even more AVR-specific built-in macros see
16706 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
16708 @table @code
16710 @item __AVR_ARCH__
16711 Build-in macro that resolves to a decimal number that identifies the
16712 architecture and depends on the @option{-mmcu=@var{mcu}} option.
16713 Possible values are:
16715 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
16716 @code{4}, @code{5}, @code{51}, @code{6}
16718 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3}, @code{avr31},
16719 @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51}, @code{avr6},
16721 respectively and
16723 @code{100},
16724 @code{102}, @code{103}, @code{104},
16725 @code{105}, @code{106}, @code{107}
16727 for @var{mcu}=@code{avrtiny},
16728 @code{avrxmega2}, @code{avrxmega3}, @code{avrxmega4},
16729 @code{avrxmega5}, @code{avrxmega6}, @code{avrxmega7}, respectively.
16730 If @var{mcu} specifies a device, this built-in macro is set
16731 accordingly. For example, with @option{-mmcu=atmega8} the macro is
16732 defined to @code{4}.
16734 @item __AVR_@var{Device}__
16735 Setting @option{-mmcu=@var{device}} defines this built-in macro which reflects
16736 the device's name. For example, @option{-mmcu=atmega8} defines the
16737 built-in macro @code{__AVR_ATmega8__}, @option{-mmcu=attiny261a} defines
16738 @code{__AVR_ATtiny261A__}, etc.
16740 The built-in macros' names follow
16741 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
16742 the device name as from the AVR user manual. The difference between
16743 @var{Device} in the built-in macro and @var{device} in
16744 @option{-mmcu=@var{device}} is that the latter is always lowercase.
16746 If @var{device} is not a device but only a core architecture like
16747 @samp{avr51}, this macro is not defined.
16749 @item __AVR_DEVICE_NAME__
16750 Setting @option{-mmcu=@var{device}} defines this built-in macro to
16751 the device's name. For example, with @option{-mmcu=atmega8} the macro
16752 is defined to @code{atmega8}.
16754 If @var{device} is not a device but only a core architecture like
16755 @samp{avr51}, this macro is not defined.
16757 @item __AVR_XMEGA__
16758 The device / architecture belongs to the XMEGA family of devices.
16760 @item __AVR_HAVE_ELPM__
16761 The device has the @code{ELPM} instruction.
16763 @item __AVR_HAVE_ELPMX__
16764 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
16765 R@var{n},Z+} instructions.
16767 @item __AVR_HAVE_MOVW__
16768 The device has the @code{MOVW} instruction to perform 16-bit
16769 register-register moves.
16771 @item __AVR_HAVE_LPMX__
16772 The device has the @code{LPM R@var{n},Z} and
16773 @code{LPM R@var{n},Z+} instructions.
16775 @item __AVR_HAVE_MUL__
16776 The device has a hardware multiplier. 
16778 @item __AVR_HAVE_JMP_CALL__
16779 The device has the @code{JMP} and @code{CALL} instructions.
16780 This is the case for devices with more than 8@tie{}KiB of program
16781 memory.
16783 @item __AVR_HAVE_EIJMP_EICALL__
16784 @itemx __AVR_3_BYTE_PC__
16785 The device has the @code{EIJMP} and @code{EICALL} instructions.
16786 This is the case for devices with more than 128@tie{}KiB of program memory.
16787 This also means that the program counter
16788 (PC) is 3@tie{}bytes wide.
16790 @item __AVR_2_BYTE_PC__
16791 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
16792 with up to 128@tie{}KiB of program memory.
16794 @item __AVR_HAVE_8BIT_SP__
16795 @itemx __AVR_HAVE_16BIT_SP__
16796 The stack pointer (SP) register is treated as 8-bit respectively
16797 16-bit register by the compiler.
16798 The definition of these macros is affected by @option{-mtiny-stack}.
16800 @item __AVR_HAVE_SPH__
16801 @itemx __AVR_SP8__
16802 The device has the SPH (high part of stack pointer) special function
16803 register or has an 8-bit stack pointer, respectively.
16804 The definition of these macros is affected by @option{-mmcu=} and
16805 in the cases of @option{-mmcu=avr2} and @option{-mmcu=avr25} also
16806 by @option{-msp8}.
16808 @item __AVR_HAVE_RAMPD__
16809 @itemx __AVR_HAVE_RAMPX__
16810 @itemx __AVR_HAVE_RAMPY__
16811 @itemx __AVR_HAVE_RAMPZ__
16812 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
16813 @code{RAMPZ} special function register, respectively.
16815 @item __NO_INTERRUPTS__
16816 This macro reflects the @option{-mno-interrupts} command-line option.
16818 @item __AVR_ERRATA_SKIP__
16819 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
16820 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
16821 instructions because of a hardware erratum.  Skip instructions are
16822 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
16823 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
16824 set.
16826 @item __AVR_ISA_RMW__
16827 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
16829 @item __AVR_SFR_OFFSET__=@var{offset}
16830 Instructions that can address I/O special function registers directly
16831 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
16832 address as if addressed by an instruction to access RAM like @code{LD}
16833 or @code{STS}. This offset depends on the device architecture and has
16834 to be subtracted from the RAM address in order to get the
16835 respective I/O@tie{}address.
16837 @item __AVR_SHORT_CALLS__
16838 The @option{-mshort-calls} command line option is set.
16840 @item __AVR_PM_BASE_ADDRESS__=@var{addr}
16841 Some devices support reading from flash memory by means of @code{LD*}
16842 instructions.  The flash memory is seen in the data address space
16843 at an offset of @code{__AVR_PM_BASE_ADDRESS__}.  If this macro
16844 is not defined, this feature is not available.  If defined,
16845 the address space is linear and there is no need to put
16846 @code{.rodata} into RAM.  This is handled by the default linker
16847 description file, and is currently available for
16848 @code{avrtiny} and @code{avrxmega3}.  Even more convenient,
16849 there is no need to use address spaces like @code{__flash} or
16850 features like attribute @code{progmem} and @code{pgm_read_*}.
16852 @item __WITH_AVRLIBC__
16853 The compiler is configured to be used together with AVR-Libc.
16854 See the @option{--with-avrlibc} configure option.
16856 @end table
16858 @node Blackfin Options
16859 @subsection Blackfin Options
16860 @cindex Blackfin Options
16862 @table @gcctabopt
16863 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
16864 @opindex mcpu=
16865 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
16866 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
16867 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
16868 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
16869 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
16870 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
16871 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
16872 @samp{bf561}, @samp{bf592}.
16874 The optional @var{sirevision} specifies the silicon revision of the target
16875 Blackfin processor.  Any workarounds available for the targeted silicon revision
16876 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
16877 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
16878 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
16879 hexadecimal digits representing the major and minor numbers in the silicon
16880 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
16881 is not defined.  If @var{sirevision} is @samp{any}, the
16882 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
16883 If this optional @var{sirevision} is not used, GCC assumes the latest known
16884 silicon revision of the targeted Blackfin processor.
16886 GCC defines a preprocessor macro for the specified @var{cpu}.
16887 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
16888 provided by libgloss to be linked in if @option{-msim} is not given.
16890 Without this option, @samp{bf532} is used as the processor by default.
16892 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
16893 only the preprocessor macro is defined.
16895 @item -msim
16896 @opindex msim
16897 Specifies that the program will be run on the simulator.  This causes
16898 the simulator BSP provided by libgloss to be linked in.  This option
16899 has effect only for @samp{bfin-elf} toolchain.
16900 Certain other options, such as @option{-mid-shared-library} and
16901 @option{-mfdpic}, imply @option{-msim}.
16903 @item -momit-leaf-frame-pointer
16904 @opindex momit-leaf-frame-pointer
16905 Don't keep the frame pointer in a register for leaf functions.  This
16906 avoids the instructions to save, set up and restore frame pointers and
16907 makes an extra register available in leaf functions.
16909 @item -mspecld-anomaly
16910 @opindex mspecld-anomaly
16911 When enabled, the compiler ensures that the generated code does not
16912 contain speculative loads after jump instructions. If this option is used,
16913 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
16915 @item -mno-specld-anomaly
16916 @opindex mno-specld-anomaly
16917 Don't generate extra code to prevent speculative loads from occurring.
16919 @item -mcsync-anomaly
16920 @opindex mcsync-anomaly
16921 When enabled, the compiler ensures that the generated code does not
16922 contain CSYNC or SSYNC instructions too soon after conditional branches.
16923 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
16925 @item -mno-csync-anomaly
16926 @opindex mno-csync-anomaly
16927 Don't generate extra code to prevent CSYNC or SSYNC instructions from
16928 occurring too soon after a conditional branch.
16930 @item -mlow-64k
16931 @opindex mlow-64k
16932 When enabled, the compiler is free to take advantage of the knowledge that
16933 the entire program fits into the low 64k of memory.
16935 @item -mno-low-64k
16936 @opindex mno-low-64k
16937 Assume that the program is arbitrarily large.  This is the default.
16939 @item -mstack-check-l1
16940 @opindex mstack-check-l1
16941 Do stack checking using information placed into L1 scratchpad memory by the
16942 uClinux kernel.
16944 @item -mid-shared-library
16945 @opindex mid-shared-library
16946 Generate code that supports shared libraries via the library ID method.
16947 This allows for execute in place and shared libraries in an environment
16948 without virtual memory management.  This option implies @option{-fPIC}.
16949 With a @samp{bfin-elf} target, this option implies @option{-msim}.
16951 @item -mno-id-shared-library
16952 @opindex mno-id-shared-library
16953 Generate code that doesn't assume ID-based shared libraries are being used.
16954 This is the default.
16956 @item -mleaf-id-shared-library
16957 @opindex mleaf-id-shared-library
16958 Generate code that supports shared libraries via the library ID method,
16959 but assumes that this library or executable won't link against any other
16960 ID shared libraries.  That allows the compiler to use faster code for jumps
16961 and calls.
16963 @item -mno-leaf-id-shared-library
16964 @opindex mno-leaf-id-shared-library
16965 Do not assume that the code being compiled won't link against any ID shared
16966 libraries.  Slower code is generated for jump and call insns.
16968 @item -mshared-library-id=n
16969 @opindex mshared-library-id
16970 Specifies the identification number of the ID-based shared library being
16971 compiled.  Specifying a value of 0 generates more compact code; specifying
16972 other values forces the allocation of that number to the current
16973 library but is no more space- or time-efficient than omitting this option.
16975 @item -msep-data
16976 @opindex msep-data
16977 Generate code that allows the data segment to be located in a different
16978 area of memory from the text segment.  This allows for execute in place in
16979 an environment without virtual memory management by eliminating relocations
16980 against the text section.
16982 @item -mno-sep-data
16983 @opindex mno-sep-data
16984 Generate code that assumes that the data segment follows the text segment.
16985 This is the default.
16987 @item -mlong-calls
16988 @itemx -mno-long-calls
16989 @opindex mlong-calls
16990 @opindex mno-long-calls
16991 Tells the compiler to perform function calls by first loading the
16992 address of the function into a register and then performing a subroutine
16993 call on this register.  This switch is needed if the target function
16994 lies outside of the 24-bit addressing range of the offset-based
16995 version of subroutine call instruction.
16997 This feature is not enabled by default.  Specifying
16998 @option{-mno-long-calls} restores the default behavior.  Note these
16999 switches have no effect on how the compiler generates code to handle
17000 function calls via function pointers.
17002 @item -mfast-fp
17003 @opindex mfast-fp
17004 Link with the fast floating-point library. This library relaxes some of
17005 the IEEE floating-point standard's rules for checking inputs against
17006 Not-a-Number (NAN), in the interest of performance.
17008 @item -minline-plt
17009 @opindex minline-plt
17010 Enable inlining of PLT entries in function calls to functions that are
17011 not known to bind locally.  It has no effect without @option{-mfdpic}.
17013 @item -mmulticore
17014 @opindex mmulticore
17015 Build a standalone application for multicore Blackfin processors. 
17016 This option causes proper start files and link scripts supporting 
17017 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
17018 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
17020 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
17021 selects the one-application-per-core programming model.  Without
17022 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
17023 programming model is used. In this model, the main function of Core B
17024 should be named as @code{coreb_main}.
17026 If this option is not used, the single-core application programming
17027 model is used.
17029 @item -mcorea
17030 @opindex mcorea
17031 Build a standalone application for Core A of BF561 when using
17032 the one-application-per-core programming model. Proper start files
17033 and link scripts are used to support Core A, and the macro
17034 @code{__BFIN_COREA} is defined.
17035 This option can only be used in conjunction with @option{-mmulticore}.
17037 @item -mcoreb
17038 @opindex mcoreb
17039 Build a standalone application for Core B of BF561 when using
17040 the one-application-per-core programming model. Proper start files
17041 and link scripts are used to support Core B, and the macro
17042 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
17043 should be used instead of @code{main}. 
17044 This option can only be used in conjunction with @option{-mmulticore}.
17046 @item -msdram
17047 @opindex msdram
17048 Build a standalone application for SDRAM. Proper start files and
17049 link scripts are used to put the application into SDRAM, and the macro
17050 @code{__BFIN_SDRAM} is defined.
17051 The loader should initialize SDRAM before loading the application.
17053 @item -micplb
17054 @opindex micplb
17055 Assume that ICPLBs are enabled at run time.  This has an effect on certain
17056 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
17057 are enabled; for standalone applications the default is off.
17058 @end table
17060 @node C6X Options
17061 @subsection C6X Options
17062 @cindex C6X Options
17064 @table @gcctabopt
17065 @item -march=@var{name}
17066 @opindex march
17067 This specifies the name of the target architecture.  GCC uses this
17068 name to determine what kind of instructions it can emit when generating
17069 assembly code.  Permissible names are: @samp{c62x},
17070 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
17072 @item -mbig-endian
17073 @opindex mbig-endian
17074 Generate code for a big-endian target.
17076 @item -mlittle-endian
17077 @opindex mlittle-endian
17078 Generate code for a little-endian target.  This is the default.
17080 @item -msim
17081 @opindex msim
17082 Choose startup files and linker script suitable for the simulator.
17084 @item -msdata=default
17085 @opindex msdata=default
17086 Put small global and static data in the @code{.neardata} section,
17087 which is pointed to by register @code{B14}.  Put small uninitialized
17088 global and static data in the @code{.bss} section, which is adjacent
17089 to the @code{.neardata} section.  Put small read-only data into the
17090 @code{.rodata} section.  The corresponding sections used for large
17091 pieces of data are @code{.fardata}, @code{.far} and @code{.const}.
17093 @item -msdata=all
17094 @opindex msdata=all
17095 Put all data, not just small objects, into the sections reserved for
17096 small data, and use addressing relative to the @code{B14} register to
17097 access them.
17099 @item -msdata=none
17100 @opindex msdata=none
17101 Make no use of the sections reserved for small data, and use absolute
17102 addresses to access all data.  Put all initialized global and static
17103 data in the @code{.fardata} section, and all uninitialized data in the
17104 @code{.far} section.  Put all constant data into the @code{.const}
17105 section.
17106 @end table
17108 @node CRIS Options
17109 @subsection CRIS Options
17110 @cindex CRIS Options
17112 These options are defined specifically for the CRIS ports.
17114 @table @gcctabopt
17115 @item -march=@var{architecture-type}
17116 @itemx -mcpu=@var{architecture-type}
17117 @opindex march
17118 @opindex mcpu
17119 Generate code for the specified architecture.  The choices for
17120 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
17121 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
17122 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
17123 @samp{v10}.
17125 @item -mtune=@var{architecture-type}
17126 @opindex mtune
17127 Tune to @var{architecture-type} everything applicable about the generated
17128 code, except for the ABI and the set of available instructions.  The
17129 choices for @var{architecture-type} are the same as for
17130 @option{-march=@var{architecture-type}}.
17132 @item -mmax-stack-frame=@var{n}
17133 @opindex mmax-stack-frame
17134 Warn when the stack frame of a function exceeds @var{n} bytes.
17136 @item -metrax4
17137 @itemx -metrax100
17138 @opindex metrax4
17139 @opindex metrax100
17140 The options @option{-metrax4} and @option{-metrax100} are synonyms for
17141 @option{-march=v3} and @option{-march=v8} respectively.
17143 @item -mmul-bug-workaround
17144 @itemx -mno-mul-bug-workaround
17145 @opindex mmul-bug-workaround
17146 @opindex mno-mul-bug-workaround
17147 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
17148 models where it applies.  This option is active by default.
17150 @item -mpdebug
17151 @opindex mpdebug
17152 Enable CRIS-specific verbose debug-related information in the assembly
17153 code.  This option also has the effect of turning off the @samp{#NO_APP}
17154 formatted-code indicator to the assembler at the beginning of the
17155 assembly file.
17157 @item -mcc-init
17158 @opindex mcc-init
17159 Do not use condition-code results from previous instruction; always emit
17160 compare and test instructions before use of condition codes.
17162 @item -mno-side-effects
17163 @opindex mno-side-effects
17164 Do not emit instructions with side effects in addressing modes other than
17165 post-increment.
17167 @item -mstack-align
17168 @itemx -mno-stack-align
17169 @itemx -mdata-align
17170 @itemx -mno-data-align
17171 @itemx -mconst-align
17172 @itemx -mno-const-align
17173 @opindex mstack-align
17174 @opindex mno-stack-align
17175 @opindex mdata-align
17176 @opindex mno-data-align
17177 @opindex mconst-align
17178 @opindex mno-const-align
17179 These options (@samp{no-} options) arrange (eliminate arrangements) for the
17180 stack frame, individual data and constants to be aligned for the maximum
17181 single data access size for the chosen CPU model.  The default is to
17182 arrange for 32-bit alignment.  ABI details such as structure layout are
17183 not affected by these options.
17185 @item -m32-bit
17186 @itemx -m16-bit
17187 @itemx -m8-bit
17188 @opindex m32-bit
17189 @opindex m16-bit
17190 @opindex m8-bit
17191 Similar to the stack- data- and const-align options above, these options
17192 arrange for stack frame, writable data and constants to all be 32-bit,
17193 16-bit or 8-bit aligned.  The default is 32-bit alignment.
17195 @item -mno-prologue-epilogue
17196 @itemx -mprologue-epilogue
17197 @opindex mno-prologue-epilogue
17198 @opindex mprologue-epilogue
17199 With @option{-mno-prologue-epilogue}, the normal function prologue and
17200 epilogue which set up the stack frame are omitted and no return
17201 instructions or return sequences are generated in the code.  Use this
17202 option only together with visual inspection of the compiled code: no
17203 warnings or errors are generated when call-saved registers must be saved,
17204 or storage for local variables needs to be allocated.
17206 @item -mno-gotplt
17207 @itemx -mgotplt
17208 @opindex mno-gotplt
17209 @opindex mgotplt
17210 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
17211 instruction sequences that load addresses for functions from the PLT part
17212 of the GOT rather than (traditional on other architectures) calls to the
17213 PLT@.  The default is @option{-mgotplt}.
17215 @item -melf
17216 @opindex melf
17217 Legacy no-op option only recognized with the cris-axis-elf and
17218 cris-axis-linux-gnu targets.
17220 @item -mlinux
17221 @opindex mlinux
17222 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
17224 @item -sim
17225 @opindex sim
17226 This option, recognized for the cris-axis-elf, arranges
17227 to link with input-output functions from a simulator library.  Code,
17228 initialized data and zero-initialized data are allocated consecutively.
17230 @item -sim2
17231 @opindex sim2
17232 Like @option{-sim}, but pass linker options to locate initialized data at
17233 0x40000000 and zero-initialized data at 0x80000000.
17234 @end table
17236 @node CR16 Options
17237 @subsection CR16 Options
17238 @cindex CR16 Options
17240 These options are defined specifically for the CR16 ports.
17242 @table @gcctabopt
17244 @item -mmac
17245 @opindex mmac
17246 Enable the use of multiply-accumulate instructions. Disabled by default.
17248 @item -mcr16cplus
17249 @itemx -mcr16c
17250 @opindex mcr16cplus
17251 @opindex mcr16c
17252 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
17253 is default.
17255 @item -msim
17256 @opindex msim
17257 Links the library libsim.a which is in compatible with simulator. Applicable
17258 to ELF compiler only.
17260 @item -mint32
17261 @opindex mint32
17262 Choose integer type as 32-bit wide.
17264 @item -mbit-ops
17265 @opindex mbit-ops
17266 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
17268 @item -mdata-model=@var{model}
17269 @opindex mdata-model
17270 Choose a data model. The choices for @var{model} are @samp{near},
17271 @samp{far} or @samp{medium}. @samp{medium} is default.
17272 However, @samp{far} is not valid with @option{-mcr16c}, as the
17273 CR16C architecture does not support the far data model.
17274 @end table
17276 @node Darwin Options
17277 @subsection Darwin Options
17278 @cindex Darwin options
17280 These options are defined for all architectures running the Darwin operating
17281 system.
17283 FSF GCC on Darwin does not create ``fat'' object files; it creates
17284 an object file for the single architecture that GCC was built to
17285 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
17286 @option{-arch} options are used; it does so by running the compiler or
17287 linker multiple times and joining the results together with
17288 @file{lipo}.
17290 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
17291 @samp{i686}) is determined by the flags that specify the ISA
17292 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
17293 @option{-force_cpusubtype_ALL} option can be used to override this.
17295 The Darwin tools vary in their behavior when presented with an ISA
17296 mismatch.  The assembler, @file{as}, only permits instructions to
17297 be used that are valid for the subtype of the file it is generating,
17298 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
17299 The linker for shared libraries, @file{/usr/bin/libtool}, fails
17300 and prints an error if asked to create a shared library with a less
17301 restrictive subtype than its input files (for instance, trying to put
17302 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
17303 for executables, @command{ld}, quietly gives the executable the most
17304 restrictive subtype of any of its input files.
17306 @table @gcctabopt
17307 @item -F@var{dir}
17308 @opindex F
17309 Add the framework directory @var{dir} to the head of the list of
17310 directories to be searched for header files.  These directories are
17311 interleaved with those specified by @option{-I} options and are
17312 scanned in a left-to-right order.
17314 A framework directory is a directory with frameworks in it.  A
17315 framework is a directory with a @file{Headers} and/or
17316 @file{PrivateHeaders} directory contained directly in it that ends
17317 in @file{.framework}.  The name of a framework is the name of this
17318 directory excluding the @file{.framework}.  Headers associated with
17319 the framework are found in one of those two directories, with
17320 @file{Headers} being searched first.  A subframework is a framework
17321 directory that is in a framework's @file{Frameworks} directory.
17322 Includes of subframework headers can only appear in a header of a
17323 framework that contains the subframework, or in a sibling subframework
17324 header.  Two subframeworks are siblings if they occur in the same
17325 framework.  A subframework should not have the same name as a
17326 framework; a warning is issued if this is violated.  Currently a
17327 subframework cannot have subframeworks; in the future, the mechanism
17328 may be extended to support this.  The standard frameworks can be found
17329 in @file{/System/Library/Frameworks} and
17330 @file{/Library/Frameworks}.  An example include looks like
17331 @code{#include <Framework/header.h>}, where @file{Framework} denotes
17332 the name of the framework and @file{header.h} is found in the
17333 @file{PrivateHeaders} or @file{Headers} directory.
17335 @item -iframework@var{dir}
17336 @opindex iframework
17337 Like @option{-F} except the directory is a treated as a system
17338 directory.  The main difference between this @option{-iframework} and
17339 @option{-F} is that with @option{-iframework} the compiler does not
17340 warn about constructs contained within header files found via
17341 @var{dir}.  This option is valid only for the C family of languages.
17343 @item -gused
17344 @opindex gused
17345 Emit debugging information for symbols that are used.  For stabs
17346 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
17347 This is by default ON@.
17349 @item -gfull
17350 @opindex gfull
17351 Emit debugging information for all symbols and types.
17353 @item -mmacosx-version-min=@var{version}
17354 The earliest version of MacOS X that this executable will run on
17355 is @var{version}.  Typical values of @var{version} include @code{10.1},
17356 @code{10.2}, and @code{10.3.9}.
17358 If the compiler was built to use the system's headers by default,
17359 then the default for this option is the system version on which the
17360 compiler is running, otherwise the default is to make choices that
17361 are compatible with as many systems and code bases as possible.
17363 @item -mkernel
17364 @opindex mkernel
17365 Enable kernel development mode.  The @option{-mkernel} option sets
17366 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
17367 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
17368 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
17369 applicable.  This mode also sets @option{-mno-altivec},
17370 @option{-msoft-float}, @option{-fno-builtin} and
17371 @option{-mlong-branch} for PowerPC targets.
17373 @item -mone-byte-bool
17374 @opindex mone-byte-bool
17375 Override the defaults for @code{bool} so that @code{sizeof(bool)==1}.
17376 By default @code{sizeof(bool)} is @code{4} when compiling for
17377 Darwin/PowerPC and @code{1} when compiling for Darwin/x86, so this
17378 option has no effect on x86.
17380 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
17381 to generate code that is not binary compatible with code generated
17382 without that switch.  Using this switch may require recompiling all
17383 other modules in a program, including system libraries.  Use this
17384 switch to conform to a non-default data model.
17386 @item -mfix-and-continue
17387 @itemx -ffix-and-continue
17388 @itemx -findirect-data
17389 @opindex mfix-and-continue
17390 @opindex ffix-and-continue
17391 @opindex findirect-data
17392 Generate code suitable for fast turnaround development, such as to
17393 allow GDB to dynamically load @file{.o} files into already-running
17394 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
17395 are provided for backwards compatibility.
17397 @item -all_load
17398 @opindex all_load
17399 Loads all members of static archive libraries.
17400 See man ld(1) for more information.
17402 @item -arch_errors_fatal
17403 @opindex arch_errors_fatal
17404 Cause the errors having to do with files that have the wrong architecture
17405 to be fatal.
17407 @item -bind_at_load
17408 @opindex bind_at_load
17409 Causes the output file to be marked such that the dynamic linker will
17410 bind all undefined references when the file is loaded or launched.
17412 @item -bundle
17413 @opindex bundle
17414 Produce a Mach-o bundle format file.
17415 See man ld(1) for more information.
17417 @item -bundle_loader @var{executable}
17418 @opindex bundle_loader
17419 This option specifies the @var{executable} that will load the build
17420 output file being linked.  See man ld(1) for more information.
17422 @item -dynamiclib
17423 @opindex dynamiclib
17424 When passed this option, GCC produces a dynamic library instead of
17425 an executable when linking, using the Darwin @file{libtool} command.
17427 @item -force_cpusubtype_ALL
17428 @opindex force_cpusubtype_ALL
17429 This causes GCC's output file to have the @samp{ALL} subtype, instead of
17430 one controlled by the @option{-mcpu} or @option{-march} option.
17432 @item -allowable_client  @var{client_name}
17433 @itemx -client_name
17434 @itemx -compatibility_version
17435 @itemx -current_version
17436 @itemx -dead_strip
17437 @itemx -dependency-file
17438 @itemx -dylib_file
17439 @itemx -dylinker_install_name
17440 @itemx -dynamic
17441 @itemx -exported_symbols_list
17442 @itemx -filelist
17443 @need 800
17444 @itemx -flat_namespace
17445 @itemx -force_flat_namespace
17446 @itemx -headerpad_max_install_names
17447 @itemx -image_base
17448 @itemx -init
17449 @itemx -install_name
17450 @itemx -keep_private_externs
17451 @itemx -multi_module
17452 @itemx -multiply_defined
17453 @itemx -multiply_defined_unused
17454 @need 800
17455 @itemx -noall_load
17456 @itemx -no_dead_strip_inits_and_terms
17457 @itemx -nofixprebinding
17458 @itemx -nomultidefs
17459 @itemx -noprebind
17460 @itemx -noseglinkedit
17461 @itemx -pagezero_size
17462 @itemx -prebind
17463 @itemx -prebind_all_twolevel_modules
17464 @itemx -private_bundle
17465 @need 800
17466 @itemx -read_only_relocs
17467 @itemx -sectalign
17468 @itemx -sectobjectsymbols
17469 @itemx -whyload
17470 @itemx -seg1addr
17471 @itemx -sectcreate
17472 @itemx -sectobjectsymbols
17473 @itemx -sectorder
17474 @itemx -segaddr
17475 @itemx -segs_read_only_addr
17476 @need 800
17477 @itemx -segs_read_write_addr
17478 @itemx -seg_addr_table
17479 @itemx -seg_addr_table_filename
17480 @itemx -seglinkedit
17481 @itemx -segprot
17482 @itemx -segs_read_only_addr
17483 @itemx -segs_read_write_addr
17484 @itemx -single_module
17485 @itemx -static
17486 @itemx -sub_library
17487 @need 800
17488 @itemx -sub_umbrella
17489 @itemx -twolevel_namespace
17490 @itemx -umbrella
17491 @itemx -undefined
17492 @itemx -unexported_symbols_list
17493 @itemx -weak_reference_mismatches
17494 @itemx -whatsloaded
17495 @opindex allowable_client
17496 @opindex client_name
17497 @opindex compatibility_version
17498 @opindex current_version
17499 @opindex dead_strip
17500 @opindex dependency-file
17501 @opindex dylib_file
17502 @opindex dylinker_install_name
17503 @opindex dynamic
17504 @opindex exported_symbols_list
17505 @opindex filelist
17506 @opindex flat_namespace
17507 @opindex force_flat_namespace
17508 @opindex headerpad_max_install_names
17509 @opindex image_base
17510 @opindex init
17511 @opindex install_name
17512 @opindex keep_private_externs
17513 @opindex multi_module
17514 @opindex multiply_defined
17515 @opindex multiply_defined_unused
17516 @opindex noall_load
17517 @opindex no_dead_strip_inits_and_terms
17518 @opindex nofixprebinding
17519 @opindex nomultidefs
17520 @opindex noprebind
17521 @opindex noseglinkedit
17522 @opindex pagezero_size
17523 @opindex prebind
17524 @opindex prebind_all_twolevel_modules
17525 @opindex private_bundle
17526 @opindex read_only_relocs
17527 @opindex sectalign
17528 @opindex sectobjectsymbols
17529 @opindex whyload
17530 @opindex seg1addr
17531 @opindex sectcreate
17532 @opindex sectobjectsymbols
17533 @opindex sectorder
17534 @opindex segaddr
17535 @opindex segs_read_only_addr
17536 @opindex segs_read_write_addr
17537 @opindex seg_addr_table
17538 @opindex seg_addr_table_filename
17539 @opindex seglinkedit
17540 @opindex segprot
17541 @opindex segs_read_only_addr
17542 @opindex segs_read_write_addr
17543 @opindex single_module
17544 @opindex static
17545 @opindex sub_library
17546 @opindex sub_umbrella
17547 @opindex twolevel_namespace
17548 @opindex umbrella
17549 @opindex undefined
17550 @opindex unexported_symbols_list
17551 @opindex weak_reference_mismatches
17552 @opindex whatsloaded
17553 These options are passed to the Darwin linker.  The Darwin linker man page
17554 describes them in detail.
17555 @end table
17557 @node DEC Alpha Options
17558 @subsection DEC Alpha Options
17560 These @samp{-m} options are defined for the DEC Alpha implementations:
17562 @table @gcctabopt
17563 @item -mno-soft-float
17564 @itemx -msoft-float
17565 @opindex mno-soft-float
17566 @opindex msoft-float
17567 Use (do not use) the hardware floating-point instructions for
17568 floating-point operations.  When @option{-msoft-float} is specified,
17569 functions in @file{libgcc.a} are used to perform floating-point
17570 operations.  Unless they are replaced by routines that emulate the
17571 floating-point operations, or compiled in such a way as to call such
17572 emulations routines, these routines issue floating-point
17573 operations.   If you are compiling for an Alpha without floating-point
17574 operations, you must ensure that the library is built so as not to call
17575 them.
17577 Note that Alpha implementations without floating-point operations are
17578 required to have floating-point registers.
17580 @item -mfp-reg
17581 @itemx -mno-fp-regs
17582 @opindex mfp-reg
17583 @opindex mno-fp-regs
17584 Generate code that uses (does not use) the floating-point register set.
17585 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
17586 register set is not used, floating-point operands are passed in integer
17587 registers as if they were integers and floating-point results are passed
17588 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
17589 so any function with a floating-point argument or return value called by code
17590 compiled with @option{-mno-fp-regs} must also be compiled with that
17591 option.
17593 A typical use of this option is building a kernel that does not use,
17594 and hence need not save and restore, any floating-point registers.
17596 @item -mieee
17597 @opindex mieee
17598 The Alpha architecture implements floating-point hardware optimized for
17599 maximum performance.  It is mostly compliant with the IEEE floating-point
17600 standard.  However, for full compliance, software assistance is
17601 required.  This option generates code fully IEEE-compliant code
17602 @emph{except} that the @var{inexact-flag} is not maintained (see below).
17603 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
17604 defined during compilation.  The resulting code is less efficient but is
17605 able to correctly support denormalized numbers and exceptional IEEE
17606 values such as not-a-number and plus/minus infinity.  Other Alpha
17607 compilers call this option @option{-ieee_with_no_inexact}.
17609 @item -mieee-with-inexact
17610 @opindex mieee-with-inexact
17611 This is like @option{-mieee} except the generated code also maintains
17612 the IEEE @var{inexact-flag}.  Turning on this option causes the
17613 generated code to implement fully-compliant IEEE math.  In addition to
17614 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
17615 macro.  On some Alpha implementations the resulting code may execute
17616 significantly slower than the code generated by default.  Since there is
17617 very little code that depends on the @var{inexact-flag}, you should
17618 normally not specify this option.  Other Alpha compilers call this
17619 option @option{-ieee_with_inexact}.
17621 @item -mfp-trap-mode=@var{trap-mode}
17622 @opindex mfp-trap-mode
17623 This option controls what floating-point related traps are enabled.
17624 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
17625 The trap mode can be set to one of four values:
17627 @table @samp
17628 @item n
17629 This is the default (normal) setting.  The only traps that are enabled
17630 are the ones that cannot be disabled in software (e.g., division by zero
17631 trap).
17633 @item u
17634 In addition to the traps enabled by @samp{n}, underflow traps are enabled
17635 as well.
17637 @item su
17638 Like @samp{u}, but the instructions are marked to be safe for software
17639 completion (see Alpha architecture manual for details).
17641 @item sui
17642 Like @samp{su}, but inexact traps are enabled as well.
17643 @end table
17645 @item -mfp-rounding-mode=@var{rounding-mode}
17646 @opindex mfp-rounding-mode
17647 Selects the IEEE rounding mode.  Other Alpha compilers call this option
17648 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
17651 @table @samp
17652 @item n
17653 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
17654 the nearest machine number or towards the even machine number in case
17655 of a tie.
17657 @item m
17658 Round towards minus infinity.
17660 @item c
17661 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
17663 @item d
17664 Dynamic rounding mode.  A field in the floating-point control register
17665 (@var{fpcr}, see Alpha architecture reference manual) controls the
17666 rounding mode in effect.  The C library initializes this register for
17667 rounding towards plus infinity.  Thus, unless your program modifies the
17668 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
17669 @end table
17671 @item -mtrap-precision=@var{trap-precision}
17672 @opindex mtrap-precision
17673 In the Alpha architecture, floating-point traps are imprecise.  This
17674 means without software assistance it is impossible to recover from a
17675 floating trap and program execution normally needs to be terminated.
17676 GCC can generate code that can assist operating system trap handlers
17677 in determining the exact location that caused a floating-point trap.
17678 Depending on the requirements of an application, different levels of
17679 precisions can be selected:
17681 @table @samp
17682 @item p
17683 Program precision.  This option is the default and means a trap handler
17684 can only identify which program caused a floating-point exception.
17686 @item f
17687 Function precision.  The trap handler can determine the function that
17688 caused a floating-point exception.
17690 @item i
17691 Instruction precision.  The trap handler can determine the exact
17692 instruction that caused a floating-point exception.
17693 @end table
17695 Other Alpha compilers provide the equivalent options called
17696 @option{-scope_safe} and @option{-resumption_safe}.
17698 @item -mieee-conformant
17699 @opindex mieee-conformant
17700 This option marks the generated code as IEEE conformant.  You must not
17701 use this option unless you also specify @option{-mtrap-precision=i} and either
17702 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
17703 is to emit the line @samp{.eflag 48} in the function prologue of the
17704 generated assembly file.
17706 @item -mbuild-constants
17707 @opindex mbuild-constants
17708 Normally GCC examines a 32- or 64-bit integer constant to
17709 see if it can construct it from smaller constants in two or three
17710 instructions.  If it cannot, it outputs the constant as a literal and
17711 generates code to load it from the data segment at run time.
17713 Use this option to require GCC to construct @emph{all} integer constants
17714 using code, even if it takes more instructions (the maximum is six).
17716 You typically use this option to build a shared library dynamic
17717 loader.  Itself a shared library, it must relocate itself in memory
17718 before it can find the variables and constants in its own data segment.
17720 @item -mbwx
17721 @itemx -mno-bwx
17722 @itemx -mcix
17723 @itemx -mno-cix
17724 @itemx -mfix
17725 @itemx -mno-fix
17726 @itemx -mmax
17727 @itemx -mno-max
17728 @opindex mbwx
17729 @opindex mno-bwx
17730 @opindex mcix
17731 @opindex mno-cix
17732 @opindex mfix
17733 @opindex mno-fix
17734 @opindex mmax
17735 @opindex mno-max
17736 Indicate whether GCC should generate code to use the optional BWX,
17737 CIX, FIX and MAX instruction sets.  The default is to use the instruction
17738 sets supported by the CPU type specified via @option{-mcpu=} option or that
17739 of the CPU on which GCC was built if none is specified.
17741 @item -mfloat-vax
17742 @itemx -mfloat-ieee
17743 @opindex mfloat-vax
17744 @opindex mfloat-ieee
17745 Generate code that uses (does not use) VAX F and G floating-point
17746 arithmetic instead of IEEE single and double precision.
17748 @item -mexplicit-relocs
17749 @itemx -mno-explicit-relocs
17750 @opindex mexplicit-relocs
17751 @opindex mno-explicit-relocs
17752 Older Alpha assemblers provided no way to generate symbol relocations
17753 except via assembler macros.  Use of these macros does not allow
17754 optimal instruction scheduling.  GNU binutils as of version 2.12
17755 supports a new syntax that allows the compiler to explicitly mark
17756 which relocations should apply to which instructions.  This option
17757 is mostly useful for debugging, as GCC detects the capabilities of
17758 the assembler when it is built and sets the default accordingly.
17760 @item -msmall-data
17761 @itemx -mlarge-data
17762 @opindex msmall-data
17763 @opindex mlarge-data
17764 When @option{-mexplicit-relocs} is in effect, static data is
17765 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
17766 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
17767 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
17768 16-bit relocations off of the @code{$gp} register.  This limits the
17769 size of the small data area to 64KB, but allows the variables to be
17770 directly accessed via a single instruction.
17772 The default is @option{-mlarge-data}.  With this option the data area
17773 is limited to just below 2GB@.  Programs that require more than 2GB of
17774 data must use @code{malloc} or @code{mmap} to allocate the data in the
17775 heap instead of in the program's data segment.
17777 When generating code for shared libraries, @option{-fpic} implies
17778 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
17780 @item -msmall-text
17781 @itemx -mlarge-text
17782 @opindex msmall-text
17783 @opindex mlarge-text
17784 When @option{-msmall-text} is used, the compiler assumes that the
17785 code of the entire program (or shared library) fits in 4MB, and is
17786 thus reachable with a branch instruction.  When @option{-msmall-data}
17787 is used, the compiler can assume that all local symbols share the
17788 same @code{$gp} value, and thus reduce the number of instructions
17789 required for a function call from 4 to 1.
17791 The default is @option{-mlarge-text}.
17793 @item -mcpu=@var{cpu_type}
17794 @opindex mcpu
17795 Set the instruction set and instruction scheduling parameters for
17796 machine type @var{cpu_type}.  You can specify either the @samp{EV}
17797 style name or the corresponding chip number.  GCC supports scheduling
17798 parameters for the EV4, EV5 and EV6 family of processors and
17799 chooses the default values for the instruction set from the processor
17800 you specify.  If you do not specify a processor type, GCC defaults
17801 to the processor on which the compiler was built.
17803 Supported values for @var{cpu_type} are
17805 @table @samp
17806 @item ev4
17807 @itemx ev45
17808 @itemx 21064
17809 Schedules as an EV4 and has no instruction set extensions.
17811 @item ev5
17812 @itemx 21164
17813 Schedules as an EV5 and has no instruction set extensions.
17815 @item ev56
17816 @itemx 21164a
17817 Schedules as an EV5 and supports the BWX extension.
17819 @item pca56
17820 @itemx 21164pc
17821 @itemx 21164PC
17822 Schedules as an EV5 and supports the BWX and MAX extensions.
17824 @item ev6
17825 @itemx 21264
17826 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
17828 @item ev67
17829 @itemx 21264a
17830 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
17831 @end table
17833 Native toolchains also support the value @samp{native},
17834 which selects the best architecture option for the host processor.
17835 @option{-mcpu=native} has no effect if GCC does not recognize
17836 the processor.
17838 @item -mtune=@var{cpu_type}
17839 @opindex mtune
17840 Set only the instruction scheduling parameters for machine type
17841 @var{cpu_type}.  The instruction set is not changed.
17843 Native toolchains also support the value @samp{native},
17844 which selects the best architecture option for the host processor.
17845 @option{-mtune=native} has no effect if GCC does not recognize
17846 the processor.
17848 @item -mmemory-latency=@var{time}
17849 @opindex mmemory-latency
17850 Sets the latency the scheduler should assume for typical memory
17851 references as seen by the application.  This number is highly
17852 dependent on the memory access patterns used by the application
17853 and the size of the external cache on the machine.
17855 Valid options for @var{time} are
17857 @table @samp
17858 @item @var{number}
17859 A decimal number representing clock cycles.
17861 @item L1
17862 @itemx L2
17863 @itemx L3
17864 @itemx main
17865 The compiler contains estimates of the number of clock cycles for
17866 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
17867 (also called Dcache, Scache, and Bcache), as well as to main memory.
17868 Note that L3 is only valid for EV5.
17870 @end table
17871 @end table
17873 @node FR30 Options
17874 @subsection FR30 Options
17875 @cindex FR30 Options
17877 These options are defined specifically for the FR30 port.
17879 @table @gcctabopt
17881 @item -msmall-model
17882 @opindex msmall-model
17883 Use the small address space model.  This can produce smaller code, but
17884 it does assume that all symbolic values and addresses fit into a
17885 20-bit range.
17887 @item -mno-lsim
17888 @opindex mno-lsim
17889 Assume that runtime support has been provided and so there is no need
17890 to include the simulator library (@file{libsim.a}) on the linker
17891 command line.
17893 @end table
17895 @node FT32 Options
17896 @subsection FT32 Options
17897 @cindex FT32 Options
17899 These options are defined specifically for the FT32 port.
17901 @table @gcctabopt
17903 @item -msim
17904 @opindex msim
17905 Specifies that the program will be run on the simulator.  This causes
17906 an alternate runtime startup and library to be linked.
17907 You must not use this option when generating programs that will run on
17908 real hardware; you must provide your own runtime library for whatever
17909 I/O functions are needed.
17911 @item -mlra
17912 @opindex mlra
17913 Enable Local Register Allocation.  This is still experimental for FT32,
17914 so by default the compiler uses standard reload.
17916 @item -mnodiv
17917 @opindex mnodiv
17918 Do not use div and mod instructions.
17920 @item -mft32b
17921 @opindex mft32b
17922 Enable use of the extended instructions of the FT32B processor.
17924 @item -mcompress
17925 @opindex mcompress
17926 Compress all code using the Ft32B code compression scheme.
17928 @item -mnopm
17929 @opindex  mnopm
17930 Do not generate code that reads program memory.
17932 @end table
17934 @node FRV Options
17935 @subsection FRV Options
17936 @cindex FRV Options
17938 @table @gcctabopt
17939 @item -mgpr-32
17940 @opindex mgpr-32
17942 Only use the first 32 general-purpose registers.
17944 @item -mgpr-64
17945 @opindex mgpr-64
17947 Use all 64 general-purpose registers.
17949 @item -mfpr-32
17950 @opindex mfpr-32
17952 Use only the first 32 floating-point registers.
17954 @item -mfpr-64
17955 @opindex mfpr-64
17957 Use all 64 floating-point registers.
17959 @item -mhard-float
17960 @opindex mhard-float
17962 Use hardware instructions for floating-point operations.
17964 @item -msoft-float
17965 @opindex msoft-float
17967 Use library routines for floating-point operations.
17969 @item -malloc-cc
17970 @opindex malloc-cc
17972 Dynamically allocate condition code registers.
17974 @item -mfixed-cc
17975 @opindex mfixed-cc
17977 Do not try to dynamically allocate condition code registers, only
17978 use @code{icc0} and @code{fcc0}.
17980 @item -mdword
17981 @opindex mdword
17983 Change ABI to use double word insns.
17985 @item -mno-dword
17986 @opindex mno-dword
17988 Do not use double word instructions.
17990 @item -mdouble
17991 @opindex mdouble
17993 Use floating-point double instructions.
17995 @item -mno-double
17996 @opindex mno-double
17998 Do not use floating-point double instructions.
18000 @item -mmedia
18001 @opindex mmedia
18003 Use media instructions.
18005 @item -mno-media
18006 @opindex mno-media
18008 Do not use media instructions.
18010 @item -mmuladd
18011 @opindex mmuladd
18013 Use multiply and add/subtract instructions.
18015 @item -mno-muladd
18016 @opindex mno-muladd
18018 Do not use multiply and add/subtract instructions.
18020 @item -mfdpic
18021 @opindex mfdpic
18023 Select the FDPIC ABI, which uses function descriptors to represent
18024 pointers to functions.  Without any PIC/PIE-related options, it
18025 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
18026 assumes GOT entries and small data are within a 12-bit range from the
18027 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
18028 are computed with 32 bits.
18029 With a @samp{bfin-elf} target, this option implies @option{-msim}.
18031 @item -minline-plt
18032 @opindex minline-plt
18034 Enable inlining of PLT entries in function calls to functions that are
18035 not known to bind locally.  It has no effect without @option{-mfdpic}.
18036 It's enabled by default if optimizing for speed and compiling for
18037 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
18038 optimization option such as @option{-O3} or above is present in the
18039 command line.
18041 @item -mTLS
18042 @opindex mTLS
18044 Assume a large TLS segment when generating thread-local code.
18046 @item -mtls
18047 @opindex mtls
18049 Do not assume a large TLS segment when generating thread-local code.
18051 @item -mgprel-ro
18052 @opindex mgprel-ro
18054 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
18055 that is known to be in read-only sections.  It's enabled by default,
18056 except for @option{-fpic} or @option{-fpie}: even though it may help
18057 make the global offset table smaller, it trades 1 instruction for 4.
18058 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
18059 one of which may be shared by multiple symbols, and it avoids the need
18060 for a GOT entry for the referenced symbol, so it's more likely to be a
18061 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
18063 @item -multilib-library-pic
18064 @opindex multilib-library-pic
18066 Link with the (library, not FD) pic libraries.  It's implied by
18067 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
18068 @option{-fpic} without @option{-mfdpic}.  You should never have to use
18069 it explicitly.
18071 @item -mlinked-fp
18072 @opindex mlinked-fp
18074 Follow the EABI requirement of always creating a frame pointer whenever
18075 a stack frame is allocated.  This option is enabled by default and can
18076 be disabled with @option{-mno-linked-fp}.
18078 @item -mlong-calls
18079 @opindex mlong-calls
18081 Use indirect addressing to call functions outside the current
18082 compilation unit.  This allows the functions to be placed anywhere
18083 within the 32-bit address space.
18085 @item -malign-labels
18086 @opindex malign-labels
18088 Try to align labels to an 8-byte boundary by inserting NOPs into the
18089 previous packet.  This option only has an effect when VLIW packing
18090 is enabled.  It doesn't create new packets; it merely adds NOPs to
18091 existing ones.
18093 @item -mlibrary-pic
18094 @opindex mlibrary-pic
18096 Generate position-independent EABI code.
18098 @item -macc-4
18099 @opindex macc-4
18101 Use only the first four media accumulator registers.
18103 @item -macc-8
18104 @opindex macc-8
18106 Use all eight media accumulator registers.
18108 @item -mpack
18109 @opindex mpack
18111 Pack VLIW instructions.
18113 @item -mno-pack
18114 @opindex mno-pack
18116 Do not pack VLIW instructions.
18118 @item -mno-eflags
18119 @opindex mno-eflags
18121 Do not mark ABI switches in e_flags.
18123 @item -mcond-move
18124 @opindex mcond-move
18126 Enable the use of conditional-move instructions (default).
18128 This switch is mainly for debugging the compiler and will likely be removed
18129 in a future version.
18131 @item -mno-cond-move
18132 @opindex mno-cond-move
18134 Disable the use of conditional-move instructions.
18136 This switch is mainly for debugging the compiler and will likely be removed
18137 in a future version.
18139 @item -mscc
18140 @opindex mscc
18142 Enable the use of conditional set instructions (default).
18144 This switch is mainly for debugging the compiler and will likely be removed
18145 in a future version.
18147 @item -mno-scc
18148 @opindex mno-scc
18150 Disable the use of conditional set instructions.
18152 This switch is mainly for debugging the compiler and will likely be removed
18153 in a future version.
18155 @item -mcond-exec
18156 @opindex mcond-exec
18158 Enable the use of conditional execution (default).
18160 This switch is mainly for debugging the compiler and will likely be removed
18161 in a future version.
18163 @item -mno-cond-exec
18164 @opindex mno-cond-exec
18166 Disable the use of conditional execution.
18168 This switch is mainly for debugging the compiler and will likely be removed
18169 in a future version.
18171 @item -mvliw-branch
18172 @opindex mvliw-branch
18174 Run a pass to pack branches into VLIW instructions (default).
18176 This switch is mainly for debugging the compiler and will likely be removed
18177 in a future version.
18179 @item -mno-vliw-branch
18180 @opindex mno-vliw-branch
18182 Do not run a pass to pack branches into VLIW instructions.
18184 This switch is mainly for debugging the compiler and will likely be removed
18185 in a future version.
18187 @item -mmulti-cond-exec
18188 @opindex mmulti-cond-exec
18190 Enable optimization of @code{&&} and @code{||} in conditional execution
18191 (default).
18193 This switch is mainly for debugging the compiler and will likely be removed
18194 in a future version.
18196 @item -mno-multi-cond-exec
18197 @opindex mno-multi-cond-exec
18199 Disable optimization of @code{&&} and @code{||} in conditional execution.
18201 This switch is mainly for debugging the compiler and will likely be removed
18202 in a future version.
18204 @item -mnested-cond-exec
18205 @opindex mnested-cond-exec
18207 Enable nested conditional execution optimizations (default).
18209 This switch is mainly for debugging the compiler and will likely be removed
18210 in a future version.
18212 @item -mno-nested-cond-exec
18213 @opindex mno-nested-cond-exec
18215 Disable nested conditional execution optimizations.
18217 This switch is mainly for debugging the compiler and will likely be removed
18218 in a future version.
18220 @item -moptimize-membar
18221 @opindex moptimize-membar
18223 This switch removes redundant @code{membar} instructions from the
18224 compiler-generated code.  It is enabled by default.
18226 @item -mno-optimize-membar
18227 @opindex mno-optimize-membar
18229 This switch disables the automatic removal of redundant @code{membar}
18230 instructions from the generated code.
18232 @item -mtomcat-stats
18233 @opindex mtomcat-stats
18235 Cause gas to print out tomcat statistics.
18237 @item -mcpu=@var{cpu}
18238 @opindex mcpu
18240 Select the processor type for which to generate code.  Possible values are
18241 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
18242 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
18244 @end table
18246 @node GNU/Linux Options
18247 @subsection GNU/Linux Options
18249 These @samp{-m} options are defined for GNU/Linux targets:
18251 @table @gcctabopt
18252 @item -mglibc
18253 @opindex mglibc
18254 Use the GNU C library.  This is the default except
18255 on @samp{*-*-linux-*uclibc*}, @samp{*-*-linux-*musl*} and
18256 @samp{*-*-linux-*android*} targets.
18258 @item -muclibc
18259 @opindex muclibc
18260 Use uClibc C library.  This is the default on
18261 @samp{*-*-linux-*uclibc*} targets.
18263 @item -mmusl
18264 @opindex mmusl
18265 Use the musl C library.  This is the default on
18266 @samp{*-*-linux-*musl*} targets.
18268 @item -mbionic
18269 @opindex mbionic
18270 Use Bionic C library.  This is the default on
18271 @samp{*-*-linux-*android*} targets.
18273 @item -mandroid
18274 @opindex mandroid
18275 Compile code compatible with Android platform.  This is the default on
18276 @samp{*-*-linux-*android*} targets.
18278 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
18279 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
18280 this option makes the GCC driver pass Android-specific options to the linker.
18281 Finally, this option causes the preprocessor macro @code{__ANDROID__}
18282 to be defined.
18284 @item -tno-android-cc
18285 @opindex tno-android-cc
18286 Disable compilation effects of @option{-mandroid}, i.e., do not enable
18287 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
18288 @option{-fno-rtti} by default.
18290 @item -tno-android-ld
18291 @opindex tno-android-ld
18292 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
18293 linking options to the linker.
18295 @end table
18297 @node H8/300 Options
18298 @subsection H8/300 Options
18300 These @samp{-m} options are defined for the H8/300 implementations:
18302 @table @gcctabopt
18303 @item -mrelax
18304 @opindex mrelax
18305 Shorten some address references at link time, when possible; uses the
18306 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
18307 ld, Using ld}, for a fuller description.
18309 @item -mh
18310 @opindex mh
18311 Generate code for the H8/300H@.
18313 @item -ms
18314 @opindex ms
18315 Generate code for the H8S@.
18317 @item -mn
18318 @opindex mn
18319 Generate code for the H8S and H8/300H in the normal mode.  This switch
18320 must be used either with @option{-mh} or @option{-ms}.
18322 @item -ms2600
18323 @opindex ms2600
18324 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
18326 @item -mexr
18327 @opindex mexr
18328 Extended registers are stored on stack before execution of function
18329 with monitor attribute. Default option is @option{-mexr}.
18330 This option is valid only for H8S targets.
18332 @item -mno-exr
18333 @opindex mno-exr
18334 Extended registers are not stored on stack before execution of function 
18335 with monitor attribute. Default option is @option{-mno-exr}. 
18336 This option is valid only for H8S targets.
18338 @item -mint32
18339 @opindex mint32
18340 Make @code{int} data 32 bits by default.
18342 @item -malign-300
18343 @opindex malign-300
18344 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
18345 The default for the H8/300H and H8S is to align longs and floats on
18346 4-byte boundaries.
18347 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
18348 This option has no effect on the H8/300.
18349 @end table
18351 @node HPPA Options
18352 @subsection HPPA Options
18353 @cindex HPPA Options
18355 These @samp{-m} options are defined for the HPPA family of computers:
18357 @table @gcctabopt
18358 @item -march=@var{architecture-type}
18359 @opindex march
18360 Generate code for the specified architecture.  The choices for
18361 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
18362 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
18363 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
18364 architecture option for your machine.  Code compiled for lower numbered
18365 architectures runs on higher numbered architectures, but not the
18366 other way around.
18368 @item -mpa-risc-1-0
18369 @itemx -mpa-risc-1-1
18370 @itemx -mpa-risc-2-0
18371 @opindex mpa-risc-1-0
18372 @opindex mpa-risc-1-1
18373 @opindex mpa-risc-2-0
18374 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
18376 @item -mcaller-copies
18377 @opindex mcaller-copies
18378 The caller copies function arguments passed by hidden reference.  This
18379 option should be used with care as it is not compatible with the default
18380 32-bit runtime.  However, only aggregates larger than eight bytes are
18381 passed by hidden reference and the option provides better compatibility
18382 with OpenMP.
18384 @item -mjump-in-delay
18385 @opindex mjump-in-delay
18386 This option is ignored and provided for compatibility purposes only.
18388 @item -mdisable-fpregs
18389 @opindex mdisable-fpregs
18390 Prevent floating-point registers from being used in any manner.  This is
18391 necessary for compiling kernels that perform lazy context switching of
18392 floating-point registers.  If you use this option and attempt to perform
18393 floating-point operations, the compiler aborts.
18395 @item -mdisable-indexing
18396 @opindex mdisable-indexing
18397 Prevent the compiler from using indexing address modes.  This avoids some
18398 rather obscure problems when compiling MIG generated code under MACH@.
18400 @item -mno-space-regs
18401 @opindex mno-space-regs
18402 Generate code that assumes the target has no space registers.  This allows
18403 GCC to generate faster indirect calls and use unscaled index address modes.
18405 Such code is suitable for level 0 PA systems and kernels.
18407 @item -mfast-indirect-calls
18408 @opindex mfast-indirect-calls
18409 Generate code that assumes calls never cross space boundaries.  This
18410 allows GCC to emit code that performs faster indirect calls.
18412 This option does not work in the presence of shared libraries or nested
18413 functions.
18415 @item -mfixed-range=@var{register-range}
18416 @opindex mfixed-range
18417 Generate code treating the given register range as fixed registers.
18418 A fixed register is one that the register allocator cannot use.  This is
18419 useful when compiling kernel code.  A register range is specified as
18420 two registers separated by a dash.  Multiple register ranges can be
18421 specified separated by a comma.
18423 @item -mlong-load-store
18424 @opindex mlong-load-store
18425 Generate 3-instruction load and store sequences as sometimes required by
18426 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
18427 the HP compilers.
18429 @item -mportable-runtime
18430 @opindex mportable-runtime
18431 Use the portable calling conventions proposed by HP for ELF systems.
18433 @item -mgas
18434 @opindex mgas
18435 Enable the use of assembler directives only GAS understands.
18437 @item -mschedule=@var{cpu-type}
18438 @opindex mschedule
18439 Schedule code according to the constraints for the machine type
18440 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
18441 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
18442 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
18443 proper scheduling option for your machine.  The default scheduling is
18444 @samp{8000}.
18446 @item -mlinker-opt
18447 @opindex mlinker-opt
18448 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
18449 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
18450 linkers in which they give bogus error messages when linking some programs.
18452 @item -msoft-float
18453 @opindex msoft-float
18454 Generate output containing library calls for floating point.
18455 @strong{Warning:} the requisite libraries are not available for all HPPA
18456 targets.  Normally the facilities of the machine's usual C compiler are
18457 used, but this cannot be done directly in cross-compilation.  You must make
18458 your own arrangements to provide suitable library functions for
18459 cross-compilation.
18461 @option{-msoft-float} changes the calling convention in the output file;
18462 therefore, it is only useful if you compile @emph{all} of a program with
18463 this option.  In particular, you need to compile @file{libgcc.a}, the
18464 library that comes with GCC, with @option{-msoft-float} in order for
18465 this to work.
18467 @item -msio
18468 @opindex msio
18469 Generate the predefine, @code{_SIO}, for server IO@.  The default is
18470 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
18471 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
18472 options are available under HP-UX and HI-UX@.
18474 @item -mgnu-ld
18475 @opindex mgnu-ld
18476 Use options specific to GNU @command{ld}.
18477 This passes @option{-shared} to @command{ld} when
18478 building a shared library.  It is the default when GCC is configured,
18479 explicitly or implicitly, with the GNU linker.  This option does not
18480 affect which @command{ld} is called; it only changes what parameters
18481 are passed to that @command{ld}.
18482 The @command{ld} that is called is determined by the
18483 @option{--with-ld} configure option, GCC's program search path, and
18484 finally by the user's @env{PATH}.  The linker used by GCC can be printed
18485 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
18486 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
18488 @item -mhp-ld
18489 @opindex mhp-ld
18490 Use options specific to HP @command{ld}.
18491 This passes @option{-b} to @command{ld} when building
18492 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
18493 links.  It is the default when GCC is configured, explicitly or
18494 implicitly, with the HP linker.  This option does not affect
18495 which @command{ld} is called; it only changes what parameters are passed to that
18496 @command{ld}.
18497 The @command{ld} that is called is determined by the @option{--with-ld}
18498 configure option, GCC's program search path, and finally by the user's
18499 @env{PATH}.  The linker used by GCC can be printed using @samp{which
18500 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
18501 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
18503 @item -mlong-calls
18504 @opindex mno-long-calls
18505 Generate code that uses long call sequences.  This ensures that a call
18506 is always able to reach linker generated stubs.  The default is to generate
18507 long calls only when the distance from the call site to the beginning
18508 of the function or translation unit, as the case may be, exceeds a
18509 predefined limit set by the branch type being used.  The limits for
18510 normal calls are 7,600,000 and 240,000 bytes, respectively for the
18511 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
18512 240,000 bytes.
18514 Distances are measured from the beginning of functions when using the
18515 @option{-ffunction-sections} option, or when using the @option{-mgas}
18516 and @option{-mno-portable-runtime} options together under HP-UX with
18517 the SOM linker.
18519 It is normally not desirable to use this option as it degrades
18520 performance.  However, it may be useful in large applications,
18521 particularly when partial linking is used to build the application.
18523 The types of long calls used depends on the capabilities of the
18524 assembler and linker, and the type of code being generated.  The
18525 impact on systems that support long absolute calls, and long pic
18526 symbol-difference or pc-relative calls should be relatively small.
18527 However, an indirect call is used on 32-bit ELF systems in pic code
18528 and it is quite long.
18530 @item -munix=@var{unix-std}
18531 @opindex march
18532 Generate compiler predefines and select a startfile for the specified
18533 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
18534 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
18535 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
18536 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
18537 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
18538 and later.
18540 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
18541 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
18542 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
18543 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
18544 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
18545 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
18547 It is @emph{important} to note that this option changes the interfaces
18548 for various library routines.  It also affects the operational behavior
18549 of the C library.  Thus, @emph{extreme} care is needed in using this
18550 option.
18552 Library code that is intended to operate with more than one UNIX
18553 standard must test, set and restore the variable @code{__xpg4_extended_mask}
18554 as appropriate.  Most GNU software doesn't provide this capability.
18556 @item -nolibdld
18557 @opindex nolibdld
18558 Suppress the generation of link options to search libdld.sl when the
18559 @option{-static} option is specified on HP-UX 10 and later.
18561 @item -static
18562 @opindex static
18563 The HP-UX implementation of setlocale in libc has a dependency on
18564 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
18565 when the @option{-static} option is specified, special link options
18566 are needed to resolve this dependency.
18568 On HP-UX 10 and later, the GCC driver adds the necessary options to
18569 link with libdld.sl when the @option{-static} option is specified.
18570 This causes the resulting binary to be dynamic.  On the 64-bit port,
18571 the linkers generate dynamic binaries by default in any case.  The
18572 @option{-nolibdld} option can be used to prevent the GCC driver from
18573 adding these link options.
18575 @item -threads
18576 @opindex threads
18577 Add support for multithreading with the @dfn{dce thread} library
18578 under HP-UX@.  This option sets flags for both the preprocessor and
18579 linker.
18580 @end table
18582 @node IA-64 Options
18583 @subsection IA-64 Options
18584 @cindex IA-64 Options
18586 These are the @samp{-m} options defined for the Intel IA-64 architecture.
18588 @table @gcctabopt
18589 @item -mbig-endian
18590 @opindex mbig-endian
18591 Generate code for a big-endian target.  This is the default for HP-UX@.
18593 @item -mlittle-endian
18594 @opindex mlittle-endian
18595 Generate code for a little-endian target.  This is the default for AIX5
18596 and GNU/Linux.
18598 @item -mgnu-as
18599 @itemx -mno-gnu-as
18600 @opindex mgnu-as
18601 @opindex mno-gnu-as
18602 Generate (or don't) code for the GNU assembler.  This is the default.
18603 @c Also, this is the default if the configure option @option{--with-gnu-as}
18604 @c is used.
18606 @item -mgnu-ld
18607 @itemx -mno-gnu-ld
18608 @opindex mgnu-ld
18609 @opindex mno-gnu-ld
18610 Generate (or don't) code for the GNU linker.  This is the default.
18611 @c Also, this is the default if the configure option @option{--with-gnu-ld}
18612 @c is used.
18614 @item -mno-pic
18615 @opindex mno-pic
18616 Generate code that does not use a global pointer register.  The result
18617 is not position independent code, and violates the IA-64 ABI@.
18619 @item -mvolatile-asm-stop
18620 @itemx -mno-volatile-asm-stop
18621 @opindex mvolatile-asm-stop
18622 @opindex mno-volatile-asm-stop
18623 Generate (or don't) a stop bit immediately before and after volatile asm
18624 statements.
18626 @item -mregister-names
18627 @itemx -mno-register-names
18628 @opindex mregister-names
18629 @opindex mno-register-names
18630 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
18631 the stacked registers.  This may make assembler output more readable.
18633 @item -mno-sdata
18634 @itemx -msdata
18635 @opindex mno-sdata
18636 @opindex msdata
18637 Disable (or enable) optimizations that use the small data section.  This may
18638 be useful for working around optimizer bugs.
18640 @item -mconstant-gp
18641 @opindex mconstant-gp
18642 Generate code that uses a single constant global pointer value.  This is
18643 useful when compiling kernel code.
18645 @item -mauto-pic
18646 @opindex mauto-pic
18647 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
18648 This is useful when compiling firmware code.
18650 @item -minline-float-divide-min-latency
18651 @opindex minline-float-divide-min-latency
18652 Generate code for inline divides of floating-point values
18653 using the minimum latency algorithm.
18655 @item -minline-float-divide-max-throughput
18656 @opindex minline-float-divide-max-throughput
18657 Generate code for inline divides of floating-point values
18658 using the maximum throughput algorithm.
18660 @item -mno-inline-float-divide
18661 @opindex mno-inline-float-divide
18662 Do not generate inline code for divides of floating-point values.
18664 @item -minline-int-divide-min-latency
18665 @opindex minline-int-divide-min-latency
18666 Generate code for inline divides of integer values
18667 using the minimum latency algorithm.
18669 @item -minline-int-divide-max-throughput
18670 @opindex minline-int-divide-max-throughput
18671 Generate code for inline divides of integer values
18672 using the maximum throughput algorithm.
18674 @item -mno-inline-int-divide
18675 @opindex mno-inline-int-divide
18676 Do not generate inline code for divides of integer values.
18678 @item -minline-sqrt-min-latency
18679 @opindex minline-sqrt-min-latency
18680 Generate code for inline square roots
18681 using the minimum latency algorithm.
18683 @item -minline-sqrt-max-throughput
18684 @opindex minline-sqrt-max-throughput
18685 Generate code for inline square roots
18686 using the maximum throughput algorithm.
18688 @item -mno-inline-sqrt
18689 @opindex mno-inline-sqrt
18690 Do not generate inline code for @code{sqrt}.
18692 @item -mfused-madd
18693 @itemx -mno-fused-madd
18694 @opindex mfused-madd
18695 @opindex mno-fused-madd
18696 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
18697 instructions.  The default is to use these instructions.
18699 @item -mno-dwarf2-asm
18700 @itemx -mdwarf2-asm
18701 @opindex mno-dwarf2-asm
18702 @opindex mdwarf2-asm
18703 Don't (or do) generate assembler code for the DWARF line number debugging
18704 info.  This may be useful when not using the GNU assembler.
18706 @item -mearly-stop-bits
18707 @itemx -mno-early-stop-bits
18708 @opindex mearly-stop-bits
18709 @opindex mno-early-stop-bits
18710 Allow stop bits to be placed earlier than immediately preceding the
18711 instruction that triggered the stop bit.  This can improve instruction
18712 scheduling, but does not always do so.
18714 @item -mfixed-range=@var{register-range}
18715 @opindex mfixed-range
18716 Generate code treating the given register range as fixed registers.
18717 A fixed register is one that the register allocator cannot use.  This is
18718 useful when compiling kernel code.  A register range is specified as
18719 two registers separated by a dash.  Multiple register ranges can be
18720 specified separated by a comma.
18722 @item -mtls-size=@var{tls-size}
18723 @opindex mtls-size
18724 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
18727 @item -mtune=@var{cpu-type}
18728 @opindex mtune
18729 Tune the instruction scheduling for a particular CPU, Valid values are
18730 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
18731 and @samp{mckinley}.
18733 @item -milp32
18734 @itemx -mlp64
18735 @opindex milp32
18736 @opindex mlp64
18737 Generate code for a 32-bit or 64-bit environment.
18738 The 32-bit environment sets int, long and pointer to 32 bits.
18739 The 64-bit environment sets int to 32 bits and long and pointer
18740 to 64 bits.  These are HP-UX specific flags.
18742 @item -mno-sched-br-data-spec
18743 @itemx -msched-br-data-spec
18744 @opindex mno-sched-br-data-spec
18745 @opindex msched-br-data-spec
18746 (Dis/En)able data speculative scheduling before reload.
18747 This results in generation of @code{ld.a} instructions and
18748 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
18749 The default setting is disabled.
18751 @item -msched-ar-data-spec
18752 @itemx -mno-sched-ar-data-spec
18753 @opindex msched-ar-data-spec
18754 @opindex mno-sched-ar-data-spec
18755 (En/Dis)able data speculative scheduling after reload.
18756 This results in generation of @code{ld.a} instructions and
18757 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
18758 The default setting is enabled.
18760 @item -mno-sched-control-spec
18761 @itemx -msched-control-spec
18762 @opindex mno-sched-control-spec
18763 @opindex msched-control-spec
18764 (Dis/En)able control speculative scheduling.  This feature is
18765 available only during region scheduling (i.e.@: before reload).
18766 This results in generation of the @code{ld.s} instructions and
18767 the corresponding check instructions @code{chk.s}.
18768 The default setting is disabled.
18770 @item -msched-br-in-data-spec
18771 @itemx -mno-sched-br-in-data-spec
18772 @opindex msched-br-in-data-spec
18773 @opindex mno-sched-br-in-data-spec
18774 (En/Dis)able speculative scheduling of the instructions that
18775 are dependent on the data speculative loads before reload.
18776 This is effective only with @option{-msched-br-data-spec} enabled.
18777 The default setting is enabled.
18779 @item -msched-ar-in-data-spec
18780 @itemx -mno-sched-ar-in-data-spec
18781 @opindex msched-ar-in-data-spec
18782 @opindex mno-sched-ar-in-data-spec
18783 (En/Dis)able speculative scheduling of the instructions that
18784 are dependent on the data speculative loads after reload.
18785 This is effective only with @option{-msched-ar-data-spec} enabled.
18786 The default setting is enabled.
18788 @item -msched-in-control-spec
18789 @itemx -mno-sched-in-control-spec
18790 @opindex msched-in-control-spec
18791 @opindex mno-sched-in-control-spec
18792 (En/Dis)able speculative scheduling of the instructions that
18793 are dependent on the control speculative loads.
18794 This is effective only with @option{-msched-control-spec} enabled.
18795 The default setting is enabled.
18797 @item -mno-sched-prefer-non-data-spec-insns
18798 @itemx -msched-prefer-non-data-spec-insns
18799 @opindex mno-sched-prefer-non-data-spec-insns
18800 @opindex msched-prefer-non-data-spec-insns
18801 If enabled, data-speculative instructions are chosen for schedule
18802 only if there are no other choices at the moment.  This makes
18803 the use of the data speculation much more conservative.
18804 The default setting is disabled.
18806 @item -mno-sched-prefer-non-control-spec-insns
18807 @itemx -msched-prefer-non-control-spec-insns
18808 @opindex mno-sched-prefer-non-control-spec-insns
18809 @opindex msched-prefer-non-control-spec-insns
18810 If enabled, control-speculative instructions are chosen for schedule
18811 only if there are no other choices at the moment.  This makes
18812 the use of the control speculation much more conservative.
18813 The default setting is disabled.
18815 @item -mno-sched-count-spec-in-critical-path
18816 @itemx -msched-count-spec-in-critical-path
18817 @opindex mno-sched-count-spec-in-critical-path
18818 @opindex msched-count-spec-in-critical-path
18819 If enabled, speculative dependencies are considered during
18820 computation of the instructions priorities.  This makes the use of the
18821 speculation a bit more conservative.
18822 The default setting is disabled.
18824 @item -msched-spec-ldc
18825 @opindex msched-spec-ldc
18826 Use a simple data speculation check.  This option is on by default.
18828 @item -msched-control-spec-ldc
18829 @opindex msched-spec-ldc
18830 Use a simple check for control speculation.  This option is on by default.
18832 @item -msched-stop-bits-after-every-cycle
18833 @opindex msched-stop-bits-after-every-cycle
18834 Place a stop bit after every cycle when scheduling.  This option is on
18835 by default.
18837 @item -msched-fp-mem-deps-zero-cost
18838 @opindex msched-fp-mem-deps-zero-cost
18839 Assume that floating-point stores and loads are not likely to cause a conflict
18840 when placed into the same instruction group.  This option is disabled by
18841 default.
18843 @item -msel-sched-dont-check-control-spec
18844 @opindex msel-sched-dont-check-control-spec
18845 Generate checks for control speculation in selective scheduling.
18846 This flag is disabled by default.
18848 @item -msched-max-memory-insns=@var{max-insns}
18849 @opindex msched-max-memory-insns
18850 Limit on the number of memory insns per instruction group, giving lower
18851 priority to subsequent memory insns attempting to schedule in the same
18852 instruction group. Frequently useful to prevent cache bank conflicts.
18853 The default value is 1.
18855 @item -msched-max-memory-insns-hard-limit
18856 @opindex msched-max-memory-insns-hard-limit
18857 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
18858 disallowing more than that number in an instruction group.
18859 Otherwise, the limit is ``soft'', meaning that non-memory operations
18860 are preferred when the limit is reached, but memory operations may still
18861 be scheduled.
18863 @end table
18865 @node LM32 Options
18866 @subsection LM32 Options
18867 @cindex LM32 options
18869 These @option{-m} options are defined for the LatticeMico32 architecture:
18871 @table @gcctabopt
18872 @item -mbarrel-shift-enabled
18873 @opindex mbarrel-shift-enabled
18874 Enable barrel-shift instructions.
18876 @item -mdivide-enabled
18877 @opindex mdivide-enabled
18878 Enable divide and modulus instructions.
18880 @item -mmultiply-enabled
18881 @opindex multiply-enabled
18882 Enable multiply instructions.
18884 @item -msign-extend-enabled
18885 @opindex msign-extend-enabled
18886 Enable sign extend instructions.
18888 @item -muser-enabled
18889 @opindex muser-enabled
18890 Enable user-defined instructions.
18892 @end table
18894 @node M32C Options
18895 @subsection M32C Options
18896 @cindex M32C options
18898 @table @gcctabopt
18899 @item -mcpu=@var{name}
18900 @opindex mcpu=
18901 Select the CPU for which code is generated.  @var{name} may be one of
18902 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
18903 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
18904 the M32C/80 series.
18906 @item -msim
18907 @opindex msim
18908 Specifies that the program will be run on the simulator.  This causes
18909 an alternate runtime library to be linked in which supports, for
18910 example, file I/O@.  You must not use this option when generating
18911 programs that will run on real hardware; you must provide your own
18912 runtime library for whatever I/O functions are needed.
18914 @item -memregs=@var{number}
18915 @opindex memregs=
18916 Specifies the number of memory-based pseudo-registers GCC uses
18917 during code generation.  These pseudo-registers are used like real
18918 registers, so there is a tradeoff between GCC's ability to fit the
18919 code into available registers, and the performance penalty of using
18920 memory instead of registers.  Note that all modules in a program must
18921 be compiled with the same value for this option.  Because of that, you
18922 must not use this option with GCC's default runtime libraries.
18924 @end table
18926 @node M32R/D Options
18927 @subsection M32R/D Options
18928 @cindex M32R/D options
18930 These @option{-m} options are defined for Renesas M32R/D architectures:
18932 @table @gcctabopt
18933 @item -m32r2
18934 @opindex m32r2
18935 Generate code for the M32R/2@.
18937 @item -m32rx
18938 @opindex m32rx
18939 Generate code for the M32R/X@.
18941 @item -m32r
18942 @opindex m32r
18943 Generate code for the M32R@.  This is the default.
18945 @item -mmodel=small
18946 @opindex mmodel=small
18947 Assume all objects live in the lower 16MB of memory (so that their addresses
18948 can be loaded with the @code{ld24} instruction), and assume all subroutines
18949 are reachable with the @code{bl} instruction.
18950 This is the default.
18952 The addressability of a particular object can be set with the
18953 @code{model} attribute.
18955 @item -mmodel=medium
18956 @opindex mmodel=medium
18957 Assume objects may be anywhere in the 32-bit address space (the compiler
18958 generates @code{seth/add3} instructions to load their addresses), and
18959 assume all subroutines are reachable with the @code{bl} instruction.
18961 @item -mmodel=large
18962 @opindex mmodel=large
18963 Assume objects may be anywhere in the 32-bit address space (the compiler
18964 generates @code{seth/add3} instructions to load their addresses), and
18965 assume subroutines may not be reachable with the @code{bl} instruction
18966 (the compiler generates the much slower @code{seth/add3/jl}
18967 instruction sequence).
18969 @item -msdata=none
18970 @opindex msdata=none
18971 Disable use of the small data area.  Variables are put into
18972 one of @code{.data}, @code{.bss}, or @code{.rodata} (unless the
18973 @code{section} attribute has been specified).
18974 This is the default.
18976 The small data area consists of sections @code{.sdata} and @code{.sbss}.
18977 Objects may be explicitly put in the small data area with the
18978 @code{section} attribute using one of these sections.
18980 @item -msdata=sdata
18981 @opindex msdata=sdata
18982 Put small global and static data in the small data area, but do not
18983 generate special code to reference them.
18985 @item -msdata=use
18986 @opindex msdata=use
18987 Put small global and static data in the small data area, and generate
18988 special instructions to reference them.
18990 @item -G @var{num}
18991 @opindex G
18992 @cindex smaller data references
18993 Put global and static objects less than or equal to @var{num} bytes
18994 into the small data or BSS sections instead of the normal data or BSS
18995 sections.  The default value of @var{num} is 8.
18996 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
18997 for this option to have any effect.
18999 All modules should be compiled with the same @option{-G @var{num}} value.
19000 Compiling with different values of @var{num} may or may not work; if it
19001 doesn't the linker gives an error message---incorrect code is not
19002 generated.
19004 @item -mdebug
19005 @opindex mdebug
19006 Makes the M32R-specific code in the compiler display some statistics
19007 that might help in debugging programs.
19009 @item -malign-loops
19010 @opindex malign-loops
19011 Align all loops to a 32-byte boundary.
19013 @item -mno-align-loops
19014 @opindex mno-align-loops
19015 Do not enforce a 32-byte alignment for loops.  This is the default.
19017 @item -missue-rate=@var{number}
19018 @opindex missue-rate=@var{number}
19019 Issue @var{number} instructions per cycle.  @var{number} can only be 1
19020 or 2.
19022 @item -mbranch-cost=@var{number}
19023 @opindex mbranch-cost=@var{number}
19024 @var{number} can only be 1 or 2.  If it is 1 then branches are
19025 preferred over conditional code, if it is 2, then the opposite applies.
19027 @item -mflush-trap=@var{number}
19028 @opindex mflush-trap=@var{number}
19029 Specifies the trap number to use to flush the cache.  The default is
19030 12.  Valid numbers are between 0 and 15 inclusive.
19032 @item -mno-flush-trap
19033 @opindex mno-flush-trap
19034 Specifies that the cache cannot be flushed by using a trap.
19036 @item -mflush-func=@var{name}
19037 @opindex mflush-func=@var{name}
19038 Specifies the name of the operating system function to call to flush
19039 the cache.  The default is @samp{_flush_cache}, but a function call
19040 is only used if a trap is not available.
19042 @item -mno-flush-func
19043 @opindex mno-flush-func
19044 Indicates that there is no OS function for flushing the cache.
19046 @end table
19048 @node M680x0 Options
19049 @subsection M680x0 Options
19050 @cindex M680x0 options
19052 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
19053 The default settings depend on which architecture was selected when
19054 the compiler was configured; the defaults for the most common choices
19055 are given below.
19057 @table @gcctabopt
19058 @item -march=@var{arch}
19059 @opindex march
19060 Generate code for a specific M680x0 or ColdFire instruction set
19061 architecture.  Permissible values of @var{arch} for M680x0
19062 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
19063 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
19064 architectures are selected according to Freescale's ISA classification
19065 and the permissible values are: @samp{isaa}, @samp{isaaplus},
19066 @samp{isab} and @samp{isac}.
19068 GCC defines a macro @code{__mcf@var{arch}__} whenever it is generating
19069 code for a ColdFire target.  The @var{arch} in this macro is one of the
19070 @option{-march} arguments given above.
19072 When used together, @option{-march} and @option{-mtune} select code
19073 that runs on a family of similar processors but that is optimized
19074 for a particular microarchitecture.
19076 @item -mcpu=@var{cpu}
19077 @opindex mcpu
19078 Generate code for a specific M680x0 or ColdFire processor.
19079 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
19080 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
19081 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
19082 below, which also classifies the CPUs into families:
19084 @multitable @columnfractions 0.20 0.80
19085 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
19086 @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}
19087 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
19088 @item @samp{5206e} @tab @samp{5206e}
19089 @item @samp{5208} @tab @samp{5207} @samp{5208}
19090 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
19091 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
19092 @item @samp{5216} @tab @samp{5214} @samp{5216}
19093 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
19094 @item @samp{5225} @tab @samp{5224} @samp{5225}
19095 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
19096 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
19097 @item @samp{5249} @tab @samp{5249}
19098 @item @samp{5250} @tab @samp{5250}
19099 @item @samp{5271} @tab @samp{5270} @samp{5271}
19100 @item @samp{5272} @tab @samp{5272}
19101 @item @samp{5275} @tab @samp{5274} @samp{5275}
19102 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
19103 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
19104 @item @samp{5307} @tab @samp{5307}
19105 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
19106 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
19107 @item @samp{5407} @tab @samp{5407}
19108 @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}
19109 @end multitable
19111 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
19112 @var{arch} is compatible with @var{cpu}.  Other combinations of
19113 @option{-mcpu} and @option{-march} are rejected.
19115 GCC defines the macro @code{__mcf_cpu_@var{cpu}} when ColdFire target
19116 @var{cpu} is selected.  It also defines @code{__mcf_family_@var{family}},
19117 where the value of @var{family} is given by the table above.
19119 @item -mtune=@var{tune}
19120 @opindex mtune
19121 Tune the code for a particular microarchitecture within the
19122 constraints set by @option{-march} and @option{-mcpu}.
19123 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
19124 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
19125 and @samp{cpu32}.  The ColdFire microarchitectures
19126 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
19128 You can also use @option{-mtune=68020-40} for code that needs
19129 to run relatively well on 68020, 68030 and 68040 targets.
19130 @option{-mtune=68020-60} is similar but includes 68060 targets
19131 as well.  These two options select the same tuning decisions as
19132 @option{-m68020-40} and @option{-m68020-60} respectively.
19134 GCC defines the macros @code{__mc@var{arch}} and @code{__mc@var{arch}__}
19135 when tuning for 680x0 architecture @var{arch}.  It also defines
19136 @code{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
19137 option is used.  If GCC is tuning for a range of architectures,
19138 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
19139 it defines the macros for every architecture in the range.
19141 GCC also defines the macro @code{__m@var{uarch}__} when tuning for
19142 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
19143 of the arguments given above.
19145 @item -m68000
19146 @itemx -mc68000
19147 @opindex m68000
19148 @opindex mc68000
19149 Generate output for a 68000.  This is the default
19150 when the compiler is configured for 68000-based systems.
19151 It is equivalent to @option{-march=68000}.
19153 Use this option for microcontrollers with a 68000 or EC000 core,
19154 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
19156 @item -m68010
19157 @opindex m68010
19158 Generate output for a 68010.  This is the default
19159 when the compiler is configured for 68010-based systems.
19160 It is equivalent to @option{-march=68010}.
19162 @item -m68020
19163 @itemx -mc68020
19164 @opindex m68020
19165 @opindex mc68020
19166 Generate output for a 68020.  This is the default
19167 when the compiler is configured for 68020-based systems.
19168 It is equivalent to @option{-march=68020}.
19170 @item -m68030
19171 @opindex m68030
19172 Generate output for a 68030.  This is the default when the compiler is
19173 configured for 68030-based systems.  It is equivalent to
19174 @option{-march=68030}.
19176 @item -m68040
19177 @opindex m68040
19178 Generate output for a 68040.  This is the default when the compiler is
19179 configured for 68040-based systems.  It is equivalent to
19180 @option{-march=68040}.
19182 This option inhibits the use of 68881/68882 instructions that have to be
19183 emulated by software on the 68040.  Use this option if your 68040 does not
19184 have code to emulate those instructions.
19186 @item -m68060
19187 @opindex m68060
19188 Generate output for a 68060.  This is the default when the compiler is
19189 configured for 68060-based systems.  It is equivalent to
19190 @option{-march=68060}.
19192 This option inhibits the use of 68020 and 68881/68882 instructions that
19193 have to be emulated by software on the 68060.  Use this option if your 68060
19194 does not have code to emulate those instructions.
19196 @item -mcpu32
19197 @opindex mcpu32
19198 Generate output for a CPU32.  This is the default
19199 when the compiler is configured for CPU32-based systems.
19200 It is equivalent to @option{-march=cpu32}.
19202 Use this option for microcontrollers with a
19203 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
19204 68336, 68340, 68341, 68349 and 68360.
19206 @item -m5200
19207 @opindex m5200
19208 Generate output for a 520X ColdFire CPU@.  This is the default
19209 when the compiler is configured for 520X-based systems.
19210 It is equivalent to @option{-mcpu=5206}, and is now deprecated
19211 in favor of that option.
19213 Use this option for microcontroller with a 5200 core, including
19214 the MCF5202, MCF5203, MCF5204 and MCF5206.
19216 @item -m5206e
19217 @opindex m5206e
19218 Generate output for a 5206e ColdFire CPU@.  The option is now
19219 deprecated in favor of the equivalent @option{-mcpu=5206e}.
19221 @item -m528x
19222 @opindex m528x
19223 Generate output for a member of the ColdFire 528X family.
19224 The option is now deprecated in favor of the equivalent
19225 @option{-mcpu=528x}.
19227 @item -m5307
19228 @opindex m5307
19229 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
19230 in favor of the equivalent @option{-mcpu=5307}.
19232 @item -m5407
19233 @opindex m5407
19234 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
19235 in favor of the equivalent @option{-mcpu=5407}.
19237 @item -mcfv4e
19238 @opindex mcfv4e
19239 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
19240 This includes use of hardware floating-point instructions.
19241 The option is equivalent to @option{-mcpu=547x}, and is now
19242 deprecated in favor of that option.
19244 @item -m68020-40
19245 @opindex m68020-40
19246 Generate output for a 68040, without using any of the new instructions.
19247 This results in code that can run relatively efficiently on either a
19248 68020/68881 or a 68030 or a 68040.  The generated code does use the
19249 68881 instructions that are emulated on the 68040.
19251 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
19253 @item -m68020-60
19254 @opindex m68020-60
19255 Generate output for a 68060, without using any of the new instructions.
19256 This results in code that can run relatively efficiently on either a
19257 68020/68881 or a 68030 or a 68040.  The generated code does use the
19258 68881 instructions that are emulated on the 68060.
19260 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
19262 @item -mhard-float
19263 @itemx -m68881
19264 @opindex mhard-float
19265 @opindex m68881
19266 Generate floating-point instructions.  This is the default for 68020
19267 and above, and for ColdFire devices that have an FPU@.  It defines the
19268 macro @code{__HAVE_68881__} on M680x0 targets and @code{__mcffpu__}
19269 on ColdFire targets.
19271 @item -msoft-float
19272 @opindex msoft-float
19273 Do not generate floating-point instructions; use library calls instead.
19274 This is the default for 68000, 68010, and 68832 targets.  It is also
19275 the default for ColdFire devices that have no FPU.
19277 @item -mdiv
19278 @itemx -mno-div
19279 @opindex mdiv
19280 @opindex mno-div
19281 Generate (do not generate) ColdFire hardware divide and remainder
19282 instructions.  If @option{-march} is used without @option{-mcpu},
19283 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
19284 architectures.  Otherwise, the default is taken from the target CPU
19285 (either the default CPU, or the one specified by @option{-mcpu}).  For
19286 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
19287 @option{-mcpu=5206e}.
19289 GCC defines the macro @code{__mcfhwdiv__} when this option is enabled.
19291 @item -mshort
19292 @opindex mshort
19293 Consider type @code{int} to be 16 bits wide, like @code{short int}.
19294 Additionally, parameters passed on the stack are also aligned to a
19295 16-bit boundary even on targets whose API mandates promotion to 32-bit.
19297 @item -mno-short
19298 @opindex mno-short
19299 Do not consider type @code{int} to be 16 bits wide.  This is the default.
19301 @item -mnobitfield
19302 @itemx -mno-bitfield
19303 @opindex mnobitfield
19304 @opindex mno-bitfield
19305 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
19306 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
19308 @item -mbitfield
19309 @opindex mbitfield
19310 Do use the bit-field instructions.  The @option{-m68020} option implies
19311 @option{-mbitfield}.  This is the default if you use a configuration
19312 designed for a 68020.
19314 @item -mrtd
19315 @opindex mrtd
19316 Use a different function-calling convention, in which functions
19317 that take a fixed number of arguments return with the @code{rtd}
19318 instruction, which pops their arguments while returning.  This
19319 saves one instruction in the caller since there is no need to pop
19320 the arguments there.
19322 This calling convention is incompatible with the one normally
19323 used on Unix, so you cannot use it if you need to call libraries
19324 compiled with the Unix compiler.
19326 Also, you must provide function prototypes for all functions that
19327 take variable numbers of arguments (including @code{printf});
19328 otherwise incorrect code is generated for calls to those
19329 functions.
19331 In addition, seriously incorrect code results if you call a
19332 function with too many arguments.  (Normally, extra arguments are
19333 harmlessly ignored.)
19335 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
19336 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
19338 @item -mno-rtd
19339 @opindex mno-rtd
19340 Do not use the calling conventions selected by @option{-mrtd}.
19341 This is the default.
19343 @item -malign-int
19344 @itemx -mno-align-int
19345 @opindex malign-int
19346 @opindex mno-align-int
19347 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
19348 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
19349 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
19350 Aligning variables on 32-bit boundaries produces code that runs somewhat
19351 faster on processors with 32-bit busses at the expense of more memory.
19353 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
19354 aligns structures containing the above types differently than
19355 most published application binary interface specifications for the m68k.
19357 @item -mpcrel
19358 @opindex mpcrel
19359 Use the pc-relative addressing mode of the 68000 directly, instead of
19360 using a global offset table.  At present, this option implies @option{-fpic},
19361 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
19362 not presently supported with @option{-mpcrel}, though this could be supported for
19363 68020 and higher processors.
19365 @item -mno-strict-align
19366 @itemx -mstrict-align
19367 @opindex mno-strict-align
19368 @opindex mstrict-align
19369 Do not (do) assume that unaligned memory references are handled by
19370 the system.
19372 @item -msep-data
19373 Generate code that allows the data segment to be located in a different
19374 area of memory from the text segment.  This allows for execute-in-place in
19375 an environment without virtual memory management.  This option implies
19376 @option{-fPIC}.
19378 @item -mno-sep-data
19379 Generate code that assumes that the data segment follows the text segment.
19380 This is the default.
19382 @item -mid-shared-library
19383 Generate code that supports shared libraries via the library ID method.
19384 This allows for execute-in-place and shared libraries in an environment
19385 without virtual memory management.  This option implies @option{-fPIC}.
19387 @item -mno-id-shared-library
19388 Generate code that doesn't assume ID-based shared libraries are being used.
19389 This is the default.
19391 @item -mshared-library-id=n
19392 Specifies the identification number of the ID-based shared library being
19393 compiled.  Specifying a value of 0 generates more compact code; specifying
19394 other values forces the allocation of that number to the current
19395 library, but is no more space- or time-efficient than omitting this option.
19397 @item -mxgot
19398 @itemx -mno-xgot
19399 @opindex mxgot
19400 @opindex mno-xgot
19401 When generating position-independent code for ColdFire, generate code
19402 that works if the GOT has more than 8192 entries.  This code is
19403 larger and slower than code generated without this option.  On M680x0
19404 processors, this option is not needed; @option{-fPIC} suffices.
19406 GCC normally uses a single instruction to load values from the GOT@.
19407 While this is relatively efficient, it only works if the GOT
19408 is smaller than about 64k.  Anything larger causes the linker
19409 to report an error such as:
19411 @cindex relocation truncated to fit (ColdFire)
19412 @smallexample
19413 relocation truncated to fit: R_68K_GOT16O foobar
19414 @end smallexample
19416 If this happens, you should recompile your code with @option{-mxgot}.
19417 It should then work with very large GOTs.  However, code generated with
19418 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
19419 the value of a global symbol.
19421 Note that some linkers, including newer versions of the GNU linker,
19422 can create multiple GOTs and sort GOT entries.  If you have such a linker,
19423 you should only need to use @option{-mxgot} when compiling a single
19424 object file that accesses more than 8192 GOT entries.  Very few do.
19426 These options have no effect unless GCC is generating
19427 position-independent code.
19429 @item -mlong-jump-table-offsets
19430 @opindex mlong-jump-table-offsets
19431 Use 32-bit offsets in @code{switch} tables.  The default is to use
19432 16-bit offsets.
19434 @end table
19436 @node MCore Options
19437 @subsection MCore Options
19438 @cindex MCore options
19440 These are the @samp{-m} options defined for the Motorola M*Core
19441 processors.
19443 @table @gcctabopt
19445 @item -mhardlit
19446 @itemx -mno-hardlit
19447 @opindex mhardlit
19448 @opindex mno-hardlit
19449 Inline constants into the code stream if it can be done in two
19450 instructions or less.
19452 @item -mdiv
19453 @itemx -mno-div
19454 @opindex mdiv
19455 @opindex mno-div
19456 Use the divide instruction.  (Enabled by default).
19458 @item -mrelax-immediate
19459 @itemx -mno-relax-immediate
19460 @opindex mrelax-immediate
19461 @opindex mno-relax-immediate
19462 Allow arbitrary-sized immediates in bit operations.
19464 @item -mwide-bitfields
19465 @itemx -mno-wide-bitfields
19466 @opindex mwide-bitfields
19467 @opindex mno-wide-bitfields
19468 Always treat bit-fields as @code{int}-sized.
19470 @item -m4byte-functions
19471 @itemx -mno-4byte-functions
19472 @opindex m4byte-functions
19473 @opindex mno-4byte-functions
19474 Force all functions to be aligned to a 4-byte boundary.
19476 @item -mcallgraph-data
19477 @itemx -mno-callgraph-data
19478 @opindex mcallgraph-data
19479 @opindex mno-callgraph-data
19480 Emit callgraph information.
19482 @item -mslow-bytes
19483 @itemx -mno-slow-bytes
19484 @opindex mslow-bytes
19485 @opindex mno-slow-bytes
19486 Prefer word access when reading byte quantities.
19488 @item -mlittle-endian
19489 @itemx -mbig-endian
19490 @opindex mlittle-endian
19491 @opindex mbig-endian
19492 Generate code for a little-endian target.
19494 @item -m210
19495 @itemx -m340
19496 @opindex m210
19497 @opindex m340
19498 Generate code for the 210 processor.
19500 @item -mno-lsim
19501 @opindex mno-lsim
19502 Assume that runtime support has been provided and so omit the
19503 simulator library (@file{libsim.a)} from the linker command line.
19505 @item -mstack-increment=@var{size}
19506 @opindex mstack-increment
19507 Set the maximum amount for a single stack increment operation.  Large
19508 values can increase the speed of programs that contain functions
19509 that need a large amount of stack space, but they can also trigger a
19510 segmentation fault if the stack is extended too much.  The default
19511 value is 0x1000.
19513 @end table
19515 @node MeP Options
19516 @subsection MeP Options
19517 @cindex MeP options
19519 @table @gcctabopt
19521 @item -mabsdiff
19522 @opindex mabsdiff
19523 Enables the @code{abs} instruction, which is the absolute difference
19524 between two registers.
19526 @item -mall-opts
19527 @opindex mall-opts
19528 Enables all the optional instructions---average, multiply, divide, bit
19529 operations, leading zero, absolute difference, min/max, clip, and
19530 saturation.
19533 @item -maverage
19534 @opindex maverage
19535 Enables the @code{ave} instruction, which computes the average of two
19536 registers.
19538 @item -mbased=@var{n}
19539 @opindex mbased=
19540 Variables of size @var{n} bytes or smaller are placed in the
19541 @code{.based} section by default.  Based variables use the @code{$tp}
19542 register as a base register, and there is a 128-byte limit to the
19543 @code{.based} section.
19545 @item -mbitops
19546 @opindex mbitops
19547 Enables the bit operation instructions---bit test (@code{btstm}), set
19548 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
19549 test-and-set (@code{tas}).
19551 @item -mc=@var{name}
19552 @opindex mc=
19553 Selects which section constant data is placed in.  @var{name} may
19554 be @samp{tiny}, @samp{near}, or @samp{far}.
19556 @item -mclip
19557 @opindex mclip
19558 Enables the @code{clip} instruction.  Note that @option{-mclip} is not
19559 useful unless you also provide @option{-mminmax}.
19561 @item -mconfig=@var{name}
19562 @opindex mconfig=
19563 Selects one of the built-in core configurations.  Each MeP chip has
19564 one or more modules in it; each module has a core CPU and a variety of
19565 coprocessors, optional instructions, and peripherals.  The
19566 @code{MeP-Integrator} tool, not part of GCC, provides these
19567 configurations through this option; using this option is the same as
19568 using all the corresponding command-line options.  The default
19569 configuration is @samp{default}.
19571 @item -mcop
19572 @opindex mcop
19573 Enables the coprocessor instructions.  By default, this is a 32-bit
19574 coprocessor.  Note that the coprocessor is normally enabled via the
19575 @option{-mconfig=} option.
19577 @item -mcop32
19578 @opindex mcop32
19579 Enables the 32-bit coprocessor's instructions.
19581 @item -mcop64
19582 @opindex mcop64
19583 Enables the 64-bit coprocessor's instructions.
19585 @item -mivc2
19586 @opindex mivc2
19587 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
19589 @item -mdc
19590 @opindex mdc
19591 Causes constant variables to be placed in the @code{.near} section.
19593 @item -mdiv
19594 @opindex mdiv
19595 Enables the @code{div} and @code{divu} instructions.
19597 @item -meb
19598 @opindex meb
19599 Generate big-endian code.
19601 @item -mel
19602 @opindex mel
19603 Generate little-endian code.
19605 @item -mio-volatile
19606 @opindex mio-volatile
19607 Tells the compiler that any variable marked with the @code{io}
19608 attribute is to be considered volatile.
19610 @item -ml
19611 @opindex ml
19612 Causes variables to be assigned to the @code{.far} section by default.
19614 @item -mleadz
19615 @opindex mleadz
19616 Enables the @code{leadz} (leading zero) instruction.
19618 @item -mm
19619 @opindex mm
19620 Causes variables to be assigned to the @code{.near} section by default.
19622 @item -mminmax
19623 @opindex mminmax
19624 Enables the @code{min} and @code{max} instructions.
19626 @item -mmult
19627 @opindex mmult
19628 Enables the multiplication and multiply-accumulate instructions.
19630 @item -mno-opts
19631 @opindex mno-opts
19632 Disables all the optional instructions enabled by @option{-mall-opts}.
19634 @item -mrepeat
19635 @opindex mrepeat
19636 Enables the @code{repeat} and @code{erepeat} instructions, used for
19637 low-overhead looping.
19639 @item -ms
19640 @opindex ms
19641 Causes all variables to default to the @code{.tiny} section.  Note
19642 that there is a 65536-byte limit to this section.  Accesses to these
19643 variables use the @code{%gp} base register.
19645 @item -msatur
19646 @opindex msatur
19647 Enables the saturation instructions.  Note that the compiler does not
19648 currently generate these itself, but this option is included for
19649 compatibility with other tools, like @code{as}.
19651 @item -msdram
19652 @opindex msdram
19653 Link the SDRAM-based runtime instead of the default ROM-based runtime.
19655 @item -msim
19656 @opindex msim
19657 Link the simulator run-time libraries.
19659 @item -msimnovec
19660 @opindex msimnovec
19661 Link the simulator runtime libraries, excluding built-in support
19662 for reset and exception vectors and tables.
19664 @item -mtf
19665 @opindex mtf
19666 Causes all functions to default to the @code{.far} section.  Without
19667 this option, functions default to the @code{.near} section.
19669 @item -mtiny=@var{n}
19670 @opindex mtiny=
19671 Variables that are @var{n} bytes or smaller are allocated to the
19672 @code{.tiny} section.  These variables use the @code{$gp} base
19673 register.  The default for this option is 4, but note that there's a
19674 65536-byte limit to the @code{.tiny} section.
19676 @end table
19678 @node MicroBlaze Options
19679 @subsection MicroBlaze Options
19680 @cindex MicroBlaze Options
19682 @table @gcctabopt
19684 @item -msoft-float
19685 @opindex msoft-float
19686 Use software emulation for floating point (default).
19688 @item -mhard-float
19689 @opindex mhard-float
19690 Use hardware floating-point instructions.
19692 @item -mmemcpy
19693 @opindex mmemcpy
19694 Do not optimize block moves, use @code{memcpy}.
19696 @item -mno-clearbss
19697 @opindex mno-clearbss
19698 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
19700 @item -mcpu=@var{cpu-type}
19701 @opindex mcpu=
19702 Use features of, and schedule code for, the given CPU.
19703 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
19704 where @var{X} is a major version, @var{YY} is the minor version, and
19705 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
19706 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
19708 @item -mxl-soft-mul
19709 @opindex mxl-soft-mul
19710 Use software multiply emulation (default).
19712 @item -mxl-soft-div
19713 @opindex mxl-soft-div
19714 Use software emulation for divides (default).
19716 @item -mxl-barrel-shift
19717 @opindex mxl-barrel-shift
19718 Use the hardware barrel shifter.
19720 @item -mxl-pattern-compare
19721 @opindex mxl-pattern-compare
19722 Use pattern compare instructions.
19724 @item -msmall-divides
19725 @opindex msmall-divides
19726 Use table lookup optimization for small signed integer divisions.
19728 @item -mxl-stack-check
19729 @opindex mxl-stack-check
19730 This option is deprecated.  Use @option{-fstack-check} instead.
19732 @item -mxl-gp-opt
19733 @opindex mxl-gp-opt
19734 Use GP-relative @code{.sdata}/@code{.sbss} sections.
19736 @item -mxl-multiply-high
19737 @opindex mxl-multiply-high
19738 Use multiply high instructions for high part of 32x32 multiply.
19740 @item -mxl-float-convert
19741 @opindex mxl-float-convert
19742 Use hardware floating-point conversion instructions.
19744 @item -mxl-float-sqrt
19745 @opindex mxl-float-sqrt
19746 Use hardware floating-point square root instruction.
19748 @item -mbig-endian
19749 @opindex mbig-endian
19750 Generate code for a big-endian target.
19752 @item -mlittle-endian
19753 @opindex mlittle-endian
19754 Generate code for a little-endian target.
19756 @item -mxl-reorder
19757 @opindex mxl-reorder
19758 Use reorder instructions (swap and byte reversed load/store).
19760 @item -mxl-mode-@var{app-model}
19761 Select application model @var{app-model}.  Valid models are
19762 @table @samp
19763 @item executable
19764 normal executable (default), uses startup code @file{crt0.o}.
19766 @item xmdstub
19767 for use with Xilinx Microprocessor Debugger (XMD) based
19768 software intrusive debug agent called xmdstub. This uses startup file
19769 @file{crt1.o} and sets the start address of the program to 0x800.
19771 @item bootstrap
19772 for applications that are loaded using a bootloader.
19773 This model uses startup file @file{crt2.o} which does not contain a processor
19774 reset vector handler. This is suitable for transferring control on a
19775 processor reset to the bootloader rather than the application.
19777 @item novectors
19778 for applications that do not require any of the
19779 MicroBlaze vectors. This option may be useful for applications running
19780 within a monitoring application. This model uses @file{crt3.o} as a startup file.
19781 @end table
19783 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
19784 @option{-mxl-mode-@var{app-model}}.
19786 @end table
19788 @node MIPS Options
19789 @subsection MIPS Options
19790 @cindex MIPS options
19792 @table @gcctabopt
19794 @item -EB
19795 @opindex EB
19796 Generate big-endian code.
19798 @item -EL
19799 @opindex EL
19800 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
19801 configurations.
19803 @item -march=@var{arch}
19804 @opindex march
19805 Generate code that runs on @var{arch}, which can be the name of a
19806 generic MIPS ISA, or the name of a particular processor.
19807 The ISA names are:
19808 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
19809 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5},
19810 @samp{mips32r6}, @samp{mips64}, @samp{mips64r2}, @samp{mips64r3},
19811 @samp{mips64r5} and @samp{mips64r6}.
19812 The processor names are:
19813 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
19814 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
19815 @samp{5kc}, @samp{5kf},
19816 @samp{20kc},
19817 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
19818 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
19819 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
19820 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
19821 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
19822 @samp{i6400},
19823 @samp{interaptiv},
19824 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
19825 @samp{m4k},
19826 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
19827 @samp{m5100}, @samp{m5101},
19828 @samp{octeon}, @samp{octeon+}, @samp{octeon2}, @samp{octeon3},
19829 @samp{orion},
19830 @samp{p5600},
19831 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
19832 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
19833 @samp{rm7000}, @samp{rm9000},
19834 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
19835 @samp{sb1},
19836 @samp{sr71000},
19837 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
19838 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
19839 @samp{xlr} and @samp{xlp}.
19840 The special value @samp{from-abi} selects the
19841 most compatible architecture for the selected ABI (that is,
19842 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
19844 The native Linux/GNU toolchain also supports the value @samp{native},
19845 which selects the best architecture option for the host processor.
19846 @option{-march=native} has no effect if GCC does not recognize
19847 the processor.
19849 In processor names, a final @samp{000} can be abbreviated as @samp{k}
19850 (for example, @option{-march=r2k}).  Prefixes are optional, and
19851 @samp{vr} may be written @samp{r}.
19853 Names of the form @samp{@var{n}f2_1} refer to processors with
19854 FPUs clocked at half the rate of the core, names of the form
19855 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
19856 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
19857 processors with FPUs clocked a ratio of 3:2 with respect to the core.
19858 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
19859 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
19860 accepted as synonyms for @samp{@var{n}f1_1}.
19862 GCC defines two macros based on the value of this option.  The first
19863 is @code{_MIPS_ARCH}, which gives the name of target architecture, as
19864 a string.  The second has the form @code{_MIPS_ARCH_@var{foo}},
19865 where @var{foo} is the capitalized value of @code{_MIPS_ARCH}@.
19866 For example, @option{-march=r2000} sets @code{_MIPS_ARCH}
19867 to @code{"r2000"} and defines the macro @code{_MIPS_ARCH_R2000}.
19869 Note that the @code{_MIPS_ARCH} macro uses the processor names given
19870 above.  In other words, it has the full prefix and does not
19871 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
19872 the macro names the resolved architecture (either @code{"mips1"} or
19873 @code{"mips3"}).  It names the default architecture when no
19874 @option{-march} option is given.
19876 @item -mtune=@var{arch}
19877 @opindex mtune
19878 Optimize for @var{arch}.  Among other things, this option controls
19879 the way instructions are scheduled, and the perceived cost of arithmetic
19880 operations.  The list of @var{arch} values is the same as for
19881 @option{-march}.
19883 When this option is not used, GCC optimizes for the processor
19884 specified by @option{-march}.  By using @option{-march} and
19885 @option{-mtune} together, it is possible to generate code that
19886 runs on a family of processors, but optimize the code for one
19887 particular member of that family.
19889 @option{-mtune} defines the macros @code{_MIPS_TUNE} and
19890 @code{_MIPS_TUNE_@var{foo}}, which work in the same way as the
19891 @option{-march} ones described above.
19893 @item -mips1
19894 @opindex mips1
19895 Equivalent to @option{-march=mips1}.
19897 @item -mips2
19898 @opindex mips2
19899 Equivalent to @option{-march=mips2}.
19901 @item -mips3
19902 @opindex mips3
19903 Equivalent to @option{-march=mips3}.
19905 @item -mips4
19906 @opindex mips4
19907 Equivalent to @option{-march=mips4}.
19909 @item -mips32
19910 @opindex mips32
19911 Equivalent to @option{-march=mips32}.
19913 @item -mips32r3
19914 @opindex mips32r3
19915 Equivalent to @option{-march=mips32r3}.
19917 @item -mips32r5
19918 @opindex mips32r5
19919 Equivalent to @option{-march=mips32r5}.
19921 @item -mips32r6
19922 @opindex mips32r6
19923 Equivalent to @option{-march=mips32r6}.
19925 @item -mips64
19926 @opindex mips64
19927 Equivalent to @option{-march=mips64}.
19929 @item -mips64r2
19930 @opindex mips64r2
19931 Equivalent to @option{-march=mips64r2}.
19933 @item -mips64r3
19934 @opindex mips64r3
19935 Equivalent to @option{-march=mips64r3}.
19937 @item -mips64r5
19938 @opindex mips64r5
19939 Equivalent to @option{-march=mips64r5}.
19941 @item -mips64r6
19942 @opindex mips64r6
19943 Equivalent to @option{-march=mips64r6}.
19945 @item -mips16
19946 @itemx -mno-mips16
19947 @opindex mips16
19948 @opindex mno-mips16
19949 Generate (do not generate) MIPS16 code.  If GCC is targeting a
19950 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
19952 MIPS16 code generation can also be controlled on a per-function basis
19953 by means of @code{mips16} and @code{nomips16} attributes.
19954 @xref{Function Attributes}, for more information.
19956 @item -mflip-mips16
19957 @opindex mflip-mips16
19958 Generate MIPS16 code on alternating functions.  This option is provided
19959 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
19960 not intended for ordinary use in compiling user code.
19962 @item -minterlink-compressed
19963 @item -mno-interlink-compressed
19964 @opindex minterlink-compressed
19965 @opindex mno-interlink-compressed
19966 Require (do not require) that code using the standard (uncompressed) MIPS ISA
19967 be link-compatible with MIPS16 and microMIPS code, and vice versa.
19969 For example, code using the standard ISA encoding cannot jump directly
19970 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
19971 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
19972 knows that the target of the jump is not compressed.
19974 @item -minterlink-mips16
19975 @itemx -mno-interlink-mips16
19976 @opindex minterlink-mips16
19977 @opindex mno-interlink-mips16
19978 Aliases of @option{-minterlink-compressed} and
19979 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
19980 and are retained for backwards compatibility.
19982 @item -mabi=32
19983 @itemx -mabi=o64
19984 @itemx -mabi=n32
19985 @itemx -mabi=64
19986 @itemx -mabi=eabi
19987 @opindex mabi=32
19988 @opindex mabi=o64
19989 @opindex mabi=n32
19990 @opindex mabi=64
19991 @opindex mabi=eabi
19992 Generate code for the given ABI@.
19994 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
19995 generates 64-bit code when you select a 64-bit architecture, but you
19996 can use @option{-mgp32} to get 32-bit code instead.
19998 For information about the O64 ABI, see
19999 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
20001 GCC supports a variant of the o32 ABI in which floating-point registers
20002 are 64 rather than 32 bits wide.  You can select this combination with
20003 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
20004 and @code{mfhc1} instructions and is therefore only supported for
20005 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
20007 The register assignments for arguments and return values remain the
20008 same, but each scalar value is passed in a single 64-bit register
20009 rather than a pair of 32-bit registers.  For example, scalar
20010 floating-point values are returned in @samp{$f0} only, not a
20011 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
20012 remains the same in that the even-numbered double-precision registers
20013 are saved.
20015 Two additional variants of the o32 ABI are supported to enable
20016 a transition from 32-bit to 64-bit registers.  These are FPXX
20017 (@option{-mfpxx}) and FP64A (@option{-mfp64} @option{-mno-odd-spreg}).
20018 The FPXX extension mandates that all code must execute correctly
20019 when run using 32-bit or 64-bit registers.  The code can be interlinked
20020 with either FP32 or FP64, but not both.
20021 The FP64A extension is similar to the FP64 extension but forbids the
20022 use of odd-numbered single-precision registers.  This can be used
20023 in conjunction with the @code{FRE} mode of FPUs in MIPS32R5
20024 processors and allows both FP32 and FP64A code to interlink and
20025 run in the same process without changing FPU modes.
20027 @item -mabicalls
20028 @itemx -mno-abicalls
20029 @opindex mabicalls
20030 @opindex mno-abicalls
20031 Generate (do not generate) code that is suitable for SVR4-style
20032 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
20033 systems.
20035 @item -mshared
20036 @itemx -mno-shared
20037 Generate (do not generate) code that is fully position-independent,
20038 and that can therefore be linked into shared libraries.  This option
20039 only affects @option{-mabicalls}.
20041 All @option{-mabicalls} code has traditionally been position-independent,
20042 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
20043 as an extension, the GNU toolchain allows executables to use absolute
20044 accesses for locally-binding symbols.  It can also use shorter GP
20045 initialization sequences and generate direct calls to locally-defined
20046 functions.  This mode is selected by @option{-mno-shared}.
20048 @option{-mno-shared} depends on binutils 2.16 or higher and generates
20049 objects that can only be linked by the GNU linker.  However, the option
20050 does not affect the ABI of the final executable; it only affects the ABI
20051 of relocatable objects.  Using @option{-mno-shared} generally makes
20052 executables both smaller and quicker.
20054 @option{-mshared} is the default.
20056 @item -mplt
20057 @itemx -mno-plt
20058 @opindex mplt
20059 @opindex mno-plt
20060 Assume (do not assume) that the static and dynamic linkers
20061 support PLTs and copy relocations.  This option only affects
20062 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
20063 has no effect without @option{-msym32}.
20065 You can make @option{-mplt} the default by configuring
20066 GCC with @option{--with-mips-plt}.  The default is
20067 @option{-mno-plt} otherwise.
20069 @item -mxgot
20070 @itemx -mno-xgot
20071 @opindex mxgot
20072 @opindex mno-xgot
20073 Lift (do not lift) the usual restrictions on the size of the global
20074 offset table.
20076 GCC normally uses a single instruction to load values from the GOT@.
20077 While this is relatively efficient, it only works if the GOT
20078 is smaller than about 64k.  Anything larger causes the linker
20079 to report an error such as:
20081 @cindex relocation truncated to fit (MIPS)
20082 @smallexample
20083 relocation truncated to fit: R_MIPS_GOT16 foobar
20084 @end smallexample
20086 If this happens, you should recompile your code with @option{-mxgot}.
20087 This works with very large GOTs, although the code is also
20088 less efficient, since it takes three instructions to fetch the
20089 value of a global symbol.
20091 Note that some linkers can create multiple GOTs.  If you have such a
20092 linker, you should only need to use @option{-mxgot} when a single object
20093 file accesses more than 64k's worth of GOT entries.  Very few do.
20095 These options have no effect unless GCC is generating position
20096 independent code.
20098 @item -mgp32
20099 @opindex mgp32
20100 Assume that general-purpose registers are 32 bits wide.
20102 @item -mgp64
20103 @opindex mgp64
20104 Assume that general-purpose registers are 64 bits wide.
20106 @item -mfp32
20107 @opindex mfp32
20108 Assume that floating-point registers are 32 bits wide.
20110 @item -mfp64
20111 @opindex mfp64
20112 Assume that floating-point registers are 64 bits wide.
20114 @item -mfpxx
20115 @opindex mfpxx
20116 Do not assume the width of floating-point registers.
20118 @item -mhard-float
20119 @opindex mhard-float
20120 Use floating-point coprocessor instructions.
20122 @item -msoft-float
20123 @opindex msoft-float
20124 Do not use floating-point coprocessor instructions.  Implement
20125 floating-point calculations using library calls instead.
20127 @item -mno-float
20128 @opindex mno-float
20129 Equivalent to @option{-msoft-float}, but additionally asserts that the
20130 program being compiled does not perform any floating-point operations.
20131 This option is presently supported only by some bare-metal MIPS
20132 configurations, where it may select a special set of libraries
20133 that lack all floating-point support (including, for example, the
20134 floating-point @code{printf} formats).  
20135 If code compiled with @option{-mno-float} accidentally contains
20136 floating-point operations, it is likely to suffer a link-time
20137 or run-time failure.
20139 @item -msingle-float
20140 @opindex msingle-float
20141 Assume that the floating-point coprocessor only supports single-precision
20142 operations.
20144 @item -mdouble-float
20145 @opindex mdouble-float
20146 Assume that the floating-point coprocessor supports double-precision
20147 operations.  This is the default.
20149 @item -modd-spreg
20150 @itemx -mno-odd-spreg
20151 @opindex modd-spreg
20152 @opindex mno-odd-spreg
20153 Enable the use of odd-numbered single-precision floating-point registers
20154 for the o32 ABI.  This is the default for processors that are known to
20155 support these registers.  When using the o32 FPXX ABI, @option{-mno-odd-spreg}
20156 is set by default.
20158 @item -mabs=2008
20159 @itemx -mabs=legacy
20160 @opindex mabs=2008
20161 @opindex mabs=legacy
20162 These options control the treatment of the special not-a-number (NaN)
20163 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
20164 @code{neg.@i{fmt}} machine instructions.
20166 By default or when @option{-mabs=legacy} is used the legacy
20167 treatment is selected.  In this case these instructions are considered
20168 arithmetic and avoided where correct operation is required and the
20169 input operand might be a NaN.  A longer sequence of instructions that
20170 manipulate the sign bit of floating-point datum manually is used
20171 instead unless the @option{-ffinite-math-only} option has also been
20172 specified.
20174 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
20175 this case these instructions are considered non-arithmetic and therefore
20176 operating correctly in all cases, including in particular where the
20177 input operand is a NaN.  These instructions are therefore always used
20178 for the respective operations.
20180 @item -mnan=2008
20181 @itemx -mnan=legacy
20182 @opindex mnan=2008
20183 @opindex mnan=legacy
20184 These options control the encoding of the special not-a-number (NaN)
20185 IEEE 754 floating-point data.
20187 The @option{-mnan=legacy} option selects the legacy encoding.  In this
20188 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
20189 significand field being 0, whereas signaling NaNs (sNaNs) are denoted
20190 by the first bit of their trailing significand field being 1.
20192 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
20193 this case qNaNs are denoted by the first bit of their trailing
20194 significand field being 1, whereas sNaNs are denoted by the first bit of
20195 their trailing significand field being 0.
20197 The default is @option{-mnan=legacy} unless GCC has been configured with
20198 @option{--with-nan=2008}.
20200 @item -mllsc
20201 @itemx -mno-llsc
20202 @opindex mllsc
20203 @opindex mno-llsc
20204 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
20205 implement atomic memory built-in functions.  When neither option is
20206 specified, GCC uses the instructions if the target architecture
20207 supports them.
20209 @option{-mllsc} is useful if the runtime environment can emulate the
20210 instructions and @option{-mno-llsc} can be useful when compiling for
20211 nonstandard ISAs.  You can make either option the default by
20212 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
20213 respectively.  @option{--with-llsc} is the default for some
20214 configurations; see the installation documentation for details.
20216 @item -mdsp
20217 @itemx -mno-dsp
20218 @opindex mdsp
20219 @opindex mno-dsp
20220 Use (do not use) revision 1 of the MIPS DSP ASE@.
20221 @xref{MIPS DSP Built-in Functions}.  This option defines the
20222 preprocessor macro @code{__mips_dsp}.  It also defines
20223 @code{__mips_dsp_rev} to 1.
20225 @item -mdspr2
20226 @itemx -mno-dspr2
20227 @opindex mdspr2
20228 @opindex mno-dspr2
20229 Use (do not use) revision 2 of the MIPS DSP ASE@.
20230 @xref{MIPS DSP Built-in Functions}.  This option defines the
20231 preprocessor macros @code{__mips_dsp} and @code{__mips_dspr2}.
20232 It also defines @code{__mips_dsp_rev} to 2.
20234 @item -msmartmips
20235 @itemx -mno-smartmips
20236 @opindex msmartmips
20237 @opindex mno-smartmips
20238 Use (do not use) the MIPS SmartMIPS ASE.
20240 @item -mpaired-single
20241 @itemx -mno-paired-single
20242 @opindex mpaired-single
20243 @opindex mno-paired-single
20244 Use (do not use) paired-single floating-point instructions.
20245 @xref{MIPS Paired-Single Support}.  This option requires
20246 hardware floating-point support to be enabled.
20248 @item -mdmx
20249 @itemx -mno-mdmx
20250 @opindex mdmx
20251 @opindex mno-mdmx
20252 Use (do not use) MIPS Digital Media Extension instructions.
20253 This option can only be used when generating 64-bit code and requires
20254 hardware floating-point support to be enabled.
20256 @item -mips3d
20257 @itemx -mno-mips3d
20258 @opindex mips3d
20259 @opindex mno-mips3d
20260 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
20261 The option @option{-mips3d} implies @option{-mpaired-single}.
20263 @item -mmicromips
20264 @itemx -mno-micromips
20265 @opindex mmicromips
20266 @opindex mno-mmicromips
20267 Generate (do not generate) microMIPS code.
20269 MicroMIPS code generation can also be controlled on a per-function basis
20270 by means of @code{micromips} and @code{nomicromips} attributes.
20271 @xref{Function Attributes}, for more information.
20273 @item -mmt
20274 @itemx -mno-mt
20275 @opindex mmt
20276 @opindex mno-mt
20277 Use (do not use) MT Multithreading instructions.
20279 @item -mmcu
20280 @itemx -mno-mcu
20281 @opindex mmcu
20282 @opindex mno-mcu
20283 Use (do not use) the MIPS MCU ASE instructions.
20285 @item -meva
20286 @itemx -mno-eva
20287 @opindex meva
20288 @opindex mno-eva
20289 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
20291 @item -mvirt
20292 @itemx -mno-virt
20293 @opindex mvirt
20294 @opindex mno-virt
20295 Use (do not use) the MIPS Virtualization (VZ) instructions.
20297 @item -mxpa
20298 @itemx -mno-xpa
20299 @opindex mxpa
20300 @opindex mno-xpa
20301 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
20303 @item -mlong64
20304 @opindex mlong64
20305 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
20306 an explanation of the default and the way that the pointer size is
20307 determined.
20309 @item -mlong32
20310 @opindex mlong32
20311 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
20313 The default size of @code{int}s, @code{long}s and pointers depends on
20314 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
20315 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
20316 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
20317 or the same size as integer registers, whichever is smaller.
20319 @item -msym32
20320 @itemx -mno-sym32
20321 @opindex msym32
20322 @opindex mno-sym32
20323 Assume (do not assume) that all symbols have 32-bit values, regardless
20324 of the selected ABI@.  This option is useful in combination with
20325 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
20326 to generate shorter and faster references to symbolic addresses.
20328 @item -G @var{num}
20329 @opindex G
20330 Put definitions of externally-visible data in a small data section
20331 if that data is no bigger than @var{num} bytes.  GCC can then generate
20332 more efficient accesses to the data; see @option{-mgpopt} for details.
20334 The default @option{-G} option depends on the configuration.
20336 @item -mlocal-sdata
20337 @itemx -mno-local-sdata
20338 @opindex mlocal-sdata
20339 @opindex mno-local-sdata
20340 Extend (do not extend) the @option{-G} behavior to local data too,
20341 such as to static variables in C@.  @option{-mlocal-sdata} is the
20342 default for all configurations.
20344 If the linker complains that an application is using too much small data,
20345 you might want to try rebuilding the less performance-critical parts with
20346 @option{-mno-local-sdata}.  You might also want to build large
20347 libraries with @option{-mno-local-sdata}, so that the libraries leave
20348 more room for the main program.
20350 @item -mextern-sdata
20351 @itemx -mno-extern-sdata
20352 @opindex mextern-sdata
20353 @opindex mno-extern-sdata
20354 Assume (do not assume) that externally-defined data is in
20355 a small data section if the size of that data is within the @option{-G} limit.
20356 @option{-mextern-sdata} is the default for all configurations.
20358 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
20359 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
20360 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
20361 is placed in a small data section.  If @var{Var} is defined by another
20362 module, you must either compile that module with a high-enough
20363 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
20364 definition.  If @var{Var} is common, you must link the application
20365 with a high-enough @option{-G} setting.
20367 The easiest way of satisfying these restrictions is to compile
20368 and link every module with the same @option{-G} option.  However,
20369 you may wish to build a library that supports several different
20370 small data limits.  You can do this by compiling the library with
20371 the highest supported @option{-G} setting and additionally using
20372 @option{-mno-extern-sdata} to stop the library from making assumptions
20373 about externally-defined data.
20375 @item -mgpopt
20376 @itemx -mno-gpopt
20377 @opindex mgpopt
20378 @opindex mno-gpopt
20379 Use (do not use) GP-relative accesses for symbols that are known to be
20380 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
20381 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
20382 configurations.
20384 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
20385 might not hold the value of @code{_gp}.  For example, if the code is
20386 part of a library that might be used in a boot monitor, programs that
20387 call boot monitor routines pass an unknown value in @code{$gp}.
20388 (In such situations, the boot monitor itself is usually compiled
20389 with @option{-G0}.)
20391 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
20392 @option{-mno-extern-sdata}.
20394 @item -membedded-data
20395 @itemx -mno-embedded-data
20396 @opindex membedded-data
20397 @opindex mno-embedded-data
20398 Allocate variables to the read-only data section first if possible, then
20399 next in the small data section if possible, otherwise in data.  This gives
20400 slightly slower code than the default, but reduces the amount of RAM required
20401 when executing, and thus may be preferred for some embedded systems.
20403 @item -muninit-const-in-rodata
20404 @itemx -mno-uninit-const-in-rodata
20405 @opindex muninit-const-in-rodata
20406 @opindex mno-uninit-const-in-rodata
20407 Put uninitialized @code{const} variables in the read-only data section.
20408 This option is only meaningful in conjunction with @option{-membedded-data}.
20410 @item -mcode-readable=@var{setting}
20411 @opindex mcode-readable
20412 Specify whether GCC may generate code that reads from executable sections.
20413 There are three possible settings:
20415 @table @gcctabopt
20416 @item -mcode-readable=yes
20417 Instructions may freely access executable sections.  This is the
20418 default setting.
20420 @item -mcode-readable=pcrel
20421 MIPS16 PC-relative load instructions can access executable sections,
20422 but other instructions must not do so.  This option is useful on 4KSc
20423 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
20424 It is also useful on processors that can be configured to have a dual
20425 instruction/data SRAM interface and that, like the M4K, automatically
20426 redirect PC-relative loads to the instruction RAM.
20428 @item -mcode-readable=no
20429 Instructions must not access executable sections.  This option can be
20430 useful on targets that are configured to have a dual instruction/data
20431 SRAM interface but that (unlike the M4K) do not automatically redirect
20432 PC-relative loads to the instruction RAM.
20433 @end table
20435 @item -msplit-addresses
20436 @itemx -mno-split-addresses
20437 @opindex msplit-addresses
20438 @opindex mno-split-addresses
20439 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
20440 relocation operators.  This option has been superseded by
20441 @option{-mexplicit-relocs} but is retained for backwards compatibility.
20443 @item -mexplicit-relocs
20444 @itemx -mno-explicit-relocs
20445 @opindex mexplicit-relocs
20446 @opindex mno-explicit-relocs
20447 Use (do not use) assembler relocation operators when dealing with symbolic
20448 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
20449 is to use assembler macros instead.
20451 @option{-mexplicit-relocs} is the default if GCC was configured
20452 to use an assembler that supports relocation operators.
20454 @item -mcheck-zero-division
20455 @itemx -mno-check-zero-division
20456 @opindex mcheck-zero-division
20457 @opindex mno-check-zero-division
20458 Trap (do not trap) on integer division by zero.
20460 The default is @option{-mcheck-zero-division}.
20462 @item -mdivide-traps
20463 @itemx -mdivide-breaks
20464 @opindex mdivide-traps
20465 @opindex mdivide-breaks
20466 MIPS systems check for division by zero by generating either a
20467 conditional trap or a break instruction.  Using traps results in
20468 smaller code, but is only supported on MIPS II and later.  Also, some
20469 versions of the Linux kernel have a bug that prevents trap from
20470 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
20471 allow conditional traps on architectures that support them and
20472 @option{-mdivide-breaks} to force the use of breaks.
20474 The default is usually @option{-mdivide-traps}, but this can be
20475 overridden at configure time using @option{--with-divide=breaks}.
20476 Divide-by-zero checks can be completely disabled using
20477 @option{-mno-check-zero-division}.
20479 @item -mload-store-pairs
20480 @itemx -mno-load-store-pairs
20481 @opindex mload-store-pairs
20482 @opindex mno-load-store-pairs
20483 Enable (disable) an optimization that pairs consecutive load or store
20484 instructions to enable load/store bonding.  This option is enabled by
20485 default but only takes effect when the selected architecture is known
20486 to support bonding.
20488 @item -mmemcpy
20489 @itemx -mno-memcpy
20490 @opindex mmemcpy
20491 @opindex mno-memcpy
20492 Force (do not force) the use of @code{memcpy} for non-trivial block
20493 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
20494 most constant-sized copies.
20496 @item -mlong-calls
20497 @itemx -mno-long-calls
20498 @opindex mlong-calls
20499 @opindex mno-long-calls
20500 Disable (do not disable) use of the @code{jal} instruction.  Calling
20501 functions using @code{jal} is more efficient but requires the caller
20502 and callee to be in the same 256 megabyte segment.
20504 This option has no effect on abicalls code.  The default is
20505 @option{-mno-long-calls}.
20507 @item -mmad
20508 @itemx -mno-mad
20509 @opindex mmad
20510 @opindex mno-mad
20511 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
20512 instructions, as provided by the R4650 ISA@.
20514 @item -mimadd
20515 @itemx -mno-imadd
20516 @opindex mimadd
20517 @opindex mno-imadd
20518 Enable (disable) use of the @code{madd} and @code{msub} integer
20519 instructions.  The default is @option{-mimadd} on architectures
20520 that support @code{madd} and @code{msub} except for the 74k 
20521 architecture where it was found to generate slower code.
20523 @item -mfused-madd
20524 @itemx -mno-fused-madd
20525 @opindex mfused-madd
20526 @opindex mno-fused-madd
20527 Enable (disable) use of the floating-point multiply-accumulate
20528 instructions, when they are available.  The default is
20529 @option{-mfused-madd}.
20531 On the R8000 CPU when multiply-accumulate instructions are used,
20532 the intermediate product is calculated to infinite precision
20533 and is not subject to the FCSR Flush to Zero bit.  This may be
20534 undesirable in some circumstances.  On other processors the result
20535 is numerically identical to the equivalent computation using
20536 separate multiply, add, subtract and negate instructions.
20538 @item -nocpp
20539 @opindex nocpp
20540 Tell the MIPS assembler to not run its preprocessor over user
20541 assembler files (with a @samp{.s} suffix) when assembling them.
20543 @item -mfix-24k
20544 @item -mno-fix-24k
20545 @opindex mfix-24k
20546 @opindex mno-fix-24k
20547 Work around the 24K E48 (lost data on stores during refill) errata.
20548 The workarounds are implemented by the assembler rather than by GCC@.
20550 @item -mfix-r4000
20551 @itemx -mno-fix-r4000
20552 @opindex mfix-r4000
20553 @opindex mno-fix-r4000
20554 Work around certain R4000 CPU errata:
20555 @itemize @minus
20556 @item
20557 A double-word or a variable shift may give an incorrect result if executed
20558 immediately after starting an integer division.
20559 @item
20560 A double-word or a variable shift may give an incorrect result if executed
20561 while an integer multiplication is in progress.
20562 @item
20563 An integer division may give an incorrect result if started in a delay slot
20564 of a taken branch or a jump.
20565 @end itemize
20567 @item -mfix-r4400
20568 @itemx -mno-fix-r4400
20569 @opindex mfix-r4400
20570 @opindex mno-fix-r4400
20571 Work around certain R4400 CPU errata:
20572 @itemize @minus
20573 @item
20574 A double-word or a variable shift may give an incorrect result if executed
20575 immediately after starting an integer division.
20576 @end itemize
20578 @item -mfix-r10000
20579 @itemx -mno-fix-r10000
20580 @opindex mfix-r10000
20581 @opindex mno-fix-r10000
20582 Work around certain R10000 errata:
20583 @itemize @minus
20584 @item
20585 @code{ll}/@code{sc} sequences may not behave atomically on revisions
20586 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
20587 @end itemize
20589 This option can only be used if the target architecture supports
20590 branch-likely instructions.  @option{-mfix-r10000} is the default when
20591 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
20592 otherwise.
20594 @item -mfix-rm7000
20595 @itemx -mno-fix-rm7000
20596 @opindex mfix-rm7000
20597 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
20598 workarounds are implemented by the assembler rather than by GCC@.
20600 @item -mfix-vr4120
20601 @itemx -mno-fix-vr4120
20602 @opindex mfix-vr4120
20603 Work around certain VR4120 errata:
20604 @itemize @minus
20605 @item
20606 @code{dmultu} does not always produce the correct result.
20607 @item
20608 @code{div} and @code{ddiv} do not always produce the correct result if one
20609 of the operands is negative.
20610 @end itemize
20611 The workarounds for the division errata rely on special functions in
20612 @file{libgcc.a}.  At present, these functions are only provided by
20613 the @code{mips64vr*-elf} configurations.
20615 Other VR4120 errata require a NOP to be inserted between certain pairs of
20616 instructions.  These errata are handled by the assembler, not by GCC itself.
20618 @item -mfix-vr4130
20619 @opindex mfix-vr4130
20620 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
20621 workarounds are implemented by the assembler rather than by GCC,
20622 although GCC avoids using @code{mflo} and @code{mfhi} if the
20623 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
20624 instructions are available instead.
20626 @item -mfix-sb1
20627 @itemx -mno-fix-sb1
20628 @opindex mfix-sb1
20629 Work around certain SB-1 CPU core errata.
20630 (This flag currently works around the SB-1 revision 2
20631 ``F1'' and ``F2'' floating-point errata.)
20633 @item -mr10k-cache-barrier=@var{setting}
20634 @opindex mr10k-cache-barrier
20635 Specify whether GCC should insert cache barriers to avoid the
20636 side-effects of speculation on R10K processors.
20638 In common with many processors, the R10K tries to predict the outcome
20639 of a conditional branch and speculatively executes instructions from
20640 the ``taken'' branch.  It later aborts these instructions if the
20641 predicted outcome is wrong.  However, on the R10K, even aborted
20642 instructions can have side effects.
20644 This problem only affects kernel stores and, depending on the system,
20645 kernel loads.  As an example, a speculatively-executed store may load
20646 the target memory into cache and mark the cache line as dirty, even if
20647 the store itself is later aborted.  If a DMA operation writes to the
20648 same area of memory before the ``dirty'' line is flushed, the cached
20649 data overwrites the DMA-ed data.  See the R10K processor manual
20650 for a full description, including other potential problems.
20652 One workaround is to insert cache barrier instructions before every memory
20653 access that might be speculatively executed and that might have side
20654 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
20655 controls GCC's implementation of this workaround.  It assumes that
20656 aborted accesses to any byte in the following regions does not have
20657 side effects:
20659 @enumerate
20660 @item
20661 the memory occupied by the current function's stack frame;
20663 @item
20664 the memory occupied by an incoming stack argument;
20666 @item
20667 the memory occupied by an object with a link-time-constant address.
20668 @end enumerate
20670 It is the kernel's responsibility to ensure that speculative
20671 accesses to these regions are indeed safe.
20673 If the input program contains a function declaration such as:
20675 @smallexample
20676 void foo (void);
20677 @end smallexample
20679 then the implementation of @code{foo} must allow @code{j foo} and
20680 @code{jal foo} to be executed speculatively.  GCC honors this
20681 restriction for functions it compiles itself.  It expects non-GCC
20682 functions (such as hand-written assembly code) to do the same.
20684 The option has three forms:
20686 @table @gcctabopt
20687 @item -mr10k-cache-barrier=load-store
20688 Insert a cache barrier before a load or store that might be
20689 speculatively executed and that might have side effects even
20690 if aborted.
20692 @item -mr10k-cache-barrier=store
20693 Insert a cache barrier before a store that might be speculatively
20694 executed and that might have side effects even if aborted.
20696 @item -mr10k-cache-barrier=none
20697 Disable the insertion of cache barriers.  This is the default setting.
20698 @end table
20700 @item -mflush-func=@var{func}
20701 @itemx -mno-flush-func
20702 @opindex mflush-func
20703 Specifies the function to call to flush the I and D caches, or to not
20704 call any such function.  If called, the function must take the same
20705 arguments as the common @code{_flush_func}, that is, the address of the
20706 memory range for which the cache is being flushed, the size of the
20707 memory range, and the number 3 (to flush both caches).  The default
20708 depends on the target GCC was configured for, but commonly is either
20709 @code{_flush_func} or @code{__cpu_flush}.
20711 @item mbranch-cost=@var{num}
20712 @opindex mbranch-cost
20713 Set the cost of branches to roughly @var{num} ``simple'' instructions.
20714 This cost is only a heuristic and is not guaranteed to produce
20715 consistent results across releases.  A zero cost redundantly selects
20716 the default, which is based on the @option{-mtune} setting.
20718 @item -mbranch-likely
20719 @itemx -mno-branch-likely
20720 @opindex mbranch-likely
20721 @opindex mno-branch-likely
20722 Enable or disable use of Branch Likely instructions, regardless of the
20723 default for the selected architecture.  By default, Branch Likely
20724 instructions may be generated if they are supported by the selected
20725 architecture.  An exception is for the MIPS32 and MIPS64 architectures
20726 and processors that implement those architectures; for those, Branch
20727 Likely instructions are not be generated by default because the MIPS32
20728 and MIPS64 architectures specifically deprecate their use.
20730 @item -mcompact-branches=never
20731 @itemx -mcompact-branches=optimal
20732 @itemx -mcompact-branches=always
20733 @opindex mcompact-branches=never
20734 @opindex mcompact-branches=optimal
20735 @opindex mcompact-branches=always
20736 These options control which form of branches will be generated.  The
20737 default is @option{-mcompact-branches=optimal}.
20739 The @option{-mcompact-branches=never} option ensures that compact branch
20740 instructions will never be generated.
20742 The @option{-mcompact-branches=always} option ensures that a compact
20743 branch instruction will be generated if available.  If a compact branch
20744 instruction is not available, a delay slot form of the branch will be
20745 used instead.
20747 This option is supported from MIPS Release 6 onwards.
20749 The @option{-mcompact-branches=optimal} option will cause a delay slot
20750 branch to be used if one is available in the current ISA and the delay
20751 slot is successfully filled.  If the delay slot is not filled, a compact
20752 branch will be chosen if one is available.
20754 @item -mfp-exceptions
20755 @itemx -mno-fp-exceptions
20756 @opindex mfp-exceptions
20757 Specifies whether FP exceptions are enabled.  This affects how
20758 FP instructions are scheduled for some processors.
20759 The default is that FP exceptions are
20760 enabled.
20762 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
20763 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
20764 FP pipe.
20766 @item -mvr4130-align
20767 @itemx -mno-vr4130-align
20768 @opindex mvr4130-align
20769 The VR4130 pipeline is two-way superscalar, but can only issue two
20770 instructions together if the first one is 8-byte aligned.  When this
20771 option is enabled, GCC aligns pairs of instructions that it
20772 thinks should execute in parallel.
20774 This option only has an effect when optimizing for the VR4130.
20775 It normally makes code faster, but at the expense of making it bigger.
20776 It is enabled by default at optimization level @option{-O3}.
20778 @item -msynci
20779 @itemx -mno-synci
20780 @opindex msynci
20781 Enable (disable) generation of @code{synci} instructions on
20782 architectures that support it.  The @code{synci} instructions (if
20783 enabled) are generated when @code{__builtin___clear_cache} is
20784 compiled.
20786 This option defaults to @option{-mno-synci}, but the default can be
20787 overridden by configuring GCC with @option{--with-synci}.
20789 When compiling code for single processor systems, it is generally safe
20790 to use @code{synci}.  However, on many multi-core (SMP) systems, it
20791 does not invalidate the instruction caches on all cores and may lead
20792 to undefined behavior.
20794 @item -mrelax-pic-calls
20795 @itemx -mno-relax-pic-calls
20796 @opindex mrelax-pic-calls
20797 Try to turn PIC calls that are normally dispatched via register
20798 @code{$25} into direct calls.  This is only possible if the linker can
20799 resolve the destination at link time and if the destination is within
20800 range for a direct call.
20802 @option{-mrelax-pic-calls} is the default if GCC was configured to use
20803 an assembler and a linker that support the @code{.reloc} assembly
20804 directive and @option{-mexplicit-relocs} is in effect.  With
20805 @option{-mno-explicit-relocs}, this optimization can be performed by the
20806 assembler and the linker alone without help from the compiler.
20808 @item -mmcount-ra-address
20809 @itemx -mno-mcount-ra-address
20810 @opindex mmcount-ra-address
20811 @opindex mno-mcount-ra-address
20812 Emit (do not emit) code that allows @code{_mcount} to modify the
20813 calling function's return address.  When enabled, this option extends
20814 the usual @code{_mcount} interface with a new @var{ra-address}
20815 parameter, which has type @code{intptr_t *} and is passed in register
20816 @code{$12}.  @code{_mcount} can then modify the return address by
20817 doing both of the following:
20818 @itemize
20819 @item
20820 Returning the new address in register @code{$31}.
20821 @item
20822 Storing the new address in @code{*@var{ra-address}},
20823 if @var{ra-address} is nonnull.
20824 @end itemize
20826 The default is @option{-mno-mcount-ra-address}.
20828 @item -mframe-header-opt
20829 @itemx -mno-frame-header-opt
20830 @opindex mframe-header-opt
20831 Enable (disable) frame header optimization in the o32 ABI.  When using the
20832 o32 ABI, calling functions will allocate 16 bytes on the stack for the called
20833 function to write out register arguments.  When enabled, this optimization
20834 will suppress the allocation of the frame header if it can be determined that
20835 it is unused.
20837 This optimization is off by default at all optimization levels.
20839 @item -mlxc1-sxc1
20840 @itemx -mno-lxc1-sxc1
20841 @opindex mlxc1-sxc1
20842 When applicable, enable (disable) the generation of @code{lwxc1},
20843 @code{swxc1}, @code{ldxc1}, @code{sdxc1} instructions.  Enabled by default.
20845 @item -mmadd4
20846 @itemx -mno-madd4
20847 @opindex mmadd4
20848 When applicable, enable (disable) the generation of 4-operand @code{madd.s},
20849 @code{madd.d} and related instructions.  Enabled by default.
20851 @end table
20853 @node MMIX Options
20854 @subsection MMIX Options
20855 @cindex MMIX Options
20857 These options are defined for the MMIX:
20859 @table @gcctabopt
20860 @item -mlibfuncs
20861 @itemx -mno-libfuncs
20862 @opindex mlibfuncs
20863 @opindex mno-libfuncs
20864 Specify that intrinsic library functions are being compiled, passing all
20865 values in registers, no matter the size.
20867 @item -mepsilon
20868 @itemx -mno-epsilon
20869 @opindex mepsilon
20870 @opindex mno-epsilon
20871 Generate floating-point comparison instructions that compare with respect
20872 to the @code{rE} epsilon register.
20874 @item -mabi=mmixware
20875 @itemx -mabi=gnu
20876 @opindex mabi=mmixware
20877 @opindex mabi=gnu
20878 Generate code that passes function parameters and return values that (in
20879 the called function) are seen as registers @code{$0} and up, as opposed to
20880 the GNU ABI which uses global registers @code{$231} and up.
20882 @item -mzero-extend
20883 @itemx -mno-zero-extend
20884 @opindex mzero-extend
20885 @opindex mno-zero-extend
20886 When reading data from memory in sizes shorter than 64 bits, use (do not
20887 use) zero-extending load instructions by default, rather than
20888 sign-extending ones.
20890 @item -mknuthdiv
20891 @itemx -mno-knuthdiv
20892 @opindex mknuthdiv
20893 @opindex mno-knuthdiv
20894 Make the result of a division yielding a remainder have the same sign as
20895 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
20896 remainder follows the sign of the dividend.  Both methods are
20897 arithmetically valid, the latter being almost exclusively used.
20899 @item -mtoplevel-symbols
20900 @itemx -mno-toplevel-symbols
20901 @opindex mtoplevel-symbols
20902 @opindex mno-toplevel-symbols
20903 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
20904 code can be used with the @code{PREFIX} assembly directive.
20906 @item -melf
20907 @opindex melf
20908 Generate an executable in the ELF format, rather than the default
20909 @samp{mmo} format used by the @command{mmix} simulator.
20911 @item -mbranch-predict
20912 @itemx -mno-branch-predict
20913 @opindex mbranch-predict
20914 @opindex mno-branch-predict
20915 Use (do not use) the probable-branch instructions, when static branch
20916 prediction indicates a probable branch.
20918 @item -mbase-addresses
20919 @itemx -mno-base-addresses
20920 @opindex mbase-addresses
20921 @opindex mno-base-addresses
20922 Generate (do not generate) code that uses @emph{base addresses}.  Using a
20923 base address automatically generates a request (handled by the assembler
20924 and the linker) for a constant to be set up in a global register.  The
20925 register is used for one or more base address requests within the range 0
20926 to 255 from the value held in the register.  The generally leads to short
20927 and fast code, but the number of different data items that can be
20928 addressed is limited.  This means that a program that uses lots of static
20929 data may require @option{-mno-base-addresses}.
20931 @item -msingle-exit
20932 @itemx -mno-single-exit
20933 @opindex msingle-exit
20934 @opindex mno-single-exit
20935 Force (do not force) generated code to have a single exit point in each
20936 function.
20937 @end table
20939 @node MN10300 Options
20940 @subsection MN10300 Options
20941 @cindex MN10300 options
20943 These @option{-m} options are defined for Matsushita MN10300 architectures:
20945 @table @gcctabopt
20946 @item -mmult-bug
20947 @opindex mmult-bug
20948 Generate code to avoid bugs in the multiply instructions for the MN10300
20949 processors.  This is the default.
20951 @item -mno-mult-bug
20952 @opindex mno-mult-bug
20953 Do not generate code to avoid bugs in the multiply instructions for the
20954 MN10300 processors.
20956 @item -mam33
20957 @opindex mam33
20958 Generate code using features specific to the AM33 processor.
20960 @item -mno-am33
20961 @opindex mno-am33
20962 Do not generate code using features specific to the AM33 processor.  This
20963 is the default.
20965 @item -mam33-2
20966 @opindex mam33-2
20967 Generate code using features specific to the AM33/2.0 processor.
20969 @item -mam34
20970 @opindex mam34
20971 Generate code using features specific to the AM34 processor.
20973 @item -mtune=@var{cpu-type}
20974 @opindex mtune
20975 Use the timing characteristics of the indicated CPU type when
20976 scheduling instructions.  This does not change the targeted processor
20977 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
20978 @samp{am33-2} or @samp{am34}.
20980 @item -mreturn-pointer-on-d0
20981 @opindex mreturn-pointer-on-d0
20982 When generating a function that returns a pointer, return the pointer
20983 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
20984 only in @code{a0}, and attempts to call such functions without a prototype
20985 result in errors.  Note that this option is on by default; use
20986 @option{-mno-return-pointer-on-d0} to disable it.
20988 @item -mno-crt0
20989 @opindex mno-crt0
20990 Do not link in the C run-time initialization object file.
20992 @item -mrelax
20993 @opindex mrelax
20994 Indicate to the linker that it should perform a relaxation optimization pass
20995 to shorten branches, calls and absolute memory addresses.  This option only
20996 has an effect when used on the command line for the final link step.
20998 This option makes symbolic debugging impossible.
21000 @item -mliw
21001 @opindex mliw
21002 Allow the compiler to generate @emph{Long Instruction Word}
21003 instructions if the target is the @samp{AM33} or later.  This is the
21004 default.  This option defines the preprocessor macro @code{__LIW__}.
21006 @item -mnoliw
21007 @opindex mnoliw
21008 Do not allow the compiler to generate @emph{Long Instruction Word}
21009 instructions.  This option defines the preprocessor macro
21010 @code{__NO_LIW__}.
21012 @item -msetlb
21013 @opindex msetlb
21014 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
21015 instructions if the target is the @samp{AM33} or later.  This is the
21016 default.  This option defines the preprocessor macro @code{__SETLB__}.
21018 @item -mnosetlb
21019 @opindex mnosetlb
21020 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
21021 instructions.  This option defines the preprocessor macro
21022 @code{__NO_SETLB__}.
21024 @end table
21026 @node Moxie Options
21027 @subsection Moxie Options
21028 @cindex Moxie Options
21030 @table @gcctabopt
21032 @item -meb
21033 @opindex meb
21034 Generate big-endian code.  This is the default for @samp{moxie-*-*}
21035 configurations.
21037 @item -mel
21038 @opindex mel
21039 Generate little-endian code.
21041 @item -mmul.x
21042 @opindex mmul.x
21043 Generate mul.x and umul.x instructions.  This is the default for
21044 @samp{moxiebox-*-*} configurations.
21046 @item -mno-crt0
21047 @opindex mno-crt0
21048 Do not link in the C run-time initialization object file.
21050 @end table
21052 @node MSP430 Options
21053 @subsection MSP430 Options
21054 @cindex MSP430 Options
21056 These options are defined for the MSP430:
21058 @table @gcctabopt
21060 @item -masm-hex
21061 @opindex masm-hex
21062 Force assembly output to always use hex constants.  Normally such
21063 constants are signed decimals, but this option is available for
21064 testsuite and/or aesthetic purposes.
21066 @item -mmcu=
21067 @opindex mmcu=
21068 Select the MCU to target.  This is used to create a C preprocessor
21069 symbol based upon the MCU name, converted to upper case and pre- and
21070 post-fixed with @samp{__}.  This in turn is used by the
21071 @file{msp430.h} header file to select an MCU-specific supplementary
21072 header file.
21074 The option also sets the ISA to use.  If the MCU name is one that is
21075 known to only support the 430 ISA then that is selected, otherwise the
21076 430X ISA is selected.  A generic MCU name of @samp{msp430} can also be
21077 used to select the 430 ISA.  Similarly the generic @samp{msp430x} MCU
21078 name selects the 430X ISA.
21080 In addition an MCU-specific linker script is added to the linker
21081 command line.  The script's name is the name of the MCU with
21082 @file{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the @command{gcc}
21083 command line defines the C preprocessor symbol @code{__XXX__} and
21084 cause the linker to search for a script called @file{xxx.ld}.
21086 This option is also passed on to the assembler.
21088 @item -mwarn-mcu
21089 @itemx -mno-warn-mcu
21090 @opindex mwarn-mcu
21091 @opindex mno-warn-mcu
21092 This option enables or disables warnings about conflicts between the
21093 MCU name specified by the @option{-mmcu} option and the ISA set by the
21094 @option{-mcpu} option and/or the hardware multiply support set by the
21095 @option{-mhwmult} option.  It also toggles warnings about unrecognized
21096 MCU names.  This option is on by default.
21098 @item -mcpu=
21099 @opindex mcpu=
21100 Specifies the ISA to use.  Accepted values are @samp{msp430},
21101 @samp{msp430x} and @samp{msp430xv2}.  This option is deprecated.  The
21102 @option{-mmcu=} option should be used to select the ISA.
21104 @item -msim
21105 @opindex msim
21106 Link to the simulator runtime libraries and linker script.  Overrides
21107 any scripts that would be selected by the @option{-mmcu=} option.
21109 @item -mlarge
21110 @opindex mlarge
21111 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
21113 @item -msmall
21114 @opindex msmall
21115 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
21117 @item -mrelax
21118 @opindex mrelax
21119 This option is passed to the assembler and linker, and allows the
21120 linker to perform certain optimizations that cannot be done until
21121 the final link.
21123 @item mhwmult=
21124 @opindex mhwmult=
21125 Describes the type of hardware multiply supported by the target.
21126 Accepted values are @samp{none} for no hardware multiply, @samp{16bit}
21127 for the original 16-bit-only multiply supported by early MCUs.
21128 @samp{32bit} for the 16/32-bit multiply supported by later MCUs and
21129 @samp{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
21130 A value of @samp{auto} can also be given.  This tells GCC to deduce
21131 the hardware multiply support based upon the MCU name provided by the
21132 @option{-mmcu} option.  If no @option{-mmcu} option is specified or if
21133 the MCU name is not recognized then no hardware multiply support is
21134 assumed.  @code{auto} is the default setting.
21136 Hardware multiplies are normally performed by calling a library
21137 routine.  This saves space in the generated code.  When compiling at
21138 @option{-O3} or higher however the hardware multiplier is invoked
21139 inline.  This makes for bigger, but faster code.
21141 The hardware multiply routines disable interrupts whilst running and
21142 restore the previous interrupt state when they finish.  This makes
21143 them safe to use inside interrupt handlers as well as in normal code.
21145 @item -minrt
21146 @opindex minrt
21147 Enable the use of a minimum runtime environment - no static
21148 initializers or constructors.  This is intended for memory-constrained
21149 devices.  The compiler includes special symbols in some objects
21150 that tell the linker and runtime which code fragments are required.
21152 @item -mcode-region=
21153 @itemx -mdata-region=
21154 @opindex mcode-region
21155 @opindex mdata-region
21156 These options tell the compiler where to place functions and data that
21157 do not have one of the @code{lower}, @code{upper}, @code{either} or
21158 @code{section} attributes.  Possible values are @code{lower},
21159 @code{upper}, @code{either} or @code{any}.  The first three behave
21160 like the corresponding attribute.  The fourth possible value -
21161 @code{any} - is the default.  It leaves placement entirely up to the
21162 linker script and how it assigns the standard sections
21163 (@code{.text}, @code{.data}, etc) to the memory regions.
21165 @item -msilicon-errata=
21166 @opindex msilicon-errata
21167 This option passes on a request to assembler to enable the fixes for
21168 the named silicon errata.
21170 @item -msilicon-errata-warn=
21171 @opindex msilicon-errata-warn
21172 This option passes on a request to the assembler to enable warning
21173 messages when a silicon errata might need to be applied.
21175 @end table
21177 @node NDS32 Options
21178 @subsection NDS32 Options
21179 @cindex NDS32 Options
21181 These options are defined for NDS32 implementations:
21183 @table @gcctabopt
21185 @item -mbig-endian
21186 @opindex mbig-endian
21187 Generate code in big-endian mode.
21189 @item -mlittle-endian
21190 @opindex mlittle-endian
21191 Generate code in little-endian mode.
21193 @item -mreduced-regs
21194 @opindex mreduced-regs
21195 Use reduced-set registers for register allocation.
21197 @item -mfull-regs
21198 @opindex mfull-regs
21199 Use full-set registers for register allocation.
21201 @item -mcmov
21202 @opindex mcmov
21203 Generate conditional move instructions.
21205 @item -mno-cmov
21206 @opindex mno-cmov
21207 Do not generate conditional move instructions.
21209 @item -mperf-ext
21210 @opindex mperf-ext
21211 Generate performance extension instructions.
21213 @item -mno-perf-ext
21214 @opindex mno-perf-ext
21215 Do not generate performance extension instructions.
21217 @item -mv3push
21218 @opindex mv3push
21219 Generate v3 push25/pop25 instructions.
21221 @item -mno-v3push
21222 @opindex mno-v3push
21223 Do not generate v3 push25/pop25 instructions.
21225 @item -m16-bit
21226 @opindex m16-bit
21227 Generate 16-bit instructions.
21229 @item -mno-16-bit
21230 @opindex mno-16-bit
21231 Do not generate 16-bit instructions.
21233 @item -misr-vector-size=@var{num}
21234 @opindex misr-vector-size
21235 Specify the size of each interrupt vector, which must be 4 or 16.
21237 @item -mcache-block-size=@var{num}
21238 @opindex mcache-block-size
21239 Specify the size of each cache block,
21240 which must be a power of 2 between 4 and 512.
21242 @item -march=@var{arch}
21243 @opindex march
21244 Specify the name of the target architecture.
21246 @item -mcmodel=@var{code-model}
21247 @opindex mcmodel
21248 Set the code model to one of
21249 @table @asis
21250 @item @samp{small}
21251 All the data and read-only data segments must be within 512KB addressing space.
21252 The text segment must be within 16MB addressing space.
21253 @item @samp{medium}
21254 The data segment must be within 512KB while the read-only data segment can be
21255 within 4GB addressing space.  The text segment should be still within 16MB
21256 addressing space.
21257 @item @samp{large}
21258 All the text and data segments can be within 4GB addressing space.
21259 @end table
21261 @item -mctor-dtor
21262 @opindex mctor-dtor
21263 Enable constructor/destructor feature.
21265 @item -mrelax
21266 @opindex mrelax
21267 Guide linker to relax instructions.
21269 @end table
21271 @node Nios II Options
21272 @subsection Nios II Options
21273 @cindex Nios II options
21274 @cindex Altera Nios II options
21276 These are the options defined for the Altera Nios II processor.
21278 @table @gcctabopt
21280 @item -G @var{num}
21281 @opindex G
21282 @cindex smaller data references
21283 Put global and static objects less than or equal to @var{num} bytes
21284 into the small data or BSS sections instead of the normal data or BSS
21285 sections.  The default value of @var{num} is 8.
21287 @item -mgpopt=@var{option}
21288 @item -mgpopt
21289 @itemx -mno-gpopt
21290 @opindex mgpopt
21291 @opindex mno-gpopt
21292 Generate (do not generate) GP-relative accesses.  The following 
21293 @var{option} names are recognized:
21295 @table @samp
21297 @item none
21298 Do not generate GP-relative accesses.
21300 @item local
21301 Generate GP-relative accesses for small data objects that are not 
21302 external, weak, or uninitialized common symbols.  
21303 Also use GP-relative addressing for objects that
21304 have been explicitly placed in a small data section via a @code{section}
21305 attribute.
21307 @item global
21308 As for @samp{local}, but also generate GP-relative accesses for
21309 small data objects that are external, weak, or common.  If you use this option,
21310 you must ensure that all parts of your program (including libraries) are
21311 compiled with the same @option{-G} setting.
21313 @item data
21314 Generate GP-relative accesses for all data objects in the program.  If you
21315 use this option, the entire data and BSS segments
21316 of your program must fit in 64K of memory and you must use an appropriate
21317 linker script to allocate them within the addressable range of the
21318 global pointer.
21320 @item all
21321 Generate GP-relative addresses for function pointers as well as data
21322 pointers.  If you use this option, the entire text, data, and BSS segments
21323 of your program must fit in 64K of memory and you must use an appropriate
21324 linker script to allocate them within the addressable range of the
21325 global pointer.
21327 @end table
21329 @option{-mgpopt} is equivalent to @option{-mgpopt=local}, and
21330 @option{-mno-gpopt} is equivalent to @option{-mgpopt=none}.
21332 The default is @option{-mgpopt} except when @option{-fpic} or
21333 @option{-fPIC} is specified to generate position-independent code.
21334 Note that the Nios II ABI does not permit GP-relative accesses from
21335 shared libraries.
21337 You may need to specify @option{-mno-gpopt} explicitly when building
21338 programs that include large amounts of small data, including large
21339 GOT data sections.  In this case, the 16-bit offset for GP-relative
21340 addressing may not be large enough to allow access to the entire 
21341 small data section.
21343 @item -mgprel-sec=@var{regexp}
21344 @opindex mgprel-sec
21345 This option specifies additional section names that can be accessed via
21346 GP-relative addressing.  It is most useful in conjunction with 
21347 @code{section} attributes on variable declarations 
21348 (@pxref{Common Variable Attributes}) and a custom linker script.  
21349 The @var{regexp} is a POSIX Extended Regular Expression.
21351 This option does not affect the behavior of the @option{-G} option, and 
21352 and the specified sections are in addition to the standard @code{.sdata} 
21353 and @code{.sbss} small-data sections that are recognized by @option{-mgpopt}.
21355 @item -mr0rel-sec=@var{regexp}
21356 @opindex mr0rel-sec
21357 This option specifies names of sections that can be accessed via a 
21358 16-bit offset from @code{r0}; that is, in the low 32K or high 32K 
21359 of the 32-bit address space.  It is most useful in conjunction with 
21360 @code{section} attributes on variable declarations 
21361 (@pxref{Common Variable Attributes}) and a custom linker script.  
21362 The @var{regexp} is a POSIX Extended Regular Expression.
21364 In contrast to the use of GP-relative addressing for small data, 
21365 zero-based addressing is never generated by default and there are no 
21366 conventional section names used in standard linker scripts for sections
21367 in the low or high areas of memory.
21369 @item -mel
21370 @itemx -meb
21371 @opindex mel
21372 @opindex meb
21373 Generate little-endian (default) or big-endian (experimental) code,
21374 respectively.
21376 @item -march=@var{arch}
21377 @opindex march
21378 This specifies the name of the target Nios II architecture.  GCC uses this
21379 name to determine what kind of instructions it can emit when generating
21380 assembly code.  Permissible names are: @samp{r1}, @samp{r2}.
21382 The preprocessor macro @code{__nios2_arch__} is available to programs,
21383 with value 1 or 2, indicating the targeted ISA level.
21385 @item -mbypass-cache
21386 @itemx -mno-bypass-cache
21387 @opindex mno-bypass-cache
21388 @opindex mbypass-cache
21389 Force all load and store instructions to always bypass cache by 
21390 using I/O variants of the instructions. The default is not to
21391 bypass the cache.
21393 @item -mno-cache-volatile 
21394 @itemx -mcache-volatile       
21395 @opindex mcache-volatile 
21396 @opindex mno-cache-volatile
21397 Volatile memory access bypass the cache using the I/O variants of 
21398 the load and store instructions. The default is not to bypass the cache.
21400 @item -mno-fast-sw-div
21401 @itemx -mfast-sw-div
21402 @opindex mno-fast-sw-div
21403 @opindex mfast-sw-div
21404 Do not use table-based fast divide for small numbers. The default 
21405 is to use the fast divide at @option{-O3} and above.
21407 @item -mno-hw-mul
21408 @itemx -mhw-mul
21409 @itemx -mno-hw-mulx
21410 @itemx -mhw-mulx
21411 @itemx -mno-hw-div
21412 @itemx -mhw-div
21413 @opindex mno-hw-mul
21414 @opindex mhw-mul
21415 @opindex mno-hw-mulx
21416 @opindex mhw-mulx
21417 @opindex mno-hw-div
21418 @opindex mhw-div
21419 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
21420 instructions by the compiler. The default is to emit @code{mul}
21421 and not emit @code{div} and @code{mulx}.
21423 @item -mbmx
21424 @itemx -mno-bmx
21425 @itemx -mcdx
21426 @itemx -mno-cdx
21427 Enable or disable generation of Nios II R2 BMX (bit manipulation) and
21428 CDX (code density) instructions.  Enabling these instructions also
21429 requires @option{-march=r2}.  Since these instructions are optional
21430 extensions to the R2 architecture, the default is not to emit them.
21432 @item -mcustom-@var{insn}=@var{N}
21433 @itemx -mno-custom-@var{insn}
21434 @opindex mcustom-@var{insn}
21435 @opindex mno-custom-@var{insn}
21436 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
21437 custom instruction with encoding @var{N} when generating code that uses 
21438 @var{insn}.  For example, @option{-mcustom-fadds=253} generates custom
21439 instruction 253 for single-precision floating-point add operations instead
21440 of the default behavior of using a library call.
21442 The following values of @var{insn} are supported.  Except as otherwise
21443 noted, floating-point operations are expected to be implemented with
21444 normal IEEE 754 semantics and correspond directly to the C operators or the
21445 equivalent GCC built-in functions (@pxref{Other Builtins}).
21447 Single-precision floating point:
21448 @table @asis
21450 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
21451 Binary arithmetic operations.
21453 @item @samp{fnegs}
21454 Unary negation.
21456 @item @samp{fabss}
21457 Unary absolute value.
21459 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
21460 Comparison operations.
21462 @item @samp{fmins}, @samp{fmaxs}
21463 Floating-point minimum and maximum.  These instructions are only
21464 generated if @option{-ffinite-math-only} is specified.
21466 @item @samp{fsqrts}
21467 Unary square root operation.
21469 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
21470 Floating-point trigonometric and exponential functions.  These instructions
21471 are only generated if @option{-funsafe-math-optimizations} is also specified.
21473 @end table
21475 Double-precision floating point:
21476 @table @asis
21478 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
21479 Binary arithmetic operations.
21481 @item @samp{fnegd}
21482 Unary negation.
21484 @item @samp{fabsd}
21485 Unary absolute value.
21487 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
21488 Comparison operations.
21490 @item @samp{fmind}, @samp{fmaxd}
21491 Double-precision minimum and maximum.  These instructions are only
21492 generated if @option{-ffinite-math-only} is specified.
21494 @item @samp{fsqrtd}
21495 Unary square root operation.
21497 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
21498 Double-precision trigonometric and exponential functions.  These instructions
21499 are only generated if @option{-funsafe-math-optimizations} is also specified.
21501 @end table
21503 Conversions:
21504 @table @asis
21505 @item @samp{fextsd}
21506 Conversion from single precision to double precision.
21508 @item @samp{ftruncds}
21509 Conversion from double precision to single precision.
21511 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
21512 Conversion from floating point to signed or unsigned integer types, with
21513 truncation towards zero.
21515 @item @samp{round}
21516 Conversion from single-precision floating point to signed integer,
21517 rounding to the nearest integer and ties away from zero.
21518 This corresponds to the @code{__builtin_lroundf} function when
21519 @option{-fno-math-errno} is used.
21521 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
21522 Conversion from signed or unsigned integer types to floating-point types.
21524 @end table
21526 In addition, all of the following transfer instructions for internal
21527 registers X and Y must be provided to use any of the double-precision
21528 floating-point instructions.  Custom instructions taking two
21529 double-precision source operands expect the first operand in the
21530 64-bit register X.  The other operand (or only operand of a unary
21531 operation) is given to the custom arithmetic instruction with the
21532 least significant half in source register @var{src1} and the most
21533 significant half in @var{src2}.  A custom instruction that returns a
21534 double-precision result returns the most significant 32 bits in the
21535 destination register and the other half in 32-bit register Y.  
21536 GCC automatically generates the necessary code sequences to write
21537 register X and/or read register Y when double-precision floating-point
21538 instructions are used.
21540 @table @asis
21542 @item @samp{fwrx}
21543 Write @var{src1} into the least significant half of X and @var{src2} into
21544 the most significant half of X.
21546 @item @samp{fwry}
21547 Write @var{src1} into Y.
21549 @item @samp{frdxhi}, @samp{frdxlo}
21550 Read the most or least (respectively) significant half of X and store it in
21551 @var{dest}.
21553 @item @samp{frdy}
21554 Read the value of Y and store it into @var{dest}.
21555 @end table
21557 Note that you can gain more local control over generation of Nios II custom
21558 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
21559 and @code{target("no-custom-@var{insn}")} function attributes
21560 (@pxref{Function Attributes})
21561 or pragmas (@pxref{Function Specific Option Pragmas}).
21563 @item -mcustom-fpu-cfg=@var{name}
21564 @opindex mcustom-fpu-cfg
21566 This option enables a predefined, named set of custom instruction encodings
21567 (see @option{-mcustom-@var{insn}} above).  
21568 Currently, the following sets are defined:
21570 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
21571 @gccoptlist{-mcustom-fmuls=252 @gol
21572 -mcustom-fadds=253 @gol
21573 -mcustom-fsubs=254 @gol
21574 -fsingle-precision-constant}
21576 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
21577 @gccoptlist{-mcustom-fmuls=252 @gol
21578 -mcustom-fadds=253 @gol
21579 -mcustom-fsubs=254 @gol
21580 -mcustom-fdivs=255 @gol
21581 -fsingle-precision-constant}
21583 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
21584 @gccoptlist{-mcustom-floatus=243 @gol
21585 -mcustom-fixsi=244 @gol
21586 -mcustom-floatis=245 @gol
21587 -mcustom-fcmpgts=246 @gol
21588 -mcustom-fcmples=249 @gol
21589 -mcustom-fcmpeqs=250 @gol
21590 -mcustom-fcmpnes=251 @gol
21591 -mcustom-fmuls=252 @gol
21592 -mcustom-fadds=253 @gol
21593 -mcustom-fsubs=254 @gol
21594 -mcustom-fdivs=255 @gol
21595 -fsingle-precision-constant}
21597 Custom instruction assignments given by individual
21598 @option{-mcustom-@var{insn}=} options override those given by
21599 @option{-mcustom-fpu-cfg=}, regardless of the
21600 order of the options on the command line.
21602 Note that you can gain more local control over selection of a FPU
21603 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
21604 function attribute (@pxref{Function Attributes})
21605 or pragma (@pxref{Function Specific Option Pragmas}).
21607 @end table
21609 These additional @samp{-m} options are available for the Altera Nios II
21610 ELF (bare-metal) target:
21612 @table @gcctabopt
21614 @item -mhal
21615 @opindex mhal
21616 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
21617 startup and termination code, and is typically used in conjunction with
21618 @option{-msys-crt0=} to specify the location of the alternate startup code
21619 provided by the HAL BSP.
21621 @item -msmallc
21622 @opindex msmallc
21623 Link with a limited version of the C library, @option{-lsmallc}, rather than
21624 Newlib.
21626 @item -msys-crt0=@var{startfile}
21627 @opindex msys-crt0
21628 @var{startfile} is the file name of the startfile (crt0) to use 
21629 when linking.  This option is only useful in conjunction with @option{-mhal}.
21631 @item -msys-lib=@var{systemlib}
21632 @opindex msys-lib
21633 @var{systemlib} is the library name of the library that provides
21634 low-level system calls required by the C library,
21635 e.g. @code{read} and @code{write}.
21636 This option is typically used to link with a library provided by a HAL BSP.
21638 @end table
21640 @node Nvidia PTX Options
21641 @subsection Nvidia PTX Options
21642 @cindex Nvidia PTX options
21643 @cindex nvptx options
21645 These options are defined for Nvidia PTX:
21647 @table @gcctabopt
21649 @item -m32
21650 @itemx -m64
21651 @opindex m32
21652 @opindex m64
21653 Generate code for 32-bit or 64-bit ABI.
21655 @item -mmainkernel
21656 @opindex mmainkernel
21657 Link in code for a __main kernel.  This is for stand-alone instead of
21658 offloading execution.
21660 @item -moptimize
21661 @opindex moptimize
21662 Apply partitioned execution optimizations.  This is the default when any
21663 level of optimization is selected.
21665 @item -msoft-stack
21666 @opindex msoft-stack
21667 Generate code that does not use @code{.local} memory
21668 directly for stack storage. Instead, a per-warp stack pointer is
21669 maintained explicitly. This enables variable-length stack allocation (with
21670 variable-length arrays or @code{alloca}), and when global memory is used for
21671 underlying storage, makes it possible to access automatic variables from other
21672 threads, or with atomic instructions. This code generation variant is used
21673 for OpenMP offloading, but the option is exposed on its own for the purpose
21674 of testing the compiler; to generate code suitable for linking into programs
21675 using OpenMP offloading, use option @option{-mgomp}.
21677 @item -muniform-simt
21678 @opindex muniform-simt
21679 Switch to code generation variant that allows to execute all threads in each
21680 warp, while maintaining memory state and side effects as if only one thread
21681 in each warp was active outside of OpenMP SIMD regions.  All atomic operations
21682 and calls to runtime (malloc, free, vprintf) are conditionally executed (iff
21683 current lane index equals the master lane index), and the register being
21684 assigned is copied via a shuffle instruction from the master lane.  Outside of
21685 SIMD regions lane 0 is the master; inside, each thread sees itself as the
21686 master.  Shared memory array @code{int __nvptx_uni[]} stores all-zeros or
21687 all-ones bitmasks for each warp, indicating current mode (0 outside of SIMD
21688 regions).  Each thread can bitwise-and the bitmask at position @code{tid.y}
21689 with current lane index to compute the master lane index.
21691 @item -mgomp
21692 @opindex mgomp
21693 Generate code for use in OpenMP offloading: enables @option{-msoft-stack} and
21694 @option{-muniform-simt} options, and selects corresponding multilib variant.
21696 @end table
21698 @node PDP-11 Options
21699 @subsection PDP-11 Options
21700 @cindex PDP-11 Options
21702 These options are defined for the PDP-11:
21704 @table @gcctabopt
21705 @item -mfpu
21706 @opindex mfpu
21707 Use hardware FPP floating point.  This is the default.  (FIS floating
21708 point on the PDP-11/40 is not supported.)
21710 @item -msoft-float
21711 @opindex msoft-float
21712 Do not use hardware floating point.
21714 @item -mac0
21715 @opindex mac0
21716 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
21718 @item -mno-ac0
21719 @opindex mno-ac0
21720 Return floating-point results in memory.  This is the default.
21722 @item -m40
21723 @opindex m40
21724 Generate code for a PDP-11/40.
21726 @item -m45
21727 @opindex m45
21728 Generate code for a PDP-11/45.  This is the default.
21730 @item -m10
21731 @opindex m10
21732 Generate code for a PDP-11/10.
21734 @item -mbcopy-builtin
21735 @opindex mbcopy-builtin
21736 Use inline @code{movmemhi} patterns for copying memory.  This is the
21737 default.
21739 @item -mbcopy
21740 @opindex mbcopy
21741 Do not use inline @code{movmemhi} patterns for copying memory.
21743 @item -mint16
21744 @itemx -mno-int32
21745 @opindex mint16
21746 @opindex mno-int32
21747 Use 16-bit @code{int}.  This is the default.
21749 @item -mint32
21750 @itemx -mno-int16
21751 @opindex mint32
21752 @opindex mno-int16
21753 Use 32-bit @code{int}.
21755 @item -mfloat64
21756 @itemx -mno-float32
21757 @opindex mfloat64
21758 @opindex mno-float32
21759 Use 64-bit @code{float}.  This is the default.
21761 @item -mfloat32
21762 @itemx -mno-float64
21763 @opindex mfloat32
21764 @opindex mno-float64
21765 Use 32-bit @code{float}.
21767 @item -mabshi
21768 @opindex mabshi
21769 Use @code{abshi2} pattern.  This is the default.
21771 @item -mno-abshi
21772 @opindex mno-abshi
21773 Do not use @code{abshi2} pattern.
21775 @item -mbranch-expensive
21776 @opindex mbranch-expensive
21777 Pretend that branches are expensive.  This is for experimenting with
21778 code generation only.
21780 @item -mbranch-cheap
21781 @opindex mbranch-cheap
21782 Do not pretend that branches are expensive.  This is the default.
21784 @item -munix-asm
21785 @opindex munix-asm
21786 Use Unix assembler syntax.  This is the default when configured for
21787 @samp{pdp11-*-bsd}.
21789 @item -mdec-asm
21790 @opindex mdec-asm
21791 Use DEC assembler syntax.  This is the default when configured for any
21792 PDP-11 target other than @samp{pdp11-*-bsd}.
21793 @end table
21795 @node picoChip Options
21796 @subsection picoChip Options
21797 @cindex picoChip options
21799 These @samp{-m} options are defined for picoChip implementations:
21801 @table @gcctabopt
21803 @item -mae=@var{ae_type}
21804 @opindex mcpu
21805 Set the instruction set, register set, and instruction scheduling
21806 parameters for array element type @var{ae_type}.  Supported values
21807 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
21809 @option{-mae=ANY} selects a completely generic AE type.  Code
21810 generated with this option runs on any of the other AE types.  The
21811 code is not as efficient as it would be if compiled for a specific
21812 AE type, and some types of operation (e.g., multiplication) do not
21813 work properly on all types of AE.
21815 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
21816 for compiled code, and is the default.
21818 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
21819 option may suffer from poor performance of byte (char) manipulation,
21820 since the DSP AE does not provide hardware support for byte load/stores.
21822 @item -msymbol-as-address
21823 Enable the compiler to directly use a symbol name as an address in a
21824 load/store instruction, without first loading it into a
21825 register.  Typically, the use of this option generates larger
21826 programs, which run faster than when the option isn't used.  However, the
21827 results vary from program to program, so it is left as a user option,
21828 rather than being permanently enabled.
21830 @item -mno-inefficient-warnings
21831 Disables warnings about the generation of inefficient code.  These
21832 warnings can be generated, for example, when compiling code that
21833 performs byte-level memory operations on the MAC AE type.  The MAC AE has
21834 no hardware support for byte-level memory operations, so all byte
21835 load/stores must be synthesized from word load/store operations.  This is
21836 inefficient and a warning is generated to indicate
21837 that you should rewrite the code to avoid byte operations, or to target
21838 an AE type that has the necessary hardware support.  This option disables
21839 these warnings.
21841 @end table
21843 @node PowerPC Options
21844 @subsection PowerPC Options
21845 @cindex PowerPC options
21847 These are listed under @xref{RS/6000 and PowerPC Options}.
21849 @node RISC-V Options
21850 @subsection RISC-V Options
21851 @cindex RISC-V Options
21853 These command-line options are defined for RISC-V targets:
21855 @table @gcctabopt
21856 @item -mbranch-cost=@var{n}
21857 @opindex mbranch-cost
21858 Set the cost of branches to roughly @var{n} instructions.
21860 @item -mplt
21861 @itemx -mno-plt
21862 @opindex plt
21863 When generating PIC code, do or don't allow the use of PLTs. Ignored for
21864 non-PIC.  The default is @option{-mplt}.
21866 @item -mabi=@var{ABI-string}
21867 @opindex mabi
21868 Specify integer and floating-point calling convention.  @var{ABI-string}
21869 contains two parts: the size of integer types and the registers used for
21870 floating-point types.  For example @samp{-march=rv64ifd -mabi=lp64d} means that
21871 @samp{long} and pointers are 64-bit (implicitly defining @samp{int} to be
21872 32-bit), and that floating-point values up to 64 bits wide are passed in F
21873 registers.  Contrast this with @samp{-march=rv64ifd -mabi=lp64f}, which still
21874 allows the compiler to generate code that uses the F and D extensions but only
21875 allows floating-point values up to 32 bits long to be passed in registers; or
21876 @samp{-march=rv64ifd -mabi=lp64}, in which no floating-point arguments will be
21877 passed in registers.
21879 The default for this argument is system dependent, users who want a specific
21880 calling convention should specify one explicitly.  The valid calling
21881 conventions are: @samp{ilp32}, @samp{ilp32f}, @samp{ilp32d}, @samp{lp64},
21882 @samp{lp64f}, and @samp{lp64d}.  Some calling conventions are impossible to
21883 implement on some ISAs: for example, @samp{-march=rv32if -mabi=ilp32d} is
21884 invalid because the ABI requires 64-bit values be passed in F registers, but F
21885 registers are only 32 bits wide.
21887 @item -mfdiv
21888 @itemx -mno-fdiv
21889 @opindex mfdiv
21890 Do or don't use hardware floating-point divide and square root instructions.
21891 This requires the F or D extensions for floating-point registers.  The default
21892 is to use them if the specified architecture has these instructions.
21894 @item -mdiv
21895 @itemx -mno-div
21896 @opindex mdiv
21897 Do or don't use hardware instructions for integer division.  This requires the
21898 M extension.  The default is to use them if the specified architecture has
21899 these instructions.
21901 @item -march=@var{ISA-string}
21902 @opindex march
21903 Generate code for given RISC-V ISA (e.g.@ @samp{rv64im}).  ISA strings must be
21904 lower-case.  Examples include @samp{rv64i}, @samp{rv32g}, and @samp{rv32imaf}.
21906 @item -mtune=@var{processor-string}
21907 @opindex mtune
21908 Optimize the output for the given processor, specified by microarchitecture
21909 name.
21911 @item -msmall-data-limit=@var{n}
21912 @opindex msmall-data-limit
21913 Put global and static data smaller than @var{n} bytes into a special section
21914 (on some targets).
21916 @item -msave-restore
21917 @itemx -mno-save-restore
21918 @opindex msave-restore
21919 Do or don't use smaller but slower prologue and epilogue code that uses
21920 library function calls.  The default is to use fast inline prologues and
21921 epilogues.
21923 @item -mstrict-align
21924 @itemx -mno-strict-align
21925 @opindex mstrict-align
21926 Do not or do generate unaligned memory accesses.  The default is set depending
21927 on whether the processor we are optimizing for supports fast unaligned access
21928 or not.
21930 @item -mcmodel=medlow
21931 @opindex mcmodel=medlow
21932 Generate code for the medium-low code model. The program and its statically
21933 defined symbols must lie within a single 2 GiB address range and must lie
21934 between absolute addresses @minus{}2 GiB and +2 GiB. Programs can be
21935 statically or dynamically linked. This is the default code model.
21937 @item -mcmodel=medany
21938 @opindex mcmodel=medany
21939 Generate code for the medium-any code model. The program and its statically
21940 defined symbols must be within any single 2 GiB address range. Programs can be
21941 statically or dynamically linked.
21943 @item -mexplicit-relocs
21944 @itemx -mno-exlicit-relocs
21945 Use or do not use assembler relocation operators when dealing with symbolic
21946 addresses.  The alternative is to use assembler macros instead, which may
21947 limit optimization.
21949 @end table
21951 @node RL78 Options
21952 @subsection RL78 Options
21953 @cindex RL78 Options
21955 @table @gcctabopt
21957 @item -msim
21958 @opindex msim
21959 Links in additional target libraries to support operation within a
21960 simulator.
21962 @item -mmul=none
21963 @itemx -mmul=g10
21964 @itemx -mmul=g13
21965 @itemx -mmul=g14
21966 @itemx -mmul=rl78
21967 @opindex mmul
21968 Specifies the type of hardware multiplication and division support to
21969 be used.  The simplest is @code{none}, which uses software for both
21970 multiplication and division.  This is the default.  The @code{g13}
21971 value is for the hardware multiply/divide peripheral found on the
21972 RL78/G13 (S2 core) targets.  The @code{g14} value selects the use of
21973 the multiplication and division instructions supported by the RL78/G14
21974 (S3 core) parts.  The value @code{rl78} is an alias for @code{g14} and
21975 the value @code{mg10} is an alias for @code{none}.
21977 In addition a C preprocessor macro is defined, based upon the setting
21978 of this option.  Possible values are: @code{__RL78_MUL_NONE__},
21979 @code{__RL78_MUL_G13__} or @code{__RL78_MUL_G14__}.
21981 @item -mcpu=g10
21982 @itemx -mcpu=g13
21983 @itemx -mcpu=g14
21984 @itemx -mcpu=rl78
21985 @opindex mcpu
21986 Specifies the RL78 core to target.  The default is the G14 core, also
21987 known as an S3 core or just RL78.  The G13 or S2 core does not have
21988 multiply or divide instructions, instead it uses a hardware peripheral
21989 for these operations.  The G10 or S1 core does not have register
21990 banks, so it uses a different calling convention.
21992 If this option is set it also selects the type of hardware multiply
21993 support to use, unless this is overridden by an explicit
21994 @option{-mmul=none} option on the command line.  Thus specifying
21995 @option{-mcpu=g13} enables the use of the G13 hardware multiply
21996 peripheral and specifying @option{-mcpu=g10} disables the use of
21997 hardware multiplications altogether.
21999 Note, although the RL78/G14 core is the default target, specifying
22000 @option{-mcpu=g14} or @option{-mcpu=rl78} on the command line does
22001 change the behavior of the toolchain since it also enables G14
22002 hardware multiply support.  If these options are not specified on the
22003 command line then software multiplication routines will be used even
22004 though the code targets the RL78 core.  This is for backwards
22005 compatibility with older toolchains which did not have hardware
22006 multiply and divide support.
22008 In addition a C preprocessor macro is defined, based upon the setting
22009 of this option.  Possible values are: @code{__RL78_G10__},
22010 @code{__RL78_G13__} or @code{__RL78_G14__}.
22012 @item -mg10
22013 @itemx -mg13
22014 @itemx -mg14
22015 @itemx -mrl78
22016 @opindex mg10
22017 @opindex mg13
22018 @opindex mg14
22019 @opindex mrl78
22020 These are aliases for the corresponding @option{-mcpu=} option.  They
22021 are provided for backwards compatibility.
22023 @item -mallregs
22024 @opindex mallregs
22025 Allow the compiler to use all of the available registers.  By default
22026 registers @code{r24..r31} are reserved for use in interrupt handlers.
22027 With this option enabled these registers can be used in ordinary
22028 functions as well.
22030 @item -m64bit-doubles
22031 @itemx -m32bit-doubles
22032 @opindex m64bit-doubles
22033 @opindex m32bit-doubles
22034 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
22035 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
22036 @option{-m32bit-doubles}.
22038 @item -msave-mduc-in-interrupts
22039 @item -mno-save-mduc-in-interrupts
22040 @opindex msave-mduc-in-interrupts
22041 @opindex mno-save-mduc-in-interrupts
22042 Specifies that interrupt handler functions should preserve the
22043 MDUC registers.  This is only necessary if normal code might use
22044 the MDUC registers, for example because it performs multiplication
22045 and division operations.  The default is to ignore the MDUC registers
22046 as this makes the interrupt handlers faster.  The target option -mg13
22047 needs to be passed for this to work as this feature is only available
22048 on the G13 target (S2 core).  The MDUC registers will only be saved
22049 if the interrupt handler performs a multiplication or division
22050 operation or it calls another function.
22052 @end table
22054 @node RS/6000 and PowerPC Options
22055 @subsection IBM RS/6000 and PowerPC Options
22056 @cindex RS/6000 and PowerPC Options
22057 @cindex IBM RS/6000 and PowerPC Options
22059 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
22060 @table @gcctabopt
22061 @item -mpowerpc-gpopt
22062 @itemx -mno-powerpc-gpopt
22063 @itemx -mpowerpc-gfxopt
22064 @itemx -mno-powerpc-gfxopt
22065 @need 800
22066 @itemx -mpowerpc64
22067 @itemx -mno-powerpc64
22068 @itemx -mmfcrf
22069 @itemx -mno-mfcrf
22070 @itemx -mpopcntb
22071 @itemx -mno-popcntb
22072 @itemx -mpopcntd
22073 @itemx -mno-popcntd
22074 @itemx -mfprnd
22075 @itemx -mno-fprnd
22076 @need 800
22077 @itemx -mcmpb
22078 @itemx -mno-cmpb
22079 @itemx -mmfpgpr
22080 @itemx -mno-mfpgpr
22081 @itemx -mhard-dfp
22082 @itemx -mno-hard-dfp
22083 @opindex mpowerpc-gpopt
22084 @opindex mno-powerpc-gpopt
22085 @opindex mpowerpc-gfxopt
22086 @opindex mno-powerpc-gfxopt
22087 @opindex mpowerpc64
22088 @opindex mno-powerpc64
22089 @opindex mmfcrf
22090 @opindex mno-mfcrf
22091 @opindex mpopcntb
22092 @opindex mno-popcntb
22093 @opindex mpopcntd
22094 @opindex mno-popcntd
22095 @opindex mfprnd
22096 @opindex mno-fprnd
22097 @opindex mcmpb
22098 @opindex mno-cmpb
22099 @opindex mmfpgpr
22100 @opindex mno-mfpgpr
22101 @opindex mhard-dfp
22102 @opindex mno-hard-dfp
22103 You use these options to specify which instructions are available on the
22104 processor you are using.  The default value of these options is
22105 determined when configuring GCC@.  Specifying the
22106 @option{-mcpu=@var{cpu_type}} overrides the specification of these
22107 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
22108 rather than the options listed above.
22110 Specifying @option{-mpowerpc-gpopt} allows
22111 GCC to use the optional PowerPC architecture instructions in the
22112 General Purpose group, including floating-point square root.  Specifying
22113 @option{-mpowerpc-gfxopt} allows GCC to
22114 use the optional PowerPC architecture instructions in the Graphics
22115 group, including floating-point select.
22117 The @option{-mmfcrf} option allows GCC to generate the move from
22118 condition register field instruction implemented on the POWER4
22119 processor and other processors that support the PowerPC V2.01
22120 architecture.
22121 The @option{-mpopcntb} option allows GCC to generate the popcount and
22122 double-precision FP reciprocal estimate instruction implemented on the
22123 POWER5 processor and other processors that support the PowerPC V2.02
22124 architecture.
22125 The @option{-mpopcntd} option allows GCC to generate the popcount
22126 instruction implemented on the POWER7 processor and other processors
22127 that support the PowerPC V2.06 architecture.
22128 The @option{-mfprnd} option allows GCC to generate the FP round to
22129 integer instructions implemented on the POWER5+ processor and other
22130 processors that support the PowerPC V2.03 architecture.
22131 The @option{-mcmpb} option allows GCC to generate the compare bytes
22132 instruction implemented on the POWER6 processor and other processors
22133 that support the PowerPC V2.05 architecture.
22134 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
22135 general-purpose register instructions implemented on the POWER6X
22136 processor and other processors that support the extended PowerPC V2.05
22137 architecture.
22138 The @option{-mhard-dfp} option allows GCC to generate the decimal
22139 floating-point instructions implemented on some POWER processors.
22141 The @option{-mpowerpc64} option allows GCC to generate the additional
22142 64-bit instructions that are found in the full PowerPC64 architecture
22143 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
22144 @option{-mno-powerpc64}.
22146 @item -mcpu=@var{cpu_type}
22147 @opindex mcpu
22148 Set architecture type, register usage, and
22149 instruction scheduling parameters for machine type @var{cpu_type}.
22150 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
22151 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
22152 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
22153 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
22154 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
22155 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
22156 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
22157 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
22158 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
22159 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8},
22160 @samp{power9}, @samp{powerpc}, @samp{powerpc64}, @samp{powerpc64le},
22161 and @samp{rs64}.
22163 @option{-mcpu=powerpc}, @option{-mcpu=powerpc64}, and
22164 @option{-mcpu=powerpc64le} specify pure 32-bit PowerPC (either
22165 endian), 64-bit big endian PowerPC and 64-bit little endian PowerPC
22166 architecture machine types, with an appropriate, generic processor
22167 model assumed for scheduling purposes.
22169 The other options specify a specific processor.  Code generated under
22170 those options runs best on that processor, and may not run at all on
22171 others.
22173 The @option{-mcpu} options automatically enable or disable the
22174 following options:
22176 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
22177 -mpopcntb -mpopcntd  -mpowerpc64 @gol
22178 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
22179 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
22180 -mcrypto -mdirect-move -mhtm -mpower8-fusion -mpower8-vector @gol
22181 -mquad-memory -mquad-memory-atomic -mfloat128 -mfloat128-hardware}
22183 The particular options set for any particular CPU varies between
22184 compiler versions, depending on what setting seems to produce optimal
22185 code for that CPU; it doesn't necessarily reflect the actual hardware's
22186 capabilities.  If you wish to set an individual option to a particular
22187 value, you may specify it after the @option{-mcpu} option, like
22188 @option{-mcpu=970 -mno-altivec}.
22190 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
22191 not enabled or disabled by the @option{-mcpu} option at present because
22192 AIX does not have full support for these options.  You may still
22193 enable or disable them individually if you're sure it'll work in your
22194 environment.
22196 @item -mtune=@var{cpu_type}
22197 @opindex mtune
22198 Set the instruction scheduling parameters for machine type
22199 @var{cpu_type}, but do not set the architecture type or register usage,
22200 as @option{-mcpu=@var{cpu_type}} does.  The same
22201 values for @var{cpu_type} are used for @option{-mtune} as for
22202 @option{-mcpu}.  If both are specified, the code generated uses the
22203 architecture and registers set by @option{-mcpu}, but the
22204 scheduling parameters set by @option{-mtune}.
22206 @item -mcmodel=small
22207 @opindex mcmodel=small
22208 Generate PowerPC64 code for the small model: The TOC is limited to
22209 64k.
22211 @item -mcmodel=medium
22212 @opindex mcmodel=medium
22213 Generate PowerPC64 code for the medium model: The TOC and other static
22214 data may be up to a total of 4G in size.  This is the default for 64-bit
22215 Linux.
22217 @item -mcmodel=large
22218 @opindex mcmodel=large
22219 Generate PowerPC64 code for the large model: The TOC may be up to 4G
22220 in size.  Other data and code is only limited by the 64-bit address
22221 space.
22223 @item -maltivec
22224 @itemx -mno-altivec
22225 @opindex maltivec
22226 @opindex mno-altivec
22227 Generate code that uses (does not use) AltiVec instructions, and also
22228 enable the use of built-in functions that allow more direct access to
22229 the AltiVec instruction set.  You may also need to set
22230 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
22231 enhancements.
22233 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
22234 @option{-maltivec=be}, the element order for AltiVec intrinsics such
22235 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} 
22236 match array element order corresponding to the endianness of the
22237 target.  That is, element zero identifies the leftmost element in a
22238 vector register when targeting a big-endian platform, and identifies
22239 the rightmost element in a vector register when targeting a
22240 little-endian platform.
22242 @item -maltivec=be
22243 @opindex maltivec=be
22244 Generate AltiVec instructions using big-endian element order,
22245 regardless of whether the target is big- or little-endian.  This is
22246 the default when targeting a big-endian platform.
22248 The element order is used to interpret element numbers in AltiVec
22249 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
22250 @code{vec_insert}.  By default, these match array element order
22251 corresponding to the endianness for the target.
22253 @item -maltivec=le
22254 @opindex maltivec=le
22255 Generate AltiVec instructions using little-endian element order,
22256 regardless of whether the target is big- or little-endian.  This is
22257 the default when targeting a little-endian platform.  This option is
22258 currently ignored when targeting a big-endian platform.
22260 The element order is used to interpret element numbers in AltiVec
22261 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
22262 @code{vec_insert}.  By default, these match array element order
22263 corresponding to the endianness for the target.
22265 @item -mvrsave
22266 @itemx -mno-vrsave
22267 @opindex mvrsave
22268 @opindex mno-vrsave
22269 Generate VRSAVE instructions when generating AltiVec code.
22271 @item -msecure-plt
22272 @opindex msecure-plt
22273 Generate code that allows @command{ld} and @command{ld.so}
22274 to build executables and shared
22275 libraries with non-executable @code{.plt} and @code{.got} sections.
22276 This is a PowerPC
22277 32-bit SYSV ABI option.
22279 @item -mbss-plt
22280 @opindex mbss-plt
22281 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
22282 fills in, and
22283 requires @code{.plt} and @code{.got}
22284 sections that are both writable and executable.
22285 This is a PowerPC 32-bit SYSV ABI option.
22287 @item -misel
22288 @itemx -mno-isel
22289 @opindex misel
22290 @opindex mno-isel
22291 This switch enables or disables the generation of ISEL instructions.
22293 @item -misel=@var{yes/no}
22294 This switch has been deprecated.  Use @option{-misel} and
22295 @option{-mno-isel} instead.
22297 @item -mspe
22298 @itemx -mno-spe
22299 @opindex mspe
22300 @opindex mno-spe
22301 This switch enables or disables the generation of SPE simd
22302 instructions.
22304 @item -mpaired
22305 @itemx -mno-paired
22306 @opindex mpaired
22307 @opindex mno-paired
22308 This switch enables or disables the generation of PAIRED simd
22309 instructions.
22311 @item -mspe=@var{yes/no}
22312 This option has been deprecated.  Use @option{-mspe} and
22313 @option{-mno-spe} instead.
22315 @item -mvsx
22316 @itemx -mno-vsx
22317 @opindex mvsx
22318 @opindex mno-vsx
22319 Generate code that uses (does not use) vector/scalar (VSX)
22320 instructions, and also enable the use of built-in functions that allow
22321 more direct access to the VSX instruction set.
22323 @item -mcrypto
22324 @itemx -mno-crypto
22325 @opindex mcrypto
22326 @opindex mno-crypto
22327 Enable the use (disable) of the built-in functions that allow direct
22328 access to the cryptographic instructions that were added in version
22329 2.07 of the PowerPC ISA.
22331 @item -mdirect-move
22332 @itemx -mno-direct-move
22333 @opindex mdirect-move
22334 @opindex mno-direct-move
22335 Generate code that uses (does not use) the instructions to move data
22336 between the general purpose registers and the vector/scalar (VSX)
22337 registers that were added in version 2.07 of the PowerPC ISA.
22339 @item -mhtm
22340 @itemx -mno-htm
22341 @opindex mhtm
22342 @opindex mno-htm
22343 Enable (disable) the use of the built-in functions that allow direct
22344 access to the Hardware Transactional Memory (HTM) instructions that
22345 were added in version 2.07 of the PowerPC ISA.
22347 @item -mpower8-fusion
22348 @itemx -mno-power8-fusion
22349 @opindex mpower8-fusion
22350 @opindex mno-power8-fusion
22351 Generate code that keeps (does not keeps) some integer operations
22352 adjacent so that the instructions can be fused together on power8 and
22353 later processors.
22355 @item -mpower8-vector
22356 @itemx -mno-power8-vector
22357 @opindex mpower8-vector
22358 @opindex mno-power8-vector
22359 Generate code that uses (does not use) the vector and scalar
22360 instructions that were added in version 2.07 of the PowerPC ISA.  Also
22361 enable the use of built-in functions that allow more direct access to
22362 the vector instructions.
22364 @item -mquad-memory
22365 @itemx -mno-quad-memory
22366 @opindex mquad-memory
22367 @opindex mno-quad-memory
22368 Generate code that uses (does not use) the non-atomic quad word memory
22369 instructions.  The @option{-mquad-memory} option requires use of
22370 64-bit mode.
22372 @item -mquad-memory-atomic
22373 @itemx -mno-quad-memory-atomic
22374 @opindex mquad-memory-atomic
22375 @opindex mno-quad-memory-atomic
22376 Generate code that uses (does not use) the atomic quad word memory
22377 instructions.  The @option{-mquad-memory-atomic} option requires use of
22378 64-bit mode.
22380 @item -mfloat128
22381 @itemx -mno-float128
22382 @opindex mfloat128
22383 @opindex mno-float128
22384 Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point
22385 and use either software emulation for IEEE 128-bit floating point or
22386 hardware instructions.
22388 The VSX instruction set (@option{-mvsx}, @option{-mcpu=power7},
22389 @option{-mcpu=power8}), or @option{-mcpu=power9} must be enabled to
22390 use the IEEE 128-bit floating point support.  The IEEE 128-bit
22391 floating point support only works on PowerPC Linux systems.
22393 The default for @option{-mfloat128} is enabled on PowerPC Linux
22394 systems using the VSX instruction set, and disabled on other systems.
22396 If you use the ISA 3.0 instruction set (@option{-mpower9-vector} or
22397 @option{-mcpu=power9}) on a 64-bit system, the IEEE 128-bit floating
22398 point support will also enable the generation of ISA 3.0 IEEE 128-bit
22399 floating point instructions.  Otherwise, if you do not specify to
22400 generate ISA 3.0 instructions or you are targeting a 32-bit big endian
22401 system, IEEE 128-bit floating point will be done with software
22402 emulation.
22404 @item -mfloat128-hardware
22405 @itemx -mno-float128-hardware
22406 @opindex mfloat128-hardware
22407 @opindex mno-float128-hardware
22408 Enable/disable using ISA 3.0 hardware instructions to support the
22409 @var{__float128} data type.
22411 The default for @option{-mfloat128-hardware} is enabled on PowerPC
22412 Linux systems using the ISA 3.0 instruction set, and disabled on other
22413 systems.
22415 @item -mfloat-gprs=@var{yes/single/double/no}
22416 @itemx -mfloat-gprs
22417 @opindex mfloat-gprs
22418 This switch enables or disables the generation of floating-point
22419 operations on the general-purpose registers for architectures that
22420 support it.
22422 The argument @samp{yes} or @samp{single} enables the use of
22423 single-precision floating-point operations.
22425 The argument @samp{double} enables the use of single and
22426 double-precision floating-point operations.
22428 The argument @samp{no} disables floating-point operations on the
22429 general-purpose registers.
22431 This option is currently only available on the MPC854x.
22433 @item -m32
22434 @itemx -m64
22435 @opindex m32
22436 @opindex m64
22437 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
22438 targets (including GNU/Linux).  The 32-bit environment sets int, long
22439 and pointer to 32 bits and generates code that runs on any PowerPC
22440 variant.  The 64-bit environment sets int to 32 bits and long and
22441 pointer to 64 bits, and generates code for PowerPC64, as for
22442 @option{-mpowerpc64}.
22444 @item -mfull-toc
22445 @itemx -mno-fp-in-toc
22446 @itemx -mno-sum-in-toc
22447 @itemx -mminimal-toc
22448 @opindex mfull-toc
22449 @opindex mno-fp-in-toc
22450 @opindex mno-sum-in-toc
22451 @opindex mminimal-toc
22452 Modify generation of the TOC (Table Of Contents), which is created for
22453 every executable file.  The @option{-mfull-toc} option is selected by
22454 default.  In that case, GCC allocates at least one TOC entry for
22455 each unique non-automatic variable reference in your program.  GCC
22456 also places floating-point constants in the TOC@.  However, only
22457 16,384 entries are available in the TOC@.
22459 If you receive a linker error message that saying you have overflowed
22460 the available TOC space, you can reduce the amount of TOC space used
22461 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
22462 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
22463 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
22464 generate code to calculate the sum of an address and a constant at
22465 run time instead of putting that sum into the TOC@.  You may specify one
22466 or both of these options.  Each causes GCC to produce very slightly
22467 slower and larger code at the expense of conserving TOC space.
22469 If you still run out of space in the TOC even when you specify both of
22470 these options, specify @option{-mminimal-toc} instead.  This option causes
22471 GCC to make only one TOC entry for every file.  When you specify this
22472 option, GCC produces code that is slower and larger but which
22473 uses extremely little TOC space.  You may wish to use this option
22474 only on files that contain less frequently-executed code.
22476 @item -maix64
22477 @itemx -maix32
22478 @opindex maix64
22479 @opindex maix32
22480 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
22481 @code{long} type, and the infrastructure needed to support them.
22482 Specifying @option{-maix64} implies @option{-mpowerpc64},
22483 while @option{-maix32} disables the 64-bit ABI and
22484 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
22486 @item -mxl-compat
22487 @itemx -mno-xl-compat
22488 @opindex mxl-compat
22489 @opindex mno-xl-compat
22490 Produce code that conforms more closely to IBM XL compiler semantics
22491 when using AIX-compatible ABI@.  Pass floating-point arguments to
22492 prototyped functions beyond the register save area (RSA) on the stack
22493 in addition to argument FPRs.  Do not assume that most significant
22494 double in 128-bit long double value is properly rounded when comparing
22495 values and converting to double.  Use XL symbol names for long double
22496 support routines.
22498 The AIX calling convention was extended but not initially documented to
22499 handle an obscure K&R C case of calling a function that takes the
22500 address of its arguments with fewer arguments than declared.  IBM XL
22501 compilers access floating-point arguments that do not fit in the
22502 RSA from the stack when a subroutine is compiled without
22503 optimization.  Because always storing floating-point arguments on the
22504 stack is inefficient and rarely needed, this option is not enabled by
22505 default and only is necessary when calling subroutines compiled by IBM
22506 XL compilers without optimization.
22508 @item -mpe
22509 @opindex mpe
22510 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
22511 application written to use message passing with special startup code to
22512 enable the application to run.  The system must have PE installed in the
22513 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
22514 must be overridden with the @option{-specs=} option to specify the
22515 appropriate directory location.  The Parallel Environment does not
22516 support threads, so the @option{-mpe} option and the @option{-pthread}
22517 option are incompatible.
22519 @item -malign-natural
22520 @itemx -malign-power
22521 @opindex malign-natural
22522 @opindex malign-power
22523 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
22524 @option{-malign-natural} overrides the ABI-defined alignment of larger
22525 types, such as floating-point doubles, on their natural size-based boundary.
22526 The option @option{-malign-power} instructs GCC to follow the ABI-specified
22527 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
22529 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
22530 is not supported.
22532 @item -msoft-float
22533 @itemx -mhard-float
22534 @opindex msoft-float
22535 @opindex mhard-float
22536 Generate code that does not use (uses) the floating-point register set.
22537 Software floating-point emulation is provided if you use the
22538 @option{-msoft-float} option, and pass the option to GCC when linking.
22540 @item -msingle-float
22541 @itemx -mdouble-float
22542 @opindex msingle-float
22543 @opindex mdouble-float
22544 Generate code for single- or double-precision floating-point operations.
22545 @option{-mdouble-float} implies @option{-msingle-float}.
22547 @item -msimple-fpu
22548 @opindex msimple-fpu
22549 Do not generate @code{sqrt} and @code{div} instructions for hardware
22550 floating-point unit.
22552 @item -mfpu=@var{name}
22553 @opindex mfpu
22554 Specify type of floating-point unit.  Valid values for @var{name} are
22555 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
22556 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
22557 @samp{sp_full} (equivalent to @option{-msingle-float}),
22558 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
22560 @item -mxilinx-fpu
22561 @opindex mxilinx-fpu
22562 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
22564 @item -mmultiple
22565 @itemx -mno-multiple
22566 @opindex mmultiple
22567 @opindex mno-multiple
22568 Generate code that uses (does not use) the load multiple word
22569 instructions and the store multiple word instructions.  These
22570 instructions are generated by default on POWER systems, and not
22571 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
22572 PowerPC systems, since those instructions do not work when the
22573 processor is in little-endian mode.  The exceptions are PPC740 and
22574 PPC750 which permit these instructions in little-endian mode.
22576 @item -mstring
22577 @itemx -mno-string
22578 @opindex mstring
22579 @opindex mno-string
22580 Generate code that uses (does not use) the load string instructions
22581 and the store string word instructions to save multiple registers and
22582 do small block moves.  These instructions are generated by default on
22583 POWER systems, and not generated on PowerPC systems.  Do not use
22584 @option{-mstring} on little-endian PowerPC systems, since those
22585 instructions do not work when the processor is in little-endian mode.
22586 The exceptions are PPC740 and PPC750 which permit these instructions
22587 in little-endian mode.
22589 @item -mupdate
22590 @itemx -mno-update
22591 @opindex mupdate
22592 @opindex mno-update
22593 Generate code that uses (does not use) the load or store instructions
22594 that update the base register to the address of the calculated memory
22595 location.  These instructions are generated by default.  If you use
22596 @option{-mno-update}, there is a small window between the time that the
22597 stack pointer is updated and the address of the previous frame is
22598 stored, which means code that walks the stack frame across interrupts or
22599 signals may get corrupted data.
22601 @item -mavoid-indexed-addresses
22602 @itemx -mno-avoid-indexed-addresses
22603 @opindex mavoid-indexed-addresses
22604 @opindex mno-avoid-indexed-addresses
22605 Generate code that tries to avoid (not avoid) the use of indexed load
22606 or store instructions. These instructions can incur a performance
22607 penalty on Power6 processors in certain situations, such as when
22608 stepping through large arrays that cross a 16M boundary.  This option
22609 is enabled by default when targeting Power6 and disabled otherwise.
22611 @item -mfused-madd
22612 @itemx -mno-fused-madd
22613 @opindex mfused-madd
22614 @opindex mno-fused-madd
22615 Generate code that uses (does not use) the floating-point multiply and
22616 accumulate instructions.  These instructions are generated by default
22617 if hardware floating point is used.  The machine-dependent
22618 @option{-mfused-madd} option is now mapped to the machine-independent
22619 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
22620 mapped to @option{-ffp-contract=off}.
22622 @item -mmulhw
22623 @itemx -mno-mulhw
22624 @opindex mmulhw
22625 @opindex mno-mulhw
22626 Generate code that uses (does not use) the half-word multiply and
22627 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
22628 These instructions are generated by default when targeting those
22629 processors.
22631 @item -mdlmzb
22632 @itemx -mno-dlmzb
22633 @opindex mdlmzb
22634 @opindex mno-dlmzb
22635 Generate code that uses (does not use) the string-search @samp{dlmzb}
22636 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
22637 generated by default when targeting those processors.
22639 @item -mno-bit-align
22640 @itemx -mbit-align
22641 @opindex mno-bit-align
22642 @opindex mbit-align
22643 On System V.4 and embedded PowerPC systems do not (do) force structures
22644 and unions that contain bit-fields to be aligned to the base type of the
22645 bit-field.
22647 For example, by default a structure containing nothing but 8
22648 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
22649 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
22650 the structure is aligned to a 1-byte boundary and is 1 byte in
22651 size.
22653 @item -mno-strict-align
22654 @itemx -mstrict-align
22655 @opindex mno-strict-align
22656 @opindex mstrict-align
22657 On System V.4 and embedded PowerPC systems do not (do) assume that
22658 unaligned memory references are handled by the system.
22660 @item -mrelocatable
22661 @itemx -mno-relocatable
22662 @opindex mrelocatable
22663 @opindex mno-relocatable
22664 Generate code that allows (does not allow) a static executable to be
22665 relocated to a different address at run time.  A simple embedded
22666 PowerPC system loader should relocate the entire contents of
22667 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
22668 a table of 32-bit addresses generated by this option.  For this to
22669 work, all objects linked together must be compiled with
22670 @option{-mrelocatable} or @option{-mrelocatable-lib}.
22671 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
22673 @item -mrelocatable-lib
22674 @itemx -mno-relocatable-lib
22675 @opindex mrelocatable-lib
22676 @opindex mno-relocatable-lib
22677 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
22678 @code{.fixup} section to allow static executables to be relocated at
22679 run time, but @option{-mrelocatable-lib} does not use the smaller stack
22680 alignment of @option{-mrelocatable}.  Objects compiled with
22681 @option{-mrelocatable-lib} may be linked with objects compiled with
22682 any combination of the @option{-mrelocatable} options.
22684 @item -mno-toc
22685 @itemx -mtoc
22686 @opindex mno-toc
22687 @opindex mtoc
22688 On System V.4 and embedded PowerPC systems do not (do) assume that
22689 register 2 contains a pointer to a global area pointing to the addresses
22690 used in the program.
22692 @item -mlittle
22693 @itemx -mlittle-endian
22694 @opindex mlittle
22695 @opindex mlittle-endian
22696 On System V.4 and embedded PowerPC systems compile code for the
22697 processor in little-endian mode.  The @option{-mlittle-endian} option is
22698 the same as @option{-mlittle}.
22700 @item -mbig
22701 @itemx -mbig-endian
22702 @opindex mbig
22703 @opindex mbig-endian
22704 On System V.4 and embedded PowerPC systems compile code for the
22705 processor in big-endian mode.  The @option{-mbig-endian} option is
22706 the same as @option{-mbig}.
22708 @item -mdynamic-no-pic
22709 @opindex mdynamic-no-pic
22710 On Darwin and Mac OS X systems, compile code so that it is not
22711 relocatable, but that its external references are relocatable.  The
22712 resulting code is suitable for applications, but not shared
22713 libraries.
22715 @item -msingle-pic-base
22716 @opindex msingle-pic-base
22717 Treat the register used for PIC addressing as read-only, rather than
22718 loading it in the prologue for each function.  The runtime system is
22719 responsible for initializing this register with an appropriate value
22720 before execution begins.
22722 @item -mprioritize-restricted-insns=@var{priority}
22723 @opindex mprioritize-restricted-insns
22724 This option controls the priority that is assigned to
22725 dispatch-slot restricted instructions during the second scheduling
22726 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
22727 or @samp{2} to assign no, highest, or second-highest (respectively) 
22728 priority to dispatch-slot restricted
22729 instructions.
22731 @item -msched-costly-dep=@var{dependence_type}
22732 @opindex msched-costly-dep
22733 This option controls which dependences are considered costly
22734 by the target during instruction scheduling.  The argument
22735 @var{dependence_type} takes one of the following values:
22737 @table @asis
22738 @item @samp{no}
22739 No dependence is costly.
22741 @item @samp{all}
22742 All dependences are costly.
22744 @item @samp{true_store_to_load}
22745 A true dependence from store to load is costly.
22747 @item @samp{store_to_load}
22748 Any dependence from store to load is costly.
22750 @item @var{number}
22751 Any dependence for which the latency is greater than or equal to 
22752 @var{number} is costly.
22753 @end table
22755 @item -minsert-sched-nops=@var{scheme}
22756 @opindex minsert-sched-nops
22757 This option controls which NOP insertion scheme is used during
22758 the second scheduling pass.  The argument @var{scheme} takes one of the
22759 following values:
22761 @table @asis
22762 @item @samp{no}
22763 Don't insert NOPs.
22765 @item @samp{pad}
22766 Pad with NOPs any dispatch group that has vacant issue slots,
22767 according to the scheduler's grouping.
22769 @item @samp{regroup_exact}
22770 Insert NOPs to force costly dependent insns into
22771 separate groups.  Insert exactly as many NOPs as needed to force an insn
22772 to a new group, according to the estimated processor grouping.
22774 @item @var{number}
22775 Insert NOPs to force costly dependent insns into
22776 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
22777 @end table
22779 @item -mcall-sysv
22780 @opindex mcall-sysv
22781 On System V.4 and embedded PowerPC systems compile code using calling
22782 conventions that adhere to the March 1995 draft of the System V
22783 Application Binary Interface, PowerPC processor supplement.  This is the
22784 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
22786 @item -mcall-sysv-eabi
22787 @itemx -mcall-eabi
22788 @opindex mcall-sysv-eabi
22789 @opindex mcall-eabi
22790 Specify both @option{-mcall-sysv} and @option{-meabi} options.
22792 @item -mcall-sysv-noeabi
22793 @opindex mcall-sysv-noeabi
22794 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
22796 @item -mcall-aixdesc
22797 @opindex m
22798 On System V.4 and embedded PowerPC systems compile code for the AIX
22799 operating system.
22801 @item -mcall-linux
22802 @opindex mcall-linux
22803 On System V.4 and embedded PowerPC systems compile code for the
22804 Linux-based GNU system.
22806 @item -mcall-freebsd
22807 @opindex mcall-freebsd
22808 On System V.4 and embedded PowerPC systems compile code for the
22809 FreeBSD operating system.
22811 @item -mcall-netbsd
22812 @opindex mcall-netbsd
22813 On System V.4 and embedded PowerPC systems compile code for the
22814 NetBSD operating system.
22816 @item -mcall-openbsd
22817 @opindex mcall-netbsd
22818 On System V.4 and embedded PowerPC systems compile code for the
22819 OpenBSD operating system.
22821 @item -maix-struct-return
22822 @opindex maix-struct-return
22823 Return all structures in memory (as specified by the AIX ABI)@.
22825 @item -msvr4-struct-return
22826 @opindex msvr4-struct-return
22827 Return structures smaller than 8 bytes in registers (as specified by the
22828 SVR4 ABI)@.
22830 @item -mabi=@var{abi-type}
22831 @opindex mabi
22832 Extend the current ABI with a particular extension, or remove such extension.
22833 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
22834 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
22835 @samp{elfv1}, @samp{elfv2}@.
22837 @item -mabi=spe
22838 @opindex mabi=spe
22839 Extend the current ABI with SPE ABI extensions.  This does not change
22840 the default ABI, instead it adds the SPE ABI extensions to the current
22841 ABI@.
22843 @item -mabi=no-spe
22844 @opindex mabi=no-spe
22845 Disable Book-E SPE ABI extensions for the current ABI@.
22847 @item -mabi=ibmlongdouble
22848 @opindex mabi=ibmlongdouble
22849 Change the current ABI to use IBM extended-precision long double.
22850 This is not likely to work if your system defaults to using IEEE
22851 extended-precision long double.  If you change the long double type
22852 from IEEE extended-precision, the compiler will issue a warning unless
22853 you use the @option{-Wno-psabi} option.
22855 @item -mabi=ieeelongdouble
22856 @opindex mabi=ieeelongdouble
22857 Change the current ABI to use IEEE extended-precision long double.
22858 This is not likely to work if your system defaults to using IBM
22859 extended-precision long double.  If you change the long double type
22860 from IBM extended-precision, the compiler will issue a warning unless
22861 you use the @option{-Wno-psabi} option.
22863 @item -mabi=elfv1
22864 @opindex mabi=elfv1
22865 Change the current ABI to use the ELFv1 ABI.
22866 This is the default ABI for big-endian PowerPC 64-bit Linux.
22867 Overriding the default ABI requires special system support and is
22868 likely to fail in spectacular ways.
22870 @item -mabi=elfv2
22871 @opindex mabi=elfv2
22872 Change the current ABI to use the ELFv2 ABI.
22873 This is the default ABI for little-endian PowerPC 64-bit Linux.
22874 Overriding the default ABI requires special system support and is
22875 likely to fail in spectacular ways.
22877 @item -mgnu-attribute
22878 @itemx -mno-gnu-attribute
22879 @opindex mgnu-attribute
22880 @opindex mno-gnu-attribute
22881 Emit .gnu_attribute assembly directives to set tag/value pairs in a
22882 .gnu.attributes section that specify ABI variations in function
22883 parameters or return values.
22885 @item -mprototype
22886 @itemx -mno-prototype
22887 @opindex mprototype
22888 @opindex mno-prototype
22889 On System V.4 and embedded PowerPC systems assume that all calls to
22890 variable argument functions are properly prototyped.  Otherwise, the
22891 compiler must insert an instruction before every non-prototyped call to
22892 set or clear bit 6 of the condition code register (@code{CR}) to
22893 indicate whether floating-point values are passed in the floating-point
22894 registers in case the function takes variable arguments.  With
22895 @option{-mprototype}, only calls to prototyped variable argument functions
22896 set or clear the bit.
22898 @item -msim
22899 @opindex msim
22900 On embedded PowerPC systems, assume that the startup module is called
22901 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
22902 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
22903 configurations.
22905 @item -mmvme
22906 @opindex mmvme
22907 On embedded PowerPC systems, assume that the startup module is called
22908 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
22909 @file{libc.a}.
22911 @item -mads
22912 @opindex mads
22913 On embedded PowerPC systems, assume that the startup module is called
22914 @file{crt0.o} and the standard C libraries are @file{libads.a} and
22915 @file{libc.a}.
22917 @item -myellowknife
22918 @opindex myellowknife
22919 On embedded PowerPC systems, assume that the startup module is called
22920 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
22921 @file{libc.a}.
22923 @item -mvxworks
22924 @opindex mvxworks
22925 On System V.4 and embedded PowerPC systems, specify that you are
22926 compiling for a VxWorks system.
22928 @item -memb
22929 @opindex memb
22930 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
22931 header to indicate that @samp{eabi} extended relocations are used.
22933 @item -meabi
22934 @itemx -mno-eabi
22935 @opindex meabi
22936 @opindex mno-eabi
22937 On System V.4 and embedded PowerPC systems do (do not) adhere to the
22938 Embedded Applications Binary Interface (EABI), which is a set of
22939 modifications to the System V.4 specifications.  Selecting @option{-meabi}
22940 means that the stack is aligned to an 8-byte boundary, a function
22941 @code{__eabi} is called from @code{main} to set up the EABI
22942 environment, and the @option{-msdata} option can use both @code{r2} and
22943 @code{r13} to point to two separate small data areas.  Selecting
22944 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
22945 no EABI initialization function is called from @code{main}, and the
22946 @option{-msdata} option only uses @code{r13} to point to a single
22947 small data area.  The @option{-meabi} option is on by default if you
22948 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
22950 @item -msdata=eabi
22951 @opindex msdata=eabi
22952 On System V.4 and embedded PowerPC systems, put small initialized
22953 @code{const} global and static data in the @code{.sdata2} section, which
22954 is pointed to by register @code{r2}.  Put small initialized
22955 non-@code{const} global and static data in the @code{.sdata} section,
22956 which is pointed to by register @code{r13}.  Put small uninitialized
22957 global and static data in the @code{.sbss} section, which is adjacent to
22958 the @code{.sdata} section.  The @option{-msdata=eabi} option is
22959 incompatible with the @option{-mrelocatable} option.  The
22960 @option{-msdata=eabi} option also sets the @option{-memb} option.
22962 @item -msdata=sysv
22963 @opindex msdata=sysv
22964 On System V.4 and embedded PowerPC systems, put small global and static
22965 data in the @code{.sdata} section, which is pointed to by register
22966 @code{r13}.  Put small uninitialized global and static data in the
22967 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
22968 The @option{-msdata=sysv} option is incompatible with the
22969 @option{-mrelocatable} option.
22971 @item -msdata=default
22972 @itemx -msdata
22973 @opindex msdata=default
22974 @opindex msdata
22975 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
22976 compile code the same as @option{-msdata=eabi}, otherwise compile code the
22977 same as @option{-msdata=sysv}.
22979 @item -msdata=data
22980 @opindex msdata=data
22981 On System V.4 and embedded PowerPC systems, put small global
22982 data in the @code{.sdata} section.  Put small uninitialized global
22983 data in the @code{.sbss} section.  Do not use register @code{r13}
22984 to address small data however.  This is the default behavior unless
22985 other @option{-msdata} options are used.
22987 @item -msdata=none
22988 @itemx -mno-sdata
22989 @opindex msdata=none
22990 @opindex mno-sdata
22991 On embedded PowerPC systems, put all initialized global and static data
22992 in the @code{.data} section, and all uninitialized data in the
22993 @code{.bss} section.
22995 @item -mblock-move-inline-limit=@var{num}
22996 @opindex mblock-move-inline-limit
22997 Inline all block moves (such as calls to @code{memcpy} or structure
22998 copies) less than or equal to @var{num} bytes.  The minimum value for
22999 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
23000 targets.  The default value is target-specific.
23002 @item -G @var{num}
23003 @opindex G
23004 @cindex smaller data references (PowerPC)
23005 @cindex .sdata/.sdata2 references (PowerPC)
23006 On embedded PowerPC systems, put global and static items less than or
23007 equal to @var{num} bytes into the small data or BSS sections instead of
23008 the normal data or BSS section.  By default, @var{num} is 8.  The
23009 @option{-G @var{num}} switch is also passed to the linker.
23010 All modules should be compiled with the same @option{-G @var{num}} value.
23012 @item -mregnames
23013 @itemx -mno-regnames
23014 @opindex mregnames
23015 @opindex mno-regnames
23016 On System V.4 and embedded PowerPC systems do (do not) emit register
23017 names in the assembly language output using symbolic forms.
23019 @item -mlongcall
23020 @itemx -mno-longcall
23021 @opindex mlongcall
23022 @opindex mno-longcall
23023 By default assume that all calls are far away so that a longer and more
23024 expensive calling sequence is required.  This is required for calls
23025 farther than 32 megabytes (33,554,432 bytes) from the current location.
23026 A short call is generated if the compiler knows
23027 the call cannot be that far away.  This setting can be overridden by
23028 the @code{shortcall} function attribute, or by @code{#pragma
23029 longcall(0)}.
23031 Some linkers are capable of detecting out-of-range calls and generating
23032 glue code on the fly.  On these systems, long calls are unnecessary and
23033 generate slower code.  As of this writing, the AIX linker can do this,
23034 as can the GNU linker for PowerPC/64.  It is planned to add this feature
23035 to the GNU linker for 32-bit PowerPC systems as well.
23037 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
23038 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
23039 addresses represent the callee and the branch island.  The
23040 Darwin/PPC linker prefers the first address and generates a @code{bl
23041 callee} if the PPC @code{bl} instruction reaches the callee directly;
23042 otherwise, the linker generates @code{bl L42} to call the branch
23043 island.  The branch island is appended to the body of the
23044 calling function; it computes the full 32-bit address of the callee
23045 and jumps to it.
23047 On Mach-O (Darwin) systems, this option directs the compiler emit to
23048 the glue for every direct call, and the Darwin linker decides whether
23049 to use or discard it.
23051 In the future, GCC may ignore all longcall specifications
23052 when the linker is known to generate glue.
23054 @item -mtls-markers
23055 @itemx -mno-tls-markers
23056 @opindex mtls-markers
23057 @opindex mno-tls-markers
23058 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
23059 specifying the function argument.  The relocation allows the linker to
23060 reliably associate function call with argument setup instructions for
23061 TLS optimization, which in turn allows GCC to better schedule the
23062 sequence.
23064 @item -mrecip
23065 @itemx -mno-recip
23066 @opindex mrecip
23067 This option enables use of the reciprocal estimate and
23068 reciprocal square root estimate instructions with additional
23069 Newton-Raphson steps to increase precision instead of doing a divide or
23070 square root and divide for floating-point arguments.  You should use
23071 the @option{-ffast-math} option when using @option{-mrecip} (or at
23072 least @option{-funsafe-math-optimizations},
23073 @option{-ffinite-math-only}, @option{-freciprocal-math} and
23074 @option{-fno-trapping-math}).  Note that while the throughput of the
23075 sequence is generally higher than the throughput of the non-reciprocal
23076 instruction, the precision of the sequence can be decreased by up to 2
23077 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
23078 roots.
23080 @item -mrecip=@var{opt}
23081 @opindex mrecip=opt
23082 This option controls which reciprocal estimate instructions
23083 may be used.  @var{opt} is a comma-separated list of options, which may
23084 be preceded by a @code{!} to invert the option:
23086 @table @samp
23088 @item all
23089 Enable all estimate instructions.
23091 @item default 
23092 Enable the default instructions, equivalent to @option{-mrecip}.
23094 @item none 
23095 Disable all estimate instructions, equivalent to @option{-mno-recip}.
23097 @item div 
23098 Enable the reciprocal approximation instructions for both 
23099 single and double precision.
23101 @item divf 
23102 Enable the single-precision reciprocal approximation instructions.
23104 @item divd 
23105 Enable the double-precision reciprocal approximation instructions.
23107 @item rsqrt 
23108 Enable the reciprocal square root approximation instructions for both
23109 single and double precision.
23111 @item rsqrtf 
23112 Enable the single-precision reciprocal square root approximation instructions.
23114 @item rsqrtd 
23115 Enable the double-precision reciprocal square root approximation instructions.
23117 @end table
23119 So, for example, @option{-mrecip=all,!rsqrtd} enables
23120 all of the reciprocal estimate instructions, except for the
23121 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
23122 which handle the double-precision reciprocal square root calculations.
23124 @item -mrecip-precision
23125 @itemx -mno-recip-precision
23126 @opindex mrecip-precision
23127 Assume (do not assume) that the reciprocal estimate instructions
23128 provide higher-precision estimates than is mandated by the PowerPC
23129 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
23130 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
23131 The double-precision square root estimate instructions are not generated by
23132 default on low-precision machines, since they do not provide an
23133 estimate that converges after three steps.
23135 @item -mveclibabi=@var{type}
23136 @opindex mveclibabi
23137 Specifies the ABI type to use for vectorizing intrinsics using an
23138 external library.  The only type supported at present is @samp{mass},
23139 which specifies to use IBM's Mathematical Acceleration Subsystem
23140 (MASS) libraries for vectorizing intrinsics using external libraries.
23141 GCC currently emits calls to @code{acosd2}, @code{acosf4},
23142 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
23143 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
23144 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
23145 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
23146 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
23147 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
23148 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
23149 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
23150 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
23151 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
23152 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
23153 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
23154 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
23155 for power7.  Both @option{-ftree-vectorize} and
23156 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
23157 libraries must be specified at link time.
23159 @item -mfriz
23160 @itemx -mno-friz
23161 @opindex mfriz
23162 Generate (do not generate) the @code{friz} instruction when the
23163 @option{-funsafe-math-optimizations} option is used to optimize
23164 rounding of floating-point values to 64-bit integer and back to floating
23165 point.  The @code{friz} instruction does not return the same value if
23166 the floating-point number is too large to fit in an integer.
23168 @item -mpointers-to-nested-functions
23169 @itemx -mno-pointers-to-nested-functions
23170 @opindex mpointers-to-nested-functions
23171 Generate (do not generate) code to load up the static chain register
23172 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
23173 systems where a function pointer points to a 3-word descriptor giving
23174 the function address, TOC value to be loaded in register @code{r2}, and
23175 static chain value to be loaded in register @code{r11}.  The
23176 @option{-mpointers-to-nested-functions} is on by default.  You cannot
23177 call through pointers to nested functions or pointers
23178 to functions compiled in other languages that use the static chain if
23179 you use @option{-mno-pointers-to-nested-functions}.
23181 @item -msave-toc-indirect
23182 @itemx -mno-save-toc-indirect
23183 @opindex msave-toc-indirect
23184 Generate (do not generate) code to save the TOC value in the reserved
23185 stack location in the function prologue if the function calls through
23186 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
23187 saved in the prologue, it is saved just before the call through the
23188 pointer.  The @option{-mno-save-toc-indirect} option is the default.
23190 @item -mcompat-align-parm
23191 @itemx -mno-compat-align-parm
23192 @opindex mcompat-align-parm
23193 Generate (do not generate) code to pass structure parameters with a
23194 maximum alignment of 64 bits, for compatibility with older versions
23195 of GCC.
23197 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
23198 structure parameter on a 128-bit boundary when that structure contained
23199 a member requiring 128-bit alignment.  This is corrected in more
23200 recent versions of GCC.  This option may be used to generate code
23201 that is compatible with functions compiled with older versions of
23202 GCC.
23204 The @option{-mno-compat-align-parm} option is the default.
23206 @item -mstack-protector-guard=@var{guard}
23207 @itemx -mstack-protector-guard-reg=@var{reg}
23208 @itemx -mstack-protector-guard-offset=@var{offset}
23209 @itemx -mstack-protector-guard-symbol=@var{symbol}
23210 @opindex mstack-protector-guard
23211 @opindex mstack-protector-guard-reg
23212 @opindex mstack-protector-guard-offset
23213 @opindex mstack-protector-guard-symbol
23214 Generate stack protection code using canary at @var{guard}.  Supported
23215 locations are @samp{global} for global canary or @samp{tls} for per-thread
23216 canary in the TLS block (the default with GNU libc version 2.4 or later).
23218 With the latter choice the options
23219 @option{-mstack-protector-guard-reg=@var{reg}} and
23220 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
23221 which register to use as base register for reading the canary, and from what
23222 offset from that base register. The default for those is as specified in the
23223 relevant ABI.  @option{-mstack-protector-guard-symbol=@var{symbol}} overrides
23224 the offset with a symbol reference to a canary in the TLS block.
23225 @end table
23227 @node RX Options
23228 @subsection RX Options
23229 @cindex RX Options
23231 These command-line options are defined for RX targets:
23233 @table @gcctabopt
23234 @item -m64bit-doubles
23235 @itemx -m32bit-doubles
23236 @opindex m64bit-doubles
23237 @opindex m32bit-doubles
23238 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
23239 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
23240 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
23241 works on 32-bit values, which is why the default is
23242 @option{-m32bit-doubles}.
23244 @item -fpu
23245 @itemx -nofpu
23246 @opindex fpu
23247 @opindex nofpu
23248 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
23249 floating-point hardware.  The default is enabled for the RX600
23250 series and disabled for the RX200 series.
23252 Floating-point instructions are only generated for 32-bit floating-point 
23253 values, however, so the FPU hardware is not used for doubles if the
23254 @option{-m64bit-doubles} option is used.
23256 @emph{Note} If the @option{-fpu} option is enabled then
23257 @option{-funsafe-math-optimizations} is also enabled automatically.
23258 This is because the RX FPU instructions are themselves unsafe.
23260 @item -mcpu=@var{name}
23261 @opindex mcpu
23262 Selects the type of RX CPU to be targeted.  Currently three types are
23263 supported, the generic @samp{RX600} and @samp{RX200} series hardware and
23264 the specific @samp{RX610} CPU.  The default is @samp{RX600}.
23266 The only difference between @samp{RX600} and @samp{RX610} is that the
23267 @samp{RX610} does not support the @code{MVTIPL} instruction.
23269 The @samp{RX200} series does not have a hardware floating-point unit
23270 and so @option{-nofpu} is enabled by default when this type is
23271 selected.
23273 @item -mbig-endian-data
23274 @itemx -mlittle-endian-data
23275 @opindex mbig-endian-data
23276 @opindex mlittle-endian-data
23277 Store data (but not code) in the big-endian format.  The default is
23278 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
23279 format.
23281 @item -msmall-data-limit=@var{N}
23282 @opindex msmall-data-limit
23283 Specifies the maximum size in bytes of global and static variables
23284 which can be placed into the small data area.  Using the small data
23285 area can lead to smaller and faster code, but the size of area is
23286 limited and it is up to the programmer to ensure that the area does
23287 not overflow.  Also when the small data area is used one of the RX's
23288 registers (usually @code{r13}) is reserved for use pointing to this
23289 area, so it is no longer available for use by the compiler.  This
23290 could result in slower and/or larger code if variables are pushed onto
23291 the stack instead of being held in this register.
23293 Note, common variables (variables that have not been initialized) and
23294 constants are not placed into the small data area as they are assigned
23295 to other sections in the output executable.
23297 The default value is zero, which disables this feature.  Note, this
23298 feature is not enabled by default with higher optimization levels
23299 (@option{-O2} etc) because of the potentially detrimental effects of
23300 reserving a register.  It is up to the programmer to experiment and
23301 discover whether this feature is of benefit to their program.  See the
23302 description of the @option{-mpid} option for a description of how the
23303 actual register to hold the small data area pointer is chosen.
23305 @item -msim
23306 @itemx -mno-sim
23307 @opindex msim
23308 @opindex mno-sim
23309 Use the simulator runtime.  The default is to use the libgloss
23310 board-specific runtime.
23312 @item -mas100-syntax
23313 @itemx -mno-as100-syntax
23314 @opindex mas100-syntax
23315 @opindex mno-as100-syntax
23316 When generating assembler output use a syntax that is compatible with
23317 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
23318 assembler, but it has some restrictions so it is not generated by default.
23320 @item -mmax-constant-size=@var{N}
23321 @opindex mmax-constant-size
23322 Specifies the maximum size, in bytes, of a constant that can be used as
23323 an operand in a RX instruction.  Although the RX instruction set does
23324 allow constants of up to 4 bytes in length to be used in instructions,
23325 a longer value equates to a longer instruction.  Thus in some
23326 circumstances it can be beneficial to restrict the size of constants
23327 that are used in instructions.  Constants that are too big are instead
23328 placed into a constant pool and referenced via register indirection.
23330 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
23331 or 4 means that constants of any size are allowed.
23333 @item -mrelax
23334 @opindex mrelax
23335 Enable linker relaxation.  Linker relaxation is a process whereby the
23336 linker attempts to reduce the size of a program by finding shorter
23337 versions of various instructions.  Disabled by default.
23339 @item -mint-register=@var{N}
23340 @opindex mint-register
23341 Specify the number of registers to reserve for fast interrupt handler
23342 functions.  The value @var{N} can be between 0 and 4.  A value of 1
23343 means that register @code{r13} is reserved for the exclusive use
23344 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
23345 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
23346 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
23347 A value of 0, the default, does not reserve any registers.
23349 @item -msave-acc-in-interrupts
23350 @opindex msave-acc-in-interrupts
23351 Specifies that interrupt handler functions should preserve the
23352 accumulator register.  This is only necessary if normal code might use
23353 the accumulator register, for example because it performs 64-bit
23354 multiplications.  The default is to ignore the accumulator as this
23355 makes the interrupt handlers faster.
23357 @item -mpid
23358 @itemx -mno-pid
23359 @opindex mpid
23360 @opindex mno-pid
23361 Enables the generation of position independent data.  When enabled any
23362 access to constant data is done via an offset from a base address
23363 held in a register.  This allows the location of constant data to be
23364 determined at run time without requiring the executable to be
23365 relocated, which is a benefit to embedded applications with tight
23366 memory constraints.  Data that can be modified is not affected by this
23367 option.
23369 Note, using this feature reserves a register, usually @code{r13}, for
23370 the constant data base address.  This can result in slower and/or
23371 larger code, especially in complicated functions.
23373 The actual register chosen to hold the constant data base address
23374 depends upon whether the @option{-msmall-data-limit} and/or the
23375 @option{-mint-register} command-line options are enabled.  Starting
23376 with register @code{r13} and proceeding downwards, registers are
23377 allocated first to satisfy the requirements of @option{-mint-register},
23378 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
23379 is possible for the small data area register to be @code{r8} if both
23380 @option{-mint-register=4} and @option{-mpid} are specified on the
23381 command line.
23383 By default this feature is not enabled.  The default can be restored
23384 via the @option{-mno-pid} command-line option.
23386 @item -mno-warn-multiple-fast-interrupts
23387 @itemx -mwarn-multiple-fast-interrupts
23388 @opindex mno-warn-multiple-fast-interrupts
23389 @opindex mwarn-multiple-fast-interrupts
23390 Prevents GCC from issuing a warning message if it finds more than one
23391 fast interrupt handler when it is compiling a file.  The default is to
23392 issue a warning for each extra fast interrupt handler found, as the RX
23393 only supports one such interrupt.
23395 @item -mallow-string-insns
23396 @itemx -mno-allow-string-insns
23397 @opindex mallow-string-insns
23398 @opindex mno-allow-string-insns
23399 Enables or disables the use of the string manipulation instructions
23400 @code{SMOVF}, @code{SCMPU}, @code{SMOVB}, @code{SMOVU}, @code{SUNTIL}
23401 @code{SWHILE} and also the @code{RMPA} instruction.  These
23402 instructions may prefetch data, which is not safe to do if accessing
23403 an I/O register.  (See section 12.2.7 of the RX62N Group User's Manual
23404 for more information).
23406 The default is to allow these instructions, but it is not possible for
23407 GCC to reliably detect all circumstances where a string instruction
23408 might be used to access an I/O register, so their use cannot be
23409 disabled automatically.  Instead it is reliant upon the programmer to
23410 use the @option{-mno-allow-string-insns} option if their program
23411 accesses I/O space.
23413 When the instructions are enabled GCC defines the C preprocessor
23414 symbol @code{__RX_ALLOW_STRING_INSNS__}, otherwise it defines the
23415 symbol @code{__RX_DISALLOW_STRING_INSNS__}.
23417 @item -mjsr
23418 @itemx -mno-jsr
23419 @opindex mjsr
23420 @opindex mno-jsr
23421 Use only (or not only) @code{JSR} instructions to access functions.
23422 This option can be used when code size exceeds the range of @code{BSR}
23423 instructions.  Note that @option{-mno-jsr} does not mean to not use
23424 @code{JSR} but instead means that any type of branch may be used.
23425 @end table
23427 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
23428 has special significance to the RX port when used with the
23429 @code{interrupt} function attribute.  This attribute indicates a
23430 function intended to process fast interrupts.  GCC ensures
23431 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
23432 and/or @code{r13} and only provided that the normal use of the
23433 corresponding registers have been restricted via the
23434 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
23435 options.
23437 @node S/390 and zSeries Options
23438 @subsection S/390 and zSeries Options
23439 @cindex S/390 and zSeries Options
23441 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
23443 @table @gcctabopt
23444 @item -mhard-float
23445 @itemx -msoft-float
23446 @opindex mhard-float
23447 @opindex msoft-float
23448 Use (do not use) the hardware floating-point instructions and registers
23449 for floating-point operations.  When @option{-msoft-float} is specified,
23450 functions in @file{libgcc.a} are used to perform floating-point
23451 operations.  When @option{-mhard-float} is specified, the compiler
23452 generates IEEE floating-point instructions.  This is the default.
23454 @item -mhard-dfp
23455 @itemx -mno-hard-dfp
23456 @opindex mhard-dfp
23457 @opindex mno-hard-dfp
23458 Use (do not use) the hardware decimal-floating-point instructions for
23459 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
23460 specified, functions in @file{libgcc.a} are used to perform
23461 decimal-floating-point operations.  When @option{-mhard-dfp} is
23462 specified, the compiler generates decimal-floating-point hardware
23463 instructions.  This is the default for @option{-march=z9-ec} or higher.
23465 @item -mlong-double-64
23466 @itemx -mlong-double-128
23467 @opindex mlong-double-64
23468 @opindex mlong-double-128
23469 These switches control the size of @code{long double} type. A size
23470 of 64 bits makes the @code{long double} type equivalent to the @code{double}
23471 type. This is the default.
23473 @item -mbackchain
23474 @itemx -mno-backchain
23475 @opindex mbackchain
23476 @opindex mno-backchain
23477 Store (do not store) the address of the caller's frame as backchain pointer
23478 into the callee's stack frame.
23479 A backchain may be needed to allow debugging using tools that do not understand
23480 DWARF call frame information.
23481 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
23482 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
23483 the backchain is placed into the topmost word of the 96/160 byte register
23484 save area.
23486 In general, code compiled with @option{-mbackchain} is call-compatible with
23487 code compiled with @option{-mmo-backchain}; however, use of the backchain
23488 for debugging purposes usually requires that the whole binary is built with
23489 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
23490 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
23491 to build a linux kernel use @option{-msoft-float}.
23493 The default is to not maintain the backchain.
23495 @item -mpacked-stack
23496 @itemx -mno-packed-stack
23497 @opindex mpacked-stack
23498 @opindex mno-packed-stack
23499 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
23500 specified, the compiler uses the all fields of the 96/160 byte register save
23501 area only for their default purpose; unused fields still take up stack space.
23502 When @option{-mpacked-stack} is specified, register save slots are densely
23503 packed at the top of the register save area; unused space is reused for other
23504 purposes, allowing for more efficient use of the available stack space.
23505 However, when @option{-mbackchain} is also in effect, the topmost word of
23506 the save area is always used to store the backchain, and the return address
23507 register is always saved two words below the backchain.
23509 As long as the stack frame backchain is not used, code generated with
23510 @option{-mpacked-stack} is call-compatible with code generated with
23511 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
23512 S/390 or zSeries generated code that uses the stack frame backchain at run
23513 time, not just for debugging purposes.  Such code is not call-compatible
23514 with code compiled with @option{-mpacked-stack}.  Also, note that the
23515 combination of @option{-mbackchain},
23516 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
23517 to build a linux kernel use @option{-msoft-float}.
23519 The default is to not use the packed stack layout.
23521 @item -msmall-exec
23522 @itemx -mno-small-exec
23523 @opindex msmall-exec
23524 @opindex mno-small-exec
23525 Generate (or do not generate) code using the @code{bras} instruction
23526 to do subroutine calls.
23527 This only works reliably if the total executable size does not
23528 exceed 64k.  The default is to use the @code{basr} instruction instead,
23529 which does not have this limitation.
23531 @item -m64
23532 @itemx -m31
23533 @opindex m64
23534 @opindex m31
23535 When @option{-m31} is specified, generate code compliant to the
23536 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
23537 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
23538 particular to generate 64-bit instructions.  For the @samp{s390}
23539 targets, the default is @option{-m31}, while the @samp{s390x}
23540 targets default to @option{-m64}.
23542 @item -mzarch
23543 @itemx -mesa
23544 @opindex mzarch
23545 @opindex mesa
23546 When @option{-mzarch} is specified, generate code using the
23547 instructions available on z/Architecture.
23548 When @option{-mesa} is specified, generate code using the
23549 instructions available on ESA/390.  Note that @option{-mesa} is
23550 not possible with @option{-m64}.
23551 When generating code compliant to the GNU/Linux for S/390 ABI,
23552 the default is @option{-mesa}.  When generating code compliant
23553 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
23555 @item -mhtm
23556 @itemx -mno-htm
23557 @opindex mhtm
23558 @opindex mno-htm
23559 The @option{-mhtm} option enables a set of builtins making use of
23560 instructions available with the transactional execution facility
23561 introduced with the IBM zEnterprise EC12 machine generation
23562 @ref{S/390 System z Built-in Functions}.
23563 @option{-mhtm} is enabled by default when using @option{-march=zEC12}.
23565 @item -mvx
23566 @itemx -mno-vx
23567 @opindex mvx
23568 @opindex mno-vx
23569 When @option{-mvx} is specified, generate code using the instructions
23570 available with the vector extension facility introduced with the IBM
23571 z13 machine generation.
23572 This option changes the ABI for some vector type values with regard to
23573 alignment and calling conventions.  In case vector type values are
23574 being used in an ABI-relevant context a GAS @samp{.gnu_attribute}
23575 command will be added to mark the resulting binary with the ABI used.
23576 @option{-mvx} is enabled by default when using @option{-march=z13}.
23578 @item -mzvector
23579 @itemx -mno-zvector
23580 @opindex mzvector
23581 @opindex mno-zvector
23582 The @option{-mzvector} option enables vector language extensions and
23583 builtins using instructions available with the vector extension
23584 facility introduced with the IBM z13 machine generation.
23585 This option adds support for @samp{vector} to be used as a keyword to
23586 define vector type variables and arguments.  @samp{vector} is only
23587 available when GNU extensions are enabled.  It will not be expanded
23588 when requesting strict standard compliance e.g. with @option{-std=c99}.
23589 In addition to the GCC low-level builtins @option{-mzvector} enables
23590 a set of builtins added for compatibility with AltiVec-style
23591 implementations like Power and Cell.  In order to make use of these
23592 builtins the header file @file{vecintrin.h} needs to be included.
23593 @option{-mzvector} is disabled by default.
23595 @item -mmvcle
23596 @itemx -mno-mvcle
23597 @opindex mmvcle
23598 @opindex mno-mvcle
23599 Generate (or do not generate) code using the @code{mvcle} instruction
23600 to perform block moves.  When @option{-mno-mvcle} is specified,
23601 use a @code{mvc} loop instead.  This is the default unless optimizing for
23602 size.
23604 @item -mdebug
23605 @itemx -mno-debug
23606 @opindex mdebug
23607 @opindex mno-debug
23608 Print (or do not print) additional debug information when compiling.
23609 The default is to not print debug information.
23611 @item -march=@var{cpu-type}
23612 @opindex march
23613 Generate code that runs on @var{cpu-type}, which is the name of a
23614 system representing a certain processor type.  Possible values for
23615 @var{cpu-type} are @samp{z900}/@samp{arch5}, @samp{z990}/@samp{arch6},
23616 @samp{z9-109}, @samp{z9-ec}/@samp{arch7}, @samp{z10}/@samp{arch8},
23617 @samp{z196}/@samp{arch9}, @samp{zEC12}, @samp{z13}/@samp{arch11}, and
23618 @samp{native}.
23620 The default is @option{-march=z900}.  @samp{g5}/@samp{arch3} and
23621 @samp{g6} are deprecated and will be removed with future releases.
23623 Specifying @samp{native} as cpu type can be used to select the best
23624 architecture option for the host processor.
23625 @option{-march=native} has no effect if GCC does not recognize the
23626 processor.
23628 @item -mtune=@var{cpu-type}
23629 @opindex mtune
23630 Tune to @var{cpu-type} everything applicable about the generated code,
23631 except for the ABI and the set of available instructions.
23632 The list of @var{cpu-type} values is the same as for @option{-march}.
23633 The default is the value used for @option{-march}.
23635 @item -mtpf-trace
23636 @itemx -mno-tpf-trace
23637 @opindex mtpf-trace
23638 @opindex mno-tpf-trace
23639 Generate code that adds (does not add) in TPF OS specific branches to trace
23640 routines in the operating system.  This option is off by default, even
23641 when compiling for the TPF OS@.
23643 @item -mfused-madd
23644 @itemx -mno-fused-madd
23645 @opindex mfused-madd
23646 @opindex mno-fused-madd
23647 Generate code that uses (does not use) the floating-point multiply and
23648 accumulate instructions.  These instructions are generated by default if
23649 hardware floating point is used.
23651 @item -mwarn-framesize=@var{framesize}
23652 @opindex mwarn-framesize
23653 Emit a warning if the current function exceeds the given frame size.  Because
23654 this is a compile-time check it doesn't need to be a real problem when the program
23655 runs.  It is intended to identify functions that most probably cause
23656 a stack overflow.  It is useful to be used in an environment with limited stack
23657 size e.g.@: the linux kernel.
23659 @item -mwarn-dynamicstack
23660 @opindex mwarn-dynamicstack
23661 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
23662 arrays.  This is generally a bad idea with a limited stack size.
23664 @item -mstack-guard=@var{stack-guard}
23665 @itemx -mstack-size=@var{stack-size}
23666 @opindex mstack-guard
23667 @opindex mstack-size
23668 If these options are provided the S/390 back end emits additional instructions in
23669 the function prologue that trigger a trap if the stack size is @var{stack-guard}
23670 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
23671 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
23672 the frame size of the compiled function is chosen.
23673 These options are intended to be used to help debugging stack overflow problems.
23674 The additionally emitted code causes only little overhead and hence can also be
23675 used in production-like systems without greater performance degradation.  The given
23676 values have to be exact powers of 2 and @var{stack-size} has to be greater than
23677 @var{stack-guard} without exceeding 64k.
23678 In order to be efficient the extra code makes the assumption that the stack starts
23679 at an address aligned to the value given by @var{stack-size}.
23680 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
23682 @item -mhotpatch=@var{pre-halfwords},@var{post-halfwords}
23683 @opindex mhotpatch
23684 If the hotpatch option is enabled, a ``hot-patching'' function
23685 prologue is generated for all functions in the compilation unit.
23686 The funtion label is prepended with the given number of two-byte
23687 NOP instructions (@var{pre-halfwords}, maximum 1000000).  After
23688 the label, 2 * @var{post-halfwords} bytes are appended, using the
23689 largest NOP like instructions the architecture allows (maximum
23690 1000000).
23692 If both arguments are zero, hotpatching is disabled.
23694 This option can be overridden for individual functions with the
23695 @code{hotpatch} attribute.
23696 @end table
23698 @node Score Options
23699 @subsection Score Options
23700 @cindex Score Options
23702 These options are defined for Score implementations:
23704 @table @gcctabopt
23705 @item -meb
23706 @opindex meb
23707 Compile code for big-endian mode.  This is the default.
23709 @item -mel
23710 @opindex mel
23711 Compile code for little-endian mode.
23713 @item -mnhwloop
23714 @opindex mnhwloop
23715 Disable generation of @code{bcnz} instructions.
23717 @item -muls
23718 @opindex muls
23719 Enable generation of unaligned load and store instructions.
23721 @item -mmac
23722 @opindex mmac
23723 Enable the use of multiply-accumulate instructions. Disabled by default.
23725 @item -mscore5
23726 @opindex mscore5
23727 Specify the SCORE5 as the target architecture.
23729 @item -mscore5u
23730 @opindex mscore5u
23731 Specify the SCORE5U of the target architecture.
23733 @item -mscore7
23734 @opindex mscore7
23735 Specify the SCORE7 as the target architecture. This is the default.
23737 @item -mscore7d
23738 @opindex mscore7d
23739 Specify the SCORE7D as the target architecture.
23740 @end table
23742 @node SH Options
23743 @subsection SH Options
23745 These @samp{-m} options are defined for the SH implementations:
23747 @table @gcctabopt
23748 @item -m1
23749 @opindex m1
23750 Generate code for the SH1.
23752 @item -m2
23753 @opindex m2
23754 Generate code for the SH2.
23756 @item -m2e
23757 Generate code for the SH2e.
23759 @item -m2a-nofpu
23760 @opindex m2a-nofpu
23761 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
23762 that the floating-point unit is not used.
23764 @item -m2a-single-only
23765 @opindex m2a-single-only
23766 Generate code for the SH2a-FPU, in such a way that no double-precision
23767 floating-point operations are used.
23769 @item -m2a-single
23770 @opindex m2a-single
23771 Generate code for the SH2a-FPU assuming the floating-point unit is in
23772 single-precision mode by default.
23774 @item -m2a
23775 @opindex m2a
23776 Generate code for the SH2a-FPU assuming the floating-point unit is in
23777 double-precision mode by default.
23779 @item -m3
23780 @opindex m3
23781 Generate code for the SH3.
23783 @item -m3e
23784 @opindex m3e
23785 Generate code for the SH3e.
23787 @item -m4-nofpu
23788 @opindex m4-nofpu
23789 Generate code for the SH4 without a floating-point unit.
23791 @item -m4-single-only
23792 @opindex m4-single-only
23793 Generate code for the SH4 with a floating-point unit that only
23794 supports single-precision arithmetic.
23796 @item -m4-single
23797 @opindex m4-single
23798 Generate code for the SH4 assuming the floating-point unit is in
23799 single-precision mode by default.
23801 @item -m4
23802 @opindex m4
23803 Generate code for the SH4.
23805 @item -m4-100
23806 @opindex m4-100
23807 Generate code for SH4-100.
23809 @item -m4-100-nofpu
23810 @opindex m4-100-nofpu
23811 Generate code for SH4-100 in such a way that the
23812 floating-point unit is not used.
23814 @item -m4-100-single
23815 @opindex m4-100-single
23816 Generate code for SH4-100 assuming the floating-point unit is in
23817 single-precision mode by default.
23819 @item -m4-100-single-only
23820 @opindex m4-100-single-only
23821 Generate code for SH4-100 in such a way that no double-precision
23822 floating-point operations are used.
23824 @item -m4-200
23825 @opindex m4-200
23826 Generate code for SH4-200.
23828 @item -m4-200-nofpu
23829 @opindex m4-200-nofpu
23830 Generate code for SH4-200 without in such a way that the
23831 floating-point unit is not used.
23833 @item -m4-200-single
23834 @opindex m4-200-single
23835 Generate code for SH4-200 assuming the floating-point unit is in
23836 single-precision mode by default.
23838 @item -m4-200-single-only
23839 @opindex m4-200-single-only
23840 Generate code for SH4-200 in such a way that no double-precision
23841 floating-point operations are used.
23843 @item -m4-300
23844 @opindex m4-300
23845 Generate code for SH4-300.
23847 @item -m4-300-nofpu
23848 @opindex m4-300-nofpu
23849 Generate code for SH4-300 without in such a way that the
23850 floating-point unit is not used.
23852 @item -m4-300-single
23853 @opindex m4-300-single
23854 Generate code for SH4-300 in such a way that no double-precision
23855 floating-point operations are used.
23857 @item -m4-300-single-only
23858 @opindex m4-300-single-only
23859 Generate code for SH4-300 in such a way that no double-precision
23860 floating-point operations are used.
23862 @item -m4-340
23863 @opindex m4-340
23864 Generate code for SH4-340 (no MMU, no FPU).
23866 @item -m4-500
23867 @opindex m4-500
23868 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
23869 assembler.
23871 @item -m4a-nofpu
23872 @opindex m4a-nofpu
23873 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
23874 floating-point unit is not used.
23876 @item -m4a-single-only
23877 @opindex m4a-single-only
23878 Generate code for the SH4a, in such a way that no double-precision
23879 floating-point operations are used.
23881 @item -m4a-single
23882 @opindex m4a-single
23883 Generate code for the SH4a assuming the floating-point unit is in
23884 single-precision mode by default.
23886 @item -m4a
23887 @opindex m4a
23888 Generate code for the SH4a.
23890 @item -m4al
23891 @opindex m4al
23892 Same as @option{-m4a-nofpu}, except that it implicitly passes
23893 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
23894 instructions at the moment.
23896 @item -mb
23897 @opindex mb
23898 Compile code for the processor in big-endian mode.
23900 @item -ml
23901 @opindex ml
23902 Compile code for the processor in little-endian mode.
23904 @item -mdalign
23905 @opindex mdalign
23906 Align doubles at 64-bit boundaries.  Note that this changes the calling
23907 conventions, and thus some functions from the standard C library do
23908 not work unless you recompile it first with @option{-mdalign}.
23910 @item -mrelax
23911 @opindex mrelax
23912 Shorten some address references at link time, when possible; uses the
23913 linker option @option{-relax}.
23915 @item -mbigtable
23916 @opindex mbigtable
23917 Use 32-bit offsets in @code{switch} tables.  The default is to use
23918 16-bit offsets.
23920 @item -mbitops
23921 @opindex mbitops
23922 Enable the use of bit manipulation instructions on SH2A.
23924 @item -mfmovd
23925 @opindex mfmovd
23926 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
23927 alignment constraints.
23929 @item -mrenesas
23930 @opindex mrenesas
23931 Comply with the calling conventions defined by Renesas.
23933 @item -mno-renesas
23934 @opindex mno-renesas
23935 Comply with the calling conventions defined for GCC before the Renesas
23936 conventions were available.  This option is the default for all
23937 targets of the SH toolchain.
23939 @item -mnomacsave
23940 @opindex mnomacsave
23941 Mark the @code{MAC} register as call-clobbered, even if
23942 @option{-mrenesas} is given.
23944 @item -mieee
23945 @itemx -mno-ieee
23946 @opindex mieee
23947 @opindex mno-ieee
23948 Control the IEEE compliance of floating-point comparisons, which affects the
23949 handling of cases where the result of a comparison is unordered.  By default
23950 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
23951 enabled @option{-mno-ieee} is implicitly set, which results in faster
23952 floating-point greater-equal and less-equal comparisons.  The implicit settings
23953 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
23955 @item -minline-ic_invalidate
23956 @opindex minline-ic_invalidate
23957 Inline code to invalidate instruction cache entries after setting up
23958 nested function trampolines.
23959 This option has no effect if @option{-musermode} is in effect and the selected
23960 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
23961 instruction.
23962 If the selected code generation option does not allow the use of the @code{icbi}
23963 instruction, and @option{-musermode} is not in effect, the inlined code
23964 manipulates the instruction cache address array directly with an associative
23965 write.  This not only requires privileged mode at run time, but it also
23966 fails if the cache line had been mapped via the TLB and has become unmapped.
23968 @item -misize
23969 @opindex misize
23970 Dump instruction size and location in the assembly code.
23972 @item -mpadstruct
23973 @opindex mpadstruct
23974 This option is deprecated.  It pads structures to multiple of 4 bytes,
23975 which is incompatible with the SH ABI@.
23977 @item -matomic-model=@var{model}
23978 @opindex matomic-model=@var{model}
23979 Sets the model of atomic operations and additional parameters as a comma
23980 separated list.  For details on the atomic built-in functions see
23981 @ref{__atomic Builtins}.  The following models and parameters are supported:
23983 @table @samp
23985 @item none
23986 Disable compiler generated atomic sequences and emit library calls for atomic
23987 operations.  This is the default if the target is not @code{sh*-*-linux*}.
23989 @item soft-gusa
23990 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
23991 built-in functions.  The generated atomic sequences require additional support
23992 from the interrupt/exception handling code of the system and are only suitable
23993 for SH3* and SH4* single-core systems.  This option is enabled by default when
23994 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
23995 this option also partially utilizes the hardware atomic instructions
23996 @code{movli.l} and @code{movco.l} to create more efficient code, unless
23997 @samp{strict} is specified.  
23999 @item soft-tcb
24000 Generate software atomic sequences that use a variable in the thread control
24001 block.  This is a variation of the gUSA sequences which can also be used on
24002 SH1* and SH2* targets.  The generated atomic sequences require additional
24003 support from the interrupt/exception handling code of the system and are only
24004 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
24005 parameter has to be specified as well.
24007 @item soft-imask
24008 Generate software atomic sequences that temporarily disable interrupts by
24009 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
24010 in privileged mode and is only suitable for single-core systems.  Additional
24011 support from the interrupt/exception handling code of the system is not
24012 required.  This model is enabled by default when the target is
24013 @code{sh*-*-linux*} and SH1* or SH2*.
24015 @item hard-llcs
24016 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
24017 instructions only.  This is only available on SH4A and is suitable for
24018 multi-core systems.  Since the hardware instructions support only 32 bit atomic
24019 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
24020 Code compiled with this option is also compatible with other software
24021 atomic model interrupt/exception handling systems if executed on an SH4A
24022 system.  Additional support from the interrupt/exception handling code of the
24023 system is not required for this model.
24025 @item gbr-offset=
24026 This parameter specifies the offset in bytes of the variable in the thread
24027 control block structure that should be used by the generated atomic sequences
24028 when the @samp{soft-tcb} model has been selected.  For other models this
24029 parameter is ignored.  The specified value must be an integer multiple of four
24030 and in the range 0-1020.
24032 @item strict
24033 This parameter prevents mixed usage of multiple atomic models, even if they
24034 are compatible, and makes the compiler generate atomic sequences of the
24035 specified model only.
24037 @end table
24039 @item -mtas
24040 @opindex mtas
24041 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
24042 Notice that depending on the particular hardware and software configuration
24043 this can degrade overall performance due to the operand cache line flushes
24044 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
24045 processors the @code{tas.b} instruction must be used with caution since it
24046 can result in data corruption for certain cache configurations.
24048 @item -mprefergot
24049 @opindex mprefergot
24050 When generating position-independent code, emit function calls using
24051 the Global Offset Table instead of the Procedure Linkage Table.
24053 @item -musermode
24054 @itemx -mno-usermode
24055 @opindex musermode
24056 @opindex mno-usermode
24057 Don't allow (allow) the compiler generating privileged mode code.  Specifying
24058 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
24059 inlined code would not work in user mode.  @option{-musermode} is the default
24060 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
24061 @option{-musermode} has no effect, since there is no user mode.
24063 @item -multcost=@var{number}
24064 @opindex multcost=@var{number}
24065 Set the cost to assume for a multiply insn.
24067 @item -mdiv=@var{strategy}
24068 @opindex mdiv=@var{strategy}
24069 Set the division strategy to be used for integer division operations.
24070 @var{strategy} can be one of: 
24072 @table @samp
24074 @item call-div1
24075 Calls a library function that uses the single-step division instruction
24076 @code{div1} to perform the operation.  Division by zero calculates an
24077 unspecified result and does not trap.  This is the default except for SH4,
24078 SH2A and SHcompact.
24080 @item call-fp
24081 Calls a library function that performs the operation in double precision
24082 floating point.  Division by zero causes a floating-point exception.  This is
24083 the default for SHcompact with FPU.  Specifying this for targets that do not
24084 have a double precision FPU defaults to @code{call-div1}.
24086 @item call-table
24087 Calls a library function that uses a lookup table for small divisors and
24088 the @code{div1} instruction with case distinction for larger divisors.  Division
24089 by zero calculates an unspecified result and does not trap.  This is the default
24090 for SH4.  Specifying this for targets that do not have dynamic shift
24091 instructions defaults to @code{call-div1}.
24093 @end table
24095 When a division strategy has not been specified the default strategy is
24096 selected based on the current target.  For SH2A the default strategy is to
24097 use the @code{divs} and @code{divu} instructions instead of library function
24098 calls.
24100 @item -maccumulate-outgoing-args
24101 @opindex maccumulate-outgoing-args
24102 Reserve space once for outgoing arguments in the function prologue rather
24103 than around each call.  Generally beneficial for performance and size.  Also
24104 needed for unwinding to avoid changing the stack frame around conditional code.
24106 @item -mdivsi3_libfunc=@var{name}
24107 @opindex mdivsi3_libfunc=@var{name}
24108 Set the name of the library function used for 32-bit signed division to
24109 @var{name}.
24110 This only affects the name used in the @samp{call} division strategies, and
24111 the compiler still expects the same sets of input/output/clobbered registers as
24112 if this option were not present.
24114 @item -mfixed-range=@var{register-range}
24115 @opindex mfixed-range
24116 Generate code treating the given register range as fixed registers.
24117 A fixed register is one that the register allocator can not use.  This is
24118 useful when compiling kernel code.  A register range is specified as
24119 two registers separated by a dash.  Multiple register ranges can be
24120 specified separated by a comma.
24122 @item -mbranch-cost=@var{num}
24123 @opindex mbranch-cost=@var{num}
24124 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
24125 make the compiler try to generate more branch-free code if possible.  
24126 If not specified the value is selected depending on the processor type that
24127 is being compiled for.
24129 @item -mzdcbranch
24130 @itemx -mno-zdcbranch
24131 @opindex mzdcbranch
24132 @opindex mno-zdcbranch
24133 Assume (do not assume) that zero displacement conditional branch instructions
24134 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
24135 compiler prefers zero displacement branch code sequences.  This is
24136 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
24137 disabled by specifying @option{-mno-zdcbranch}.
24139 @item -mcbranch-force-delay-slot
24140 @opindex mcbranch-force-delay-slot
24141 Force the usage of delay slots for conditional branches, which stuffs the delay
24142 slot with a @code{nop} if a suitable instruction cannot be found.  By default
24143 this option is disabled.  It can be enabled to work around hardware bugs as
24144 found in the original SH7055.
24146 @item -mfused-madd
24147 @itemx -mno-fused-madd
24148 @opindex mfused-madd
24149 @opindex mno-fused-madd
24150 Generate code that uses (does not use) the floating-point multiply and
24151 accumulate instructions.  These instructions are generated by default
24152 if hardware floating point is used.  The machine-dependent
24153 @option{-mfused-madd} option is now mapped to the machine-independent
24154 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
24155 mapped to @option{-ffp-contract=off}.
24157 @item -mfsca
24158 @itemx -mno-fsca
24159 @opindex mfsca
24160 @opindex mno-fsca
24161 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
24162 and cosine approximations.  The option @option{-mfsca} must be used in
24163 combination with @option{-funsafe-math-optimizations}.  It is enabled by default
24164 when generating code for SH4A.  Using @option{-mno-fsca} disables sine and cosine
24165 approximations even if @option{-funsafe-math-optimizations} is in effect.
24167 @item -mfsrra
24168 @itemx -mno-fsrra
24169 @opindex mfsrra
24170 @opindex mno-fsrra
24171 Allow or disallow the compiler to emit the @code{fsrra} instruction for
24172 reciprocal square root approximations.  The option @option{-mfsrra} must be used
24173 in combination with @option{-funsafe-math-optimizations} and
24174 @option{-ffinite-math-only}.  It is enabled by default when generating code for
24175 SH4A.  Using @option{-mno-fsrra} disables reciprocal square root approximations
24176 even if @option{-funsafe-math-optimizations} and @option{-ffinite-math-only} are
24177 in effect.
24179 @item -mpretend-cmove
24180 @opindex mpretend-cmove
24181 Prefer zero-displacement conditional branches for conditional move instruction
24182 patterns.  This can result in faster code on the SH4 processor.
24184 @item -mfdpic
24185 @opindex fdpic
24186 Generate code using the FDPIC ABI.
24188 @end table
24190 @node Solaris 2 Options
24191 @subsection Solaris 2 Options
24192 @cindex Solaris 2 options
24194 These @samp{-m} options are supported on Solaris 2:
24196 @table @gcctabopt
24197 @item -mclear-hwcap
24198 @opindex mclear-hwcap
24199 @option{-mclear-hwcap} tells the compiler to remove the hardware
24200 capabilities generated by the Solaris assembler.  This is only necessary
24201 when object files use ISA extensions not supported by the current
24202 machine, but check at runtime whether or not to use them.
24204 @item -mimpure-text
24205 @opindex mimpure-text
24206 @option{-mimpure-text}, used in addition to @option{-shared}, tells
24207 the compiler to not pass @option{-z text} to the linker when linking a
24208 shared object.  Using this option, you can link position-dependent
24209 code into a shared object.
24211 @option{-mimpure-text} suppresses the ``relocations remain against
24212 allocatable but non-writable sections'' linker error message.
24213 However, the necessary relocations trigger copy-on-write, and the
24214 shared object is not actually shared across processes.  Instead of
24215 using @option{-mimpure-text}, you should compile all source code with
24216 @option{-fpic} or @option{-fPIC}.
24218 @end table
24220 These switches are supported in addition to the above on Solaris 2:
24222 @table @gcctabopt
24223 @item -pthreads
24224 @opindex pthreads
24225 This is a synonym for @option{-pthread}.
24226 @end table
24228 @node SPARC Options
24229 @subsection SPARC Options
24230 @cindex SPARC options
24232 These @samp{-m} options are supported on the SPARC:
24234 @table @gcctabopt
24235 @item -mno-app-regs
24236 @itemx -mapp-regs
24237 @opindex mno-app-regs
24238 @opindex mapp-regs
24239 Specify @option{-mapp-regs} to generate output using the global registers
24240 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
24241 global register 1, each global register 2 through 4 is then treated as an
24242 allocable register that is clobbered by function calls.  This is the default.
24244 To be fully SVR4 ABI-compliant at the cost of some performance loss,
24245 specify @option{-mno-app-regs}.  You should compile libraries and system
24246 software with this option.
24248 @item -mflat
24249 @itemx -mno-flat
24250 @opindex mflat
24251 @opindex mno-flat
24252 With @option{-mflat}, the compiler does not generate save/restore instructions
24253 and uses a ``flat'' or single register window model.  This model is compatible
24254 with the regular register window model.  The local registers and the input
24255 registers (0--5) are still treated as ``call-saved'' registers and are
24256 saved on the stack as needed.
24258 With @option{-mno-flat} (the default), the compiler generates save/restore
24259 instructions (except for leaf functions).  This is the normal operating mode.
24261 @item -mfpu
24262 @itemx -mhard-float
24263 @opindex mfpu
24264 @opindex mhard-float
24265 Generate output containing floating-point instructions.  This is the
24266 default.
24268 @item -mno-fpu
24269 @itemx -msoft-float
24270 @opindex mno-fpu
24271 @opindex msoft-float
24272 Generate output containing library calls for floating point.
24273 @strong{Warning:} the requisite libraries are not available for all SPARC
24274 targets.  Normally the facilities of the machine's usual C compiler are
24275 used, but this cannot be done directly in cross-compilation.  You must make
24276 your own arrangements to provide suitable library functions for
24277 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
24278 @samp{sparclite-*-*} do provide software floating-point support.
24280 @option{-msoft-float} changes the calling convention in the output file;
24281 therefore, it is only useful if you compile @emph{all} of a program with
24282 this option.  In particular, you need to compile @file{libgcc.a}, the
24283 library that comes with GCC, with @option{-msoft-float} in order for
24284 this to work.
24286 @item -mhard-quad-float
24287 @opindex mhard-quad-float
24288 Generate output containing quad-word (long double) floating-point
24289 instructions.
24291 @item -msoft-quad-float
24292 @opindex msoft-quad-float
24293 Generate output containing library calls for quad-word (long double)
24294 floating-point instructions.  The functions called are those specified
24295 in the SPARC ABI@.  This is the default.
24297 As of this writing, there are no SPARC implementations that have hardware
24298 support for the quad-word floating-point instructions.  They all invoke
24299 a trap handler for one of these instructions, and then the trap handler
24300 emulates the effect of the instruction.  Because of the trap handler overhead,
24301 this is much slower than calling the ABI library routines.  Thus the
24302 @option{-msoft-quad-float} option is the default.
24304 @item -mno-unaligned-doubles
24305 @itemx -munaligned-doubles
24306 @opindex mno-unaligned-doubles
24307 @opindex munaligned-doubles
24308 Assume that doubles have 8-byte alignment.  This is the default.
24310 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
24311 alignment only if they are contained in another type, or if they have an
24312 absolute address.  Otherwise, it assumes they have 4-byte alignment.
24313 Specifying this option avoids some rare compatibility problems with code
24314 generated by other compilers.  It is not the default because it results
24315 in a performance loss, especially for floating-point code.
24317 @item -muser-mode
24318 @itemx -mno-user-mode
24319 @opindex muser-mode
24320 @opindex mno-user-mode
24321 Do not generate code that can only run in supervisor mode.  This is relevant
24322 only for the @code{casa} instruction emitted for the LEON3 processor.  This
24323 is the default.
24325 @item -mfaster-structs
24326 @itemx -mno-faster-structs
24327 @opindex mfaster-structs
24328 @opindex mno-faster-structs
24329 With @option{-mfaster-structs}, the compiler assumes that structures
24330 should have 8-byte alignment.  This enables the use of pairs of
24331 @code{ldd} and @code{std} instructions for copies in structure
24332 assignment, in place of twice as many @code{ld} and @code{st} pairs.
24333 However, the use of this changed alignment directly violates the SPARC
24334 ABI@.  Thus, it's intended only for use on targets where the developer
24335 acknowledges that their resulting code is not directly in line with
24336 the rules of the ABI@.
24338 @item -mstd-struct-return
24339 @itemx -mno-std-struct-return
24340 @opindex mstd-struct-return
24341 @opindex mno-std-struct-return
24342 With @option{-mstd-struct-return}, the compiler generates checking code
24343 in functions returning structures or unions to detect size mismatches
24344 between the two sides of function calls, as per the 32-bit ABI@.
24346 The default is @option{-mno-std-struct-return}.  This option has no effect
24347 in 64-bit mode.
24349 @item -mlra
24350 @itemx -mno-lra
24351 @opindex mlra
24352 @opindex mno-lra
24353 Enable Local Register Allocation.  This is the default for SPARC since GCC 7
24354 so @option{-mno-lra} needs to be passed to get old Reload.
24356 @item -mcpu=@var{cpu_type}
24357 @opindex mcpu
24358 Set the instruction set, register set, and instruction scheduling parameters
24359 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
24360 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
24361 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
24362 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
24363 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
24364 @samp{niagara3}, @samp{niagara4}, @samp{niagara7} and @samp{m8}.
24366 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
24367 which selects the best architecture option for the host processor.
24368 @option{-mcpu=native} has no effect if GCC does not recognize
24369 the processor.
24371 Default instruction scheduling parameters are used for values that select
24372 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
24373 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
24375 Here is a list of each supported architecture and their supported
24376 implementations.
24378 @table @asis
24379 @item v7
24380 cypress, leon3v7
24382 @item v8
24383 supersparc, hypersparc, leon, leon3
24385 @item sparclite
24386 f930, f934, sparclite86x
24388 @item sparclet
24389 tsc701
24391 @item v9
24392 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4,
24393 niagara7, m8
24394 @end table
24396 By default (unless configured otherwise), GCC generates code for the V7
24397 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
24398 additionally optimizes it for the Cypress CY7C602 chip, as used in the
24399 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
24400 SPARCStation 1, 2, IPX etc.
24402 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
24403 architecture.  The only difference from V7 code is that the compiler emits
24404 the integer multiply and integer divide instructions which exist in SPARC-V8
24405 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
24406 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
24407 2000 series.
24409 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
24410 the SPARC architecture.  This adds the integer multiply, integer divide step
24411 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
24412 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
24413 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
24414 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
24415 MB86934 chip, which is the more recent SPARClite with FPU@.
24417 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
24418 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
24419 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
24420 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
24421 optimizes it for the TEMIC SPARClet chip.
24423 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
24424 architecture.  This adds 64-bit integer and floating-point move instructions,
24425 3 additional floating-point condition code registers and conditional move
24426 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
24427 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
24428 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
24429 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
24430 @option{-mcpu=niagara}, the compiler additionally optimizes it for
24431 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
24432 additionally optimizes it for Sun UltraSPARC T2 chips. With
24433 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
24434 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
24435 additionally optimizes it for Sun UltraSPARC T4 chips.  With
24436 @option{-mcpu=niagara7}, the compiler additionally optimizes it for
24437 Oracle SPARC M7 chips.  With @option{-mcpu=m8}, the compiler
24438 additionally optimizes it for Oracle M8 chips.
24440 @item -mtune=@var{cpu_type}
24441 @opindex mtune
24442 Set the instruction scheduling parameters for machine type
24443 @var{cpu_type}, but do not set the instruction set or register set that the
24444 option @option{-mcpu=@var{cpu_type}} does.
24446 The same values for @option{-mcpu=@var{cpu_type}} can be used for
24447 @option{-mtune=@var{cpu_type}}, but the only useful values are those
24448 that select a particular CPU implementation.  Those are
24449 @samp{cypress}, @samp{supersparc}, @samp{hypersparc}, @samp{leon},
24450 @samp{leon3}, @samp{leon3v7}, @samp{f930}, @samp{f934},
24451 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
24452 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3},
24453 @samp{niagara4}, @samp{niagara7} and @samp{m8}.  With native Solaris
24454 and GNU/Linux toolchains, @samp{native} can also be used.
24456 @item -mv8plus
24457 @itemx -mno-v8plus
24458 @opindex mv8plus
24459 @opindex mno-v8plus
24460 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
24461 difference from the V8 ABI is that the global and out registers are
24462 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
24463 mode for all SPARC-V9 processors.
24465 @item -mvis
24466 @itemx -mno-vis
24467 @opindex mvis
24468 @opindex mno-vis
24469 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
24470 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
24472 @item -mvis2
24473 @itemx -mno-vis2
24474 @opindex mvis2
24475 @opindex mno-vis2
24476 With @option{-mvis2}, GCC generates code that takes advantage of
24477 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
24478 default is @option{-mvis2} when targeting a cpu that supports such
24479 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
24480 also sets @option{-mvis}.
24482 @item -mvis3
24483 @itemx -mno-vis3
24484 @opindex mvis3
24485 @opindex mno-vis3
24486 With @option{-mvis3}, GCC generates code that takes advantage of
24487 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
24488 default is @option{-mvis3} when targeting a cpu that supports such
24489 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
24490 also sets @option{-mvis2} and @option{-mvis}.
24492 @item -mvis4
24493 @itemx -mno-vis4
24494 @opindex mvis4
24495 @opindex mno-vis4
24496 With @option{-mvis4}, GCC generates code that takes advantage of
24497 version 4.0 of the UltraSPARC Visual Instruction Set extensions.  The
24498 default is @option{-mvis4} when targeting a cpu that supports such
24499 instructions, such as niagara-7 and later.  Setting @option{-mvis4}
24500 also sets @option{-mvis3}, @option{-mvis2} and @option{-mvis}.
24502 @item -mvis4b
24503 @itemx -mno-vis4b
24504 @opindex mvis4b
24505 @opindex mno-vis4b
24506 With @option{-mvis4b}, GCC generates code that takes advantage of
24507 version 4.0 of the UltraSPARC Visual Instruction Set extensions, plus
24508 the additional VIS instructions introduced in the Oracle SPARC
24509 Architecture 2017.  The default is @option{-mvis4b} when targeting a
24510 cpu that supports such instructions, such as m8 and later.  Setting
24511 @option{-mvis4b} also sets @option{-mvis4}, @option{-mvis3},
24512 @option{-mvis2} and @option{-mvis}.
24514 @item -mcbcond
24515 @itemx -mno-cbcond
24516 @opindex mcbcond
24517 @opindex mno-cbcond
24518 With @option{-mcbcond}, GCC generates code that takes advantage of the UltraSPARC
24519 Compare-and-Branch-on-Condition instructions.  The default is @option{-mcbcond}
24520 when targeting a CPU that supports such instructions, such as Niagara-4 and
24521 later.
24523 @item -mfmaf
24524 @itemx -mno-fmaf
24525 @opindex mfmaf
24526 @opindex mno-fmaf
24527 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
24528 Fused Multiply-Add Floating-point instructions.  The default is @option{-mfmaf}
24529 when targeting a CPU that supports such instructions, such as Niagara-3 and
24530 later.
24532 @item -mfsmuld
24533 @itemx -mno-fsmuld
24534 @opindex mfsmuld
24535 @opindex mno-fsmuld
24536 With @option{-mfsmuld}, GCC generates code that takes advantage of the
24537 Floating-point Multiply Single to Double (FsMULd) instruction.  The default is
24538 @option{-mfsmuld} when targeting a CPU supporting the architecture versions V8
24539 or V9 with FPU except @option{-mcpu=leon}.
24541 @item -mpopc
24542 @itemx -mno-popc
24543 @opindex mpopc
24544 @opindex mno-popc
24545 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
24546 Population Count instruction.  The default is @option{-mpopc}
24547 when targeting a CPU that supports such an instruction, such as Niagara-2 and
24548 later.
24550 @item -msubxc
24551 @itemx -mno-subxc
24552 @opindex msubxc
24553 @opindex mno-subxc
24554 With @option{-msubxc}, GCC generates code that takes advantage of the UltraSPARC
24555 Subtract-Extended-with-Carry instruction.  The default is @option{-msubxc}
24556 when targeting a CPU that supports such an instruction, such as Niagara-7 and
24557 later.
24559 @item -mfix-at697f
24560 @opindex mfix-at697f
24561 Enable the documented workaround for the single erratum of the Atmel AT697F
24562 processor (which corresponds to erratum #13 of the AT697E processor).
24564 @item -mfix-ut699
24565 @opindex mfix-ut699
24566 Enable the documented workarounds for the floating-point errata and the data
24567 cache nullify errata of the UT699 processor.
24569 @item -mfix-ut700
24570 @opindex mfix-ut700
24571 Enable the documented workaround for the back-to-back store errata of
24572 the UT699E/UT700 processor.
24574 @item -mfix-gr712rc
24575 @opindex mfix-gr712rc
24576 Enable the documented workaround for the back-to-back store errata of
24577 the GR712RC processor.
24578 @end table
24580 These @samp{-m} options are supported in addition to the above
24581 on SPARC-V9 processors in 64-bit environments:
24583 @table @gcctabopt
24584 @item -m32
24585 @itemx -m64
24586 @opindex m32
24587 @opindex m64
24588 Generate code for a 32-bit or 64-bit environment.
24589 The 32-bit environment sets int, long and pointer to 32 bits.
24590 The 64-bit environment sets int to 32 bits and long and pointer
24591 to 64 bits.
24593 @item -mcmodel=@var{which}
24594 @opindex mcmodel
24595 Set the code model to one of
24597 @table @samp
24598 @item medlow
24599 The Medium/Low code model: 64-bit addresses, programs
24600 must be linked in the low 32 bits of memory.  Programs can be statically
24601 or dynamically linked.
24603 @item medmid
24604 The Medium/Middle code model: 64-bit addresses, programs
24605 must be linked in the low 44 bits of memory, the text and data segments must
24606 be less than 2GB in size and the data segment must be located within 2GB of
24607 the text segment.
24609 @item medany
24610 The Medium/Anywhere code model: 64-bit addresses, programs
24611 may be linked anywhere in memory, the text and data segments must be less
24612 than 2GB in size and the data segment must be located within 2GB of the
24613 text segment.
24615 @item embmedany
24616 The Medium/Anywhere code model for embedded systems:
24617 64-bit addresses, the text and data segments must be less than 2GB in
24618 size, both starting anywhere in memory (determined at link time).  The
24619 global register %g4 points to the base of the data segment.  Programs
24620 are statically linked and PIC is not supported.
24621 @end table
24623 @item -mmemory-model=@var{mem-model}
24624 @opindex mmemory-model
24625 Set the memory model in force on the processor to one of
24627 @table @samp
24628 @item default
24629 The default memory model for the processor and operating system.
24631 @item rmo
24632 Relaxed Memory Order
24634 @item pso
24635 Partial Store Order
24637 @item tso
24638 Total Store Order
24640 @item sc
24641 Sequential Consistency
24642 @end table
24644 These memory models are formally defined in Appendix D of the SPARC-V9
24645 architecture manual, as set in the processor's @code{PSTATE.MM} field.
24647 @item -mstack-bias
24648 @itemx -mno-stack-bias
24649 @opindex mstack-bias
24650 @opindex mno-stack-bias
24651 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
24652 frame pointer if present, are offset by @minus{}2047 which must be added back
24653 when making stack frame references.  This is the default in 64-bit mode.
24654 Otherwise, assume no such offset is present.
24655 @end table
24657 @node SPU Options
24658 @subsection SPU Options
24659 @cindex SPU options
24661 These @samp{-m} options are supported on the SPU:
24663 @table @gcctabopt
24664 @item -mwarn-reloc
24665 @itemx -merror-reloc
24666 @opindex mwarn-reloc
24667 @opindex merror-reloc
24669 The loader for SPU does not handle dynamic relocations.  By default, GCC
24670 gives an error when it generates code that requires a dynamic
24671 relocation.  @option{-mno-error-reloc} disables the error,
24672 @option{-mwarn-reloc} generates a warning instead.
24674 @item -msafe-dma
24675 @itemx -munsafe-dma
24676 @opindex msafe-dma
24677 @opindex munsafe-dma
24679 Instructions that initiate or test completion of DMA must not be
24680 reordered with respect to loads and stores of the memory that is being
24681 accessed.
24682 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
24683 memory accesses, but that can lead to inefficient code in places where the
24684 memory is known to not change.  Rather than mark the memory as volatile,
24685 you can use @option{-msafe-dma} to tell the compiler to treat
24686 the DMA instructions as potentially affecting all memory.  
24688 @item -mbranch-hints
24689 @opindex mbranch-hints
24691 By default, GCC generates a branch hint instruction to avoid
24692 pipeline stalls for always-taken or probably-taken branches.  A hint
24693 is not generated closer than 8 instructions away from its branch.
24694 There is little reason to disable them, except for debugging purposes,
24695 or to make an object a little bit smaller.
24697 @item -msmall-mem
24698 @itemx -mlarge-mem
24699 @opindex msmall-mem
24700 @opindex mlarge-mem
24702 By default, GCC generates code assuming that addresses are never larger
24703 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
24704 a full 32-bit address.
24706 @item -mstdmain
24707 @opindex mstdmain
24709 By default, GCC links against startup code that assumes the SPU-style
24710 main function interface (which has an unconventional parameter list).
24711 With @option{-mstdmain}, GCC links your program against startup
24712 code that assumes a C99-style interface to @code{main}, including a
24713 local copy of @code{argv} strings.
24715 @item -mfixed-range=@var{register-range}
24716 @opindex mfixed-range
24717 Generate code treating the given register range as fixed registers.
24718 A fixed register is one that the register allocator cannot use.  This is
24719 useful when compiling kernel code.  A register range is specified as
24720 two registers separated by a dash.  Multiple register ranges can be
24721 specified separated by a comma.
24723 @item -mea32
24724 @itemx -mea64
24725 @opindex mea32
24726 @opindex mea64
24727 Compile code assuming that pointers to the PPU address space accessed
24728 via the @code{__ea} named address space qualifier are either 32 or 64
24729 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
24730 all object code in an executable must be compiled with the same setting.
24732 @item -maddress-space-conversion
24733 @itemx -mno-address-space-conversion
24734 @opindex maddress-space-conversion
24735 @opindex mno-address-space-conversion
24736 Allow/disallow treating the @code{__ea} address space as superset
24737 of the generic address space.  This enables explicit type casts
24738 between @code{__ea} and generic pointer as well as implicit
24739 conversions of generic pointers to @code{__ea} pointers.  The
24740 default is to allow address space pointer conversions.
24742 @item -mcache-size=@var{cache-size}
24743 @opindex mcache-size
24744 This option controls the version of libgcc that the compiler links to an
24745 executable and selects a software-managed cache for accessing variables
24746 in the @code{__ea} address space with a particular cache size.  Possible
24747 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
24748 and @samp{128}.  The default cache size is 64KB.
24750 @item -matomic-updates
24751 @itemx -mno-atomic-updates
24752 @opindex matomic-updates
24753 @opindex mno-atomic-updates
24754 This option controls the version of libgcc that the compiler links to an
24755 executable and selects whether atomic updates to the software-managed
24756 cache of PPU-side variables are used.  If you use atomic updates, changes
24757 to a PPU variable from SPU code using the @code{__ea} named address space
24758 qualifier do not interfere with changes to other PPU variables residing
24759 in the same cache line from PPU code.  If you do not use atomic updates,
24760 such interference may occur; however, writing back cache lines is
24761 more efficient.  The default behavior is to use atomic updates.
24763 @item -mdual-nops
24764 @itemx -mdual-nops=@var{n}
24765 @opindex mdual-nops
24766 By default, GCC inserts NOPs to increase dual issue when it expects
24767 it to increase performance.  @var{n} can be a value from 0 to 10.  A
24768 smaller @var{n} inserts fewer NOPs.  10 is the default, 0 is the
24769 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
24771 @item -mhint-max-nops=@var{n}
24772 @opindex mhint-max-nops
24773 Maximum number of NOPs to insert for a branch hint.  A branch hint must
24774 be at least 8 instructions away from the branch it is affecting.  GCC
24775 inserts up to @var{n} NOPs to enforce this, otherwise it does not
24776 generate the branch hint.
24778 @item -mhint-max-distance=@var{n}
24779 @opindex mhint-max-distance
24780 The encoding of the branch hint instruction limits the hint to be within
24781 256 instructions of the branch it is affecting.  By default, GCC makes
24782 sure it is within 125.
24784 @item -msafe-hints
24785 @opindex msafe-hints
24786 Work around a hardware bug that causes the SPU to stall indefinitely.
24787 By default, GCC inserts the @code{hbrp} instruction to make sure
24788 this stall won't happen.
24790 @end table
24792 @node System V Options
24793 @subsection Options for System V
24795 These additional options are available on System V Release 4 for
24796 compatibility with other compilers on those systems:
24798 @table @gcctabopt
24799 @item -G
24800 @opindex G
24801 Create a shared object.
24802 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
24804 @item -Qy
24805 @opindex Qy
24806 Identify the versions of each tool used by the compiler, in a
24807 @code{.ident} assembler directive in the output.
24809 @item -Qn
24810 @opindex Qn
24811 Refrain from adding @code{.ident} directives to the output file (this is
24812 the default).
24814 @item -YP,@var{dirs}
24815 @opindex YP
24816 Search the directories @var{dirs}, and no others, for libraries
24817 specified with @option{-l}.
24819 @item -Ym,@var{dir}
24820 @opindex Ym
24821 Look in the directory @var{dir} to find the M4 preprocessor.
24822 The assembler uses this option.
24823 @c This is supposed to go with a -Yd for predefined M4 macro files, but
24824 @c the generic assembler that comes with Solaris takes just -Ym.
24825 @end table
24827 @node TILE-Gx Options
24828 @subsection TILE-Gx Options
24829 @cindex TILE-Gx options
24831 These @samp{-m} options are supported on the TILE-Gx:
24833 @table @gcctabopt
24834 @item -mcmodel=small
24835 @opindex mcmodel=small
24836 Generate code for the small model.  The distance for direct calls is
24837 limited to 500M in either direction.  PC-relative addresses are 32
24838 bits.  Absolute addresses support the full address range.
24840 @item -mcmodel=large
24841 @opindex mcmodel=large
24842 Generate code for the large model.  There is no limitation on call
24843 distance, pc-relative addresses, or absolute addresses.
24845 @item -mcpu=@var{name}
24846 @opindex mcpu
24847 Selects the type of CPU to be targeted.  Currently the only supported
24848 type is @samp{tilegx}.
24850 @item -m32
24851 @itemx -m64
24852 @opindex m32
24853 @opindex m64
24854 Generate code for a 32-bit or 64-bit environment.  The 32-bit
24855 environment sets int, long, and pointer to 32 bits.  The 64-bit
24856 environment sets int to 32 bits and long and pointer to 64 bits.
24858 @item -mbig-endian
24859 @itemx -mlittle-endian
24860 @opindex mbig-endian
24861 @opindex mlittle-endian
24862 Generate code in big/little endian mode, respectively.
24863 @end table
24865 @node TILEPro Options
24866 @subsection TILEPro Options
24867 @cindex TILEPro options
24869 These @samp{-m} options are supported on the TILEPro:
24871 @table @gcctabopt
24872 @item -mcpu=@var{name}
24873 @opindex mcpu
24874 Selects the type of CPU to be targeted.  Currently the only supported
24875 type is @samp{tilepro}.
24877 @item -m32
24878 @opindex m32
24879 Generate code for a 32-bit environment, which sets int, long, and
24880 pointer to 32 bits.  This is the only supported behavior so the flag
24881 is essentially ignored.
24882 @end table
24884 @node V850 Options
24885 @subsection V850 Options
24886 @cindex V850 Options
24888 These @samp{-m} options are defined for V850 implementations:
24890 @table @gcctabopt
24891 @item -mlong-calls
24892 @itemx -mno-long-calls
24893 @opindex mlong-calls
24894 @opindex mno-long-calls
24895 Treat all calls as being far away (near).  If calls are assumed to be
24896 far away, the compiler always loads the function's address into a
24897 register, and calls indirect through the pointer.
24899 @item -mno-ep
24900 @itemx -mep
24901 @opindex mno-ep
24902 @opindex mep
24903 Do not optimize (do optimize) basic blocks that use the same index
24904 pointer 4 or more times to copy pointer into the @code{ep} register, and
24905 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
24906 option is on by default if you optimize.
24908 @item -mno-prolog-function
24909 @itemx -mprolog-function
24910 @opindex mno-prolog-function
24911 @opindex mprolog-function
24912 Do not use (do use) external functions to save and restore registers
24913 at the prologue and epilogue of a function.  The external functions
24914 are slower, but use less code space if more than one function saves
24915 the same number of registers.  The @option{-mprolog-function} option
24916 is on by default if you optimize.
24918 @item -mspace
24919 @opindex mspace
24920 Try to make the code as small as possible.  At present, this just turns
24921 on the @option{-mep} and @option{-mprolog-function} options.
24923 @item -mtda=@var{n}
24924 @opindex mtda
24925 Put static or global variables whose size is @var{n} bytes or less into
24926 the tiny data area that register @code{ep} points to.  The tiny data
24927 area can hold up to 256 bytes in total (128 bytes for byte references).
24929 @item -msda=@var{n}
24930 @opindex msda
24931 Put static or global variables whose size is @var{n} bytes or less into
24932 the small data area that register @code{gp} points to.  The small data
24933 area can hold up to 64 kilobytes.
24935 @item -mzda=@var{n}
24936 @opindex mzda
24937 Put static or global variables whose size is @var{n} bytes or less into
24938 the first 32 kilobytes of memory.
24940 @item -mv850
24941 @opindex mv850
24942 Specify that the target processor is the V850.
24944 @item -mv850e3v5
24945 @opindex mv850e3v5
24946 Specify that the target processor is the V850E3V5.  The preprocessor
24947 constant @code{__v850e3v5__} is defined if this option is used.
24949 @item -mv850e2v4
24950 @opindex mv850e2v4
24951 Specify that the target processor is the V850E3V5.  This is an alias for
24952 the @option{-mv850e3v5} option.
24954 @item -mv850e2v3
24955 @opindex mv850e2v3
24956 Specify that the target processor is the V850E2V3.  The preprocessor
24957 constant @code{__v850e2v3__} is defined if this option is used.
24959 @item -mv850e2
24960 @opindex mv850e2
24961 Specify that the target processor is the V850E2.  The preprocessor
24962 constant @code{__v850e2__} is defined if this option is used.
24964 @item -mv850e1
24965 @opindex mv850e1
24966 Specify that the target processor is the V850E1.  The preprocessor
24967 constants @code{__v850e1__} and @code{__v850e__} are defined if
24968 this option is used.
24970 @item -mv850es
24971 @opindex mv850es
24972 Specify that the target processor is the V850ES.  This is an alias for
24973 the @option{-mv850e1} option.
24975 @item -mv850e
24976 @opindex mv850e
24977 Specify that the target processor is the V850E@.  The preprocessor
24978 constant @code{__v850e__} is defined if this option is used.
24980 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
24981 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
24982 are defined then a default target processor is chosen and the
24983 relevant @samp{__v850*__} preprocessor constant is defined.
24985 The preprocessor constants @code{__v850} and @code{__v851__} are always
24986 defined, regardless of which processor variant is the target.
24988 @item -mdisable-callt
24989 @itemx -mno-disable-callt
24990 @opindex mdisable-callt
24991 @opindex mno-disable-callt
24992 This option suppresses generation of the @code{CALLT} instruction for the
24993 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
24994 architecture.
24996 This option is enabled by default when the RH850 ABI is
24997 in use (see @option{-mrh850-abi}), and disabled by default when the
24998 GCC ABI is in use.  If @code{CALLT} instructions are being generated
24999 then the C preprocessor symbol @code{__V850_CALLT__} is defined.
25001 @item -mrelax
25002 @itemx -mno-relax
25003 @opindex mrelax
25004 @opindex mno-relax
25005 Pass on (or do not pass on) the @option{-mrelax} command-line option
25006 to the assembler.
25008 @item -mlong-jumps
25009 @itemx -mno-long-jumps
25010 @opindex mlong-jumps
25011 @opindex mno-long-jumps
25012 Disable (or re-enable) the generation of PC-relative jump instructions.
25014 @item -msoft-float
25015 @itemx -mhard-float
25016 @opindex msoft-float
25017 @opindex mhard-float
25018 Disable (or re-enable) the generation of hardware floating point
25019 instructions.  This option is only significant when the target
25020 architecture is @samp{V850E2V3} or higher.  If hardware floating point
25021 instructions are being generated then the C preprocessor symbol
25022 @code{__FPU_OK__} is defined, otherwise the symbol
25023 @code{__NO_FPU__} is defined.
25025 @item -mloop
25026 @opindex mloop
25027 Enables the use of the e3v5 LOOP instruction.  The use of this
25028 instruction is not enabled by default when the e3v5 architecture is
25029 selected because its use is still experimental.
25031 @item -mrh850-abi
25032 @itemx -mghs
25033 @opindex mrh850-abi
25034 @opindex mghs
25035 Enables support for the RH850 version of the V850 ABI.  This is the
25036 default.  With this version of the ABI the following rules apply:
25038 @itemize
25039 @item
25040 Integer sized structures and unions are returned via a memory pointer
25041 rather than a register.
25043 @item
25044 Large structures and unions (more than 8 bytes in size) are passed by
25045 value.
25047 @item
25048 Functions are aligned to 16-bit boundaries.
25050 @item
25051 The @option{-m8byte-align} command-line option is supported.
25053 @item
25054 The @option{-mdisable-callt} command-line option is enabled by
25055 default.  The @option{-mno-disable-callt} command-line option is not
25056 supported.
25057 @end itemize
25059 When this version of the ABI is enabled the C preprocessor symbol
25060 @code{__V850_RH850_ABI__} is defined.
25062 @item -mgcc-abi
25063 @opindex mgcc-abi
25064 Enables support for the old GCC version of the V850 ABI.  With this
25065 version of the ABI the following rules apply:
25067 @itemize
25068 @item
25069 Integer sized structures and unions are returned in register @code{r10}.
25071 @item
25072 Large structures and unions (more than 8 bytes in size) are passed by
25073 reference.
25075 @item
25076 Functions are aligned to 32-bit boundaries, unless optimizing for
25077 size.
25079 @item
25080 The @option{-m8byte-align} command-line option is not supported.
25082 @item
25083 The @option{-mdisable-callt} command-line option is supported but not
25084 enabled by default.
25085 @end itemize
25087 When this version of the ABI is enabled the C preprocessor symbol
25088 @code{__V850_GCC_ABI__} is defined.
25090 @item -m8byte-align
25091 @itemx -mno-8byte-align
25092 @opindex m8byte-align
25093 @opindex mno-8byte-align
25094 Enables support for @code{double} and @code{long long} types to be
25095 aligned on 8-byte boundaries.  The default is to restrict the
25096 alignment of all objects to at most 4-bytes.  When
25097 @option{-m8byte-align} is in effect the C preprocessor symbol
25098 @code{__V850_8BYTE_ALIGN__} is defined.
25100 @item -mbig-switch
25101 @opindex mbig-switch
25102 Generate code suitable for big switch tables.  Use this option only if
25103 the assembler/linker complain about out of range branches within a switch
25104 table.
25106 @item -mapp-regs
25107 @opindex mapp-regs
25108 This option causes r2 and r5 to be used in the code generated by
25109 the compiler.  This setting is the default.
25111 @item -mno-app-regs
25112 @opindex mno-app-regs
25113 This option causes r2 and r5 to be treated as fixed registers.
25115 @end table
25117 @node VAX Options
25118 @subsection VAX Options
25119 @cindex VAX options
25121 These @samp{-m} options are defined for the VAX:
25123 @table @gcctabopt
25124 @item -munix
25125 @opindex munix
25126 Do not output certain jump instructions (@code{aobleq} and so on)
25127 that the Unix assembler for the VAX cannot handle across long
25128 ranges.
25130 @item -mgnu
25131 @opindex mgnu
25132 Do output those jump instructions, on the assumption that the
25133 GNU assembler is being used.
25135 @item -mg
25136 @opindex mg
25137 Output code for G-format floating-point numbers instead of D-format.
25138 @end table
25140 @node Visium Options
25141 @subsection Visium Options
25142 @cindex Visium options
25144 @table @gcctabopt
25146 @item -mdebug
25147 @opindex mdebug
25148 A program which performs file I/O and is destined to run on an MCM target
25149 should be linked with this option.  It causes the libraries libc.a and
25150 libdebug.a to be linked.  The program should be run on the target under
25151 the control of the GDB remote debugging stub.
25153 @item -msim
25154 @opindex msim
25155 A program which performs file I/O and is destined to run on the simulator
25156 should be linked with option.  This causes libraries libc.a and libsim.a to
25157 be linked.
25159 @item -mfpu
25160 @itemx -mhard-float
25161 @opindex mfpu
25162 @opindex mhard-float
25163 Generate code containing floating-point instructions.  This is the
25164 default.
25166 @item -mno-fpu
25167 @itemx -msoft-float
25168 @opindex mno-fpu
25169 @opindex msoft-float
25170 Generate code containing library calls for floating-point.
25172 @option{-msoft-float} changes the calling convention in the output file;
25173 therefore, it is only useful if you compile @emph{all} of a program with
25174 this option.  In particular, you need to compile @file{libgcc.a}, the
25175 library that comes with GCC, with @option{-msoft-float} in order for
25176 this to work.
25178 @item -mcpu=@var{cpu_type}
25179 @opindex mcpu
25180 Set the instruction set, register set, and instruction scheduling parameters
25181 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
25182 @samp{mcm}, @samp{gr5} and @samp{gr6}.
25184 @samp{mcm} is a synonym of @samp{gr5} present for backward compatibility.
25186 By default (unless configured otherwise), GCC generates code for the GR5
25187 variant of the Visium architecture.  
25189 With @option{-mcpu=gr6}, GCC generates code for the GR6 variant of the Visium
25190 architecture.  The only difference from GR5 code is that the compiler will
25191 generate block move instructions.
25193 @item -mtune=@var{cpu_type}
25194 @opindex mtune
25195 Set the instruction scheduling parameters for machine type @var{cpu_type},
25196 but do not set the instruction set or register set that the option
25197 @option{-mcpu=@var{cpu_type}} would.
25199 @item -msv-mode
25200 @opindex msv-mode
25201 Generate code for the supervisor mode, where there are no restrictions on
25202 the access to general registers.  This is the default.
25204 @item -muser-mode
25205 @opindex muser-mode
25206 Generate code for the user mode, where the access to some general registers
25207 is forbidden: on the GR5, registers r24 to r31 cannot be accessed in this
25208 mode; on the GR6, only registers r29 to r31 are affected.
25209 @end table
25211 @node VMS Options
25212 @subsection VMS Options
25214 These @samp{-m} options are defined for the VMS implementations:
25216 @table @gcctabopt
25217 @item -mvms-return-codes
25218 @opindex mvms-return-codes
25219 Return VMS condition codes from @code{main}. The default is to return POSIX-style
25220 condition (e.g.@ error) codes.
25222 @item -mdebug-main=@var{prefix}
25223 @opindex mdebug-main=@var{prefix}
25224 Flag the first routine whose name starts with @var{prefix} as the main
25225 routine for the debugger.
25227 @item -mmalloc64
25228 @opindex mmalloc64
25229 Default to 64-bit memory allocation routines.
25231 @item -mpointer-size=@var{size}
25232 @opindex mpointer-size=@var{size}
25233 Set the default size of pointers. Possible options for @var{size} are
25234 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
25235 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
25236 The later option disables @code{pragma pointer_size}.
25237 @end table
25239 @node VxWorks Options
25240 @subsection VxWorks Options
25241 @cindex VxWorks Options
25243 The options in this section are defined for all VxWorks targets.
25244 Options specific to the target hardware are listed with the other
25245 options for that target.
25247 @table @gcctabopt
25248 @item -mrtp
25249 @opindex mrtp
25250 GCC can generate code for both VxWorks kernels and real time processes
25251 (RTPs).  This option switches from the former to the latter.  It also
25252 defines the preprocessor macro @code{__RTP__}.
25254 @item -non-static
25255 @opindex non-static
25256 Link an RTP executable against shared libraries rather than static
25257 libraries.  The options @option{-static} and @option{-shared} can
25258 also be used for RTPs (@pxref{Link Options}); @option{-static}
25259 is the default.
25261 @item -Bstatic
25262 @itemx -Bdynamic
25263 @opindex Bstatic
25264 @opindex Bdynamic
25265 These options are passed down to the linker.  They are defined for
25266 compatibility with Diab.
25268 @item -Xbind-lazy
25269 @opindex Xbind-lazy
25270 Enable lazy binding of function calls.  This option is equivalent to
25271 @option{-Wl,-z,now} and is defined for compatibility with Diab.
25273 @item -Xbind-now
25274 @opindex Xbind-now
25275 Disable lazy binding of function calls.  This option is the default and
25276 is defined for compatibility with Diab.
25277 @end table
25279 @node x86 Options
25280 @subsection x86 Options
25281 @cindex x86 Options
25283 These @samp{-m} options are defined for the x86 family of computers.
25285 @table @gcctabopt
25287 @item -march=@var{cpu-type}
25288 @opindex march
25289 Generate instructions for the machine type @var{cpu-type}.  In contrast to
25290 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
25291 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
25292 to generate code that may not run at all on processors other than the one
25293 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
25294 @option{-mtune=@var{cpu-type}}.
25296 The choices for @var{cpu-type} are:
25298 @table @samp
25299 @item native
25300 This selects the CPU to generate code for at compilation time by determining
25301 the processor type of the compiling machine.  Using @option{-march=native}
25302 enables all instruction subsets supported by the local machine (hence
25303 the result might not run on different machines).  Using @option{-mtune=native}
25304 produces code optimized for the local machine under the constraints
25305 of the selected instruction set.  
25307 @item i386
25308 Original Intel i386 CPU@.
25310 @item i486
25311 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
25313 @item i586
25314 @itemx pentium
25315 Intel Pentium CPU with no MMX support.
25317 @item lakemont
25318 Intel Lakemont MCU, based on Intel Pentium CPU.
25320 @item pentium-mmx
25321 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
25323 @item pentiumpro
25324 Intel Pentium Pro CPU@.
25326 @item i686
25327 When used with @option{-march}, the Pentium Pro
25328 instruction set is used, so the code runs on all i686 family chips.
25329 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
25331 @item pentium2
25332 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
25333 support.
25335 @item pentium3
25336 @itemx pentium3m
25337 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
25338 set support.
25340 @item pentium-m
25341 Intel Pentium M; low-power version of Intel Pentium III CPU
25342 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
25344 @item pentium4
25345 @itemx pentium4m
25346 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
25348 @item prescott
25349 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
25350 set support.
25352 @item nocona
25353 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
25354 SSE2 and SSE3 instruction set support.
25356 @item core2
25357 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
25358 instruction set support.
25360 @item nehalem
25361 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
25362 SSE4.1, SSE4.2 and POPCNT instruction set support.
25364 @item westmere
25365 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
25366 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
25368 @item sandybridge
25369 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
25370 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
25372 @item ivybridge
25373 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
25374 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
25375 instruction set support.
25377 @item haswell
25378 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
25379 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25380 BMI, BMI2 and F16C instruction set support.
25382 @item broadwell
25383 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
25384 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25385 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
25387 @item skylake
25388 Intel Skylake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
25389 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25390 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC and
25391 XSAVES instruction set support.
25393 @item bonnell
25394 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
25395 instruction set support.
25397 @item silvermont
25398 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
25399 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
25401 @item knl
25402 Intel Knight's Landing CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
25403 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25404 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER and
25405 AVX512CD instruction set support.
25407 @item knm
25408 Intel Knights Mill CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
25409 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25410 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER, AVX512CD,
25411 AVX5124VNNIW, AVX5124FMAPS and AVX512VPOPCNTDQ instruction set support.
25413 @item skylake-avx512
25414 Intel Skylake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
25415 SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25416 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F,
25417 AVX512VL, AVX512BW, AVX512DQ and AVX512CD instruction set support.
25419 @item cannonlake
25420 Intel Cannonlake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2,
25421 SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE,
25422 RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC,
25423 XSAVES, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, AVX512VBMI,
25424 AVX512IFMA, SHA, CLWB and UMIP instruction set support.
25426 @item k6
25427 AMD K6 CPU with MMX instruction set support.
25429 @item k6-2
25430 @itemx k6-3
25431 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
25433 @item athlon
25434 @itemx athlon-tbird
25435 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
25436 support.
25438 @item athlon-4
25439 @itemx athlon-xp
25440 @itemx athlon-mp
25441 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
25442 instruction set support.
25444 @item k8
25445 @itemx opteron
25446 @itemx athlon64
25447 @itemx athlon-fx
25448 Processors based on the AMD K8 core with x86-64 instruction set support,
25449 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
25450 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
25451 instruction set extensions.)
25453 @item k8-sse3
25454 @itemx opteron-sse3
25455 @itemx athlon64-sse3
25456 Improved versions of AMD K8 cores with SSE3 instruction set support.
25458 @item amdfam10
25459 @itemx barcelona
25460 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
25461 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
25462 instruction set extensions.)
25464 @item bdver1
25465 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
25466 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
25467 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
25468 @item bdver2
25469 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
25470 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
25471 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
25472 extensions.)
25473 @item bdver3
25474 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
25475 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
25476 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
25477 64-bit instruction set extensions.
25478 @item bdver4
25479 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
25480 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
25481 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
25482 SSE4.2, ABM and 64-bit instruction set extensions.
25484 @item znver1
25485 AMD Family 17h core based CPUs with x86-64 instruction set support.  (This
25486 supersets BMI, BMI2, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX,
25487 SHA, CLZERO, AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3,
25488 SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, and 64-bit
25489 instruction set extensions.
25491 @item btver1
25492 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
25493 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
25494 instruction set extensions.)
25496 @item btver2
25497 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
25498 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
25499 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
25501 @item winchip-c6
25502 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
25503 set support.
25505 @item winchip2
25506 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
25507 instruction set support.
25509 @item c3
25510 VIA C3 CPU with MMX and 3DNow!@: instruction set support.
25511 (No scheduling is implemented for this chip.)
25513 @item c3-2
25514 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
25515 (No scheduling is implemented for this chip.)
25517 @item c7
25518 VIA C7 (Esther) CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
25519 (No scheduling is implemented for this chip.)
25521 @item samuel-2
25522 VIA Eden Samuel 2 CPU with MMX and 3DNow!@: instruction set support.
25523 (No scheduling is implemented for this chip.)
25525 @item nehemiah
25526 VIA Eden Nehemiah CPU with MMX and SSE instruction set support.
25527 (No scheduling is implemented for this chip.)
25529 @item esther
25530 VIA Eden Esther CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
25531 (No scheduling is implemented for this chip.)
25533 @item eden-x2
25534 VIA Eden X2 CPU with x86-64, MMX, SSE, SSE2 and SSE3 instruction set support.
25535 (No scheduling is implemented for this chip.)
25537 @item eden-x4
25538 VIA Eden X4 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2,
25539 AVX and AVX2 instruction set support.
25540 (No scheduling is implemented for this chip.)
25542 @item nano
25543 Generic VIA Nano CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
25544 instruction set support.
25545 (No scheduling is implemented for this chip.)
25547 @item nano-1000
25548 VIA Nano 1xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
25549 instruction set support.
25550 (No scheduling is implemented for this chip.)
25552 @item nano-2000
25553 VIA Nano 2xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
25554 instruction set support.
25555 (No scheduling is implemented for this chip.)
25557 @item nano-3000
25558 VIA Nano 3xxx CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
25559 instruction set support.
25560 (No scheduling is implemented for this chip.)
25562 @item nano-x2
25563 VIA Nano Dual Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
25564 instruction set support.
25565 (No scheduling is implemented for this chip.)
25567 @item nano-x4
25568 VIA Nano Quad Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
25569 instruction set support.
25570 (No scheduling is implemented for this chip.)
25572 @item geode
25573 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
25574 @end table
25576 @item -mtune=@var{cpu-type}
25577 @opindex mtune
25578 Tune to @var{cpu-type} everything applicable about the generated code, except
25579 for the ABI and the set of available instructions.  
25580 While picking a specific @var{cpu-type} schedules things appropriately
25581 for that particular chip, the compiler does not generate any code that
25582 cannot run on the default machine type unless you use a
25583 @option{-march=@var{cpu-type}} option.
25584 For example, if GCC is configured for i686-pc-linux-gnu
25585 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
25586 but still runs on i686 machines.
25588 The choices for @var{cpu-type} are the same as for @option{-march}.
25589 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
25591 @table @samp
25592 @item generic
25593 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
25594 If you know the CPU on which your code will run, then you should use
25595 the corresponding @option{-mtune} or @option{-march} option instead of
25596 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
25597 of your application will have, then you should use this option.
25599 As new processors are deployed in the marketplace, the behavior of this
25600 option will change.  Therefore, if you upgrade to a newer version of
25601 GCC, code generation controlled by this option will change to reflect
25602 the processors
25603 that are most common at the time that version of GCC is released.
25605 There is no @option{-march=generic} option because @option{-march}
25606 indicates the instruction set the compiler can use, and there is no
25607 generic instruction set applicable to all processors.  In contrast,
25608 @option{-mtune} indicates the processor (or, in this case, collection of
25609 processors) for which the code is optimized.
25611 @item intel
25612 Produce code optimized for the most current Intel processors, which are
25613 Haswell and Silvermont for this version of GCC.  If you know the CPU
25614 on which your code will run, then you should use the corresponding
25615 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
25616 But, if you want your application performs better on both Haswell and
25617 Silvermont, then you should use this option.
25619 As new Intel processors are deployed in the marketplace, the behavior of
25620 this option will change.  Therefore, if you upgrade to a newer version of
25621 GCC, code generation controlled by this option will change to reflect
25622 the most current Intel processors at the time that version of GCC is
25623 released.
25625 There is no @option{-march=intel} option because @option{-march} indicates
25626 the instruction set the compiler can use, and there is no common
25627 instruction set applicable to all processors.  In contrast,
25628 @option{-mtune} indicates the processor (or, in this case, collection of
25629 processors) for which the code is optimized.
25630 @end table
25632 @item -mcpu=@var{cpu-type}
25633 @opindex mcpu
25634 A deprecated synonym for @option{-mtune}.
25636 @item -mfpmath=@var{unit}
25637 @opindex mfpmath
25638 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
25639 for @var{unit} are:
25641 @table @samp
25642 @item 387
25643 Use the standard 387 floating-point coprocessor present on the majority of chips and
25644 emulated otherwise.  Code compiled with this option runs almost everywhere.
25645 The temporary results are computed in 80-bit precision instead of the precision
25646 specified by the type, resulting in slightly different results compared to most
25647 of other chips.  See @option{-ffloat-store} for more detailed description.
25649 This is the default choice for non-Darwin x86-32 targets.
25651 @item sse
25652 Use scalar floating-point instructions present in the SSE instruction set.
25653 This instruction set is supported by Pentium III and newer chips,
25654 and in the AMD line
25655 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
25656 instruction set supports only single-precision arithmetic, thus the double and
25657 extended-precision arithmetic are still done using 387.  A later version, present
25658 only in Pentium 4 and AMD x86-64 chips, supports double-precision
25659 arithmetic too.
25661 For the x86-32 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
25662 or @option{-msse2} switches to enable SSE extensions and make this option
25663 effective.  For the x86-64 compiler, these extensions are enabled by default.
25665 The resulting code should be considerably faster in the majority of cases and avoid
25666 the numerical instability problems of 387 code, but may break some existing
25667 code that expects temporaries to be 80 bits.
25669 This is the default choice for the x86-64 compiler, Darwin x86-32 targets,
25670 and the default choice for x86-32 targets with the SSE2 instruction set
25671 when @option{-ffast-math} is enabled.
25673 @item sse,387
25674 @itemx sse+387
25675 @itemx both
25676 Attempt to utilize both instruction sets at once.  This effectively doubles the
25677 amount of available registers, and on chips with separate execution units for
25678 387 and SSE the execution resources too.  Use this option with care, as it is
25679 still experimental, because the GCC register allocator does not model separate
25680 functional units well, resulting in unstable performance.
25681 @end table
25683 @item -masm=@var{dialect}
25684 @opindex masm=@var{dialect}
25685 Output assembly instructions using selected @var{dialect}.  Also affects
25686 which dialect is used for basic @code{asm} (@pxref{Basic Asm}) and
25687 extended @code{asm} (@pxref{Extended Asm}). Supported choices (in dialect
25688 order) are @samp{att} or @samp{intel}. The default is @samp{att}. Darwin does
25689 not support @samp{intel}.
25691 @item -mieee-fp
25692 @itemx -mno-ieee-fp
25693 @opindex mieee-fp
25694 @opindex mno-ieee-fp
25695 Control whether or not the compiler uses IEEE floating-point
25696 comparisons.  These correctly handle the case where the result of a
25697 comparison is unordered.
25699 @item -m80387
25700 @item -mhard-float
25701 @opindex 80387
25702 @opindex mhard-float
25703 Generate output containing 80387 instructions for floating point.
25705 @item -mno-80387
25706 @item -msoft-float
25707 @opindex no-80387
25708 @opindex msoft-float
25709 Generate output containing library calls for floating point.
25711 @strong{Warning:} the requisite libraries are not part of GCC@.
25712 Normally the facilities of the machine's usual C compiler are used, but
25713 this cannot be done directly in cross-compilation.  You must make your
25714 own arrangements to provide suitable library functions for
25715 cross-compilation.
25717 On machines where a function returns floating-point results in the 80387
25718 register stack, some floating-point opcodes may be emitted even if
25719 @option{-msoft-float} is used.
25721 @item -mno-fp-ret-in-387
25722 @opindex mno-fp-ret-in-387
25723 Do not use the FPU registers for return values of functions.
25725 The usual calling convention has functions return values of types
25726 @code{float} and @code{double} in an FPU register, even if there
25727 is no FPU@.  The idea is that the operating system should emulate
25728 an FPU@.
25730 The option @option{-mno-fp-ret-in-387} causes such values to be returned
25731 in ordinary CPU registers instead.
25733 @item -mno-fancy-math-387
25734 @opindex mno-fancy-math-387
25735 Some 387 emulators do not support the @code{sin}, @code{cos} and
25736 @code{sqrt} instructions for the 387.  Specify this option to avoid
25737 generating those instructions.  This option is the default on
25738 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
25739 indicates that the target CPU always has an FPU and so the
25740 instruction does not need emulation.  These
25741 instructions are not generated unless you also use the
25742 @option{-funsafe-math-optimizations} switch.
25744 @item -malign-double
25745 @itemx -mno-align-double
25746 @opindex malign-double
25747 @opindex mno-align-double
25748 Control whether GCC aligns @code{double}, @code{long double}, and
25749 @code{long long} variables on a two-word boundary or a one-word
25750 boundary.  Aligning @code{double} variables on a two-word boundary
25751 produces code that runs somewhat faster on a Pentium at the
25752 expense of more memory.
25754 On x86-64, @option{-malign-double} is enabled by default.
25756 @strong{Warning:} if you use the @option{-malign-double} switch,
25757 structures containing the above types are aligned differently than
25758 the published application binary interface specifications for the x86-32
25759 and are not binary compatible with structures in code compiled
25760 without that switch.
25762 @item -m96bit-long-double
25763 @itemx -m128bit-long-double
25764 @opindex m96bit-long-double
25765 @opindex m128bit-long-double
25766 These switches control the size of @code{long double} type.  The x86-32
25767 application binary interface specifies the size to be 96 bits,
25768 so @option{-m96bit-long-double} is the default in 32-bit mode.
25770 Modern architectures (Pentium and newer) prefer @code{long double}
25771 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
25772 conforming to the ABI, this is not possible.  So specifying
25773 @option{-m128bit-long-double} aligns @code{long double}
25774 to a 16-byte boundary by padding the @code{long double} with an additional
25775 32-bit zero.
25777 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
25778 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
25780 Notice that neither of these options enable any extra precision over the x87
25781 standard of 80 bits for a @code{long double}.
25783 @strong{Warning:} if you override the default value for your target ABI, this
25784 changes the size of 
25785 structures and arrays containing @code{long double} variables,
25786 as well as modifying the function calling convention for functions taking
25787 @code{long double}.  Hence they are not binary-compatible
25788 with code compiled without that switch.
25790 @item -mlong-double-64
25791 @itemx -mlong-double-80
25792 @itemx -mlong-double-128
25793 @opindex mlong-double-64
25794 @opindex mlong-double-80
25795 @opindex mlong-double-128
25796 These switches control the size of @code{long double} type. A size
25797 of 64 bits makes the @code{long double} type equivalent to the @code{double}
25798 type. This is the default for 32-bit Bionic C library.  A size
25799 of 128 bits makes the @code{long double} type equivalent to the
25800 @code{__float128} type. This is the default for 64-bit Bionic C library.
25802 @strong{Warning:} if you override the default value for your target ABI, this
25803 changes the size of
25804 structures and arrays containing @code{long double} variables,
25805 as well as modifying the function calling convention for functions taking
25806 @code{long double}.  Hence they are not binary-compatible
25807 with code compiled without that switch.
25809 @item -malign-data=@var{type}
25810 @opindex malign-data
25811 Control how GCC aligns variables.  Supported values for @var{type} are
25812 @samp{compat} uses increased alignment value compatible uses GCC 4.8
25813 and earlier, @samp{abi} uses alignment value as specified by the
25814 psABI, and @samp{cacheline} uses increased alignment value to match
25815 the cache line size.  @samp{compat} is the default.
25817 @item -mlarge-data-threshold=@var{threshold}
25818 @opindex mlarge-data-threshold
25819 When @option{-mcmodel=medium} is specified, data objects larger than
25820 @var{threshold} are placed in the large data section.  This value must be the
25821 same across all objects linked into the binary, and defaults to 65535.
25823 @item -mrtd
25824 @opindex mrtd
25825 Use a different function-calling convention, in which functions that
25826 take a fixed number of arguments return with the @code{ret @var{num}}
25827 instruction, which pops their arguments while returning.  This saves one
25828 instruction in the caller since there is no need to pop the arguments
25829 there.
25831 You can specify that an individual function is called with this calling
25832 sequence with the function attribute @code{stdcall}.  You can also
25833 override the @option{-mrtd} option by using the function attribute
25834 @code{cdecl}.  @xref{Function Attributes}.
25836 @strong{Warning:} this calling convention is incompatible with the one
25837 normally used on Unix, so you cannot use it if you need to call
25838 libraries compiled with the Unix compiler.
25840 Also, you must provide function prototypes for all functions that
25841 take variable numbers of arguments (including @code{printf});
25842 otherwise incorrect code is generated for calls to those
25843 functions.
25845 In addition, seriously incorrect code results if you call a
25846 function with too many arguments.  (Normally, extra arguments are
25847 harmlessly ignored.)
25849 @item -mregparm=@var{num}
25850 @opindex mregparm
25851 Control how many registers are used to pass integer arguments.  By
25852 default, no registers are used to pass arguments, and at most 3
25853 registers can be used.  You can control this behavior for a specific
25854 function by using the function attribute @code{regparm}.
25855 @xref{Function Attributes}.
25857 @strong{Warning:} if you use this switch, and
25858 @var{num} is nonzero, then you must build all modules with the same
25859 value, including any libraries.  This includes the system libraries and
25860 startup modules.
25862 @item -msseregparm
25863 @opindex msseregparm
25864 Use SSE register passing conventions for float and double arguments
25865 and return values.  You can control this behavior for a specific
25866 function by using the function attribute @code{sseregparm}.
25867 @xref{Function Attributes}.
25869 @strong{Warning:} if you use this switch then you must build all
25870 modules with the same value, including any libraries.  This includes
25871 the system libraries and startup modules.
25873 @item -mvect8-ret-in-mem
25874 @opindex mvect8-ret-in-mem
25875 Return 8-byte vectors in memory instead of MMX registers.  This is the
25876 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
25877 Studio compilers until version 12.  Later compiler versions (starting
25878 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
25879 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
25880 you need to remain compatible with existing code produced by those
25881 previous compiler versions or older versions of GCC@.
25883 @item -mpc32
25884 @itemx -mpc64
25885 @itemx -mpc80
25886 @opindex mpc32
25887 @opindex mpc64
25888 @opindex mpc80
25890 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
25891 is specified, the significands of results of floating-point operations are
25892 rounded to 24 bits (single precision); @option{-mpc64} rounds the
25893 significands of results of floating-point operations to 53 bits (double
25894 precision) and @option{-mpc80} rounds the significands of results of
25895 floating-point operations to 64 bits (extended double precision), which is
25896 the default.  When this option is used, floating-point operations in higher
25897 precisions are not available to the programmer without setting the FPU
25898 control word explicitly.
25900 Setting the rounding of floating-point operations to less than the default
25901 80 bits can speed some programs by 2% or more.  Note that some mathematical
25902 libraries assume that extended-precision (80-bit) floating-point operations
25903 are enabled by default; routines in such libraries could suffer significant
25904 loss of accuracy, typically through so-called ``catastrophic cancellation'',
25905 when this option is used to set the precision to less than extended precision.
25907 @item -mstackrealign
25908 @opindex mstackrealign
25909 Realign the stack at entry.  On the x86, the @option{-mstackrealign}
25910 option generates an alternate prologue and epilogue that realigns the
25911 run-time stack if necessary.  This supports mixing legacy codes that keep
25912 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
25913 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
25914 applicable to individual functions.
25916 @item -mpreferred-stack-boundary=@var{num}
25917 @opindex mpreferred-stack-boundary
25918 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
25919 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
25920 the default is 4 (16 bytes or 128 bits).
25922 @strong{Warning:} When generating code for the x86-64 architecture with
25923 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
25924 used to keep the stack boundary aligned to 8 byte boundary.  Since
25925 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
25926 intended to be used in controlled environment where stack space is
25927 important limitation.  This option leads to wrong code when functions
25928 compiled with 16 byte stack alignment (such as functions from a standard
25929 library) are called with misaligned stack.  In this case, SSE
25930 instructions may lead to misaligned memory access traps.  In addition,
25931 variable arguments are handled incorrectly for 16 byte aligned
25932 objects (including x87 long double and __int128), leading to wrong
25933 results.  You must build all modules with
25934 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
25935 includes the system libraries and startup modules.
25937 @item -mincoming-stack-boundary=@var{num}
25938 @opindex mincoming-stack-boundary
25939 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
25940 boundary.  If @option{-mincoming-stack-boundary} is not specified,
25941 the one specified by @option{-mpreferred-stack-boundary} is used.
25943 On Pentium and Pentium Pro, @code{double} and @code{long double} values
25944 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
25945 suffer significant run time performance penalties.  On Pentium III, the
25946 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
25947 properly if it is not 16-byte aligned.
25949 To ensure proper alignment of this values on the stack, the stack boundary
25950 must be as aligned as that required by any value stored on the stack.
25951 Further, every function must be generated such that it keeps the stack
25952 aligned.  Thus calling a function compiled with a higher preferred
25953 stack boundary from a function compiled with a lower preferred stack
25954 boundary most likely misaligns the stack.  It is recommended that
25955 libraries that use callbacks always use the default setting.
25957 This extra alignment does consume extra stack space, and generally
25958 increases code size.  Code that is sensitive to stack space usage, such
25959 as embedded systems and operating system kernels, may want to reduce the
25960 preferred alignment to @option{-mpreferred-stack-boundary=2}.
25962 @need 200
25963 @item -mmmx
25964 @opindex mmmx
25965 @need 200
25966 @itemx -msse
25967 @opindex msse
25968 @need 200
25969 @itemx -msse2
25970 @opindex msse2
25971 @need 200
25972 @itemx -msse3
25973 @opindex msse3
25974 @need 200
25975 @itemx -mssse3
25976 @opindex mssse3
25977 @need 200
25978 @itemx -msse4
25979 @opindex msse4
25980 @need 200
25981 @itemx -msse4a
25982 @opindex msse4a
25983 @need 200
25984 @itemx -msse4.1
25985 @opindex msse4.1
25986 @need 200
25987 @itemx -msse4.2
25988 @opindex msse4.2
25989 @need 200
25990 @itemx -mavx
25991 @opindex mavx
25992 @need 200
25993 @itemx -mavx2
25994 @opindex mavx2
25995 @need 200
25996 @itemx -mavx512f
25997 @opindex mavx512f
25998 @need 200
25999 @itemx -mavx512pf
26000 @opindex mavx512pf
26001 @need 200
26002 @itemx -mavx512er
26003 @opindex mavx512er
26004 @need 200
26005 @itemx -mavx512cd
26006 @opindex mavx512cd
26007 @need 200
26008 @itemx -mavx512vl
26009 @opindex mavx512vl
26010 @need 200
26011 @itemx -mavx512bw
26012 @opindex mavx512bw
26013 @need 200
26014 @itemx -mavx512dq
26015 @opindex mavx512dq
26016 @need 200
26017 @itemx -mavx512ifma
26018 @opindex mavx512ifma
26019 @need 200
26020 @itemx -mavx512vbmi
26021 @opindex mavx512vbmi
26022 @need 200
26023 @itemx -msha
26024 @opindex msha
26025 @need 200
26026 @itemx -maes
26027 @opindex maes
26028 @need 200
26029 @itemx -mpclmul
26030 @opindex mpclmul
26031 @need 200
26032 @itemx -mclfushopt
26033 @opindex mclfushopt
26034 @need 200
26035 @itemx -mfsgsbase
26036 @opindex mfsgsbase
26037 @need 200
26038 @itemx -mrdrnd
26039 @opindex mrdrnd
26040 @need 200
26041 @itemx -mf16c
26042 @opindex mf16c
26043 @need 200
26044 @itemx -mfma
26045 @opindex mfma
26046 @need 200
26047 @itemx -mfma4
26048 @opindex mfma4
26049 @need 200
26050 @itemx -mprefetchwt1
26051 @opindex mprefetchwt1
26052 @need 200
26053 @itemx -mxop
26054 @opindex mxop
26055 @need 200
26056 @itemx -mlwp
26057 @opindex mlwp
26058 @need 200
26059 @itemx -m3dnow
26060 @opindex m3dnow
26061 @need 200
26062 @itemx -m3dnowa
26063 @opindex m3dnowa
26064 @need 200
26065 @itemx -mpopcnt
26066 @opindex mpopcnt
26067 @need 200
26068 @itemx -mabm
26069 @opindex mabm
26070 @need 200
26071 @itemx -mbmi
26072 @opindex mbmi
26073 @need 200
26074 @itemx -mbmi2
26075 @need 200
26076 @itemx -mlzcnt
26077 @opindex mlzcnt
26078 @need 200
26079 @itemx -mfxsr
26080 @opindex mfxsr
26081 @need 200
26082 @itemx -mxsave
26083 @opindex mxsave
26084 @need 200
26085 @itemx -mxsaveopt
26086 @opindex mxsaveopt
26087 @need 200
26088 @itemx -mxsavec
26089 @opindex mxsavec
26090 @need 200
26091 @itemx -mxsaves
26092 @opindex mxsaves
26093 @need 200
26094 @itemx -mrtm
26095 @opindex mrtm
26096 @need 200
26097 @itemx -mtbm
26098 @opindex mtbm
26099 @need 200
26100 @itemx -mmpx
26101 @opindex mmpx
26102 @need 200
26103 @itemx -mmwaitx
26104 @opindex mmwaitx
26105 @need 200
26106 @itemx -mclzero
26107 @opindex mclzero
26108 @need 200
26109 @itemx -mpku
26110 @opindex mpku
26111 @need 200
26112 @itemx -mcet
26113 @opindex mcet
26114 @need 200
26115 @itemx -mavx512vbmi2
26116 @opindex mavx512vbmi2
26117 @need 200
26118 @itemx -mgfni
26119 @opindex mgfni
26120 @need 200
26121 @itemx -mvaes
26122 @opindex mvaes
26123 These switches enable the use of instructions in the MMX, SSE,
26124 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
26125 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
26126 AVX512VL, AVX512BW, AVX512DQ, AVX512IFMA, AVX512VBMI, BMI, BMI2, VAES,
26127 FXSR, XSAVE, XSAVEOPT, LZCNT, RTM, MPX, MWAITX, PKU, IBT, SHSTK, AVX512VBMI2,
26128 GFNI, 3DNow!@: or enhanced 3DNow!@: extended instruction sets.  Each has a
26129 corresponding @option{-mno-} option to disable use of these instructions.
26131 These extensions are also available as built-in functions: see
26132 @ref{x86 Built-in Functions}, for details of the functions enabled and
26133 disabled by these switches.
26135 To generate SSE/SSE2 instructions automatically from floating-point
26136 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
26138 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
26139 generates new AVX instructions or AVX equivalence for all SSEx instructions
26140 when needed.
26142 These options enable GCC to use these extended instructions in
26143 generated code, even without @option{-mfpmath=sse}.  Applications that
26144 perform run-time CPU detection must compile separate files for each
26145 supported architecture, using the appropriate flags.  In particular,
26146 the file containing the CPU detection code should be compiled without
26147 these options.
26149 The @option{-mcet} option turns on the @option{-mibt} and @option{-mshstk}
26150 options.  The @option{-mibt} option enables indirect branch tracking support
26151 and the @option{-mshstk} option enables shadow stack support from
26152 Intel Control-flow Enforcement Technology (CET).  The compiler also provides
26153 a number of built-in functions for fine-grained control in a CET-based
26154 application.  See @xref{x86 Built-in Functions}, for more information.
26156 @item -mdump-tune-features
26157 @opindex mdump-tune-features
26158 This option instructs GCC to dump the names of the x86 performance 
26159 tuning features and default settings. The names can be used in 
26160 @option{-mtune-ctrl=@var{feature-list}}.
26162 @item -mtune-ctrl=@var{feature-list}
26163 @opindex mtune-ctrl=@var{feature-list}
26164 This option is used to do fine grain control of x86 code generation features.
26165 @var{feature-list} is a comma separated list of @var{feature} names. See also
26166 @option{-mdump-tune-features}. When specified, the @var{feature} is turned
26167 on if it is not preceded with @samp{^}, otherwise, it is turned off. 
26168 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
26169 developers. Using it may lead to code paths not covered by testing and can
26170 potentially result in compiler ICEs or runtime errors.
26172 @item -mno-default
26173 @opindex mno-default
26174 This option instructs GCC to turn off all tunable features. See also 
26175 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
26177 @item -mcld
26178 @opindex mcld
26179 This option instructs GCC to emit a @code{cld} instruction in the prologue
26180 of functions that use string instructions.  String instructions depend on
26181 the DF flag to select between autoincrement or autodecrement mode.  While the
26182 ABI specifies the DF flag to be cleared on function entry, some operating
26183 systems violate this specification by not clearing the DF flag in their
26184 exception dispatchers.  The exception handler can be invoked with the DF flag
26185 set, which leads to wrong direction mode when string instructions are used.
26186 This option can be enabled by default on 32-bit x86 targets by configuring
26187 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
26188 instructions can be suppressed with the @option{-mno-cld} compiler option
26189 in this case.
26191 @item -mvzeroupper
26192 @opindex mvzeroupper
26193 This option instructs GCC to emit a @code{vzeroupper} instruction
26194 before a transfer of control flow out of the function to minimize
26195 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
26196 intrinsics.
26198 @item -mprefer-avx128
26199 @opindex mprefer-avx128
26200 This option instructs GCC to use 128-bit AVX instructions instead of
26201 256-bit AVX instructions in the auto-vectorizer.
26203 @item -mprefer-vector-width=@var{opt}
26204 @opindex mprefer-vector-width
26205 This option instructs GCC to use @var{opt}-bit vector width in instructions
26206 instead of default on the selected platform.
26208 @table @samp
26209 @item none
26210 No extra limitations applied to GCC other than defined by the selected platform.
26212 @item 128
26213 Prefer 128-bit vector width for instructions.
26215 @item 256
26216 Prefer 256-bit vector width for instructions.
26218 @item 512
26219 Prefer 512-bit vector width for instructions.
26220 @end table
26222 @item -mcx16
26223 @opindex mcx16
26224 This option enables GCC to generate @code{CMPXCHG16B} instructions in 64-bit
26225 code to implement compare-and-exchange operations on 16-byte aligned 128-bit
26226 objects.  This is useful for atomic updates of data structures exceeding one
26227 machine word in size.  The compiler uses this instruction to implement
26228 @ref{__sync Builtins}.  However, for @ref{__atomic Builtins} operating on
26229 128-bit integers, a library call is always used.
26231 @item -msahf
26232 @opindex msahf
26233 This option enables generation of @code{SAHF} instructions in 64-bit code.
26234 Early Intel Pentium 4 CPUs with Intel 64 support,
26235 prior to the introduction of Pentium 4 G1 step in December 2005,
26236 lacked the @code{LAHF} and @code{SAHF} instructions
26237 which are supported by AMD64.
26238 These are load and store instructions, respectively, for certain status flags.
26239 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
26240 @code{drem}, and @code{remainder} built-in functions;
26241 see @ref{Other Builtins} for details.
26243 @item -mmovbe
26244 @opindex mmovbe
26245 This option enables use of the @code{movbe} instruction to implement
26246 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
26248 @item -mibt
26249 @opindex mibt
26250 This option tells the compiler to use indirect branch tracking support
26251 (for indirect calls and jumps) from x86 Control-flow Enforcement
26252 Technology (CET).  The option has effect only if the
26253 @option{-fcf-protection=full} or @option{-fcf-protection=branch} option
26254 is specified. The option @option{-mibt} is on by default when the
26255 @code{-mcet} option is specified.
26257 @item -mshstk
26258 @opindex mshstk
26259 This option tells the compiler to use shadow stack support (return
26260 address tracking) from x86 Control-flow Enforcement Technology (CET).
26261 The option has effect only if the @option{-fcf-protection=full} or
26262 @option{-fcf-protection=return} option is specified.  The option
26263 @option{-mshstk} is on by default when the @option{-mcet} option is
26264 specified.
26266 @item -mcrc32
26267 @opindex mcrc32
26268 This option enables built-in functions @code{__builtin_ia32_crc32qi},
26269 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
26270 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
26272 @item -mrecip
26273 @opindex mrecip
26274 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
26275 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
26276 with an additional Newton-Raphson step
26277 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
26278 (and their vectorized
26279 variants) for single-precision floating-point arguments.  These instructions
26280 are generated only when @option{-funsafe-math-optimizations} is enabled
26281 together with @option{-ffinite-math-only} and @option{-fno-trapping-math}.
26282 Note that while the throughput of the sequence is higher than the throughput
26283 of the non-reciprocal instruction, the precision of the sequence can be
26284 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
26286 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
26287 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
26288 combination), and doesn't need @option{-mrecip}.
26290 Also note that GCC emits the above sequence with additional Newton-Raphson step
26291 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
26292 already with @option{-ffast-math} (or the above option combination), and
26293 doesn't need @option{-mrecip}.
26295 @item -mrecip=@var{opt}
26296 @opindex mrecip=opt
26297 This option controls which reciprocal estimate instructions
26298 may be used.  @var{opt} is a comma-separated list of options, which may
26299 be preceded by a @samp{!} to invert the option:
26301 @table @samp
26302 @item all
26303 Enable all estimate instructions.
26305 @item default
26306 Enable the default instructions, equivalent to @option{-mrecip}.
26308 @item none
26309 Disable all estimate instructions, equivalent to @option{-mno-recip}.
26311 @item div
26312 Enable the approximation for scalar division.
26314 @item vec-div
26315 Enable the approximation for vectorized division.
26317 @item sqrt
26318 Enable the approximation for scalar square root.
26320 @item vec-sqrt
26321 Enable the approximation for vectorized square root.
26322 @end table
26324 So, for example, @option{-mrecip=all,!sqrt} enables
26325 all of the reciprocal approximations, except for square root.
26327 @item -mveclibabi=@var{type}
26328 @opindex mveclibabi
26329 Specifies the ABI type to use for vectorizing intrinsics using an
26330 external library.  Supported values for @var{type} are @samp{svml} 
26331 for the Intel short
26332 vector math library and @samp{acml} for the AMD math core library.
26333 To use this option, both @option{-ftree-vectorize} and
26334 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
26335 ABI-compatible library must be specified at link time.
26337 GCC currently emits calls to @code{vmldExp2},
26338 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
26339 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
26340 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
26341 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
26342 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
26343 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
26344 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
26345 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
26346 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
26347 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
26348 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
26349 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
26350 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
26351 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
26352 when @option{-mveclibabi=acml} is used.  
26354 @item -mabi=@var{name}
26355 @opindex mabi
26356 Generate code for the specified calling convention.  Permissible values
26357 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
26358 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
26359 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
26360 You can control this behavior for specific functions by
26361 using the function attributes @code{ms_abi} and @code{sysv_abi}.
26362 @xref{Function Attributes}.
26364 @item -mforce-indirect-call
26365 @opindex mforce-indirect-call
26366 Force all calls to functions to be indirect. This is useful
26367 when using Intel Processor Trace where it generates more precise timing
26368 information for function calls.
26370 @item -mcall-ms2sysv-xlogues
26371 @opindex mcall-ms2sysv-xlogues
26372 @opindex mno-call-ms2sysv-xlogues
26373 Due to differences in 64-bit ABIs, any Microsoft ABI function that calls a
26374 System V ABI function must consider RSI, RDI and XMM6-15 as clobbered.  By
26375 default, the code for saving and restoring these registers is emitted inline,
26376 resulting in fairly lengthy prologues and epilogues.  Using
26377 @option{-mcall-ms2sysv-xlogues} emits prologues and epilogues that
26378 use stubs in the static portion of libgcc to perform these saves and restores,
26379 thus reducing function size at the cost of a few extra instructions.
26381 @item -mtls-dialect=@var{type}
26382 @opindex mtls-dialect
26383 Generate code to access thread-local storage using the @samp{gnu} or
26384 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
26385 @samp{gnu2} is more efficient, but it may add compile- and run-time
26386 requirements that cannot be satisfied on all systems.
26388 @item -mpush-args
26389 @itemx -mno-push-args
26390 @opindex mpush-args
26391 @opindex mno-push-args
26392 Use PUSH operations to store outgoing parameters.  This method is shorter
26393 and usually equally fast as method using SUB/MOV operations and is enabled
26394 by default.  In some cases disabling it may improve performance because of
26395 improved scheduling and reduced dependencies.
26397 @item -maccumulate-outgoing-args
26398 @opindex maccumulate-outgoing-args
26399 If enabled, the maximum amount of space required for outgoing arguments is
26400 computed in the function prologue.  This is faster on most modern CPUs
26401 because of reduced dependencies, improved scheduling and reduced stack usage
26402 when the preferred stack boundary is not equal to 2.  The drawback is a notable
26403 increase in code size.  This switch implies @option{-mno-push-args}.
26405 @item -mthreads
26406 @opindex mthreads
26407 Support thread-safe exception handling on MinGW.  Programs that rely
26408 on thread-safe exception handling must compile and link all code with the
26409 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
26410 @option{-D_MT}; when linking, it links in a special thread helper library
26411 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
26413 @item -mms-bitfields
26414 @itemx -mno-ms-bitfields
26415 @opindex mms-bitfields
26416 @opindex mno-ms-bitfields
26418 Enable/disable bit-field layout compatible with the native Microsoft
26419 Windows compiler.  
26421 If @code{packed} is used on a structure, or if bit-fields are used,
26422 it may be that the Microsoft ABI lays out the structure differently
26423 than the way GCC normally does.  Particularly when moving packed
26424 data between functions compiled with GCC and the native Microsoft compiler
26425 (either via function call or as data in a file), it may be necessary to access
26426 either format.
26428 This option is enabled by default for Microsoft Windows
26429 targets.  This behavior can also be controlled locally by use of variable
26430 or type attributes.  For more information, see @ref{x86 Variable Attributes}
26431 and @ref{x86 Type Attributes}.
26433 The Microsoft structure layout algorithm is fairly simple with the exception
26434 of the bit-field packing.  
26435 The padding and alignment of members of structures and whether a bit-field 
26436 can straddle a storage-unit boundary are determine by these rules:
26438 @enumerate
26439 @item Structure members are stored sequentially in the order in which they are
26440 declared: the first member has the lowest memory address and the last member
26441 the highest.
26443 @item Every data object has an alignment requirement.  The alignment requirement
26444 for all data except structures, unions, and arrays is either the size of the
26445 object or the current packing size (specified with either the
26446 @code{aligned} attribute or the @code{pack} pragma),
26447 whichever is less.  For structures, unions, and arrays,
26448 the alignment requirement is the largest alignment requirement of its members.
26449 Every object is allocated an offset so that:
26451 @smallexample
26452 offset % alignment_requirement == 0
26453 @end smallexample
26455 @item Adjacent bit-fields are packed into the same 1-, 2-, or 4-byte allocation
26456 unit if the integral types are the same size and if the next bit-field fits
26457 into the current allocation unit without crossing the boundary imposed by the
26458 common alignment requirements of the bit-fields.
26459 @end enumerate
26461 MSVC interprets zero-length bit-fields in the following ways:
26463 @enumerate
26464 @item If a zero-length bit-field is inserted between two bit-fields that
26465 are normally coalesced, the bit-fields are not coalesced.
26467 For example:
26469 @smallexample
26470 struct
26471  @{
26472    unsigned long bf_1 : 12;
26473    unsigned long : 0;
26474    unsigned long bf_2 : 12;
26475  @} t1;
26476 @end smallexample
26478 @noindent
26479 The size of @code{t1} is 8 bytes with the zero-length bit-field.  If the
26480 zero-length bit-field were removed, @code{t1}'s size would be 4 bytes.
26482 @item If a zero-length bit-field is inserted after a bit-field, @code{foo}, and the
26483 alignment of the zero-length bit-field is greater than the member that follows it,
26484 @code{bar}, @code{bar} is aligned as the type of the zero-length bit-field.
26486 For example:
26488 @smallexample
26489 struct
26490  @{
26491    char foo : 4;
26492    short : 0;
26493    char bar;
26494  @} t2;
26496 struct
26497  @{
26498    char foo : 4;
26499    short : 0;
26500    double bar;
26501  @} t3;
26502 @end smallexample
26504 @noindent
26505 For @code{t2}, @code{bar} is placed at offset 2, rather than offset 1.
26506 Accordingly, the size of @code{t2} is 4.  For @code{t3}, the zero-length
26507 bit-field does not affect the alignment of @code{bar} or, as a result, the size
26508 of the structure.
26510 Taking this into account, it is important to note the following:
26512 @enumerate
26513 @item If a zero-length bit-field follows a normal bit-field, the type of the
26514 zero-length bit-field may affect the alignment of the structure as whole. For
26515 example, @code{t2} has a size of 4 bytes, since the zero-length bit-field follows a
26516 normal bit-field, and is of type short.
26518 @item Even if a zero-length bit-field is not followed by a normal bit-field, it may
26519 still affect the alignment of the structure:
26521 @smallexample
26522 struct
26523  @{
26524    char foo : 6;
26525    long : 0;
26526  @} t4;
26527 @end smallexample
26529 @noindent
26530 Here, @code{t4} takes up 4 bytes.
26531 @end enumerate
26533 @item Zero-length bit-fields following non-bit-field members are ignored:
26535 @smallexample
26536 struct
26537  @{
26538    char foo;
26539    long : 0;
26540    char bar;
26541  @} t5;
26542 @end smallexample
26544 @noindent
26545 Here, @code{t5} takes up 2 bytes.
26546 @end enumerate
26549 @item -mno-align-stringops
26550 @opindex mno-align-stringops
26551 Do not align the destination of inlined string operations.  This switch reduces
26552 code size and improves performance in case the destination is already aligned,
26553 but GCC doesn't know about it.
26555 @item -minline-all-stringops
26556 @opindex minline-all-stringops
26557 By default GCC inlines string operations only when the destination is 
26558 known to be aligned to least a 4-byte boundary.  
26559 This enables more inlining and increases code
26560 size, but may improve performance of code that depends on fast
26561 @code{memcpy}, @code{strlen},
26562 and @code{memset} for short lengths.
26564 @item -minline-stringops-dynamically
26565 @opindex minline-stringops-dynamically
26566 For string operations of unknown size, use run-time checks with
26567 inline code for small blocks and a library call for large blocks.
26569 @item -mstringop-strategy=@var{alg}
26570 @opindex mstringop-strategy=@var{alg}
26571 Override the internal decision heuristic for the particular algorithm to use
26572 for inlining string operations.  The allowed values for @var{alg} are:
26574 @table @samp
26575 @item rep_byte
26576 @itemx rep_4byte
26577 @itemx rep_8byte
26578 Expand using i386 @code{rep} prefix of the specified size.
26580 @item byte_loop
26581 @itemx loop
26582 @itemx unrolled_loop
26583 Expand into an inline loop.
26585 @item libcall
26586 Always use a library call.
26587 @end table
26589 @item -mmemcpy-strategy=@var{strategy}
26590 @opindex mmemcpy-strategy=@var{strategy}
26591 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
26592 should be inlined and what inline algorithm to use when the expected size
26593 of the copy operation is known. @var{strategy} 
26594 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
26595 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
26596 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
26597 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
26598 in the list must be specified in increasing order.  The minimal byte size for 
26599 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
26600 preceding range.
26602 @item -mmemset-strategy=@var{strategy}
26603 @opindex mmemset-strategy=@var{strategy}
26604 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
26605 @code{__builtin_memset} expansion.
26607 @item -momit-leaf-frame-pointer
26608 @opindex momit-leaf-frame-pointer
26609 Don't keep the frame pointer in a register for leaf functions.  This
26610 avoids the instructions to save, set up, and restore frame pointers and
26611 makes an extra register available in leaf functions.  The option
26612 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
26613 which might make debugging harder.
26615 @item -mtls-direct-seg-refs
26616 @itemx -mno-tls-direct-seg-refs
26617 @opindex mtls-direct-seg-refs
26618 Controls whether TLS variables may be accessed with offsets from the
26619 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
26620 or whether the thread base pointer must be added.  Whether or not this
26621 is valid depends on the operating system, and whether it maps the
26622 segment to cover the entire TLS area.
26624 For systems that use the GNU C Library, the default is on.
26626 @item -msse2avx
26627 @itemx -mno-sse2avx
26628 @opindex msse2avx
26629 Specify that the assembler should encode SSE instructions with VEX
26630 prefix.  The option @option{-mavx} turns this on by default.
26632 @item -mfentry
26633 @itemx -mno-fentry
26634 @opindex mfentry
26635 If profiling is active (@option{-pg}), put the profiling
26636 counter call before the prologue.
26637 Note: On x86 architectures the attribute @code{ms_hook_prologue}
26638 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
26640 @item -mrecord-mcount
26641 @itemx -mno-record-mcount
26642 @opindex mrecord-mcount
26643 If profiling is active (@option{-pg}), generate a __mcount_loc section
26644 that contains pointers to each profiling call. This is useful for
26645 automatically patching and out calls.
26647 @item -mnop-mcount
26648 @itemx -mno-nop-mcount
26649 @opindex mnop-mcount
26650 If profiling is active (@option{-pg}), generate the calls to
26651 the profiling functions as NOPs. This is useful when they
26652 should be patched in later dynamically. This is likely only
26653 useful together with @option{-mrecord-mcount}.
26655 @item -mskip-rax-setup
26656 @itemx -mno-skip-rax-setup
26657 @opindex mskip-rax-setup
26658 When generating code for the x86-64 architecture with SSE extensions
26659 disabled, @option{-mskip-rax-setup} can be used to skip setting up RAX
26660 register when there are no variable arguments passed in vector registers.
26662 @strong{Warning:} Since RAX register is used to avoid unnecessarily
26663 saving vector registers on stack when passing variable arguments, the
26664 impacts of this option are callees may waste some stack space,
26665 misbehave or jump to a random location.  GCC 4.4 or newer don't have
26666 those issues, regardless the RAX register value.
26668 @item -m8bit-idiv
26669 @itemx -mno-8bit-idiv
26670 @opindex m8bit-idiv
26671 On some processors, like Intel Atom, 8-bit unsigned integer divide is
26672 much faster than 32-bit/64-bit integer divide.  This option generates a
26673 run-time check.  If both dividend and divisor are within range of 0
26674 to 255, 8-bit unsigned integer divide is used instead of
26675 32-bit/64-bit integer divide.
26677 @item -mavx256-split-unaligned-load
26678 @itemx -mavx256-split-unaligned-store
26679 @opindex mavx256-split-unaligned-load
26680 @opindex mavx256-split-unaligned-store
26681 Split 32-byte AVX unaligned load and store.
26683 @item -mstack-protector-guard=@var{guard}
26684 @itemx -mstack-protector-guard-reg=@var{reg}
26685 @itemx -mstack-protector-guard-offset=@var{offset}
26686 @opindex mstack-protector-guard
26687 @opindex mstack-protector-guard-reg
26688 @opindex mstack-protector-guard-offset
26689 Generate stack protection code using canary at @var{guard}.  Supported
26690 locations are @samp{global} for global canary or @samp{tls} for per-thread
26691 canary in the TLS block (the default).  This option has effect only when
26692 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
26694 With the latter choice the options
26695 @option{-mstack-protector-guard-reg=@var{reg}} and
26696 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
26697 which segment register (@code{%fs} or @code{%gs}) to use as base register
26698 for reading the canary, and from what offset from that base register.
26699 The default for those is as specified in the relevant ABI.
26701 @item -mmitigate-rop
26702 @opindex mmitigate-rop
26703 Try to avoid generating code sequences that contain unintended return
26704 opcodes, to mitigate against certain forms of attack. At the moment,
26705 this option is limited in what it can do and should not be relied
26706 on to provide serious protection.
26708 @item -mgeneral-regs-only
26709 @opindex mgeneral-regs-only
26710 Generate code that uses only the general-purpose registers.  This
26711 prevents the compiler from using floating-point, vector, mask and bound
26712 registers.
26714 @end table
26716 These @samp{-m} switches are supported in addition to the above
26717 on x86-64 processors in 64-bit environments.
26719 @table @gcctabopt
26720 @item -m32
26721 @itemx -m64
26722 @itemx -mx32
26723 @itemx -m16
26724 @itemx -miamcu
26725 @opindex m32
26726 @opindex m64
26727 @opindex mx32
26728 @opindex m16
26729 @opindex miamcu
26730 Generate code for a 16-bit, 32-bit or 64-bit environment.
26731 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
26732 to 32 bits, and
26733 generates code that runs on any i386 system.
26735 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
26736 types to 64 bits, and generates code for the x86-64 architecture.
26737 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
26738 and @option{-mdynamic-no-pic} options.
26740 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
26741 to 32 bits, and
26742 generates code for the x86-64 architecture.
26744 The @option{-m16} option is the same as @option{-m32}, except for that
26745 it outputs the @code{.code16gcc} assembly directive at the beginning of
26746 the assembly output so that the binary can run in 16-bit mode.
26748 The @option{-miamcu} option generates code which conforms to Intel MCU
26749 psABI.  It requires the @option{-m32} option to be turned on.
26751 @item -mno-red-zone
26752 @opindex mno-red-zone
26753 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
26754 by the x86-64 ABI; it is a 128-byte area beyond the location of the
26755 stack pointer that is not modified by signal or interrupt handlers
26756 and therefore can be used for temporary data without adjusting the stack
26757 pointer.  The flag @option{-mno-red-zone} disables this red zone.
26759 @item -mcmodel=small
26760 @opindex mcmodel=small
26761 Generate code for the small code model: the program and its symbols must
26762 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
26763 Programs can be statically or dynamically linked.  This is the default
26764 code model.
26766 @item -mcmodel=kernel
26767 @opindex mcmodel=kernel
26768 Generate code for the kernel code model.  The kernel runs in the
26769 negative 2 GB of the address space.
26770 This model has to be used for Linux kernel code.
26772 @item -mcmodel=medium
26773 @opindex mcmodel=medium
26774 Generate code for the medium model: the program is linked in the lower 2
26775 GB of the address space.  Small symbols are also placed there.  Symbols
26776 with sizes larger than @option{-mlarge-data-threshold} are put into
26777 large data or BSS sections and can be located above 2GB.  Programs can
26778 be statically or dynamically linked.
26780 @item -mcmodel=large
26781 @opindex mcmodel=large
26782 Generate code for the large model.  This model makes no assumptions
26783 about addresses and sizes of sections.
26785 @item -maddress-mode=long
26786 @opindex maddress-mode=long
26787 Generate code for long address mode.  This is only supported for 64-bit
26788 and x32 environments.  It is the default address mode for 64-bit
26789 environments.
26791 @item -maddress-mode=short
26792 @opindex maddress-mode=short
26793 Generate code for short address mode.  This is only supported for 32-bit
26794 and x32 environments.  It is the default address mode for 32-bit and
26795 x32 environments.
26796 @end table
26798 @node x86 Windows Options
26799 @subsection x86 Windows Options
26800 @cindex x86 Windows Options
26801 @cindex Windows Options for x86
26803 These additional options are available for Microsoft Windows targets:
26805 @table @gcctabopt
26806 @item -mconsole
26807 @opindex mconsole
26808 This option
26809 specifies that a console application is to be generated, by
26810 instructing the linker to set the PE header subsystem type
26811 required for console applications.
26812 This option is available for Cygwin and MinGW targets and is
26813 enabled by default on those targets.
26815 @item -mdll
26816 @opindex mdll
26817 This option is available for Cygwin and MinGW targets.  It
26818 specifies that a DLL---a dynamic link library---is to be
26819 generated, enabling the selection of the required runtime
26820 startup object and entry point.
26822 @item -mnop-fun-dllimport
26823 @opindex mnop-fun-dllimport
26824 This option is available for Cygwin and MinGW targets.  It
26825 specifies that the @code{dllimport} attribute should be ignored.
26827 @item -mthread
26828 @opindex mthread
26829 This option is available for MinGW targets. It specifies
26830 that MinGW-specific thread support is to be used.
26832 @item -municode
26833 @opindex municode
26834 This option is available for MinGW-w64 targets.  It causes
26835 the @code{UNICODE} preprocessor macro to be predefined, and
26836 chooses Unicode-capable runtime startup code.
26838 @item -mwin32
26839 @opindex mwin32
26840 This option is available for Cygwin and MinGW targets.  It
26841 specifies that the typical Microsoft Windows predefined macros are to
26842 be set in the pre-processor, but does not influence the choice
26843 of runtime library/startup code.
26845 @item -mwindows
26846 @opindex mwindows
26847 This option is available for Cygwin and MinGW targets.  It
26848 specifies that a GUI application is to be generated by
26849 instructing the linker to set the PE header subsystem type
26850 appropriately.
26852 @item -fno-set-stack-executable
26853 @opindex fno-set-stack-executable
26854 This option is available for MinGW targets. It specifies that
26855 the executable flag for the stack used by nested functions isn't
26856 set. This is necessary for binaries running in kernel mode of
26857 Microsoft Windows, as there the User32 API, which is used to set executable
26858 privileges, isn't available.
26860 @item -fwritable-relocated-rdata
26861 @opindex fno-writable-relocated-rdata
26862 This option is available for MinGW and Cygwin targets.  It specifies
26863 that relocated-data in read-only section is put into the @code{.data}
26864 section.  This is a necessary for older runtimes not supporting
26865 modification of @code{.rdata} sections for pseudo-relocation.
26867 @item -mpe-aligned-commons
26868 @opindex mpe-aligned-commons
26869 This option is available for Cygwin and MinGW targets.  It
26870 specifies that the GNU extension to the PE file format that
26871 permits the correct alignment of COMMON variables should be
26872 used when generating code.  It is enabled by default if
26873 GCC detects that the target assembler found during configuration
26874 supports the feature.
26875 @end table
26877 See also under @ref{x86 Options} for standard options.
26879 @node Xstormy16 Options
26880 @subsection Xstormy16 Options
26881 @cindex Xstormy16 Options
26883 These options are defined for Xstormy16:
26885 @table @gcctabopt
26886 @item -msim
26887 @opindex msim
26888 Choose startup files and linker script suitable for the simulator.
26889 @end table
26891 @node Xtensa Options
26892 @subsection Xtensa Options
26893 @cindex Xtensa Options
26895 These options are supported for Xtensa targets:
26897 @table @gcctabopt
26898 @item -mconst16
26899 @itemx -mno-const16
26900 @opindex mconst16
26901 @opindex mno-const16
26902 Enable or disable use of @code{CONST16} instructions for loading
26903 constant values.  The @code{CONST16} instruction is currently not a
26904 standard option from Tensilica.  When enabled, @code{CONST16}
26905 instructions are always used in place of the standard @code{L32R}
26906 instructions.  The use of @code{CONST16} is enabled by default only if
26907 the @code{L32R} instruction is not available.
26909 @item -mfused-madd
26910 @itemx -mno-fused-madd
26911 @opindex mfused-madd
26912 @opindex mno-fused-madd
26913 Enable or disable use of fused multiply/add and multiply/subtract
26914 instructions in the floating-point option.  This has no effect if the
26915 floating-point option is not also enabled.  Disabling fused multiply/add
26916 and multiply/subtract instructions forces the compiler to use separate
26917 instructions for the multiply and add/subtract operations.  This may be
26918 desirable in some cases where strict IEEE 754-compliant results are
26919 required: the fused multiply add/subtract instructions do not round the
26920 intermediate result, thereby producing results with @emph{more} bits of
26921 precision than specified by the IEEE standard.  Disabling fused multiply
26922 add/subtract instructions also ensures that the program output is not
26923 sensitive to the compiler's ability to combine multiply and add/subtract
26924 operations.
26926 @item -mserialize-volatile
26927 @itemx -mno-serialize-volatile
26928 @opindex mserialize-volatile
26929 @opindex mno-serialize-volatile
26930 When this option is enabled, GCC inserts @code{MEMW} instructions before
26931 @code{volatile} memory references to guarantee sequential consistency.
26932 The default is @option{-mserialize-volatile}.  Use
26933 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
26935 @item -mforce-no-pic
26936 @opindex mforce-no-pic
26937 For targets, like GNU/Linux, where all user-mode Xtensa code must be
26938 position-independent code (PIC), this option disables PIC for compiling
26939 kernel code.
26941 @item -mtext-section-literals
26942 @itemx -mno-text-section-literals
26943 @opindex mtext-section-literals
26944 @opindex mno-text-section-literals
26945 These options control the treatment of literal pools.  The default is
26946 @option{-mno-text-section-literals}, which places literals in a separate
26947 section in the output file.  This allows the literal pool to be placed
26948 in a data RAM/ROM, and it also allows the linker to combine literal
26949 pools from separate object files to remove redundant literals and
26950 improve code size.  With @option{-mtext-section-literals}, the literals
26951 are interspersed in the text section in order to keep them as close as
26952 possible to their references.  This may be necessary for large assembly
26953 files.  Literals for each function are placed right before that function.
26955 @item -mauto-litpools
26956 @itemx -mno-auto-litpools
26957 @opindex mauto-litpools
26958 @opindex mno-auto-litpools
26959 These options control the treatment of literal pools.  The default is
26960 @option{-mno-auto-litpools}, which places literals in a separate
26961 section in the output file unless @option{-mtext-section-literals} is
26962 used.  With @option{-mauto-litpools} the literals are interspersed in
26963 the text section by the assembler.  Compiler does not produce explicit
26964 @code{.literal} directives and loads literals into registers with
26965 @code{MOVI} instructions instead of @code{L32R} to let the assembler
26966 do relaxation and place literals as necessary.  This option allows
26967 assembler to create several literal pools per function and assemble
26968 very big functions, which may not be possible with
26969 @option{-mtext-section-literals}.
26971 @item -mtarget-align
26972 @itemx -mno-target-align
26973 @opindex mtarget-align
26974 @opindex mno-target-align
26975 When this option is enabled, GCC instructs the assembler to
26976 automatically align instructions to reduce branch penalties at the
26977 expense of some code density.  The assembler attempts to widen density
26978 instructions to align branch targets and the instructions following call
26979 instructions.  If there are not enough preceding safe density
26980 instructions to align a target, no widening is performed.  The
26981 default is @option{-mtarget-align}.  These options do not affect the
26982 treatment of auto-aligned instructions like @code{LOOP}, which the
26983 assembler always aligns, either by widening density instructions or
26984 by inserting NOP instructions.
26986 @item -mlongcalls
26987 @itemx -mno-longcalls
26988 @opindex mlongcalls
26989 @opindex mno-longcalls
26990 When this option is enabled, GCC instructs the assembler to translate
26991 direct calls to indirect calls unless it can determine that the target
26992 of a direct call is in the range allowed by the call instruction.  This
26993 translation typically occurs for calls to functions in other source
26994 files.  Specifically, the assembler translates a direct @code{CALL}
26995 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
26996 The default is @option{-mno-longcalls}.  This option should be used in
26997 programs where the call target can potentially be out of range.  This
26998 option is implemented in the assembler, not the compiler, so the
26999 assembly code generated by GCC still shows direct call
27000 instructions---look at the disassembled object code to see the actual
27001 instructions.  Note that the assembler uses an indirect call for
27002 every cross-file call, not just those that really are out of range.
27003 @end table
27005 @node zSeries Options
27006 @subsection zSeries Options
27007 @cindex zSeries options
27009 These are listed under @xref{S/390 and zSeries Options}.
27012 @c man end
27014 @node Spec Files
27015 @section Specifying Subprocesses and the Switches to Pass to Them
27016 @cindex Spec Files
27018 @command{gcc} is a driver program.  It performs its job by invoking a
27019 sequence of other programs to do the work of compiling, assembling and
27020 linking.  GCC interprets its command-line parameters and uses these to
27021 deduce which programs it should invoke, and which command-line options
27022 it ought to place on their command lines.  This behavior is controlled
27023 by @dfn{spec strings}.  In most cases there is one spec string for each
27024 program that GCC can invoke, but a few programs have multiple spec
27025 strings to control their behavior.  The spec strings built into GCC can
27026 be overridden by using the @option{-specs=} command-line switch to specify
27027 a spec file.
27029 @dfn{Spec files} are plain-text files that are used to construct spec
27030 strings.  They consist of a sequence of directives separated by blank
27031 lines.  The type of directive is determined by the first non-whitespace
27032 character on the line, which can be one of the following:
27034 @table @code
27035 @item %@var{command}
27036 Issues a @var{command} to the spec file processor.  The commands that can
27037 appear here are:
27039 @table @code
27040 @item %include <@var{file}>
27041 @cindex @code{%include}
27042 Search for @var{file} and insert its text at the current point in the
27043 specs file.
27045 @item %include_noerr <@var{file}>
27046 @cindex @code{%include_noerr}
27047 Just like @samp{%include}, but do not generate an error message if the include
27048 file cannot be found.
27050 @item %rename @var{old_name} @var{new_name}
27051 @cindex @code{%rename}
27052 Rename the spec string @var{old_name} to @var{new_name}.
27054 @end table
27056 @item *[@var{spec_name}]:
27057 This tells the compiler to create, override or delete the named spec
27058 string.  All lines after this directive up to the next directive or
27059 blank line are considered to be the text for the spec string.  If this
27060 results in an empty string then the spec is deleted.  (Or, if the
27061 spec did not exist, then nothing happens.)  Otherwise, if the spec
27062 does not currently exist a new spec is created.  If the spec does
27063 exist then its contents are overridden by the text of this
27064 directive, unless the first character of that text is the @samp{+}
27065 character, in which case the text is appended to the spec.
27067 @item [@var{suffix}]:
27068 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
27069 and up to the next directive or blank line are considered to make up the
27070 spec string for the indicated suffix.  When the compiler encounters an
27071 input file with the named suffix, it processes the spec string in
27072 order to work out how to compile that file.  For example:
27074 @smallexample
27075 .ZZ:
27076 z-compile -input %i
27077 @end smallexample
27079 This says that any input file whose name ends in @samp{.ZZ} should be
27080 passed to the program @samp{z-compile}, which should be invoked with the
27081 command-line switch @option{-input} and with the result of performing the
27082 @samp{%i} substitution.  (See below.)
27084 As an alternative to providing a spec string, the text following a
27085 suffix directive can be one of the following:
27087 @table @code
27088 @item @@@var{language}
27089 This says that the suffix is an alias for a known @var{language}.  This is
27090 similar to using the @option{-x} command-line switch to GCC to specify a
27091 language explicitly.  For example:
27093 @smallexample
27094 .ZZ:
27095 @@c++
27096 @end smallexample
27098 Says that .ZZ files are, in fact, C++ source files.
27100 @item #@var{name}
27101 This causes an error messages saying:
27103 @smallexample
27104 @var{name} compiler not installed on this system.
27105 @end smallexample
27106 @end table
27108 GCC already has an extensive list of suffixes built into it.
27109 This directive adds an entry to the end of the list of suffixes, but
27110 since the list is searched from the end backwards, it is effectively
27111 possible to override earlier entries using this technique.
27113 @end table
27115 GCC has the following spec strings built into it.  Spec files can
27116 override these strings or create their own.  Note that individual
27117 targets can also add their own spec strings to this list.
27119 @smallexample
27120 asm          Options to pass to the assembler
27121 asm_final    Options to pass to the assembler post-processor
27122 cpp          Options to pass to the C preprocessor
27123 cc1          Options to pass to the C compiler
27124 cc1plus      Options to pass to the C++ compiler
27125 endfile      Object files to include at the end of the link
27126 link         Options to pass to the linker
27127 lib          Libraries to include on the command line to the linker
27128 libgcc       Decides which GCC support library to pass to the linker
27129 linker       Sets the name of the linker
27130 predefines   Defines to be passed to the C preprocessor
27131 signed_char  Defines to pass to CPP to say whether @code{char} is signed
27132              by default
27133 startfile    Object files to include at the start of the link
27134 @end smallexample
27136 Here is a small example of a spec file:
27138 @smallexample
27139 %rename lib                 old_lib
27141 *lib:
27142 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
27143 @end smallexample
27145 This example renames the spec called @samp{lib} to @samp{old_lib} and
27146 then overrides the previous definition of @samp{lib} with a new one.
27147 The new definition adds in some extra command-line options before
27148 including the text of the old definition.
27150 @dfn{Spec strings} are a list of command-line options to be passed to their
27151 corresponding program.  In addition, the spec strings can contain
27152 @samp{%}-prefixed sequences to substitute variable text or to
27153 conditionally insert text into the command line.  Using these constructs
27154 it is possible to generate quite complex command lines.
27156 Here is a table of all defined @samp{%}-sequences for spec
27157 strings.  Note that spaces are not generated automatically around the
27158 results of expanding these sequences.  Therefore you can concatenate them
27159 together or combine them with constant text in a single argument.
27161 @table @code
27162 @item %%
27163 Substitute one @samp{%} into the program name or argument.
27165 @item %i
27166 Substitute the name of the input file being processed.
27168 @item %b
27169 Substitute the basename of the input file being processed.
27170 This is the substring up to (and not including) the last period
27171 and not including the directory.
27173 @item %B
27174 This is the same as @samp{%b}, but include the file suffix (text after
27175 the last period).
27177 @item %d
27178 Marks the argument containing or following the @samp{%d} as a
27179 temporary file name, so that that file is deleted if GCC exits
27180 successfully.  Unlike @samp{%g}, this contributes no text to the
27181 argument.
27183 @item %g@var{suffix}
27184 Substitute a file name that has suffix @var{suffix} and is chosen
27185 once per compilation, and mark the argument in the same way as
27186 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
27187 name is now chosen in a way that is hard to predict even when previously
27188 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
27189 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
27190 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
27191 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
27192 was simply substituted with a file name chosen once per compilation,
27193 without regard to any appended suffix (which was therefore treated
27194 just like ordinary text), making such attacks more likely to succeed.
27196 @item %u@var{suffix}
27197 Like @samp{%g}, but generates a new temporary file name
27198 each time it appears instead of once per compilation.
27200 @item %U@var{suffix}
27201 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
27202 new one if there is no such last file name.  In the absence of any
27203 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
27204 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
27205 involves the generation of two distinct file names, one
27206 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
27207 simply substituted with a file name chosen for the previous @samp{%u},
27208 without regard to any appended suffix.
27210 @item %j@var{suffix}
27211 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
27212 writable, and if @option{-save-temps} is not used; 
27213 otherwise, substitute the name
27214 of a temporary file, just like @samp{%u}.  This temporary file is not
27215 meant for communication between processes, but rather as a junk
27216 disposal mechanism.
27218 @item %|@var{suffix}
27219 @itemx %m@var{suffix}
27220 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
27221 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
27222 all.  These are the two most common ways to instruct a program that it
27223 should read from standard input or write to standard output.  If you
27224 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
27225 construct: see for example @file{f/lang-specs.h}.
27227 @item %.@var{SUFFIX}
27228 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
27229 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
27230 terminated by the next space or %.
27232 @item %w
27233 Marks the argument containing or following the @samp{%w} as the
27234 designated output file of this compilation.  This puts the argument
27235 into the sequence of arguments that @samp{%o} substitutes.
27237 @item %o
27238 Substitutes the names of all the output files, with spaces
27239 automatically placed around them.  You should write spaces
27240 around the @samp{%o} as well or the results are undefined.
27241 @samp{%o} is for use in the specs for running the linker.
27242 Input files whose names have no recognized suffix are not compiled
27243 at all, but they are included among the output files, so they are
27244 linked.
27246 @item %O
27247 Substitutes the suffix for object files.  Note that this is
27248 handled specially when it immediately follows @samp{%g, %u, or %U},
27249 because of the need for those to form complete file names.  The
27250 handling is such that @samp{%O} is treated exactly as if it had already
27251 been substituted, except that @samp{%g, %u, and %U} do not currently
27252 support additional @var{suffix} characters following @samp{%O} as they do
27253 following, for example, @samp{.o}.
27255 @item %p
27256 Substitutes the standard macro predefinitions for the
27257 current target machine.  Use this when running @command{cpp}.
27259 @item %P
27260 Like @samp{%p}, but puts @samp{__} before and after the name of each
27261 predefined macro, except for macros that start with @samp{__} or with
27262 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
27265 @item %I
27266 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
27267 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
27268 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
27269 and @option{-imultilib} as necessary.
27271 @item %s
27272 Current argument is the name of a library or startup file of some sort.
27273 Search for that file in a standard list of directories and substitute
27274 the full name found.  The current working directory is included in the
27275 list of directories scanned.
27277 @item %T
27278 Current argument is the name of a linker script.  Search for that file
27279 in the current list of directories to scan for libraries. If the file
27280 is located insert a @option{--script} option into the command line
27281 followed by the full path name found.  If the file is not found then
27282 generate an error message.  Note: the current working directory is not
27283 searched.
27285 @item %e@var{str}
27286 Print @var{str} as an error message.  @var{str} is terminated by a newline.
27287 Use this when inconsistent options are detected.
27289 @item %(@var{name})
27290 Substitute the contents of spec string @var{name} at this point.
27292 @item %x@{@var{option}@}
27293 Accumulate an option for @samp{%X}.
27295 @item %X
27296 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
27297 spec string.
27299 @item %Y
27300 Output the accumulated assembler options specified by @option{-Wa}.
27302 @item %Z
27303 Output the accumulated preprocessor options specified by @option{-Wp}.
27305 @item %a
27306 Process the @code{asm} spec.  This is used to compute the
27307 switches to be passed to the assembler.
27309 @item %A
27310 Process the @code{asm_final} spec.  This is a spec string for
27311 passing switches to an assembler post-processor, if such a program is
27312 needed.
27314 @item %l
27315 Process the @code{link} spec.  This is the spec for computing the
27316 command line passed to the linker.  Typically it makes use of the
27317 @samp{%L %G %S %D and %E} sequences.
27319 @item %D
27320 Dump out a @option{-L} option for each directory that GCC believes might
27321 contain startup files.  If the target supports multilibs then the
27322 current multilib directory is prepended to each of these paths.
27324 @item %L
27325 Process the @code{lib} spec.  This is a spec string for deciding which
27326 libraries are included on the command line to the linker.
27328 @item %G
27329 Process the @code{libgcc} spec.  This is a spec string for deciding
27330 which GCC support library is included on the command line to the linker.
27332 @item %S
27333 Process the @code{startfile} spec.  This is a spec for deciding which
27334 object files are the first ones passed to the linker.  Typically
27335 this might be a file named @file{crt0.o}.
27337 @item %E
27338 Process the @code{endfile} spec.  This is a spec string that specifies
27339 the last object files that are passed to the linker.
27341 @item %C
27342 Process the @code{cpp} spec.  This is used to construct the arguments
27343 to be passed to the C preprocessor.
27345 @item %1
27346 Process the @code{cc1} spec.  This is used to construct the options to be
27347 passed to the actual C compiler (@command{cc1}).
27349 @item %2
27350 Process the @code{cc1plus} spec.  This is used to construct the options to be
27351 passed to the actual C++ compiler (@command{cc1plus}).
27353 @item %*
27354 Substitute the variable part of a matched option.  See below.
27355 Note that each comma in the substituted string is replaced by
27356 a single space.
27358 @item %<S
27359 Remove all occurrences of @code{-S} from the command line.  Note---this
27360 command is position dependent.  @samp{%} commands in the spec string
27361 before this one see @code{-S}, @samp{%} commands in the spec string
27362 after this one do not.
27364 @item %:@var{function}(@var{args})
27365 Call the named function @var{function}, passing it @var{args}.
27366 @var{args} is first processed as a nested spec string, then split
27367 into an argument vector in the usual fashion.  The function returns
27368 a string which is processed as if it had appeared literally as part
27369 of the current spec.
27371 The following built-in spec functions are provided:
27373 @table @code
27374 @item @code{getenv}
27375 The @code{getenv} spec function takes two arguments: an environment
27376 variable name and a string.  If the environment variable is not
27377 defined, a fatal error is issued.  Otherwise, the return value is the
27378 value of the environment variable concatenated with the string.  For
27379 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
27381 @smallexample
27382 %:getenv(TOPDIR /include)
27383 @end smallexample
27385 expands to @file{/path/to/top/include}.
27387 @item @code{if-exists}
27388 The @code{if-exists} spec function takes one argument, an absolute
27389 pathname to a file.  If the file exists, @code{if-exists} returns the
27390 pathname.  Here is a small example of its usage:
27392 @smallexample
27393 *startfile:
27394 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
27395 @end smallexample
27397 @item @code{if-exists-else}
27398 The @code{if-exists-else} spec function is similar to the @code{if-exists}
27399 spec function, except that it takes two arguments.  The first argument is
27400 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
27401 returns the pathname.  If it does not exist, it returns the second argument.
27402 This way, @code{if-exists-else} can be used to select one file or another,
27403 based on the existence of the first.  Here is a small example of its usage:
27405 @smallexample
27406 *startfile:
27407 crt0%O%s %:if-exists(crti%O%s) \
27408 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
27409 @end smallexample
27411 @item @code{replace-outfile}
27412 The @code{replace-outfile} spec function takes two arguments.  It looks for the
27413 first argument in the outfiles array and replaces it with the second argument.  Here
27414 is a small example of its usage:
27416 @smallexample
27417 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
27418 @end smallexample
27420 @item @code{remove-outfile}
27421 The @code{remove-outfile} spec function takes one argument.  It looks for the
27422 first argument in the outfiles array and removes it.  Here is a small example
27423 its usage:
27425 @smallexample
27426 %:remove-outfile(-lm)
27427 @end smallexample
27429 @item @code{pass-through-libs}
27430 The @code{pass-through-libs} spec function takes any number of arguments.  It
27431 finds any @option{-l} options and any non-options ending in @file{.a} (which it
27432 assumes are the names of linker input library archive files) and returns a
27433 result containing all the found arguments each prepended by
27434 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
27435 intended to be passed to the LTO linker plugin.
27437 @smallexample
27438 %:pass-through-libs(%G %L %G)
27439 @end smallexample
27441 @item @code{print-asm-header}
27442 The @code{print-asm-header} function takes no arguments and simply
27443 prints a banner like:
27445 @smallexample
27446 Assembler options
27447 =================
27449 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
27450 @end smallexample
27452 It is used to separate compiler options from assembler options
27453 in the @option{--target-help} output.
27454 @end table
27456 @item %@{S@}
27457 Substitutes the @code{-S} switch, if that switch is given to GCC@.
27458 If that switch is not specified, this substitutes nothing.  Note that
27459 the leading dash is omitted when specifying this option, and it is
27460 automatically inserted if the substitution is performed.  Thus the spec
27461 string @samp{%@{foo@}} matches the command-line option @option{-foo}
27462 and outputs the command-line option @option{-foo}.
27464 @item %W@{S@}
27465 Like %@{@code{S}@} but mark last argument supplied within as a file to be
27466 deleted on failure.
27468 @item %@{S*@}
27469 Substitutes all the switches specified to GCC whose names start
27470 with @code{-S}, but which also take an argument.  This is used for
27471 switches like @option{-o}, @option{-D}, @option{-I}, etc.
27472 GCC considers @option{-o foo} as being
27473 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
27474 text, including the space.  Thus two arguments are generated.
27476 @item %@{S*&T*@}
27477 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
27478 (the order of @code{S} and @code{T} in the spec is not significant).
27479 There can be any number of ampersand-separated variables; for each the
27480 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
27482 @item %@{S:X@}
27483 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
27485 @item %@{!S:X@}
27486 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
27488 @item %@{S*:X@}
27489 Substitutes @code{X} if one or more switches whose names start with
27490 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
27491 once, no matter how many such switches appeared.  However, if @code{%*}
27492 appears somewhere in @code{X}, then @code{X} is substituted once
27493 for each matching switch, with the @code{%*} replaced by the part of
27494 that switch matching the @code{*}.
27496 If @code{%*} appears as the last part of a spec sequence then a space
27497 is added after the end of the last substitution.  If there is more
27498 text in the sequence, however, then a space is not generated.  This
27499 allows the @code{%*} substitution to be used as part of a larger
27500 string.  For example, a spec string like this:
27502 @smallexample
27503 %@{mcu=*:--script=%*/memory.ld@}
27504 @end smallexample
27506 @noindent
27507 when matching an option like @option{-mcu=newchip} produces:
27509 @smallexample
27510 --script=newchip/memory.ld
27511 @end smallexample
27513 @item %@{.S:X@}
27514 Substitutes @code{X}, if processing a file with suffix @code{S}.
27516 @item %@{!.S:X@}
27517 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
27519 @item %@{,S:X@}
27520 Substitutes @code{X}, if processing a file for language @code{S}.
27522 @item %@{!,S:X@}
27523 Substitutes @code{X}, if not processing a file for language @code{S}.
27525 @item %@{S|P:X@}
27526 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
27527 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
27528 @code{*} sequences as well, although they have a stronger binding than
27529 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
27530 alternatives must be starred, and only the first matching alternative
27531 is substituted.
27533 For example, a spec string like this:
27535 @smallexample
27536 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
27537 @end smallexample
27539 @noindent
27540 outputs the following command-line options from the following input
27541 command-line options:
27543 @smallexample
27544 fred.c        -foo -baz
27545 jim.d         -bar -boggle
27546 -d fred.c     -foo -baz -boggle
27547 -d jim.d      -bar -baz -boggle
27548 @end smallexample
27550 @item %@{S:X; T:Y; :D@}
27552 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
27553 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
27554 be as many clauses as you need.  This may be combined with @code{.},
27555 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
27558 @end table
27560 The switch matching text @code{S} in a @samp{%@{S@}}, @samp{%@{S:X@}}
27561 or similar construct can use a backslash to ignore the special meaning
27562 of the character following it, thus allowing literal matching of a
27563 character that is otherwise specially treated.  For example,
27564 @samp{%@{std=iso9899\:1999:X@}} substitutes @code{X} if the
27565 @option{-std=iso9899:1999} option is given.
27567 The conditional text @code{X} in a @samp{%@{S:X@}} or similar
27568 construct may contain other nested @samp{%} constructs or spaces, or
27569 even newlines.  They are processed as usual, as described above.
27570 Trailing white space in @code{X} is ignored.  White space may also
27571 appear anywhere on the left side of the colon in these constructs,
27572 except between @code{.} or @code{*} and the corresponding word.
27574 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
27575 handled specifically in these constructs.  If another value of
27576 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
27577 @option{-W} switch is found later in the command line, the earlier
27578 switch value is ignored, except with @{@code{S}*@} where @code{S} is
27579 just one letter, which passes all matching options.
27581 The character @samp{|} at the beginning of the predicate text is used to
27582 indicate that a command should be piped to the following command, but
27583 only if @option{-pipe} is specified.
27585 It is built into GCC which switches take arguments and which do not.
27586 (You might think it would be useful to generalize this to allow each
27587 compiler's spec to say which switches take arguments.  But this cannot
27588 be done in a consistent fashion.  GCC cannot even decide which input
27589 files have been specified without knowing which switches take arguments,
27590 and it must know which input files to compile in order to tell which
27591 compilers to run).
27593 GCC also knows implicitly that arguments starting in @option{-l} are to be
27594 treated as compiler output files, and passed to the linker in their
27595 proper position among the other output files.
27597 @node Environment Variables
27598 @section Environment Variables Affecting GCC
27599 @cindex environment variables
27601 @c man begin ENVIRONMENT
27602 This section describes several environment variables that affect how GCC
27603 operates.  Some of them work by specifying directories or prefixes to use
27604 when searching for various kinds of files.  Some are used to specify other
27605 aspects of the compilation environment.
27607 Note that you can also specify places to search using options such as
27608 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
27609 take precedence over places specified using environment variables, which
27610 in turn take precedence over those specified by the configuration of GCC@.
27611 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
27612 GNU Compiler Collection (GCC) Internals}.
27614 @table @env
27615 @item LANG
27616 @itemx LC_CTYPE
27617 @c @itemx LC_COLLATE
27618 @itemx LC_MESSAGES
27619 @c @itemx LC_MONETARY
27620 @c @itemx LC_NUMERIC
27621 @c @itemx LC_TIME
27622 @itemx LC_ALL
27623 @findex LANG
27624 @findex LC_CTYPE
27625 @c @findex LC_COLLATE
27626 @findex LC_MESSAGES
27627 @c @findex LC_MONETARY
27628 @c @findex LC_NUMERIC
27629 @c @findex LC_TIME
27630 @findex LC_ALL
27631 @cindex locale
27632 These environment variables control the way that GCC uses
27633 localization information which allows GCC to work with different
27634 national conventions.  GCC inspects the locale categories
27635 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
27636 so.  These locale categories can be set to any value supported by your
27637 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
27638 Kingdom encoded in UTF-8.
27640 The @env{LC_CTYPE} environment variable specifies character
27641 classification.  GCC uses it to determine the character boundaries in
27642 a string; this is needed for some multibyte encodings that contain quote
27643 and escape characters that are otherwise interpreted as a string
27644 end or escape.
27646 The @env{LC_MESSAGES} environment variable specifies the language to
27647 use in diagnostic messages.
27649 If the @env{LC_ALL} environment variable is set, it overrides the value
27650 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
27651 and @env{LC_MESSAGES} default to the value of the @env{LANG}
27652 environment variable.  If none of these variables are set, GCC
27653 defaults to traditional C English behavior.
27655 @item TMPDIR
27656 @findex TMPDIR
27657 If @env{TMPDIR} is set, it specifies the directory to use for temporary
27658 files.  GCC uses temporary files to hold the output of one stage of
27659 compilation which is to be used as input to the next stage: for example,
27660 the output of the preprocessor, which is the input to the compiler
27661 proper.
27663 @item GCC_COMPARE_DEBUG
27664 @findex GCC_COMPARE_DEBUG
27665 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
27666 @option{-fcompare-debug} to the compiler driver.  See the documentation
27667 of this option for more details.
27669 @item GCC_EXEC_PREFIX
27670 @findex GCC_EXEC_PREFIX
27671 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
27672 names of the subprograms executed by the compiler.  No slash is added
27673 when this prefix is combined with the name of a subprogram, but you can
27674 specify a prefix that ends with a slash if you wish.
27676 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
27677 an appropriate prefix to use based on the pathname it is invoked with.
27679 If GCC cannot find the subprogram using the specified prefix, it
27680 tries looking in the usual places for the subprogram.
27682 The default value of @env{GCC_EXEC_PREFIX} is
27683 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
27684 the installed compiler. In many cases @var{prefix} is the value
27685 of @code{prefix} when you ran the @file{configure} script.
27687 Other prefixes specified with @option{-B} take precedence over this prefix.
27689 This prefix is also used for finding files such as @file{crt0.o} that are
27690 used for linking.
27692 In addition, the prefix is used in an unusual way in finding the
27693 directories to search for header files.  For each of the standard
27694 directories whose name normally begins with @samp{/usr/local/lib/gcc}
27695 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
27696 replacing that beginning with the specified prefix to produce an
27697 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
27698 @file{foo/bar} just before it searches the standard directory 
27699 @file{/usr/local/lib/bar}.
27700 If a standard directory begins with the configured
27701 @var{prefix} then the value of @var{prefix} is replaced by
27702 @env{GCC_EXEC_PREFIX} when looking for header files.
27704 @item COMPILER_PATH
27705 @findex COMPILER_PATH
27706 The value of @env{COMPILER_PATH} is a colon-separated list of
27707 directories, much like @env{PATH}.  GCC tries the directories thus
27708 specified when searching for subprograms, if it cannot find the
27709 subprograms using @env{GCC_EXEC_PREFIX}.
27711 @item LIBRARY_PATH
27712 @findex LIBRARY_PATH
27713 The value of @env{LIBRARY_PATH} is a colon-separated list of
27714 directories, much like @env{PATH}.  When configured as a native compiler,
27715 GCC tries the directories thus specified when searching for special
27716 linker files, if it cannot find them using @env{GCC_EXEC_PREFIX}.  Linking
27717 using GCC also uses these directories when searching for ordinary
27718 libraries for the @option{-l} option (but directories specified with
27719 @option{-L} come first).
27721 @item LANG
27722 @findex LANG
27723 @cindex locale definition
27724 This variable is used to pass locale information to the compiler.  One way in
27725 which this information is used is to determine the character set to be used
27726 when character literals, string literals and comments are parsed in C and C++.
27727 When the compiler is configured to allow multibyte characters,
27728 the following values for @env{LANG} are recognized:
27730 @table @samp
27731 @item C-JIS
27732 Recognize JIS characters.
27733 @item C-SJIS
27734 Recognize SJIS characters.
27735 @item C-EUCJP
27736 Recognize EUCJP characters.
27737 @end table
27739 If @env{LANG} is not defined, or if it has some other value, then the
27740 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
27741 recognize and translate multibyte characters.
27742 @end table
27744 @noindent
27745 Some additional environment variables affect the behavior of the
27746 preprocessor.
27748 @include cppenv.texi
27750 @c man end
27752 @node Precompiled Headers
27753 @section Using Precompiled Headers
27754 @cindex precompiled headers
27755 @cindex speed of compilation
27757 Often large projects have many header files that are included in every
27758 source file.  The time the compiler takes to process these header files
27759 over and over again can account for nearly all of the time required to
27760 build the project.  To make builds faster, GCC allows you to
27761 @dfn{precompile} a header file.
27763 To create a precompiled header file, simply compile it as you would any
27764 other file, if necessary using the @option{-x} option to make the driver
27765 treat it as a C or C++ header file.  You may want to use a
27766 tool like @command{make} to keep the precompiled header up-to-date when
27767 the headers it contains change.
27769 A precompiled header file is searched for when @code{#include} is
27770 seen in the compilation.  As it searches for the included file
27771 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
27772 compiler looks for a precompiled header in each directory just before it
27773 looks for the include file in that directory.  The name searched for is
27774 the name specified in the @code{#include} with @samp{.gch} appended.  If
27775 the precompiled header file cannot be used, it is ignored.
27777 For instance, if you have @code{#include "all.h"}, and you have
27778 @file{all.h.gch} in the same directory as @file{all.h}, then the
27779 precompiled header file is used if possible, and the original
27780 header is used otherwise.
27782 Alternatively, you might decide to put the precompiled header file in a
27783 directory and use @option{-I} to ensure that directory is searched
27784 before (or instead of) the directory containing the original header.
27785 Then, if you want to check that the precompiled header file is always
27786 used, you can put a file of the same name as the original header in this
27787 directory containing an @code{#error} command.
27789 This also works with @option{-include}.  So yet another way to use
27790 precompiled headers, good for projects not designed with precompiled
27791 header files in mind, is to simply take most of the header files used by
27792 a project, include them from another header file, precompile that header
27793 file, and @option{-include} the precompiled header.  If the header files
27794 have guards against multiple inclusion, they are skipped because
27795 they've already been included (in the precompiled header).
27797 If you need to precompile the same header file for different
27798 languages, targets, or compiler options, you can instead make a
27799 @emph{directory} named like @file{all.h.gch}, and put each precompiled
27800 header in the directory, perhaps using @option{-o}.  It doesn't matter
27801 what you call the files in the directory; every precompiled header in
27802 the directory is considered.  The first precompiled header
27803 encountered in the directory that is valid for this compilation is
27804 used; they're searched in no particular order.
27806 There are many other possibilities, limited only by your imagination,
27807 good sense, and the constraints of your build system.
27809 A precompiled header file can be used only when these conditions apply:
27811 @itemize
27812 @item
27813 Only one precompiled header can be used in a particular compilation.
27815 @item
27816 A precompiled header cannot be used once the first C token is seen.  You
27817 can have preprocessor directives before a precompiled header; you cannot
27818 include a precompiled header from inside another header.
27820 @item
27821 The precompiled header file must be produced for the same language as
27822 the current compilation.  You cannot use a C precompiled header for a C++
27823 compilation.
27825 @item
27826 The precompiled header file must have been produced by the same compiler
27827 binary as the current compilation is using.
27829 @item
27830 Any macros defined before the precompiled header is included must
27831 either be defined in the same way as when the precompiled header was
27832 generated, or must not affect the precompiled header, which usually
27833 means that they don't appear in the precompiled header at all.
27835 The @option{-D} option is one way to define a macro before a
27836 precompiled header is included; using a @code{#define} can also do it.
27837 There are also some options that define macros implicitly, like
27838 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
27839 defined this way.
27841 @item If debugging information is output when using the precompiled
27842 header, using @option{-g} or similar, the same kind of debugging information
27843 must have been output when building the precompiled header.  However,
27844 a precompiled header built using @option{-g} can be used in a compilation
27845 when no debugging information is being output.
27847 @item The same @option{-m} options must generally be used when building
27848 and using the precompiled header.  @xref{Submodel Options},
27849 for any cases where this rule is relaxed.
27851 @item Each of the following options must be the same when building and using
27852 the precompiled header:
27854 @gccoptlist{-fexceptions}
27856 @item
27857 Some other command-line options starting with @option{-f},
27858 @option{-p}, or @option{-O} must be defined in the same way as when
27859 the precompiled header was generated.  At present, it's not clear
27860 which options are safe to change and which are not; the safest choice
27861 is to use exactly the same options when generating and using the
27862 precompiled header.  The following are known to be safe:
27864 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
27865 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
27866 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
27867 -pedantic-errors}
27869 @end itemize
27871 For all of these except the last, the compiler automatically
27872 ignores the precompiled header if the conditions aren't met.  If you
27873 find an option combination that doesn't work and doesn't cause the
27874 precompiled header to be ignored, please consider filing a bug report,
27875 see @ref{Bugs}.
27877 If you do use differing options when generating and using the
27878 precompiled header, the actual behavior is a mixture of the
27879 behavior for the options.  For instance, if you use @option{-g} to
27880 generate the precompiled header but not when using it, you may or may
27881 not get debugging information for routines in the precompiled header.