gcc/
[official-gcc.git] / gcc / doc / invoke.texi
blob5ae9dc4128d5bd2abc15e6b1982051b798f73b70
1 @c Copyright (C) 1988-2017 Free Software Foundation, Inc.
2 @c This is part of the GCC manual.
3 @c For copying conditions, see the file gcc.texi.
5 @ignore
6 @c man begin INCLUDE
7 @include gcc-vers.texi
8 @c man end
10 @c man begin COPYRIGHT
11 Copyright @copyright{} 1988-2017 Free Software Foundation, Inc.
13 Permission is granted to copy, distribute and/or modify this document
14 under the terms of the GNU Free Documentation License, Version 1.3 or
15 any later version published by the Free Software Foundation; with the
16 Invariant Sections being ``GNU General Public License'' and ``Funding
17 Free Software'', the Front-Cover texts being (a) (see below), and with
18 the Back-Cover Texts being (b) (see below).  A copy of the license is
19 included in the gfdl(7) man page.
21 (a) The FSF's Front-Cover Text is:
23      A GNU Manual
25 (b) The FSF's Back-Cover Text is:
27      You have freedom to copy and modify this GNU Manual, like GNU
28      software.  Copies published by the Free Software Foundation raise
29      funds for GNU development.
30 @c man end
31 @c Set file name and title for the man page.
32 @setfilename gcc
33 @settitle GNU project C and C++ compiler
34 @c man begin SYNOPSIS
35 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
36     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
37     [@option{-W}@var{warn}@dots{}] [@option{-Wpedantic}]
38     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
39     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
40     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
41     [@option{-o} @var{outfile}] [@@@var{file}] @var{infile}@dots{}
43 Only the most useful options are listed here; see below for the
44 remainder.  @command{g++} accepts mostly the same options as @command{gcc}.
45 @c man end
46 @c man begin SEEALSO
47 gpl(7), gfdl(7), fsf-funding(7),
48 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
49 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
50 @file{ld}, @file{binutils} and @file{gdb}.
51 @c man end
52 @c man begin BUGS
53 For instructions on reporting bugs, see
54 @w{@value{BUGURL}}.
55 @c man end
56 @c man begin AUTHOR
57 See the Info entry for @command{gcc}, or
58 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
59 for contributors to GCC@.
60 @c man end
61 @end ignore
63 @node Invoking GCC
64 @chapter GCC Command Options
65 @cindex GCC command options
66 @cindex command options
67 @cindex options, GCC command
69 @c man begin DESCRIPTION
70 When you invoke GCC, it normally does preprocessing, compilation,
71 assembly and linking.  The ``overall options'' allow you to stop this
72 process at an intermediate stage.  For example, the @option{-c} option
73 says not to run the linker.  Then the output consists of object files
74 output by the assembler.
75 @xref{Overall Options,,Options Controlling the Kind of Output}.
77 Other options are passed on to one or more stages of processing.  Some options
78 control the preprocessor and others the compiler itself.  Yet other
79 options control the assembler and linker; most of these are not
80 documented here, since you rarely need to use any of them.
82 @cindex C compilation options
83 Most of the command-line options that you can use with GCC are useful
84 for C programs; when an option is only useful with another language
85 (usually C++), the explanation says so explicitly.  If the description
86 for a particular option does not mention a source language, you can use
87 that option with all supported languages.
89 @cindex cross compiling
90 @cindex specifying machine version
91 @cindex specifying compiler version and target machine
92 @cindex compiler version, specifying
93 @cindex target machine, specifying
94 The usual way to run GCC is to run the executable called @command{gcc}, or
95 @command{@var{machine}-gcc} when cross-compiling, or
96 @command{@var{machine}-gcc-@var{version}} to run a specific version of GCC.
97 When you compile C++ programs, you should invoke GCC as @command{g++} 
98 instead.  @xref{Invoking G++,,Compiling C++ Programs}, 
99 for information about the differences in behavior between @command{gcc} 
100 and @code{g++} when compiling C++ programs.
102 @cindex grouping options
103 @cindex options, grouping
104 The @command{gcc} program accepts options and file names as operands.  Many
105 options have multi-letter names; therefore multiple single-letter options
106 may @emph{not} be grouped: @option{-dv} is very different from @w{@samp{-d
107 -v}}.
109 @cindex order of options
110 @cindex options, order
111 You can mix options and other arguments.  For the most part, the order
112 you use doesn't matter.  Order does matter when you use several
113 options of the same kind; for example, if you specify @option{-L} more
114 than once, the directories are searched in the order specified.  Also,
115 the placement of the @option{-l} option is significant.
117 Many options have long names starting with @samp{-f} or with
118 @samp{-W}---for example,
119 @option{-fmove-loop-invariants}, @option{-Wformat} and so on.  Most of
120 these have both positive and negative forms; the negative form of
121 @option{-ffoo} is @option{-fno-foo}.  This manual documents
122 only one of these two forms, whichever one is not the default.
124 @c man end
126 @xref{Option Index}, for an index to GCC's options.
128 @menu
129 * Option Summary::      Brief list of all options, without explanations.
130 * Overall Options::     Controlling the kind of output:
131                         an executable, object files, assembler files,
132                         or preprocessed source.
133 * Invoking G++::        Compiling C++ programs.
134 * C Dialect Options::   Controlling the variant of C language compiled.
135 * C++ Dialect Options:: Variations on C++.
136 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
137                         and Objective-C++.
138 * Diagnostic Message Formatting Options:: Controlling how diagnostics should
139                         be formatted.
140 * Warning Options::     How picky should the compiler be?
141 * Debugging Options::   Producing debuggable code.
142 * Optimize Options::    How much optimization?
143 * Instrumentation Options:: Enabling profiling and extra run-time error checking.
144 * Preprocessor Options:: Controlling header files and macro definitions.
145                          Also, getting dependency information for Make.
146 * Assembler Options::   Passing options to the assembler.
147 * Link Options::        Specifying libraries and so on.
148 * Directory Options::   Where to find header files and libraries.
149                         Where to find the compiler executable files.
150 * Code Gen Options::    Specifying conventions for function calls, data layout
151                         and register usage.
152 * Developer Options::   Printing GCC configuration info, statistics, and
153                         debugging dumps.
154 * Submodel Options::    Target-specific options, such as compiling for a
155                         specific processor variant.
156 * Spec Files::          How to pass switches to sub-processes.
157 * Environment Variables:: Env vars that affect GCC.
158 * Precompiled Headers:: Compiling a header once, and using it many times.
159 @end menu
161 @c man begin OPTIONS
163 @node Option Summary
164 @section Option Summary
166 Here is a summary of all the options, grouped by type.  Explanations are
167 in the following sections.
169 @table @emph
170 @item Overall Options
171 @xref{Overall Options,,Options Controlling the Kind of Output}.
172 @gccoptlist{-c  -S  -E  -o @var{file}  -x @var{language}  @gol
173 -v  -###  --help@r{[}=@var{class}@r{[},@dots{}@r{]]}  --target-help  --version @gol
174 -pass-exit-codes  -pipe  -specs=@var{file}  -wrapper  @gol
175 @@@var{file}  -fplugin=@var{file}  -fplugin-arg-@var{name}=@var{arg}  @gol
176 -fdump-ada-spec@r{[}-slim@r{]}  -fada-spec-parent=@var{unit}  -fdump-go-spec=@var{file}}
178 @item C Language Options
179 @xref{C Dialect Options,,Options Controlling C Dialect}.
180 @gccoptlist{-ansi  -std=@var{standard}  -fgnu89-inline @gol
181 -fpermitted-flt-eval-methods=@var{standard} @gol
182 -aux-info @var{filename}  -fallow-parameterless-variadic-functions @gol
183 -fno-asm  -fno-builtin  -fno-builtin-@var{function}  -fgimple@gol
184 -fhosted  -ffreestanding  -fopenacc  -fopenmp  -fopenmp-simd @gol
185 -fms-extensions  -fplan9-extensions  -fsso-struct=@var{endianness} @gol
186 -fallow-single-precision  -fcond-mismatch  -flax-vector-conversions @gol
187 -fsigned-bitfields  -fsigned-char @gol
188 -funsigned-bitfields  -funsigned-char}
190 @item C++ Language Options
191 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
192 @gccoptlist{-fabi-version=@var{n}  -fno-access-control @gol
193 -faligned-new=@var{n}  -fargs-in-order=@var{n}  -fcheck-new @gol
194 -fconstexpr-depth=@var{n}  -fconstexpr-loop-limit=@var{n} @gol
195 -ffriend-injection @gol
196 -fno-elide-constructors @gol
197 -fno-enforce-eh-specs @gol
198 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
199 -fno-implicit-templates @gol
200 -fno-implicit-inline-templates @gol
201 -fno-implement-inlines  -fms-extensions @gol
202 -fnew-inheriting-ctors @gol
203 -fnew-ttp-matching @gol
204 -fno-nonansi-builtins  -fnothrow-opt  -fno-operator-names @gol
205 -fno-optional-diags  -fpermissive @gol
206 -fno-pretty-templates @gol
207 -frepo  -fno-rtti  -fsized-deallocation @gol
208 -ftemplate-backtrace-limit=@var{n} @gol
209 -ftemplate-depth=@var{n} @gol
210 -fno-threadsafe-statics  -fuse-cxa-atexit @gol
211 -fno-weak  -nostdinc++ @gol
212 -fvisibility-inlines-hidden @gol
213 -fvisibility-ms-compat @gol
214 -fext-numeric-literals @gol
215 -Wabi=@var{n}  -Wabi-tag  -Wconversion-null  -Wctor-dtor-privacy @gol
216 -Wdelete-non-virtual-dtor  -Wliteral-suffix  -Wmultiple-inheritance @gol
217 -Wnamespaces  -Wnarrowing @gol
218 -Wnoexcept  -Wnoexcept-type  -Wclass-memaccess @gol
219 -Wnon-virtual-dtor  -Wreorder  -Wregister @gol
220 -Weffc++  -Wstrict-null-sentinel  -Wtemplates @gol
221 -Wno-non-template-friend  -Wold-style-cast @gol
222 -Woverloaded-virtual  -Wno-pmf-conversions @gol
223 -Wsign-promo  -Wvirtual-inheritance}
225 @item Objective-C and Objective-C++ Language Options
226 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
227 Objective-C and Objective-C++ Dialects}.
228 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
229 -fgnu-runtime  -fnext-runtime @gol
230 -fno-nil-receivers @gol
231 -fobjc-abi-version=@var{n} @gol
232 -fobjc-call-cxx-cdtors @gol
233 -fobjc-direct-dispatch @gol
234 -fobjc-exceptions @gol
235 -fobjc-gc @gol
236 -fobjc-nilcheck @gol
237 -fobjc-std=objc1 @gol
238 -fno-local-ivars @gol
239 -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]} @gol
240 -freplace-objc-classes @gol
241 -fzero-link @gol
242 -gen-decls @gol
243 -Wassign-intercept @gol
244 -Wno-protocol  -Wselector @gol
245 -Wstrict-selector-match @gol
246 -Wundeclared-selector}
248 @item Diagnostic Message Formatting Options
249 @xref{Diagnostic Message Formatting Options,,Options to Control Diagnostic Messages Formatting}.
250 @gccoptlist{-fmessage-length=@var{n}  @gol
251 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
252 -fdiagnostics-color=@r{[}auto@r{|}never@r{|}always@r{]}  @gol
253 -fno-diagnostics-show-option  -fno-diagnostics-show-caret @gol
254 -fdiagnostics-parseable-fixits  -fdiagnostics-generate-patch @gol
255 -fdiagnostics-show-template-tree -fno-elide-type @gol
256 -fno-show-column}
258 @item Warning Options
259 @xref{Warning Options,,Options to Request or Suppress Warnings}.
260 @gccoptlist{-fsyntax-only  -fmax-errors=@var{n}  -Wpedantic @gol
261 -pedantic-errors @gol
262 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  @gol
263 -Walloc-zero  -Walloc-size-larger-than=@var{n}
264 -Walloca  -Walloca-larger-than=@var{n} @gol
265 -Wno-aggressive-loop-optimizations  -Warray-bounds  -Warray-bounds=@var{n} @gol
266 -Wno-attributes  -Wbool-compare  -Wbool-operation @gol
267 -Wno-builtin-declaration-mismatch @gol
268 -Wno-builtin-macro-redefined  -Wc90-c99-compat  -Wc99-c11-compat @gol
269 -Wc++-compat  -Wc++11-compat  -Wc++14-compat  -Wcast-align  -Wcast-qual  @gol
270 -Wchar-subscripts  -Wchkp  -Wcatch-value  -Wcatch-value=@var{n} @gol
271 -Wclobbered  -Wcomment  -Wconditionally-supported @gol
272 -Wconversion  -Wcoverage-mismatch  -Wno-cpp  -Wdangling-else  -Wdate-time @gol
273 -Wdelete-incomplete @gol
274 -Wno-deprecated  -Wno-deprecated-declarations  -Wno-designated-init @gol
275 -Wdisabled-optimization @gol
276 -Wno-discarded-qualifiers  -Wno-discarded-array-qualifiers @gol
277 -Wno-div-by-zero  -Wdouble-promotion @gol
278 -Wduplicated-branches  -Wduplicated-cond @gol
279 -Wempty-body  -Wenum-compare  -Wno-endif-labels  -Wexpansion-to-defined @gol
280 -Werror  -Werror=*  -Wextra-semi  -Wfatal-errors @gol
281 -Wfloat-equal  -Wformat  -Wformat=2 @gol
282 -Wno-format-contains-nul  -Wno-format-extra-args  @gol
283 -Wformat-nonliteral -Wformat-overflow=@var{n} @gol
284 -Wformat-security  -Wformat-signedness  -Wformat-truncation=@var{n} @gol
285 -Wformat-y2k  -Wframe-address @gol
286 -Wframe-larger-than=@var{len}  -Wno-free-nonheap-object  -Wjump-misses-init @gol
287 -Wignored-qualifiers  -Wignored-attributes  -Wincompatible-pointer-types @gol
288 -Wimplicit  -Wimplicit-fallthrough  -Wimplicit-fallthrough=@var{n} @gol
289 -Wimplicit-function-declaration  -Wimplicit-int @gol
290 -Winit-self  -Winline  -Wno-int-conversion  -Wint-in-bool-context @gol
291 -Wno-int-to-pointer-cast  -Winvalid-memory-model  -Wno-invalid-offsetof @gol
292 -Winvalid-pch  -Wlarger-than=@var{len} @gol
293 -Wlogical-op  -Wlogical-not-parentheses  -Wlong-long @gol
294 -Wmain  -Wmaybe-uninitialized  -Wmemset-elt-size  -Wmemset-transposed-args @gol
295 -Wmisleading-indentation  -Wmissing-braces @gol
296 -Wmissing-field-initializers  -Wmissing-include-dirs @gol
297 -Wno-multichar  -Wmultistatement-macros  -Wnonnull  -Wnonnull-compare @gol
298 -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]} @gol
299 -Wnull-dereference  -Wodr  -Wno-overflow  -Wopenmp-simd  @gol
300 -Woverride-init-side-effects  -Woverlength-strings @gol
301 -Wpacked  -Wpacked-bitfield-compat  -Wpadded @gol
302 -Wparentheses  -Wno-pedantic-ms-format @gol
303 -Wplacement-new  -Wplacement-new=@var{n} @gol
304 -Wpointer-arith  -Wpointer-compare  -Wno-pointer-to-int-cast @gol
305 -Wno-pragmas  -Wredundant-decls  -Wrestrict  -Wno-return-local-addr @gol
306 -Wreturn-type  -Wsequence-point  -Wshadow  -Wno-shadow-ivar @gol
307 -Wshadow=global,  -Wshadow=local,  -Wshadow=compatible-local @gol
308 -Wshift-overflow  -Wshift-overflow=@var{n} @gol
309 -Wshift-count-negative  -Wshift-count-overflow  -Wshift-negative-value @gol
310 -Wsign-compare  -Wsign-conversion  -Wfloat-conversion @gol
311 -Wno-scalar-storage-order  -Wsizeof-pointer-div @gol
312 -Wsizeof-pointer-memaccess  -Wsizeof-array-argument @gol
313 -Wstack-protector  -Wstack-usage=@var{len}  -Wstrict-aliasing @gol
314 -Wstrict-aliasing=n  -Wstrict-overflow  -Wstrict-overflow=@var{n} @gol
315 -Wstringop-overflow=@var{n} @gol
316 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]} @gol
317 -Wsuggest-final-types @gol  -Wsuggest-final-methods  -Wsuggest-override @gol
318 -Wmissing-format-attribute  -Wsubobject-linkage @gol
319 -Wswitch  -Wswitch-bool  -Wswitch-default  -Wswitch-enum @gol
320 -Wswitch-unreachable  -Wsync-nand @gol
321 -Wsystem-headers  -Wtautological-compare  -Wtrampolines  -Wtrigraphs @gol
322 -Wtype-limits  -Wundef @gol
323 -Wuninitialized  -Wunknown-pragmas  -Wunsafe-loop-optimizations @gol
324 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
325 -Wunused-label  -Wunused-local-typedefs  -Wunused-macros @gol
326 -Wunused-parameter  -Wno-unused-result @gol
327 -Wunused-value  -Wunused-variable @gol
328 -Wunused-const-variable  -Wunused-const-variable=@var{n} @gol
329 -Wunused-but-set-parameter  -Wunused-but-set-variable @gol
330 -Wuseless-cast  -Wvariadic-macros  -Wvector-operation-performance @gol
331 -Wvla  -Wvla-larger-than=@var{n}  -Wvolatile-register-var  -Wwrite-strings @gol
332 -Wzero-as-null-pointer-constant  -Whsa}
334 @item C and Objective-C-only Warning Options
335 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
336 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
337 -Wold-style-declaration  -Wold-style-definition @gol
338 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
339 -Wdeclaration-after-statement  -Wpointer-sign}
341 @item Debugging Options
342 @xref{Debugging Options,,Options for Debugging Your Program}.
343 @gccoptlist{-g  -g@var{level}  -gcoff  -gdwarf  -gdwarf-@var{version} @gol
344 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
345 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
346 -gcolumn-info  -gno-column-info @gol
347 -gvms  -gxcoff  -gxcoff+  -gz@r{[}=@var{type}@r{]} @gol
348 -fdebug-prefix-map=@var{old}=@var{new}  -fdebug-types-section @gol
349 -feliminate-dwarf2-dups  -fno-eliminate-unused-debug-types @gol
350 -femit-struct-debug-baseonly  -femit-struct-debug-reduced @gol
351 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
352 -feliminate-unused-debug-symbols  -femit-class-debug-always @gol
353 -fno-merge-debug-strings  -fno-dwarf2-cfi-asm @gol
354 -fvar-tracking  -fvar-tracking-assignments}
356 @item Optimization Options
357 @xref{Optimize Options,,Options that Control Optimization}.
358 @gccoptlist{-faggressive-loop-optimizations  -falign-functions[=@var{n}] @gol
359 -falign-jumps[=@var{n}] @gol
360 -falign-labels[=@var{n}]  -falign-loops[=@var{n}] @gol
361 -fassociative-math  -fauto-profile  -fauto-profile[=@var{path}] @gol
362 -fauto-inc-dec  -fbranch-probabilities @gol
363 -fbranch-target-load-optimize  -fbranch-target-load-optimize2 @gol
364 -fbtr-bb-exclusive  -fcaller-saves @gol
365 -fcombine-stack-adjustments  -fconserve-stack @gol
366 -fcompare-elim  -fcprop-registers  -fcrossjumping @gol
367 -fcse-follow-jumps  -fcse-skip-blocks  -fcx-fortran-rules @gol
368 -fcx-limited-range @gol
369 -fdata-sections  -fdce  -fdelayed-branch @gol
370 -fdelete-null-pointer-checks  -fdevirtualize  -fdevirtualize-speculatively @gol
371 -fdevirtualize-at-ltrans  -fdse @gol
372 -fearly-inlining  -fipa-sra  -fexpensive-optimizations  -ffat-lto-objects @gol
373 -ffast-math  -ffinite-math-only  -ffloat-store  -fexcess-precision=@var{style} @gol
374 -fforward-propagate  -ffp-contract=@var{style}  -ffunction-sections @gol
375 -fgcse  -fgcse-after-reload  -fgcse-las  -fgcse-lm  -fgraphite-identity @gol
376 -fgcse-sm  -fhoist-adjacent-loads  -fif-conversion @gol
377 -fif-conversion2  -findirect-inlining @gol
378 -finline-functions  -finline-functions-called-once  -finline-limit=@var{n} @gol
379 -finline-small-functions  -fipa-cp  -fipa-cp-clone @gol
380 -fipa-bit-cp -fipa-vrp @gol
381 -fipa-pta  -fipa-profile  -fipa-pure-const  -fipa-reference  -fipa-icf @gol
382 -fira-algorithm=@var{algorithm} @gol
383 -fira-region=@var{region}  -fira-hoist-pressure @gol
384 -fira-loop-pressure  -fno-ira-share-save-slots @gol
385 -fno-ira-share-spill-slots @gol
386 -fisolate-erroneous-paths-dereference  -fisolate-erroneous-paths-attribute @gol
387 -fivopts  -fkeep-inline-functions  -fkeep-static-functions @gol
388 -fkeep-static-consts  -flimit-function-alignment  -flive-range-shrinkage @gol
389 -floop-block  -floop-interchange  -floop-strip-mine @gol
390 -floop-unroll-and-jam  -floop-nest-optimize @gol
391 -floop-parallelize-all  -flra-remat  -flto  -flto-compression-level @gol
392 -flto-partition=@var{alg}  -fmerge-all-constants @gol
393 -fmerge-constants  -fmodulo-sched  -fmodulo-sched-allow-regmoves @gol
394 -fmove-loop-invariants  -fno-branch-count-reg @gol
395 -fno-defer-pop  -fno-fp-int-builtin-inexact  -fno-function-cse @gol
396 -fno-guess-branch-probability  -fno-inline  -fno-math-errno  -fno-peephole @gol
397 -fno-peephole2  -fno-printf-return-value  -fno-sched-interblock @gol
398 -fno-sched-spec  -fno-signed-zeros @gol
399 -fno-toplevel-reorder  -fno-trapping-math  -fno-zero-initialized-in-bss @gol
400 -fomit-frame-pointer  -foptimize-sibling-calls @gol
401 -fpartial-inlining  -fpeel-loops  -fpredictive-commoning @gol
402 -fprefetch-loop-arrays @gol
403 -fprofile-correction @gol
404 -fprofile-use  -fprofile-use=@var{path}  -fprofile-values @gol
405 -fprofile-reorder-functions @gol
406 -freciprocal-math  -free  -frename-registers  -freorder-blocks @gol
407 -freorder-blocks-algorithm=@var{algorithm} @gol
408 -freorder-blocks-and-partition  -freorder-functions @gol
409 -frerun-cse-after-loop  -freschedule-modulo-scheduled-loops @gol
410 -frounding-math  -fsched2-use-superblocks  -fsched-pressure @gol
411 -fsched-spec-load  -fsched-spec-load-dangerous @gol
412 -fsched-stalled-insns-dep[=@var{n}]  -fsched-stalled-insns[=@var{n}] @gol
413 -fsched-group-heuristic  -fsched-critical-path-heuristic @gol
414 -fsched-spec-insn-heuristic  -fsched-rank-heuristic @gol
415 -fsched-last-insn-heuristic  -fsched-dep-count-heuristic @gol
416 -fschedule-fusion @gol
417 -fschedule-insns  -fschedule-insns2  -fsection-anchors @gol
418 -fselective-scheduling  -fselective-scheduling2 @gol
419 -fsel-sched-pipelining  -fsel-sched-pipelining-outer-loops @gol
420 -fsemantic-interposition  -fshrink-wrap  -fshrink-wrap-separate @gol
421 -fsignaling-nans @gol
422 -fsingle-precision-constant  -fsplit-ivs-in-unroller  -fsplit-loops@gol
423 -fsplit-paths @gol
424 -fsplit-wide-types  -fssa-backprop  -fssa-phiopt @gol
425 -fstdarg-opt  -fstore-merging  -fstrict-aliasing @gol
426 -fthread-jumps  -ftracer  -ftree-bit-ccp @gol
427 -ftree-builtin-call-dce  -ftree-ccp  -ftree-ch @gol
428 -ftree-coalesce-vars  -ftree-copy-prop  -ftree-dce  -ftree-dominator-opts @gol
429 -ftree-dse  -ftree-forwprop  -ftree-fre  -fcode-hoisting @gol
430 -ftree-loop-if-convert  -ftree-loop-im @gol
431 -ftree-phiprop  -ftree-loop-distribution  -ftree-loop-distribute-patterns @gol
432 -ftree-loop-ivcanon  -ftree-loop-linear  -ftree-loop-optimize @gol
433 -ftree-loop-vectorize @gol
434 -ftree-parallelize-loops=@var{n}  -ftree-pre  -ftree-partial-pre  -ftree-pta @gol
435 -ftree-reassoc  -ftree-sink  -ftree-slsr  -ftree-sra @gol
436 -ftree-switch-conversion  -ftree-tail-merge @gol
437 -ftree-ter  -ftree-vectorize  -ftree-vrp  -funconstrained-commons @gol
438 -funit-at-a-time  -funroll-all-loops  -funroll-loops @gol
439 -funsafe-math-optimizations  -funswitch-loops @gol
440 -fipa-ra  -fvariable-expansion-in-unroller  -fvect-cost-model  -fvpt @gol
441 -fweb  -fwhole-program  -fwpa  -fuse-linker-plugin @gol
442 --param @var{name}=@var{value}
443 -O  -O0  -O1  -O2  -O3  -Os  -Ofast  -Og}
445 @item Program Instrumentation Options
446 @xref{Instrumentation Options,,Program Instrumentation Options}.
447 @gccoptlist{-p  -pg  -fprofile-arcs  --coverage  -ftest-coverage @gol
448 -fprofile-abs-path @gol
449 -fprofile-dir=@var{path}  -fprofile-generate  -fprofile-generate=@var{path} @gol
450 -fsanitize=@var{style}  -fsanitize-recover  -fsanitize-recover=@var{style} @gol
451 -fasan-shadow-offset=@var{number}  -fsanitize-sections=@var{s1},@var{s2},... @gol
452 -fsanitize-undefined-trap-on-error  -fbounds-check @gol
453 -fcheck-pointer-bounds  -fchkp-check-incomplete-type @gol
454 -fchkp-first-field-has-own-bounds  -fchkp-narrow-bounds @gol
455 -fchkp-narrow-to-innermost-array  -fchkp-optimize @gol
456 -fchkp-use-fast-string-functions  -fchkp-use-nochk-string-functions @gol
457 -fchkp-use-static-bounds  -fchkp-use-static-const-bounds @gol
458 -fchkp-treat-zero-dynamic-size-as-infinite  -fchkp-check-read @gol
459 -fchkp-check-read  -fchkp-check-write  -fchkp-store-bounds @gol
460 -fchkp-instrument-calls  -fchkp-instrument-marked-only @gol
461 -fchkp-use-wrappers  -fchkp-flexible-struct-trailing-arrays@gol
462 -fstack-protector  -fstack-protector-all  -fstack-protector-strong @gol
463 -fstack-protector-explicit  -fstack-check @gol
464 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
465 -fno-stack-limit  -fsplit-stack @gol
466 -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]} @gol
467 -fvtv-counts  -fvtv-debug @gol
468 -finstrument-functions @gol
469 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
470 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}}
472 @item Preprocessor Options
473 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
474 @gccoptlist{-A@var{question}=@var{answer} @gol
475 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
476 -C  -CC  -D@var{macro}@r{[}=@var{defn}@r{]} @gol
477 -dD  -dI  -dM  -dN  -dU @gol
478 -fdebug-cpp  -fdirectives-only  -fdollars-in-identifiers  @gol
479 -fexec-charset=@var{charset}  -fextended-identifiers  @gol
480 -finput-charset=@var{charset}  -fno-canonical-system-headers @gol
481 -fpch-deps  -fpch-preprocess  -fpreprocessed @gol
482 -ftabstop=@var{width}  -ftrack-macro-expansion  @gol
483 -fwide-exec-charset=@var{charset}  -fworking-directory @gol
484 -H  -imacros @var{file}  -include @var{file} @gol
485 -M  -MD  -MF  -MG  -MM  -MMD  -MP  -MQ  -MT @gol
486 -no-integrated-cpp  -P  -pthread  -remap @gol
487 -traditional  -traditional-cpp  -trigraphs @gol
488 -U@var{macro}  -undef  @gol
489 -Wp,@var{option}  -Xpreprocessor @var{option}}
491 @item Assembler Options
492 @xref{Assembler Options,,Passing Options to the Assembler}.
493 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
495 @item Linker Options
496 @xref{Link Options,,Options for Linking}.
497 @gccoptlist{@var{object-file-name}  -fuse-ld=@var{linker}  -l@var{library} @gol
498 -nostartfiles  -nodefaultlibs  -nostdlib  -pie  -pthread  -rdynamic @gol
499 -s  -static  -static-libgcc  -static-libstdc++ @gol
500 -static-libasan  -static-libtsan  -static-liblsan  -static-libubsan @gol
501 -static-libmpx  -static-libmpxwrappers @gol
502 -shared  -shared-libgcc  -symbolic @gol
503 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
504 -u @var{symbol}  -z @var{keyword}}
506 @item Directory Options
507 @xref{Directory Options,,Options for Directory Search}.
508 @gccoptlist{-B@var{prefix}  -I@var{dir}  -I- @gol
509 -idirafter @var{dir} @gol
510 -imacros @var{file}  -imultilib @var{dir} @gol
511 -iplugindir=@var{dir}  -iprefix @var{file} @gol
512 -iquote @var{dir}  -isysroot @var{dir}  -isystem @var{dir} @gol
513 -iwithprefix @var{dir}  -iwithprefixbefore @var{dir}  @gol
514 -L@var{dir}  -no-canonical-prefixes  --no-sysroot-suffix @gol
515 -nostdinc  -nostdinc++  --sysroot=@var{dir}}
517 @item Code Generation Options
518 @xref{Code Gen Options,,Options for Code Generation Conventions}.
519 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
520 -ffixed-@var{reg}  -fexceptions @gol
521 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
522 -fasynchronous-unwind-tables @gol
523 -fno-gnu-unique @gol
524 -finhibit-size-directive  -fno-common  -fno-ident @gol
525 -fpcc-struct-return  -fpic  -fPIC  -fpie  -fPIE  -fno-plt @gol
526 -fno-jump-tables @gol
527 -frecord-gcc-switches @gol
528 -freg-struct-return  -fshort-enums  -fshort-wchar @gol
529 -fverbose-asm  -fpack-struct[=@var{n}]  @gol
530 -fleading-underscore  -ftls-model=@var{model} @gol
531 -fstack-reuse=@var{reuse_level} @gol
532 -ftrampolines  -ftrapv  -fwrapv @gol
533 -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]} @gol
534 -fstrict-volatile-bitfields  -fsync-libcalls}
536 @item Developer Options
537 @xref{Developer Options,,GCC Developer Options}.
538 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
539 -dumpfullversion  -fchecking  -fchecking=@var{n}  -fdbg-cnt-list @gol
540 -fdbg-cnt=@var{counter-value-list} @gol
541 -fdisable-ipa-@var{pass_name} @gol
542 -fdisable-rtl-@var{pass_name} @gol
543 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
544 -fdisable-tree-@var{pass_name} @gol
545 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
546 -fdump-noaddr  -fdump-unnumbered  -fdump-unnumbered-links @gol
547 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
548 -fdump-final-insns@r{[}=@var{file}@r{]}
549 -fdump-ipa-all  -fdump-ipa-cgraph  -fdump-ipa-inline @gol
550 -fdump-lang-all @gol
551 -fdump-lang-@var{switch} @gol
552 -fdump-lang-@var{switch}-@var{options} @gol
553 -fdump-lang-@var{switch}-@var{options}=@var{filename} @gol
554 -fdump-passes @gol
555 -fdump-rtl-@var{pass}  -fdump-rtl-@var{pass}=@var{filename} @gol
556 -fdump-statistics @gol
557 -fdump-tree-all @gol
558 -fdump-tree-@var{switch} @gol
559 -fdump-tree-@var{switch}-@var{options} @gol
560 -fdump-tree-@var{switch}-@var{options}=@var{filename} @gol
561 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
562 -fenable-@var{kind}-@var{pass} @gol
563 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
564 -fira-verbose=@var{n} @gol
565 -flto-report  -flto-report-wpa  -fmem-report-wpa @gol
566 -fmem-report  -fpre-ipa-mem-report  -fpost-ipa-mem-report @gol
567 -fopt-info  -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
568 -fprofile-report @gol
569 -frandom-seed=@var{string}  -fsched-verbose=@var{n} @gol
570 -fsel-sched-verbose  -fsel-sched-dump-cfg  -fsel-sched-pipelining-verbose @gol
571 -fstats  -fstack-usage  -ftime-report  -ftime-report-details @gol
572 -fvar-tracking-assignments-toggle  -gtoggle @gol
573 -print-file-name=@var{library}  -print-libgcc-file-name @gol
574 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
575 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
576 -print-sysroot  -print-sysroot-headers-suffix @gol
577 -save-temps  -save-temps=cwd  -save-temps=obj  -time@r{[}=@var{file}@r{]}}
579 @item Machine-Dependent Options
580 @xref{Submodel Options,,Machine-Dependent Options}.
581 @c This list is ordered alphanumerically by subsection name.
582 @c Try and put the significant identifier (CPU or system) first,
583 @c so users have a clue at guessing where the ones they want will be.
585 @emph{AArch64 Options}
586 @gccoptlist{-mabi=@var{name}  -mbig-endian  -mlittle-endian @gol
587 -mgeneral-regs-only @gol
588 -mcmodel=tiny  -mcmodel=small  -mcmodel=large @gol
589 -mstrict-align @gol
590 -momit-leaf-frame-pointer @gol
591 -mtls-dialect=desc  -mtls-dialect=traditional @gol
592 -mtls-size=@var{size} @gol
593 -mfix-cortex-a53-835769  -mfix-cortex-a53-843419 @gol
594 -mlow-precision-recip-sqrt  -mlow-precision-sqrt  -mlow-precision-div @gol
595 -mpc-relative-literal-loads @gol
596 -msign-return-address=@var{scope} @gol
597 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}  -moverride=@var{string}}
599 @emph{Adapteva Epiphany Options}
600 @gccoptlist{-mhalf-reg-file  -mprefer-short-insn-regs @gol
601 -mbranch-cost=@var{num}  -mcmove  -mnops=@var{num}  -msoft-cmpsf @gol
602 -msplit-lohi  -mpost-inc  -mpost-modify  -mstack-offset=@var{num} @gol
603 -mround-nearest  -mlong-calls  -mshort-calls  -msmall16 @gol
604 -mfp-mode=@var{mode}  -mvect-double  -max-vect-align=@var{num} @gol
605 -msplit-vecmove-early  -m1reg-@var{reg}}
607 @emph{ARC Options}
608 @gccoptlist{-mbarrel-shifter @gol
609 -mcpu=@var{cpu}  -mA6  -mARC600  -mA7  -mARC700 @gol
610 -mdpfp  -mdpfp-compact  -mdpfp-fast  -mno-dpfp-lrsr @gol
611 -mea  -mno-mpy  -mmul32x16  -mmul64  -matomic @gol
612 -mnorm  -mspfp  -mspfp-compact  -mspfp-fast  -msimd  -msoft-float  -mswap @gol
613 -mcrc  -mdsp-packa  -mdvbf  -mlock  -mmac-d16  -mmac-24  -mrtsc  -mswape @gol
614 -mtelephony  -mxy  -misize  -mannotate-align  -marclinux  -marclinux_prof @gol
615 -mlong-calls  -mmedium-calls  -msdata -mirq-ctrl-saved @gol
616 -mrgf-banked-regs @gol
617 -mvolatile-cache  -mtp-regno=@var{regno} @gol
618 -malign-call  -mauto-modify-reg  -mbbit-peephole  -mno-brcc @gol
619 -mcase-vector-pcrel  -mcompact-casesi  -mno-cond-exec  -mearly-cbranchsi @gol
620 -mexpand-adddi  -mindexed-loads  -mlra  -mlra-priority-none @gol
621 -mlra-priority-compact mlra-priority-noncompact  -mno-millicode @gol
622 -mmixed-code  -mq-class  -mRcq  -mRcw  -msize-level=@var{level} @gol
623 -mtune=@var{cpu}  -mmultcost=@var{num} @gol
624 -munalign-prob-threshold=@var{probability}  -mmpy-option=@var{multo} @gol
625 -mdiv-rem  -mcode-density  -mll64  -mfpu=@var{fpu}}
627 @emph{ARM Options}
628 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
629 -mabi=@var{name} @gol
630 -mapcs-stack-check  -mno-apcs-stack-check @gol
631 -mapcs-reentrant  -mno-apcs-reentrant @gol
632 -msched-prolog  -mno-sched-prolog @gol
633 -mlittle-endian  -mbig-endian @gol
634 -mbe8 -mbe32 @gol
635 -mfloat-abi=@var{name} @gol
636 -mfp16-format=@var{name}
637 -mthumb-interwork  -mno-thumb-interwork @gol
638 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
639 -mtune=@var{name}  -mprint-tune-info @gol
640 -mstructure-size-boundary=@var{n} @gol
641 -mabort-on-noreturn @gol
642 -mlong-calls  -mno-long-calls @gol
643 -msingle-pic-base  -mno-single-pic-base @gol
644 -mpic-register=@var{reg} @gol
645 -mnop-fun-dllimport @gol
646 -mpoke-function-name @gol
647 -mthumb  -marm @gol
648 -mtpcs-frame  -mtpcs-leaf-frame @gol
649 -mcaller-super-interworking  -mcallee-super-interworking @gol
650 -mtp=@var{name}  -mtls-dialect=@var{dialect} @gol
651 -mword-relocations @gol
652 -mfix-cortex-m3-ldrd @gol
653 -munaligned-access @gol
654 -mneon-for-64bits @gol
655 -mslow-flash-data @gol
656 -masm-syntax-unified @gol
657 -mrestrict-it @gol
658 -mpure-code @gol
659 -mcmse}
661 @emph{AVR Options}
662 @gccoptlist{-mmcu=@var{mcu}  -mabsdata  -maccumulate-args @gol
663 -mbranch-cost=@var{cost} @gol
664 -mcall-prologues  -mgas-isr-prologues  -mint8 @gol
665 -mn_flash=@var{size}  -mno-interrupts @gol
666 -mrelax  -mrmw  -mstrict-X  -mtiny-stack  -mfract-convert-truncate @gol
667 -mshort-calls  -nodevicelib @gol
668 -Waddr-space-convert  -Wmisspelled-isr}
670 @emph{Blackfin Options}
671 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
672 -msim  -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
673 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
674 -mlow-64k  -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
675 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
676 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
677 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
678 -mfast-fp  -minline-plt  -mmulticore  -mcorea  -mcoreb  -msdram @gol
679 -micplb}
681 @emph{C6X Options}
682 @gccoptlist{-mbig-endian  -mlittle-endian  -march=@var{cpu} @gol
683 -msim  -msdata=@var{sdata-type}}
685 @emph{CRIS Options}
686 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
687 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
688 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
689 -mstack-align  -mdata-align  -mconst-align @gol
690 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
691 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
692 -mmul-bug-workaround  -mno-mul-bug-workaround}
694 @emph{CR16 Options}
695 @gccoptlist{-mmac @gol
696 -mcr16cplus  -mcr16c @gol
697 -msim  -mint32  -mbit-ops
698 -mdata-model=@var{model}}
700 @emph{Darwin Options}
701 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
702 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
703 -client_name  -compatibility_version  -current_version @gol
704 -dead_strip @gol
705 -dependency-file  -dylib_file  -dylinker_install_name @gol
706 -dynamic  -dynamiclib  -exported_symbols_list @gol
707 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
708 -force_flat_namespace  -headerpad_max_install_names @gol
709 -iframework @gol
710 -image_base  -init  -install_name  -keep_private_externs @gol
711 -multi_module  -multiply_defined  -multiply_defined_unused @gol
712 -noall_load   -no_dead_strip_inits_and_terms @gol
713 -nofixprebinding  -nomultidefs  -noprebind  -noseglinkedit @gol
714 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
715 -private_bundle  -read_only_relocs  -sectalign @gol
716 -sectobjectsymbols  -whyload  -seg1addr @gol
717 -sectcreate  -sectobjectsymbols  -sectorder @gol
718 -segaddr  -segs_read_only_addr  -segs_read_write_addr @gol
719 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
720 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
721 -single_module  -static  -sub_library  -sub_umbrella @gol
722 -twolevel_namespace  -umbrella  -undefined @gol
723 -unexported_symbols_list  -weak_reference_mismatches @gol
724 -whatsloaded  -F  -gused  -gfull  -mmacosx-version-min=@var{version} @gol
725 -mkernel  -mone-byte-bool}
727 @emph{DEC Alpha Options}
728 @gccoptlist{-mno-fp-regs  -msoft-float @gol
729 -mieee  -mieee-with-inexact  -mieee-conformant @gol
730 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
731 -mtrap-precision=@var{mode}  -mbuild-constants @gol
732 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
733 -mbwx  -mmax  -mfix  -mcix @gol
734 -mfloat-vax  -mfloat-ieee @gol
735 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
736 -msmall-text  -mlarge-text @gol
737 -mmemory-latency=@var{time}}
739 @emph{FR30 Options}
740 @gccoptlist{-msmall-model  -mno-lsim}
742 @emph{FT32 Options}
743 @gccoptlist{-msim  -mlra  -mnodiv}
745 @emph{FRV Options}
746 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
747 -mhard-float  -msoft-float @gol
748 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
749 -mdouble  -mno-double @gol
750 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
751 -mfdpic  -minline-plt  -mgprel-ro  -multilib-library-pic @gol
752 -mlinked-fp  -mlong-calls  -malign-labels @gol
753 -mlibrary-pic  -macc-4  -macc-8 @gol
754 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
755 -moptimize-membar  -mno-optimize-membar @gol
756 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
757 -mvliw-branch  -mno-vliw-branch @gol
758 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
759 -mno-nested-cond-exec  -mtomcat-stats @gol
760 -mTLS  -mtls @gol
761 -mcpu=@var{cpu}}
763 @emph{GNU/Linux Options}
764 @gccoptlist{-mglibc  -muclibc  -mmusl  -mbionic  -mandroid @gol
765 -tno-android-cc  -tno-android-ld}
767 @emph{H8/300 Options}
768 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr  -mno-exr  -mint32  -malign-300}
770 @emph{HPPA Options}
771 @gccoptlist{-march=@var{architecture-type} @gol
772 -mcaller-copies  -mdisable-fpregs  -mdisable-indexing @gol
773 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
774 -mfixed-range=@var{register-range} @gol
775 -mjump-in-delay  -mlinker-opt  -mlong-calls @gol
776 -mlong-load-store  -mno-disable-fpregs @gol
777 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
778 -mno-jump-in-delay  -mno-long-load-store @gol
779 -mno-portable-runtime  -mno-soft-float @gol
780 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
781 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
782 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
783 -munix=@var{unix-std}  -nolibdld  -static  -threads}
785 @emph{IA-64 Options}
786 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
787 -mvolatile-asm-stop  -mregister-names  -msdata  -mno-sdata @gol
788 -mconstant-gp  -mauto-pic  -mfused-madd @gol
789 -minline-float-divide-min-latency @gol
790 -minline-float-divide-max-throughput @gol
791 -mno-inline-float-divide @gol
792 -minline-int-divide-min-latency @gol
793 -minline-int-divide-max-throughput  @gol
794 -mno-inline-int-divide @gol
795 -minline-sqrt-min-latency  -minline-sqrt-max-throughput @gol
796 -mno-inline-sqrt @gol
797 -mdwarf2-asm  -mearly-stop-bits @gol
798 -mfixed-range=@var{register-range}  -mtls-size=@var{tls-size} @gol
799 -mtune=@var{cpu-type}  -milp32  -mlp64 @gol
800 -msched-br-data-spec  -msched-ar-data-spec  -msched-control-spec @gol
801 -msched-br-in-data-spec  -msched-ar-in-data-spec  -msched-in-control-spec @gol
802 -msched-spec-ldc  -msched-spec-control-ldc @gol
803 -msched-prefer-non-data-spec-insns  -msched-prefer-non-control-spec-insns @gol
804 -msched-stop-bits-after-every-cycle  -msched-count-spec-in-critical-path @gol
805 -msel-sched-dont-check-control-spec  -msched-fp-mem-deps-zero-cost @gol
806 -msched-max-memory-insns-hard-limit  -msched-max-memory-insns=@var{max-insns}}
808 @emph{LM32 Options}
809 @gccoptlist{-mbarrel-shift-enabled  -mdivide-enabled  -mmultiply-enabled @gol
810 -msign-extend-enabled  -muser-enabled}
812 @emph{M32R/D Options}
813 @gccoptlist{-m32r2  -m32rx  -m32r @gol
814 -mdebug @gol
815 -malign-loops  -mno-align-loops @gol
816 -missue-rate=@var{number} @gol
817 -mbranch-cost=@var{number} @gol
818 -mmodel=@var{code-size-model-type} @gol
819 -msdata=@var{sdata-type} @gol
820 -mno-flush-func  -mflush-func=@var{name} @gol
821 -mno-flush-trap  -mflush-trap=@var{number} @gol
822 -G @var{num}}
824 @emph{M32C Options}
825 @gccoptlist{-mcpu=@var{cpu}  -msim  -memregs=@var{number}}
827 @emph{M680x0 Options}
828 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune} @gol
829 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
830 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
831 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
832 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
833 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
834 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
835 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
836 -mxgot  -mno-xgot  -mlong-jump-table-offsets}
838 @emph{MCore Options}
839 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
840 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
841 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
842 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
843 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
845 @emph{MeP Options}
846 @gccoptlist{-mabsdiff  -mall-opts  -maverage  -mbased=@var{n}  -mbitops @gol
847 -mc=@var{n}  -mclip  -mconfig=@var{name}  -mcop  -mcop32  -mcop64  -mivc2 @gol
848 -mdc  -mdiv  -meb  -mel  -mio-volatile  -ml  -mleadz  -mm  -mminmax @gol
849 -mmult  -mno-opts  -mrepeat  -ms  -msatur  -msdram  -msim  -msimnovec  -mtf @gol
850 -mtiny=@var{n}}
852 @emph{MicroBlaze Options}
853 @gccoptlist{-msoft-float  -mhard-float  -msmall-divides  -mcpu=@var{cpu} @gol
854 -mmemcpy  -mxl-soft-mul  -mxl-soft-div  -mxl-barrel-shift @gol
855 -mxl-pattern-compare  -mxl-stack-check  -mxl-gp-opt  -mno-clearbss @gol
856 -mxl-multiply-high  -mxl-float-convert  -mxl-float-sqrt @gol
857 -mbig-endian  -mlittle-endian  -mxl-reorder  -mxl-mode-@var{app-model}}
859 @emph{MIPS Options}
860 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
861 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips32r3  -mips32r5 @gol
862 -mips32r6  -mips64  -mips64r2  -mips64r3  -mips64r5  -mips64r6 @gol
863 -mips16  -mno-mips16  -mflip-mips16 @gol
864 -minterlink-compressed  -mno-interlink-compressed @gol
865 -minterlink-mips16  -mno-interlink-mips16 @gol
866 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
867 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
868 -mgp32  -mgp64  -mfp32  -mfpxx  -mfp64  -mhard-float  -msoft-float @gol
869 -mno-float  -msingle-float  -mdouble-float @gol
870 -modd-spreg  -mno-odd-spreg @gol
871 -mabs=@var{mode}  -mnan=@var{encoding} @gol
872 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
873 -mmcu  -mmno-mcu @gol
874 -meva  -mno-eva @gol
875 -mvirt  -mno-virt @gol
876 -mxpa  -mno-xpa @gol
877 -mmicromips  -mno-micromips @gol
878 -mmsa  -mno-msa @gol
879 -mfpu=@var{fpu-type} @gol
880 -msmartmips  -mno-smartmips @gol
881 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
882 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
883 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
884 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
885 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
886 -membedded-data  -mno-embedded-data @gol
887 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
888 -mcode-readable=@var{setting} @gol
889 -msplit-addresses  -mno-split-addresses @gol
890 -mexplicit-relocs  -mno-explicit-relocs @gol
891 -mcheck-zero-division  -mno-check-zero-division @gol
892 -mdivide-traps  -mdivide-breaks @gol
893 -mload-store-pairs  -mno-load-store-pairs @gol
894 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
895 -mmad  -mno-mad  -mimadd  -mno-imadd  -mfused-madd  -mno-fused-madd  -nocpp @gol
896 -mfix-24k  -mno-fix-24k @gol
897 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
898 -mfix-r10000  -mno-fix-r10000  -mfix-rm7000  -mno-fix-rm7000 @gol
899 -mfix-vr4120  -mno-fix-vr4120 @gol
900 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
901 -mflush-func=@var{func}  -mno-flush-func @gol
902 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
903 -mcompact-branches=@var{policy} @gol
904 -mfp-exceptions  -mno-fp-exceptions @gol
905 -mvr4130-align  -mno-vr4130-align  -msynci  -mno-synci @gol
906 -mlxc1-sxc1 -mno-lxc1-sxc1 -mmadd4 -mno-madd4 @gol
907 -mrelax-pic-calls  -mno-relax-pic-calls  -mmcount-ra-address @gol
908 -mframe-header-opt  -mno-frame-header-opt}
910 @emph{MMIX Options}
911 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
912 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
913 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
914 -mno-base-addresses  -msingle-exit  -mno-single-exit}
916 @emph{MN10300 Options}
917 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
918 -mno-am33  -mam33  -mam33-2  -mam34 @gol
919 -mtune=@var{cpu-type} @gol
920 -mreturn-pointer-on-d0 @gol
921 -mno-crt0  -mrelax  -mliw  -msetlb}
923 @emph{Moxie Options}
924 @gccoptlist{-meb  -mel  -mmul.x  -mno-crt0}
926 @emph{MSP430 Options}
927 @gccoptlist{-msim  -masm-hex  -mmcu=  -mcpu=  -mlarge  -msmall  -mrelax @gol
928 -mwarn-mcu @gol
929 -mcode-region=  -mdata-region= @gol
930 -msilicon-errata=  -msilicon-errata-warn= @gol
931 -mhwmult=  -minrt}
933 @emph{NDS32 Options}
934 @gccoptlist{-mbig-endian  -mlittle-endian @gol
935 -mreduced-regs  -mfull-regs @gol
936 -mcmov  -mno-cmov @gol
937 -mperf-ext  -mno-perf-ext @gol
938 -mv3push  -mno-v3push @gol
939 -m16bit  -mno-16bit @gol
940 -misr-vector-size=@var{num} @gol
941 -mcache-block-size=@var{num} @gol
942 -march=@var{arch} @gol
943 -mcmodel=@var{code-model} @gol
944 -mctor-dtor  -mrelax}
946 @emph{Nios II Options}
947 @gccoptlist{-G @var{num}  -mgpopt=@var{option}  -mgpopt  -mno-gpopt @gol
948 -mel  -meb @gol
949 -mno-bypass-cache  -mbypass-cache @gol
950 -mno-cache-volatile  -mcache-volatile @gol
951 -mno-fast-sw-div  -mfast-sw-div @gol
952 -mhw-mul  -mno-hw-mul  -mhw-mulx  -mno-hw-mulx  -mno-hw-div  -mhw-div @gol
953 -mcustom-@var{insn}=@var{N}  -mno-custom-@var{insn} @gol
954 -mcustom-fpu-cfg=@var{name} @gol
955 -mhal  -msmallc  -msys-crt0=@var{name}  -msys-lib=@var{name} @gol
956 -march=@var{arch}  -mbmx  -mno-bmx  -mcdx  -mno-cdx}
958 @emph{Nvidia PTX Options}
959 @gccoptlist{-m32  -m64  -mmainkernel  -moptimize}
961 @emph{PDP-11 Options}
962 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
963 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
964 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
965 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
966 -mbranch-expensive  -mbranch-cheap @gol
967 -munix-asm  -mdec-asm}
969 @emph{picoChip Options}
970 @gccoptlist{-mae=@var{ae_type}  -mvliw-lookahead=@var{N} @gol
971 -msymbol-as-address  -mno-inefficient-warnings}
973 @emph{PowerPC Options}
974 See RS/6000 and PowerPC Options.
976 @emph{RISC-V Options}
977 @gccoptlist{-mbranch-cost=@var{N-instruction} @gol
978 -mmemcpy  -mno-memcpy @gol
979 -mplt  -mno-plt @gol
980 -mabi=@var{ABI-string} @gol
981 -mfdiv  -mno-fdiv @gol
982 -mdiv  -mno-div @gol
983 -march=@var{ISA-string} @gol
984 -mtune=@var{processor-string} @gol
985 -msmall-data-limit=@var{N-bytes} @gol
986 -msave-restore  -mno-save-restore @gol
987 -mstrict-align -mno-strict-align @gol
988 -mcmodel=@var{code-model} @gol
989 -mexplicit-relocs  -mno-explicit-relocs @gol}
991 @emph{RL78 Options}
992 @gccoptlist{-msim  -mmul=none  -mmul=g13  -mmul=g14  -mallregs @gol
993 -mcpu=g10  -mcpu=g13  -mcpu=g14  -mg10  -mg13  -mg14 @gol
994 -m64bit-doubles  -m32bit-doubles  -msave-mduc-in-interrupts}
996 @emph{RS/6000 and PowerPC Options}
997 @gccoptlist{-mcpu=@var{cpu-type} @gol
998 -mtune=@var{cpu-type} @gol
999 -mcmodel=@var{code-model} @gol
1000 -mpowerpc64 @gol
1001 -maltivec  -mno-altivec @gol
1002 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
1003 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
1004 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mpopcntd  -mno-popcntd @gol
1005 -mfprnd  -mno-fprnd @gol
1006 -mcmpb  -mno-cmpb  -mmfpgpr  -mno-mfpgpr  -mhard-dfp  -mno-hard-dfp @gol
1007 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
1008 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
1009 -malign-power  -malign-natural @gol
1010 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
1011 -msingle-float  -mdouble-float  -msimple-fpu @gol
1012 -mstring  -mno-string  -mupdate  -mno-update @gol
1013 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
1014 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
1015 -mstrict-align  -mno-strict-align  -mrelocatable @gol
1016 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
1017 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
1018 -mdynamic-no-pic  -maltivec  -mswdiv  -msingle-pic-base @gol
1019 -mprioritize-restricted-insns=@var{priority} @gol
1020 -msched-costly-dep=@var{dependence_type} @gol
1021 -minsert-sched-nops=@var{scheme} @gol
1022 -mcall-sysv  -mcall-netbsd @gol
1023 -maix-struct-return  -msvr4-struct-return @gol
1024 -mabi=@var{abi-type}  -msecure-plt  -mbss-plt @gol
1025 -mblock-move-inline-limit=@var{num} @gol
1026 -misel  -mno-isel @gol
1027 -misel=yes  -misel=no @gol
1028 -mspe  -mno-spe @gol
1029 -mspe=yes  -mspe=no @gol
1030 -mpaired @gol
1031 -mvrsave  -mno-vrsave @gol
1032 -mmulhw  -mno-mulhw @gol
1033 -mdlmzb  -mno-dlmzb @gol
1034 -mfloat-gprs=yes  -mfloat-gprs=no  -mfloat-gprs=single  -mfloat-gprs=double @gol
1035 -mprototype  -mno-prototype @gol
1036 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
1037 -msdata=@var{opt}  -mvxworks  -G @var{num} @gol
1038 -mrecip  -mrecip=@var{opt}  -mno-recip  -mrecip-precision @gol
1039 -mno-recip-precision @gol
1040 -mveclibabi=@var{type}  -mfriz  -mno-friz @gol
1041 -mpointers-to-nested-functions  -mno-pointers-to-nested-functions @gol
1042 -msave-toc-indirect  -mno-save-toc-indirect @gol
1043 -mpower8-fusion  -mno-mpower8-fusion  -mpower8-vector  -mno-power8-vector @gol
1044 -mcrypto  -mno-crypto  -mhtm  -mno-htm  -mdirect-move  -mno-direct-move @gol
1045 -mquad-memory  -mno-quad-memory @gol
1046 -mquad-memory-atomic  -mno-quad-memory-atomic @gol
1047 -mcompat-align-parm  -mno-compat-align-parm @gol
1048 -mfloat128  -mno-float128  -mfloat128-hardware  -mno-float128-hardware @gol
1049 -mgnu-attribute  -mno-gnu-attribute @gol
1050 -mstack-protector-guard=@var{guard} -mstack-protector-guard-reg=@var{reg} @gol
1051 -mstack-protector-guard-offset=@var{offset}}
1053 @emph{RX Options}
1054 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
1055 -mcpu=@gol
1056 -mbig-endian-data  -mlittle-endian-data @gol
1057 -msmall-data @gol
1058 -msim  -mno-sim@gol
1059 -mas100-syntax  -mno-as100-syntax@gol
1060 -mrelax@gol
1061 -mmax-constant-size=@gol
1062 -mint-register=@gol
1063 -mpid@gol
1064 -mallow-string-insns  -mno-allow-string-insns@gol
1065 -mjsr@gol
1066 -mno-warn-multiple-fast-interrupts@gol
1067 -msave-acc-in-interrupts}
1069 @emph{S/390 and zSeries Options}
1070 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1071 -mhard-float  -msoft-float  -mhard-dfp  -mno-hard-dfp @gol
1072 -mlong-double-64  -mlong-double-128 @gol
1073 -mbackchain  -mno-backchain  -mpacked-stack  -mno-packed-stack @gol
1074 -msmall-exec  -mno-small-exec  -mmvcle  -mno-mvcle @gol
1075 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
1076 -mhtm  -mvx  -mzvector @gol
1077 -mtpf-trace  -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
1078 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size  -mstack-guard @gol
1079 -mhotpatch=@var{halfwords},@var{halfwords}}
1081 @emph{Score Options}
1082 @gccoptlist{-meb  -mel @gol
1083 -mnhwloop @gol
1084 -muls @gol
1085 -mmac @gol
1086 -mscore5  -mscore5u  -mscore7  -mscore7d}
1088 @emph{SH Options}
1089 @gccoptlist{-m1  -m2  -m2e @gol
1090 -m2a-nofpu  -m2a-single-only  -m2a-single  -m2a @gol
1091 -m3  -m3e @gol
1092 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
1093 -m4a-nofpu  -m4a-single-only  -m4a-single  -m4a  -m4al @gol
1094 -mb  -ml  -mdalign  -mrelax @gol
1095 -mbigtable  -mfmovd  -mrenesas  -mno-renesas  -mnomacsave @gol
1096 -mieee  -mno-ieee  -mbitops  -misize  -minline-ic_invalidate  -mpadstruct @gol
1097 -mprefergot  -musermode  -multcost=@var{number}  -mdiv=@var{strategy} @gol
1098 -mdivsi3_libfunc=@var{name}  -mfixed-range=@var{register-range} @gol
1099 -maccumulate-outgoing-args @gol
1100 -matomic-model=@var{atomic-model} @gol
1101 -mbranch-cost=@var{num}  -mzdcbranch  -mno-zdcbranch @gol
1102 -mcbranch-force-delay-slot @gol
1103 -mfused-madd  -mno-fused-madd  -mfsca  -mno-fsca  -mfsrra  -mno-fsrra @gol
1104 -mpretend-cmove  -mtas}
1106 @emph{Solaris 2 Options}
1107 @gccoptlist{-mclear-hwcap  -mno-clear-hwcap  -mimpure-text  -mno-impure-text @gol
1108 -pthreads}
1110 @emph{SPARC Options}
1111 @gccoptlist{-mcpu=@var{cpu-type} @gol
1112 -mtune=@var{cpu-type} @gol
1113 -mcmodel=@var{code-model} @gol
1114 -mmemory-model=@var{mem-model} @gol
1115 -m32  -m64  -mapp-regs  -mno-app-regs @gol
1116 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
1117 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1118 -mhard-quad-float  -msoft-quad-float @gol
1119 -mstack-bias  -mno-stack-bias @gol
1120 -mstd-struct-return  -mno-std-struct-return @gol
1121 -munaligned-doubles  -mno-unaligned-doubles @gol
1122 -muser-mode  -mno-user-mode @gol
1123 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
1124 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
1125 -mvis4 -mno-vis4 -mvis4b -mno-vis4b @gol
1126 -mcbcond  -mno-cbcond  -mfmaf  -mno-fmaf  -mfsmuld  -mno-fsmuld  @gol
1127 -mpopc  -mno-popc  -msubxc  -mno-subxc @gol
1128 -mfix-at697f  -mfix-ut699  -mfix-ut700  -mfix-gr712rc @gol
1129 -mlra  -mno-lra}
1131 @emph{SPU Options}
1132 @gccoptlist{-mwarn-reloc  -merror-reloc @gol
1133 -msafe-dma  -munsafe-dma @gol
1134 -mbranch-hints @gol
1135 -msmall-mem  -mlarge-mem  -mstdmain @gol
1136 -mfixed-range=@var{register-range} @gol
1137 -mea32  -mea64 @gol
1138 -maddress-space-conversion  -mno-address-space-conversion @gol
1139 -mcache-size=@var{cache-size} @gol
1140 -matomic-updates  -mno-atomic-updates}
1142 @emph{System V Options}
1143 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
1145 @emph{TILE-Gx Options}
1146 @gccoptlist{-mcpu=CPU  -m32  -m64  -mbig-endian  -mlittle-endian @gol
1147 -mcmodel=@var{code-model}}
1149 @emph{TILEPro Options}
1150 @gccoptlist{-mcpu=@var{cpu}  -m32}
1152 @emph{V850 Options}
1153 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
1154 -mprolog-function  -mno-prolog-function  -mspace @gol
1155 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
1156 -mapp-regs  -mno-app-regs @gol
1157 -mdisable-callt  -mno-disable-callt @gol
1158 -mv850e2v3  -mv850e2  -mv850e1  -mv850es @gol
1159 -mv850e  -mv850  -mv850e3v5 @gol
1160 -mloop @gol
1161 -mrelax @gol
1162 -mlong-jumps @gol
1163 -msoft-float @gol
1164 -mhard-float @gol
1165 -mgcc-abi @gol
1166 -mrh850-abi @gol
1167 -mbig-switch}
1169 @emph{VAX Options}
1170 @gccoptlist{-mg  -mgnu  -munix}
1172 @emph{Visium Options}
1173 @gccoptlist{-mdebug  -msim  -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1174 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type}  -msv-mode  -muser-mode}
1176 @emph{VMS Options}
1177 @gccoptlist{-mvms-return-codes  -mdebug-main=@var{prefix}  -mmalloc64 @gol
1178 -mpointer-size=@var{size}}
1180 @emph{VxWorks Options}
1181 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1182 -Xbind-lazy  -Xbind-now}
1184 @emph{x86 Options}
1185 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1186 -mtune-ctrl=@var{feature-list}  -mdump-tune-features  -mno-default @gol
1187 -mfpmath=@var{unit} @gol
1188 -masm=@var{dialect}  -mno-fancy-math-387 @gol
1189 -mno-fp-ret-in-387  -m80387  -mhard-float  -msoft-float @gol
1190 -mno-wide-multiply  -mrtd  -malign-double @gol
1191 -mpreferred-stack-boundary=@var{num} @gol
1192 -mincoming-stack-boundary=@var{num} @gol
1193 -mcld  -mcx16  -msahf  -mmovbe  -mcrc32 @gol
1194 -mrecip  -mrecip=@var{opt} @gol
1195 -mvzeroupper  -mprefer-avx128 @gol
1196 -mmmx  -msse  -msse2  -msse3  -mssse3  -msse4.1  -msse4.2  -msse4  -mavx @gol
1197 -mavx2  -mavx512f  -mavx512pf  -mavx512er  -mavx512cd  -mavx512vl @gol
1198 -mavx512bw  -mavx512dq  -mavx512ifma  -mavx512vbmi  -msha  -maes @gol
1199 -mpclmul  -mfsgsbase  -mrdrnd  -mf16c  -mfma @gol
1200 -mprefetchwt1  -mclflushopt  -mxsavec  -mxsaves @gol
1201 -msse4a  -m3dnow  -m3dnowa  -mpopcnt  -mabm  -mbmi  -mtbm  -mfma4  -mxop @gol
1202 -mlzcnt  -mbmi2  -mfxsr  -mxsave  -mxsaveopt  -mrtm  -mlwp  -mmpx  @gol
1203 -mmwaitx  -mclzero  -mpku  -mthreads @gol
1204 -mms-bitfields  -mno-align-stringops  -minline-all-stringops @gol
1205 -minline-stringops-dynamically  -mstringop-strategy=@var{alg} @gol
1206 -mmemcpy-strategy=@var{strategy}  -mmemset-strategy=@var{strategy} @gol
1207 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
1208 -m96bit-long-double  -mlong-double-64  -mlong-double-80  -mlong-double-128 @gol
1209 -mregparm=@var{num}  -msseregparm @gol
1210 -mveclibabi=@var{type}  -mvect8-ret-in-mem @gol
1211 -mpc32  -mpc64  -mpc80  -mstackrealign @gol
1212 -momit-leaf-frame-pointer  -mno-red-zone  -mno-tls-direct-seg-refs @gol
1213 -mcmodel=@var{code-model}  -mabi=@var{name}  -maddress-mode=@var{mode} @gol
1214 -m32  -m64  -mx32  -m16  -miamcu  -mlarge-data-threshold=@var{num} @gol
1215 -msse2avx  -mfentry  -mrecord-mcount  -mnop-mcount  -m8bit-idiv @gol
1216 -mavx256-split-unaligned-load  -mavx256-split-unaligned-store @gol
1217 -malign-data=@var{type}  -mstack-protector-guard=@var{guard} @gol
1218 -mmitigate-rop  -mgeneral-regs-only  -mcall-ms2sysv-xlogues}
1220 @emph{x86 Windows Options}
1221 @gccoptlist{-mconsole  -mcygwin  -mno-cygwin  -mdll @gol
1222 -mnop-fun-dllimport  -mthread @gol
1223 -municode  -mwin32  -mwindows  -fno-set-stack-executable}
1225 @emph{Xstormy16 Options}
1226 @gccoptlist{-msim}
1228 @emph{Xtensa Options}
1229 @gccoptlist{-mconst16  -mno-const16 @gol
1230 -mfused-madd  -mno-fused-madd @gol
1231 -mforce-no-pic @gol
1232 -mserialize-volatile  -mno-serialize-volatile @gol
1233 -mtext-section-literals  -mno-text-section-literals @gol
1234 -mauto-litpools  -mno-auto-litpools @gol
1235 -mtarget-align  -mno-target-align @gol
1236 -mlongcalls  -mno-longcalls}
1238 @emph{zSeries Options}
1239 See S/390 and zSeries Options.
1240 @end table
1243 @node Overall Options
1244 @section Options Controlling the Kind of Output
1246 Compilation can involve up to four stages: preprocessing, compilation
1247 proper, assembly and linking, always in that order.  GCC is capable of
1248 preprocessing and compiling several files either into several
1249 assembler input files, or into one assembler input file; then each
1250 assembler input file produces an object file, and linking combines all
1251 the object files (those newly compiled, and those specified as input)
1252 into an executable file.
1254 @cindex file name suffix
1255 For any given input file, the file name suffix determines what kind of
1256 compilation is done:
1258 @table @gcctabopt
1259 @item @var{file}.c
1260 C source code that must be preprocessed.
1262 @item @var{file}.i
1263 C source code that should not be preprocessed.
1265 @item @var{file}.ii
1266 C++ source code that should not be preprocessed.
1268 @item @var{file}.m
1269 Objective-C source code.  Note that you must link with the @file{libobjc}
1270 library to make an Objective-C program work.
1272 @item @var{file}.mi
1273 Objective-C source code that should not be preprocessed.
1275 @item @var{file}.mm
1276 @itemx @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.  Note that @samp{.M} refers
1279 to a literal capital M@.
1281 @item @var{file}.mii
1282 Objective-C++ source code that should not be preprocessed.
1284 @item @var{file}.h
1285 C, C++, Objective-C or Objective-C++ header file to be turned into a
1286 precompiled header (default), or C, C++ header file to be turned into an
1287 Ada spec (via the @option{-fdump-ada-spec} switch).
1289 @item @var{file}.cc
1290 @itemx @var{file}.cp
1291 @itemx @var{file}.cxx
1292 @itemx @var{file}.cpp
1293 @itemx @var{file}.CPP
1294 @itemx @var{file}.c++
1295 @itemx @var{file}.C
1296 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1297 the last two letters must both be literally @samp{x}.  Likewise,
1298 @samp{.C} refers to a literal capital C@.
1300 @item @var{file}.mm
1301 @itemx @var{file}.M
1302 Objective-C++ source code that must be preprocessed.
1304 @item @var{file}.mii
1305 Objective-C++ source code that should not be preprocessed.
1307 @item @var{file}.hh
1308 @itemx @var{file}.H
1309 @itemx @var{file}.hp
1310 @itemx @var{file}.hxx
1311 @itemx @var{file}.hpp
1312 @itemx @var{file}.HPP
1313 @itemx @var{file}.h++
1314 @itemx @var{file}.tcc
1315 C++ header file to be turned into a precompiled header or Ada spec.
1317 @item @var{file}.f
1318 @itemx @var{file}.for
1319 @itemx @var{file}.ftn
1320 Fixed form Fortran source code that should not be preprocessed.
1322 @item @var{file}.F
1323 @itemx @var{file}.FOR
1324 @itemx @var{file}.fpp
1325 @itemx @var{file}.FPP
1326 @itemx @var{file}.FTN
1327 Fixed form Fortran source code that must be preprocessed (with the traditional
1328 preprocessor).
1330 @item @var{file}.f90
1331 @itemx @var{file}.f95
1332 @itemx @var{file}.f03
1333 @itemx @var{file}.f08
1334 Free form Fortran source code that should not be preprocessed.
1336 @item @var{file}.F90
1337 @itemx @var{file}.F95
1338 @itemx @var{file}.F03
1339 @itemx @var{file}.F08
1340 Free form Fortran source code that must be preprocessed (with the
1341 traditional preprocessor).
1343 @item @var{file}.go
1344 Go source code.
1346 @item @var{file}.brig
1347 BRIG files (binary representation of HSAIL).
1349 @item @var{file}.ads
1350 Ada source code file that contains a library unit declaration (a
1351 declaration of a package, subprogram, or generic, or a generic
1352 instantiation), or a library unit renaming declaration (a package,
1353 generic, or subprogram renaming declaration).  Such files are also
1354 called @dfn{specs}.
1356 @item @var{file}.adb
1357 Ada source code file containing a library unit body (a subprogram or
1358 package body).  Such files are also called @dfn{bodies}.
1360 @c GCC also knows about some suffixes for languages not yet included:
1361 @c Pascal:
1362 @c @var{file}.p
1363 @c @var{file}.pas
1364 @c Ratfor:
1365 @c @var{file}.r
1367 @item @var{file}.s
1368 Assembler code.
1370 @item @var{file}.S
1371 @itemx @var{file}.sx
1372 Assembler code that must be preprocessed.
1374 @item @var{other}
1375 An object file to be fed straight into linking.
1376 Any file name with no recognized suffix is treated this way.
1377 @end table
1379 @opindex x
1380 You can specify the input language explicitly with the @option{-x} option:
1382 @table @gcctabopt
1383 @item -x @var{language}
1384 Specify explicitly the @var{language} for the following input files
1385 (rather than letting the compiler choose a default based on the file
1386 name suffix).  This option applies to all following input files until
1387 the next @option{-x} option.  Possible values for @var{language} are:
1388 @smallexample
1389 c  c-header  cpp-output
1390 c++  c++-header  c++-cpp-output
1391 objective-c  objective-c-header  objective-c-cpp-output
1392 objective-c++ objective-c++-header objective-c++-cpp-output
1393 assembler  assembler-with-cpp
1395 f77  f77-cpp-input f95  f95-cpp-input
1397 brig
1398 @end smallexample
1400 @item -x none
1401 Turn off any specification of a language, so that subsequent files are
1402 handled according to their file name suffixes (as they are if @option{-x}
1403 has not been used at all).
1404 @end table
1406 If you only want some of the stages of compilation, you can use
1407 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1408 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1409 @command{gcc} is to stop.  Note that some combinations (for example,
1410 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1412 @table @gcctabopt
1413 @item -c
1414 @opindex c
1415 Compile or assemble the source files, but do not link.  The linking
1416 stage simply is not done.  The ultimate output is in the form of an
1417 object file for each source file.
1419 By default, the object file name for a source file is made by replacing
1420 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1422 Unrecognized input files, not requiring compilation or assembly, are
1423 ignored.
1425 @item -S
1426 @opindex S
1427 Stop after the stage of compilation proper; do not assemble.  The output
1428 is in the form of an assembler code file for each non-assembler input
1429 file specified.
1431 By default, the assembler file name for a source file is made by
1432 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1434 Input files that don't require compilation are ignored.
1436 @item -E
1437 @opindex E
1438 Stop after the preprocessing stage; do not run the compiler proper.  The
1439 output is in the form of preprocessed source code, which is sent to the
1440 standard output.
1442 Input files that don't require preprocessing are ignored.
1444 @cindex output file option
1445 @item -o @var{file}
1446 @opindex o
1447 Place output in file @var{file}.  This applies to whatever
1448 sort of output is being produced, whether it be an executable file,
1449 an object file, an assembler file or preprocessed C code.
1451 If @option{-o} is not specified, the default is to put an executable
1452 file in @file{a.out}, the object file for
1453 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1454 assembler file in @file{@var{source}.s}, a precompiled header file in
1455 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1456 standard output.
1458 @item -v
1459 @opindex v
1460 Print (on standard error output) the commands executed to run the stages
1461 of compilation.  Also print the version number of the compiler driver
1462 program and of the preprocessor and the compiler proper.
1464 @item -###
1465 @opindex ###
1466 Like @option{-v} except the commands are not executed and arguments
1467 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1468 This is useful for shell scripts to capture the driver-generated command lines.
1470 @item --help
1471 @opindex help
1472 Print (on the standard output) a description of the command-line options
1473 understood by @command{gcc}.  If the @option{-v} option is also specified
1474 then @option{--help} is also passed on to the various processes
1475 invoked by @command{gcc}, so that they can display the command-line options
1476 they accept.  If the @option{-Wextra} option has also been specified
1477 (prior to the @option{--help} option), then command-line options that
1478 have no documentation associated with them are also displayed.
1480 @item --target-help
1481 @opindex target-help
1482 Print (on the standard output) a description of target-specific command-line
1483 options for each tool.  For some targets extra target-specific
1484 information may also be printed.
1486 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1487 Print (on the standard output) a description of the command-line
1488 options understood by the compiler that fit into all specified classes
1489 and qualifiers.  These are the supported classes:
1491 @table @asis
1492 @item @samp{optimizers}
1493 Display all of the optimization options supported by the
1494 compiler.
1496 @item @samp{warnings}
1497 Display all of the options controlling warning messages
1498 produced by the compiler.
1500 @item @samp{target}
1501 Display target-specific options.  Unlike the
1502 @option{--target-help} option however, target-specific options of the
1503 linker and assembler are not displayed.  This is because those
1504 tools do not currently support the extended @option{--help=} syntax.
1506 @item @samp{params}
1507 Display the values recognized by the @option{--param}
1508 option.
1510 @item @var{language}
1511 Display the options supported for @var{language}, where
1512 @var{language} is the name of one of the languages supported in this
1513 version of GCC@.
1515 @item @samp{common}
1516 Display the options that are common to all languages.
1517 @end table
1519 These are the supported qualifiers:
1521 @table @asis
1522 @item @samp{undocumented}
1523 Display only those options that are undocumented.
1525 @item @samp{joined}
1526 Display options taking an argument that appears after an equal
1527 sign in the same continuous piece of text, such as:
1528 @samp{--help=target}.
1530 @item @samp{separate}
1531 Display options taking an argument that appears as a separate word
1532 following the original option, such as: @samp{-o output-file}.
1533 @end table
1535 Thus for example to display all the undocumented target-specific
1536 switches supported by the compiler, use:
1538 @smallexample
1539 --help=target,undocumented
1540 @end smallexample
1542 The sense of a qualifier can be inverted by prefixing it with the
1543 @samp{^} character, so for example to display all binary warning
1544 options (i.e., ones that are either on or off and that do not take an
1545 argument) that have a description, use:
1547 @smallexample
1548 --help=warnings,^joined,^undocumented
1549 @end smallexample
1551 The argument to @option{--help=} should not consist solely of inverted
1552 qualifiers.
1554 Combining several classes is possible, although this usually
1555 restricts the output so much that there is nothing to display.  One
1556 case where it does work, however, is when one of the classes is
1557 @var{target}.  For example, to display all the target-specific
1558 optimization options, use:
1560 @smallexample
1561 --help=target,optimizers
1562 @end smallexample
1564 The @option{--help=} option can be repeated on the command line.  Each
1565 successive use displays its requested class of options, skipping
1566 those that have already been displayed.
1568 If the @option{-Q} option appears on the command line before the
1569 @option{--help=} option, then the descriptive text displayed by
1570 @option{--help=} is changed.  Instead of describing the displayed
1571 options, an indication is given as to whether the option is enabled,
1572 disabled or set to a specific value (assuming that the compiler
1573 knows this at the point where the @option{--help=} option is used).
1575 Here is a truncated example from the ARM port of @command{gcc}:
1577 @smallexample
1578   % gcc -Q -mabi=2 --help=target -c
1579   The following options are target specific:
1580   -mabi=                                2
1581   -mabort-on-noreturn                   [disabled]
1582   -mapcs                                [disabled]
1583 @end smallexample
1585 The output is sensitive to the effects of previous command-line
1586 options, so for example it is possible to find out which optimizations
1587 are enabled at @option{-O2} by using:
1589 @smallexample
1590 -Q -O2 --help=optimizers
1591 @end smallexample
1593 Alternatively you can discover which binary optimizations are enabled
1594 by @option{-O3} by using:
1596 @smallexample
1597 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1598 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1599 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1600 @end smallexample
1602 @item --version
1603 @opindex version
1604 Display the version number and copyrights of the invoked GCC@.
1606 @item -pass-exit-codes
1607 @opindex pass-exit-codes
1608 Normally the @command{gcc} program exits with the code of 1 if any
1609 phase of the compiler returns a non-success return code.  If you specify
1610 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1611 the numerically highest error produced by any phase returning an error
1612 indication.  The C, C++, and Fortran front ends return 4 if an internal
1613 compiler error is encountered.
1615 @item -pipe
1616 @opindex pipe
1617 Use pipes rather than temporary files for communication between the
1618 various stages of compilation.  This fails to work on some systems where
1619 the assembler is unable to read from a pipe; but the GNU assembler has
1620 no trouble.
1622 @item -specs=@var{file}
1623 @opindex specs
1624 Process @var{file} after the compiler reads in the standard @file{specs}
1625 file, in order to override the defaults which the @command{gcc} driver
1626 program uses when determining what switches to pass to @command{cc1},
1627 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
1628 @option{-specs=@var{file}} can be specified on the command line, and they
1629 are processed in order, from left to right.  @xref{Spec Files}, for
1630 information about the format of the @var{file}.
1632 @item -wrapper
1633 @opindex wrapper
1634 Invoke all subcommands under a wrapper program.  The name of the
1635 wrapper program and its parameters are passed as a comma separated
1636 list.
1638 @smallexample
1639 gcc -c t.c -wrapper gdb,--args
1640 @end smallexample
1642 @noindent
1643 This invokes all subprograms of @command{gcc} under
1644 @samp{gdb --args}, thus the invocation of @command{cc1} is
1645 @samp{gdb --args cc1 @dots{}}.
1647 @item -fplugin=@var{name}.so
1648 @opindex fplugin
1649 Load the plugin code in file @var{name}.so, assumed to be a
1650 shared object to be dlopen'd by the compiler.  The base name of
1651 the shared object file is used to identify the plugin for the
1652 purposes of argument parsing (See
1653 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1654 Each plugin should define the callback functions specified in the
1655 Plugins API.
1657 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1658 @opindex fplugin-arg
1659 Define an argument called @var{key} with a value of @var{value}
1660 for the plugin called @var{name}.
1662 @item -fdump-ada-spec@r{[}-slim@r{]}
1663 @opindex fdump-ada-spec
1664 For C and C++ source and include files, generate corresponding Ada specs.
1665 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1666 GNAT User's Guide}, which provides detailed documentation on this feature.
1668 @item -fada-spec-parent=@var{unit}
1669 @opindex fada-spec-parent
1670 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1671 Ada specs as child units of parent @var{unit}.
1673 @item -fdump-go-spec=@var{file}
1674 @opindex fdump-go-spec
1675 For input files in any language, generate corresponding Go
1676 declarations in @var{file}.  This generates Go @code{const},
1677 @code{type}, @code{var}, and @code{func} declarations which may be a
1678 useful way to start writing a Go interface to code written in some
1679 other language.
1681 @include @value{srcdir}/../libiberty/at-file.texi
1682 @end table
1684 @node Invoking G++
1685 @section Compiling C++ Programs
1687 @cindex suffixes for C++ source
1688 @cindex C++ source file suffixes
1689 C++ source files conventionally use one of the suffixes @samp{.C},
1690 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1691 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1692 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1693 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1694 files with these names and compiles them as C++ programs even if you
1695 call the compiler the same way as for compiling C programs (usually
1696 with the name @command{gcc}).
1698 @findex g++
1699 @findex c++
1700 However, the use of @command{gcc} does not add the C++ library.
1701 @command{g++} is a program that calls GCC and automatically specifies linking
1702 against the C++ library.  It treats @samp{.c},
1703 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1704 files unless @option{-x} is used.  This program is also useful when
1705 precompiling a C header file with a @samp{.h} extension for use in C++
1706 compilations.  On many systems, @command{g++} is also installed with
1707 the name @command{c++}.
1709 @cindex invoking @command{g++}
1710 When you compile C++ programs, you may specify many of the same
1711 command-line options that you use for compiling programs in any
1712 language; or command-line options meaningful for C and related
1713 languages; or options that are meaningful only for C++ programs.
1714 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1715 explanations of options for languages related to C@.
1716 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1717 explanations of options that are meaningful only for C++ programs.
1719 @node C Dialect Options
1720 @section Options Controlling C Dialect
1721 @cindex dialect options
1722 @cindex language dialect options
1723 @cindex options, dialect
1725 The following options control the dialect of C (or languages derived
1726 from C, such as C++, Objective-C and Objective-C++) that the compiler
1727 accepts:
1729 @table @gcctabopt
1730 @cindex ANSI support
1731 @cindex ISO support
1732 @item -ansi
1733 @opindex ansi
1734 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1735 equivalent to @option{-std=c++98}.
1737 This turns off certain features of GCC that are incompatible with ISO
1738 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1739 such as the @code{asm} and @code{typeof} keywords, and
1740 predefined macros such as @code{unix} and @code{vax} that identify the
1741 type of system you are using.  It also enables the undesirable and
1742 rarely used ISO trigraph feature.  For the C compiler,
1743 it disables recognition of C++ style @samp{//} comments as well as
1744 the @code{inline} keyword.
1746 The alternate keywords @code{__asm__}, @code{__extension__},
1747 @code{__inline__} and @code{__typeof__} continue to work despite
1748 @option{-ansi}.  You would not want to use them in an ISO C program, of
1749 course, but it is useful to put them in header files that might be included
1750 in compilations done with @option{-ansi}.  Alternate predefined macros
1751 such as @code{__unix__} and @code{__vax__} are also available, with or
1752 without @option{-ansi}.
1754 The @option{-ansi} option does not cause non-ISO programs to be
1755 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1756 addition to @option{-ansi}.  @xref{Warning Options}.
1758 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1759 option is used.  Some header files may notice this macro and refrain
1760 from declaring certain functions or defining certain macros that the
1761 ISO standard doesn't call for; this is to avoid interfering with any
1762 programs that might use these names for other things.
1764 Functions that are normally built in but do not have semantics
1765 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1766 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1767 built-in functions provided by GCC}, for details of the functions
1768 affected.
1770 @item -std=
1771 @opindex std
1772 Determine the language standard. @xref{Standards,,Language Standards
1773 Supported by GCC}, for details of these standard versions.  This option
1774 is currently only supported when compiling C or C++.
1776 The compiler can accept several base standards, such as @samp{c90} or
1777 @samp{c++98}, and GNU dialects of those standards, such as
1778 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1779 compiler accepts all programs following that standard plus those
1780 using GNU extensions that do not contradict it.  For example,
1781 @option{-std=c90} turns off certain features of GCC that are
1782 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1783 keywords, but not other GNU extensions that do not have a meaning in
1784 ISO C90, such as omitting the middle term of a @code{?:}
1785 expression. On the other hand, when a GNU dialect of a standard is
1786 specified, all features supported by the compiler are enabled, even when
1787 those features change the meaning of the base standard.  As a result, some
1788 strict-conforming programs may be rejected.  The particular standard
1789 is used by @option{-Wpedantic} to identify which features are GNU
1790 extensions given that version of the standard. For example
1791 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1792 comments, while @option{-std=gnu99 -Wpedantic} does not.
1794 A value for this option must be provided; possible values are
1796 @table @samp
1797 @item c90
1798 @itemx c89
1799 @itemx iso9899:1990
1800 Support all ISO C90 programs (certain GNU extensions that conflict
1801 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1803 @item iso9899:199409
1804 ISO C90 as modified in amendment 1.
1806 @item c99
1807 @itemx c9x
1808 @itemx iso9899:1999
1809 @itemx iso9899:199x
1810 ISO C99.  This standard is substantially completely supported, modulo
1811 bugs and floating-point issues
1812 (mainly but not entirely relating to optional C99 features from
1813 Annexes F and G).  See
1814 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1815 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1817 @item c11
1818 @itemx c1x
1819 @itemx iso9899:2011
1820 ISO C11, the 2011 revision of the ISO C standard.  This standard is
1821 substantially completely supported, modulo bugs, floating-point issues
1822 (mainly but not entirely relating to optional C11 features from
1823 Annexes F and G) and the optional Annexes K (Bounds-checking
1824 interfaces) and L (Analyzability).  The name @samp{c1x} is deprecated.
1826 @item gnu90
1827 @itemx gnu89
1828 GNU dialect of ISO C90 (including some C99 features).
1830 @item gnu99
1831 @itemx gnu9x
1832 GNU dialect of ISO C99.  The name @samp{gnu9x} is deprecated.
1834 @item gnu11
1835 @itemx gnu1x
1836 GNU dialect of ISO C11.  This is the default for C code.
1837 The name @samp{gnu1x} is deprecated.
1839 @item c++98
1840 @itemx c++03
1841 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1842 additional defect reports. Same as @option{-ansi} for C++ code.
1844 @item gnu++98
1845 @itemx gnu++03
1846 GNU dialect of @option{-std=c++98}.
1848 @item c++11
1849 @itemx c++0x
1850 The 2011 ISO C++ standard plus amendments.
1851 The name @samp{c++0x} is deprecated.
1853 @item gnu++11
1854 @itemx gnu++0x
1855 GNU dialect of @option{-std=c++11}.
1856 The name @samp{gnu++0x} is deprecated.
1858 @item c++14
1859 @itemx c++1y
1860 The 2014 ISO C++ standard plus amendments.
1861 The name @samp{c++1y} is deprecated.
1863 @item gnu++14
1864 @itemx gnu++1y
1865 GNU dialect of @option{-std=c++14}.
1866 This is the default for C++ code.
1867 The name @samp{gnu++1y} is deprecated.
1869 @item c++1z
1870 The next revision of the ISO C++ standard, tentatively planned for
1871 2017.  Support is highly experimental, and will almost certainly
1872 change in incompatible ways in future releases.
1874 @item gnu++1z
1875 GNU dialect of @option{-std=c++1z}.  Support is highly experimental,
1876 and will almost certainly change in incompatible ways in future
1877 releases.
1878 @end table
1880 @item -fgnu89-inline
1881 @opindex fgnu89-inline
1882 The option @option{-fgnu89-inline} tells GCC to use the traditional
1883 GNU semantics for @code{inline} functions when in C99 mode.
1884 @xref{Inline,,An Inline Function is As Fast As a Macro}.
1885 Using this option is roughly equivalent to adding the
1886 @code{gnu_inline} function attribute to all inline functions
1887 (@pxref{Function Attributes}).
1889 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1890 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1891 specifies the default behavior).
1892 This option is not supported in @option{-std=c90} or
1893 @option{-std=gnu90} mode.
1895 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1896 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1897 in effect for @code{inline} functions.  @xref{Common Predefined
1898 Macros,,,cpp,The C Preprocessor}.
1900 @item -fpermitted-flt-eval-methods=@var{style}
1901 @opindex fpermitted-flt-eval-methods
1902 @opindex fpermitted-flt-eval-methods=c11
1903 @opindex fpermitted-flt-eval-methods=ts-18661-3
1904 ISO/IEC TS 18661-3 defines new permissible values for
1905 @code{FLT_EVAL_METHOD} that indicate that operations and constants with
1906 a semantic type that is an interchange or extended format should be
1907 evaluated to the precision and range of that type.  These new values are
1908 a superset of those permitted under C99/C11, which does not specify the
1909 meaning of other positive values of @code{FLT_EVAL_METHOD}.  As such, code
1910 conforming to C11 may not have been written expecting the possibility of
1911 the new values.
1913 @option{-fpermitted-flt-eval-methods} specifies whether the compiler
1914 should allow only the values of @code{FLT_EVAL_METHOD} specified in C99/C11,
1915 or the extended set of values specified in ISO/IEC TS 18661-3.
1917 @var{style} is either @code{c11} or @code{ts-18661-3} as appropriate.
1919 The default when in a standards compliant mode (@option{-std=c11} or similar)
1920 is @option{-fpermitted-flt-eval-methods=c11}.  The default when in a GNU
1921 dialect (@option{-std=gnu11} or similar) is
1922 @option{-fpermitted-flt-eval-methods=ts-18661-3}.
1924 @item -aux-info @var{filename}
1925 @opindex aux-info
1926 Output to the given filename prototyped declarations for all functions
1927 declared and/or defined in a translation unit, including those in header
1928 files.  This option is silently ignored in any language other than C@.
1930 Besides declarations, the file indicates, in comments, the origin of
1931 each declaration (source file and line), whether the declaration was
1932 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1933 @samp{O} for old, respectively, in the first character after the line
1934 number and the colon), and whether it came from a declaration or a
1935 definition (@samp{C} or @samp{F}, respectively, in the following
1936 character).  In the case of function definitions, a K&R-style list of
1937 arguments followed by their declarations is also provided, inside
1938 comments, after the declaration.
1940 @item -fallow-parameterless-variadic-functions
1941 @opindex fallow-parameterless-variadic-functions
1942 Accept variadic functions without named parameters.
1944 Although it is possible to define such a function, this is not very
1945 useful as it is not possible to read the arguments.  This is only
1946 supported for C as this construct is allowed by C++.
1948 @item -fno-asm
1949 @opindex fno-asm
1950 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1951 keyword, so that code can use these words as identifiers.  You can use
1952 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1953 instead.  @option{-ansi} implies @option{-fno-asm}.
1955 In C++, this switch only affects the @code{typeof} keyword, since
1956 @code{asm} and @code{inline} are standard keywords.  You may want to
1957 use the @option{-fno-gnu-keywords} flag instead, which has the same
1958 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1959 switch only affects the @code{asm} and @code{typeof} keywords, since
1960 @code{inline} is a standard keyword in ISO C99.
1962 @item -fno-builtin
1963 @itemx -fno-builtin-@var{function}
1964 @opindex fno-builtin
1965 @cindex built-in functions
1966 Don't recognize built-in functions that do not begin with
1967 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1968 functions provided by GCC}, for details of the functions affected,
1969 including those which are not built-in functions when @option{-ansi} or
1970 @option{-std} options for strict ISO C conformance are used because they
1971 do not have an ISO standard meaning.
1973 GCC normally generates special code to handle certain built-in functions
1974 more efficiently; for instance, calls to @code{alloca} may become single
1975 instructions which adjust the stack directly, and calls to @code{memcpy}
1976 may become inline copy loops.  The resulting code is often both smaller
1977 and faster, but since the function calls no longer appear as such, you
1978 cannot set a breakpoint on those calls, nor can you change the behavior
1979 of the functions by linking with a different library.  In addition,
1980 when a function is recognized as a built-in function, GCC may use
1981 information about that function to warn about problems with calls to
1982 that function, or to generate more efficient code, even if the
1983 resulting code still contains calls to that function.  For example,
1984 warnings are given with @option{-Wformat} for bad calls to
1985 @code{printf} when @code{printf} is built in and @code{strlen} is
1986 known not to modify global memory.
1988 With the @option{-fno-builtin-@var{function}} option
1989 only the built-in function @var{function} is
1990 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1991 function is named that is not built-in in this version of GCC, this
1992 option is ignored.  There is no corresponding
1993 @option{-fbuiltin-@var{function}} option; if you wish to enable
1994 built-in functions selectively when using @option{-fno-builtin} or
1995 @option{-ffreestanding}, you may define macros such as:
1997 @smallexample
1998 #define abs(n)          __builtin_abs ((n))
1999 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
2000 @end smallexample
2002 @item -fgimple
2003 @opindex fgimple
2005 Enable parsing of function definitions marked with @code{__GIMPLE}.
2006 This is an experimental feature that allows unit testing of GIMPLE
2007 passes.
2009 @item -fhosted
2010 @opindex fhosted
2011 @cindex hosted environment
2013 Assert that compilation targets a hosted environment.  This implies
2014 @option{-fbuiltin}.  A hosted environment is one in which the
2015 entire standard library is available, and in which @code{main} has a return
2016 type of @code{int}.  Examples are nearly everything except a kernel.
2017 This is equivalent to @option{-fno-freestanding}.
2019 @item -ffreestanding
2020 @opindex ffreestanding
2021 @cindex hosted environment
2023 Assert that compilation targets a freestanding environment.  This
2024 implies @option{-fno-builtin}.  A freestanding environment
2025 is one in which the standard library may not exist, and program startup may
2026 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
2027 This is equivalent to @option{-fno-hosted}.
2029 @xref{Standards,,Language Standards Supported by GCC}, for details of
2030 freestanding and hosted environments.
2032 @item -fopenacc
2033 @opindex fopenacc
2034 @cindex OpenACC accelerator programming
2035 Enable handling of OpenACC directives @code{#pragma acc} in C/C++ and
2036 @code{!$acc} in Fortran.  When @option{-fopenacc} is specified, the
2037 compiler generates accelerated code according to the OpenACC Application
2038 Programming Interface v2.0 @w{@uref{http://www.openacc.org/}}.  This option
2039 implies @option{-pthread}, and thus is only supported on targets that
2040 have support for @option{-pthread}.
2042 @item -fopenacc-dim=@var{geom}
2043 @opindex fopenacc-dim
2044 @cindex OpenACC accelerator programming
2045 Specify default compute dimensions for parallel offload regions that do
2046 not explicitly specify.  The @var{geom} value is a triple of
2047 ':'-separated sizes, in order 'gang', 'worker' and, 'vector'.  A size
2048 can be omitted, to use a target-specific default value.
2050 @item -fopenmp
2051 @opindex fopenmp
2052 @cindex OpenMP parallel
2053 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
2054 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
2055 compiler generates parallel code according to the OpenMP Application
2056 Program Interface v4.5 @w{@uref{http://www.openmp.org/}}.  This option
2057 implies @option{-pthread}, and thus is only supported on targets that
2058 have support for @option{-pthread}. @option{-fopenmp} implies
2059 @option{-fopenmp-simd}.
2061 @item -fopenmp-simd
2062 @opindex fopenmp-simd
2063 @cindex OpenMP SIMD
2064 @cindex SIMD
2065 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
2066 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
2067 are ignored.
2069 @item -fcilkplus
2070 @opindex fcilkplus
2071 @cindex Enable Cilk Plus
2072 Enable the usage of Cilk Plus language extension features for C/C++.
2073 When the option @option{-fcilkplus} is specified, enable the usage of
2074 the Cilk Plus Language extension features for C/C++.  The present
2075 implementation follows ABI version 1.2.  This is an experimental
2076 feature that is only partially complete, and whose interface may
2077 change in future versions of GCC as the official specification
2078 changes.  Currently, all features but @code{_Cilk_for} have been
2079 implemented.
2081 @item -fgnu-tm
2082 @opindex fgnu-tm
2083 When the option @option{-fgnu-tm} is specified, the compiler
2084 generates code for the Linux variant of Intel's current Transactional
2085 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
2086 an experimental feature whose interface may change in future versions
2087 of GCC, as the official specification changes.  Please note that not
2088 all architectures are supported for this feature.
2090 For more information on GCC's support for transactional memory,
2091 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
2092 Transactional Memory Library}.
2094 Note that the transactional memory feature is not supported with
2095 non-call exceptions (@option{-fnon-call-exceptions}).
2097 @item -fms-extensions
2098 @opindex fms-extensions
2099 Accept some non-standard constructs used in Microsoft header files.
2101 In C++ code, this allows member names in structures to be similar
2102 to previous types declarations.
2104 @smallexample
2105 typedef int UOW;
2106 struct ABC @{
2107   UOW UOW;
2109 @end smallexample
2111 Some cases of unnamed fields in structures and unions are only
2112 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
2113 fields within structs/unions}, for details.
2115 Note that this option is off for all targets but x86 
2116 targets using ms-abi.
2118 @item -fplan9-extensions
2119 @opindex fplan9-extensions
2120 Accept some non-standard constructs used in Plan 9 code.
2122 This enables @option{-fms-extensions}, permits passing pointers to
2123 structures with anonymous fields to functions that expect pointers to
2124 elements of the type of the field, and permits referring to anonymous
2125 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
2126 struct/union fields within structs/unions}, for details.  This is only
2127 supported for C, not C++.
2129 @item -fcond-mismatch
2130 @opindex fcond-mismatch
2131 Allow conditional expressions with mismatched types in the second and
2132 third arguments.  The value of such an expression is void.  This option
2133 is not supported for C++.
2135 @item -flax-vector-conversions
2136 @opindex flax-vector-conversions
2137 Allow implicit conversions between vectors with differing numbers of
2138 elements and/or incompatible element types.  This option should not be
2139 used for new code.
2141 @item -funsigned-char
2142 @opindex funsigned-char
2143 Let the type @code{char} be unsigned, like @code{unsigned char}.
2145 Each kind of machine has a default for what @code{char} should
2146 be.  It is either like @code{unsigned char} by default or like
2147 @code{signed char} by default.
2149 Ideally, a portable program should always use @code{signed char} or
2150 @code{unsigned char} when it depends on the signedness of an object.
2151 But many programs have been written to use plain @code{char} and
2152 expect it to be signed, or expect it to be unsigned, depending on the
2153 machines they were written for.  This option, and its inverse, let you
2154 make such a program work with the opposite default.
2156 The type @code{char} is always a distinct type from each of
2157 @code{signed char} or @code{unsigned char}, even though its behavior
2158 is always just like one of those two.
2160 @item -fsigned-char
2161 @opindex fsigned-char
2162 Let the type @code{char} be signed, like @code{signed char}.
2164 Note that this is equivalent to @option{-fno-unsigned-char}, which is
2165 the negative form of @option{-funsigned-char}.  Likewise, the option
2166 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
2168 @item -fsigned-bitfields
2169 @itemx -funsigned-bitfields
2170 @itemx -fno-signed-bitfields
2171 @itemx -fno-unsigned-bitfields
2172 @opindex fsigned-bitfields
2173 @opindex funsigned-bitfields
2174 @opindex fno-signed-bitfields
2175 @opindex fno-unsigned-bitfields
2176 These options control whether a bit-field is signed or unsigned, when the
2177 declaration does not use either @code{signed} or @code{unsigned}.  By
2178 default, such a bit-field is signed, because this is consistent: the
2179 basic integer types such as @code{int} are signed types.
2181 @item -fsso-struct=@var{endianness}
2182 @opindex fsso-struct
2183 Set the default scalar storage order of structures and unions to the
2184 specified endianness.  The accepted values are @samp{big-endian},
2185 @samp{little-endian} and @samp{native} for the native endianness of
2186 the target (the default).  This option is not supported for C++.
2188 @strong{Warning:} the @option{-fsso-struct} switch causes GCC to generate
2189 code that is not binary compatible with code generated without it if the
2190 specified endianness is not the native endianness of the target.
2191 @end table
2193 @node C++ Dialect Options
2194 @section Options Controlling C++ Dialect
2196 @cindex compiler options, C++
2197 @cindex C++ options, command-line
2198 @cindex options, C++
2199 This section describes the command-line options that are only meaningful
2200 for C++ programs.  You can also use most of the GNU compiler options
2201 regardless of what language your program is in.  For example, you
2202 might compile a file @file{firstClass.C} like this:
2204 @smallexample
2205 g++ -g -fstrict-enums -O -c firstClass.C
2206 @end smallexample
2208 @noindent
2209 In this example, only @option{-fstrict-enums} is an option meant
2210 only for C++ programs; you can use the other options with any
2211 language supported by GCC@.
2213 Some options for compiling C programs, such as @option{-std}, are also
2214 relevant for C++ programs.
2215 @xref{C Dialect Options,,Options Controlling C Dialect}.
2217 Here is a list of options that are @emph{only} for compiling C++ programs:
2219 @table @gcctabopt
2221 @item -fabi-version=@var{n}
2222 @opindex fabi-version
2223 Use version @var{n} of the C++ ABI@.  The default is version 0.
2225 Version 0 refers to the version conforming most closely to
2226 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2227 will change in different versions of G++ as ABI bugs are fixed.
2229 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.
2231 Version 2 is the version of the C++ ABI that first appeared in G++
2232 3.4, and was the default through G++ 4.9.
2234 Version 3 corrects an error in mangling a constant address as a
2235 template argument.
2237 Version 4, which first appeared in G++ 4.5, implements a standard
2238 mangling for vector types.
2240 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2241 attribute const/volatile on function pointer types, decltype of a
2242 plain decl, and use of a function parameter in the declaration of
2243 another parameter.
2245 Version 6, which first appeared in G++ 4.7, corrects the promotion
2246 behavior of C++11 scoped enums and the mangling of template argument
2247 packs, const/static_cast, prefix ++ and --, and a class scope function
2248 used as a template argument.
2250 Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a
2251 builtin type and corrects the mangling of lambdas in default argument
2252 scope.
2254 Version 8, which first appeared in G++ 4.9, corrects the substitution
2255 behavior of function types with function-cv-qualifiers.
2257 Version 9, which first appeared in G++ 5.2, corrects the alignment of
2258 @code{nullptr_t}.
2260 Version 10, which first appeared in G++ 6.1, adds mangling of
2261 attributes that affect type identity, such as ia32 calling convention
2262 attributes (e.g. @samp{stdcall}).
2264 Version 11, which first appeared in G++ 7, corrects the mangling of
2265 sizeof... expressions and operator names.  For multiple entities with
2266 the same name within a function, that are declared in different scopes,
2267 the mangling now changes starting with the twelfth occurrence.  It also
2268 implies @option{-fnew-inheriting-ctors}.
2270 See also @option{-Wabi}.
2272 @item -fabi-compat-version=@var{n}
2273 @opindex fabi-compat-version
2274 On targets that support strong aliases, G++
2275 works around mangling changes by creating an alias with the correct
2276 mangled name when defining a symbol with an incorrect mangled name.
2277 This switch specifies which ABI version to use for the alias.
2279 With @option{-fabi-version=0} (the default), this defaults to 8 (GCC 5
2280 compatibility).  If another ABI version is explicitly selected, this
2281 defaults to 0.  For compatibility with GCC versions 3.2 through 4.9,
2282 use @option{-fabi-compat-version=2}.
2284 If this option is not provided but @option{-Wabi=@var{n}} is, that
2285 version is used for compatibility aliases.  If this option is provided
2286 along with @option{-Wabi} (without the version), the version from this
2287 option is used for the warning.
2289 @item -fno-access-control
2290 @opindex fno-access-control
2291 Turn off all access checking.  This switch is mainly useful for working
2292 around bugs in the access control code.
2294 @item -faligned-new
2295 @opindex faligned-new
2296 Enable support for C++17 @code{new} of types that require more
2297 alignment than @code{void* ::operator new(std::size_t)} provides.  A
2298 numeric argument such as @code{-faligned-new=32} can be used to
2299 specify how much alignment (in bytes) is provided by that function,
2300 but few users will need to override the default of
2301 @code{alignof(std::max_align_t)}.
2303 This flag is enabled by default for @option{-std=c++1z}.
2305 @item -fcheck-new
2306 @opindex fcheck-new
2307 Check that the pointer returned by @code{operator new} is non-null
2308 before attempting to modify the storage allocated.  This check is
2309 normally unnecessary because the C++ standard specifies that
2310 @code{operator new} only returns @code{0} if it is declared
2311 @code{throw()}, in which case the compiler always checks the
2312 return value even without this option.  In all other cases, when
2313 @code{operator new} has a non-empty exception specification, memory
2314 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2315 @samp{new (nothrow)}.
2317 @item -fconcepts
2318 @opindex fconcepts
2319 Enable support for the C++ Extensions for Concepts Technical
2320 Specification, ISO 19217 (2015), which allows code like
2322 @smallexample
2323 template <class T> concept bool Addable = requires (T t) @{ t + t; @};
2324 template <Addable T> T add (T a, T b) @{ return a + b; @}
2325 @end smallexample
2327 @item -fconstexpr-depth=@var{n}
2328 @opindex fconstexpr-depth
2329 Set the maximum nested evaluation depth for C++11 constexpr functions
2330 to @var{n}.  A limit is needed to detect endless recursion during
2331 constant expression evaluation.  The minimum specified by the standard
2332 is 512.
2334 @item -fconstexpr-loop-limit=@var{n}
2335 @opindex fconstexpr-loop-limit
2336 Set the maximum number of iterations for a loop in C++14 constexpr functions
2337 to @var{n}.  A limit is needed to detect infinite loops during
2338 constant expression evaluation.  The default is 262144 (1<<18).
2340 @item -fdeduce-init-list
2341 @opindex fdeduce-init-list
2342 Enable deduction of a template type parameter as
2343 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2345 @smallexample
2346 template <class T> auto forward(T t) -> decltype (realfn (t))
2348   return realfn (t);
2351 void f()
2353   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2355 @end smallexample
2357 This deduction was implemented as a possible extension to the
2358 originally proposed semantics for the C++11 standard, but was not part
2359 of the final standard, so it is disabled by default.  This option is
2360 deprecated, and may be removed in a future version of G++.
2362 @item -ffriend-injection
2363 @opindex ffriend-injection
2364 Inject friend functions into the enclosing namespace, so that they are
2365 visible outside the scope of the class in which they are declared.
2366 Friend functions were documented to work this way in the old Annotated
2367 C++ Reference Manual.  
2368 However, in ISO C++ a friend function that is not declared
2369 in an enclosing scope can only be found using argument dependent
2370 lookup.  GCC defaults to the standard behavior.
2372 This option is for compatibility, and may be removed in a future
2373 release of G++.
2375 @item -fno-elide-constructors
2376 @opindex fno-elide-constructors
2377 The C++ standard allows an implementation to omit creating a temporary
2378 that is only used to initialize another object of the same type.
2379 Specifying this option disables that optimization, and forces G++ to
2380 call the copy constructor in all cases.  This option also causes G++
2381 to call trivial member functions which otherwise would be expanded inline.
2383 In C++17, the compiler is required to omit these temporaries, but this
2384 option still affects trivial member functions.
2386 @item -fno-enforce-eh-specs
2387 @opindex fno-enforce-eh-specs
2388 Don't generate code to check for violation of exception specifications
2389 at run time.  This option violates the C++ standard, but may be useful
2390 for reducing code size in production builds, much like defining
2391 @code{NDEBUG}.  This does not give user code permission to throw
2392 exceptions in violation of the exception specifications; the compiler
2393 still optimizes based on the specifications, so throwing an
2394 unexpected exception results in undefined behavior at run time.
2396 @item -fextern-tls-init
2397 @itemx -fno-extern-tls-init
2398 @opindex fextern-tls-init
2399 @opindex fno-extern-tls-init
2400 The C++11 and OpenMP standards allow @code{thread_local} and
2401 @code{threadprivate} variables to have dynamic (runtime)
2402 initialization.  To support this, any use of such a variable goes
2403 through a wrapper function that performs any necessary initialization.
2404 When the use and definition of the variable are in the same
2405 translation unit, this overhead can be optimized away, but when the
2406 use is in a different translation unit there is significant overhead
2407 even if the variable doesn't actually need dynamic initialization.  If
2408 the programmer can be sure that no use of the variable in a
2409 non-defining TU needs to trigger dynamic initialization (either
2410 because the variable is statically initialized, or a use of the
2411 variable in the defining TU will be executed before any uses in
2412 another TU), they can avoid this overhead with the
2413 @option{-fno-extern-tls-init} option.
2415 On targets that support symbol aliases, the default is
2416 @option{-fextern-tls-init}.  On targets that do not support symbol
2417 aliases, the default is @option{-fno-extern-tls-init}.
2419 @item -ffor-scope
2420 @itemx -fno-for-scope
2421 @opindex ffor-scope
2422 @opindex fno-for-scope
2423 If @option{-ffor-scope} is specified, the scope of variables declared in
2424 a @i{for-init-statement} is limited to the @code{for} loop itself,
2425 as specified by the C++ standard.
2426 If @option{-fno-for-scope} is specified, the scope of variables declared in
2427 a @i{for-init-statement} extends to the end of the enclosing scope,
2428 as was the case in old versions of G++, and other (traditional)
2429 implementations of C++.
2431 If neither flag is given, the default is to follow the standard,
2432 but to allow and give a warning for old-style code that would
2433 otherwise be invalid, or have different behavior.
2435 @item -fno-gnu-keywords
2436 @opindex fno-gnu-keywords
2437 Do not recognize @code{typeof} as a keyword, so that code can use this
2438 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2439 This option is implied by the strict ISO C++ dialects: @option{-ansi},
2440 @option{-std=c++98}, @option{-std=c++11}, etc.
2442 @item -fno-implicit-templates
2443 @opindex fno-implicit-templates
2444 Never emit code for non-inline templates that are instantiated
2445 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2446 @xref{Template Instantiation}, for more information.
2448 @item -fno-implicit-inline-templates
2449 @opindex fno-implicit-inline-templates
2450 Don't emit code for implicit instantiations of inline templates, either.
2451 The default is to handle inlines differently so that compiles with and
2452 without optimization need the same set of explicit instantiations.
2454 @item -fno-implement-inlines
2455 @opindex fno-implement-inlines
2456 To save space, do not emit out-of-line copies of inline functions
2457 controlled by @code{#pragma implementation}.  This causes linker
2458 errors if these functions are not inlined everywhere they are called.
2460 @item -fms-extensions
2461 @opindex fms-extensions
2462 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2463 int and getting a pointer to member function via non-standard syntax.
2465 @item -fnew-inheriting-ctors
2466 @opindex fnew-inheriting-ctors
2467 Enable the P0136 adjustment to the semantics of C++11 constructor
2468 inheritance.  This is part of C++17 but also considered to be a Defect
2469 Report against C++11 and C++14.  This flag is enabled by default
2470 unless @option{-fabi-version=10} or lower is specified.
2472 @item -fnew-ttp-matching
2473 @opindex fnew-ttp-matching
2474 Enable the P0522 resolution to Core issue 150, template template
2475 parameters and default arguments: this allows a template with default
2476 template arguments as an argument for a template template parameter
2477 with fewer template parameters.  This flag is enabled by default for
2478 @option{-std=c++1z}.
2480 @item -fno-nonansi-builtins
2481 @opindex fno-nonansi-builtins
2482 Disable built-in declarations of functions that are not mandated by
2483 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2484 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2486 @item -fnothrow-opt
2487 @opindex fnothrow-opt
2488 Treat a @code{throw()} exception specification as if it were a
2489 @code{noexcept} specification to reduce or eliminate the text size
2490 overhead relative to a function with no exception specification.  If
2491 the function has local variables of types with non-trivial
2492 destructors, the exception specification actually makes the
2493 function smaller because the EH cleanups for those variables can be
2494 optimized away.  The semantic effect is that an exception thrown out of
2495 a function with such an exception specification results in a call
2496 to @code{terminate} rather than @code{unexpected}.
2498 @item -fno-operator-names
2499 @opindex fno-operator-names
2500 Do not treat the operator name keywords @code{and}, @code{bitand},
2501 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2502 synonyms as keywords.
2504 @item -fno-optional-diags
2505 @opindex fno-optional-diags
2506 Disable diagnostics that the standard says a compiler does not need to
2507 issue.  Currently, the only such diagnostic issued by G++ is the one for
2508 a name having multiple meanings within a class.
2510 @item -fpermissive
2511 @opindex fpermissive
2512 Downgrade some diagnostics about nonconformant code from errors to
2513 warnings.  Thus, using @option{-fpermissive} allows some
2514 nonconforming code to compile.
2516 @item -fno-pretty-templates
2517 @opindex fno-pretty-templates
2518 When an error message refers to a specialization of a function
2519 template, the compiler normally prints the signature of the
2520 template followed by the template arguments and any typedefs or
2521 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2522 rather than @code{void f(int)}) so that it's clear which template is
2523 involved.  When an error message refers to a specialization of a class
2524 template, the compiler omits any template arguments that match
2525 the default template arguments for that template.  If either of these
2526 behaviors make it harder to understand the error message rather than
2527 easier, you can use @option{-fno-pretty-templates} to disable them.
2529 @item -frepo
2530 @opindex frepo
2531 Enable automatic template instantiation at link time.  This option also
2532 implies @option{-fno-implicit-templates}.  @xref{Template
2533 Instantiation}, for more information.
2535 @item -fno-rtti
2536 @opindex fno-rtti
2537 Disable generation of information about every class with virtual
2538 functions for use by the C++ run-time type identification features
2539 (@code{dynamic_cast} and @code{typeid}).  If you don't use those parts
2540 of the language, you can save some space by using this flag.  Note that
2541 exception handling uses the same information, but G++ generates it as
2542 needed. The @code{dynamic_cast} operator can still be used for casts that
2543 do not require run-time type information, i.e.@: casts to @code{void *} or to
2544 unambiguous base classes.
2546 @item -fsized-deallocation
2547 @opindex fsized-deallocation
2548 Enable the built-in global declarations
2549 @smallexample
2550 void operator delete (void *, std::size_t) noexcept;
2551 void operator delete[] (void *, std::size_t) noexcept;
2552 @end smallexample
2553 as introduced in C++14.  This is useful for user-defined replacement
2554 deallocation functions that, for example, use the size of the object
2555 to make deallocation faster.  Enabled by default under
2556 @option{-std=c++14} and above.  The flag @option{-Wsized-deallocation}
2557 warns about places that might want to add a definition.
2559 @item -fstrict-enums
2560 @opindex fstrict-enums
2561 Allow the compiler to optimize using the assumption that a value of
2562 enumerated type can only be one of the values of the enumeration (as
2563 defined in the C++ standard; basically, a value that can be
2564 represented in the minimum number of bits needed to represent all the
2565 enumerators).  This assumption may not be valid if the program uses a
2566 cast to convert an arbitrary integer value to the enumerated type.
2568 @item -fstrong-eval-order
2569 @opindex fstrong-eval-order
2570 Evaluate member access, array subscripting, and shift expressions in
2571 left-to-right order, and evaluate assignment in right-to-left order,
2572 as adopted for C++17.  Enabled by default with @option{-std=c++1z}.
2573 @option{-fstrong-eval-order=some} enables just the ordering of member
2574 access and shift expressions, and is the default without
2575 @option{-std=c++1z}.
2577 @item -ftemplate-backtrace-limit=@var{n}
2578 @opindex ftemplate-backtrace-limit
2579 Set the maximum number of template instantiation notes for a single
2580 warning or error to @var{n}.  The default value is 10.
2582 @item -ftemplate-depth=@var{n}
2583 @opindex ftemplate-depth
2584 Set the maximum instantiation depth for template classes to @var{n}.
2585 A limit on the template instantiation depth is needed to detect
2586 endless recursions during template class instantiation.  ANSI/ISO C++
2587 conforming programs must not rely on a maximum depth greater than 17
2588 (changed to 1024 in C++11).  The default value is 900, as the compiler
2589 can run out of stack space before hitting 1024 in some situations.
2591 @item -fno-threadsafe-statics
2592 @opindex fno-threadsafe-statics
2593 Do not emit the extra code to use the routines specified in the C++
2594 ABI for thread-safe initialization of local statics.  You can use this
2595 option to reduce code size slightly in code that doesn't need to be
2596 thread-safe.
2598 @item -fuse-cxa-atexit
2599 @opindex fuse-cxa-atexit
2600 Register destructors for objects with static storage duration with the
2601 @code{__cxa_atexit} function rather than the @code{atexit} function.
2602 This option is required for fully standards-compliant handling of static
2603 destructors, but only works if your C library supports
2604 @code{__cxa_atexit}.
2606 @item -fno-use-cxa-get-exception-ptr
2607 @opindex fno-use-cxa-get-exception-ptr
2608 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2609 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2610 if the runtime routine is not available.
2612 @item -fvisibility-inlines-hidden
2613 @opindex fvisibility-inlines-hidden
2614 This switch declares that the user does not attempt to compare
2615 pointers to inline functions or methods where the addresses of the two functions
2616 are taken in different shared objects.
2618 The effect of this is that GCC may, effectively, mark inline methods with
2619 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2620 appear in the export table of a DSO and do not require a PLT indirection
2621 when used within the DSO@.  Enabling this option can have a dramatic effect
2622 on load and link times of a DSO as it massively reduces the size of the
2623 dynamic export table when the library makes heavy use of templates.
2625 The behavior of this switch is not quite the same as marking the
2626 methods as hidden directly, because it does not affect static variables
2627 local to the function or cause the compiler to deduce that
2628 the function is defined in only one shared object.
2630 You may mark a method as having a visibility explicitly to negate the
2631 effect of the switch for that method.  For example, if you do want to
2632 compare pointers to a particular inline method, you might mark it as
2633 having default visibility.  Marking the enclosing class with explicit
2634 visibility has no effect.
2636 Explicitly instantiated inline methods are unaffected by this option
2637 as their linkage might otherwise cross a shared library boundary.
2638 @xref{Template Instantiation}.
2640 @item -fvisibility-ms-compat
2641 @opindex fvisibility-ms-compat
2642 This flag attempts to use visibility settings to make GCC's C++
2643 linkage model compatible with that of Microsoft Visual Studio.
2645 The flag makes these changes to GCC's linkage model:
2647 @enumerate
2648 @item
2649 It sets the default visibility to @code{hidden}, like
2650 @option{-fvisibility=hidden}.
2652 @item
2653 Types, but not their members, are not hidden by default.
2655 @item
2656 The One Definition Rule is relaxed for types without explicit
2657 visibility specifications that are defined in more than one
2658 shared object: those declarations are permitted if they are
2659 permitted when this option is not used.
2660 @end enumerate
2662 In new code it is better to use @option{-fvisibility=hidden} and
2663 export those classes that are intended to be externally visible.
2664 Unfortunately it is possible for code to rely, perhaps accidentally,
2665 on the Visual Studio behavior.
2667 Among the consequences of these changes are that static data members
2668 of the same type with the same name but defined in different shared
2669 objects are different, so changing one does not change the other;
2670 and that pointers to function members defined in different shared
2671 objects may not compare equal.  When this flag is given, it is a
2672 violation of the ODR to define types with the same name differently.
2674 @item -fno-weak
2675 @opindex fno-weak
2676 Do not use weak symbol support, even if it is provided by the linker.
2677 By default, G++ uses weak symbols if they are available.  This
2678 option exists only for testing, and should not be used by end-users;
2679 it results in inferior code and has no benefits.  This option may
2680 be removed in a future release of G++.
2682 @item -nostdinc++
2683 @opindex nostdinc++
2684 Do not search for header files in the standard directories specific to
2685 C++, but do still search the other standard directories.  (This option
2686 is used when building the C++ library.)
2687 @end table
2689 In addition, these optimization, warning, and code generation options
2690 have meanings only for C++ programs:
2692 @table @gcctabopt
2693 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2694 @opindex Wabi
2695 @opindex Wno-abi
2696 Warn when G++ it generates code that is probably not compatible with
2697 the vendor-neutral C++ ABI@.  Since G++ now defaults to updating the
2698 ABI with each major release, normally @option{-Wabi} will warn only if
2699 there is a check added later in a release series for an ABI issue
2700 discovered since the initial release.  @option{-Wabi} will warn about
2701 more things if an older ABI version is selected (with
2702 @option{-fabi-version=@var{n}}).
2704 @option{-Wabi} can also be used with an explicit version number to
2705 warn about compatibility with a particular @option{-fabi-version}
2706 level, e.g. @option{-Wabi=2} to warn about changes relative to
2707 @option{-fabi-version=2}.
2709 If an explicit version number is provided and
2710 @option{-fabi-compat-version} is not specified, the version number
2711 from this option is used for compatibility aliases.  If no explicit
2712 version number is provided with this option, but
2713 @option{-fabi-compat-version} is specified, that version number is
2714 used for ABI warnings.
2716 Although an effort has been made to warn about
2717 all such cases, there are probably some cases that are not warned about,
2718 even though G++ is generating incompatible code.  There may also be
2719 cases where warnings are emitted even though the code that is generated
2720 is compatible.
2722 You should rewrite your code to avoid these warnings if you are
2723 concerned about the fact that code generated by G++ may not be binary
2724 compatible with code generated by other compilers.
2726 Known incompatibilities in @option{-fabi-version=2} (which was the
2727 default from GCC 3.4 to 4.9) include:
2729 @itemize @bullet
2731 @item
2732 A template with a non-type template parameter of reference type was
2733 mangled incorrectly:
2734 @smallexample
2735 extern int N;
2736 template <int &> struct S @{@};
2737 void n (S<N>) @{2@}
2738 @end smallexample
2740 This was fixed in @option{-fabi-version=3}.
2742 @item
2743 SIMD vector types declared using @code{__attribute ((vector_size))} were
2744 mangled in a non-standard way that does not allow for overloading of
2745 functions taking vectors of different sizes.
2747 The mangling was changed in @option{-fabi-version=4}.
2749 @item
2750 @code{__attribute ((const))} and @code{noreturn} were mangled as type
2751 qualifiers, and @code{decltype} of a plain declaration was folded away.
2753 These mangling issues were fixed in @option{-fabi-version=5}.
2755 @item
2756 Scoped enumerators passed as arguments to a variadic function are
2757 promoted like unscoped enumerators, causing @code{va_arg} to complain.
2758 On most targets this does not actually affect the parameter passing
2759 ABI, as there is no way to pass an argument smaller than @code{int}.
2761 Also, the ABI changed the mangling of template argument packs,
2762 @code{const_cast}, @code{static_cast}, prefix increment/decrement, and
2763 a class scope function used as a template argument.
2765 These issues were corrected in @option{-fabi-version=6}.
2767 @item
2768 Lambdas in default argument scope were mangled incorrectly, and the
2769 ABI changed the mangling of @code{nullptr_t}.
2771 These issues were corrected in @option{-fabi-version=7}.
2773 @item
2774 When mangling a function type with function-cv-qualifiers, the
2775 un-qualified function type was incorrectly treated as a substitution
2776 candidate.
2778 This was fixed in @option{-fabi-version=8}, the default for GCC 5.1.
2780 @item
2781 @code{decltype(nullptr)} incorrectly had an alignment of 1, leading to
2782 unaligned accesses.  Note that this did not affect the ABI of a
2783 function with a @code{nullptr_t} parameter, as parameters have a
2784 minimum alignment.
2786 This was fixed in @option{-fabi-version=9}, the default for GCC 5.2.
2788 @item
2789 Target-specific attributes that affect the identity of a type, such as
2790 ia32 calling conventions on a function type (stdcall, regparm, etc.),
2791 did not affect the mangled name, leading to name collisions when
2792 function pointers were used as template arguments.
2794 This was fixed in @option{-fabi-version=10}, the default for GCC 6.1.
2796 @end itemize
2798 It also warns about psABI-related changes.  The known psABI changes at this
2799 point include:
2801 @itemize @bullet
2803 @item
2804 For SysV/x86-64, unions with @code{long double} members are 
2805 passed in memory as specified in psABI.  For example:
2807 @smallexample
2808 union U @{
2809   long double ld;
2810   int i;
2812 @end smallexample
2814 @noindent
2815 @code{union U} is always passed in memory.
2817 @end itemize
2819 @item -Wabi-tag @r{(C++ and Objective-C++ only)}
2820 @opindex Wabi-tag
2821 @opindex -Wabi-tag
2822 Warn when a type with an ABI tag is used in a context that does not
2823 have that ABI tag.  See @ref{C++ Attributes} for more information
2824 about ABI tags.
2826 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2827 @opindex Wctor-dtor-privacy
2828 @opindex Wno-ctor-dtor-privacy
2829 Warn when a class seems unusable because all the constructors or
2830 destructors in that class are private, and it has neither friends nor
2831 public static member functions.  Also warn if there are no non-private
2832 methods, and there's at least one private member function that isn't
2833 a constructor or destructor.
2835 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2836 @opindex Wdelete-non-virtual-dtor
2837 @opindex Wno-delete-non-virtual-dtor
2838 Warn when @code{delete} is used to destroy an instance of a class that
2839 has virtual functions and non-virtual destructor. It is unsafe to delete
2840 an instance of a derived class through a pointer to a base class if the
2841 base class does not have a virtual destructor.  This warning is enabled
2842 by @option{-Wall}.
2844 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2845 @opindex Wliteral-suffix
2846 @opindex Wno-literal-suffix
2847 Warn when a string or character literal is followed by a ud-suffix which does
2848 not begin with an underscore.  As a conforming extension, GCC treats such
2849 suffixes as separate preprocessing tokens in order to maintain backwards
2850 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2851 For example:
2853 @smallexample
2854 #define __STDC_FORMAT_MACROS
2855 #include <inttypes.h>
2856 #include <stdio.h>
2858 int main() @{
2859   int64_t i64 = 123;
2860   printf("My int64: %" PRId64"\n", i64);
2862 @end smallexample
2864 In this case, @code{PRId64} is treated as a separate preprocessing token.
2866 Additionally, warn when a user-defined literal operator is declared with
2867 a literal suffix identifier that doesn't begin with an underscore. Literal
2868 suffix identifiers that don't begin with an underscore are reserved for
2869 future standardization.
2871 This warning is enabled by default.
2873 @item -Wlto-type-mismatch
2874 @opindex Wlto-type-mismatch
2875 @opindex Wno-lto-type-mismatch
2877 During the link-time optimization warn about type mismatches in
2878 global declarations from different compilation units.
2879 Requires @option{-flto} to be enabled.  Enabled by default.
2881 @item -Wno-narrowing @r{(C++ and Objective-C++ only)}
2882 @opindex Wnarrowing
2883 @opindex Wno-narrowing
2884 For C++11 and later standards, narrowing conversions are diagnosed by default,
2885 as required by the standard.  A narrowing conversion from a constant produces
2886 an error, and a narrowing conversion from a non-constant produces a warning,
2887 but @option{-Wno-narrowing} suppresses the diagnostic.
2888 Note that this does not affect the meaning of well-formed code;
2889 narrowing conversions are still considered ill-formed in SFINAE contexts.
2891 With @option{-Wnarrowing} in C++98, warn when a narrowing
2892 conversion prohibited by C++11 occurs within
2893 @samp{@{ @}}, e.g.
2895 @smallexample
2896 int i = @{ 2.2 @}; // error: narrowing from double to int
2897 @end smallexample
2899 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2901 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2902 @opindex Wnoexcept
2903 @opindex Wno-noexcept
2904 Warn when a noexcept-expression evaluates to false because of a call
2905 to a function that does not have a non-throwing exception
2906 specification (i.e. @code{throw()} or @code{noexcept}) but is known by
2907 the compiler to never throw an exception.
2909 @item -Wnoexcept-type @r{(C++ and Objective-C++ only)}
2910 @opindex Wnoexcept-type
2911 @opindex Wno-noexcept-type
2912 Warn if the C++1z feature making @code{noexcept} part of a function
2913 type changes the mangled name of a symbol relative to C++14.  Enabled
2914 by @option{-Wabi} and @option{-Wc++1z-compat}.
2916 @smallexample
2917 template <class T> void f(T t) @{ t(); @};
2918 void g() noexcept;
2919 void h() @{ f(g); @} // in C++14 calls f<void(*)()>, in C++1z calls f<void(*)()noexcept>
2920 @end smallexample
2922 @item -Wclass-memaccess @r{(C++ and Objective-C++ only)}
2923 @opindex Wclass-memaccess
2924 Warn when the destination of a call to a raw memory function such as
2925 @code{memset} or @code{memcpy} is an object of class type writing into which
2926 might bypass the class non-trivial or deleted constructor or copy assignment,
2927 violate const-correctness or encapsulation, or corrupt the virtual table.
2928 Modifying the representation of such objects may violate invariants maintained
2929 by member functions of the class.  For example, the call to @code{memset}
2930 below is undefined becase it modifies a non-trivial class object and is,
2931 therefore, diagnosed.  The safe way to either initialize or clear the storage
2932 of objects of such types is by using the appropriate constructor or assignment
2933 operator, if one is available.
2934 @smallexample
2935 std::string str = "abc";
2936 memset (&str, 0, 3);
2937 @end smallexample
2938 The @option{-Wclass-memaccess} option is enabled by @option{-Wall}.
2940 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2941 @opindex Wnon-virtual-dtor
2942 @opindex Wno-non-virtual-dtor
2943 Warn when a class has virtual functions and an accessible non-virtual
2944 destructor itself or in an accessible polymorphic base class, in which
2945 case it is possible but unsafe to delete an instance of a derived
2946 class through a pointer to the class itself or base class.  This
2947 warning is automatically enabled if @option{-Weffc++} is specified.
2949 @item -Wregister @r{(C++ and Objective-C++ only)}
2950 @opindex Wregister
2951 @opindex Wno-register
2952 Warn on uses of the @code{register} storage class specifier, except
2953 when it is part of the GNU @ref{Explicit Register Variables} extension.
2954 The use of the @code{register} keyword as storage class specifier has
2955 been deprecated in C++11 and removed in C++17.
2956 Enabled by default with @option{-std=c++1z}.
2958 @item -Wreorder @r{(C++ and Objective-C++ only)}
2959 @opindex Wreorder
2960 @opindex Wno-reorder
2961 @cindex reordering, warning
2962 @cindex warning for reordering of member initializers
2963 Warn when the order of member initializers given in the code does not
2964 match the order in which they must be executed.  For instance:
2966 @smallexample
2967 struct A @{
2968   int i;
2969   int j;
2970   A(): j (0), i (1) @{ @}
2972 @end smallexample
2974 @noindent
2975 The compiler rearranges the member initializers for @code{i}
2976 and @code{j} to match the declaration order of the members, emitting
2977 a warning to that effect.  This warning is enabled by @option{-Wall}.
2979 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
2980 @opindex fext-numeric-literals
2981 @opindex fno-ext-numeric-literals
2982 Accept imaginary, fixed-point, or machine-defined
2983 literal number suffixes as GNU extensions.
2984 When this option is turned off these suffixes are treated
2985 as C++11 user-defined literal numeric suffixes.
2986 This is on by default for all pre-C++11 dialects and all GNU dialects:
2987 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
2988 @option{-std=gnu++14}.
2989 This option is off by default
2990 for ISO C++11 onwards (@option{-std=c++11}, ...).
2991 @end table
2993 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2995 @table @gcctabopt
2996 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2997 @opindex Weffc++
2998 @opindex Wno-effc++
2999 Warn about violations of the following style guidelines from Scott Meyers'
3000 @cite{Effective C++} series of books:
3002 @itemize @bullet
3003 @item
3004 Define a copy constructor and an assignment operator for classes
3005 with dynamically-allocated memory.
3007 @item
3008 Prefer initialization to assignment in constructors.
3010 @item
3011 Have @code{operator=} return a reference to @code{*this}.
3013 @item
3014 Don't try to return a reference when you must return an object.
3016 @item
3017 Distinguish between prefix and postfix forms of increment and
3018 decrement operators.
3020 @item
3021 Never overload @code{&&}, @code{||}, or @code{,}.
3023 @end itemize
3025 This option also enables @option{-Wnon-virtual-dtor}, which is also
3026 one of the effective C++ recommendations.  However, the check is
3027 extended to warn about the lack of virtual destructor in accessible
3028 non-polymorphic bases classes too.
3030 When selecting this option, be aware that the standard library
3031 headers do not obey all of these guidelines; use @samp{grep -v}
3032 to filter out those warnings.
3034 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
3035 @opindex Wstrict-null-sentinel
3036 @opindex Wno-strict-null-sentinel
3037 Warn about the use of an uncasted @code{NULL} as sentinel.  When
3038 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
3039 to @code{__null}.  Although it is a null pointer constant rather than a
3040 null pointer, it is guaranteed to be of the same size as a pointer.
3041 But this use is not portable across different compilers.
3043 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
3044 @opindex Wno-non-template-friend
3045 @opindex Wnon-template-friend
3046 Disable warnings when non-template friend functions are declared
3047 within a template.  In very old versions of GCC that predate implementation
3048 of the ISO standard, declarations such as 
3049 @samp{friend int foo(int)}, where the name of the friend is an unqualified-id,
3050 could be interpreted as a particular specialization of a template
3051 function; the warning exists to diagnose compatibility problems, 
3052 and is enabled by default.
3054 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
3055 @opindex Wold-style-cast
3056 @opindex Wno-old-style-cast
3057 Warn if an old-style (C-style) cast to a non-void type is used within
3058 a C++ program.  The new-style casts (@code{dynamic_cast},
3059 @code{static_cast}, @code{reinterpret_cast}, and @code{const_cast}) are
3060 less vulnerable to unintended effects and much easier to search for.
3062 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
3063 @opindex Woverloaded-virtual
3064 @opindex Wno-overloaded-virtual
3065 @cindex overloaded virtual function, warning
3066 @cindex warning for overloaded virtual function
3067 Warn when a function declaration hides virtual functions from a
3068 base class.  For example, in:
3070 @smallexample
3071 struct A @{
3072   virtual void f();
3075 struct B: public A @{
3076   void f(int);
3078 @end smallexample
3080 the @code{A} class version of @code{f} is hidden in @code{B}, and code
3081 like:
3083 @smallexample
3084 B* b;
3085 b->f();
3086 @end smallexample
3088 @noindent
3089 fails to compile.
3091 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
3092 @opindex Wno-pmf-conversions
3093 @opindex Wpmf-conversions
3094 Disable the diagnostic for converting a bound pointer to member function
3095 to a plain pointer.
3097 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
3098 @opindex Wsign-promo
3099 @opindex Wno-sign-promo
3100 Warn when overload resolution chooses a promotion from unsigned or
3101 enumerated type to a signed type, over a conversion to an unsigned type of
3102 the same size.  Previous versions of G++ tried to preserve
3103 unsignedness, but the standard mandates the current behavior.
3105 @item -Wtemplates @r{(C++ and Objective-C++ only)}
3106 @opindex Wtemplates
3107 Warn when a primary template declaration is encountered.  Some coding
3108 rules disallow templates, and this may be used to enforce that rule.
3109 The warning is inactive inside a system header file, such as the STL, so
3110 one can still use the STL.  One may also instantiate or specialize
3111 templates.
3113 @item -Wmultiple-inheritance @r{(C++ and Objective-C++ only)}
3114 @opindex Wmultiple-inheritance
3115 Warn when a class is defined with multiple direct base classes.  Some
3116 coding rules disallow multiple inheritance, and this may be used to
3117 enforce that rule.  The warning is inactive inside a system header file,
3118 such as the STL, so one can still use the STL.  One may also define
3119 classes that indirectly use multiple inheritance.
3121 @item -Wvirtual-inheritance
3122 @opindex Wvirtual-inheritance
3123 Warn when a class is defined with a virtual direct base class.  Some
3124 coding rules disallow multiple inheritance, and this may be used to
3125 enforce that rule.  The warning is inactive inside a system header file,
3126 such as the STL, so one can still use the STL.  One may also define
3127 classes that indirectly use virtual inheritance.
3129 @item -Wnamespaces
3130 @opindex Wnamespaces
3131 Warn when a namespace definition is opened.  Some coding rules disallow
3132 namespaces, and this may be used to enforce that rule.  The warning is
3133 inactive inside a system header file, such as the STL, so one can still
3134 use the STL.  One may also use using directives and qualified names.
3136 @item -Wno-terminate @r{(C++ and Objective-C++ only)}
3137 @opindex Wterminate
3138 @opindex Wno-terminate
3139 Disable the warning about a throw-expression that will immediately
3140 result in a call to @code{terminate}.
3141 @end table
3143 @node Objective-C and Objective-C++ Dialect Options
3144 @section Options Controlling Objective-C and Objective-C++ Dialects
3146 @cindex compiler options, Objective-C and Objective-C++
3147 @cindex Objective-C and Objective-C++ options, command-line
3148 @cindex options, Objective-C and Objective-C++
3149 (NOTE: This manual does not describe the Objective-C and Objective-C++
3150 languages themselves.  @xref{Standards,,Language Standards
3151 Supported by GCC}, for references.)
3153 This section describes the command-line options that are only meaningful
3154 for Objective-C and Objective-C++ programs.  You can also use most of
3155 the language-independent GNU compiler options.
3156 For example, you might compile a file @file{some_class.m} like this:
3158 @smallexample
3159 gcc -g -fgnu-runtime -O -c some_class.m
3160 @end smallexample
3162 @noindent
3163 In this example, @option{-fgnu-runtime} is an option meant only for
3164 Objective-C and Objective-C++ programs; you can use the other options with
3165 any language supported by GCC@.
3167 Note that since Objective-C is an extension of the C language, Objective-C
3168 compilations may also use options specific to the C front-end (e.g.,
3169 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
3170 C++-specific options (e.g., @option{-Wabi}).
3172 Here is a list of options that are @emph{only} for compiling Objective-C
3173 and Objective-C++ programs:
3175 @table @gcctabopt
3176 @item -fconstant-string-class=@var{class-name}
3177 @opindex fconstant-string-class
3178 Use @var{class-name} as the name of the class to instantiate for each
3179 literal string specified with the syntax @code{@@"@dots{}"}.  The default
3180 class name is @code{NXConstantString} if the GNU runtime is being used, and
3181 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
3182 @option{-fconstant-cfstrings} option, if also present, overrides the
3183 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
3184 to be laid out as constant CoreFoundation strings.
3186 @item -fgnu-runtime
3187 @opindex fgnu-runtime
3188 Generate object code compatible with the standard GNU Objective-C
3189 runtime.  This is the default for most types of systems.
3191 @item -fnext-runtime
3192 @opindex fnext-runtime
3193 Generate output compatible with the NeXT runtime.  This is the default
3194 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
3195 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
3196 used.
3198 @item -fno-nil-receivers
3199 @opindex fno-nil-receivers
3200 Assume that all Objective-C message dispatches (@code{[receiver
3201 message:arg]}) in this translation unit ensure that the receiver is
3202 not @code{nil}.  This allows for more efficient entry points in the
3203 runtime to be used.  This option is only available in conjunction with
3204 the NeXT runtime and ABI version 0 or 1.
3206 @item -fobjc-abi-version=@var{n}
3207 @opindex fobjc-abi-version
3208 Use version @var{n} of the Objective-C ABI for the selected runtime.
3209 This option is currently supported only for the NeXT runtime.  In that
3210 case, Version 0 is the traditional (32-bit) ABI without support for
3211 properties and other Objective-C 2.0 additions.  Version 1 is the
3212 traditional (32-bit) ABI with support for properties and other
3213 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
3214 nothing is specified, the default is Version 0 on 32-bit target
3215 machines, and Version 2 on 64-bit target machines.
3217 @item -fobjc-call-cxx-cdtors
3218 @opindex fobjc-call-cxx-cdtors
3219 For each Objective-C class, check if any of its instance variables is a
3220 C++ object with a non-trivial default constructor.  If so, synthesize a
3221 special @code{- (id) .cxx_construct} instance method which runs
3222 non-trivial default constructors on any such instance variables, in order,
3223 and then return @code{self}.  Similarly, check if any instance variable
3224 is a C++ object with a non-trivial destructor, and if so, synthesize a
3225 special @code{- (void) .cxx_destruct} method which runs
3226 all such default destructors, in reverse order.
3228 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
3229 methods thusly generated only operate on instance variables
3230 declared in the current Objective-C class, and not those inherited
3231 from superclasses.  It is the responsibility of the Objective-C
3232 runtime to invoke all such methods in an object's inheritance
3233 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
3234 by the runtime immediately after a new object instance is allocated;
3235 the @code{- (void) .cxx_destruct} methods are invoked immediately
3236 before the runtime deallocates an object instance.
3238 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
3239 support for invoking the @code{- (id) .cxx_construct} and
3240 @code{- (void) .cxx_destruct} methods.
3242 @item -fobjc-direct-dispatch
3243 @opindex fobjc-direct-dispatch
3244 Allow fast jumps to the message dispatcher.  On Darwin this is
3245 accomplished via the comm page.
3247 @item -fobjc-exceptions
3248 @opindex fobjc-exceptions
3249 Enable syntactic support for structured exception handling in
3250 Objective-C, similar to what is offered by C++.  This option
3251 is required to use the Objective-C keywords @code{@@try},
3252 @code{@@throw}, @code{@@catch}, @code{@@finally} and
3253 @code{@@synchronized}.  This option is available with both the GNU
3254 runtime and the NeXT runtime (but not available in conjunction with
3255 the NeXT runtime on Mac OS X 10.2 and earlier).
3257 @item -fobjc-gc
3258 @opindex fobjc-gc
3259 Enable garbage collection (GC) in Objective-C and Objective-C++
3260 programs.  This option is only available with the NeXT runtime; the
3261 GNU runtime has a different garbage collection implementation that
3262 does not require special compiler flags.
3264 @item -fobjc-nilcheck
3265 @opindex fobjc-nilcheck
3266 For the NeXT runtime with version 2 of the ABI, check for a nil
3267 receiver in method invocations before doing the actual method call.
3268 This is the default and can be disabled using
3269 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
3270 checked for nil in this way no matter what this flag is set to.
3271 Currently this flag does nothing when the GNU runtime, or an older
3272 version of the NeXT runtime ABI, is used.
3274 @item -fobjc-std=objc1
3275 @opindex fobjc-std
3276 Conform to the language syntax of Objective-C 1.0, the language
3277 recognized by GCC 4.0.  This only affects the Objective-C additions to
3278 the C/C++ language; it does not affect conformance to C/C++ standards,
3279 which is controlled by the separate C/C++ dialect option flags.  When
3280 this option is used with the Objective-C or Objective-C++ compiler,
3281 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
3282 This is useful if you need to make sure that your Objective-C code can
3283 be compiled with older versions of GCC@.
3285 @item -freplace-objc-classes
3286 @opindex freplace-objc-classes
3287 Emit a special marker instructing @command{ld(1)} not to statically link in
3288 the resulting object file, and allow @command{dyld(1)} to load it in at
3289 run time instead.  This is used in conjunction with the Fix-and-Continue
3290 debugging mode, where the object file in question may be recompiled and
3291 dynamically reloaded in the course of program execution, without the need
3292 to restart the program itself.  Currently, Fix-and-Continue functionality
3293 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
3294 and later.
3296 @item -fzero-link
3297 @opindex fzero-link
3298 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
3299 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
3300 compile time) with static class references that get initialized at load time,
3301 which improves run-time performance.  Specifying the @option{-fzero-link} flag
3302 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
3303 to be retained.  This is useful in Zero-Link debugging mode, since it allows
3304 for individual class implementations to be modified during program execution.
3305 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
3306 regardless of command-line options.
3308 @item -fno-local-ivars
3309 @opindex fno-local-ivars
3310 @opindex flocal-ivars
3311 By default instance variables in Objective-C can be accessed as if
3312 they were local variables from within the methods of the class they're
3313 declared in.  This can lead to shadowing between instance variables
3314 and other variables declared either locally inside a class method or
3315 globally with the same name.  Specifying the @option{-fno-local-ivars}
3316 flag disables this behavior thus avoiding variable shadowing issues.
3318 @item -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]}
3319 @opindex fivar-visibility
3320 Set the default instance variable visibility to the specified option
3321 so that instance variables declared outside the scope of any access
3322 modifier directives default to the specified visibility.
3324 @item -gen-decls
3325 @opindex gen-decls
3326 Dump interface declarations for all classes seen in the source file to a
3327 file named @file{@var{sourcename}.decl}.
3329 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
3330 @opindex Wassign-intercept
3331 @opindex Wno-assign-intercept
3332 Warn whenever an Objective-C assignment is being intercepted by the
3333 garbage collector.
3335 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
3336 @opindex Wno-protocol
3337 @opindex Wprotocol
3338 If a class is declared to implement a protocol, a warning is issued for
3339 every method in the protocol that is not implemented by the class.  The
3340 default behavior is to issue a warning for every method not explicitly
3341 implemented in the class, even if a method implementation is inherited
3342 from the superclass.  If you use the @option{-Wno-protocol} option, then
3343 methods inherited from the superclass are considered to be implemented,
3344 and no warning is issued for them.
3346 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3347 @opindex Wselector
3348 @opindex Wno-selector
3349 Warn if multiple methods of different types for the same selector are
3350 found during compilation.  The check is performed on the list of methods
3351 in the final stage of compilation.  Additionally, a check is performed
3352 for each selector appearing in a @code{@@selector(@dots{})}
3353 expression, and a corresponding method for that selector has been found
3354 during compilation.  Because these checks scan the method table only at
3355 the end of compilation, these warnings are not produced if the final
3356 stage of compilation is not reached, for example because an error is
3357 found during compilation, or because the @option{-fsyntax-only} option is
3358 being used.
3360 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3361 @opindex Wstrict-selector-match
3362 @opindex Wno-strict-selector-match
3363 Warn if multiple methods with differing argument and/or return types are
3364 found for a given selector when attempting to send a message using this
3365 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3366 is off (which is the default behavior), the compiler omits such warnings
3367 if any differences found are confined to types that share the same size
3368 and alignment.
3370 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3371 @opindex Wundeclared-selector
3372 @opindex Wno-undeclared-selector
3373 Warn if a @code{@@selector(@dots{})} expression referring to an
3374 undeclared selector is found.  A selector is considered undeclared if no
3375 method with that name has been declared before the
3376 @code{@@selector(@dots{})} expression, either explicitly in an
3377 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3378 an @code{@@implementation} section.  This option always performs its
3379 checks as soon as a @code{@@selector(@dots{})} expression is found,
3380 while @option{-Wselector} only performs its checks in the final stage of
3381 compilation.  This also enforces the coding style convention
3382 that methods and selectors must be declared before being used.
3384 @item -print-objc-runtime-info
3385 @opindex print-objc-runtime-info
3386 Generate C header describing the largest structure that is passed by
3387 value, if any.
3389 @end table
3391 @node Diagnostic Message Formatting Options
3392 @section Options to Control Diagnostic Messages Formatting
3393 @cindex options to control diagnostics formatting
3394 @cindex diagnostic messages
3395 @cindex message formatting
3397 Traditionally, diagnostic messages have been formatted irrespective of
3398 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3399 options described below
3400 to control the formatting algorithm for diagnostic messages, 
3401 e.g.@: how many characters per line, how often source location
3402 information should be reported.  Note that some language front ends may not
3403 honor these options.
3405 @table @gcctabopt
3406 @item -fmessage-length=@var{n}
3407 @opindex fmessage-length
3408 Try to format error messages so that they fit on lines of about
3409 @var{n} characters.  If @var{n} is zero, then no line-wrapping is
3410 done; each error message appears on a single line.  This is the
3411 default for all front ends.
3413 @item -fdiagnostics-show-location=once
3414 @opindex fdiagnostics-show-location
3415 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3416 reporter to emit source location information @emph{once}; that is, in
3417 case the message is too long to fit on a single physical line and has to
3418 be wrapped, the source location won't be emitted (as prefix) again,
3419 over and over, in subsequent continuation lines.  This is the default
3420 behavior.
3422 @item -fdiagnostics-show-location=every-line
3423 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3424 messages reporter to emit the same source location information (as
3425 prefix) for physical lines that result from the process of breaking
3426 a message which is too long to fit on a single line.
3428 @item -fdiagnostics-color[=@var{WHEN}]
3429 @itemx -fno-diagnostics-color
3430 @opindex fdiagnostics-color
3431 @cindex highlight, color
3432 @vindex GCC_COLORS @r{environment variable}
3433 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3434 or @samp{auto}.  The default depends on how the compiler has been configured,
3435 it can be any of the above @var{WHEN} options or also @samp{never}
3436 if @env{GCC_COLORS} environment variable isn't present in the environment,
3437 and @samp{auto} otherwise.
3438 @samp{auto} means to use color only when the standard error is a terminal.
3439 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3440 aliases for @option{-fdiagnostics-color=always} and
3441 @option{-fdiagnostics-color=never}, respectively.
3443 The colors are defined by the environment variable @env{GCC_COLORS}.
3444 Its value is a colon-separated list of capabilities and Select Graphic
3445 Rendition (SGR) substrings. SGR commands are interpreted by the
3446 terminal or terminal emulator.  (See the section in the documentation
3447 of your text terminal for permitted values and their meanings as
3448 character attributes.)  These substring values are integers in decimal
3449 representation and can be concatenated with semicolons.
3450 Common values to concatenate include
3451 @samp{1} for bold,
3452 @samp{4} for underline,
3453 @samp{5} for blink,
3454 @samp{7} for inverse,
3455 @samp{39} for default foreground color,
3456 @samp{30} to @samp{37} for foreground colors,
3457 @samp{90} to @samp{97} for 16-color mode foreground colors,
3458 @samp{38;5;0} to @samp{38;5;255}
3459 for 88-color and 256-color modes foreground colors,
3460 @samp{49} for default background color,
3461 @samp{40} to @samp{47} for background colors,
3462 @samp{100} to @samp{107} for 16-color mode background colors,
3463 and @samp{48;5;0} to @samp{48;5;255}
3464 for 88-color and 256-color modes background colors.
3466 The default @env{GCC_COLORS} is
3467 @smallexample
3468 error=01;31:warning=01;35:note=01;36:range1=32:range2=34:locus=01:\
3469 quote=01:fixit-insert=32:fixit-delete=31:\
3470 diff-filename=01:diff-hunk=32:diff-delete=31:diff-insert=32:\
3471 type-diff=01;32
3472 @end smallexample
3473 @noindent
3474 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3475 @samp{01;36} is bold cyan, @samp{32} is green, @samp{34} is blue,
3476 @samp{01} is bold, and @samp{31} is red.
3477 Setting @env{GCC_COLORS} to the empty string disables colors.
3478 Supported capabilities are as follows.
3480 @table @code
3481 @item error=
3482 @vindex error GCC_COLORS @r{capability}
3483 SGR substring for error: markers.
3485 @item warning=
3486 @vindex warning GCC_COLORS @r{capability}
3487 SGR substring for warning: markers.
3489 @item note=
3490 @vindex note GCC_COLORS @r{capability}
3491 SGR substring for note: markers.
3493 @item range1=
3494 @vindex range1 GCC_COLORS @r{capability}
3495 SGR substring for first additional range.
3497 @item range2=
3498 @vindex range2 GCC_COLORS @r{capability}
3499 SGR substring for second additional range.
3501 @item locus=
3502 @vindex locus GCC_COLORS @r{capability}
3503 SGR substring for location information, @samp{file:line} or
3504 @samp{file:line:column} etc.
3506 @item quote=
3507 @vindex quote GCC_COLORS @r{capability}
3508 SGR substring for information printed within quotes.
3510 @item fixit-insert=
3511 @vindex fixit-insert GCC_COLORS @r{capability}
3512 SGR substring for fix-it hints suggesting text to
3513 be inserted or replaced.
3515 @item fixit-delete=
3516 @vindex fixit-delete GCC_COLORS @r{capability}
3517 SGR substring for fix-it hints suggesting text to
3518 be deleted.
3520 @item diff-filename=
3521 @vindex diff-filename GCC_COLORS @r{capability}
3522 SGR substring for filename headers within generated patches.
3524 @item diff-hunk=
3525 @vindex diff-hunk GCC_COLORS @r{capability}
3526 SGR substring for the starts of hunks within generated patches.
3528 @item diff-delete=
3529 @vindex diff-delete GCC_COLORS @r{capability}
3530 SGR substring for deleted lines within generated patches.
3532 @item diff-insert=
3533 @vindex diff-insert GCC_COLORS @r{capability}
3534 SGR substring for inserted lines within generated patches.
3536 @item type-diff=
3537 @vindex type-diff GCC_COLORS @r{capability}
3538 SGR substring for highlighting mismatching types within template
3539 arguments in the C++ frontend.
3540 @end table
3542 @item -fno-diagnostics-show-option
3543 @opindex fno-diagnostics-show-option
3544 @opindex fdiagnostics-show-option
3545 By default, each diagnostic emitted includes text indicating the
3546 command-line option that directly controls the diagnostic (if such an
3547 option is known to the diagnostic machinery).  Specifying the
3548 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3550 @item -fno-diagnostics-show-caret
3551 @opindex fno-diagnostics-show-caret
3552 @opindex fdiagnostics-show-caret
3553 By default, each diagnostic emitted includes the original source line
3554 and a caret @samp{^} indicating the column.  This option suppresses this
3555 information.  The source line is truncated to @var{n} characters, if
3556 the @option{-fmessage-length=n} option is given.  When the output is done
3557 to the terminal, the width is limited to the width given by the
3558 @env{COLUMNS} environment variable or, if not set, to the terminal width.
3560 @item -fdiagnostics-parseable-fixits
3561 @opindex fdiagnostics-parseable-fixits
3562 Emit fix-it hints in a machine-parseable format, suitable for consumption
3563 by IDEs.  For each fix-it, a line will be printed after the relevant
3564 diagnostic, starting with the string ``fix-it:''.  For example:
3566 @smallexample
3567 fix-it:"test.c":@{45:3-45:21@}:"gtk_widget_show_all"
3568 @end smallexample
3570 The location is expressed as a half-open range, expressed as a count of
3571 bytes, starting at byte 1 for the initial column.  In the above example,
3572 bytes 3 through 20 of line 45 of ``test.c'' are to be replaced with the
3573 given string:
3575 @smallexample
3576 00000000011111111112222222222
3577 12345678901234567890123456789
3578   gtk_widget_showall (dlg);
3579   ^^^^^^^^^^^^^^^^^^
3580   gtk_widget_show_all
3581 @end smallexample
3583 The filename and replacement string escape backslash as ``\\", tab as ``\t'',
3584 newline as ``\n'', double quotes as ``\"'', non-printable characters as octal
3585 (e.g. vertical tab as ``\013'').
3587 An empty replacement string indicates that the given range is to be removed.
3588 An empty range (e.g. ``45:3-45:3'') indicates that the string is to
3589 be inserted at the given position.
3591 @item -fdiagnostics-generate-patch
3592 @opindex fdiagnostics-generate-patch
3593 Print fix-it hints to stderr in unified diff format, after any diagnostics
3594 are printed.  For example:
3596 @smallexample
3597 --- test.c
3598 +++ test.c
3599 @@ -42,5 +42,5 @@
3601  void show_cb(GtkDialog *dlg)
3602  @{
3603 -  gtk_widget_showall(dlg);
3604 +  gtk_widget_show_all(dlg);
3605  @}
3607 @end smallexample
3609 The diff may or may not be colorized, following the same rules
3610 as for diagnostics (see @option{-fdiagnostics-color}).
3612 @item -fdiagnostics-show-template-tree
3613 @opindex fdiagnostics-show-template-tree
3615 In the C++ frontend, when printing diagnostics showing mismatching
3616 template types, such as:
3618 @smallexample
3619   could not convert 'std::map<int, std::vector<double> >()'
3620     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3621 @end smallexample
3623 the @option{-fdiagnostics-show-template-tree} flag enables printing a
3624 tree-like structure showing the common and differing parts of the types,
3625 such as:
3627 @smallexample
3628   map<
3629     [...],
3630     vector<
3631       [double != float]>>
3632 @end smallexample
3634 The parts that differ are highlighted with color (``double'' and
3635 ``float'' in this case).
3637 @item -fno-elide-type
3638 @opindex fno-elide-type
3639 @opindex felide-type
3640 By default when the C++ frontend prints diagnostics showing mismatching
3641 template types, common parts of the types are printed as ``[...]'' to
3642 simplify the error message.  For example:
3644 @smallexample
3645   could not convert 'std::map<int, std::vector<double> >()'
3646     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3647 @end smallexample
3649 Specifying the @option{-fno-elide-type} flag suppresses that behavior.
3650 This flag also affects the output of the
3651 @option{-fdiagnostics-show-template-tree} flag.
3653 @item -fno-show-column
3654 @opindex fno-show-column
3655 Do not print column numbers in diagnostics.  This may be necessary if
3656 diagnostics are being scanned by a program that does not understand the
3657 column numbers, such as @command{dejagnu}.
3659 @end table
3661 @node Warning Options
3662 @section Options to Request or Suppress Warnings
3663 @cindex options to control warnings
3664 @cindex warning messages
3665 @cindex messages, warning
3666 @cindex suppressing warnings
3668 Warnings are diagnostic messages that report constructions that
3669 are not inherently erroneous but that are risky or suggest there
3670 may have been an error.
3672 The following language-independent options do not enable specific
3673 warnings but control the kinds of diagnostics produced by GCC@.
3675 @table @gcctabopt
3676 @cindex syntax checking
3677 @item -fsyntax-only
3678 @opindex fsyntax-only
3679 Check the code for syntax errors, but don't do anything beyond that.
3681 @item -fmax-errors=@var{n}
3682 @opindex fmax-errors
3683 Limits the maximum number of error messages to @var{n}, at which point
3684 GCC bails out rather than attempting to continue processing the source
3685 code.  If @var{n} is 0 (the default), there is no limit on the number
3686 of error messages produced.  If @option{-Wfatal-errors} is also
3687 specified, then @option{-Wfatal-errors} takes precedence over this
3688 option.
3690 @item -w
3691 @opindex w
3692 Inhibit all warning messages.
3694 @item -Werror
3695 @opindex Werror
3696 @opindex Wno-error
3697 Make all warnings into errors.
3699 @item -Werror=
3700 @opindex Werror=
3701 @opindex Wno-error=
3702 Make the specified warning into an error.  The specifier for a warning
3703 is appended; for example @option{-Werror=switch} turns the warnings
3704 controlled by @option{-Wswitch} into errors.  This switch takes a
3705 negative form, to be used to negate @option{-Werror} for specific
3706 warnings; for example @option{-Wno-error=switch} makes
3707 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3708 is in effect.
3710 The warning message for each controllable warning includes the
3711 option that controls the warning.  That option can then be used with
3712 @option{-Werror=} and @option{-Wno-error=} as described above.
3713 (Printing of the option in the warning message can be disabled using the
3714 @option{-fno-diagnostics-show-option} flag.)
3716 Note that specifying @option{-Werror=}@var{foo} automatically implies
3717 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3718 imply anything.
3720 @item -Wfatal-errors
3721 @opindex Wfatal-errors
3722 @opindex Wno-fatal-errors
3723 This option causes the compiler to abort compilation on the first error
3724 occurred rather than trying to keep going and printing further error
3725 messages.
3727 @end table
3729 You can request many specific warnings with options beginning with
3730 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3731 implicit declarations.  Each of these specific warning options also
3732 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3733 example, @option{-Wno-implicit}.  This manual lists only one of the
3734 two forms, whichever is not the default.  For further
3735 language-specific options also refer to @ref{C++ Dialect Options} and
3736 @ref{Objective-C and Objective-C++ Dialect Options}.
3738 Some options, such as @option{-Wall} and @option{-Wextra}, turn on other
3739 options, such as @option{-Wunused}, which may turn on further options,
3740 such as @option{-Wunused-value}. The combined effect of positive and
3741 negative forms is that more specific options have priority over less
3742 specific ones, independently of their position in the command-line. For
3743 options of the same specificity, the last one takes effect. Options
3744 enabled or disabled via pragmas (@pxref{Diagnostic Pragmas}) take effect
3745 as if they appeared at the end of the command-line.
3747 When an unrecognized warning option is requested (e.g.,
3748 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3749 that the option is not recognized.  However, if the @option{-Wno-} form
3750 is used, the behavior is slightly different: no diagnostic is
3751 produced for @option{-Wno-unknown-warning} unless other diagnostics
3752 are being produced.  This allows the use of new @option{-Wno-} options
3753 with old compilers, but if something goes wrong, the compiler
3754 warns that an unrecognized option is present.
3756 @table @gcctabopt
3757 @item -Wpedantic
3758 @itemx -pedantic
3759 @opindex pedantic
3760 @opindex Wpedantic
3761 Issue all the warnings demanded by strict ISO C and ISO C++;
3762 reject all programs that use forbidden extensions, and some other
3763 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3764 version of the ISO C standard specified by any @option{-std} option used.
3766 Valid ISO C and ISO C++ programs should compile properly with or without
3767 this option (though a rare few require @option{-ansi} or a
3768 @option{-std} option specifying the required version of ISO C)@.  However,
3769 without this option, certain GNU extensions and traditional C and C++
3770 features are supported as well.  With this option, they are rejected.
3772 @option{-Wpedantic} does not cause warning messages for use of the
3773 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3774 warnings are also disabled in the expression that follows
3775 @code{__extension__}.  However, only system header files should use
3776 these escape routes; application programs should avoid them.
3777 @xref{Alternate Keywords}.
3779 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3780 C conformance.  They soon find that it does not do quite what they want:
3781 it finds some non-ISO practices, but not all---only those for which
3782 ISO C @emph{requires} a diagnostic, and some others for which
3783 diagnostics have been added.
3785 A feature to report any failure to conform to ISO C might be useful in
3786 some instances, but would require considerable additional work and would
3787 be quite different from @option{-Wpedantic}.  We don't have plans to
3788 support such a feature in the near future.
3790 Where the standard specified with @option{-std} represents a GNU
3791 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3792 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3793 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3794 where they are required by the base standard.  (It does not make sense
3795 for such warnings to be given only for features not in the specified GNU
3796 C dialect, since by definition the GNU dialects of C include all
3797 features the compiler supports with the given option, and there would be
3798 nothing to warn about.)
3800 @item -pedantic-errors
3801 @opindex pedantic-errors
3802 Give an error whenever the @dfn{base standard} (see @option{-Wpedantic})
3803 requires a diagnostic, in some cases where there is undefined behavior
3804 at compile-time and in some other cases that do not prevent compilation
3805 of programs that are valid according to the standard. This is not
3806 equivalent to @option{-Werror=pedantic}, since there are errors enabled
3807 by this option and not enabled by the latter and vice versa.
3809 @item -Wall
3810 @opindex Wall
3811 @opindex Wno-all
3812 This enables all the warnings about constructions that some users
3813 consider questionable, and that are easy to avoid (or modify to
3814 prevent the warning), even in conjunction with macros.  This also
3815 enables some language-specific warnings described in @ref{C++ Dialect
3816 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3818 @option{-Wall} turns on the following warning flags:
3820 @gccoptlist{-Waddress   @gol
3821 -Warray-bounds=1 @r{(only with} @option{-O2}@r{)}  @gol
3822 -Wbool-compare  @gol
3823 -Wbool-operation  @gol
3824 -Wc++11-compat  -Wc++14-compat  @gol
3825 -Wcatch-value @r{(C++ and Objective-C++ only)}  @gol
3826 -Wchar-subscripts  @gol
3827 -Wcomment  @gol
3828 -Wduplicate-decl-specifier @r{(C and Objective-C only)} @gol
3829 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3830 -Wformat   @gol
3831 -Wint-in-bool-context  @gol
3832 -Wimplicit @r{(C and Objective-C only)} @gol
3833 -Wimplicit-int @r{(C and Objective-C only)} @gol
3834 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3835 -Winit-self @r{(only for C++)} @gol
3836 -Wlogical-not-parentheses @gol
3837 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3838 -Wmaybe-uninitialized @gol
3839 -Wmemset-elt-size @gol
3840 -Wmemset-transposed-args @gol
3841 -Wmisleading-indentation @r{(only for C/C++)} @gol
3842 -Wmissing-braces @r{(only for C/ObjC)} @gol
3843 -Wmultistatement-macros  @gol
3844 -Wnarrowing @r{(only for C++)}  @gol
3845 -Wnonnull  @gol
3846 -Wnonnull-compare  @gol
3847 -Wopenmp-simd @gol
3848 -Wparentheses  @gol
3849 -Wpointer-sign  @gol
3850 -Wreorder   @gol
3851 -Wreturn-type  @gol
3852 -Wsequence-point  @gol
3853 -Wsign-compare @r{(only in C++)}  @gol
3854 -Wsizeof-pointer-div @gol
3855 -Wsizeof-pointer-memaccess @gol
3856 -Wstrict-aliasing  @gol
3857 -Wstrict-overflow=1  @gol
3858 -Wswitch  @gol
3859 -Wtautological-compare  @gol
3860 -Wtrigraphs  @gol
3861 -Wuninitialized  @gol
3862 -Wunknown-pragmas  @gol
3863 -Wunused-function  @gol
3864 -Wunused-label     @gol
3865 -Wunused-value     @gol
3866 -Wunused-variable  @gol
3867 -Wvolatile-register-var @gol
3870 Note that some warning flags are not implied by @option{-Wall}.  Some of
3871 them warn about constructions that users generally do not consider
3872 questionable, but which occasionally you might wish to check for;
3873 others warn about constructions that are necessary or hard to avoid in
3874 some cases, and there is no simple way to modify the code to suppress
3875 the warning. Some of them are enabled by @option{-Wextra} but many of
3876 them must be enabled individually.
3878 @item -Wextra
3879 @opindex W
3880 @opindex Wextra
3881 @opindex Wno-extra
3882 This enables some extra warning flags that are not enabled by
3883 @option{-Wall}. (This option used to be called @option{-W}.  The older
3884 name is still supported, but the newer name is more descriptive.)
3886 @gccoptlist{-Wclobbered  @gol
3887 -Wempty-body  @gol
3888 -Wignored-qualifiers @gol
3889 -Wimplicit-fallthrough=3 @gol
3890 -Wmissing-field-initializers  @gol
3891 -Wmissing-parameter-type @r{(C only)}  @gol
3892 -Wold-style-declaration @r{(C only)}  @gol
3893 -Woverride-init  @gol
3894 -Wsign-compare @r{(C only)} @gol
3895 -Wtype-limits  @gol
3896 -Wuninitialized  @gol
3897 -Wshift-negative-value @r{(in C++03 and in C99 and newer)}  @gol
3898 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3899 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3902 The option @option{-Wextra} also prints warning messages for the
3903 following cases:
3905 @itemize @bullet
3907 @item
3908 A pointer is compared against integer zero with @code{<}, @code{<=},
3909 @code{>}, or @code{>=}.
3911 @item
3912 (C++ only) An enumerator and a non-enumerator both appear in a
3913 conditional expression.
3915 @item
3916 (C++ only) Ambiguous virtual bases.
3918 @item
3919 (C++ only) Subscripting an array that has been declared @code{register}.
3921 @item
3922 (C++ only) Taking the address of a variable that has been declared
3923 @code{register}.
3925 @item
3926 (C++ only) A base class is not initialized in the copy constructor
3927 of a derived class.
3929 @end itemize
3931 @item -Wchar-subscripts
3932 @opindex Wchar-subscripts
3933 @opindex Wno-char-subscripts
3934 Warn if an array subscript has type @code{char}.  This is a common cause
3935 of error, as programmers often forget that this type is signed on some
3936 machines.
3937 This warning is enabled by @option{-Wall}.
3939 @item -Wchkp
3940 @opindex Wchkp
3941 Warn about an invalid memory access that is found by Pointer Bounds Checker
3942 (@option{-fcheck-pointer-bounds}).
3944 @item -Wno-coverage-mismatch
3945 @opindex Wno-coverage-mismatch
3946 Warn if feedback profiles do not match when using the
3947 @option{-fprofile-use} option.
3948 If a source file is changed between compiling with @option{-fprofile-gen} and
3949 with @option{-fprofile-use}, the files with the profile feedback can fail
3950 to match the source file and GCC cannot use the profile feedback
3951 information.  By default, this warning is enabled and is treated as an
3952 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3953 warning or @option{-Wno-error=coverage-mismatch} can be used to
3954 disable the error.  Disabling the error for this warning can result in
3955 poorly optimized code and is useful only in the
3956 case of very minor changes such as bug fixes to an existing code-base.
3957 Completely disabling the warning is not recommended.
3959 @item -Wno-cpp
3960 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3962 Suppress warning messages emitted by @code{#warning} directives.
3964 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3965 @opindex Wdouble-promotion
3966 @opindex Wno-double-promotion
3967 Give a warning when a value of type @code{float} is implicitly
3968 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
3969 floating-point unit implement @code{float} in hardware, but emulate
3970 @code{double} in software.  On such a machine, doing computations
3971 using @code{double} values is much more expensive because of the
3972 overhead required for software emulation.
3974 It is easy to accidentally do computations with @code{double} because
3975 floating-point literals are implicitly of type @code{double}.  For
3976 example, in:
3977 @smallexample
3978 @group
3979 float area(float radius)
3981    return 3.14159 * radius * radius;
3983 @end group
3984 @end smallexample
3985 the compiler performs the entire computation with @code{double}
3986 because the floating-point literal is a @code{double}.
3988 @item -Wduplicate-decl-specifier @r{(C and Objective-C only)}
3989 @opindex Wduplicate-decl-specifier
3990 @opindex Wno-duplicate-decl-specifier
3991 Warn if a declaration has duplicate @code{const}, @code{volatile},
3992 @code{restrict} or @code{_Atomic} specifier.  This warning is enabled by
3993 @option{-Wall}.
3995 @item -Wformat
3996 @itemx -Wformat=@var{n}
3997 @opindex Wformat
3998 @opindex Wno-format
3999 @opindex ffreestanding
4000 @opindex fno-builtin
4001 @opindex Wformat=
4002 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
4003 the arguments supplied have types appropriate to the format string
4004 specified, and that the conversions specified in the format string make
4005 sense.  This includes standard functions, and others specified by format
4006 attributes (@pxref{Function Attributes}), in the @code{printf},
4007 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
4008 not in the C standard) families (or other target-specific families).
4009 Which functions are checked without format attributes having been
4010 specified depends on the standard version selected, and such checks of
4011 functions without the attribute specified are disabled by
4012 @option{-ffreestanding} or @option{-fno-builtin}.
4014 The formats are checked against the format features supported by GNU
4015 libc version 2.2.  These include all ISO C90 and C99 features, as well
4016 as features from the Single Unix Specification and some BSD and GNU
4017 extensions.  Other library implementations may not support all these
4018 features; GCC does not support warning about features that go beyond a
4019 particular library's limitations.  However, if @option{-Wpedantic} is used
4020 with @option{-Wformat}, warnings are given about format features not
4021 in the selected standard version (but not for @code{strfmon} formats,
4022 since those are not in any version of the C standard).  @xref{C Dialect
4023 Options,,Options Controlling C Dialect}.
4025 @table @gcctabopt
4026 @item -Wformat=1
4027 @itemx -Wformat
4028 @opindex Wformat
4029 @opindex Wformat=1
4030 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
4031 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
4032 @option{-Wformat} also checks for null format arguments for several
4033 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
4034 aspects of this level of format checking can be disabled by the
4035 options: @option{-Wno-format-contains-nul},
4036 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
4037 @option{-Wformat} is enabled by @option{-Wall}.
4039 @item -Wno-format-contains-nul
4040 @opindex Wno-format-contains-nul
4041 @opindex Wformat-contains-nul
4042 If @option{-Wformat} is specified, do not warn about format strings that
4043 contain NUL bytes.
4045 @item -Wno-format-extra-args
4046 @opindex Wno-format-extra-args
4047 @opindex Wformat-extra-args
4048 If @option{-Wformat} is specified, do not warn about excess arguments to a
4049 @code{printf} or @code{scanf} format function.  The C standard specifies
4050 that such arguments are ignored.
4052 Where the unused arguments lie between used arguments that are
4053 specified with @samp{$} operand number specifications, normally
4054 warnings are still given, since the implementation could not know what
4055 type to pass to @code{va_arg} to skip the unused arguments.  However,
4056 in the case of @code{scanf} formats, this option suppresses the
4057 warning if the unused arguments are all pointers, since the Single
4058 Unix Specification says that such unused arguments are allowed.
4060 @item -Wformat-overflow
4061 @itemx -Wformat-overflow=@var{level}
4062 @opindex Wformat-overflow
4063 @opindex Wno-format-overflow
4064 Warn about calls to formatted input/output functions such as @code{sprintf}
4065 and @code{vsprintf} that might overflow the destination buffer.  When the
4066 exact number of bytes written by a format directive cannot be determined
4067 at compile-time it is estimated based on heuristics that depend on the
4068 @var{level} argument and on optimization.  While enabling optimization
4069 will in most cases improve the accuracy of the warning, it may also
4070 result in false positives.
4072 @table @gcctabopt
4073 @item -Wformat-overflow
4074 @item -Wformat-overflow=1
4075 @opindex Wformat-overflow
4076 @opindex Wno-format-overflow
4077 Level @var{1} of @option{-Wformat-overflow} enabled by @option{-Wformat}
4078 employs a conservative approach that warns only about calls that most
4079 likely overflow the buffer.  At this level, numeric arguments to format
4080 directives with unknown values are assumed to have the value of one, and
4081 strings of unknown length to be empty.  Numeric arguments that are known
4082 to be bounded to a subrange of their type, or string arguments whose output
4083 is bounded either by their directive's precision or by a finite set of
4084 string literals, are assumed to take on the value within the range that
4085 results in the most bytes on output.  For example, the call to @code{sprintf}
4086 below is diagnosed because even with both @var{a} and @var{b} equal to zero,
4087 the terminating NUL character (@code{'\0'}) appended by the function
4088 to the destination buffer will be written past its end.  Increasing
4089 the size of the buffer by a single byte is sufficient to avoid the
4090 warning, though it may not be sufficient to avoid the overflow.
4092 @smallexample
4093 void f (int a, int b)
4095   char buf [12];
4096   sprintf (buf, "a = %i, b = %i\n", a, b);
4098 @end smallexample
4100 @item -Wformat-overflow=2
4101 Level @var{2} warns also about calls that might overflow the destination
4102 buffer given an argument of sufficient length or magnitude.  At level
4103 @var{2}, unknown numeric arguments are assumed to have the minimum
4104 representable value for signed types with a precision greater than 1, and
4105 the maximum representable value otherwise.  Unknown string arguments whose
4106 length cannot be assumed to be bounded either by the directive's precision,
4107 or by a finite set of string literals they may evaluate to, or the character
4108 array they may point to, are assumed to be 1 character long.
4110 At level @var{2}, the call in the example above is again diagnosed, but
4111 this time because with @var{a} equal to a 32-bit @code{INT_MIN} the first
4112 @code{%i} directive will write some of its digits beyond the end of
4113 the destination buffer.  To make the call safe regardless of the values
4114 of the two variables, the size of the destination buffer must be increased
4115 to at least 34 bytes.  GCC includes the minimum size of the buffer in
4116 an informational note following the warning.
4118 An alternative to increasing the size of the destination buffer is to
4119 constrain the range of formatted values.  The maximum length of string
4120 arguments can be bounded by specifying the precision in the format
4121 directive.  When numeric arguments of format directives can be assumed
4122 to be bounded by less than the precision of their type, choosing
4123 an appropriate length modifier to the format specifier will reduce
4124 the required buffer size.  For example, if @var{a} and @var{b} in the
4125 example above can be assumed to be within the precision of
4126 the @code{short int} type then using either the @code{%hi} format
4127 directive or casting the argument to @code{short} reduces the maximum
4128 required size of the buffer to 24 bytes.
4130 @smallexample
4131 void f (int a, int b)
4133   char buf [23];
4134   sprintf (buf, "a = %hi, b = %i\n", a, (short)b);
4136 @end smallexample
4137 @end table
4139 @item -Wno-format-zero-length
4140 @opindex Wno-format-zero-length
4141 @opindex Wformat-zero-length
4142 If @option{-Wformat} is specified, do not warn about zero-length formats.
4143 The C standard specifies that zero-length formats are allowed.
4146 @item -Wformat=2
4147 @opindex Wformat=2
4148 Enable @option{-Wformat} plus additional format checks.  Currently
4149 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
4150 -Wformat-y2k}.
4152 @item -Wformat-nonliteral
4153 @opindex Wformat-nonliteral
4154 @opindex Wno-format-nonliteral
4155 If @option{-Wformat} is specified, also warn if the format string is not a
4156 string literal and so cannot be checked, unless the format function
4157 takes its format arguments as a @code{va_list}.
4159 @item -Wformat-security
4160 @opindex Wformat-security
4161 @opindex Wno-format-security
4162 If @option{-Wformat} is specified, also warn about uses of format
4163 functions that represent possible security problems.  At present, this
4164 warns about calls to @code{printf} and @code{scanf} functions where the
4165 format string is not a string literal and there are no format arguments,
4166 as in @code{printf (foo);}.  This may be a security hole if the format
4167 string came from untrusted input and contains @samp{%n}.  (This is
4168 currently a subset of what @option{-Wformat-nonliteral} warns about, but
4169 in future warnings may be added to @option{-Wformat-security} that are not
4170 included in @option{-Wformat-nonliteral}.)
4172 @item -Wformat-signedness
4173 @opindex Wformat-signedness
4174 @opindex Wno-format-signedness
4175 If @option{-Wformat} is specified, also warn if the format string
4176 requires an unsigned argument and the argument is signed and vice versa.
4178 @item -Wformat-truncation
4179 @itemx -Wformat-truncation=@var{level}
4180 @opindex Wformat-truncation
4181 @opindex Wno-format-truncation
4182 Warn about calls to formatted input/output functions such as @code{snprintf}
4183 and @code{vsnprintf} that might result in output truncation.  When the exact
4184 number of bytes written by a format directive cannot be determined at
4185 compile-time it is estimated based on heuristics that depend on
4186 the @var{level} argument and on optimization.  While enabling optimization
4187 will in most cases improve the accuracy of the warning, it may also result
4188 in false positives.  Except as noted otherwise, the option uses the same
4189 logic @option{-Wformat-overflow}.
4191 @table @gcctabopt
4192 @item -Wformat-truncation
4193 @item -Wformat-truncation=1
4194 @opindex Wformat-truncation
4195 @opindex Wno-format-overflow
4196 Level @var{1} of @option{-Wformat-truncation} enabled by @option{-Wformat}
4197 employs a conservative approach that warns only about calls to bounded
4198 functions whose return value is unused and that will most likely result
4199 in output truncation.
4201 @item -Wformat-truncation=2
4202 Level @var{2} warns also about calls to bounded functions whose return
4203 value is used and that might result in truncation given an argument of
4204 sufficient length or magnitude.
4205 @end table
4207 @item -Wformat-y2k
4208 @opindex Wformat-y2k
4209 @opindex Wno-format-y2k
4210 If @option{-Wformat} is specified, also warn about @code{strftime}
4211 formats that may yield only a two-digit year.
4212 @end table
4214 @item -Wnonnull
4215 @opindex Wnonnull
4216 @opindex Wno-nonnull
4217 Warn about passing a null pointer for arguments marked as
4218 requiring a non-null value by the @code{nonnull} function attribute.
4220 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
4221 can be disabled with the @option{-Wno-nonnull} option.
4223 @item -Wnonnull-compare
4224 @opindex Wnonnull-compare
4225 @opindex Wno-nonnull-compare
4226 Warn when comparing an argument marked with the @code{nonnull}
4227 function attribute against null inside the function.
4229 @option{-Wnonnull-compare} is included in @option{-Wall}.  It
4230 can be disabled with the @option{-Wno-nonnull-compare} option.
4232 @item -Wnull-dereference
4233 @opindex Wnull-dereference
4234 @opindex Wno-null-dereference
4235 Warn if the compiler detects paths that trigger erroneous or
4236 undefined behavior due to dereferencing a null pointer.  This option
4237 is only active when @option{-fdelete-null-pointer-checks} is active,
4238 which is enabled by optimizations in most targets.  The precision of
4239 the warnings depends on the optimization options used.
4241 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
4242 @opindex Winit-self
4243 @opindex Wno-init-self
4244 Warn about uninitialized variables that are initialized with themselves.
4245 Note this option can only be used with the @option{-Wuninitialized} option.
4247 For example, GCC warns about @code{i} being uninitialized in the
4248 following snippet only when @option{-Winit-self} has been specified:
4249 @smallexample
4250 @group
4251 int f()
4253   int i = i;
4254   return i;
4256 @end group
4257 @end smallexample
4259 This warning is enabled by @option{-Wall} in C++.
4261 @item -Wimplicit-int @r{(C and Objective-C only)}
4262 @opindex Wimplicit-int
4263 @opindex Wno-implicit-int
4264 Warn when a declaration does not specify a type.
4265 This warning is enabled by @option{-Wall}.
4267 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
4268 @opindex Wimplicit-function-declaration
4269 @opindex Wno-implicit-function-declaration
4270 Give a warning whenever a function is used before being declared. In
4271 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
4272 enabled by default and it is made into an error by
4273 @option{-pedantic-errors}. This warning is also enabled by
4274 @option{-Wall}.
4276 @item -Wimplicit @r{(C and Objective-C only)}
4277 @opindex Wimplicit
4278 @opindex Wno-implicit
4279 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
4280 This warning is enabled by @option{-Wall}.
4282 @item -Wimplicit-fallthrough
4283 @opindex Wimplicit-fallthrough
4284 @opindex Wno-implicit-fallthrough
4285 @option{-Wimplicit-fallthrough} is the same as @option{-Wimplicit-fallthrough=3}
4286 and @option{-Wno-implicit-fallthrough} is the same as
4287 @option{-Wimplicit-fallthrough=0}.
4289 @item -Wimplicit-fallthrough=@var{n}
4290 @opindex Wimplicit-fallthrough=
4291 Warn when a switch case falls through.  For example:
4293 @smallexample
4294 @group
4295 switch (cond)
4296   @{
4297   case 1:
4298     a = 1;
4299     break;
4300   case 2:
4301     a = 2;
4302   case 3:
4303     a = 3;
4304     break;
4305   @}
4306 @end group
4307 @end smallexample
4309 This warning does not warn when the last statement of a case cannot
4310 fall through, e.g. when there is a return statement or a call to function
4311 declared with the noreturn attribute.  @option{-Wimplicit-fallthrough=}
4312 also takes into account control flow statements, such as ifs, and only
4313 warns when appropriate.  E.g.@:
4315 @smallexample
4316 @group
4317 switch (cond)
4318   @{
4319   case 1:
4320     if (i > 3) @{
4321       bar (5);
4322       break;
4323     @} else if (i < 1) @{
4324       bar (0);
4325     @} else
4326       return;
4327   default:
4328     @dots{}
4329   @}
4330 @end group
4331 @end smallexample
4333 Since there are occasions where a switch case fall through is desirable,
4334 GCC provides an attribute, @code{__attribute__ ((fallthrough))}, that is
4335 to be used along with a null statement to suppress this warning that
4336 would normally occur:
4338 @smallexample
4339 @group
4340 switch (cond)
4341   @{
4342   case 1:
4343     bar (0);
4344     __attribute__ ((fallthrough));
4345   default:
4346     @dots{}
4347   @}
4348 @end group
4349 @end smallexample
4351 C++17 provides a standard way to suppress the @option{-Wimplicit-fallthrough}
4352 warning using @code{[[fallthrough]];} instead of the GNU attribute.  In C++11
4353 or C++14 users can use @code{[[gnu::fallthrough]];}, which is a GNU extension.
4354 Instead of these attributes, it is also possible to add a fallthrough comment
4355 to silence the warning.  The whole body of the C or C++ style comment should
4356 match the given regular expressions listed below.  The option argument @var{n}
4357 specifies what kind of comments are accepted:
4359 @itemize @bullet
4361 @item @option{-Wimplicit-fallthrough=0} disables the warning altogether.
4363 @item @option{-Wimplicit-fallthrough=1} matches @code{.*} regular
4364 expression, any comment is used as fallthrough comment.
4366 @item @option{-Wimplicit-fallthrough=2} case insensitively matches
4367 @code{.*falls?[ \t-]*thr(ough|u).*} regular expression.
4369 @item @option{-Wimplicit-fallthrough=3} case sensitively matches one of the
4370 following regular expressions:
4372 @itemize @bullet
4374 @item @code{-fallthrough}
4376 @item @code{@@fallthrough@@}
4378 @item @code{lint -fallthrough[ \t]*}
4380 @item @code{[ \t.!]*(ELSE,? |INTENTIONAL(LY)? )?@*FALL(S | |-)?THR(OUGH|U)[ \t.!]*(-[^\n\r]*)?}
4382 @item @code{[ \t.!]*(Else,? |Intentional(ly)? )?@*Fall((s | |-)[Tt]|t)hr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4384 @item @code{[ \t.!]*([Ee]lse,? |[Ii]ntentional(ly)? )?@*fall(s | |-)?thr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4386 @end itemize
4388 @item @option{-Wimplicit-fallthrough=4} case sensitively matches one of the
4389 following regular expressions:
4391 @itemize @bullet
4393 @item @code{-fallthrough}
4395 @item @code{@@fallthrough@@}
4397 @item @code{lint -fallthrough[ \t]*}
4399 @item @code{[ \t]*FALLTHR(OUGH|U)[ \t]*}
4401 @end itemize
4403 @item @option{-Wimplicit-fallthrough=5} doesn't recognize any comments as
4404 fallthrough comments, only attributes disable the warning.
4406 @end itemize
4408 The comment needs to be followed after optional whitespace and other comments
4409 by @code{case} or @code{default} keywords or by a user label that precedes some
4410 @code{case} or @code{default} label.
4412 @smallexample
4413 @group
4414 switch (cond)
4415   @{
4416   case 1:
4417     bar (0);
4418     /* FALLTHRU */
4419   default:
4420     @dots{}
4421   @}
4422 @end group
4423 @end smallexample
4425 The @option{-Wimplicit-fallthrough=3} warning is enabled by @option{-Wextra}.
4427 @item -Wignored-qualifiers @r{(C and C++ only)}
4428 @opindex Wignored-qualifiers
4429 @opindex Wno-ignored-qualifiers
4430 Warn if the return type of a function has a type qualifier
4431 such as @code{const}.  For ISO C such a type qualifier has no effect,
4432 since the value returned by a function is not an lvalue.
4433 For C++, the warning is only emitted for scalar types or @code{void}.
4434 ISO C prohibits qualified @code{void} return types on function
4435 definitions, so such return types always receive a warning
4436 even without this option.
4438 This warning is also enabled by @option{-Wextra}.
4440 @item -Wignored-attributes @r{(C and C++ only)}
4441 @opindex Wignored-attributes
4442 @opindex Wno-ignored-attributes
4443 Warn when an attribute is ignored.  This is different from the
4444 @option{-Wattributes} option in that it warns whenever the compiler decides
4445 to drop an attribute, not that the attribute is either unknown, used in a
4446 wrong place, etc.  This warning is enabled by default.
4448 @item -Wmain
4449 @opindex Wmain
4450 @opindex Wno-main
4451 Warn if the type of @code{main} is suspicious.  @code{main} should be
4452 a function with external linkage, returning int, taking either zero
4453 arguments, two, or three arguments of appropriate types.  This warning
4454 is enabled by default in C++ and is enabled by either @option{-Wall}
4455 or @option{-Wpedantic}.
4457 @item -Wmisleading-indentation @r{(C and C++ only)}
4458 @opindex Wmisleading-indentation
4459 @opindex Wno-misleading-indentation
4460 Warn when the indentation of the code does not reflect the block structure.
4461 Specifically, a warning is issued for @code{if}, @code{else}, @code{while}, and
4462 @code{for} clauses with a guarded statement that does not use braces,
4463 followed by an unguarded statement with the same indentation.
4465 In the following example, the call to ``bar'' is misleadingly indented as
4466 if it were guarded by the ``if'' conditional.
4468 @smallexample
4469   if (some_condition ())
4470     foo ();
4471     bar ();  /* Gotcha: this is not guarded by the "if".  */
4472 @end smallexample
4474 In the case of mixed tabs and spaces, the warning uses the
4475 @option{-ftabstop=} option to determine if the statements line up
4476 (defaulting to 8).
4478 The warning is not issued for code involving multiline preprocessor logic
4479 such as the following example.
4481 @smallexample
4482   if (flagA)
4483     foo (0);
4484 #if SOME_CONDITION_THAT_DOES_NOT_HOLD
4485   if (flagB)
4486 #endif
4487     foo (1);
4488 @end smallexample
4490 The warning is not issued after a @code{#line} directive, since this
4491 typically indicates autogenerated code, and no assumptions can be made
4492 about the layout of the file that the directive references.
4494 This warning is enabled by @option{-Wall} in C and C++.
4496 @item -Wmissing-braces
4497 @opindex Wmissing-braces
4498 @opindex Wno-missing-braces
4499 Warn if an aggregate or union initializer is not fully bracketed.  In
4500 the following example, the initializer for @code{a} is not fully
4501 bracketed, but that for @code{b} is fully bracketed.  This warning is
4502 enabled by @option{-Wall} in C.
4504 @smallexample
4505 int a[2][2] = @{ 0, 1, 2, 3 @};
4506 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
4507 @end smallexample
4509 This warning is enabled by @option{-Wall}.
4511 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
4512 @opindex Wmissing-include-dirs
4513 @opindex Wno-missing-include-dirs
4514 Warn if a user-supplied include directory does not exist.
4516 @item -Wmultistatement-macros
4517 @opindex Wmultistatement-macros
4518 @opindex Wno-multistatement-macros
4519 Warn about unsafe multiple statement macros that appear to be guarded
4520 by a clause such as @code{if}, @code{else}, @code{for}, @code{switch}, or
4521 @code{while}, in which only the first statement is actually guarded after
4522 the macro is expanded.
4524 For example:
4526 @smallexample
4527 #define DOIT x++; y++
4528 if (c)
4529   DOIT;
4530 @end smallexample
4532 will increment @code{y} unconditionally, not just when @code{c} holds.
4533 The can usually be fixed by wrapping the macro in a do-while loop:
4534 @smallexample
4535 #define DOIT do @{ x++; y++; @} while (0)
4536 if (c)
4537   DOIT;
4538 @end smallexample
4540 This warning is enabled by @option{-Wall} in C and C++.
4542 @item -Wparentheses
4543 @opindex Wparentheses
4544 @opindex Wno-parentheses
4545 Warn if parentheses are omitted in certain contexts, such
4546 as when there is an assignment in a context where a truth value
4547 is expected, or when operators are nested whose precedence people
4548 often get confused about.
4550 Also warn if a comparison like @code{x<=y<=z} appears; this is
4551 equivalent to @code{(x<=y ? 1 : 0) <= z}, which is a different
4552 interpretation from that of ordinary mathematical notation.
4554 Also warn for dangerous uses of the GNU extension to
4555 @code{?:} with omitted middle operand. When the condition
4556 in the @code{?}: operator is a boolean expression, the omitted value is
4557 always 1.  Often programmers expect it to be a value computed
4558 inside the conditional expression instead.
4560 This warning is enabled by @option{-Wall}.
4562 @item -Wsequence-point
4563 @opindex Wsequence-point
4564 @opindex Wno-sequence-point
4565 Warn about code that may have undefined semantics because of violations
4566 of sequence point rules in the C and C++ standards.
4568 The C and C++ standards define the order in which expressions in a C/C++
4569 program are evaluated in terms of @dfn{sequence points}, which represent
4570 a partial ordering between the execution of parts of the program: those
4571 executed before the sequence point, and those executed after it.  These
4572 occur after the evaluation of a full expression (one which is not part
4573 of a larger expression), after the evaluation of the first operand of a
4574 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
4575 function is called (but after the evaluation of its arguments and the
4576 expression denoting the called function), and in certain other places.
4577 Other than as expressed by the sequence point rules, the order of
4578 evaluation of subexpressions of an expression is not specified.  All
4579 these rules describe only a partial order rather than a total order,
4580 since, for example, if two functions are called within one expression
4581 with no sequence point between them, the order in which the functions
4582 are called is not specified.  However, the standards committee have
4583 ruled that function calls do not overlap.
4585 It is not specified when between sequence points modifications to the
4586 values of objects take effect.  Programs whose behavior depends on this
4587 have undefined behavior; the C and C++ standards specify that ``Between
4588 the previous and next sequence point an object shall have its stored
4589 value modified at most once by the evaluation of an expression.
4590 Furthermore, the prior value shall be read only to determine the value
4591 to be stored.''.  If a program breaks these rules, the results on any
4592 particular implementation are entirely unpredictable.
4594 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
4595 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
4596 diagnosed by this option, and it may give an occasional false positive
4597 result, but in general it has been found fairly effective at detecting
4598 this sort of problem in programs.
4600 The C++17 standard will define the order of evaluation of operands in
4601 more cases: in particular it requires that the right-hand side of an
4602 assignment be evaluated before the left-hand side, so the above
4603 examples are no longer undefined.  But this warning will still warn
4604 about them, to help people avoid writing code that is undefined in C
4605 and earlier revisions of C++.
4607 The standard is worded confusingly, therefore there is some debate
4608 over the precise meaning of the sequence point rules in subtle cases.
4609 Links to discussions of the problem, including proposed formal
4610 definitions, may be found on the GCC readings page, at
4611 @uref{http://gcc.gnu.org/@/readings.html}.
4613 This warning is enabled by @option{-Wall} for C and C++.
4615 @item -Wno-return-local-addr
4616 @opindex Wno-return-local-addr
4617 @opindex Wreturn-local-addr
4618 Do not warn about returning a pointer (or in C++, a reference) to a
4619 variable that goes out of scope after the function returns.
4621 @item -Wreturn-type
4622 @opindex Wreturn-type
4623 @opindex Wno-return-type
4624 Warn whenever a function is defined with a return type that defaults
4625 to @code{int}.  Also warn about any @code{return} statement with no
4626 return value in a function whose return type is not @code{void}
4627 (falling off the end of the function body is considered returning
4628 without a value).
4630 For C only, warn about a @code{return} statement with an expression in a
4631 function whose return type is @code{void}, unless the expression type is
4632 also @code{void}.  As a GNU extension, the latter case is accepted
4633 without a warning unless @option{-Wpedantic} is used.
4635 For C++, a function without return type always produces a diagnostic
4636 message, even when @option{-Wno-return-type} is specified.  The only
4637 exceptions are @code{main} and functions defined in system headers.
4639 This warning is enabled by @option{-Wall}.
4641 @item -Wshift-count-negative
4642 @opindex Wshift-count-negative
4643 @opindex Wno-shift-count-negative
4644 Warn if shift count is negative. This warning is enabled by default.
4646 @item -Wshift-count-overflow
4647 @opindex Wshift-count-overflow
4648 @opindex Wno-shift-count-overflow
4649 Warn if shift count >= width of type. This warning is enabled by default.
4651 @item -Wshift-negative-value
4652 @opindex Wshift-negative-value
4653 @opindex Wno-shift-negative-value
4654 Warn if left shifting a negative value.  This warning is enabled by
4655 @option{-Wextra} in C99 and C++11 modes (and newer).
4657 @item -Wshift-overflow
4658 @itemx -Wshift-overflow=@var{n}
4659 @opindex Wshift-overflow
4660 @opindex Wno-shift-overflow
4661 Warn about left shift overflows.  This warning is enabled by
4662 default in C99 and C++11 modes (and newer).
4664 @table @gcctabopt
4665 @item -Wshift-overflow=1
4666 This is the warning level of @option{-Wshift-overflow} and is enabled
4667 by default in C99 and C++11 modes (and newer).  This warning level does
4668 not warn about left-shifting 1 into the sign bit.  (However, in C, such
4669 an overflow is still rejected in contexts where an integer constant expression
4670 is required.)
4672 @item -Wshift-overflow=2
4673 This warning level also warns about left-shifting 1 into the sign bit,
4674 unless C++14 mode is active.
4675 @end table
4677 @item -Wswitch
4678 @opindex Wswitch
4679 @opindex Wno-switch
4680 Warn whenever a @code{switch} statement has an index of enumerated type
4681 and lacks a @code{case} for one or more of the named codes of that
4682 enumeration.  (The presence of a @code{default} label prevents this
4683 warning.)  @code{case} labels outside the enumeration range also
4684 provoke warnings when this option is used (even if there is a
4685 @code{default} label).
4686 This warning is enabled by @option{-Wall}.
4688 @item -Wswitch-default
4689 @opindex Wswitch-default
4690 @opindex Wno-switch-default
4691 Warn whenever a @code{switch} statement does not have a @code{default}
4692 case.
4694 @item -Wswitch-enum
4695 @opindex Wswitch-enum
4696 @opindex Wno-switch-enum
4697 Warn whenever a @code{switch} statement has an index of enumerated type
4698 and lacks a @code{case} for one or more of the named codes of that
4699 enumeration.  @code{case} labels outside the enumeration range also
4700 provoke warnings when this option is used.  The only difference
4701 between @option{-Wswitch} and this option is that this option gives a
4702 warning about an omitted enumeration code even if there is a
4703 @code{default} label.
4705 @item -Wswitch-bool
4706 @opindex Wswitch-bool
4707 @opindex Wno-switch-bool
4708 Warn whenever a @code{switch} statement has an index of boolean type
4709 and the case values are outside the range of a boolean type.
4710 It is possible to suppress this warning by casting the controlling
4711 expression to a type other than @code{bool}.  For example:
4712 @smallexample
4713 @group
4714 switch ((int) (a == 4))
4715   @{
4716   @dots{}
4717   @}
4718 @end group
4719 @end smallexample
4720 This warning is enabled by default for C and C++ programs.
4722 @item -Wswitch-unreachable
4723 @opindex Wswitch-unreachable
4724 @opindex Wno-switch-unreachable
4725 Warn whenever a @code{switch} statement contains statements between the
4726 controlling expression and the first case label, which will never be
4727 executed.  For example:
4728 @smallexample
4729 @group
4730 switch (cond)
4731   @{
4732    i = 15;
4733   @dots{}
4734    case 5:
4735   @dots{}
4736   @}
4737 @end group
4738 @end smallexample
4739 @option{-Wswitch-unreachable} does not warn if the statement between the
4740 controlling expression and the first case label is just a declaration:
4741 @smallexample
4742 @group
4743 switch (cond)
4744   @{
4745    int i;
4746   @dots{}
4747    case 5:
4748    i = 5;
4749   @dots{}
4750   @}
4751 @end group
4752 @end smallexample
4753 This warning is enabled by default for C and C++ programs.
4755 @item -Wsync-nand @r{(C and C++ only)}
4756 @opindex Wsync-nand
4757 @opindex Wno-sync-nand
4758 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
4759 built-in functions are used.  These functions changed semantics in GCC 4.4.
4761 @item -Wunused-but-set-parameter
4762 @opindex Wunused-but-set-parameter
4763 @opindex Wno-unused-but-set-parameter
4764 Warn whenever a function parameter is assigned to, but otherwise unused
4765 (aside from its declaration).
4767 To suppress this warning use the @code{unused} attribute
4768 (@pxref{Variable Attributes}).
4770 This warning is also enabled by @option{-Wunused} together with
4771 @option{-Wextra}.
4773 @item -Wunused-but-set-variable
4774 @opindex Wunused-but-set-variable
4775 @opindex Wno-unused-but-set-variable
4776 Warn whenever a local variable is assigned to, but otherwise unused
4777 (aside from its declaration).
4778 This warning is enabled by @option{-Wall}.
4780 To suppress this warning use the @code{unused} attribute
4781 (@pxref{Variable Attributes}).
4783 This warning is also enabled by @option{-Wunused}, which is enabled
4784 by @option{-Wall}.
4786 @item -Wunused-function
4787 @opindex Wunused-function
4788 @opindex Wno-unused-function
4789 Warn whenever a static function is declared but not defined or a
4790 non-inline static function is unused.
4791 This warning is enabled by @option{-Wall}.
4793 @item -Wunused-label
4794 @opindex Wunused-label
4795 @opindex Wno-unused-label
4796 Warn whenever a label is declared but not used.
4797 This warning is enabled by @option{-Wall}.
4799 To suppress this warning use the @code{unused} attribute
4800 (@pxref{Variable Attributes}).
4802 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
4803 @opindex Wunused-local-typedefs
4804 Warn when a typedef locally defined in a function is not used.
4805 This warning is enabled by @option{-Wall}.
4807 @item -Wunused-parameter
4808 @opindex Wunused-parameter
4809 @opindex Wno-unused-parameter
4810 Warn whenever a function parameter is unused aside from its declaration.
4812 To suppress this warning use the @code{unused} attribute
4813 (@pxref{Variable Attributes}).
4815 @item -Wno-unused-result
4816 @opindex Wunused-result
4817 @opindex Wno-unused-result
4818 Do not warn if a caller of a function marked with attribute
4819 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
4820 its return value. The default is @option{-Wunused-result}.
4822 @item -Wunused-variable
4823 @opindex Wunused-variable
4824 @opindex Wno-unused-variable
4825 Warn whenever a local or static variable is unused aside from its
4826 declaration. This option implies @option{-Wunused-const-variable=1} for C,
4827 but not for C++. This warning is enabled by @option{-Wall}.
4829 To suppress this warning use the @code{unused} attribute
4830 (@pxref{Variable Attributes}).
4832 @item -Wunused-const-variable
4833 @itemx -Wunused-const-variable=@var{n}
4834 @opindex Wunused-const-variable
4835 @opindex Wno-unused-const-variable
4836 Warn whenever a constant static variable is unused aside from its declaration.
4837 @option{-Wunused-const-variable=1} is enabled by @option{-Wunused-variable}
4838 for C, but not for C++. In C this declares variable storage, but in C++ this
4839 is not an error since const variables take the place of @code{#define}s.
4841 To suppress this warning use the @code{unused} attribute
4842 (@pxref{Variable Attributes}).
4844 @table @gcctabopt
4845 @item -Wunused-const-variable=1
4846 This is the warning level that is enabled by @option{-Wunused-variable} for
4847 C.  It warns only about unused static const variables defined in the main
4848 compilation unit, but not about static const variables declared in any
4849 header included.
4851 @item -Wunused-const-variable=2
4852 This warning level also warns for unused constant static variables in
4853 headers (excluding system headers).  This is the warning level of
4854 @option{-Wunused-const-variable} and must be explicitly requested since
4855 in C++ this isn't an error and in C it might be harder to clean up all
4856 headers included.
4857 @end table
4859 @item -Wunused-value
4860 @opindex Wunused-value
4861 @opindex Wno-unused-value
4862 Warn whenever a statement computes a result that is explicitly not
4863 used. To suppress this warning cast the unused expression to
4864 @code{void}. This includes an expression-statement or the left-hand
4865 side of a comma expression that contains no side effects. For example,
4866 an expression such as @code{x[i,j]} causes a warning, while
4867 @code{x[(void)i,j]} does not.
4869 This warning is enabled by @option{-Wall}.
4871 @item -Wunused
4872 @opindex Wunused
4873 @opindex Wno-unused
4874 All the above @option{-Wunused} options combined.
4876 In order to get a warning about an unused function parameter, you must
4877 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
4878 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
4880 @item -Wuninitialized
4881 @opindex Wuninitialized
4882 @opindex Wno-uninitialized
4883 Warn if an automatic variable is used without first being initialized
4884 or if a variable may be clobbered by a @code{setjmp} call. In C++,
4885 warn if a non-static reference or non-static @code{const} member
4886 appears in a class without constructors.
4888 If you want to warn about code that uses the uninitialized value of the
4889 variable in its own initializer, use the @option{-Winit-self} option.
4891 These warnings occur for individual uninitialized or clobbered
4892 elements of structure, union or array variables as well as for
4893 variables that are uninitialized or clobbered as a whole.  They do
4894 not occur for variables or elements declared @code{volatile}.  Because
4895 these warnings depend on optimization, the exact variables or elements
4896 for which there are warnings depends on the precise optimization
4897 options and version of GCC used.
4899 Note that there may be no warning about a variable that is used only
4900 to compute a value that itself is never used, because such
4901 computations may be deleted by data flow analysis before the warnings
4902 are printed.
4904 @item -Winvalid-memory-model
4905 @opindex Winvalid-memory-model
4906 @opindex Wno-invalid-memory-model
4907 Warn for invocations of @ref{__atomic Builtins}, @ref{__sync Builtins},
4908 and the C11 atomic generic functions with a memory consistency argument
4909 that is either invalid for the operation or outside the range of values
4910 of the @code{memory_order} enumeration.  For example, since the
4911 @code{__atomic_store} and @code{__atomic_store_n} built-ins are only
4912 defined for the relaxed, release, and sequentially consistent memory
4913 orders the following code is diagnosed:
4915 @smallexample
4916 void store (int *i)
4918   __atomic_store_n (i, 0, memory_order_consume);
4920 @end smallexample
4922 @option{-Winvalid-memory-model} is enabled by default.
4924 @item -Wmaybe-uninitialized
4925 @opindex Wmaybe-uninitialized
4926 @opindex Wno-maybe-uninitialized
4927 For an automatic variable, if there exists a path from the function
4928 entry to a use of the variable that is initialized, but there exist
4929 some other paths for which the variable is not initialized, the compiler
4930 emits a warning if it cannot prove the uninitialized paths are not
4931 executed at run time. These warnings are made optional because GCC is
4932 not smart enough to see all the reasons why the code might be correct
4933 in spite of appearing to have an error.  Here is one example of how
4934 this can happen:
4936 @smallexample
4937 @group
4939   int x;
4940   switch (y)
4941     @{
4942     case 1: x = 1;
4943       break;
4944     case 2: x = 4;
4945       break;
4946     case 3: x = 5;
4947     @}
4948   foo (x);
4950 @end group
4951 @end smallexample
4953 @noindent
4954 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
4955 always initialized, but GCC doesn't know this. To suppress the
4956 warning, you need to provide a default case with assert(0) or
4957 similar code.
4959 @cindex @code{longjmp} warnings
4960 This option also warns when a non-volatile automatic variable might be
4961 changed by a call to @code{longjmp}.  These warnings as well are possible
4962 only in optimizing compilation.
4964 The compiler sees only the calls to @code{setjmp}.  It cannot know
4965 where @code{longjmp} will be called; in fact, a signal handler could
4966 call it at any point in the code.  As a result, you may get a warning
4967 even when there is in fact no problem because @code{longjmp} cannot
4968 in fact be called at the place that would cause a problem.
4970 Some spurious warnings can be avoided if you declare all the functions
4971 you use that never return as @code{noreturn}.  @xref{Function
4972 Attributes}.
4974 This warning is enabled by @option{-Wall} or @option{-Wextra}.
4976 @item -Wunknown-pragmas
4977 @opindex Wunknown-pragmas
4978 @opindex Wno-unknown-pragmas
4979 @cindex warning for unknown pragmas
4980 @cindex unknown pragmas, warning
4981 @cindex pragmas, warning of unknown
4982 Warn when a @code{#pragma} directive is encountered that is not understood by 
4983 GCC@.  If this command-line option is used, warnings are even issued
4984 for unknown pragmas in system header files.  This is not the case if
4985 the warnings are only enabled by the @option{-Wall} command-line option.
4987 @item -Wno-pragmas
4988 @opindex Wno-pragmas
4989 @opindex Wpragmas
4990 Do not warn about misuses of pragmas, such as incorrect parameters,
4991 invalid syntax, or conflicts between pragmas.  See also
4992 @option{-Wunknown-pragmas}.
4994 @item -Wstrict-aliasing
4995 @opindex Wstrict-aliasing
4996 @opindex Wno-strict-aliasing
4997 This option is only active when @option{-fstrict-aliasing} is active.
4998 It warns about code that might break the strict aliasing rules that the
4999 compiler is using for optimization.  The warning does not catch all
5000 cases, but does attempt to catch the more common pitfalls.  It is
5001 included in @option{-Wall}.
5002 It is equivalent to @option{-Wstrict-aliasing=3}
5004 @item -Wstrict-aliasing=n
5005 @opindex Wstrict-aliasing=n
5006 This option is only active when @option{-fstrict-aliasing} is active.
5007 It warns about code that might break the strict aliasing rules that the
5008 compiler is using for optimization.
5009 Higher levels correspond to higher accuracy (fewer false positives).
5010 Higher levels also correspond to more effort, similar to the way @option{-O} 
5011 works.
5012 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
5014 Level 1: Most aggressive, quick, least accurate.
5015 Possibly useful when higher levels
5016 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
5017 false negatives.  However, it has many false positives.
5018 Warns for all pointer conversions between possibly incompatible types,
5019 even if never dereferenced.  Runs in the front end only.
5021 Level 2: Aggressive, quick, not too precise.
5022 May still have many false positives (not as many as level 1 though),
5023 and few false negatives (but possibly more than level 1).
5024 Unlike level 1, it only warns when an address is taken.  Warns about
5025 incomplete types.  Runs in the front end only.
5027 Level 3 (default for @option{-Wstrict-aliasing}):
5028 Should have very few false positives and few false
5029 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
5030 Takes care of the common pun+dereference pattern in the front end:
5031 @code{*(int*)&some_float}.
5032 If optimization is enabled, it also runs in the back end, where it deals
5033 with multiple statement cases using flow-sensitive points-to information.
5034 Only warns when the converted pointer is dereferenced.
5035 Does not warn about incomplete types.
5037 @item -Wstrict-overflow
5038 @itemx -Wstrict-overflow=@var{n}
5039 @opindex Wstrict-overflow
5040 @opindex Wno-strict-overflow
5041 This option is only active when signed overflow is undefined.
5042 It warns about cases where the compiler optimizes based on the
5043 assumption that signed overflow does not occur.  Note that it does not
5044 warn about all cases where the code might overflow: it only warns
5045 about cases where the compiler implements some optimization.  Thus
5046 this warning depends on the optimization level.
5048 An optimization that assumes that signed overflow does not occur is
5049 perfectly safe if the values of the variables involved are such that
5050 overflow never does, in fact, occur.  Therefore this warning can
5051 easily give a false positive: a warning about code that is not
5052 actually a problem.  To help focus on important issues, several
5053 warning levels are defined.  No warnings are issued for the use of
5054 undefined signed overflow when estimating how many iterations a loop
5055 requires, in particular when determining whether a loop will be
5056 executed at all.
5058 @table @gcctabopt
5059 @item -Wstrict-overflow=1
5060 Warn about cases that are both questionable and easy to avoid.  For
5061 example the compiler simplifies
5062 @code{x + 1 > x} to @code{1}.  This level of
5063 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
5064 are not, and must be explicitly requested.
5066 @item -Wstrict-overflow=2
5067 Also warn about other cases where a comparison is simplified to a
5068 constant.  For example: @code{abs (x) >= 0}.  This can only be
5069 simplified when signed integer overflow is undefined, because
5070 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
5071 zero.  @option{-Wstrict-overflow} (with no level) is the same as
5072 @option{-Wstrict-overflow=2}.
5074 @item -Wstrict-overflow=3
5075 Also warn about other cases where a comparison is simplified.  For
5076 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
5078 @item -Wstrict-overflow=4
5079 Also warn about other simplifications not covered by the above cases.
5080 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
5082 @item -Wstrict-overflow=5
5083 Also warn about cases where the compiler reduces the magnitude of a
5084 constant involved in a comparison.  For example: @code{x + 2 > y} is
5085 simplified to @code{x + 1 >= y}.  This is reported only at the
5086 highest warning level because this simplification applies to many
5087 comparisons, so this warning level gives a very large number of
5088 false positives.
5089 @end table
5091 @item -Wstringop-overflow
5092 @itemx -Wstringop-overflow=@var{type}
5093 @opindex Wstringop-overflow
5094 @opindex Wno-stringop-overflow
5095 Warn for calls to string manipulation functions such as @code{memcpy} and
5096 @code{strcpy} that are determined to overflow the destination buffer.  The
5097 optional argument is one greater than the type of Object Size Checking to
5098 perform to determine the size of the destination.  @xref{Object Size Checking}.
5099 The argument is meaningful only for functions that operate on character arrays
5100 but not for raw memory functions like @code{memcpy} which always make use
5101 of Object Size type-0.  The option also warns for calls that specify a size
5102 in excess of the largest possible object or at most @code{SIZE_MAX / 2} bytes.
5103 The option produces the best results with optimization enabled but can detect
5104 a small subset of simple buffer overflows even without optimization in
5105 calls to the GCC built-in functions like @code{__builtin_memcpy} that
5106 correspond to the standard functions.  In any case, the option warns about
5107 just a subset of buffer overflows detected by the corresponding overflow
5108 checking built-ins.  For example, the option will issue a warning for
5109 the @code{strcpy} call below because it copies at least 5 characters
5110 (the string @code{"blue"} including the terminating NUL) into the buffer
5111 of size 4.
5113 @smallexample
5114 enum Color @{ blue, purple, yellow @};
5115 const char* f (enum Color clr)
5117   static char buf [4];
5118   const char *str;
5119   switch (clr)
5120     @{
5121       case blue: str = "blue"; break;
5122       case purple: str = "purple"; break;
5123       case yellow: str = "yellow"; break;
5124     @}
5126   return strcpy (buf, str);   // warning here
5128 @end smallexample
5130 Option @option{-Wstringop-overflow=2} is enabled by default.
5132 @table @gcctabopt
5133 @item -Wstringop-overflow
5134 @item -Wstringop-overflow=1
5135 @opindex Wstringop-overflow
5136 @opindex Wno-stringop-overflow
5137 The @option{-Wstringop-overflow=1} option uses type-zero Object Size Checking
5138 to determine the sizes of destination objects.  This is the default setting
5139 of the option.  At this setting the option will not warn for writes past
5140 the end of subobjects of larger objects accessed by pointers unless the
5141 size of the largest surrounding object is known.  When the destination may
5142 be one of several objects it is assumed to be the largest one of them.  On
5143 Linux systems, when optimization is enabled at this setting the option warns
5144 for the same code as when the @code{_FORTIFY_SOURCE} macro is defined to
5145 a non-zero value.
5147 @item -Wstringop-overflow=2
5148 The @option{-Wstringop-overflow=2} option uses type-one Object Size Checking
5149 to determine the sizes of destination objects.  At this setting the option
5150 will warn about overflows when writing to members of the largest complete
5151 objects whose exact size is known.  It will, however, not warn for excessive
5152 writes to the same members of unknown objects referenced by pointers since
5153 they may point to arrays containing unknown numbers of elements.
5155 @item -Wstringop-overflow=3
5156 The @option{-Wstringop-overflow=3} option uses type-two Object Size Checking
5157 to determine the sizes of destination objects.  At this setting the option
5158 warns about overflowing the smallest object or data member.  This is the
5159 most restrictive setting of the option that may result in warnings for safe
5160 code.
5162 @item -Wstringop-overflow=4
5163 The @option{-Wstringop-overflow=4} option uses type-three Object Size Checking
5164 to determine the sizes of destination objects.  At this setting the option
5165 will warn about overflowing any data members, and when the destination is
5166 one of several objects it uses the size of the largest of them to decide
5167 whether to issue a warning.  Similarly to @option{-Wstringop-overflow=3} this
5168 setting of the option may result in warnings for benign code.
5169 @end table
5171 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]}
5172 @opindex Wsuggest-attribute=
5173 @opindex Wno-suggest-attribute=
5174 Warn for cases where adding an attribute may be beneficial. The
5175 attributes currently supported are listed below.
5177 @table @gcctabopt
5178 @item -Wsuggest-attribute=pure
5179 @itemx -Wsuggest-attribute=const
5180 @itemx -Wsuggest-attribute=noreturn
5181 @opindex Wsuggest-attribute=pure
5182 @opindex Wno-suggest-attribute=pure
5183 @opindex Wsuggest-attribute=const
5184 @opindex Wno-suggest-attribute=const
5185 @opindex Wsuggest-attribute=noreturn
5186 @opindex Wno-suggest-attribute=noreturn
5188 Warn about functions that might be candidates for attributes
5189 @code{pure}, @code{const} or @code{noreturn}.  The compiler only warns for
5190 functions visible in other compilation units or (in the case of @code{pure} and
5191 @code{const}) if it cannot prove that the function returns normally. A function
5192 returns normally if it doesn't contain an infinite loop or return abnormally
5193 by throwing, calling @code{abort} or trapping.  This analysis requires option
5194 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
5195 higher.  Higher optimization levels improve the accuracy of the analysis.
5197 @item -Wsuggest-attribute=format
5198 @itemx -Wmissing-format-attribute
5199 @opindex Wsuggest-attribute=format
5200 @opindex Wmissing-format-attribute
5201 @opindex Wno-suggest-attribute=format
5202 @opindex Wno-missing-format-attribute
5203 @opindex Wformat
5204 @opindex Wno-format
5206 Warn about function pointers that might be candidates for @code{format}
5207 attributes.  Note these are only possible candidates, not absolute ones.
5208 GCC guesses that function pointers with @code{format} attributes that
5209 are used in assignment, initialization, parameter passing or return
5210 statements should have a corresponding @code{format} attribute in the
5211 resulting type.  I.e.@: the left-hand side of the assignment or
5212 initialization, the type of the parameter variable, or the return type
5213 of the containing function respectively should also have a @code{format}
5214 attribute to avoid the warning.
5216 GCC also warns about function definitions that might be
5217 candidates for @code{format} attributes.  Again, these are only
5218 possible candidates.  GCC guesses that @code{format} attributes
5219 might be appropriate for any function that calls a function like
5220 @code{vprintf} or @code{vscanf}, but this might not always be the
5221 case, and some functions for which @code{format} attributes are
5222 appropriate may not be detected.
5223 @end table
5225 @item -Wsuggest-final-types
5226 @opindex Wno-suggest-final-types
5227 @opindex Wsuggest-final-types
5228 Warn about types with virtual methods where code quality would be improved
5229 if the type were declared with the C++11 @code{final} specifier, 
5230 or, if possible,
5231 declared in an anonymous namespace. This allows GCC to more aggressively
5232 devirtualize the polymorphic calls. This warning is more effective with link
5233 time optimization, where the information about the class hierarchy graph is
5234 more complete.
5236 @item -Wsuggest-final-methods
5237 @opindex Wno-suggest-final-methods
5238 @opindex Wsuggest-final-methods
5239 Warn about virtual methods where code quality would be improved if the method
5240 were declared with the C++11 @code{final} specifier, 
5241 or, if possible, its type were
5242 declared in an anonymous namespace or with the @code{final} specifier.
5243 This warning is
5244 more effective with link-time optimization, where the information about the
5245 class hierarchy graph is more complete. It is recommended to first consider
5246 suggestions of @option{-Wsuggest-final-types} and then rebuild with new
5247 annotations.
5249 @item -Wsuggest-override
5250 Warn about overriding virtual functions that are not marked with the override
5251 keyword.
5253 @item -Walloc-zero
5254 @opindex Wno-alloc-zero
5255 @opindex Walloc-zero
5256 Warn about calls to allocation functions decorated with attribute
5257 @code{alloc_size} that specify zero bytes, including those to the built-in
5258 forms of the functions @code{aligned_alloc}, @code{alloca}, @code{calloc},
5259 @code{malloc}, and @code{realloc}.  Because the behavior of these functions
5260 when called with a zero size differs among implementations (and in the case
5261 of @code{realloc} has been deprecated) relying on it may result in subtle
5262 portability bugs and should be avoided.
5264 @item -Walloc-size-larger-than=@var{n}
5265 Warn about calls to functions decorated with attribute @code{alloc_size}
5266 that attempt to allocate objects larger than the specified number of bytes,
5267 or where the result of the size computation in an integer type with infinite
5268 precision would exceed @code{SIZE_MAX / 2}.  The option argument @var{n}
5269 may end in one of the standard suffixes designating a multiple of bytes
5270 such as @code{kB} and @code{KiB} for kilobyte and kibibyte, respectively,
5271 @code{MB} and @code{MiB} for megabyte and mebibyte, and so on.
5272 @xref{Function Attributes}.
5274 @item -Walloca
5275 @opindex Wno-alloca
5276 @opindex Walloca
5277 This option warns on all uses of @code{alloca} in the source.
5279 @item -Walloca-larger-than=@var{n}
5280 This option warns on calls to @code{alloca} that are not bounded by a
5281 controlling predicate limiting its argument of integer type to at most
5282 @var{n} bytes, or calls to @code{alloca} where the bound is unknown.
5283 Arguments of non-integer types are considered unbounded even if they
5284 appear to be constrained to the expected range.
5286 For example, a bounded case of @code{alloca} could be:
5288 @smallexample
5289 void func (size_t n)
5291   void *p;
5292   if (n <= 1000)
5293     p = alloca (n);
5294   else
5295     p = malloc (n);
5296   f (p);
5298 @end smallexample
5300 In the above example, passing @code{-Walloca-larger-than=1000} would not
5301 issue a warning because the call to @code{alloca} is known to be at most
5302 1000 bytes.  However, if @code{-Walloca-larger-than=500} were passed,
5303 the compiler would emit a warning.
5305 Unbounded uses, on the other hand, are uses of @code{alloca} with no
5306 controlling predicate constraining its integer argument.  For example:
5308 @smallexample
5309 void func ()
5311   void *p = alloca (n);
5312   f (p);
5314 @end smallexample
5316 If @code{-Walloca-larger-than=500} were passed, the above would trigger
5317 a warning, but this time because of the lack of bounds checking.
5319 Note, that even seemingly correct code involving signed integers could
5320 cause a warning:
5322 @smallexample
5323 void func (signed int n)
5325   if (n < 500)
5326     @{
5327       p = alloca (n);
5328       f (p);
5329     @}
5331 @end smallexample
5333 In the above example, @var{n} could be negative, causing a larger than
5334 expected argument to be implicitly cast into the @code{alloca} call.
5336 This option also warns when @code{alloca} is used in a loop.
5338 This warning is not enabled by @option{-Wall}, and is only active when
5339 @option{-ftree-vrp} is active (default for @option{-O2} and above).
5341 See also @option{-Wvla-larger-than=@var{n}}.
5343 @item -Warray-bounds
5344 @itemx -Warray-bounds=@var{n}
5345 @opindex Wno-array-bounds
5346 @opindex Warray-bounds
5347 This option is only active when @option{-ftree-vrp} is active
5348 (default for @option{-O2} and above). It warns about subscripts to arrays
5349 that are always out of bounds. This warning is enabled by @option{-Wall}.
5351 @table @gcctabopt
5352 @item -Warray-bounds=1
5353 This is the warning level of @option{-Warray-bounds} and is enabled
5354 by @option{-Wall}; higher levels are not, and must be explicitly requested.
5356 @item -Warray-bounds=2
5357 This warning level also warns about out of bounds access for
5358 arrays at the end of a struct and for arrays accessed through
5359 pointers. This warning level may give a larger number of
5360 false positives and is deactivated by default.
5361 @end table
5363 @item -Wbool-compare
5364 @opindex Wno-bool-compare
5365 @opindex Wbool-compare
5366 Warn about boolean expression compared with an integer value different from
5367 @code{true}/@code{false}.  For instance, the following comparison is
5368 always false:
5369 @smallexample
5370 int n = 5;
5371 @dots{}
5372 if ((n > 1) == 2) @{ @dots{} @}
5373 @end smallexample
5374 This warning is enabled by @option{-Wall}.
5376 @item -Wbool-operation
5377 @opindex Wno-bool-operation
5378 @opindex Wbool-operation
5379 Warn about suspicious operations on expressions of a boolean type.  For
5380 instance, bitwise negation of a boolean is very likely a bug in the program.
5381 For C, this warning also warns about incrementing or decrementing a boolean,
5382 which rarely makes sense.  (In C++, decrementing a boolean is always invalid.
5383 Incrementing a boolean is invalid in C++1z, and deprecated otherwise.)
5385 This warning is enabled by @option{-Wall}.
5387 @item -Wduplicated-branches
5388 @opindex Wno-duplicated-branches
5389 @opindex Wduplicated-branches
5390 Warn when an if-else has identical branches.  This warning detects cases like
5391 @smallexample
5392 if (p != NULL)
5393   return 0;
5394 else
5395   return 0;
5396 @end smallexample
5397 It doesn't warn when both branches contain just a null statement.  This warning
5398 also warn for conditional operators:
5399 @smallexample
5400   int i = x ? *p : *p;
5401 @end smallexample
5403 @item -Wduplicated-cond
5404 @opindex Wno-duplicated-cond
5405 @opindex Wduplicated-cond
5406 Warn about duplicated conditions in an if-else-if chain.  For instance,
5407 warn for the following code:
5408 @smallexample
5409 if (p->q != NULL) @{ @dots{} @}
5410 else if (p->q != NULL) @{ @dots{} @}
5411 @end smallexample
5413 @item -Wframe-address
5414 @opindex Wno-frame-address
5415 @opindex Wframe-address
5416 Warn when the @samp{__builtin_frame_address} or @samp{__builtin_return_address}
5417 is called with an argument greater than 0.  Such calls may return indeterminate
5418 values or crash the program.  The warning is included in @option{-Wall}.
5420 @item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
5421 @opindex Wno-discarded-qualifiers
5422 @opindex Wdiscarded-qualifiers
5423 Do not warn if type qualifiers on pointers are being discarded.
5424 Typically, the compiler warns if a @code{const char *} variable is
5425 passed to a function that takes a @code{char *} parameter.  This option
5426 can be used to suppress such a warning.
5428 @item -Wno-discarded-array-qualifiers @r{(C and Objective-C only)}
5429 @opindex Wno-discarded-array-qualifiers
5430 @opindex Wdiscarded-array-qualifiers
5431 Do not warn if type qualifiers on arrays which are pointer targets
5432 are being discarded. Typically, the compiler warns if a
5433 @code{const int (*)[]} variable is passed to a function that
5434 takes a @code{int (*)[]} parameter.  This option can be used to
5435 suppress such a warning.
5437 @item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
5438 @opindex Wno-incompatible-pointer-types
5439 @opindex Wincompatible-pointer-types
5440 Do not warn when there is a conversion between pointers that have incompatible
5441 types.  This warning is for cases not covered by @option{-Wno-pointer-sign},
5442 which warns for pointer argument passing or assignment with different
5443 signedness.
5445 @item -Wno-int-conversion @r{(C and Objective-C only)}
5446 @opindex Wno-int-conversion
5447 @opindex Wint-conversion
5448 Do not warn about incompatible integer to pointer and pointer to integer
5449 conversions.  This warning is about implicit conversions; for explicit
5450 conversions the warnings @option{-Wno-int-to-pointer-cast} and
5451 @option{-Wno-pointer-to-int-cast} may be used.
5453 @item -Wno-div-by-zero
5454 @opindex Wno-div-by-zero
5455 @opindex Wdiv-by-zero
5456 Do not warn about compile-time integer division by zero.  Floating-point
5457 division by zero is not warned about, as it can be a legitimate way of
5458 obtaining infinities and NaNs.
5460 @item -Wsystem-headers
5461 @opindex Wsystem-headers
5462 @opindex Wno-system-headers
5463 @cindex warnings from system headers
5464 @cindex system headers, warnings from
5465 Print warning messages for constructs found in system header files.
5466 Warnings from system headers are normally suppressed, on the assumption
5467 that they usually do not indicate real problems and would only make the
5468 compiler output harder to read.  Using this command-line option tells
5469 GCC to emit warnings from system headers as if they occurred in user
5470 code.  However, note that using @option{-Wall} in conjunction with this
5471 option does @emph{not} warn about unknown pragmas in system
5472 headers---for that, @option{-Wunknown-pragmas} must also be used.
5474 @item -Wtautological-compare
5475 @opindex Wtautological-compare
5476 @opindex Wno-tautological-compare
5477 Warn if a self-comparison always evaluates to true or false.  This
5478 warning detects various mistakes such as:
5479 @smallexample
5480 int i = 1;
5481 @dots{}
5482 if (i > i) @{ @dots{} @}
5483 @end smallexample
5484 This warning is enabled by @option{-Wall}.
5486 @item -Wtrampolines
5487 @opindex Wtrampolines
5488 @opindex Wno-trampolines
5489 Warn about trampolines generated for pointers to nested functions.
5490 A trampoline is a small piece of data or code that is created at run
5491 time on the stack when the address of a nested function is taken, and is
5492 used to call the nested function indirectly.  For some targets, it is
5493 made up of data only and thus requires no special treatment.  But, for
5494 most targets, it is made up of code and thus requires the stack to be
5495 made executable in order for the program to work properly.
5497 @item -Wfloat-equal
5498 @opindex Wfloat-equal
5499 @opindex Wno-float-equal
5500 Warn if floating-point values are used in equality comparisons.
5502 The idea behind this is that sometimes it is convenient (for the
5503 programmer) to consider floating-point values as approximations to
5504 infinitely precise real numbers.  If you are doing this, then you need
5505 to compute (by analyzing the code, or in some other way) the maximum or
5506 likely maximum error that the computation introduces, and allow for it
5507 when performing comparisons (and when producing output, but that's a
5508 different problem).  In particular, instead of testing for equality, you
5509 should check to see whether the two values have ranges that overlap; and
5510 this is done with the relational operators, so equality comparisons are
5511 probably mistaken.
5513 @item -Wtraditional @r{(C and Objective-C only)}
5514 @opindex Wtraditional
5515 @opindex Wno-traditional
5516 Warn about certain constructs that behave differently in traditional and
5517 ISO C@.  Also warn about ISO C constructs that have no traditional C
5518 equivalent, and/or problematic constructs that should be avoided.
5520 @itemize @bullet
5521 @item
5522 Macro parameters that appear within string literals in the macro body.
5523 In traditional C macro replacement takes place within string literals,
5524 but in ISO C it does not.
5526 @item
5527 In traditional C, some preprocessor directives did not exist.
5528 Traditional preprocessors only considered a line to be a directive
5529 if the @samp{#} appeared in column 1 on the line.  Therefore
5530 @option{-Wtraditional} warns about directives that traditional C
5531 understands but ignores because the @samp{#} does not appear as the
5532 first character on the line.  It also suggests you hide directives like
5533 @code{#pragma} not understood by traditional C by indenting them.  Some
5534 traditional implementations do not recognize @code{#elif}, so this option
5535 suggests avoiding it altogether.
5537 @item
5538 A function-like macro that appears without arguments.
5540 @item
5541 The unary plus operator.
5543 @item
5544 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
5545 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
5546 constants.)  Note, these suffixes appear in macros defined in the system
5547 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
5548 Use of these macros in user code might normally lead to spurious
5549 warnings, however GCC's integrated preprocessor has enough context to
5550 avoid warning in these cases.
5552 @item
5553 A function declared external in one block and then used after the end of
5554 the block.
5556 @item
5557 A @code{switch} statement has an operand of type @code{long}.
5559 @item
5560 A non-@code{static} function declaration follows a @code{static} one.
5561 This construct is not accepted by some traditional C compilers.
5563 @item
5564 The ISO type of an integer constant has a different width or
5565 signedness from its traditional type.  This warning is only issued if
5566 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
5567 typically represent bit patterns, are not warned about.
5569 @item
5570 Usage of ISO string concatenation is detected.
5572 @item
5573 Initialization of automatic aggregates.
5575 @item
5576 Identifier conflicts with labels.  Traditional C lacks a separate
5577 namespace for labels.
5579 @item
5580 Initialization of unions.  If the initializer is zero, the warning is
5581 omitted.  This is done under the assumption that the zero initializer in
5582 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
5583 initializer warnings and relies on default initialization to zero in the
5584 traditional C case.
5586 @item
5587 Conversions by prototypes between fixed/floating-point values and vice
5588 versa.  The absence of these prototypes when compiling with traditional
5589 C causes serious problems.  This is a subset of the possible
5590 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
5592 @item
5593 Use of ISO C style function definitions.  This warning intentionally is
5594 @emph{not} issued for prototype declarations or variadic functions
5595 because these ISO C features appear in your code when using
5596 libiberty's traditional C compatibility macros, @code{PARAMS} and
5597 @code{VPARAMS}.  This warning is also bypassed for nested functions
5598 because that feature is already a GCC extension and thus not relevant to
5599 traditional C compatibility.
5600 @end itemize
5602 @item -Wtraditional-conversion @r{(C and Objective-C only)}
5603 @opindex Wtraditional-conversion
5604 @opindex Wno-traditional-conversion
5605 Warn if a prototype causes a type conversion that is different from what
5606 would happen to the same argument in the absence of a prototype.  This
5607 includes conversions of fixed point to floating and vice versa, and
5608 conversions changing the width or signedness of a fixed-point argument
5609 except when the same as the default promotion.
5611 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
5612 @opindex Wdeclaration-after-statement
5613 @opindex Wno-declaration-after-statement
5614 Warn when a declaration is found after a statement in a block.  This
5615 construct, known from C++, was introduced with ISO C99 and is by default
5616 allowed in GCC@.  It is not supported by ISO C90.  @xref{Mixed Declarations}.
5618 @item -Wshadow
5619 @opindex Wshadow
5620 @opindex Wno-shadow
5621 Warn whenever a local variable or type declaration shadows another
5622 variable, parameter, type, class member (in C++), or instance variable
5623 (in Objective-C) or whenever a built-in function is shadowed. Note
5624 that in C++, the compiler warns if a local variable shadows an
5625 explicit typedef, but not if it shadows a struct/class/enum.
5626 Same as @option{-Wshadow=global}.
5628 @item -Wno-shadow-ivar @r{(Objective-C only)}
5629 @opindex Wno-shadow-ivar
5630 @opindex Wshadow-ivar
5631 Do not warn whenever a local variable shadows an instance variable in an
5632 Objective-C method.
5634 @item -Wshadow=global
5635 @opindex Wshadow=local
5636 The default for @option{-Wshadow}. Warns for any (global) shadowing.
5638 @item -Wshadow=local
5639 @opindex Wshadow=local
5640 Warn when a local variable shadows another local variable or parameter.
5641 This warning is enabled by @option{-Wshadow=global}.
5643 @item -Wshadow=compatible-local
5644 @opindex Wshadow=compatible-local
5645 Warn when a local variable shadows another local variable or parameter
5646 whose type is compatible with that of the shadowing variable. In C++,
5647 type compatibility here means the type of the shadowing variable can be
5648 converted to that of the shadowed variable. The creation of this flag
5649 (in addition to @option{-Wshadow=local}) is based on the idea that when
5650 a local variable shadows another one of incompatible type, it is most
5651 likely intentional, not a bug or typo, as shown in the following example:
5653 @smallexample
5654 @group
5655 for (SomeIterator i = SomeObj.begin(); i != SomeObj.end(); ++i)
5657   for (int i = 0; i < N; ++i)
5658   @{
5659     ...
5660   @}
5661   ...
5663 @end group
5664 @end smallexample
5666 Since the two variable @code{i} in the example above have incompatible types,
5667 enabling only @option{-Wshadow=compatible-local} will not emit a warning.
5668 Because their types are incompatible, if a programmer accidentally uses one
5669 in place of the other, type checking will catch that and emit an error or
5670 warning. So not warning (about shadowing) in this case will not lead to
5671 undetected bugs. Use of this flag instead of @option{-Wshadow=local} can
5672 possibly reduce the number of warnings triggered by intentional shadowing.
5674 This warning is enabled by @option{-Wshadow=local}.
5676 @item -Wlarger-than=@var{len}
5677 @opindex Wlarger-than=@var{len}
5678 @opindex Wlarger-than-@var{len}
5679 Warn whenever an object of larger than @var{len} bytes is defined.
5681 @item -Wframe-larger-than=@var{len}
5682 @opindex Wframe-larger-than
5683 Warn if the size of a function frame is larger than @var{len} bytes.
5684 The computation done to determine the stack frame size is approximate
5685 and not conservative.
5686 The actual requirements may be somewhat greater than @var{len}
5687 even if you do not get a warning.  In addition, any space allocated
5688 via @code{alloca}, variable-length arrays, or related constructs
5689 is not included by the compiler when determining
5690 whether or not to issue a warning.
5692 @item -Wno-free-nonheap-object
5693 @opindex Wno-free-nonheap-object
5694 @opindex Wfree-nonheap-object
5695 Do not warn when attempting to free an object that was not allocated
5696 on the heap.
5698 @item -Wstack-usage=@var{len}
5699 @opindex Wstack-usage
5700 Warn if the stack usage of a function might be larger than @var{len} bytes.
5701 The computation done to determine the stack usage is conservative.
5702 Any space allocated via @code{alloca}, variable-length arrays, or related
5703 constructs is included by the compiler when determining whether or not to
5704 issue a warning.
5706 The message is in keeping with the output of @option{-fstack-usage}.
5708 @itemize
5709 @item
5710 If the stack usage is fully static but exceeds the specified amount, it's:
5712 @smallexample
5713   warning: stack usage is 1120 bytes
5714 @end smallexample
5715 @item
5716 If the stack usage is (partly) dynamic but bounded, it's:
5718 @smallexample
5719   warning: stack usage might be 1648 bytes
5720 @end smallexample
5721 @item
5722 If the stack usage is (partly) dynamic and not bounded, it's:
5724 @smallexample
5725   warning: stack usage might be unbounded
5726 @end smallexample
5727 @end itemize
5729 @item -Wunsafe-loop-optimizations
5730 @opindex Wunsafe-loop-optimizations
5731 @opindex Wno-unsafe-loop-optimizations
5732 Warn if the loop cannot be optimized because the compiler cannot
5733 assume anything on the bounds of the loop indices.  With
5734 @option{-funsafe-loop-optimizations} warn if the compiler makes
5735 such assumptions.
5737 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
5738 @opindex Wno-pedantic-ms-format
5739 @opindex Wpedantic-ms-format
5740 When used in combination with @option{-Wformat}
5741 and @option{-pedantic} without GNU extensions, this option
5742 disables the warnings about non-ISO @code{printf} / @code{scanf} format
5743 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
5744 which depend on the MS runtime.
5746 @item -Waligned-new
5747 @opindex Waligned-new
5748 @opindex Wno-aligned-new
5749 Warn about a new-expression of a type that requires greater alignment
5750 than the @code{alignof(std::max_align_t)} but uses an allocation
5751 function without an explicit alignment parameter. This option is
5752 enabled by @option{-Wall}.
5754 Normally this only warns about global allocation functions, but
5755 @option{-Waligned-new=all} also warns about class member allocation
5756 functions.
5758 @item -Wplacement-new
5759 @itemx -Wplacement-new=@var{n}
5760 @opindex Wplacement-new
5761 @opindex Wno-placement-new
5762 Warn about placement new expressions with undefined behavior, such as
5763 constructing an object in a buffer that is smaller than the type of
5764 the object.  For example, the placement new expression below is diagnosed
5765 because it attempts to construct an array of 64 integers in a buffer only
5766 64 bytes large.
5767 @smallexample
5768 char buf [64];
5769 new (buf) int[64];
5770 @end smallexample
5771 This warning is enabled by default.
5773 @table @gcctabopt
5774 @item -Wplacement-new=1
5775 This is the default warning level of @option{-Wplacement-new}.  At this
5776 level the warning is not issued for some strictly undefined constructs that
5777 GCC allows as extensions for compatibility with legacy code.  For example,
5778 the following @code{new} expression is not diagnosed at this level even
5779 though it has undefined behavior according to the C++ standard because
5780 it writes past the end of the one-element array.
5781 @smallexample
5782 struct S @{ int n, a[1]; @};
5783 S *s = (S *)malloc (sizeof *s + 31 * sizeof s->a[0]);
5784 new (s->a)int [32]();
5785 @end smallexample
5787 @item -Wplacement-new=2
5788 At this level, in addition to diagnosing all the same constructs as at level
5789 1, a diagnostic is also issued for placement new expressions that construct
5790 an object in the last member of structure whose type is an array of a single
5791 element and whose size is less than the size of the object being constructed.
5792 While the previous example would be diagnosed, the following construct makes
5793 use of the flexible member array extension to avoid the warning at level 2.
5794 @smallexample
5795 struct S @{ int n, a[]; @};
5796 S *s = (S *)malloc (sizeof *s + 32 * sizeof s->a[0]);
5797 new (s->a)int [32]();
5798 @end smallexample
5800 @end table
5802 @item -Wpointer-arith
5803 @opindex Wpointer-arith
5804 @opindex Wno-pointer-arith
5805 Warn about anything that depends on the ``size of'' a function type or
5806 of @code{void}.  GNU C assigns these types a size of 1, for
5807 convenience in calculations with @code{void *} pointers and pointers
5808 to functions.  In C++, warn also when an arithmetic operation involves
5809 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
5811 @item -Wpointer-compare
5812 @opindex Wpointer-compare
5813 @opindex Wno-pointer-compare
5814 Warn if a pointer is compared with a zero character constant.  This usually
5815 means that the pointer was meant to be dereferenced.  For example:
5817 @smallexample
5818 const char *p = foo ();
5819 if (p == '\0')
5820   return 42;
5821 @end smallexample
5823 Note that the code above is invalid in C++11.
5825 This warning is enabled by default.
5827 @item -Wtype-limits
5828 @opindex Wtype-limits
5829 @opindex Wno-type-limits
5830 Warn if a comparison is always true or always false due to the limited
5831 range of the data type, but do not warn for constant expressions.  For
5832 example, warn if an unsigned variable is compared against zero with
5833 @code{<} or @code{>=}.  This warning is also enabled by
5834 @option{-Wextra}.
5836 @include cppwarnopts.texi
5838 @item -Wbad-function-cast @r{(C and Objective-C only)}
5839 @opindex Wbad-function-cast
5840 @opindex Wno-bad-function-cast
5841 Warn when a function call is cast to a non-matching type.
5842 For example, warn if a call to a function returning an integer type 
5843 is cast to a pointer type.
5845 @item -Wc90-c99-compat @r{(C and Objective-C only)}
5846 @opindex Wc90-c99-compat
5847 @opindex Wno-c90-c99-compat
5848 Warn about features not present in ISO C90, but present in ISO C99.
5849 For instance, warn about use of variable length arrays, @code{long long}
5850 type, @code{bool} type, compound literals, designated initializers, and so
5851 on.  This option is independent of the standards mode.  Warnings are disabled
5852 in the expression that follows @code{__extension__}.
5854 @item -Wc99-c11-compat @r{(C and Objective-C only)}
5855 @opindex Wc99-c11-compat
5856 @opindex Wno-c99-c11-compat
5857 Warn about features not present in ISO C99, but present in ISO C11.
5858 For instance, warn about use of anonymous structures and unions,
5859 @code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier,
5860 @code{_Alignas} specifier, @code{Alignof} operator, @code{_Generic} keyword,
5861 and so on.  This option is independent of the standards mode.  Warnings are
5862 disabled in the expression that follows @code{__extension__}.
5864 @item -Wc++-compat @r{(C and Objective-C only)}
5865 @opindex Wc++-compat
5866 Warn about ISO C constructs that are outside of the common subset of
5867 ISO C and ISO C++, e.g.@: request for implicit conversion from
5868 @code{void *} to a pointer to non-@code{void} type.
5870 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
5871 @opindex Wc++11-compat
5872 Warn about C++ constructs whose meaning differs between ISO C++ 1998
5873 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
5874 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
5875 enabled by @option{-Wall}.
5877 @item -Wc++14-compat @r{(C++ and Objective-C++ only)}
5878 @opindex Wc++14-compat
5879 Warn about C++ constructs whose meaning differs between ISO C++ 2011
5880 and ISO C++ 2014.  This warning is enabled by @option{-Wall}.
5882 @item -Wc++1z-compat @r{(C++ and Objective-C++ only)}
5883 @opindex Wc++1z-compat
5884 Warn about C++ constructs whose meaning differs between ISO C++ 2014
5885 and the forthoming ISO C++ 2017(?).  This warning is enabled by @option{-Wall}.
5887 @item -Wcast-qual
5888 @opindex Wcast-qual
5889 @opindex Wno-cast-qual
5890 Warn whenever a pointer is cast so as to remove a type qualifier from
5891 the target type.  For example, warn if a @code{const char *} is cast
5892 to an ordinary @code{char *}.
5894 Also warn when making a cast that introduces a type qualifier in an
5895 unsafe way.  For example, casting @code{char **} to @code{const char **}
5896 is unsafe, as in this example:
5898 @smallexample
5899   /* p is char ** value.  */
5900   const char **q = (const char **) p;
5901   /* Assignment of readonly string to const char * is OK.  */
5902   *q = "string";
5903   /* Now char** pointer points to read-only memory.  */
5904   **p = 'b';
5905 @end smallexample
5907 @item -Wcast-align
5908 @opindex Wcast-align
5909 @opindex Wno-cast-align
5910 Warn whenever a pointer is cast such that the required alignment of the
5911 target is increased.  For example, warn if a @code{char *} is cast to
5912 an @code{int *} on machines where integers can only be accessed at
5913 two- or four-byte boundaries.
5915 @item -Wwrite-strings
5916 @opindex Wwrite-strings
5917 @opindex Wno-write-strings
5918 When compiling C, give string constants the type @code{const
5919 char[@var{length}]} so that copying the address of one into a
5920 non-@code{const} @code{char *} pointer produces a warning.  These
5921 warnings help you find at compile time code that can try to write
5922 into a string constant, but only if you have been very careful about
5923 using @code{const} in declarations and prototypes.  Otherwise, it is
5924 just a nuisance. This is why we did not make @option{-Wall} request
5925 these warnings.
5927 When compiling C++, warn about the deprecated conversion from string
5928 literals to @code{char *}.  This warning is enabled by default for C++
5929 programs.
5931 @item -Wcatch-value
5932 @itemx -Wcatch-value=@var{n} @r{(C++ and Objective-C++ only)}
5933 @opindex Wcatch-value
5934 @opindex Wno-catch-value
5935 Warn about catch handlers that do not catch via reference.
5936 With @option{-Wcatch-value=1} (or @option{-Wcatch-value} for short)
5937 warn about polymorphic class types that are caught by value.
5938 With @option{-Wcatch-value=2} warn about all class types that are caught
5939 by value. With @option{-Wcatch-value=3} warn about all types that are
5940 not caught by reference. @option{-Wcatch-value} is enabled by @option{-Wall}.
5942 @item -Wclobbered
5943 @opindex Wclobbered
5944 @opindex Wno-clobbered
5945 Warn for variables that might be changed by @code{longjmp} or
5946 @code{vfork}.  This warning is also enabled by @option{-Wextra}.
5948 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
5949 @opindex Wconditionally-supported
5950 @opindex Wno-conditionally-supported
5951 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
5953 @item -Wconversion
5954 @opindex Wconversion
5955 @opindex Wno-conversion
5956 Warn for implicit conversions that may alter a value. This includes
5957 conversions between real and integer, like @code{abs (x)} when
5958 @code{x} is @code{double}; conversions between signed and unsigned,
5959 like @code{unsigned ui = -1}; and conversions to smaller types, like
5960 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
5961 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
5962 changed by the conversion like in @code{abs (2.0)}.  Warnings about
5963 conversions between signed and unsigned integers can be disabled by
5964 using @option{-Wno-sign-conversion}.
5966 For C++, also warn for confusing overload resolution for user-defined
5967 conversions; and conversions that never use a type conversion
5968 operator: conversions to @code{void}, the same type, a base class or a
5969 reference to them. Warnings about conversions between signed and
5970 unsigned integers are disabled by default in C++ unless
5971 @option{-Wsign-conversion} is explicitly enabled.
5973 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
5974 @opindex Wconversion-null
5975 @opindex Wno-conversion-null
5976 Do not warn for conversions between @code{NULL} and non-pointer
5977 types. @option{-Wconversion-null} is enabled by default.
5979 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
5980 @opindex Wzero-as-null-pointer-constant
5981 @opindex Wno-zero-as-null-pointer-constant
5982 Warn when a literal @samp{0} is used as null pointer constant.  This can
5983 be useful to facilitate the conversion to @code{nullptr} in C++11.
5985 @item -Wsubobject-linkage @r{(C++ and Objective-C++ only)}
5986 @opindex Wsubobject-linkage
5987 @opindex Wno-subobject-linkage
5988 Warn if a class type has a base or a field whose type uses the anonymous
5989 namespace or depends on a type with no linkage.  If a type A depends on
5990 a type B with no or internal linkage, defining it in multiple
5991 translation units would be an ODR violation because the meaning of B
5992 is different in each translation unit.  If A only appears in a single
5993 translation unit, the best way to silence the warning is to give it
5994 internal linkage by putting it in an anonymous namespace as well.  The
5995 compiler doesn't give this warning for types defined in the main .C
5996 file, as those are unlikely to have multiple definitions.
5997 @option{-Wsubobject-linkage} is enabled by default.
5999 @item -Wdangling-else
6000 @opindex Wdangling-else
6001 @opindex Wno-dangling-else
6002 Warn about constructions where there may be confusion to which
6003 @code{if} statement an @code{else} branch belongs.  Here is an example of
6004 such a case:
6006 @smallexample
6007 @group
6009   if (a)
6010     if (b)
6011       foo ();
6012   else
6013     bar ();
6015 @end group
6016 @end smallexample
6018 In C/C++, every @code{else} branch belongs to the innermost possible
6019 @code{if} statement, which in this example is @code{if (b)}.  This is
6020 often not what the programmer expected, as illustrated in the above
6021 example by indentation the programmer chose.  When there is the
6022 potential for this confusion, GCC issues a warning when this flag
6023 is specified.  To eliminate the warning, add explicit braces around
6024 the innermost @code{if} statement so there is no way the @code{else}
6025 can belong to the enclosing @code{if}.  The resulting code
6026 looks like this:
6028 @smallexample
6029 @group
6031   if (a)
6032     @{
6033       if (b)
6034         foo ();
6035       else
6036         bar ();
6037     @}
6039 @end group
6040 @end smallexample
6042 This warning is enabled by @option{-Wparentheses}.
6044 @item -Wdate-time
6045 @opindex Wdate-time
6046 @opindex Wno-date-time
6047 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
6048 are encountered as they might prevent bit-wise-identical reproducible
6049 compilations.
6051 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
6052 @opindex Wdelete-incomplete
6053 @opindex Wno-delete-incomplete
6054 Warn when deleting a pointer to incomplete type, which may cause
6055 undefined behavior at runtime.  This warning is enabled by default.
6057 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
6058 @opindex Wuseless-cast
6059 @opindex Wno-useless-cast
6060 Warn when an expression is casted to its own type.
6062 @item -Wempty-body
6063 @opindex Wempty-body
6064 @opindex Wno-empty-body
6065 Warn if an empty body occurs in an @code{if}, @code{else} or @code{do
6066 while} statement.  This warning is also enabled by @option{-Wextra}.
6068 @item -Wenum-compare
6069 @opindex Wenum-compare
6070 @opindex Wno-enum-compare
6071 Warn about a comparison between values of different enumerated types.
6072 In C++ enumerated type mismatches in conditional expressions are also
6073 diagnosed and the warning is enabled by default.  In C this warning is 
6074 enabled by @option{-Wall}.
6076 @item -Wextra-semi @r{(C++, Objective-C++ only)}
6077 @opindex Wextra-semi
6078 @opindex Wno-extra-semi
6079 Warn about redundant semicolon after in-class function definition.
6081 @item -Wjump-misses-init @r{(C, Objective-C only)}
6082 @opindex Wjump-misses-init
6083 @opindex Wno-jump-misses-init
6084 Warn if a @code{goto} statement or a @code{switch} statement jumps
6085 forward across the initialization of a variable, or jumps backward to a
6086 label after the variable has been initialized.  This only warns about
6087 variables that are initialized when they are declared.  This warning is
6088 only supported for C and Objective-C; in C++ this sort of branch is an
6089 error in any case.
6091 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
6092 can be disabled with the @option{-Wno-jump-misses-init} option.
6094 @item -Wsign-compare
6095 @opindex Wsign-compare
6096 @opindex Wno-sign-compare
6097 @cindex warning for comparison of signed and unsigned values
6098 @cindex comparison of signed and unsigned values, warning
6099 @cindex signed and unsigned values, comparison warning
6100 Warn when a comparison between signed and unsigned values could produce
6101 an incorrect result when the signed value is converted to unsigned.
6102 In C++, this warning is also enabled by @option{-Wall}.  In C, it is
6103 also enabled by @option{-Wextra}.
6105 @item -Wsign-conversion
6106 @opindex Wsign-conversion
6107 @opindex Wno-sign-conversion
6108 Warn for implicit conversions that may change the sign of an integer
6109 value, like assigning a signed integer expression to an unsigned
6110 integer variable. An explicit cast silences the warning. In C, this
6111 option is enabled also by @option{-Wconversion}.
6113 @item -Wfloat-conversion
6114 @opindex Wfloat-conversion
6115 @opindex Wno-float-conversion
6116 Warn for implicit conversions that reduce the precision of a real value.
6117 This includes conversions from real to integer, and from higher precision
6118 real to lower precision real values.  This option is also enabled by
6119 @option{-Wconversion}.
6121 @item -Wno-scalar-storage-order
6122 @opindex -Wno-scalar-storage-order
6123 @opindex -Wscalar-storage-order
6124 Do not warn on suspicious constructs involving reverse scalar storage order.
6126 @item -Wsized-deallocation @r{(C++ and Objective-C++ only)}
6127 @opindex Wsized-deallocation
6128 @opindex Wno-sized-deallocation
6129 Warn about a definition of an unsized deallocation function
6130 @smallexample
6131 void operator delete (void *) noexcept;
6132 void operator delete[] (void *) noexcept;
6133 @end smallexample
6134 without a definition of the corresponding sized deallocation function
6135 @smallexample
6136 void operator delete (void *, std::size_t) noexcept;
6137 void operator delete[] (void *, std::size_t) noexcept;
6138 @end smallexample
6139 or vice versa.  Enabled by @option{-Wextra} along with
6140 @option{-fsized-deallocation}.
6142 @item -Wsizeof-pointer-div
6143 @opindex Wsizeof-pointer-div
6144 @opindex Wno-sizeof-pointer-div
6145 Warn for suspicious divisions of two sizeof expressions that divide
6146 the pointer size by the element size, which is the usual way to compute
6147 the array size but won't work out correctly with pointers.  This warning
6148 warns e.g.@: about @code{sizeof (ptr) / sizeof (ptr[0])} if @code{ptr} is
6149 not an array, but a pointer.  This warning is enabled by @option{-Wall}.
6151 @item -Wsizeof-pointer-memaccess
6152 @opindex Wsizeof-pointer-memaccess
6153 @opindex Wno-sizeof-pointer-memaccess
6154 Warn for suspicious length parameters to certain string and memory built-in
6155 functions if the argument uses @code{sizeof}.  This warning warns e.g.@:
6156 about @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not an array,
6157 but a pointer, and suggests a possible fix, or about
6158 @code{memcpy (&foo, ptr, sizeof (&foo));}.  This warning is enabled by
6159 @option{-Wall}.
6161 @item -Wsizeof-array-argument
6162 @opindex Wsizeof-array-argument
6163 @opindex Wno-sizeof-array-argument
6164 Warn when the @code{sizeof} operator is applied to a parameter that is
6165 declared as an array in a function definition.  This warning is enabled by
6166 default for C and C++ programs.
6168 @item -Wmemset-elt-size
6169 @opindex Wmemset-elt-size
6170 @opindex Wno-memset-elt-size
6171 Warn for suspicious calls to the @code{memset} built-in function, if the
6172 first argument references an array, and the third argument is a number
6173 equal to the number of elements, but not equal to the size of the array
6174 in memory.  This indicates that the user has omitted a multiplication by
6175 the element size.  This warning is enabled by @option{-Wall}.
6177 @item -Wmemset-transposed-args
6178 @opindex Wmemset-transposed-args
6179 @opindex Wno-memset-transposed-args
6180 Warn for suspicious calls to the @code{memset} built-in function, if the
6181 second argument is not zero and the third argument is zero.  This warns e.g.@
6182 about @code{memset (buf, sizeof buf, 0)} where most probably
6183 @code{memset (buf, 0, sizeof buf)} was meant instead.  The diagnostics
6184 is only emitted if the third argument is literal zero.  If it is some
6185 expression that is folded to zero, a cast of zero to some type, etc., 
6186 it is far less likely that the user has mistakenly exchanged the arguments 
6187 and no warning is emitted.  This warning is enabled by @option{-Wall}.
6189 @item -Waddress
6190 @opindex Waddress
6191 @opindex Wno-address
6192 Warn about suspicious uses of memory addresses. These include using
6193 the address of a function in a conditional expression, such as
6194 @code{void func(void); if (func)}, and comparisons against the memory
6195 address of a string literal, such as @code{if (x == "abc")}.  Such
6196 uses typically indicate a programmer error: the address of a function
6197 always evaluates to true, so their use in a conditional usually
6198 indicate that the programmer forgot the parentheses in a function
6199 call; and comparisons against string literals result in unspecified
6200 behavior and are not portable in C, so they usually indicate that the
6201 programmer intended to use @code{strcmp}.  This warning is enabled by
6202 @option{-Wall}.
6204 @item -Wlogical-op
6205 @opindex Wlogical-op
6206 @opindex Wno-logical-op
6207 Warn about suspicious uses of logical operators in expressions.
6208 This includes using logical operators in contexts where a
6209 bit-wise operator is likely to be expected.  Also warns when
6210 the operands of a logical operator are the same:
6211 @smallexample
6212 extern int a;
6213 if (a < 0 && a < 0) @{ @dots{} @}
6214 @end smallexample
6216 @item -Wlogical-not-parentheses
6217 @opindex Wlogical-not-parentheses
6218 @opindex Wno-logical-not-parentheses
6219 Warn about logical not used on the left hand side operand of a comparison.
6220 This option does not warn if the right operand is considered to be a boolean
6221 expression.  Its purpose is to detect suspicious code like the following:
6222 @smallexample
6223 int a;
6224 @dots{}
6225 if (!a > 1) @{ @dots{} @}
6226 @end smallexample
6228 It is possible to suppress the warning by wrapping the LHS into
6229 parentheses:
6230 @smallexample
6231 if ((!a) > 1) @{ @dots{} @}
6232 @end smallexample
6234 This warning is enabled by @option{-Wall}.
6236 @item -Waggregate-return
6237 @opindex Waggregate-return
6238 @opindex Wno-aggregate-return
6239 Warn if any functions that return structures or unions are defined or
6240 called.  (In languages where you can return an array, this also elicits
6241 a warning.)
6243 @item -Wno-aggressive-loop-optimizations
6244 @opindex Wno-aggressive-loop-optimizations
6245 @opindex Waggressive-loop-optimizations
6246 Warn if in a loop with constant number of iterations the compiler detects
6247 undefined behavior in some statement during one or more of the iterations.
6249 @item -Wno-attributes
6250 @opindex Wno-attributes
6251 @opindex Wattributes
6252 Do not warn if an unexpected @code{__attribute__} is used, such as
6253 unrecognized attributes, function attributes applied to variables,
6254 etc.  This does not stop errors for incorrect use of supported
6255 attributes.
6257 @item -Wno-builtin-declaration-mismatch
6258 @opindex Wno-builtin-declaration-mismatch
6259 @opindex Wbuiltin-declaration-mismatch
6260 Warn if a built-in function is declared with the wrong signature.
6261 This warning is enabled by default.
6263 @item -Wno-builtin-macro-redefined
6264 @opindex Wno-builtin-macro-redefined
6265 @opindex Wbuiltin-macro-redefined
6266 Do not warn if certain built-in macros are redefined.  This suppresses
6267 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
6268 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
6270 @item -Wstrict-prototypes @r{(C and Objective-C only)}
6271 @opindex Wstrict-prototypes
6272 @opindex Wno-strict-prototypes
6273 Warn if a function is declared or defined without specifying the
6274 argument types.  (An old-style function definition is permitted without
6275 a warning if preceded by a declaration that specifies the argument
6276 types.)
6278 @item -Wold-style-declaration @r{(C and Objective-C only)}
6279 @opindex Wold-style-declaration
6280 @opindex Wno-old-style-declaration
6281 Warn for obsolescent usages, according to the C Standard, in a
6282 declaration. For example, warn if storage-class specifiers like
6283 @code{static} are not the first things in a declaration.  This warning
6284 is also enabled by @option{-Wextra}.
6286 @item -Wold-style-definition @r{(C and Objective-C only)}
6287 @opindex Wold-style-definition
6288 @opindex Wno-old-style-definition
6289 Warn if an old-style function definition is used.  A warning is given
6290 even if there is a previous prototype.
6292 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
6293 @opindex Wmissing-parameter-type
6294 @opindex Wno-missing-parameter-type
6295 A function parameter is declared without a type specifier in K&R-style
6296 functions:
6298 @smallexample
6299 void foo(bar) @{ @}
6300 @end smallexample
6302 This warning is also enabled by @option{-Wextra}.
6304 @item -Wmissing-prototypes @r{(C and Objective-C only)}
6305 @opindex Wmissing-prototypes
6306 @opindex Wno-missing-prototypes
6307 Warn if a global function is defined without a previous prototype
6308 declaration.  This warning is issued even if the definition itself
6309 provides a prototype.  Use this option to detect global functions
6310 that do not have a matching prototype declaration in a header file.
6311 This option is not valid for C++ because all function declarations
6312 provide prototypes and a non-matching declaration declares an
6313 overload rather than conflict with an earlier declaration.
6314 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
6316 @item -Wmissing-declarations
6317 @opindex Wmissing-declarations
6318 @opindex Wno-missing-declarations
6319 Warn if a global function is defined without a previous declaration.
6320 Do so even if the definition itself provides a prototype.
6321 Use this option to detect global functions that are not declared in
6322 header files.  In C, no warnings are issued for functions with previous
6323 non-prototype declarations; use @option{-Wmissing-prototypes} to detect
6324 missing prototypes.  In C++, no warnings are issued for function templates,
6325 or for inline functions, or for functions in anonymous namespaces.
6327 @item -Wmissing-field-initializers
6328 @opindex Wmissing-field-initializers
6329 @opindex Wno-missing-field-initializers
6330 @opindex W
6331 @opindex Wextra
6332 @opindex Wno-extra
6333 Warn if a structure's initializer has some fields missing.  For
6334 example, the following code causes such a warning, because
6335 @code{x.h} is implicitly zero:
6337 @smallexample
6338 struct s @{ int f, g, h; @};
6339 struct s x = @{ 3, 4 @};
6340 @end smallexample
6342 This option does not warn about designated initializers, so the following
6343 modification does not trigger a warning:
6345 @smallexample
6346 struct s @{ int f, g, h; @};
6347 struct s x = @{ .f = 3, .g = 4 @};
6348 @end smallexample
6350 In C this option does not warn about the universal zero initializer
6351 @samp{@{ 0 @}}:
6353 @smallexample
6354 struct s @{ int f, g, h; @};
6355 struct s x = @{ 0 @};
6356 @end smallexample
6358 Likewise, in C++ this option does not warn about the empty @{ @}
6359 initializer, for example:
6361 @smallexample
6362 struct s @{ int f, g, h; @};
6363 s x = @{ @};
6364 @end smallexample
6366 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
6367 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
6369 @item -Wno-multichar
6370 @opindex Wno-multichar
6371 @opindex Wmultichar
6372 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
6373 Usually they indicate a typo in the user's code, as they have
6374 implementation-defined values, and should not be used in portable code.
6376 @item -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]}
6377 @opindex Wnormalized=
6378 @opindex Wnormalized
6379 @opindex Wno-normalized
6380 @cindex NFC
6381 @cindex NFKC
6382 @cindex character set, input normalization
6383 In ISO C and ISO C++, two identifiers are different if they are
6384 different sequences of characters.  However, sometimes when characters
6385 outside the basic ASCII character set are used, you can have two
6386 different character sequences that look the same.  To avoid confusion,
6387 the ISO 10646 standard sets out some @dfn{normalization rules} which
6388 when applied ensure that two sequences that look the same are turned into
6389 the same sequence.  GCC can warn you if you are using identifiers that
6390 have not been normalized; this option controls that warning.
6392 There are four levels of warning supported by GCC@.  The default is
6393 @option{-Wnormalized=nfc}, which warns about any identifier that is
6394 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
6395 recommended form for most uses.  It is equivalent to
6396 @option{-Wnormalized}.
6398 Unfortunately, there are some characters allowed in identifiers by
6399 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
6400 identifiers.  That is, there's no way to use these symbols in portable
6401 ISO C or C++ and have all your identifiers in NFC@.
6402 @option{-Wnormalized=id} suppresses the warning for these characters.
6403 It is hoped that future versions of the standards involved will correct
6404 this, which is why this option is not the default.
6406 You can switch the warning off for all characters by writing
6407 @option{-Wnormalized=none} or @option{-Wno-normalized}.  You should
6408 only do this if you are using some other normalization scheme (like
6409 ``D''), because otherwise you can easily create bugs that are
6410 literally impossible to see.
6412 Some characters in ISO 10646 have distinct meanings but look identical
6413 in some fonts or display methodologies, especially once formatting has
6414 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
6415 LETTER N'', displays just like a regular @code{n} that has been
6416 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
6417 normalization scheme to convert all these into a standard form as
6418 well, and GCC warns if your code is not in NFKC if you use
6419 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
6420 about every identifier that contains the letter O because it might be
6421 confused with the digit 0, and so is not the default, but may be
6422 useful as a local coding convention if the programming environment 
6423 cannot be fixed to display these characters distinctly.
6425 @item -Wno-deprecated
6426 @opindex Wno-deprecated
6427 @opindex Wdeprecated
6428 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
6430 @item -Wno-deprecated-declarations
6431 @opindex Wno-deprecated-declarations
6432 @opindex Wdeprecated-declarations
6433 Do not warn about uses of functions (@pxref{Function Attributes}),
6434 variables (@pxref{Variable Attributes}), and types (@pxref{Type
6435 Attributes}) marked as deprecated by using the @code{deprecated}
6436 attribute.
6438 @item -Wno-overflow
6439 @opindex Wno-overflow
6440 @opindex Woverflow
6441 Do not warn about compile-time overflow in constant expressions.
6443 @item -Wno-odr
6444 @opindex Wno-odr
6445 @opindex Wodr
6446 Warn about One Definition Rule violations during link-time optimization.
6447 Requires @option{-flto-odr-type-merging} to be enabled.  Enabled by default.
6449 @item -Wopenmp-simd
6450 @opindex Wopenm-simd
6451 Warn if the vectorizer cost model overrides the OpenMP or the Cilk Plus
6452 simd directive set by user.  The @option{-fsimd-cost-model=unlimited}
6453 option can be used to relax the cost model.
6455 @item -Woverride-init @r{(C and Objective-C only)}
6456 @opindex Woverride-init
6457 @opindex Wno-override-init
6458 @opindex W
6459 @opindex Wextra
6460 @opindex Wno-extra
6461 Warn if an initialized field without side effects is overridden when
6462 using designated initializers (@pxref{Designated Inits, , Designated
6463 Initializers}).
6465 This warning is included in @option{-Wextra}.  To get other
6466 @option{-Wextra} warnings without this one, use @option{-Wextra
6467 -Wno-override-init}.
6469 @item -Woverride-init-side-effects @r{(C and Objective-C only)}
6470 @opindex Woverride-init-side-effects
6471 @opindex Wno-override-init-side-effects
6472 Warn if an initialized field with side effects is overridden when
6473 using designated initializers (@pxref{Designated Inits, , Designated
6474 Initializers}).  This warning is enabled by default.
6476 @item -Wpacked
6477 @opindex Wpacked
6478 @opindex Wno-packed
6479 Warn if a structure is given the packed attribute, but the packed
6480 attribute has no effect on the layout or size of the structure.
6481 Such structures may be mis-aligned for little benefit.  For
6482 instance, in this code, the variable @code{f.x} in @code{struct bar}
6483 is misaligned even though @code{struct bar} does not itself
6484 have the packed attribute:
6486 @smallexample
6487 @group
6488 struct foo @{
6489   int x;
6490   char a, b, c, d;
6491 @} __attribute__((packed));
6492 struct bar @{
6493   char z;
6494   struct foo f;
6496 @end group
6497 @end smallexample
6499 @item -Wpacked-bitfield-compat
6500 @opindex Wpacked-bitfield-compat
6501 @opindex Wno-packed-bitfield-compat
6502 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
6503 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
6504 the change can lead to differences in the structure layout.  GCC
6505 informs you when the offset of such a field has changed in GCC 4.4.
6506 For example there is no longer a 4-bit padding between field @code{a}
6507 and @code{b} in this structure:
6509 @smallexample
6510 struct foo
6512   char a:4;
6513   char b:8;
6514 @} __attribute__ ((packed));
6515 @end smallexample
6517 This warning is enabled by default.  Use
6518 @option{-Wno-packed-bitfield-compat} to disable this warning.
6520 @item -Wpadded
6521 @opindex Wpadded
6522 @opindex Wno-padded
6523 Warn if padding is included in a structure, either to align an element
6524 of the structure or to align the whole structure.  Sometimes when this
6525 happens it is possible to rearrange the fields of the structure to
6526 reduce the padding and so make the structure smaller.
6528 @item -Wredundant-decls
6529 @opindex Wredundant-decls
6530 @opindex Wno-redundant-decls
6531 Warn if anything is declared more than once in the same scope, even in
6532 cases where multiple declaration is valid and changes nothing.
6534 @item -Wrestrict
6535 @opindex Wrestrict
6536 @opindex Wno-restrict
6537 Warn when an argument passed to a restrict-qualified parameter
6538 aliases with another argument.
6540 @item -Wnested-externs @r{(C and Objective-C only)}
6541 @opindex Wnested-externs
6542 @opindex Wno-nested-externs
6543 Warn if an @code{extern} declaration is encountered within a function.
6545 @item -Wno-inherited-variadic-ctor
6546 @opindex Winherited-variadic-ctor
6547 @opindex Wno-inherited-variadic-ctor
6548 Suppress warnings about use of C++11 inheriting constructors when the
6549 base class inherited from has a C variadic constructor; the warning is
6550 on by default because the ellipsis is not inherited.
6552 @item -Winline
6553 @opindex Winline
6554 @opindex Wno-inline
6555 Warn if a function that is declared as inline cannot be inlined.
6556 Even with this option, the compiler does not warn about failures to
6557 inline functions declared in system headers.
6559 The compiler uses a variety of heuristics to determine whether or not
6560 to inline a function.  For example, the compiler takes into account
6561 the size of the function being inlined and the amount of inlining
6562 that has already been done in the current function.  Therefore,
6563 seemingly insignificant changes in the source program can cause the
6564 warnings produced by @option{-Winline} to appear or disappear.
6566 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
6567 @opindex Wno-invalid-offsetof
6568 @opindex Winvalid-offsetof
6569 Suppress warnings from applying the @code{offsetof} macro to a non-POD
6570 type.  According to the 2014 ISO C++ standard, applying @code{offsetof}
6571 to a non-standard-layout type is undefined.  In existing C++ implementations,
6572 however, @code{offsetof} typically gives meaningful results.
6573 This flag is for users who are aware that they are
6574 writing nonportable code and who have deliberately chosen to ignore the
6575 warning about it.
6577 The restrictions on @code{offsetof} may be relaxed in a future version
6578 of the C++ standard.
6580 @item -Wint-in-bool-context
6581 @opindex Wint-in-bool-context
6582 @opindex Wno-int-in-bool-context
6583 Warn for suspicious use of integer values where boolean values are expected,
6584 such as conditional expressions (?:) using non-boolean integer constants in
6585 boolean context, like @code{if (a <= b ? 2 : 3)}.  Or left shifting of signed
6586 integers in boolean context, like @code{for (a = 0; 1 << a; a++);}.  Likewise
6587 for all kinds of multiplications regardless of the data type.
6588 This warning is enabled by @option{-Wall}.
6590 @item -Wno-int-to-pointer-cast
6591 @opindex Wno-int-to-pointer-cast
6592 @opindex Wint-to-pointer-cast
6593 Suppress warnings from casts to pointer type of an integer of a
6594 different size. In C++, casting to a pointer type of smaller size is
6595 an error. @option{Wint-to-pointer-cast} is enabled by default.
6598 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
6599 @opindex Wno-pointer-to-int-cast
6600 @opindex Wpointer-to-int-cast
6601 Suppress warnings from casts from a pointer to an integer type of a
6602 different size.
6604 @item -Winvalid-pch
6605 @opindex Winvalid-pch
6606 @opindex Wno-invalid-pch
6607 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
6608 the search path but cannot be used.
6610 @item -Wlong-long
6611 @opindex Wlong-long
6612 @opindex Wno-long-long
6613 Warn if @code{long long} type is used.  This is enabled by either
6614 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
6615 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
6617 @item -Wvariadic-macros
6618 @opindex Wvariadic-macros
6619 @opindex Wno-variadic-macros
6620 Warn if variadic macros are used in ISO C90 mode, or if the GNU
6621 alternate syntax is used in ISO C99 mode.  This is enabled by either
6622 @option{-Wpedantic} or @option{-Wtraditional}.  To inhibit the warning
6623 messages, use @option{-Wno-variadic-macros}.
6625 @item -Wvarargs
6626 @opindex Wvarargs
6627 @opindex Wno-varargs
6628 Warn upon questionable usage of the macros used to handle variable
6629 arguments like @code{va_start}.  This is default.  To inhibit the
6630 warning messages, use @option{-Wno-varargs}.
6632 @item -Wvector-operation-performance
6633 @opindex Wvector-operation-performance
6634 @opindex Wno-vector-operation-performance
6635 Warn if vector operation is not implemented via SIMD capabilities of the
6636 architecture.  Mainly useful for the performance tuning.
6637 Vector operation can be implemented @code{piecewise}, which means that the
6638 scalar operation is performed on every vector element; 
6639 @code{in parallel}, which means that the vector operation is implemented
6640 using scalars of wider type, which normally is more performance efficient;
6641 and @code{as a single scalar}, which means that vector fits into a
6642 scalar type.
6644 @item -Wno-virtual-move-assign
6645 @opindex Wvirtual-move-assign
6646 @opindex Wno-virtual-move-assign
6647 Suppress warnings about inheriting from a virtual base with a
6648 non-trivial C++11 move assignment operator.  This is dangerous because
6649 if the virtual base is reachable along more than one path, it is
6650 moved multiple times, which can mean both objects end up in the
6651 moved-from state.  If the move assignment operator is written to avoid
6652 moving from a moved-from object, this warning can be disabled.
6654 @item -Wvla
6655 @opindex Wvla
6656 @opindex Wno-vla
6657 Warn if a variable-length array is used in the code.
6658 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
6659 the variable-length array.
6661 @item -Wvla-larger-than=@var{n}
6662 If this option is used, the compiler will warn on uses of
6663 variable-length arrays where the size is either unbounded, or bounded
6664 by an argument that can be larger than @var{n} bytes.  This is similar
6665 to how @option{-Walloca-larger-than=@var{n}} works, but with
6666 variable-length arrays.
6668 Note that GCC may optimize small variable-length arrays of a known
6669 value into plain arrays, so this warning may not get triggered for
6670 such arrays.
6672 This warning is not enabled by @option{-Wall}, and is only active when
6673 @option{-ftree-vrp} is active (default for @option{-O2} and above).
6675 See also @option{-Walloca-larger-than=@var{n}}.
6677 @item -Wvolatile-register-var
6678 @opindex Wvolatile-register-var
6679 @opindex Wno-volatile-register-var
6680 Warn if a register variable is declared volatile.  The volatile
6681 modifier does not inhibit all optimizations that may eliminate reads
6682 and/or writes to register variables.  This warning is enabled by
6683 @option{-Wall}.
6685 @item -Wdisabled-optimization
6686 @opindex Wdisabled-optimization
6687 @opindex Wno-disabled-optimization
6688 Warn if a requested optimization pass is disabled.  This warning does
6689 not generally indicate that there is anything wrong with your code; it
6690 merely indicates that GCC's optimizers are unable to handle the code
6691 effectively.  Often, the problem is that your code is too big or too
6692 complex; GCC refuses to optimize programs when the optimization
6693 itself is likely to take inordinate amounts of time.
6695 @item -Wpointer-sign @r{(C and Objective-C only)}
6696 @opindex Wpointer-sign
6697 @opindex Wno-pointer-sign
6698 Warn for pointer argument passing or assignment with different signedness.
6699 This option is only supported for C and Objective-C@.  It is implied by
6700 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
6701 @option{-Wno-pointer-sign}.
6703 @item -Wstack-protector
6704 @opindex Wstack-protector
6705 @opindex Wno-stack-protector
6706 This option is only active when @option{-fstack-protector} is active.  It
6707 warns about functions that are not protected against stack smashing.
6709 @item -Woverlength-strings
6710 @opindex Woverlength-strings
6711 @opindex Wno-overlength-strings
6712 Warn about string constants that are longer than the ``minimum
6713 maximum'' length specified in the C standard.  Modern compilers
6714 generally allow string constants that are much longer than the
6715 standard's minimum limit, but very portable programs should avoid
6716 using longer strings.
6718 The limit applies @emph{after} string constant concatenation, and does
6719 not count the trailing NUL@.  In C90, the limit was 509 characters; in
6720 C99, it was raised to 4095.  C++98 does not specify a normative
6721 minimum maximum, so we do not diagnose overlength strings in C++@.
6723 This option is implied by @option{-Wpedantic}, and can be disabled with
6724 @option{-Wno-overlength-strings}.
6726 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
6727 @opindex Wunsuffixed-float-constants
6729 Issue a warning for any floating constant that does not have
6730 a suffix.  When used together with @option{-Wsystem-headers} it
6731 warns about such constants in system header files.  This can be useful
6732 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
6733 from the decimal floating-point extension to C99.
6735 @item -Wno-designated-init @r{(C and Objective-C only)}
6736 Suppress warnings when a positional initializer is used to initialize
6737 a structure that has been marked with the @code{designated_init}
6738 attribute.
6740 @item -Whsa
6741 Issue a warning when HSAIL cannot be emitted for the compiled function or
6742 OpenMP construct.
6744 @end table
6746 @node Debugging Options
6747 @section Options for Debugging Your Program
6748 @cindex options, debugging
6749 @cindex debugging information options
6751 To tell GCC to emit extra information for use by a debugger, in almost 
6752 all cases you need only to add @option{-g} to your other options.
6754 GCC allows you to use @option{-g} with
6755 @option{-O}.  The shortcuts taken by optimized code may occasionally
6756 be surprising: some variables you declared may not exist
6757 at all; flow of control may briefly move where you did not expect it;
6758 some statements may not be executed because they compute constant
6759 results or their values are already at hand; some statements may
6760 execute in different places because they have been moved out of loops.
6761 Nevertheless it is possible to debug optimized output.  This makes
6762 it reasonable to use the optimizer for programs that might have bugs.
6764 If you are not using some other optimization option, consider
6765 using @option{-Og} (@pxref{Optimize Options}) with @option{-g}.  
6766 With no @option{-O} option at all, some compiler passes that collect
6767 information useful for debugging do not run at all, so that
6768 @option{-Og} may result in a better debugging experience.
6770 @table @gcctabopt
6771 @item -g
6772 @opindex g
6773 Produce debugging information in the operating system's native format
6774 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
6775 information.
6777 On most systems that use stabs format, @option{-g} enables use of extra
6778 debugging information that only GDB can use; this extra information
6779 makes debugging work better in GDB but probably makes other debuggers
6780 crash or
6781 refuse to read the program.  If you want to control for certain whether
6782 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
6783 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
6785 @item -ggdb
6786 @opindex ggdb
6787 Produce debugging information for use by GDB@.  This means to use the
6788 most expressive format available (DWARF, stabs, or the native format
6789 if neither of those are supported), including GDB extensions if at all
6790 possible.
6792 @item -gdwarf
6793 @itemx -gdwarf-@var{version}
6794 @opindex gdwarf
6795 Produce debugging information in DWARF format (if that is supported).
6796 The value of @var{version} may be either 2, 3, 4 or 5; the default version
6797 for most targets is 4.  DWARF Version 5 is only experimental.
6799 Note that with DWARF Version 2, some ports require and always
6800 use some non-conflicting DWARF 3 extensions in the unwind tables.
6802 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
6803 for maximum benefit.
6805 GCC no longer supports DWARF Version 1, which is substantially
6806 different than Version 2 and later.  For historical reasons, some
6807 other DWARF-related options (including @option{-feliminate-dwarf2-dups} 
6808 and @option{-fno-dwarf2-cfi-asm}) retain a reference to DWARF Version 2
6809 in their names, but apply to all currently-supported versions of DWARF.
6811 @item -gstabs
6812 @opindex gstabs
6813 Produce debugging information in stabs format (if that is supported),
6814 without GDB extensions.  This is the format used by DBX on most BSD
6815 systems.  On MIPS, Alpha and System V Release 4 systems this option
6816 produces stabs debugging output that is not understood by DBX or SDB@.
6817 On System V Release 4 systems this option requires the GNU assembler.
6819 @item -gstabs+
6820 @opindex gstabs+
6821 Produce debugging information in stabs format (if that is supported),
6822 using GNU extensions understood only by the GNU debugger (GDB)@.  The
6823 use of these extensions is likely to make other debuggers crash or
6824 refuse to read the program.
6826 @item -gcoff
6827 @opindex gcoff
6828 Produce debugging information in COFF format (if that is supported).
6829 This is the format used by SDB on most System V systems prior to
6830 System V Release 4.
6832 @item -gxcoff
6833 @opindex gxcoff
6834 Produce debugging information in XCOFF format (if that is supported).
6835 This is the format used by the DBX debugger on IBM RS/6000 systems.
6837 @item -gxcoff+
6838 @opindex gxcoff+
6839 Produce debugging information in XCOFF format (if that is supported),
6840 using GNU extensions understood only by the GNU debugger (GDB)@.  The
6841 use of these extensions is likely to make other debuggers crash or
6842 refuse to read the program, and may cause assemblers other than the GNU
6843 assembler (GAS) to fail with an error.
6845 @item -gvms
6846 @opindex gvms
6847 Produce debugging information in Alpha/VMS debug format (if that is
6848 supported).  This is the format used by DEBUG on Alpha/VMS systems.
6850 @item -g@var{level}
6851 @itemx -ggdb@var{level}
6852 @itemx -gstabs@var{level}
6853 @itemx -gcoff@var{level}
6854 @itemx -gxcoff@var{level}
6855 @itemx -gvms@var{level}
6856 Request debugging information and also use @var{level} to specify how
6857 much information.  The default level is 2.
6859 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
6860 @option{-g}.
6862 Level 1 produces minimal information, enough for making backtraces in
6863 parts of the program that you don't plan to debug.  This includes
6864 descriptions of functions and external variables, and line number
6865 tables, but no information about local variables.
6867 Level 3 includes extra information, such as all the macro definitions
6868 present in the program.  Some debuggers support macro expansion when
6869 you use @option{-g3}.
6871 @option{-gdwarf} does not accept a concatenated debug level, to avoid
6872 confusion with @option{-gdwarf-@var{level}}.
6873 Instead use an additional @option{-g@var{level}} option to change the
6874 debug level for DWARF.
6876 @item -feliminate-unused-debug-symbols
6877 @opindex feliminate-unused-debug-symbols
6878 Produce debugging information in stabs format (if that is supported),
6879 for only symbols that are actually used.
6881 @item -femit-class-debug-always
6882 @opindex femit-class-debug-always
6883 Instead of emitting debugging information for a C++ class in only one
6884 object file, emit it in all object files using the class.  This option
6885 should be used only with debuggers that are unable to handle the way GCC
6886 normally emits debugging information for classes because using this
6887 option increases the size of debugging information by as much as a
6888 factor of two.
6890 @item -fno-merge-debug-strings
6891 @opindex fmerge-debug-strings
6892 @opindex fno-merge-debug-strings
6893 Direct the linker to not merge together strings in the debugging
6894 information that are identical in different object files.  Merging is
6895 not supported by all assemblers or linkers.  Merging decreases the size
6896 of the debug information in the output file at the cost of increasing
6897 link processing time.  Merging is enabled by default.
6899 @item -fdebug-prefix-map=@var{old}=@var{new}
6900 @opindex fdebug-prefix-map
6901 When compiling files in directory @file{@var{old}}, record debugging
6902 information describing them as in @file{@var{new}} instead.
6904 @item -fvar-tracking
6905 @opindex fvar-tracking
6906 Run variable tracking pass.  It computes where variables are stored at each
6907 position in code.  Better debugging information is then generated
6908 (if the debugging information format supports this information).
6910 It is enabled by default when compiling with optimization (@option{-Os},
6911 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
6912 the debug info format supports it.
6914 @item -fvar-tracking-assignments
6915 @opindex fvar-tracking-assignments
6916 @opindex fno-var-tracking-assignments
6917 Annotate assignments to user variables early in the compilation and
6918 attempt to carry the annotations over throughout the compilation all the
6919 way to the end, in an attempt to improve debug information while
6920 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
6922 It can be enabled even if var-tracking is disabled, in which case
6923 annotations are created and maintained, but discarded at the end.
6924 By default, this flag is enabled together with @option{-fvar-tracking},
6925 except when selective scheduling is enabled.
6927 @item -gsplit-dwarf
6928 @opindex gsplit-dwarf
6929 Separate as much DWARF debugging information as possible into a
6930 separate output file with the extension @file{.dwo}.  This option allows
6931 the build system to avoid linking files with debug information.  To
6932 be useful, this option requires a debugger capable of reading @file{.dwo}
6933 files.
6935 @item -gpubnames
6936 @opindex gpubnames
6937 Generate DWARF @code{.debug_pubnames} and @code{.debug_pubtypes} sections.
6939 @item -ggnu-pubnames
6940 @opindex ggnu-pubnames
6941 Generate @code{.debug_pubnames} and @code{.debug_pubtypes} sections in a format
6942 suitable for conversion into a GDB@ index.  This option is only useful
6943 with a linker that can produce GDB@ index version 7.
6945 @item -fdebug-types-section
6946 @opindex fdebug-types-section
6947 @opindex fno-debug-types-section
6948 When using DWARF Version 4 or higher, type DIEs can be put into
6949 their own @code{.debug_types} section instead of making them part of the
6950 @code{.debug_info} section.  It is more efficient to put them in a separate
6951 comdat sections since the linker can then remove duplicates.
6952 But not all DWARF consumers support @code{.debug_types} sections yet
6953 and on some objects @code{.debug_types} produces larger instead of smaller
6954 debugging information.
6956 @item -grecord-gcc-switches
6957 @item -gno-record-gcc-switches
6958 @opindex grecord-gcc-switches
6959 @opindex gno-record-gcc-switches
6960 This switch causes the command-line options used to invoke the
6961 compiler that may affect code generation to be appended to the
6962 DW_AT_producer attribute in DWARF debugging information.  The options
6963 are concatenated with spaces separating them from each other and from
6964 the compiler version.  
6965 It is enabled by default.
6966 See also @option{-frecord-gcc-switches} for another
6967 way of storing compiler options into the object file.  
6969 @item -gstrict-dwarf
6970 @opindex gstrict-dwarf
6971 Disallow using extensions of later DWARF standard version than selected
6972 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
6973 DWARF extensions from later standard versions is allowed.
6975 @item -gno-strict-dwarf
6976 @opindex gno-strict-dwarf
6977 Allow using extensions of later DWARF standard version than selected with
6978 @option{-gdwarf-@var{version}}.
6980 @item -gcolumn-info
6981 @item -gno-column-info
6982 @opindex gcolumn-info
6983 @opindex gno-column-info
6984 Emit location column information into DWARF debugging information, rather
6985 than just file and line.
6986 This option is disabled by default.
6988 @item -gz@r{[}=@var{type}@r{]}
6989 @opindex gz
6990 Produce compressed debug sections in DWARF format, if that is supported.
6991 If @var{type} is not given, the default type depends on the capabilities
6992 of the assembler and linker used.  @var{type} may be one of
6993 @samp{none} (don't compress debug sections), @samp{zlib} (use zlib
6994 compression in ELF gABI format), or @samp{zlib-gnu} (use zlib
6995 compression in traditional GNU format).  If the linker doesn't support
6996 writing compressed debug sections, the option is rejected.  Otherwise,
6997 if the assembler does not support them, @option{-gz} is silently ignored
6998 when producing object files.
7000 @item -feliminate-dwarf2-dups
7001 @opindex feliminate-dwarf2-dups
7002 Compress DWARF debugging information by eliminating duplicated
7003 information about each symbol.  This option only makes sense when
7004 generating DWARF debugging information.
7006 @item -femit-struct-debug-baseonly
7007 @opindex femit-struct-debug-baseonly
7008 Emit debug information for struct-like types
7009 only when the base name of the compilation source file
7010 matches the base name of file in which the struct is defined.
7012 This option substantially reduces the size of debugging information,
7013 but at significant potential loss in type information to the debugger.
7014 See @option{-femit-struct-debug-reduced} for a less aggressive option.
7015 See @option{-femit-struct-debug-detailed} for more detailed control.
7017 This option works only with DWARF debug output.
7019 @item -femit-struct-debug-reduced
7020 @opindex femit-struct-debug-reduced
7021 Emit debug information for struct-like types
7022 only when the base name of the compilation source file
7023 matches the base name of file in which the type is defined,
7024 unless the struct is a template or defined in a system header.
7026 This option significantly reduces the size of debugging information,
7027 with some potential loss in type information to the debugger.
7028 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
7029 See @option{-femit-struct-debug-detailed} for more detailed control.
7031 This option works only with DWARF debug output.
7033 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
7034 @opindex femit-struct-debug-detailed
7035 Specify the struct-like types
7036 for which the compiler generates debug information.
7037 The intent is to reduce duplicate struct debug information
7038 between different object files within the same program.
7040 This option is a detailed version of
7041 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
7042 which serves for most needs.
7044 A specification has the syntax@*
7045 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
7047 The optional first word limits the specification to
7048 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
7049 A struct type is used directly when it is the type of a variable, member.
7050 Indirect uses arise through pointers to structs.
7051 That is, when use of an incomplete struct is valid, the use is indirect.
7052 An example is
7053 @samp{struct one direct; struct two * indirect;}.
7055 The optional second word limits the specification to
7056 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
7057 Generic structs are a bit complicated to explain.
7058 For C++, these are non-explicit specializations of template classes,
7059 or non-template classes within the above.
7060 Other programming languages have generics,
7061 but @option{-femit-struct-debug-detailed} does not yet implement them.
7063 The third word specifies the source files for those
7064 structs for which the compiler should emit debug information.
7065 The values @samp{none} and @samp{any} have the normal meaning.
7066 The value @samp{base} means that
7067 the base of name of the file in which the type declaration appears
7068 must match the base of the name of the main compilation file.
7069 In practice, this means that when compiling @file{foo.c}, debug information
7070 is generated for types declared in that file and @file{foo.h},
7071 but not other header files.
7072 The value @samp{sys} means those types satisfying @samp{base}
7073 or declared in system or compiler headers.
7075 You may need to experiment to determine the best settings for your application.
7077 The default is @option{-femit-struct-debug-detailed=all}.
7079 This option works only with DWARF debug output.
7081 @item -fno-dwarf2-cfi-asm
7082 @opindex fdwarf2-cfi-asm
7083 @opindex fno-dwarf2-cfi-asm
7084 Emit DWARF unwind info as compiler generated @code{.eh_frame} section
7085 instead of using GAS @code{.cfi_*} directives.
7087 @item -fno-eliminate-unused-debug-types
7088 @opindex feliminate-unused-debug-types
7089 @opindex fno-eliminate-unused-debug-types
7090 Normally, when producing DWARF output, GCC avoids producing debug symbol 
7091 output for types that are nowhere used in the source file being compiled.
7092 Sometimes it is useful to have GCC emit debugging
7093 information for all types declared in a compilation
7094 unit, regardless of whether or not they are actually used
7095 in that compilation unit, for example 
7096 if, in the debugger, you want to cast a value to a type that is
7097 not actually used in your program (but is declared).  More often,
7098 however, this results in a significant amount of wasted space.
7099 @end table
7101 @node Optimize Options
7102 @section Options That Control Optimization
7103 @cindex optimize options
7104 @cindex options, optimization
7106 These options control various sorts of optimizations.
7108 Without any optimization option, the compiler's goal is to reduce the
7109 cost of compilation and to make debugging produce the expected
7110 results.  Statements are independent: if you stop the program with a
7111 breakpoint between statements, you can then assign a new value to any
7112 variable or change the program counter to any other statement in the
7113 function and get exactly the results you expect from the source
7114 code.
7116 Turning on optimization flags makes the compiler attempt to improve
7117 the performance and/or code size at the expense of compilation time
7118 and possibly the ability to debug the program.
7120 The compiler performs optimization based on the knowledge it has of the
7121 program.  Compiling multiple files at once to a single output file mode allows
7122 the compiler to use information gained from all of the files when compiling
7123 each of them.
7125 Not all optimizations are controlled directly by a flag.  Only
7126 optimizations that have a flag are listed in this section.
7128 Most optimizations are only enabled if an @option{-O} level is set on
7129 the command line.  Otherwise they are disabled, even if individual
7130 optimization flags are specified.
7132 Depending on the target and how GCC was configured, a slightly different
7133 set of optimizations may be enabled at each @option{-O} level than
7134 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
7135 to find out the exact set of optimizations that are enabled at each level.
7136 @xref{Overall Options}, for examples.
7138 @table @gcctabopt
7139 @item -O
7140 @itemx -O1
7141 @opindex O
7142 @opindex O1
7143 Optimize.  Optimizing compilation takes somewhat more time, and a lot
7144 more memory for a large function.
7146 With @option{-O}, the compiler tries to reduce code size and execution
7147 time, without performing any optimizations that take a great deal of
7148 compilation time.
7150 @option{-O} turns on the following optimization flags:
7151 @gccoptlist{
7152 -fauto-inc-dec @gol
7153 -fbranch-count-reg @gol
7154 -fcombine-stack-adjustments @gol
7155 -fcompare-elim @gol
7156 -fcprop-registers @gol
7157 -fdce @gol
7158 -fdefer-pop @gol
7159 -fdelayed-branch @gol
7160 -fdse @gol
7161 -fforward-propagate @gol
7162 -fguess-branch-probability @gol
7163 -fif-conversion2 @gol
7164 -fif-conversion @gol
7165 -finline-functions-called-once @gol
7166 -fipa-pure-const @gol
7167 -fipa-profile @gol
7168 -fipa-reference @gol
7169 -fmerge-constants @gol
7170 -fmove-loop-invariants @gol
7171 -freorder-blocks @gol
7172 -fshrink-wrap @gol
7173 -fshrink-wrap-separate @gol
7174 -fsplit-wide-types @gol
7175 -fssa-backprop @gol
7176 -fssa-phiopt @gol
7177 -ftree-bit-ccp @gol
7178 -ftree-ccp @gol
7179 -ftree-ch @gol
7180 -ftree-coalesce-vars @gol
7181 -ftree-copy-prop @gol
7182 -ftree-dce @gol
7183 -ftree-dominator-opts @gol
7184 -ftree-dse @gol
7185 -ftree-forwprop @gol
7186 -ftree-fre @gol
7187 -ftree-phiprop @gol
7188 -ftree-sink @gol
7189 -ftree-slsr @gol
7190 -ftree-sra @gol
7191 -ftree-pta @gol
7192 -ftree-ter @gol
7193 -funit-at-a-time}
7195 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
7196 where doing so does not interfere with debugging.
7198 @item -O2
7199 @opindex O2
7200 Optimize even more.  GCC performs nearly all supported optimizations
7201 that do not involve a space-speed tradeoff.
7202 As compared to @option{-O}, this option increases both compilation time
7203 and the performance of the generated code.
7205 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
7206 also turns on the following optimization flags:
7207 @gccoptlist{-fthread-jumps @gol
7208 -falign-functions  -falign-jumps @gol
7209 -falign-loops  -falign-labels @gol
7210 -fcaller-saves @gol
7211 -fcrossjumping @gol
7212 -fcse-follow-jumps  -fcse-skip-blocks @gol
7213 -fdelete-null-pointer-checks @gol
7214 -fdevirtualize -fdevirtualize-speculatively @gol
7215 -fexpensive-optimizations @gol
7216 -fgcse  -fgcse-lm  @gol
7217 -fhoist-adjacent-loads @gol
7218 -finline-small-functions @gol
7219 -findirect-inlining @gol
7220 -fipa-cp @gol
7221 -fipa-bit-cp @gol
7222 -fipa-vrp @gol
7223 -fipa-sra @gol
7224 -fipa-icf @gol
7225 -fisolate-erroneous-paths-dereference @gol
7226 -flra-remat @gol
7227 -foptimize-sibling-calls @gol
7228 -foptimize-strlen @gol
7229 -fpartial-inlining @gol
7230 -fpeephole2 @gol
7231 -freorder-blocks-algorithm=stc @gol
7232 -freorder-blocks-and-partition -freorder-functions @gol
7233 -frerun-cse-after-loop  @gol
7234 -fsched-interblock  -fsched-spec @gol
7235 -fschedule-insns  -fschedule-insns2 @gol
7236 -fstore-merging @gol
7237 -fstrict-aliasing @gol
7238 -ftree-builtin-call-dce @gol
7239 -ftree-switch-conversion -ftree-tail-merge @gol
7240 -fcode-hoisting @gol
7241 -ftree-pre @gol
7242 -ftree-vrp @gol
7243 -fipa-ra}
7245 Please note the warning under @option{-fgcse} about
7246 invoking @option{-O2} on programs that use computed gotos.
7248 @item -O3
7249 @opindex O3
7250 Optimize yet more.  @option{-O3} turns on all optimizations specified
7251 by @option{-O2} and also turns on the @option{-finline-functions},
7252 @option{-funswitch-loops}, @option{-fpredictive-commoning},
7253 @option{-fgcse-after-reload}, @option{-ftree-loop-vectorize},
7254 @option{-ftree-loop-distribute-patterns}, @option{-fsplit-paths}
7255 @option{-ftree-slp-vectorize}, @option{-fvect-cost-model},
7256 @option{-ftree-partial-pre}, @option{-fpeel-loops}
7257 and @option{-fipa-cp-clone} options.
7259 @item -O0
7260 @opindex O0
7261 Reduce compilation time and make debugging produce the expected
7262 results.  This is the default.
7264 @item -Os
7265 @opindex Os
7266 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
7267 do not typically increase code size.  It also performs further
7268 optimizations designed to reduce code size.
7270 @option{-Os} disables the following optimization flags:
7271 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
7272 -falign-labels  -freorder-blocks  -freorder-blocks-algorithm=stc @gol
7273 -freorder-blocks-and-partition  -fprefetch-loop-arrays}
7275 @item -Ofast
7276 @opindex Ofast
7277 Disregard strict standards compliance.  @option{-Ofast} enables all
7278 @option{-O3} optimizations.  It also enables optimizations that are not
7279 valid for all standard-compliant programs.
7280 It turns on @option{-ffast-math} and the Fortran-specific
7281 @option{-fno-protect-parens} and @option{-fstack-arrays}.
7283 @item -Og
7284 @opindex Og
7285 Optimize debugging experience.  @option{-Og} enables optimizations
7286 that do not interfere with debugging. It should be the optimization
7287 level of choice for the standard edit-compile-debug cycle, offering
7288 a reasonable level of optimization while maintaining fast compilation
7289 and a good debugging experience.
7290 @end table
7292 If you use multiple @option{-O} options, with or without level numbers,
7293 the last such option is the one that is effective.
7295 Options of the form @option{-f@var{flag}} specify machine-independent
7296 flags.  Most flags have both positive and negative forms; the negative
7297 form of @option{-ffoo} is @option{-fno-foo}.  In the table
7298 below, only one of the forms is listed---the one you typically 
7299 use.  You can figure out the other form by either removing @samp{no-}
7300 or adding it.
7302 The following options control specific optimizations.  They are either
7303 activated by @option{-O} options or are related to ones that are.  You
7304 can use the following flags in the rare cases when ``fine-tuning'' of
7305 optimizations to be performed is desired.
7307 @table @gcctabopt
7308 @item -fno-defer-pop
7309 @opindex fno-defer-pop
7310 Always pop the arguments to each function call as soon as that function
7311 returns.  For machines that must pop arguments after a function call,
7312 the compiler normally lets arguments accumulate on the stack for several
7313 function calls and pops them all at once.
7315 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7317 @item -fforward-propagate
7318 @opindex fforward-propagate
7319 Perform a forward propagation pass on RTL@.  The pass tries to combine two
7320 instructions and checks if the result can be simplified.  If loop unrolling
7321 is active, two passes are performed and the second is scheduled after
7322 loop unrolling.
7324 This option is enabled by default at optimization levels @option{-O},
7325 @option{-O2}, @option{-O3}, @option{-Os}.
7327 @item -ffp-contract=@var{style}
7328 @opindex ffp-contract
7329 @option{-ffp-contract=off} disables floating-point expression contraction.
7330 @option{-ffp-contract=fast} enables floating-point expression contraction
7331 such as forming of fused multiply-add operations if the target has
7332 native support for them.
7333 @option{-ffp-contract=on} enables floating-point expression contraction
7334 if allowed by the language standard.  This is currently not implemented
7335 and treated equal to @option{-ffp-contract=off}.
7337 The default is @option{-ffp-contract=fast}.
7339 @item -fomit-frame-pointer
7340 @opindex fomit-frame-pointer
7341 Don't keep the frame pointer in a register for functions that
7342 don't need one.  This avoids the instructions to save, set up and
7343 restore frame pointers; it also makes an extra register available
7344 in many functions.  @strong{It also makes debugging impossible on
7345 some machines.}
7347 On some machines, such as the VAX, this flag has no effect, because
7348 the standard calling sequence automatically handles the frame pointer
7349 and nothing is saved by pretending it doesn't exist.  The
7350 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
7351 whether a target machine supports this flag.  @xref{Registers,,Register
7352 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
7354 The default setting (when not optimizing for
7355 size) for 32-bit GNU/Linux x86 and 32-bit Darwin x86 targets is
7356 @option{-fomit-frame-pointer}.  You can configure GCC with the
7357 @option{--enable-frame-pointer} configure option to change the default.
7359 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7361 @item -foptimize-sibling-calls
7362 @opindex foptimize-sibling-calls
7363 Optimize sibling and tail recursive calls.
7365 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7367 @item -foptimize-strlen
7368 @opindex foptimize-strlen
7369 Optimize various standard C string functions (e.g. @code{strlen},
7370 @code{strchr} or @code{strcpy}) and
7371 their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
7373 Enabled at levels @option{-O2}, @option{-O3}.
7375 @item -fno-inline
7376 @opindex fno-inline
7377 Do not expand any functions inline apart from those marked with
7378 the @code{always_inline} attribute.  This is the default when not
7379 optimizing.
7381 Single functions can be exempted from inlining by marking them
7382 with the @code{noinline} attribute.
7384 @item -finline-small-functions
7385 @opindex finline-small-functions
7386 Integrate functions into their callers when their body is smaller than expected
7387 function call code (so overall size of program gets smaller).  The compiler
7388 heuristically decides which functions are simple enough to be worth integrating
7389 in this way.  This inlining applies to all functions, even those not declared
7390 inline.
7392 Enabled at level @option{-O2}.
7394 @item -findirect-inlining
7395 @opindex findirect-inlining
7396 Inline also indirect calls that are discovered to be known at compile
7397 time thanks to previous inlining.  This option has any effect only
7398 when inlining itself is turned on by the @option{-finline-functions}
7399 or @option{-finline-small-functions} options.
7401 Enabled at level @option{-O2}.
7403 @item -finline-functions
7404 @opindex finline-functions
7405 Consider all functions for inlining, even if they are not declared inline.
7406 The compiler heuristically decides which functions are worth integrating
7407 in this way.
7409 If all calls to a given function are integrated, and the function is
7410 declared @code{static}, then the function is normally not output as
7411 assembler code in its own right.
7413 Enabled at level @option{-O3}.
7415 @item -finline-functions-called-once
7416 @opindex finline-functions-called-once
7417 Consider all @code{static} functions called once for inlining into their
7418 caller even if they are not marked @code{inline}.  If a call to a given
7419 function is integrated, then the function is not output as assembler code
7420 in its own right.
7422 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
7424 @item -fearly-inlining
7425 @opindex fearly-inlining
7426 Inline functions marked by @code{always_inline} and functions whose body seems
7427 smaller than the function call overhead early before doing
7428 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
7429 makes profiling significantly cheaper and usually inlining faster on programs
7430 having large chains of nested wrapper functions.
7432 Enabled by default.
7434 @item -fipa-sra
7435 @opindex fipa-sra
7436 Perform interprocedural scalar replacement of aggregates, removal of
7437 unused parameters and replacement of parameters passed by reference
7438 by parameters passed by value.
7440 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
7442 @item -finline-limit=@var{n}
7443 @opindex finline-limit
7444 By default, GCC limits the size of functions that can be inlined.  This flag
7445 allows coarse control of this limit.  @var{n} is the size of functions that
7446 can be inlined in number of pseudo instructions.
7448 Inlining is actually controlled by a number of parameters, which may be
7449 specified individually by using @option{--param @var{name}=@var{value}}.
7450 The @option{-finline-limit=@var{n}} option sets some of these parameters
7451 as follows:
7453 @table @gcctabopt
7454 @item max-inline-insns-single
7455 is set to @var{n}/2.
7456 @item max-inline-insns-auto
7457 is set to @var{n}/2.
7458 @end table
7460 See below for a documentation of the individual
7461 parameters controlling inlining and for the defaults of these parameters.
7463 @emph{Note:} there may be no value to @option{-finline-limit} that results
7464 in default behavior.
7466 @emph{Note:} pseudo instruction represents, in this particular context, an
7467 abstract measurement of function's size.  In no way does it represent a count
7468 of assembly instructions and as such its exact meaning might change from one
7469 release to an another.
7471 @item -fno-keep-inline-dllexport
7472 @opindex fno-keep-inline-dllexport
7473 This is a more fine-grained version of @option{-fkeep-inline-functions},
7474 which applies only to functions that are declared using the @code{dllexport}
7475 attribute or declspec.  @xref{Function Attributes,,Declaring Attributes of
7476 Functions}.
7478 @item -fkeep-inline-functions
7479 @opindex fkeep-inline-functions
7480 In C, emit @code{static} functions that are declared @code{inline}
7481 into the object file, even if the function has been inlined into all
7482 of its callers.  This switch does not affect functions using the
7483 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
7484 inline functions into the object file.
7486 @item -fkeep-static-functions
7487 @opindex fkeep-static-functions
7488 Emit @code{static} functions into the object file, even if the function
7489 is never used.
7491 @item -fkeep-static-consts
7492 @opindex fkeep-static-consts
7493 Emit variables declared @code{static const} when optimization isn't turned
7494 on, even if the variables aren't referenced.
7496 GCC enables this option by default.  If you want to force the compiler to
7497 check if a variable is referenced, regardless of whether or not
7498 optimization is turned on, use the @option{-fno-keep-static-consts} option.
7500 @item -fmerge-constants
7501 @opindex fmerge-constants
7502 Attempt to merge identical constants (string constants and floating-point
7503 constants) across compilation units.
7505 This option is the default for optimized compilation if the assembler and
7506 linker support it.  Use @option{-fno-merge-constants} to inhibit this
7507 behavior.
7509 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7511 @item -fmerge-all-constants
7512 @opindex fmerge-all-constants
7513 Attempt to merge identical constants and identical variables.
7515 This option implies @option{-fmerge-constants}.  In addition to
7516 @option{-fmerge-constants} this considers e.g.@: even constant initialized
7517 arrays or initialized constant variables with integral or floating-point
7518 types.  Languages like C or C++ require each variable, including multiple
7519 instances of the same variable in recursive calls, to have distinct locations,
7520 so using this option results in non-conforming
7521 behavior.
7523 @item -fmodulo-sched
7524 @opindex fmodulo-sched
7525 Perform swing modulo scheduling immediately before the first scheduling
7526 pass.  This pass looks at innermost loops and reorders their
7527 instructions by overlapping different iterations.
7529 @item -fmodulo-sched-allow-regmoves
7530 @opindex fmodulo-sched-allow-regmoves
7531 Perform more aggressive SMS-based modulo scheduling with register moves
7532 allowed.  By setting this flag certain anti-dependences edges are
7533 deleted, which triggers the generation of reg-moves based on the
7534 life-range analysis.  This option is effective only with
7535 @option{-fmodulo-sched} enabled.
7537 @item -fno-branch-count-reg
7538 @opindex fno-branch-count-reg
7539 Avoid running a pass scanning for opportunities to use ``decrement and
7540 branch'' instructions on a count register instead of generating sequences
7541 of instructions that decrement a register, compare it against zero, and
7542 then branch based upon the result.  This option is only meaningful on
7543 architectures that support such instructions, which include x86, PowerPC,
7544 IA-64 and S/390.  Note that the @option{-fno-branch-count-reg} option
7545 doesn't remove the decrement and branch instructions from the generated
7546 instruction stream introduced by other optimization passes.
7548 Enabled by default at @option{-O1} and higher.
7550 The default is @option{-fbranch-count-reg}.
7552 @item -fno-function-cse
7553 @opindex fno-function-cse
7554 Do not put function addresses in registers; make each instruction that
7555 calls a constant function contain the function's address explicitly.
7557 This option results in less efficient code, but some strange hacks
7558 that alter the assembler output may be confused by the optimizations
7559 performed when this option is not used.
7561 The default is @option{-ffunction-cse}
7563 @item -fno-zero-initialized-in-bss
7564 @opindex fno-zero-initialized-in-bss
7565 If the target supports a BSS section, GCC by default puts variables that
7566 are initialized to zero into BSS@.  This can save space in the resulting
7567 code.
7569 This option turns off this behavior because some programs explicitly
7570 rely on variables going to the data section---e.g., so that the
7571 resulting executable can find the beginning of that section and/or make
7572 assumptions based on that.
7574 The default is @option{-fzero-initialized-in-bss}.
7576 @item -fthread-jumps
7577 @opindex fthread-jumps
7578 Perform optimizations that check to see if a jump branches to a
7579 location where another comparison subsumed by the first is found.  If
7580 so, the first branch is redirected to either the destination of the
7581 second branch or a point immediately following it, depending on whether
7582 the condition is known to be true or false.
7584 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7586 @item -fsplit-wide-types
7587 @opindex fsplit-wide-types
7588 When using a type that occupies multiple registers, such as @code{long
7589 long} on a 32-bit system, split the registers apart and allocate them
7590 independently.  This normally generates better code for those types,
7591 but may make debugging more difficult.
7593 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
7594 @option{-Os}.
7596 @item -fcse-follow-jumps
7597 @opindex fcse-follow-jumps
7598 In common subexpression elimination (CSE), scan through jump instructions
7599 when the target of the jump is not reached by any other path.  For
7600 example, when CSE encounters an @code{if} statement with an
7601 @code{else} clause, CSE follows the jump when the condition
7602 tested is false.
7604 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7606 @item -fcse-skip-blocks
7607 @opindex fcse-skip-blocks
7608 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
7609 follow jumps that conditionally skip over blocks.  When CSE
7610 encounters a simple @code{if} statement with no else clause,
7611 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
7612 body of the @code{if}.
7614 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7616 @item -frerun-cse-after-loop
7617 @opindex frerun-cse-after-loop
7618 Re-run common subexpression elimination after loop optimizations are
7619 performed.
7621 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7623 @item -fgcse
7624 @opindex fgcse
7625 Perform a global common subexpression elimination pass.
7626 This pass also performs global constant and copy propagation.
7628 @emph{Note:} When compiling a program using computed gotos, a GCC
7629 extension, you may get better run-time performance if you disable
7630 the global common subexpression elimination pass by adding
7631 @option{-fno-gcse} to the command line.
7633 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7635 @item -fgcse-lm
7636 @opindex fgcse-lm
7637 When @option{-fgcse-lm} is enabled, global common subexpression elimination
7638 attempts to move loads that are only killed by stores into themselves.  This
7639 allows a loop containing a load/store sequence to be changed to a load outside
7640 the loop, and a copy/store within the loop.
7642 Enabled by default when @option{-fgcse} is enabled.
7644 @item -fgcse-sm
7645 @opindex fgcse-sm
7646 When @option{-fgcse-sm} is enabled, a store motion pass is run after
7647 global common subexpression elimination.  This pass attempts to move
7648 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
7649 loops containing a load/store sequence can be changed to a load before
7650 the loop and a store after the loop.
7652 Not enabled at any optimization level.
7654 @item -fgcse-las
7655 @opindex fgcse-las
7656 When @option{-fgcse-las} is enabled, the global common subexpression
7657 elimination pass eliminates redundant loads that come after stores to the
7658 same memory location (both partial and full redundancies).
7660 Not enabled at any optimization level.
7662 @item -fgcse-after-reload
7663 @opindex fgcse-after-reload
7664 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
7665 pass is performed after reload.  The purpose of this pass is to clean up
7666 redundant spilling.
7668 @item -faggressive-loop-optimizations
7669 @opindex faggressive-loop-optimizations
7670 This option tells the loop optimizer to use language constraints to
7671 derive bounds for the number of iterations of a loop.  This assumes that
7672 loop code does not invoke undefined behavior by for example causing signed
7673 integer overflows or out-of-bound array accesses.  The bounds for the
7674 number of iterations of a loop are used to guide loop unrolling and peeling
7675 and loop exit test optimizations.
7676 This option is enabled by default.
7678 @item -funconstrained-commons
7679 @opindex funconstrained-commons
7680 This option tells the compiler that variables declared in common blocks
7681 (e.g. Fortran) may later be overridden with longer trailing arrays. This
7682 prevents certain optimizations that depend on knowing the array bounds.
7684 @item -fcrossjumping
7685 @opindex fcrossjumping
7686 Perform cross-jumping transformation.
7687 This transformation unifies equivalent code and saves code size.  The
7688 resulting code may or may not perform better than without cross-jumping.
7690 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7692 @item -fauto-inc-dec
7693 @opindex fauto-inc-dec
7694 Combine increments or decrements of addresses with memory accesses.
7695 This pass is always skipped on architectures that do not have
7696 instructions to support this.  Enabled by default at @option{-O} and
7697 higher on architectures that support this.
7699 @item -fdce
7700 @opindex fdce
7701 Perform dead code elimination (DCE) on RTL@.
7702 Enabled by default at @option{-O} and higher.
7704 @item -fdse
7705 @opindex fdse
7706 Perform dead store elimination (DSE) on RTL@.
7707 Enabled by default at @option{-O} and higher.
7709 @item -fif-conversion
7710 @opindex fif-conversion
7711 Attempt to transform conditional jumps into branch-less equivalents.  This
7712 includes use of conditional moves, min, max, set flags and abs instructions, and
7713 some tricks doable by standard arithmetics.  The use of conditional execution
7714 on chips where it is available is controlled by @option{-fif-conversion2}.
7716 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7718 @item -fif-conversion2
7719 @opindex fif-conversion2
7720 Use conditional execution (where available) to transform conditional jumps into
7721 branch-less equivalents.
7723 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7725 @item -fdeclone-ctor-dtor
7726 @opindex fdeclone-ctor-dtor
7727 The C++ ABI requires multiple entry points for constructors and
7728 destructors: one for a base subobject, one for a complete object, and
7729 one for a virtual destructor that calls operator delete afterwards.
7730 For a hierarchy with virtual bases, the base and complete variants are
7731 clones, which means two copies of the function.  With this option, the
7732 base and complete variants are changed to be thunks that call a common
7733 implementation.
7735 Enabled by @option{-Os}.
7737 @item -fdelete-null-pointer-checks
7738 @opindex fdelete-null-pointer-checks
7739 Assume that programs cannot safely dereference null pointers, and that
7740 no code or data element resides at address zero.
7741 This option enables simple constant
7742 folding optimizations at all optimization levels.  In addition, other
7743 optimization passes in GCC use this flag to control global dataflow
7744 analyses that eliminate useless checks for null pointers; these assume
7745 that a memory access to address zero always results in a trap, so
7746 that if a pointer is checked after it has already been dereferenced,
7747 it cannot be null.
7749 Note however that in some environments this assumption is not true.
7750 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
7751 for programs that depend on that behavior.
7753 This option is enabled by default on most targets.  On Nios II ELF, it
7754 defaults to off.  On AVR and CR16, this option is completely disabled.  
7756 Passes that use the dataflow information
7757 are enabled independently at different optimization levels.
7759 @item -fdevirtualize
7760 @opindex fdevirtualize
7761 Attempt to convert calls to virtual functions to direct calls.  This
7762 is done both within a procedure and interprocedurally as part of
7763 indirect inlining (@option{-findirect-inlining}) and interprocedural constant
7764 propagation (@option{-fipa-cp}).
7765 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7767 @item -fdevirtualize-speculatively
7768 @opindex fdevirtualize-speculatively
7769 Attempt to convert calls to virtual functions to speculative direct calls.
7770 Based on the analysis of the type inheritance graph, determine for a given call
7771 the set of likely targets. If the set is small, preferably of size 1, change
7772 the call into a conditional deciding between direct and indirect calls.  The
7773 speculative calls enable more optimizations, such as inlining.  When they seem
7774 useless after further optimization, they are converted back into original form.
7776 @item -fdevirtualize-at-ltrans
7777 @opindex fdevirtualize-at-ltrans
7778 Stream extra information needed for aggressive devirtualization when running
7779 the link-time optimizer in local transformation mode.  
7780 This option enables more devirtualization but
7781 significantly increases the size of streamed data. For this reason it is
7782 disabled by default.
7784 @item -fexpensive-optimizations
7785 @opindex fexpensive-optimizations
7786 Perform a number of minor optimizations that are relatively expensive.
7788 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7790 @item -free
7791 @opindex free
7792 Attempt to remove redundant extension instructions.  This is especially
7793 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
7794 registers after writing to their lower 32-bit half.
7796 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
7797 @option{-O3}, @option{-Os}.
7799 @item -fno-lifetime-dse
7800 @opindex fno-lifetime-dse
7801 In C++ the value of an object is only affected by changes within its
7802 lifetime: when the constructor begins, the object has an indeterminate
7803 value, and any changes during the lifetime of the object are dead when
7804 the object is destroyed.  Normally dead store elimination will take
7805 advantage of this; if your code relies on the value of the object
7806 storage persisting beyond the lifetime of the object, you can use this
7807 flag to disable this optimization.  To preserve stores before the
7808 constructor starts (e.g. because your operator new clears the object
7809 storage) but still treat the object as dead after the destructor you,
7810 can use @option{-flifetime-dse=1}.  The default behavior can be
7811 explicitly selected with @option{-flifetime-dse=2}.
7812 @option{-flifetime-dse=0} is equivalent to @option{-fno-lifetime-dse}.
7814 @item -flive-range-shrinkage
7815 @opindex flive-range-shrinkage
7816 Attempt to decrease register pressure through register live range
7817 shrinkage.  This is helpful for fast processors with small or moderate
7818 size register sets.
7820 @item -fira-algorithm=@var{algorithm}
7821 @opindex fira-algorithm
7822 Use the specified coloring algorithm for the integrated register
7823 allocator.  The @var{algorithm} argument can be @samp{priority}, which
7824 specifies Chow's priority coloring, or @samp{CB}, which specifies
7825 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
7826 for all architectures, but for those targets that do support it, it is
7827 the default because it generates better code.
7829 @item -fira-region=@var{region}
7830 @opindex fira-region
7831 Use specified regions for the integrated register allocator.  The
7832 @var{region} argument should be one of the following:
7834 @table @samp
7836 @item all
7837 Use all loops as register allocation regions.
7838 This can give the best results for machines with a small and/or
7839 irregular register set.
7841 @item mixed
7842 Use all loops except for loops with small register pressure 
7843 as the regions.  This value usually gives
7844 the best results in most cases and for most architectures,
7845 and is enabled by default when compiling with optimization for speed
7846 (@option{-O}, @option{-O2}, @dots{}).
7848 @item one
7849 Use all functions as a single region.  
7850 This typically results in the smallest code size, and is enabled by default for
7851 @option{-Os} or @option{-O0}.
7853 @end table
7855 @item -fira-hoist-pressure
7856 @opindex fira-hoist-pressure
7857 Use IRA to evaluate register pressure in the code hoisting pass for
7858 decisions to hoist expressions.  This option usually results in smaller
7859 code, but it can slow the compiler down.
7861 This option is enabled at level @option{-Os} for all targets.
7863 @item -fira-loop-pressure
7864 @opindex fira-loop-pressure
7865 Use IRA to evaluate register pressure in loops for decisions to move
7866 loop invariants.  This option usually results in generation
7867 of faster and smaller code on machines with large register files (>= 32
7868 registers), but it can slow the compiler down.
7870 This option is enabled at level @option{-O3} for some targets.
7872 @item -fno-ira-share-save-slots
7873 @opindex fno-ira-share-save-slots
7874 Disable sharing of stack slots used for saving call-used hard
7875 registers living through a call.  Each hard register gets a
7876 separate stack slot, and as a result function stack frames are
7877 larger.
7879 @item -fno-ira-share-spill-slots
7880 @opindex fno-ira-share-spill-slots
7881 Disable sharing of stack slots allocated for pseudo-registers.  Each
7882 pseudo-register that does not get a hard register gets a separate
7883 stack slot, and as a result function stack frames are larger.
7885 @item -flra-remat
7886 @opindex flra-remat
7887 Enable CFG-sensitive rematerialization in LRA.  Instead of loading
7888 values of spilled pseudos, LRA tries to rematerialize (recalculate)
7889 values if it is profitable.
7891 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7893 @item -fdelayed-branch
7894 @opindex fdelayed-branch
7895 If supported for the target machine, attempt to reorder instructions
7896 to exploit instruction slots available after delayed branch
7897 instructions.
7899 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7901 @item -fschedule-insns
7902 @opindex fschedule-insns
7903 If supported for the target machine, attempt to reorder instructions to
7904 eliminate execution stalls due to required data being unavailable.  This
7905 helps machines that have slow floating point or memory load instructions
7906 by allowing other instructions to be issued until the result of the load
7907 or floating-point instruction is required.
7909 Enabled at levels @option{-O2}, @option{-O3}.
7911 @item -fschedule-insns2
7912 @opindex fschedule-insns2
7913 Similar to @option{-fschedule-insns}, but requests an additional pass of
7914 instruction scheduling after register allocation has been done.  This is
7915 especially useful on machines with a relatively small number of
7916 registers and where memory load instructions take more than one cycle.
7918 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7920 @item -fno-sched-interblock
7921 @opindex fno-sched-interblock
7922 Don't schedule instructions across basic blocks.  This is normally
7923 enabled by default when scheduling before register allocation, i.e.@:
7924 with @option{-fschedule-insns} or at @option{-O2} or higher.
7926 @item -fno-sched-spec
7927 @opindex fno-sched-spec
7928 Don't allow speculative motion of non-load instructions.  This is normally
7929 enabled by default when scheduling before register allocation, i.e.@:
7930 with @option{-fschedule-insns} or at @option{-O2} or higher.
7932 @item -fsched-pressure
7933 @opindex fsched-pressure
7934 Enable register pressure sensitive insn scheduling before register
7935 allocation.  This only makes sense when scheduling before register
7936 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
7937 @option{-O2} or higher.  Usage of this option can improve the
7938 generated code and decrease its size by preventing register pressure
7939 increase above the number of available hard registers and subsequent
7940 spills in register allocation.
7942 @item -fsched-spec-load
7943 @opindex fsched-spec-load
7944 Allow speculative motion of some load instructions.  This only makes
7945 sense when scheduling before register allocation, i.e.@: with
7946 @option{-fschedule-insns} or at @option{-O2} or higher.
7948 @item -fsched-spec-load-dangerous
7949 @opindex fsched-spec-load-dangerous
7950 Allow speculative motion of more load instructions.  This only makes
7951 sense when scheduling before register allocation, i.e.@: with
7952 @option{-fschedule-insns} or at @option{-O2} or higher.
7954 @item -fsched-stalled-insns
7955 @itemx -fsched-stalled-insns=@var{n}
7956 @opindex fsched-stalled-insns
7957 Define how many insns (if any) can be moved prematurely from the queue
7958 of stalled insns into the ready list during the second scheduling pass.
7959 @option{-fno-sched-stalled-insns} means that no insns are moved
7960 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
7961 on how many queued insns can be moved prematurely.
7962 @option{-fsched-stalled-insns} without a value is equivalent to
7963 @option{-fsched-stalled-insns=1}.
7965 @item -fsched-stalled-insns-dep
7966 @itemx -fsched-stalled-insns-dep=@var{n}
7967 @opindex fsched-stalled-insns-dep
7968 Define how many insn groups (cycles) are examined for a dependency
7969 on a stalled insn that is a candidate for premature removal from the queue
7970 of stalled insns.  This has an effect only during the second scheduling pass,
7971 and only if @option{-fsched-stalled-insns} is used.
7972 @option{-fno-sched-stalled-insns-dep} is equivalent to
7973 @option{-fsched-stalled-insns-dep=0}.
7974 @option{-fsched-stalled-insns-dep} without a value is equivalent to
7975 @option{-fsched-stalled-insns-dep=1}.
7977 @item -fsched2-use-superblocks
7978 @opindex fsched2-use-superblocks
7979 When scheduling after register allocation, use superblock scheduling.
7980 This allows motion across basic block boundaries,
7981 resulting in faster schedules.  This option is experimental, as not all machine
7982 descriptions used by GCC model the CPU closely enough to avoid unreliable
7983 results from the algorithm.
7985 This only makes sense when scheduling after register allocation, i.e.@: with
7986 @option{-fschedule-insns2} or at @option{-O2} or higher.
7988 @item -fsched-group-heuristic
7989 @opindex fsched-group-heuristic
7990 Enable the group heuristic in the scheduler.  This heuristic favors
7991 the instruction that belongs to a schedule group.  This is enabled
7992 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7993 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7995 @item -fsched-critical-path-heuristic
7996 @opindex fsched-critical-path-heuristic
7997 Enable the critical-path heuristic in the scheduler.  This heuristic favors
7998 instructions on the critical path.  This is enabled by default when
7999 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8000 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8002 @item -fsched-spec-insn-heuristic
8003 @opindex fsched-spec-insn-heuristic
8004 Enable the speculative instruction heuristic in the scheduler.  This
8005 heuristic favors speculative instructions with greater dependency weakness.
8006 This is enabled by default when scheduling is enabled, i.e.@:
8007 with @option{-fschedule-insns} or @option{-fschedule-insns2}
8008 or at @option{-O2} or higher.
8010 @item -fsched-rank-heuristic
8011 @opindex fsched-rank-heuristic
8012 Enable the rank heuristic in the scheduler.  This heuristic favors
8013 the instruction belonging to a basic block with greater size or frequency.
8014 This is enabled by default when scheduling is enabled, i.e.@:
8015 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8016 at @option{-O2} or higher.
8018 @item -fsched-last-insn-heuristic
8019 @opindex fsched-last-insn-heuristic
8020 Enable the last-instruction heuristic in the scheduler.  This heuristic
8021 favors the instruction that is less dependent on the last instruction
8022 scheduled.  This is enabled by default when scheduling is enabled,
8023 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8024 at @option{-O2} or higher.
8026 @item -fsched-dep-count-heuristic
8027 @opindex fsched-dep-count-heuristic
8028 Enable the dependent-count heuristic in the scheduler.  This heuristic
8029 favors the instruction that has more instructions depending on it.
8030 This is enabled by default when scheduling is enabled, i.e.@:
8031 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8032 at @option{-O2} or higher.
8034 @item -freschedule-modulo-scheduled-loops
8035 @opindex freschedule-modulo-scheduled-loops
8036 Modulo scheduling is performed before traditional scheduling.  If a loop
8037 is modulo scheduled, later scheduling passes may change its schedule.  
8038 Use this option to control that behavior.
8040 @item -fselective-scheduling
8041 @opindex fselective-scheduling
8042 Schedule instructions using selective scheduling algorithm.  Selective
8043 scheduling runs instead of the first scheduler pass.
8045 @item -fselective-scheduling2
8046 @opindex fselective-scheduling2
8047 Schedule instructions using selective scheduling algorithm.  Selective
8048 scheduling runs instead of the second scheduler pass.
8050 @item -fsel-sched-pipelining
8051 @opindex fsel-sched-pipelining
8052 Enable software pipelining of innermost loops during selective scheduling.
8053 This option has no effect unless one of @option{-fselective-scheduling} or
8054 @option{-fselective-scheduling2} is turned on.
8056 @item -fsel-sched-pipelining-outer-loops
8057 @opindex fsel-sched-pipelining-outer-loops
8058 When pipelining loops during selective scheduling, also pipeline outer loops.
8059 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
8061 @item -fsemantic-interposition
8062 @opindex fsemantic-interposition
8063 Some object formats, like ELF, allow interposing of symbols by the 
8064 dynamic linker.
8065 This means that for symbols exported from the DSO, the compiler cannot perform
8066 interprocedural propagation, inlining and other optimizations in anticipation
8067 that the function or variable in question may change. While this feature is
8068 useful, for example, to rewrite memory allocation functions by a debugging
8069 implementation, it is expensive in the terms of code quality.
8070 With @option{-fno-semantic-interposition} the compiler assumes that 
8071 if interposition happens for functions the overwriting function will have 
8072 precisely the same semantics (and side effects). 
8073 Similarly if interposition happens
8074 for variables, the constructor of the variable will be the same. The flag
8075 has no effect for functions explicitly declared inline 
8076 (where it is never allowed for interposition to change semantics) 
8077 and for symbols explicitly declared weak.
8079 @item -fshrink-wrap
8080 @opindex fshrink-wrap
8081 Emit function prologues only before parts of the function that need it,
8082 rather than at the top of the function.  This flag is enabled by default at
8083 @option{-O} and higher.
8085 @item -fshrink-wrap-separate
8086 @opindex fshrink-wrap-separate
8087 Shrink-wrap separate parts of the prologue and epilogue separately, so that
8088 those parts are only executed when needed.
8089 This option is on by default, but has no effect unless @option{-fshrink-wrap}
8090 is also turned on and the target supports this.
8092 @item -fcaller-saves
8093 @opindex fcaller-saves
8094 Enable allocation of values to registers that are clobbered by
8095 function calls, by emitting extra instructions to save and restore the
8096 registers around such calls.  Such allocation is done only when it
8097 seems to result in better code.
8099 This option is always enabled by default on certain machines, usually
8100 those which have no call-preserved registers to use instead.
8102 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8104 @item -fcombine-stack-adjustments
8105 @opindex fcombine-stack-adjustments
8106 Tracks stack adjustments (pushes and pops) and stack memory references
8107 and then tries to find ways to combine them.
8109 Enabled by default at @option{-O1} and higher.
8111 @item -fipa-ra
8112 @opindex fipa-ra
8113 Use caller save registers for allocation if those registers are not used by
8114 any called function.  In that case it is not necessary to save and restore
8115 them around calls.  This is only possible if called functions are part of
8116 same compilation unit as current function and they are compiled before it.
8118 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}, however the option
8119 is disabled if generated code will be instrumented for profiling
8120 (@option{-p}, or @option{-pg}) or if callee's register usage cannot be known
8121 exactly (this happens on targets that do not expose prologues
8122 and epilogues in RTL).
8124 @item -fconserve-stack
8125 @opindex fconserve-stack
8126 Attempt to minimize stack usage.  The compiler attempts to use less
8127 stack space, even if that makes the program slower.  This option
8128 implies setting the @option{large-stack-frame} parameter to 100
8129 and the @option{large-stack-frame-growth} parameter to 400.
8131 @item -ftree-reassoc
8132 @opindex ftree-reassoc
8133 Perform reassociation on trees.  This flag is enabled by default
8134 at @option{-O} and higher.
8136 @item -fcode-hoisting
8137 @opindex fcode-hoisting
8138 Perform code hoisting.  Code hoisting tries to move the
8139 evaluation of expressions executed on all paths to the function exit
8140 as early as possible.  This is especially useful as a code size
8141 optimization, but it often helps for code speed as well.
8142 This flag is enabled by default at @option{-O2} and higher.
8144 @item -ftree-pre
8145 @opindex ftree-pre
8146 Perform partial redundancy elimination (PRE) on trees.  This flag is
8147 enabled by default at @option{-O2} and @option{-O3}.
8149 @item -ftree-partial-pre
8150 @opindex ftree-partial-pre
8151 Make partial redundancy elimination (PRE) more aggressive.  This flag is
8152 enabled by default at @option{-O3}.
8154 @item -ftree-forwprop
8155 @opindex ftree-forwprop
8156 Perform forward propagation on trees.  This flag is enabled by default
8157 at @option{-O} and higher.
8159 @item -ftree-fre
8160 @opindex ftree-fre
8161 Perform full redundancy elimination (FRE) on trees.  The difference
8162 between FRE and PRE is that FRE only considers expressions
8163 that are computed on all paths leading to the redundant computation.
8164 This analysis is faster than PRE, though it exposes fewer redundancies.
8165 This flag is enabled by default at @option{-O} and higher.
8167 @item -ftree-phiprop
8168 @opindex ftree-phiprop
8169 Perform hoisting of loads from conditional pointers on trees.  This
8170 pass is enabled by default at @option{-O} and higher.
8172 @item -fhoist-adjacent-loads
8173 @opindex fhoist-adjacent-loads
8174 Speculatively hoist loads from both branches of an if-then-else if the
8175 loads are from adjacent locations in the same structure and the target
8176 architecture has a conditional move instruction.  This flag is enabled
8177 by default at @option{-O2} and higher.
8179 @item -ftree-copy-prop
8180 @opindex ftree-copy-prop
8181 Perform copy propagation on trees.  This pass eliminates unnecessary
8182 copy operations.  This flag is enabled by default at @option{-O} and
8183 higher.
8185 @item -fipa-pure-const
8186 @opindex fipa-pure-const
8187 Discover which functions are pure or constant.
8188 Enabled by default at @option{-O} and higher.
8190 @item -fipa-reference
8191 @opindex fipa-reference
8192 Discover which static variables do not escape the
8193 compilation unit.
8194 Enabled by default at @option{-O} and higher.
8196 @item -fipa-pta
8197 @opindex fipa-pta
8198 Perform interprocedural pointer analysis and interprocedural modification
8199 and reference analysis.  This option can cause excessive memory and
8200 compile-time usage on large compilation units.  It is not enabled by
8201 default at any optimization level.
8203 @item -fipa-profile
8204 @opindex fipa-profile
8205 Perform interprocedural profile propagation.  The functions called only from
8206 cold functions are marked as cold. Also functions executed once (such as
8207 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
8208 functions and loop less parts of functions executed once are then optimized for
8209 size.
8210 Enabled by default at @option{-O} and higher.
8212 @item -fipa-cp
8213 @opindex fipa-cp
8214 Perform interprocedural constant propagation.
8215 This optimization analyzes the program to determine when values passed
8216 to functions are constants and then optimizes accordingly.
8217 This optimization can substantially increase performance
8218 if the application has constants passed to functions.
8219 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
8221 @item -fipa-cp-clone
8222 @opindex fipa-cp-clone
8223 Perform function cloning to make interprocedural constant propagation stronger.
8224 When enabled, interprocedural constant propagation performs function cloning
8225 when externally visible function can be called with constant arguments.
8226 Because this optimization can create multiple copies of functions,
8227 it may significantly increase code size
8228 (see @option{--param ipcp-unit-growth=@var{value}}).
8229 This flag is enabled by default at @option{-O3}.
8231 @item -fipa-bit-cp
8232 @opindex -fipa-bit-cp
8233 When enabled, perform interprocedural bitwise constant
8234 propagation. This flag is enabled by default at @option{-O2}. It
8235 requires that @option{-fipa-cp} is enabled.
8237 @item -fipa-vrp
8238 @opindex -fipa-vrp
8239 When enabled, perform interprocedural propagation of value
8240 ranges. This flag is enabled by default at @option{-O2}. It requires
8241 that @option{-fipa-cp} is enabled.
8243 @item -fipa-icf
8244 @opindex fipa-icf
8245 Perform Identical Code Folding for functions and read-only variables.
8246 The optimization reduces code size and may disturb unwind stacks by replacing
8247 a function by equivalent one with a different name. The optimization works
8248 more effectively with link-time optimization enabled.
8250 Nevertheless the behavior is similar to Gold Linker ICF optimization, GCC ICF
8251 works on different levels and thus the optimizations are not same - there are
8252 equivalences that are found only by GCC and equivalences found only by Gold.
8254 This flag is enabled by default at @option{-O2} and @option{-Os}.
8256 @item -fisolate-erroneous-paths-dereference
8257 @opindex fisolate-erroneous-paths-dereference
8258 Detect paths that trigger erroneous or undefined behavior due to
8259 dereferencing a null pointer.  Isolate those paths from the main control
8260 flow and turn the statement with erroneous or undefined behavior into a trap.
8261 This flag is enabled by default at @option{-O2} and higher and depends on
8262 @option{-fdelete-null-pointer-checks} also being enabled.
8264 @item -fisolate-erroneous-paths-attribute
8265 @opindex fisolate-erroneous-paths-attribute
8266 Detect paths that trigger erroneous or undefined behavior due a null value
8267 being used in a way forbidden by a @code{returns_nonnull} or @code{nonnull}
8268 attribute.  Isolate those paths from the main control flow and turn the
8269 statement with erroneous or undefined behavior into a trap.  This is not
8270 currently enabled, but may be enabled by @option{-O2} in the future.
8272 @item -ftree-sink
8273 @opindex ftree-sink
8274 Perform forward store motion on trees.  This flag is
8275 enabled by default at @option{-O} and higher.
8277 @item -ftree-bit-ccp
8278 @opindex ftree-bit-ccp
8279 Perform sparse conditional bit constant propagation on trees and propagate
8280 pointer alignment information.
8281 This pass only operates on local scalar variables and is enabled by default
8282 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
8284 @item -ftree-ccp
8285 @opindex ftree-ccp
8286 Perform sparse conditional constant propagation (CCP) on trees.  This
8287 pass only operates on local scalar variables and is enabled by default
8288 at @option{-O} and higher.
8290 @item -fssa-backprop
8291 @opindex fssa-backprop
8292 Propagate information about uses of a value up the definition chain
8293 in order to simplify the definitions.  For example, this pass strips
8294 sign operations if the sign of a value never matters.  The flag is
8295 enabled by default at @option{-O} and higher.
8297 @item -fssa-phiopt
8298 @opindex fssa-phiopt
8299 Perform pattern matching on SSA PHI nodes to optimize conditional
8300 code.  This pass is enabled by default at @option{-O} and higher.
8302 @item -ftree-switch-conversion
8303 @opindex ftree-switch-conversion
8304 Perform conversion of simple initializations in a switch to
8305 initializations from a scalar array.  This flag is enabled by default
8306 at @option{-O2} and higher.
8308 @item -ftree-tail-merge
8309 @opindex ftree-tail-merge
8310 Look for identical code sequences.  When found, replace one with a jump to the
8311 other.  This optimization is known as tail merging or cross jumping.  This flag
8312 is enabled by default at @option{-O2} and higher.  The compilation time
8313 in this pass can
8314 be limited using @option{max-tail-merge-comparisons} parameter and
8315 @option{max-tail-merge-iterations} parameter.
8317 @item -ftree-dce
8318 @opindex ftree-dce
8319 Perform dead code elimination (DCE) on trees.  This flag is enabled by
8320 default at @option{-O} and higher.
8322 @item -ftree-builtin-call-dce
8323 @opindex ftree-builtin-call-dce
8324 Perform conditional dead code elimination (DCE) for calls to built-in functions
8325 that may set @code{errno} but are otherwise side-effect free.  This flag is
8326 enabled by default at @option{-O2} and higher if @option{-Os} is not also
8327 specified.
8329 @item -ftree-dominator-opts
8330 @opindex ftree-dominator-opts
8331 Perform a variety of simple scalar cleanups (constant/copy
8332 propagation, redundancy elimination, range propagation and expression
8333 simplification) based on a dominator tree traversal.  This also
8334 performs jump threading (to reduce jumps to jumps). This flag is
8335 enabled by default at @option{-O} and higher.
8337 @item -ftree-dse
8338 @opindex ftree-dse
8339 Perform dead store elimination (DSE) on trees.  A dead store is a store into
8340 a memory location that is later overwritten by another store without
8341 any intervening loads.  In this case the earlier store can be deleted.  This
8342 flag is enabled by default at @option{-O} and higher.
8344 @item -ftree-ch
8345 @opindex ftree-ch
8346 Perform loop header copying on trees.  This is beneficial since it increases
8347 effectiveness of code motion optimizations.  It also saves one jump.  This flag
8348 is enabled by default at @option{-O} and higher.  It is not enabled
8349 for @option{-Os}, since it usually increases code size.
8351 @item -ftree-loop-optimize
8352 @opindex ftree-loop-optimize
8353 Perform loop optimizations on trees.  This flag is enabled by default
8354 at @option{-O} and higher.
8356 @item -ftree-loop-linear
8357 @itemx -floop-interchange
8358 @itemx -floop-strip-mine
8359 @itemx -floop-block
8360 @itemx -floop-unroll-and-jam
8361 @opindex ftree-loop-linear
8362 @opindex floop-interchange
8363 @opindex floop-strip-mine
8364 @opindex floop-block
8365 @opindex floop-unroll-and-jam
8366 Perform loop nest optimizations.  Same as
8367 @option{-floop-nest-optimize}.  To use this code transformation, GCC has
8368 to be configured with @option{--with-isl} to enable the Graphite loop
8369 transformation infrastructure.
8371 @item -fgraphite-identity
8372 @opindex fgraphite-identity
8373 Enable the identity transformation for graphite.  For every SCoP we generate
8374 the polyhedral representation and transform it back to gimple.  Using
8375 @option{-fgraphite-identity} we can check the costs or benefits of the
8376 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
8377 are also performed by the code generator isl, like index splitting and
8378 dead code elimination in loops.
8380 @item -floop-nest-optimize
8381 @opindex floop-nest-optimize
8382 Enable the isl based loop nest optimizer.  This is a generic loop nest
8383 optimizer based on the Pluto optimization algorithms.  It calculates a loop
8384 structure optimized for data-locality and parallelism.  This option
8385 is experimental.
8387 @item -floop-parallelize-all
8388 @opindex floop-parallelize-all
8389 Use the Graphite data dependence analysis to identify loops that can
8390 be parallelized.  Parallelize all the loops that can be analyzed to
8391 not contain loop carried dependences without checking that it is
8392 profitable to parallelize the loops.
8394 @item -ftree-coalesce-vars
8395 @opindex ftree-coalesce-vars
8396 While transforming the program out of the SSA representation, attempt to
8397 reduce copying by coalescing versions of different user-defined
8398 variables, instead of just compiler temporaries.  This may severely
8399 limit the ability to debug an optimized program compiled with
8400 @option{-fno-var-tracking-assignments}.  In the negated form, this flag
8401 prevents SSA coalescing of user variables.  This option is enabled by
8402 default if optimization is enabled, and it does very little otherwise.
8404 @item -ftree-loop-if-convert
8405 @opindex ftree-loop-if-convert
8406 Attempt to transform conditional jumps in the innermost loops to
8407 branch-less equivalents.  The intent is to remove control-flow from
8408 the innermost loops in order to improve the ability of the
8409 vectorization pass to handle these loops.  This is enabled by default
8410 if vectorization is enabled.
8412 @item -ftree-loop-distribution
8413 @opindex ftree-loop-distribution
8414 Perform loop distribution.  This flag can improve cache performance on
8415 big loop bodies and allow further loop optimizations, like
8416 parallelization or vectorization, to take place.  For example, the loop
8417 @smallexample
8418 DO I = 1, N
8419   A(I) = B(I) + C
8420   D(I) = E(I) * F
8421 ENDDO
8422 @end smallexample
8423 is transformed to
8424 @smallexample
8425 DO I = 1, N
8426    A(I) = B(I) + C
8427 ENDDO
8428 DO I = 1, N
8429    D(I) = E(I) * F
8430 ENDDO
8431 @end smallexample
8433 @item -ftree-loop-distribute-patterns
8434 @opindex ftree-loop-distribute-patterns
8435 Perform loop distribution of patterns that can be code generated with
8436 calls to a library.  This flag is enabled by default at @option{-O3}.
8438 This pass distributes the initialization loops and generates a call to
8439 memset zero.  For example, the loop
8440 @smallexample
8441 DO I = 1, N
8442   A(I) = 0
8443   B(I) = A(I) + I
8444 ENDDO
8445 @end smallexample
8446 is transformed to
8447 @smallexample
8448 DO I = 1, N
8449    A(I) = 0
8450 ENDDO
8451 DO I = 1, N
8452    B(I) = A(I) + I
8453 ENDDO
8454 @end smallexample
8455 and the initialization loop is transformed into a call to memset zero.
8457 @item -ftree-loop-im
8458 @opindex ftree-loop-im
8459 Perform loop invariant motion on trees.  This pass moves only invariants that
8460 are hard to handle at RTL level (function calls, operations that expand to
8461 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
8462 operands of conditions that are invariant out of the loop, so that we can use
8463 just trivial invariantness analysis in loop unswitching.  The pass also includes
8464 store motion.
8466 @item -ftree-loop-ivcanon
8467 @opindex ftree-loop-ivcanon
8468 Create a canonical counter for number of iterations in loops for which
8469 determining number of iterations requires complicated analysis.  Later
8470 optimizations then may determine the number easily.  Useful especially
8471 in connection with unrolling.
8473 @item -fivopts
8474 @opindex fivopts
8475 Perform induction variable optimizations (strength reduction, induction
8476 variable merging and induction variable elimination) on trees.
8478 @item -ftree-parallelize-loops=n
8479 @opindex ftree-parallelize-loops
8480 Parallelize loops, i.e., split their iteration space to run in n threads.
8481 This is only possible for loops whose iterations are independent
8482 and can be arbitrarily reordered.  The optimization is only
8483 profitable on multiprocessor machines, for loops that are CPU-intensive,
8484 rather than constrained e.g.@: by memory bandwidth.  This option
8485 implies @option{-pthread}, and thus is only supported on targets
8486 that have support for @option{-pthread}.
8488 @item -ftree-pta
8489 @opindex ftree-pta
8490 Perform function-local points-to analysis on trees.  This flag is
8491 enabled by default at @option{-O} and higher.
8493 @item -ftree-sra
8494 @opindex ftree-sra
8495 Perform scalar replacement of aggregates.  This pass replaces structure
8496 references with scalars to prevent committing structures to memory too
8497 early.  This flag is enabled by default at @option{-O} and higher.
8499 @item -fstore-merging
8500 @opindex fstore-merging
8501 Perform merging of narrow stores to consecutive memory addresses.  This pass
8502 merges contiguous stores of immediate values narrower than a word into fewer
8503 wider stores to reduce the number of instructions.  This is enabled by default
8504 at @option{-O2} and higher as well as @option{-Os}.
8506 @item -ftree-ter
8507 @opindex ftree-ter
8508 Perform temporary expression replacement during the SSA->normal phase.  Single
8509 use/single def temporaries are replaced at their use location with their
8510 defining expression.  This results in non-GIMPLE code, but gives the expanders
8511 much more complex trees to work on resulting in better RTL generation.  This is
8512 enabled by default at @option{-O} and higher.
8514 @item -ftree-slsr
8515 @opindex ftree-slsr
8516 Perform straight-line strength reduction on trees.  This recognizes related
8517 expressions involving multiplications and replaces them by less expensive
8518 calculations when possible.  This is enabled by default at @option{-O} and
8519 higher.
8521 @item -ftree-vectorize
8522 @opindex ftree-vectorize
8523 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
8524 and @option{-ftree-slp-vectorize} if not explicitly specified.
8526 @item -ftree-loop-vectorize
8527 @opindex ftree-loop-vectorize
8528 Perform loop vectorization on trees. This flag is enabled by default at
8529 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8531 @item -ftree-slp-vectorize
8532 @opindex ftree-slp-vectorize
8533 Perform basic block vectorization on trees. This flag is enabled by default at
8534 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8536 @item -fvect-cost-model=@var{model}
8537 @opindex fvect-cost-model
8538 Alter the cost model used for vectorization.  The @var{model} argument
8539 should be one of @samp{unlimited}, @samp{dynamic} or @samp{cheap}.
8540 With the @samp{unlimited} model the vectorized code-path is assumed
8541 to be profitable while with the @samp{dynamic} model a runtime check
8542 guards the vectorized code-path to enable it only for iteration
8543 counts that will likely execute faster than when executing the original
8544 scalar loop.  The @samp{cheap} model disables vectorization of
8545 loops where doing so would be cost prohibitive for example due to
8546 required runtime checks for data dependence or alignment but otherwise
8547 is equal to the @samp{dynamic} model.
8548 The default cost model depends on other optimization flags and is
8549 either @samp{dynamic} or @samp{cheap}.
8551 @item -fsimd-cost-model=@var{model}
8552 @opindex fsimd-cost-model
8553 Alter the cost model used for vectorization of loops marked with the OpenMP
8554 or Cilk Plus simd directive.  The @var{model} argument should be one of
8555 @samp{unlimited}, @samp{dynamic}, @samp{cheap}.  All values of @var{model}
8556 have the same meaning as described in @option{-fvect-cost-model} and by
8557 default a cost model defined with @option{-fvect-cost-model} is used.
8559 @item -ftree-vrp
8560 @opindex ftree-vrp
8561 Perform Value Range Propagation on trees.  This is similar to the
8562 constant propagation pass, but instead of values, ranges of values are
8563 propagated.  This allows the optimizers to remove unnecessary range
8564 checks like array bound checks and null pointer checks.  This is
8565 enabled by default at @option{-O2} and higher.  Null pointer check
8566 elimination is only done if @option{-fdelete-null-pointer-checks} is
8567 enabled.
8569 @item -fsplit-paths
8570 @opindex fsplit-paths
8571 Split paths leading to loop backedges.  This can improve dead code
8572 elimination and common subexpression elimination.  This is enabled by
8573 default at @option{-O2} and above.
8575 @item -fsplit-ivs-in-unroller
8576 @opindex fsplit-ivs-in-unroller
8577 Enables expression of values of induction variables in later iterations
8578 of the unrolled loop using the value in the first iteration.  This breaks
8579 long dependency chains, thus improving efficiency of the scheduling passes.
8581 A combination of @option{-fweb} and CSE is often sufficient to obtain the
8582 same effect.  However, that is not reliable in cases where the loop body
8583 is more complicated than a single basic block.  It also does not work at all
8584 on some architectures due to restrictions in the CSE pass.
8586 This optimization is enabled by default.
8588 @item -fvariable-expansion-in-unroller
8589 @opindex fvariable-expansion-in-unroller
8590 With this option, the compiler creates multiple copies of some
8591 local variables when unrolling a loop, which can result in superior code.
8593 @item -fpartial-inlining
8594 @opindex fpartial-inlining
8595 Inline parts of functions.  This option has any effect only
8596 when inlining itself is turned on by the @option{-finline-functions}
8597 or @option{-finline-small-functions} options.
8599 Enabled at level @option{-O2}.
8601 @item -fpredictive-commoning
8602 @opindex fpredictive-commoning
8603 Perform predictive commoning optimization, i.e., reusing computations
8604 (especially memory loads and stores) performed in previous
8605 iterations of loops.
8607 This option is enabled at level @option{-O3}.
8609 @item -fprefetch-loop-arrays
8610 @opindex fprefetch-loop-arrays
8611 If supported by the target machine, generate instructions to prefetch
8612 memory to improve the performance of loops that access large arrays.
8614 This option may generate better or worse code; results are highly
8615 dependent on the structure of loops within the source code.
8617 Disabled at level @option{-Os}.
8619 @item -fno-printf-return-value
8620 @opindex fno-printf-return-value
8621 Do not substitute constants for known return value of formatted output
8622 functions such as @code{sprintf}, @code{snprintf}, @code{vsprintf}, and
8623 @code{vsnprintf} (but not @code{printf} of @code{fprintf}).  This
8624 transformation allows GCC to optimize or even eliminate branches based
8625 on the known return value of these functions called with arguments that
8626 are either constant, or whose values are known to be in a range that
8627 makes determining the exact return value possible.  For example, when
8628 @option{-fprintf-return-value} is in effect, both the branch and the
8629 body of the @code{if} statement (but not the call to @code{snprint})
8630 can be optimized away when @code{i} is a 32-bit or smaller integer
8631 because the return value is guaranteed to be at most 8.
8633 @smallexample
8634 char buf[9];
8635 if (snprintf (buf, "%08x", i) >= sizeof buf)
8636   @dots{}
8637 @end smallexample
8639 The @option{-fprintf-return-value} option relies on other optimizations
8640 and yields best results with @option{-O2}.  It works in tandem with the
8641 @option{-Wformat-overflow} and @option{-Wformat-truncation} options.
8642 The @option{-fprintf-return-value} option is enabled by default.
8644 @item -fno-peephole
8645 @itemx -fno-peephole2
8646 @opindex fno-peephole
8647 @opindex fno-peephole2
8648 Disable any machine-specific peephole optimizations.  The difference
8649 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
8650 are implemented in the compiler; some targets use one, some use the
8651 other, a few use both.
8653 @option{-fpeephole} is enabled by default.
8654 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8656 @item -fno-guess-branch-probability
8657 @opindex fno-guess-branch-probability
8658 Do not guess branch probabilities using heuristics.
8660 GCC uses heuristics to guess branch probabilities if they are
8661 not provided by profiling feedback (@option{-fprofile-arcs}).  These
8662 heuristics are based on the control flow graph.  If some branch probabilities
8663 are specified by @code{__builtin_expect}, then the heuristics are
8664 used to guess branch probabilities for the rest of the control flow graph,
8665 taking the @code{__builtin_expect} info into account.  The interactions
8666 between the heuristics and @code{__builtin_expect} can be complex, and in
8667 some cases, it may be useful to disable the heuristics so that the effects
8668 of @code{__builtin_expect} are easier to understand.
8670 The default is @option{-fguess-branch-probability} at levels
8671 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8673 @item -freorder-blocks
8674 @opindex freorder-blocks
8675 Reorder basic blocks in the compiled function in order to reduce number of
8676 taken branches and improve code locality.
8678 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8680 @item -freorder-blocks-algorithm=@var{algorithm}
8681 @opindex freorder-blocks-algorithm
8682 Use the specified algorithm for basic block reordering.  The
8683 @var{algorithm} argument can be @samp{simple}, which does not increase
8684 code size (except sometimes due to secondary effects like alignment),
8685 or @samp{stc}, the ``software trace cache'' algorithm, which tries to
8686 put all often executed code together, minimizing the number of branches
8687 executed by making extra copies of code.
8689 The default is @samp{simple} at levels @option{-O}, @option{-Os}, and
8690 @samp{stc} at levels @option{-O2}, @option{-O3}.
8692 @item -freorder-blocks-and-partition
8693 @opindex freorder-blocks-and-partition
8694 In addition to reordering basic blocks in the compiled function, in order
8695 to reduce number of taken branches, partitions hot and cold basic blocks
8696 into separate sections of the assembly and @file{.o} files, to improve
8697 paging and cache locality performance.
8699 This optimization is automatically turned off in the presence of
8700 exception handling or unwind tables (on targets using setjump/longjump or target specific scheme), for linkonce sections, for functions with a user-defined
8701 section attribute and on any architecture that does not support named
8702 sections.  When @option{-fsplit-stack} is used this option is not
8703 enabled by default (to avoid linker errors), but may be enabled
8704 explicitly (if using a working linker).
8706 Enabled for x86 at levels @option{-O2}, @option{-O3}.
8708 @item -freorder-functions
8709 @opindex freorder-functions
8710 Reorder functions in the object file in order to
8711 improve code locality.  This is implemented by using special
8712 subsections @code{.text.hot} for most frequently executed functions and
8713 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
8714 the linker so object file format must support named sections and linker must
8715 place them in a reasonable way.
8717 Also profile feedback must be available to make this option effective.  See
8718 @option{-fprofile-arcs} for details.
8720 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8722 @item -fstrict-aliasing
8723 @opindex fstrict-aliasing
8724 Allow the compiler to assume the strictest aliasing rules applicable to
8725 the language being compiled.  For C (and C++), this activates
8726 optimizations based on the type of expressions.  In particular, an
8727 object of one type is assumed never to reside at the same address as an
8728 object of a different type, unless the types are almost the same.  For
8729 example, an @code{unsigned int} can alias an @code{int}, but not a
8730 @code{void*} or a @code{double}.  A character type may alias any other
8731 type.
8733 @anchor{Type-punning}Pay special attention to code like this:
8734 @smallexample
8735 union a_union @{
8736   int i;
8737   double d;
8740 int f() @{
8741   union a_union t;
8742   t.d = 3.0;
8743   return t.i;
8745 @end smallexample
8746 The practice of reading from a different union member than the one most
8747 recently written to (called ``type-punning'') is common.  Even with
8748 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
8749 is accessed through the union type.  So, the code above works as
8750 expected.  @xref{Structures unions enumerations and bit-fields
8751 implementation}.  However, this code might not:
8752 @smallexample
8753 int f() @{
8754   union a_union t;
8755   int* ip;
8756   t.d = 3.0;
8757   ip = &t.i;
8758   return *ip;
8760 @end smallexample
8762 Similarly, access by taking the address, casting the resulting pointer
8763 and dereferencing the result has undefined behavior, even if the cast
8764 uses a union type, e.g.:
8765 @smallexample
8766 int f() @{
8767   double d = 3.0;
8768   return ((union a_union *) &d)->i;
8770 @end smallexample
8772 The @option{-fstrict-aliasing} option is enabled at levels
8773 @option{-O2}, @option{-O3}, @option{-Os}.
8775 @item -falign-functions
8776 @itemx -falign-functions=@var{n}
8777 @opindex falign-functions
8778 Align the start of functions to the next power-of-two greater than
8779 @var{n}, skipping up to @var{n} bytes.  For instance,
8780 @option{-falign-functions=32} aligns functions to the next 32-byte
8781 boundary, but @option{-falign-functions=24} aligns to the next
8782 32-byte boundary only if this can be done by skipping 23 bytes or less.
8784 @option{-fno-align-functions} and @option{-falign-functions=1} are
8785 equivalent and mean that functions are not aligned.
8787 Some assemblers only support this flag when @var{n} is a power of two;
8788 in that case, it is rounded up.
8790 If @var{n} is not specified or is zero, use a machine-dependent default.
8792 Enabled at levels @option{-O2}, @option{-O3}.
8794 @item -flimit-function-alignment
8795 If this option is enabled, the compiler tries to avoid unnecessarily
8796 overaligning functions. It attempts to instruct the assembler to align
8797 by the amount specified by @option{-falign-functions}, but not to
8798 skip more bytes than the size of the function.
8800 @item -falign-labels
8801 @itemx -falign-labels=@var{n}
8802 @opindex falign-labels
8803 Align all branch targets to a power-of-two boundary, skipping up to
8804 @var{n} bytes like @option{-falign-functions}.  This option can easily
8805 make code slower, because it must insert dummy operations for when the
8806 branch target is reached in the usual flow of the code.
8808 @option{-fno-align-labels} and @option{-falign-labels=1} are
8809 equivalent and mean that labels are not aligned.
8811 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
8812 are greater than this value, then their values are used instead.
8814 If @var{n} is not specified or is zero, use a machine-dependent default
8815 which is very likely to be @samp{1}, meaning no alignment.
8817 Enabled at levels @option{-O2}, @option{-O3}.
8819 @item -falign-loops
8820 @itemx -falign-loops=@var{n}
8821 @opindex falign-loops
8822 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
8823 like @option{-falign-functions}.  If the loops are
8824 executed many times, this makes up for any execution of the dummy
8825 operations.
8827 @option{-fno-align-loops} and @option{-falign-loops=1} are
8828 equivalent and mean that loops are not aligned.
8830 If @var{n} is not specified or is zero, use a machine-dependent default.
8832 Enabled at levels @option{-O2}, @option{-O3}.
8834 @item -falign-jumps
8835 @itemx -falign-jumps=@var{n}
8836 @opindex falign-jumps
8837 Align branch targets to a power-of-two boundary, for branch targets
8838 where the targets can only be reached by jumping, skipping up to @var{n}
8839 bytes like @option{-falign-functions}.  In this case, no dummy operations
8840 need be executed.
8842 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
8843 equivalent and mean that loops are not aligned.
8845 If @var{n} is not specified or is zero, use a machine-dependent default.
8847 Enabled at levels @option{-O2}, @option{-O3}.
8849 @item -funit-at-a-time
8850 @opindex funit-at-a-time
8851 This option is left for compatibility reasons. @option{-funit-at-a-time}
8852 has no effect, while @option{-fno-unit-at-a-time} implies
8853 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
8855 Enabled by default.
8857 @item -fno-toplevel-reorder
8858 @opindex fno-toplevel-reorder
8859 Do not reorder top-level functions, variables, and @code{asm}
8860 statements.  Output them in the same order that they appear in the
8861 input file.  When this option is used, unreferenced static variables
8862 are not removed.  This option is intended to support existing code
8863 that relies on a particular ordering.  For new code, it is better to
8864 use attributes when possible.
8866 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
8867 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
8868 targets.
8870 @item -fweb
8871 @opindex fweb
8872 Constructs webs as commonly used for register allocation purposes and assign
8873 each web individual pseudo register.  This allows the register allocation pass
8874 to operate on pseudos directly, but also strengthens several other optimization
8875 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
8876 however, make debugging impossible, since variables no longer stay in a
8877 ``home register''.
8879 Enabled by default with @option{-funroll-loops}.
8881 @item -fwhole-program
8882 @opindex fwhole-program
8883 Assume that the current compilation unit represents the whole program being
8884 compiled.  All public functions and variables with the exception of @code{main}
8885 and those merged by attribute @code{externally_visible} become static functions
8886 and in effect are optimized more aggressively by interprocedural optimizers.
8888 This option should not be used in combination with @option{-flto}.
8889 Instead relying on a linker plugin should provide safer and more precise
8890 information.
8892 @item -flto[=@var{n}]
8893 @opindex flto
8894 This option runs the standard link-time optimizer.  When invoked
8895 with source code, it generates GIMPLE (one of GCC's internal
8896 representations) and writes it to special ELF sections in the object
8897 file.  When the object files are linked together, all the function
8898 bodies are read from these ELF sections and instantiated as if they
8899 had been part of the same translation unit.
8901 To use the link-time optimizer, @option{-flto} and optimization
8902 options should be specified at compile time and during the final link.
8903 It is recommended that you compile all the files participating in the
8904 same link with the same options and also specify those options at
8905 link time.  
8906 For example:
8908 @smallexample
8909 gcc -c -O2 -flto foo.c
8910 gcc -c -O2 -flto bar.c
8911 gcc -o myprog -flto -O2 foo.o bar.o
8912 @end smallexample
8914 The first two invocations to GCC save a bytecode representation
8915 of GIMPLE into special ELF sections inside @file{foo.o} and
8916 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
8917 @file{foo.o} and @file{bar.o}, merges the two files into a single
8918 internal image, and compiles the result as usual.  Since both
8919 @file{foo.o} and @file{bar.o} are merged into a single image, this
8920 causes all the interprocedural analyses and optimizations in GCC to
8921 work across the two files as if they were a single one.  This means,
8922 for example, that the inliner is able to inline functions in
8923 @file{bar.o} into functions in @file{foo.o} and vice-versa.
8925 Another (simpler) way to enable link-time optimization is:
8927 @smallexample
8928 gcc -o myprog -flto -O2 foo.c bar.c
8929 @end smallexample
8931 The above generates bytecode for @file{foo.c} and @file{bar.c},
8932 merges them together into a single GIMPLE representation and optimizes
8933 them as usual to produce @file{myprog}.
8935 The only important thing to keep in mind is that to enable link-time
8936 optimizations you need to use the GCC driver to perform the link step.
8937 GCC then automatically performs link-time optimization if any of the
8938 objects involved were compiled with the @option{-flto} command-line option.  
8939 You generally
8940 should specify the optimization options to be used for link-time
8941 optimization though GCC tries to be clever at guessing an
8942 optimization level to use from the options used at compile time
8943 if you fail to specify one at link time.  You can always override
8944 the automatic decision to do link-time optimization
8945 by passing @option{-fno-lto} to the link command.
8947 To make whole program optimization effective, it is necessary to make
8948 certain whole program assumptions.  The compiler needs to know
8949 what functions and variables can be accessed by libraries and runtime
8950 outside of the link-time optimized unit.  When supported by the linker,
8951 the linker plugin (see @option{-fuse-linker-plugin}) passes information
8952 to the compiler about used and externally visible symbols.  When
8953 the linker plugin is not available, @option{-fwhole-program} should be
8954 used to allow the compiler to make these assumptions, which leads
8955 to more aggressive optimization decisions.
8957 When @option{-fuse-linker-plugin} is not enabled, when a file is
8958 compiled with @option{-flto}, the generated object file is larger than
8959 a regular object file because it contains GIMPLE bytecodes and the usual
8960 final code (see @option{-ffat-lto-objects}.  This means that
8961 object files with LTO information can be linked as normal object
8962 files; if @option{-fno-lto} is passed to the linker, no
8963 interprocedural optimizations are applied.  Note that when
8964 @option{-fno-fat-lto-objects} is enabled the compile stage is faster
8965 but you cannot perform a regular, non-LTO link on them.
8967 Additionally, the optimization flags used to compile individual files
8968 are not necessarily related to those used at link time.  For instance,
8970 @smallexample
8971 gcc -c -O0 -ffat-lto-objects -flto foo.c
8972 gcc -c -O0 -ffat-lto-objects -flto bar.c
8973 gcc -o myprog -O3 foo.o bar.o
8974 @end smallexample
8976 This produces individual object files with unoptimized assembler
8977 code, but the resulting binary @file{myprog} is optimized at
8978 @option{-O3}.  If, instead, the final binary is generated with
8979 @option{-fno-lto}, then @file{myprog} is not optimized.
8981 When producing the final binary, GCC only
8982 applies link-time optimizations to those files that contain bytecode.
8983 Therefore, you can mix and match object files and libraries with
8984 GIMPLE bytecodes and final object code.  GCC automatically selects
8985 which files to optimize in LTO mode and which files to link without
8986 further processing.
8988 There are some code generation flags preserved by GCC when
8989 generating bytecodes, as they need to be used during the final link
8990 stage.  Generally options specified at link time override those
8991 specified at compile time.
8993 If you do not specify an optimization level option @option{-O} at
8994 link time, then GCC uses the highest optimization level 
8995 used when compiling the object files.
8997 Currently, the following options and their settings are taken from
8998 the first object file that explicitly specifies them: 
8999 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
9000 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
9001 and all the @option{-m} target flags.
9003 Certain ABI-changing flags are required to match in all compilation units,
9004 and trying to override this at link time with a conflicting value
9005 is ignored.  This includes options such as @option{-freg-struct-return}
9006 and @option{-fpcc-struct-return}. 
9008 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
9009 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
9010 are passed through to the link stage and merged conservatively for
9011 conflicting translation units.  Specifically
9012 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
9013 precedence; and for example @option{-ffp-contract=off} takes precedence
9014 over @option{-ffp-contract=fast}.  You can override them at link time.
9016 If LTO encounters objects with C linkage declared with incompatible
9017 types in separate translation units to be linked together (undefined
9018 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
9019 issued.  The behavior is still undefined at run time.  Similar
9020 diagnostics may be raised for other languages.
9022 Another feature of LTO is that it is possible to apply interprocedural
9023 optimizations on files written in different languages:
9025 @smallexample
9026 gcc -c -flto foo.c
9027 g++ -c -flto bar.cc
9028 gfortran -c -flto baz.f90
9029 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
9030 @end smallexample
9032 Notice that the final link is done with @command{g++} to get the C++
9033 runtime libraries and @option{-lgfortran} is added to get the Fortran
9034 runtime libraries.  In general, when mixing languages in LTO mode, you
9035 should use the same link command options as when mixing languages in a
9036 regular (non-LTO) compilation.
9038 If object files containing GIMPLE bytecode are stored in a library archive, say
9039 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
9040 are using a linker with plugin support.  To create static libraries suitable
9041 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
9042 and @command{ranlib}; 
9043 to show the symbols of object files with GIMPLE bytecode, use
9044 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
9045 and @command{nm} have been compiled with plugin support.  At link time, use the the
9046 flag @option{-fuse-linker-plugin} to ensure that the library participates in
9047 the LTO optimization process:
9049 @smallexample
9050 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
9051 @end smallexample
9053 With the linker plugin enabled, the linker extracts the needed
9054 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
9055 to make them part of the aggregated GIMPLE image to be optimized.
9057 If you are not using a linker with plugin support and/or do not
9058 enable the linker plugin, then the objects inside @file{libfoo.a}
9059 are extracted and linked as usual, but they do not participate
9060 in the LTO optimization process.  In order to make a static library suitable
9061 for both LTO optimization and usual linkage, compile its object files with
9062 @option{-flto} @option{-ffat-lto-objects}.
9064 Link-time optimizations do not require the presence of the whole program to
9065 operate.  If the program does not require any symbols to be exported, it is
9066 possible to combine @option{-flto} and @option{-fwhole-program} to allow
9067 the interprocedural optimizers to use more aggressive assumptions which may
9068 lead to improved optimization opportunities.
9069 Use of @option{-fwhole-program} is not needed when linker plugin is
9070 active (see @option{-fuse-linker-plugin}).
9072 The current implementation of LTO makes no
9073 attempt to generate bytecode that is portable between different
9074 types of hosts.  The bytecode files are versioned and there is a
9075 strict version check, so bytecode files generated in one version of
9076 GCC do not work with an older or newer version of GCC.
9078 Link-time optimization does not work well with generation of debugging
9079 information.  Combining @option{-flto} with
9080 @option{-g} is currently experimental and expected to produce unexpected
9081 results.
9083 If you specify the optional @var{n}, the optimization and code
9084 generation done at link time is executed in parallel using @var{n}
9085 parallel jobs by utilizing an installed @command{make} program.  The
9086 environment variable @env{MAKE} may be used to override the program
9087 used.  The default value for @var{n} is 1.
9089 You can also specify @option{-flto=jobserver} to use GNU make's
9090 job server mode to determine the number of parallel jobs. This
9091 is useful when the Makefile calling GCC is already executing in parallel.
9092 You must prepend a @samp{+} to the command recipe in the parent Makefile
9093 for this to work.  This option likely only works if @env{MAKE} is
9094 GNU make.
9096 @item -flto-partition=@var{alg}
9097 @opindex flto-partition
9098 Specify the partitioning algorithm used by the link-time optimizer.
9099 The value is either @samp{1to1} to specify a partitioning mirroring
9100 the original source files or @samp{balanced} to specify partitioning
9101 into equally sized chunks (whenever possible) or @samp{max} to create
9102 new partition for every symbol where possible.  Specifying @samp{none}
9103 as an algorithm disables partitioning and streaming completely. 
9104 The default value is @samp{balanced}. While @samp{1to1} can be used
9105 as an workaround for various code ordering issues, the @samp{max}
9106 partitioning is intended for internal testing only.
9107 The value @samp{one} specifies that exactly one partition should be
9108 used while the value @samp{none} bypasses partitioning and executes
9109 the link-time optimization step directly from the WPA phase.
9111 @item -flto-odr-type-merging
9112 @opindex flto-odr-type-merging
9113 Enable streaming of mangled types names of C++ types and their unification
9114 at link time.  This increases size of LTO object files, but enables
9115 diagnostics about One Definition Rule violations.
9117 @item -flto-compression-level=@var{n}
9118 @opindex flto-compression-level
9119 This option specifies the level of compression used for intermediate
9120 language written to LTO object files, and is only meaningful in
9121 conjunction with LTO mode (@option{-flto}).  Valid
9122 values are 0 (no compression) to 9 (maximum compression).  Values
9123 outside this range are clamped to either 0 or 9.  If the option is not
9124 given, a default balanced compression setting is used.
9126 @item -fuse-linker-plugin
9127 @opindex fuse-linker-plugin
9128 Enables the use of a linker plugin during link-time optimization.  This
9129 option relies on plugin support in the linker, which is available in gold
9130 or in GNU ld 2.21 or newer.
9132 This option enables the extraction of object files with GIMPLE bytecode out
9133 of library archives. This improves the quality of optimization by exposing
9134 more code to the link-time optimizer.  This information specifies what
9135 symbols can be accessed externally (by non-LTO object or during dynamic
9136 linking).  Resulting code quality improvements on binaries (and shared
9137 libraries that use hidden visibility) are similar to @option{-fwhole-program}.
9138 See @option{-flto} for a description of the effect of this flag and how to
9139 use it.
9141 This option is enabled by default when LTO support in GCC is enabled
9142 and GCC was configured for use with
9143 a linker supporting plugins (GNU ld 2.21 or newer or gold).
9145 @item -ffat-lto-objects
9146 @opindex ffat-lto-objects
9147 Fat LTO objects are object files that contain both the intermediate language
9148 and the object code. This makes them usable for both LTO linking and normal
9149 linking. This option is effective only when compiling with @option{-flto}
9150 and is ignored at link time.
9152 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
9153 requires the complete toolchain to be aware of LTO. It requires a linker with
9154 linker plugin support for basic functionality.  Additionally,
9155 @command{nm}, @command{ar} and @command{ranlib}
9156 need to support linker plugins to allow a full-featured build environment
9157 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
9158 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
9159 to these tools. With non fat LTO makefiles need to be modified to use them.
9161 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
9162 support.
9164 @item -fcompare-elim
9165 @opindex fcompare-elim
9166 After register allocation and post-register allocation instruction splitting,
9167 identify arithmetic instructions that compute processor flags similar to a
9168 comparison operation based on that arithmetic.  If possible, eliminate the
9169 explicit comparison operation.
9171 This pass only applies to certain targets that cannot explicitly represent
9172 the comparison operation before register allocation is complete.
9174 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9176 @item -fcprop-registers
9177 @opindex fcprop-registers
9178 After register allocation and post-register allocation instruction splitting,
9179 perform a copy-propagation pass to try to reduce scheduling dependencies
9180 and occasionally eliminate the copy.
9182 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9184 @item -fprofile-correction
9185 @opindex fprofile-correction
9186 Profiles collected using an instrumented binary for multi-threaded programs may
9187 be inconsistent due to missed counter updates. When this option is specified,
9188 GCC uses heuristics to correct or smooth out such inconsistencies. By
9189 default, GCC emits an error message when an inconsistent profile is detected.
9191 @item -fprofile-use
9192 @itemx -fprofile-use=@var{path}
9193 @opindex fprofile-use
9194 Enable profile feedback-directed optimizations, 
9195 and the following optimizations
9196 which are generally profitable only with profile feedback available:
9197 @option{-fbranch-probabilities}, @option{-fvpt},
9198 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9199 @option{-ftree-vectorize}, and @option{ftree-loop-distribute-patterns}.
9201 Before you can use this option, you must first generate profiling information.
9202 @xref{Instrumentation Options}, for information about the
9203 @option{-fprofile-generate} option.
9205 By default, GCC emits an error message if the feedback profiles do not
9206 match the source code.  This error can be turned into a warning by using
9207 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
9208 code.
9210 If @var{path} is specified, GCC looks at the @var{path} to find
9211 the profile feedback data files. See @option{-fprofile-dir}.
9213 @item -fauto-profile
9214 @itemx -fauto-profile=@var{path}
9215 @opindex fauto-profile
9216 Enable sampling-based feedback-directed optimizations, 
9217 and the following optimizations
9218 which are generally profitable only with profile feedback available:
9219 @option{-fbranch-probabilities}, @option{-fvpt},
9220 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9221 @option{-ftree-vectorize},
9222 @option{-finline-functions}, @option{-fipa-cp}, @option{-fipa-cp-clone},
9223 @option{-fpredictive-commoning}, @option{-funswitch-loops},
9224 @option{-fgcse-after-reload}, and @option{-ftree-loop-distribute-patterns}.
9226 @var{path} is the name of a file containing AutoFDO profile information.
9227 If omitted, it defaults to @file{fbdata.afdo} in the current directory.
9229 Producing an AutoFDO profile data file requires running your program
9230 with the @command{perf} utility on a supported GNU/Linux target system.
9231 For more information, see @uref{https://perf.wiki.kernel.org/}.
9233 E.g.
9234 @smallexample
9235 perf record -e br_inst_retired:near_taken -b -o perf.data \
9236     -- your_program
9237 @end smallexample
9239 Then use the @command{create_gcov} tool to convert the raw profile data
9240 to a format that can be used by GCC.@  You must also supply the 
9241 unstripped binary for your program to this tool.  
9242 See @uref{https://github.com/google/autofdo}.
9244 E.g.
9245 @smallexample
9246 create_gcov --binary=your_program.unstripped --profile=perf.data \
9247     --gcov=profile.afdo
9248 @end smallexample
9249 @end table
9251 The following options control compiler behavior regarding floating-point 
9252 arithmetic.  These options trade off between speed and
9253 correctness.  All must be specifically enabled.
9255 @table @gcctabopt
9256 @item -ffloat-store
9257 @opindex ffloat-store
9258 Do not store floating-point variables in registers, and inhibit other
9259 options that might change whether a floating-point value is taken from a
9260 register or memory.
9262 @cindex floating-point precision
9263 This option prevents undesirable excess precision on machines such as
9264 the 68000 where the floating registers (of the 68881) keep more
9265 precision than a @code{double} is supposed to have.  Similarly for the
9266 x86 architecture.  For most programs, the excess precision does only
9267 good, but a few programs rely on the precise definition of IEEE floating
9268 point.  Use @option{-ffloat-store} for such programs, after modifying
9269 them to store all pertinent intermediate computations into variables.
9271 @item -fexcess-precision=@var{style}
9272 @opindex fexcess-precision
9273 This option allows further control over excess precision on machines
9274 where floating-point operations occur in a format with more precision or
9275 range than the IEEE standard and interchange floating-point types.  By
9276 default, @option{-fexcess-precision=fast} is in effect; this means that
9277 operations may be carried out in a wider precision than the types specified
9278 in the source if that would result in faster code, and it is unpredictable
9279 when rounding to the types specified in the source code takes place.
9280 When compiling C, if @option{-fexcess-precision=standard} is specified then
9281 excess precision follows the rules specified in ISO C99; in particular,
9282 both casts and assignments cause values to be rounded to their
9283 semantic types (whereas @option{-ffloat-store} only affects
9284 assignments).  This option is enabled by default for C if a strict
9285 conformance option such as @option{-std=c99} is used.
9286 @option{-ffast-math} enables @option{-fexcess-precision=fast} by default
9287 regardless of whether a strict conformance option is used.
9289 @opindex mfpmath
9290 @option{-fexcess-precision=standard} is not implemented for languages
9291 other than C.  On the x86, it has no effect if @option{-mfpmath=sse}
9292 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
9293 semantics apply without excess precision, and in the latter, rounding
9294 is unpredictable.
9296 @item -ffast-math
9297 @opindex ffast-math
9298 Sets the options @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
9299 @option{-ffinite-math-only}, @option{-fno-rounding-math},
9300 @option{-fno-signaling-nans}, @option{-fcx-limited-range} and
9301 @option{-fexcess-precision=fast}.
9303 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
9305 This option is not turned on by any @option{-O} option besides
9306 @option{-Ofast} since it can result in incorrect output for programs
9307 that depend on an exact implementation of IEEE or ISO rules/specifications
9308 for math functions. It may, however, yield faster code for programs
9309 that do not require the guarantees of these specifications.
9311 @item -fno-math-errno
9312 @opindex fno-math-errno
9313 Do not set @code{errno} after calling math functions that are executed
9314 with a single instruction, e.g., @code{sqrt}.  A program that relies on
9315 IEEE exceptions for math error handling may want to use this flag
9316 for speed while maintaining IEEE arithmetic compatibility.
9318 This option is not turned on by any @option{-O} option since
9319 it can result in incorrect output for programs that depend on
9320 an exact implementation of IEEE or ISO rules/specifications for
9321 math functions. It may, however, yield faster code for programs
9322 that do not require the guarantees of these specifications.
9324 The default is @option{-fmath-errno}.
9326 On Darwin systems, the math library never sets @code{errno}.  There is
9327 therefore no reason for the compiler to consider the possibility that
9328 it might, and @option{-fno-math-errno} is the default.
9330 @item -funsafe-math-optimizations
9331 @opindex funsafe-math-optimizations
9333 Allow optimizations for floating-point arithmetic that (a) assume
9334 that arguments and results are valid and (b) may violate IEEE or
9335 ANSI standards.  When used at link time, it may include libraries
9336 or startup files that change the default FPU control word or other
9337 similar optimizations.
9339 This option is not turned on by any @option{-O} option since
9340 it can result in incorrect output for programs that depend on
9341 an exact implementation of IEEE or ISO rules/specifications for
9342 math functions. It may, however, yield faster code for programs
9343 that do not require the guarantees of these specifications.
9344 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
9345 @option{-fassociative-math} and @option{-freciprocal-math}.
9347 The default is @option{-fno-unsafe-math-optimizations}.
9349 @item -fassociative-math
9350 @opindex fassociative-math
9352 Allow re-association of operands in series of floating-point operations.
9353 This violates the ISO C and C++ language standard by possibly changing
9354 computation result.  NOTE: re-ordering may change the sign of zero as
9355 well as ignore NaNs and inhibit or create underflow or overflow (and
9356 thus cannot be used on code that relies on rounding behavior like
9357 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
9358 and thus may not be used when ordered comparisons are required.
9359 This option requires that both @option{-fno-signed-zeros} and
9360 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
9361 much sense with @option{-frounding-math}. For Fortran the option
9362 is automatically enabled when both @option{-fno-signed-zeros} and
9363 @option{-fno-trapping-math} are in effect.
9365 The default is @option{-fno-associative-math}.
9367 @item -freciprocal-math
9368 @opindex freciprocal-math
9370 Allow the reciprocal of a value to be used instead of dividing by
9371 the value if this enables optimizations.  For example @code{x / y}
9372 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
9373 is subject to common subexpression elimination.  Note that this loses
9374 precision and increases the number of flops operating on the value.
9376 The default is @option{-fno-reciprocal-math}.
9378 @item -ffinite-math-only
9379 @opindex ffinite-math-only
9380 Allow optimizations for floating-point arithmetic that assume
9381 that arguments and results are not NaNs or +-Infs.
9383 This option is not turned on by any @option{-O} option since
9384 it can result in incorrect output for programs that depend on
9385 an exact implementation of IEEE or ISO rules/specifications for
9386 math functions. It may, however, yield faster code for programs
9387 that do not require the guarantees of these specifications.
9389 The default is @option{-fno-finite-math-only}.
9391 @item -fno-signed-zeros
9392 @opindex fno-signed-zeros
9393 Allow optimizations for floating-point arithmetic that ignore the
9394 signedness of zero.  IEEE arithmetic specifies the behavior of
9395 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
9396 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
9397 This option implies that the sign of a zero result isn't significant.
9399 The default is @option{-fsigned-zeros}.
9401 @item -fno-trapping-math
9402 @opindex fno-trapping-math
9403 Compile code assuming that floating-point operations cannot generate
9404 user-visible traps.  These traps include division by zero, overflow,
9405 underflow, inexact result and invalid operation.  This option requires
9406 that @option{-fno-signaling-nans} be in effect.  Setting this option may
9407 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
9409 This option should never be turned on by any @option{-O} option since
9410 it can result in incorrect output for programs that depend on
9411 an exact implementation of IEEE or ISO rules/specifications for
9412 math functions.
9414 The default is @option{-ftrapping-math}.
9416 @item -frounding-math
9417 @opindex frounding-math
9418 Disable transformations and optimizations that assume default floating-point
9419 rounding behavior.  This is round-to-zero for all floating point
9420 to integer conversions, and round-to-nearest for all other arithmetic
9421 truncations.  This option should be specified for programs that change
9422 the FP rounding mode dynamically, or that may be executed with a
9423 non-default rounding mode.  This option disables constant folding of
9424 floating-point expressions at compile time (which may be affected by
9425 rounding mode) and arithmetic transformations that are unsafe in the
9426 presence of sign-dependent rounding modes.
9428 The default is @option{-fno-rounding-math}.
9430 This option is experimental and does not currently guarantee to
9431 disable all GCC optimizations that are affected by rounding mode.
9432 Future versions of GCC may provide finer control of this setting
9433 using C99's @code{FENV_ACCESS} pragma.  This command-line option
9434 will be used to specify the default state for @code{FENV_ACCESS}.
9436 @item -fsignaling-nans
9437 @opindex fsignaling-nans
9438 Compile code assuming that IEEE signaling NaNs may generate user-visible
9439 traps during floating-point operations.  Setting this option disables
9440 optimizations that may change the number of exceptions visible with
9441 signaling NaNs.  This option implies @option{-ftrapping-math}.
9443 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
9444 be defined.
9446 The default is @option{-fno-signaling-nans}.
9448 This option is experimental and does not currently guarantee to
9449 disable all GCC optimizations that affect signaling NaN behavior.
9451 @item -fno-fp-int-builtin-inexact
9452 @opindex fno-fp-int-builtin-inexact
9453 Do not allow the built-in functions @code{ceil}, @code{floor},
9454 @code{round} and @code{trunc}, and their @code{float} and @code{long
9455 double} variants, to generate code that raises the ``inexact''
9456 floating-point exception for noninteger arguments.  ISO C99 and C11
9457 allow these functions to raise the ``inexact'' exception, but ISO/IEC
9458 TS 18661-1:2014, the C bindings to IEEE 754-2008, does not allow these
9459 functions to do so.
9461 The default is @option{-ffp-int-builtin-inexact}, allowing the
9462 exception to be raised.  This option does nothing unless
9463 @option{-ftrapping-math} is in effect.
9465 Even if @option{-fno-fp-int-builtin-inexact} is used, if the functions
9466 generate a call to a library function then the ``inexact'' exception
9467 may be raised if the library implementation does not follow TS 18661.
9469 @item -fsingle-precision-constant
9470 @opindex fsingle-precision-constant
9471 Treat floating-point constants as single precision instead of
9472 implicitly converting them to double-precision constants.
9474 @item -fcx-limited-range
9475 @opindex fcx-limited-range
9476 When enabled, this option states that a range reduction step is not
9477 needed when performing complex division.  Also, there is no checking
9478 whether the result of a complex multiplication or division is @code{NaN
9479 + I*NaN}, with an attempt to rescue the situation in that case.  The
9480 default is @option{-fno-cx-limited-range}, but is enabled by
9481 @option{-ffast-math}.
9483 This option controls the default setting of the ISO C99
9484 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
9485 all languages.
9487 @item -fcx-fortran-rules
9488 @opindex fcx-fortran-rules
9489 Complex multiplication and division follow Fortran rules.  Range
9490 reduction is done as part of complex division, but there is no checking
9491 whether the result of a complex multiplication or division is @code{NaN
9492 + I*NaN}, with an attempt to rescue the situation in that case.
9494 The default is @option{-fno-cx-fortran-rules}.
9496 @end table
9498 The following options control optimizations that may improve
9499 performance, but are not enabled by any @option{-O} options.  This
9500 section includes experimental options that may produce broken code.
9502 @table @gcctabopt
9503 @item -fbranch-probabilities
9504 @opindex fbranch-probabilities
9505 After running a program compiled with @option{-fprofile-arcs}
9506 (@pxref{Instrumentation Options}),
9507 you can compile it a second time using
9508 @option{-fbranch-probabilities}, to improve optimizations based on
9509 the number of times each branch was taken.  When a program
9510 compiled with @option{-fprofile-arcs} exits, it saves arc execution
9511 counts to a file called @file{@var{sourcename}.gcda} for each source
9512 file.  The information in this data file is very dependent on the
9513 structure of the generated code, so you must use the same source code
9514 and the same optimization options for both compilations.
9516 With @option{-fbranch-probabilities}, GCC puts a
9517 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
9518 These can be used to improve optimization.  Currently, they are only
9519 used in one place: in @file{reorg.c}, instead of guessing which path a
9520 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
9521 exactly determine which path is taken more often.
9523 @item -fprofile-values
9524 @opindex fprofile-values
9525 If combined with @option{-fprofile-arcs}, it adds code so that some
9526 data about values of expressions in the program is gathered.
9528 With @option{-fbranch-probabilities}, it reads back the data gathered
9529 from profiling values of expressions for usage in optimizations.
9531 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
9533 @item -fprofile-reorder-functions
9534 @opindex fprofile-reorder-functions
9535 Function reordering based on profile instrumentation collects
9536 first time of execution of a function and orders these functions
9537 in ascending order.
9539 Enabled with @option{-fprofile-use}.
9541 @item -fvpt
9542 @opindex fvpt
9543 If combined with @option{-fprofile-arcs}, this option instructs the compiler
9544 to add code to gather information about values of expressions.
9546 With @option{-fbranch-probabilities}, it reads back the data gathered
9547 and actually performs the optimizations based on them.
9548 Currently the optimizations include specialization of division operations
9549 using the knowledge about the value of the denominator.
9551 @item -frename-registers
9552 @opindex frename-registers
9553 Attempt to avoid false dependencies in scheduled code by making use
9554 of registers left over after register allocation.  This optimization
9555 most benefits processors with lots of registers.  Depending on the
9556 debug information format adopted by the target, however, it can
9557 make debugging impossible, since variables no longer stay in
9558 a ``home register''.
9560 Enabled by default with @option{-funroll-loops}.
9562 @item -fschedule-fusion
9563 @opindex fschedule-fusion
9564 Performs a target dependent pass over the instruction stream to schedule
9565 instructions of same type together because target machine can execute them
9566 more efficiently if they are adjacent to each other in the instruction flow.
9568 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9570 @item -ftracer
9571 @opindex ftracer
9572 Perform tail duplication to enlarge superblock size.  This transformation
9573 simplifies the control flow of the function allowing other optimizations to do
9574 a better job.
9576 Enabled with @option{-fprofile-use}.
9578 @item -funroll-loops
9579 @opindex funroll-loops
9580 Unroll loops whose number of iterations can be determined at compile time or
9581 upon entry to the loop.  @option{-funroll-loops} implies
9582 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
9583 It also turns on complete loop peeling (i.e.@: complete removal of loops with
9584 a small constant number of iterations).  This option makes code larger, and may
9585 or may not make it run faster.
9587 Enabled with @option{-fprofile-use}.
9589 @item -funroll-all-loops
9590 @opindex funroll-all-loops
9591 Unroll all loops, even if their number of iterations is uncertain when
9592 the loop is entered.  This usually makes programs run more slowly.
9593 @option{-funroll-all-loops} implies the same options as
9594 @option{-funroll-loops}.
9596 @item -fpeel-loops
9597 @opindex fpeel-loops
9598 Peels loops for which there is enough information that they do not
9599 roll much (from profile feedback or static analysis).  It also turns on
9600 complete loop peeling (i.e.@: complete removal of loops with small constant
9601 number of iterations).
9603 Enabled with @option{-O3} and/or @option{-fprofile-use}.
9605 @item -fmove-loop-invariants
9606 @opindex fmove-loop-invariants
9607 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
9608 at level @option{-O1}
9610 @item -fsplit-loops
9611 @opindex fsplit-loops
9612 Split a loop into two if it contains a condition that's always true
9613 for one side of the iteration space and false for the other.
9615 @item -funswitch-loops
9616 @opindex funswitch-loops
9617 Move branches with loop invariant conditions out of the loop, with duplicates
9618 of the loop on both branches (modified according to result of the condition).
9620 @item -ffunction-sections
9621 @itemx -fdata-sections
9622 @opindex ffunction-sections
9623 @opindex fdata-sections
9624 Place each function or data item into its own section in the output
9625 file if the target supports arbitrary sections.  The name of the
9626 function or the name of the data item determines the section's name
9627 in the output file.
9629 Use these options on systems where the linker can perform optimizations
9630 to improve locality of reference in the instruction space.  Most systems
9631 using the ELF object format and SPARC processors running Solaris 2 have
9632 linkers with such optimizations.  AIX may have these optimizations in
9633 the future.
9635 Only use these options when there are significant benefits from doing
9636 so.  When you specify these options, the assembler and linker
9637 create larger object and executable files and are also slower.
9638 You cannot use @command{gprof} on all systems if you
9639 specify this option, and you may have problems with debugging if
9640 you specify both this option and @option{-g}.
9642 @item -fbranch-target-load-optimize
9643 @opindex fbranch-target-load-optimize
9644 Perform branch target register load optimization before prologue / epilogue
9645 threading.
9646 The use of target registers can typically be exposed only during reload,
9647 thus hoisting loads out of loops and doing inter-block scheduling needs
9648 a separate optimization pass.
9650 @item -fbranch-target-load-optimize2
9651 @opindex fbranch-target-load-optimize2
9652 Perform branch target register load optimization after prologue / epilogue
9653 threading.
9655 @item -fbtr-bb-exclusive
9656 @opindex fbtr-bb-exclusive
9657 When performing branch target register load optimization, don't reuse
9658 branch target registers within any basic block.
9660 @item -fstdarg-opt
9661 @opindex fstdarg-opt
9662 Optimize the prologue of variadic argument functions with respect to usage of
9663 those arguments.
9665 @item -fsection-anchors
9666 @opindex fsection-anchors
9667 Try to reduce the number of symbolic address calculations by using
9668 shared ``anchor'' symbols to address nearby objects.  This transformation
9669 can help to reduce the number of GOT entries and GOT accesses on some
9670 targets.
9672 For example, the implementation of the following function @code{foo}:
9674 @smallexample
9675 static int a, b, c;
9676 int foo (void) @{ return a + b + c; @}
9677 @end smallexample
9679 @noindent
9680 usually calculates the addresses of all three variables, but if you
9681 compile it with @option{-fsection-anchors}, it accesses the variables
9682 from a common anchor point instead.  The effect is similar to the
9683 following pseudocode (which isn't valid C):
9685 @smallexample
9686 int foo (void)
9688   register int *xr = &x;
9689   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
9691 @end smallexample
9693 Not all targets support this option.
9695 @item --param @var{name}=@var{value}
9696 @opindex param
9697 In some places, GCC uses various constants to control the amount of
9698 optimization that is done.  For example, GCC does not inline functions
9699 that contain more than a certain number of instructions.  You can
9700 control some of these constants on the command line using the
9701 @option{--param} option.
9703 The names of specific parameters, and the meaning of the values, are
9704 tied to the internals of the compiler, and are subject to change
9705 without notice in future releases.
9707 In each case, the @var{value} is an integer.  The allowable choices for
9708 @var{name} are:
9710 @table @gcctabopt
9711 @item predictable-branch-outcome
9712 When branch is predicted to be taken with probability lower than this threshold
9713 (in percent), then it is considered well predictable. The default is 10.
9715 @item max-rtl-if-conversion-insns
9716 RTL if-conversion tries to remove conditional branches around a block and
9717 replace them with conditionally executed instructions.  This parameter
9718 gives the maximum number of instructions in a block which should be
9719 considered for if-conversion.  The default is 10, though the compiler will
9720 also use other heuristics to decide whether if-conversion is likely to be
9721 profitable.
9723 @item max-rtl-if-conversion-predictable-cost
9724 @item max-rtl-if-conversion-unpredictable-cost
9725 RTL if-conversion will try to remove conditional branches around a block
9726 and replace them with conditionally executed instructions.  These parameters
9727 give the maximum permissible cost for the sequence that would be generated
9728 by if-conversion depending on whether the branch is statically determined
9729 to be predictable or not.  The units for this parameter are the same as
9730 those for the GCC internal seq_cost metric.  The compiler will try to
9731 provide a reasonable default for this parameter using the BRANCH_COST
9732 target macro.
9734 @item max-crossjump-edges
9735 The maximum number of incoming edges to consider for cross-jumping.
9736 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
9737 the number of edges incoming to each block.  Increasing values mean
9738 more aggressive optimization, making the compilation time increase with
9739 probably small improvement in executable size.
9741 @item min-crossjump-insns
9742 The minimum number of instructions that must be matched at the end
9743 of two blocks before cross-jumping is performed on them.  This
9744 value is ignored in the case where all instructions in the block being
9745 cross-jumped from are matched.  The default value is 5.
9747 @item max-grow-copy-bb-insns
9748 The maximum code size expansion factor when copying basic blocks
9749 instead of jumping.  The expansion is relative to a jump instruction.
9750 The default value is 8.
9752 @item max-goto-duplication-insns
9753 The maximum number of instructions to duplicate to a block that jumps
9754 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
9755 passes, GCC factors computed gotos early in the compilation process,
9756 and unfactors them as late as possible.  Only computed jumps at the
9757 end of a basic blocks with no more than max-goto-duplication-insns are
9758 unfactored.  The default value is 8.
9760 @item max-delay-slot-insn-search
9761 The maximum number of instructions to consider when looking for an
9762 instruction to fill a delay slot.  If more than this arbitrary number of
9763 instructions are searched, the time savings from filling the delay slot
9764 are minimal, so stop searching.  Increasing values mean more
9765 aggressive optimization, making the compilation time increase with probably
9766 small improvement in execution time.
9768 @item max-delay-slot-live-search
9769 When trying to fill delay slots, the maximum number of instructions to
9770 consider when searching for a block with valid live register
9771 information.  Increasing this arbitrarily chosen value means more
9772 aggressive optimization, increasing the compilation time.  This parameter
9773 should be removed when the delay slot code is rewritten to maintain the
9774 control-flow graph.
9776 @item max-gcse-memory
9777 The approximate maximum amount of memory that can be allocated in
9778 order to perform the global common subexpression elimination
9779 optimization.  If more memory than specified is required, the
9780 optimization is not done.
9782 @item max-gcse-insertion-ratio
9783 If the ratio of expression insertions to deletions is larger than this value
9784 for any expression, then RTL PRE inserts or removes the expression and thus
9785 leaves partially redundant computations in the instruction stream.  The default value is 20.
9787 @item max-pending-list-length
9788 The maximum number of pending dependencies scheduling allows
9789 before flushing the current state and starting over.  Large functions
9790 with few branches or calls can create excessively large lists which
9791 needlessly consume memory and resources.
9793 @item max-modulo-backtrack-attempts
9794 The maximum number of backtrack attempts the scheduler should make
9795 when modulo scheduling a loop.  Larger values can exponentially increase
9796 compilation time.
9798 @item max-inline-insns-single
9799 Several parameters control the tree inliner used in GCC@.
9800 This number sets the maximum number of instructions (counted in GCC's
9801 internal representation) in a single function that the tree inliner
9802 considers for inlining.  This only affects functions declared
9803 inline and methods implemented in a class declaration (C++).
9804 The default value is 400.
9806 @item max-inline-insns-auto
9807 When you use @option{-finline-functions} (included in @option{-O3}),
9808 a lot of functions that would otherwise not be considered for inlining
9809 by the compiler are investigated.  To those functions, a different
9810 (more restrictive) limit compared to functions declared inline can
9811 be applied.
9812 The default value is 40.
9814 @item inline-min-speedup
9815 When estimated performance improvement of caller + callee runtime exceeds this
9816 threshold (in percent), the function can be inlined regardless of the limit on
9817 @option{--param max-inline-insns-single} and @option{--param
9818 max-inline-insns-auto}.
9820 @item large-function-insns
9821 The limit specifying really large functions.  For functions larger than this
9822 limit after inlining, inlining is constrained by
9823 @option{--param large-function-growth}.  This parameter is useful primarily
9824 to avoid extreme compilation time caused by non-linear algorithms used by the
9825 back end.
9826 The default value is 2700.
9828 @item large-function-growth
9829 Specifies maximal growth of large function caused by inlining in percents.
9830 The default value is 100 which limits large function growth to 2.0 times
9831 the original size.
9833 @item large-unit-insns
9834 The limit specifying large translation unit.  Growth caused by inlining of
9835 units larger than this limit is limited by @option{--param inline-unit-growth}.
9836 For small units this might be too tight.
9837 For example, consider a unit consisting of function A
9838 that is inline and B that just calls A three times.  If B is small relative to
9839 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
9840 large units consisting of small inlineable functions, however, the overall unit
9841 growth limit is needed to avoid exponential explosion of code size.  Thus for
9842 smaller units, the size is increased to @option{--param large-unit-insns}
9843 before applying @option{--param inline-unit-growth}.  The default is 10000.
9845 @item inline-unit-growth
9846 Specifies maximal overall growth of the compilation unit caused by inlining.
9847 The default value is 20 which limits unit growth to 1.2 times the original
9848 size. Cold functions (either marked cold via an attribute or by profile
9849 feedback) are not accounted into the unit size.
9851 @item ipcp-unit-growth
9852 Specifies maximal overall growth of the compilation unit caused by
9853 interprocedural constant propagation.  The default value is 10 which limits
9854 unit growth to 1.1 times the original size.
9856 @item large-stack-frame
9857 The limit specifying large stack frames.  While inlining the algorithm is trying
9858 to not grow past this limit too much.  The default value is 256 bytes.
9860 @item large-stack-frame-growth
9861 Specifies maximal growth of large stack frames caused by inlining in percents.
9862 The default value is 1000 which limits large stack frame growth to 11 times
9863 the original size.
9865 @item max-inline-insns-recursive
9866 @itemx max-inline-insns-recursive-auto
9867 Specifies the maximum number of instructions an out-of-line copy of a
9868 self-recursive inline
9869 function can grow into by performing recursive inlining.
9871 @option{--param max-inline-insns-recursive} applies to functions
9872 declared inline.
9873 For functions not declared inline, recursive inlining
9874 happens only when @option{-finline-functions} (included in @option{-O3}) is
9875 enabled; @option{--param max-inline-insns-recursive-auto} applies instead.  The
9876 default value is 450.
9878 @item max-inline-recursive-depth
9879 @itemx max-inline-recursive-depth-auto
9880 Specifies the maximum recursion depth used for recursive inlining.
9882 @option{--param max-inline-recursive-depth} applies to functions
9883 declared inline.  For functions not declared inline, recursive inlining
9884 happens only when @option{-finline-functions} (included in @option{-O3}) is
9885 enabled; @option{--param max-inline-recursive-depth-auto} applies instead.  The
9886 default value is 8.
9888 @item min-inline-recursive-probability
9889 Recursive inlining is profitable only for function having deep recursion
9890 in average and can hurt for function having little recursion depth by
9891 increasing the prologue size or complexity of function body to other
9892 optimizers.
9894 When profile feedback is available (see @option{-fprofile-generate}) the actual
9895 recursion depth can be guessed from the probability that function recurses
9896 via a given call expression.  This parameter limits inlining only to call
9897 expressions whose probability exceeds the given threshold (in percents).
9898 The default value is 10.
9900 @item early-inlining-insns
9901 Specify growth that the early inliner can make.  In effect it increases
9902 the amount of inlining for code having a large abstraction penalty.
9903 The default value is 14.
9905 @item max-early-inliner-iterations
9906 Limit of iterations of the early inliner.  This basically bounds
9907 the number of nested indirect calls the early inliner can resolve.
9908 Deeper chains are still handled by late inlining.
9910 @item comdat-sharing-probability
9911 Probability (in percent) that C++ inline function with comdat visibility
9912 are shared across multiple compilation units.  The default value is 20.
9914 @item profile-func-internal-id
9915 A parameter to control whether to use function internal id in profile
9916 database lookup. If the value is 0, the compiler uses an id that
9917 is based on function assembler name and filename, which makes old profile
9918 data more tolerant to source changes such as function reordering etc.
9919 The default value is 0.
9921 @item min-vect-loop-bound
9922 The minimum number of iterations under which loops are not vectorized
9923 when @option{-ftree-vectorize} is used.  The number of iterations after
9924 vectorization needs to be greater than the value specified by this option
9925 to allow vectorization.  The default value is 0.
9927 @item gcse-cost-distance-ratio
9928 Scaling factor in calculation of maximum distance an expression
9929 can be moved by GCSE optimizations.  This is currently supported only in the
9930 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
9931 is with simple expressions, i.e., the expressions that have cost
9932 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
9933 hoisting of simple expressions.  The default value is 10.
9935 @item gcse-unrestricted-cost
9936 Cost, roughly measured as the cost of a single typical machine
9937 instruction, at which GCSE optimizations do not constrain
9938 the distance an expression can travel.  This is currently
9939 supported only in the code hoisting pass.  The lesser the cost,
9940 the more aggressive code hoisting is.  Specifying 0 
9941 allows all expressions to travel unrestricted distances.
9942 The default value is 3.
9944 @item max-hoist-depth
9945 The depth of search in the dominator tree for expressions to hoist.
9946 This is used to avoid quadratic behavior in hoisting algorithm.
9947 The value of 0 does not limit on the search, but may slow down compilation
9948 of huge functions.  The default value is 30.
9950 @item max-tail-merge-comparisons
9951 The maximum amount of similar bbs to compare a bb with.  This is used to
9952 avoid quadratic behavior in tree tail merging.  The default value is 10.
9954 @item max-tail-merge-iterations
9955 The maximum amount of iterations of the pass over the function.  This is used to
9956 limit compilation time in tree tail merging.  The default value is 2.
9958 @item store-merging-allow-unaligned
9959 Allow the store merging pass to introduce unaligned stores if it is legal to
9960 do so.  The default value is 1.
9962 @item max-stores-to-merge
9963 The maximum number of stores to attempt to merge into wider stores in the store
9964 merging pass.  The minimum value is 2 and the default is 64.
9966 @item max-unrolled-insns
9967 The maximum number of instructions that a loop may have to be unrolled.
9968 If a loop is unrolled, this parameter also determines how many times
9969 the loop code is unrolled.
9971 @item max-average-unrolled-insns
9972 The maximum number of instructions biased by probabilities of their execution
9973 that a loop may have to be unrolled.  If a loop is unrolled,
9974 this parameter also determines how many times the loop code is unrolled.
9976 @item max-unroll-times
9977 The maximum number of unrollings of a single loop.
9979 @item max-peeled-insns
9980 The maximum number of instructions that a loop may have to be peeled.
9981 If a loop is peeled, this parameter also determines how many times
9982 the loop code is peeled.
9984 @item max-peel-times
9985 The maximum number of peelings of a single loop.
9987 @item max-peel-branches
9988 The maximum number of branches on the hot path through the peeled sequence.
9990 @item max-completely-peeled-insns
9991 The maximum number of insns of a completely peeled loop.
9993 @item max-completely-peel-times
9994 The maximum number of iterations of a loop to be suitable for complete peeling.
9996 @item max-completely-peel-loop-nest-depth
9997 The maximum depth of a loop nest suitable for complete peeling.
9999 @item max-unswitch-insns
10000 The maximum number of insns of an unswitched loop.
10002 @item max-unswitch-level
10003 The maximum number of branches unswitched in a single loop.
10005 @item max-loop-headers-insns
10006 The maximum number of insns in loop header duplicated by the copy loop headers
10007 pass.
10009 @item lim-expensive
10010 The minimum cost of an expensive expression in the loop invariant motion.
10012 @item iv-consider-all-candidates-bound
10013 Bound on number of candidates for induction variables, below which
10014 all candidates are considered for each use in induction variable
10015 optimizations.  If there are more candidates than this,
10016 only the most relevant ones are considered to avoid quadratic time complexity.
10018 @item iv-max-considered-uses
10019 The induction variable optimizations give up on loops that contain more
10020 induction variable uses.
10022 @item iv-always-prune-cand-set-bound
10023 If the number of candidates in the set is smaller than this value,
10024 always try to remove unnecessary ivs from the set
10025 when adding a new one.
10027 @item avg-loop-niter
10028 Average number of iterations of a loop.
10030 @item dse-max-object-size
10031 Maximum size (in bytes) of objects tracked bytewise by dead store elimination.
10032 Larger values may result in larger compilation times.
10034 @item scev-max-expr-size
10035 Bound on size of expressions used in the scalar evolutions analyzer.
10036 Large expressions slow the analyzer.
10038 @item scev-max-expr-complexity
10039 Bound on the complexity of the expressions in the scalar evolutions analyzer.
10040 Complex expressions slow the analyzer.
10042 @item max-tree-if-conversion-phi-args
10043 Maximum number of arguments in a PHI supported by TREE if conversion
10044 unless the loop is marked with simd pragma.
10046 @item vect-max-version-for-alignment-checks
10047 The maximum number of run-time checks that can be performed when
10048 doing loop versioning for alignment in the vectorizer.
10050 @item vect-max-version-for-alias-checks
10051 The maximum number of run-time checks that can be performed when
10052 doing loop versioning for alias in the vectorizer.
10054 @item vect-max-peeling-for-alignment
10055 The maximum number of loop peels to enhance access alignment
10056 for vectorizer. Value -1 means no limit.
10058 @item max-iterations-to-track
10059 The maximum number of iterations of a loop the brute-force algorithm
10060 for analysis of the number of iterations of the loop tries to evaluate.
10062 @item hot-bb-count-ws-permille
10063 A basic block profile count is considered hot if it contributes to 
10064 the given permillage (i.e. 0...1000) of the entire profiled execution.
10066 @item hot-bb-frequency-fraction
10067 Select fraction of the entry block frequency of executions of basic block in
10068 function given basic block needs to have to be considered hot.
10070 @item max-predicted-iterations
10071 The maximum number of loop iterations we predict statically.  This is useful
10072 in cases where a function contains a single loop with known bound and
10073 another loop with unknown bound.
10074 The known number of iterations is predicted correctly, while
10075 the unknown number of iterations average to roughly 10.  This means that the
10076 loop without bounds appears artificially cold relative to the other one.
10078 @item builtin-expect-probability
10079 Control the probability of the expression having the specified value. This
10080 parameter takes a percentage (i.e. 0 ... 100) as input.
10081 The default probability of 90 is obtained empirically.
10083 @item align-threshold
10085 Select fraction of the maximal frequency of executions of a basic block in
10086 a function to align the basic block.
10088 @item align-loop-iterations
10090 A loop expected to iterate at least the selected number of iterations is
10091 aligned.
10093 @item tracer-dynamic-coverage
10094 @itemx tracer-dynamic-coverage-feedback
10096 This value is used to limit superblock formation once the given percentage of
10097 executed instructions is covered.  This limits unnecessary code size
10098 expansion.
10100 The @option{tracer-dynamic-coverage-feedback} parameter
10101 is used only when profile
10102 feedback is available.  The real profiles (as opposed to statically estimated
10103 ones) are much less balanced allowing the threshold to be larger value.
10105 @item tracer-max-code-growth
10106 Stop tail duplication once code growth has reached given percentage.  This is
10107 a rather artificial limit, as most of the duplicates are eliminated later in
10108 cross jumping, so it may be set to much higher values than is the desired code
10109 growth.
10111 @item tracer-min-branch-ratio
10113 Stop reverse growth when the reverse probability of best edge is less than this
10114 threshold (in percent).
10116 @item tracer-min-branch-probability
10117 @itemx tracer-min-branch-probability-feedback
10119 Stop forward growth if the best edge has probability lower than this
10120 threshold.
10122 Similarly to @option{tracer-dynamic-coverage} two parameters are
10123 provided.  @option{tracer-min-branch-probability-feedback} is used for
10124 compilation with profile feedback and @option{tracer-min-branch-probability}
10125 compilation without.  The value for compilation with profile feedback
10126 needs to be more conservative (higher) in order to make tracer
10127 effective.
10129 @item max-cse-path-length
10131 The maximum number of basic blocks on path that CSE considers.
10132 The default is 10.
10134 @item max-cse-insns
10135 The maximum number of instructions CSE processes before flushing.
10136 The default is 1000.
10138 @item ggc-min-expand
10140 GCC uses a garbage collector to manage its own memory allocation.  This
10141 parameter specifies the minimum percentage by which the garbage
10142 collector's heap should be allowed to expand between collections.
10143 Tuning this may improve compilation speed; it has no effect on code
10144 generation.
10146 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
10147 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
10148 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
10149 GCC is not able to calculate RAM on a particular platform, the lower
10150 bound of 30% is used.  Setting this parameter and
10151 @option{ggc-min-heapsize} to zero causes a full collection to occur at
10152 every opportunity.  This is extremely slow, but can be useful for
10153 debugging.
10155 @item ggc-min-heapsize
10157 Minimum size of the garbage collector's heap before it begins bothering
10158 to collect garbage.  The first collection occurs after the heap expands
10159 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
10160 tuning this may improve compilation speed, and has no effect on code
10161 generation.
10163 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
10164 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
10165 with a lower bound of 4096 (four megabytes) and an upper bound of
10166 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
10167 particular platform, the lower bound is used.  Setting this parameter
10168 very large effectively disables garbage collection.  Setting this
10169 parameter and @option{ggc-min-expand} to zero causes a full collection
10170 to occur at every opportunity.
10172 @item max-reload-search-insns
10173 The maximum number of instruction reload should look backward for equivalent
10174 register.  Increasing values mean more aggressive optimization, making the
10175 compilation time increase with probably slightly better performance.
10176 The default value is 100.
10178 @item max-cselib-memory-locations
10179 The maximum number of memory locations cselib should take into account.
10180 Increasing values mean more aggressive optimization, making the compilation time
10181 increase with probably slightly better performance.  The default value is 500.
10183 @item max-sched-ready-insns
10184 The maximum number of instructions ready to be issued the scheduler should
10185 consider at any given time during the first scheduling pass.  Increasing
10186 values mean more thorough searches, making the compilation time increase
10187 with probably little benefit.  The default value is 100.
10189 @item max-sched-region-blocks
10190 The maximum number of blocks in a region to be considered for
10191 interblock scheduling.  The default value is 10.
10193 @item max-pipeline-region-blocks
10194 The maximum number of blocks in a region to be considered for
10195 pipelining in the selective scheduler.  The default value is 15.
10197 @item max-sched-region-insns
10198 The maximum number of insns in a region to be considered for
10199 interblock scheduling.  The default value is 100.
10201 @item max-pipeline-region-insns
10202 The maximum number of insns in a region to be considered for
10203 pipelining in the selective scheduler.  The default value is 200.
10205 @item min-spec-prob
10206 The minimum probability (in percents) of reaching a source block
10207 for interblock speculative scheduling.  The default value is 40.
10209 @item max-sched-extend-regions-iters
10210 The maximum number of iterations through CFG to extend regions.
10211 A value of 0 (the default) disables region extensions.
10213 @item max-sched-insn-conflict-delay
10214 The maximum conflict delay for an insn to be considered for speculative motion.
10215 The default value is 3.
10217 @item sched-spec-prob-cutoff
10218 The minimal probability of speculation success (in percents), so that
10219 speculative insns are scheduled.
10220 The default value is 40.
10222 @item sched-state-edge-prob-cutoff
10223 The minimum probability an edge must have for the scheduler to save its
10224 state across it.
10225 The default value is 10.
10227 @item sched-mem-true-dep-cost
10228 Minimal distance (in CPU cycles) between store and load targeting same
10229 memory locations.  The default value is 1.
10231 @item selsched-max-lookahead
10232 The maximum size of the lookahead window of selective scheduling.  It is a
10233 depth of search for available instructions.
10234 The default value is 50.
10236 @item selsched-max-sched-times
10237 The maximum number of times that an instruction is scheduled during
10238 selective scheduling.  This is the limit on the number of iterations
10239 through which the instruction may be pipelined.  The default value is 2.
10241 @item selsched-insns-to-rename
10242 The maximum number of best instructions in the ready list that are considered
10243 for renaming in the selective scheduler.  The default value is 2.
10245 @item sms-min-sc
10246 The minimum value of stage count that swing modulo scheduler
10247 generates.  The default value is 2.
10249 @item max-last-value-rtl
10250 The maximum size measured as number of RTLs that can be recorded in an expression
10251 in combiner for a pseudo register as last known value of that register.  The default
10252 is 10000.
10254 @item max-combine-insns
10255 The maximum number of instructions the RTL combiner tries to combine.
10256 The default value is 2 at @option{-Og} and 4 otherwise.
10258 @item integer-share-limit
10259 Small integer constants can use a shared data structure, reducing the
10260 compiler's memory usage and increasing its speed.  This sets the maximum
10261 value of a shared integer constant.  The default value is 256.
10263 @item ssp-buffer-size
10264 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
10265 protection when @option{-fstack-protection} is used.
10267 @item min-size-for-stack-sharing
10268 The minimum size of variables taking part in stack slot sharing when not
10269 optimizing. The default value is 32.
10271 @item max-jump-thread-duplication-stmts
10272 Maximum number of statements allowed in a block that needs to be
10273 duplicated when threading jumps.
10275 @item max-fields-for-field-sensitive
10276 Maximum number of fields in a structure treated in
10277 a field sensitive manner during pointer analysis.  The default is zero
10278 for @option{-O0} and @option{-O1},
10279 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
10281 @item prefetch-latency
10282 Estimate on average number of instructions that are executed before
10283 prefetch finishes.  The distance prefetched ahead is proportional
10284 to this constant.  Increasing this number may also lead to less
10285 streams being prefetched (see @option{simultaneous-prefetches}).
10287 @item simultaneous-prefetches
10288 Maximum number of prefetches that can run at the same time.
10290 @item l1-cache-line-size
10291 The size of cache line in L1 cache, in bytes.
10293 @item l1-cache-size
10294 The size of L1 cache, in kilobytes.
10296 @item l2-cache-size
10297 The size of L2 cache, in kilobytes.
10299 @item min-insn-to-prefetch-ratio
10300 The minimum ratio between the number of instructions and the
10301 number of prefetches to enable prefetching in a loop.
10303 @item prefetch-min-insn-to-mem-ratio
10304 The minimum ratio between the number of instructions and the
10305 number of memory references to enable prefetching in a loop.
10307 @item use-canonical-types
10308 Whether the compiler should use the ``canonical'' type system.  By
10309 default, this should always be 1, which uses a more efficient internal
10310 mechanism for comparing types in C++ and Objective-C++.  However, if
10311 bugs in the canonical type system are causing compilation failures,
10312 set this value to 0 to disable canonical types.
10314 @item switch-conversion-max-branch-ratio
10315 Switch initialization conversion refuses to create arrays that are
10316 bigger than @option{switch-conversion-max-branch-ratio} times the number of
10317 branches in the switch.
10319 @item max-partial-antic-length
10320 Maximum length of the partial antic set computed during the tree
10321 partial redundancy elimination optimization (@option{-ftree-pre}) when
10322 optimizing at @option{-O3} and above.  For some sorts of source code
10323 the enhanced partial redundancy elimination optimization can run away,
10324 consuming all of the memory available on the host machine.  This
10325 parameter sets a limit on the length of the sets that are computed,
10326 which prevents the runaway behavior.  Setting a value of 0 for
10327 this parameter allows an unlimited set length.
10329 @item sccvn-max-scc-size
10330 Maximum size of a strongly connected component (SCC) during SCCVN
10331 processing.  If this limit is hit, SCCVN processing for the whole
10332 function is not done and optimizations depending on it are
10333 disabled.  The default maximum SCC size is 10000.
10335 @item sccvn-max-alias-queries-per-access
10336 Maximum number of alias-oracle queries we perform when looking for
10337 redundancies for loads and stores.  If this limit is hit the search
10338 is aborted and the load or store is not considered redundant.  The
10339 number of queries is algorithmically limited to the number of
10340 stores on all paths from the load to the function entry.
10341 The default maximum number of queries is 1000.
10343 @item ira-max-loops-num
10344 IRA uses regional register allocation by default.  If a function
10345 contains more loops than the number given by this parameter, only at most
10346 the given number of the most frequently-executed loops form regions
10347 for regional register allocation.  The default value of the
10348 parameter is 100.
10350 @item ira-max-conflict-table-size 
10351 Although IRA uses a sophisticated algorithm to compress the conflict
10352 table, the table can still require excessive amounts of memory for
10353 huge functions.  If the conflict table for a function could be more
10354 than the size in MB given by this parameter, the register allocator
10355 instead uses a faster, simpler, and lower-quality
10356 algorithm that does not require building a pseudo-register conflict table.  
10357 The default value of the parameter is 2000.
10359 @item ira-loop-reserved-regs
10360 IRA can be used to evaluate more accurate register pressure in loops
10361 for decisions to move loop invariants (see @option{-O3}).  The number
10362 of available registers reserved for some other purposes is given
10363 by this parameter.  The default value of the parameter is 2, which is
10364 the minimal number of registers needed by typical instructions.
10365 This value is the best found from numerous experiments.
10367 @item lra-inheritance-ebb-probability-cutoff
10368 LRA tries to reuse values reloaded in registers in subsequent insns.
10369 This optimization is called inheritance.  EBB is used as a region to
10370 do this optimization.  The parameter defines a minimal fall-through
10371 edge probability in percentage used to add BB to inheritance EBB in
10372 LRA.  The default value of the parameter is 40.  The value was chosen
10373 from numerous runs of SPEC2000 on x86-64.
10375 @item loop-invariant-max-bbs-in-loop
10376 Loop invariant motion can be very expensive, both in compilation time and
10377 in amount of needed compile-time memory, with very large loops.  Loops
10378 with more basic blocks than this parameter won't have loop invariant
10379 motion optimization performed on them.  The default value of the
10380 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
10382 @item loop-max-datarefs-for-datadeps
10383 Building data dependencies is expensive for very large loops.  This
10384 parameter limits the number of data references in loops that are
10385 considered for data dependence analysis.  These large loops are no
10386 handled by the optimizations using loop data dependencies.
10387 The default value is 1000.
10389 @item max-vartrack-size
10390 Sets a maximum number of hash table slots to use during variable
10391 tracking dataflow analysis of any function.  If this limit is exceeded
10392 with variable tracking at assignments enabled, analysis for that
10393 function is retried without it, after removing all debug insns from
10394 the function.  If the limit is exceeded even without debug insns, var
10395 tracking analysis is completely disabled for the function.  Setting
10396 the parameter to zero makes it unlimited.
10398 @item max-vartrack-expr-depth
10399 Sets a maximum number of recursion levels when attempting to map
10400 variable names or debug temporaries to value expressions.  This trades
10401 compilation time for more complete debug information.  If this is set too
10402 low, value expressions that are available and could be represented in
10403 debug information may end up not being used; setting this higher may
10404 enable the compiler to find more complex debug expressions, but compile
10405 time and memory use may grow.  The default is 12.
10407 @item min-nondebug-insn-uid
10408 Use uids starting at this parameter for nondebug insns.  The range below
10409 the parameter is reserved exclusively for debug insns created by
10410 @option{-fvar-tracking-assignments}, but debug insns may get
10411 (non-overlapping) uids above it if the reserved range is exhausted.
10413 @item ipa-sra-ptr-growth-factor
10414 IPA-SRA replaces a pointer to an aggregate with one or more new
10415 parameters only when their cumulative size is less or equal to
10416 @option{ipa-sra-ptr-growth-factor} times the size of the original
10417 pointer parameter.
10419 @item sra-max-scalarization-size-Ospeed
10420 @item sra-max-scalarization-size-Osize
10421 The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to
10422 replace scalar parts of aggregates with uses of independent scalar
10423 variables.  These parameters control the maximum size, in storage units,
10424 of aggregate which is considered for replacement when compiling for
10425 speed
10426 (@option{sra-max-scalarization-size-Ospeed}) or size
10427 (@option{sra-max-scalarization-size-Osize}) respectively.
10429 @item tm-max-aggregate-size
10430 When making copies of thread-local variables in a transaction, this
10431 parameter specifies the size in bytes after which variables are
10432 saved with the logging functions as opposed to save/restore code
10433 sequence pairs.  This option only applies when using
10434 @option{-fgnu-tm}.
10436 @item graphite-max-nb-scop-params
10437 To avoid exponential effects in the Graphite loop transforms, the
10438 number of parameters in a Static Control Part (SCoP) is bounded.  The
10439 default value is 10 parameters.  A variable whose value is unknown at
10440 compilation time and defined outside a SCoP is a parameter of the SCoP.
10442 @item graphite-max-bbs-per-function
10443 To avoid exponential effects in the detection of SCoPs, the size of
10444 the functions analyzed by Graphite is bounded.  The default value is
10445 100 basic blocks.
10447 @item loop-block-tile-size
10448 Loop blocking or strip mining transforms, enabled with
10449 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
10450 loop in the loop nest by a given number of iterations.  The strip
10451 length can be changed using the @option{loop-block-tile-size}
10452 parameter.  The default value is 51 iterations.
10454 @item loop-unroll-jam-size
10455 Specify the unroll factor for the @option{-floop-unroll-and-jam} option.  The 
10456 default value is 4.
10458 @item loop-unroll-jam-depth
10459 Specify the dimension to be unrolled (counting from the most inner loop)
10460 for the  @option{-floop-unroll-and-jam}.  The default value is 2.
10462 @item ipa-cp-value-list-size
10463 IPA-CP attempts to track all possible values and types passed to a function's
10464 parameter in order to propagate them and perform devirtualization.
10465 @option{ipa-cp-value-list-size} is the maximum number of values and types it
10466 stores per one formal parameter of a function.
10468 @item ipa-cp-eval-threshold
10469 IPA-CP calculates its own score of cloning profitability heuristics
10470 and performs those cloning opportunities with scores that exceed
10471 @option{ipa-cp-eval-threshold}.
10473 @item ipa-cp-recursion-penalty
10474 Percentage penalty the recursive functions will receive when they
10475 are evaluated for cloning.
10477 @item ipa-cp-single-call-penalty
10478 Percentage penalty functions containing a single call to another
10479 function will receive when they are evaluated for cloning.
10482 @item ipa-max-agg-items
10483 IPA-CP is also capable to propagate a number of scalar values passed
10484 in an aggregate. @option{ipa-max-agg-items} controls the maximum
10485 number of such values per one parameter.
10487 @item ipa-cp-loop-hint-bonus
10488 When IPA-CP determines that a cloning candidate would make the number
10489 of iterations of a loop known, it adds a bonus of
10490 @option{ipa-cp-loop-hint-bonus} to the profitability score of
10491 the candidate.
10493 @item ipa-cp-array-index-hint-bonus
10494 When IPA-CP determines that a cloning candidate would make the index of
10495 an array access known, it adds a bonus of
10496 @option{ipa-cp-array-index-hint-bonus} to the profitability
10497 score of the candidate.
10499 @item ipa-max-aa-steps
10500 During its analysis of function bodies, IPA-CP employs alias analysis
10501 in order to track values pointed to by function parameters.  In order
10502 not spend too much time analyzing huge functions, it gives up and
10503 consider all memory clobbered after examining
10504 @option{ipa-max-aa-steps} statements modifying memory.
10506 @item lto-partitions
10507 Specify desired number of partitions produced during WHOPR compilation.
10508 The number of partitions should exceed the number of CPUs used for compilation.
10509 The default value is 32.
10511 @item lto-min-partition
10512 Size of minimal partition for WHOPR (in estimated instructions).
10513 This prevents expenses of splitting very small programs into too many
10514 partitions.
10516 @item lto-max-partition
10517 Size of max partition for WHOPR (in estimated instructions).
10518 to provide an upper bound for individual size of partition.
10519 Meant to be used only with balanced partitioning.
10521 @item cxx-max-namespaces-for-diagnostic-help
10522 The maximum number of namespaces to consult for suggestions when C++
10523 name lookup fails for an identifier.  The default is 1000.
10525 @item sink-frequency-threshold
10526 The maximum relative execution frequency (in percents) of the target block
10527 relative to a statement's original block to allow statement sinking of a
10528 statement.  Larger numbers result in more aggressive statement sinking.
10529 The default value is 75.  A small positive adjustment is applied for
10530 statements with memory operands as those are even more profitable so sink.
10532 @item max-stores-to-sink
10533 The maximum number of conditional store pairs that can be sunk.  Set to 0
10534 if either vectorization (@option{-ftree-vectorize}) or if-conversion
10535 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
10537 @item allow-store-data-races
10538 Allow optimizers to introduce new data races on stores.
10539 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10540 at optimization level @option{-Ofast}.
10542 @item case-values-threshold
10543 The smallest number of different values for which it is best to use a
10544 jump-table instead of a tree of conditional branches.  If the value is
10545 0, use the default for the machine.  The default is 0.
10547 @item tree-reassoc-width
10548 Set the maximum number of instructions executed in parallel in
10549 reassociated tree. This parameter overrides target dependent
10550 heuristics used by default if has non zero value.
10552 @item sched-pressure-algorithm
10553 Choose between the two available implementations of
10554 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
10555 and is the more likely to prevent instructions from being reordered.
10556 Algorithm 2 was designed to be a compromise between the relatively
10557 conservative approach taken by algorithm 1 and the rather aggressive
10558 approach taken by the default scheduler.  It relies more heavily on
10559 having a regular register file and accurate register pressure classes.
10560 See @file{haifa-sched.c} in the GCC sources for more details.
10562 The default choice depends on the target.
10564 @item max-slsr-cand-scan
10565 Set the maximum number of existing candidates that are considered when
10566 seeking a basis for a new straight-line strength reduction candidate.
10568 @item asan-globals
10569 Enable buffer overflow detection for global objects.  This kind
10570 of protection is enabled by default if you are using
10571 @option{-fsanitize=address} option.
10572 To disable global objects protection use @option{--param asan-globals=0}.
10574 @item asan-stack
10575 Enable buffer overflow detection for stack objects.  This kind of
10576 protection is enabled by default when using @option{-fsanitize=address}.
10577 To disable stack protection use @option{--param asan-stack=0} option.
10579 @item asan-instrument-reads
10580 Enable buffer overflow detection for memory reads.  This kind of
10581 protection is enabled by default when using @option{-fsanitize=address}.
10582 To disable memory reads protection use
10583 @option{--param asan-instrument-reads=0}.
10585 @item asan-instrument-writes
10586 Enable buffer overflow detection for memory writes.  This kind of
10587 protection is enabled by default when using @option{-fsanitize=address}.
10588 To disable memory writes protection use
10589 @option{--param asan-instrument-writes=0} option.
10591 @item asan-memintrin
10592 Enable detection for built-in functions.  This kind of protection
10593 is enabled by default when using @option{-fsanitize=address}.
10594 To disable built-in functions protection use
10595 @option{--param asan-memintrin=0}.
10597 @item asan-use-after-return
10598 Enable detection of use-after-return.  This kind of protection
10599 is enabled by default when using the @option{-fsanitize=address} option.
10600 To disable it use @option{--param asan-use-after-return=0}.
10602 Note: By default the check is disabled at run time.  To enable it,
10603 add @code{detect_stack_use_after_return=1} to the environment variable
10604 @env{ASAN_OPTIONS}.
10606 @item asan-instrumentation-with-call-threshold
10607 If number of memory accesses in function being instrumented
10608 is greater or equal to this number, use callbacks instead of inline checks.
10609 E.g. to disable inline code use
10610 @option{--param asan-instrumentation-with-call-threshold=0}.
10612 @item use-after-scope-direct-emission-threshold
10613 If the size of a local variable in bytes is smaller or equal to this
10614 number, directly poison (or unpoison) shadow memory instead of using
10615 run-time callbacks.  The default value is 256.
10617 @item chkp-max-ctor-size
10618 Static constructors generated by Pointer Bounds Checker may become very
10619 large and significantly increase compile time at optimization level
10620 @option{-O1} and higher.  This parameter is a maximum number of statements
10621 in a single generated constructor.  Default value is 5000.
10623 @item max-fsm-thread-path-insns
10624 Maximum number of instructions to copy when duplicating blocks on a
10625 finite state automaton jump thread path.  The default is 100.
10627 @item max-fsm-thread-length
10628 Maximum number of basic blocks on a finite state automaton jump thread
10629 path.  The default is 10.
10631 @item max-fsm-thread-paths
10632 Maximum number of new jump thread paths to create for a finite state
10633 automaton.  The default is 50.
10635 @item parloops-chunk-size
10636 Chunk size of omp schedule for loops parallelized by parloops.  The default
10637 is 0.
10639 @item parloops-schedule
10640 Schedule type of omp schedule for loops parallelized by parloops (static,
10641 dynamic, guided, auto, runtime).  The default is static.
10643 @item max-ssa-name-query-depth
10644 Maximum depth of recursion when querying properties of SSA names in things
10645 like fold routines.  One level of recursion corresponds to following a
10646 use-def chain.
10648 @item hsa-gen-debug-stores
10649 Enable emission of special debug stores within HSA kernels which are
10650 then read and reported by libgomp plugin.  Generation of these stores
10651 is disabled by default, use @option{--param hsa-gen-debug-stores=1} to
10652 enable it.
10654 @item max-speculative-devirt-maydefs
10655 The maximum number of may-defs we analyze when looking for a must-def
10656 specifying the dynamic type of an object that invokes a virtual call
10657 we may be able to devirtualize speculatively.
10659 @item max-vrp-switch-assertions
10660 The maximum number of assertions to add along the default edge of a switch
10661 statement during VRP.  The default is 10.
10662 @end table
10663 @end table
10665 @node Instrumentation Options
10666 @section Program Instrumentation Options
10667 @cindex instrumentation options
10668 @cindex program instrumentation options
10669 @cindex run-time error checking options
10670 @cindex profiling options
10671 @cindex options, program instrumentation
10672 @cindex options, run-time error checking
10673 @cindex options, profiling
10675 GCC supports a number of command-line options that control adding
10676 run-time instrumentation to the code it normally generates.  
10677 For example, one purpose of instrumentation is collect profiling
10678 statistics for use in finding program hot spots, code coverage
10679 analysis, or profile-guided optimizations.
10680 Another class of program instrumentation is adding run-time checking 
10681 to detect programming errors like invalid pointer
10682 dereferences or out-of-bounds array accesses, as well as deliberately
10683 hostile attacks such as stack smashing or C++ vtable hijacking.
10684 There is also a general hook which can be used to implement other
10685 forms of tracing or function-level instrumentation for debug or
10686 program analysis purposes.
10688 @table @gcctabopt
10689 @cindex @command{prof}
10690 @item -p
10691 @opindex p
10692 Generate extra code to write profile information suitable for the
10693 analysis program @command{prof}.  You must use this option when compiling
10694 the source files you want data about, and you must also use it when
10695 linking.
10697 @cindex @command{gprof}
10698 @item -pg
10699 @opindex pg
10700 Generate extra code to write profile information suitable for the
10701 analysis program @command{gprof}.  You must use this option when compiling
10702 the source files you want data about, and you must also use it when
10703 linking.
10705 @item -fprofile-arcs
10706 @opindex fprofile-arcs
10707 Add code so that program flow @dfn{arcs} are instrumented.  During
10708 execution the program records how many times each branch and call is
10709 executed and how many times it is taken or returns.  On targets that support
10710 constructors with priority support, profiling properly handles constructors,
10711 destructors and C++ constructors (and destructors) of classes which are used
10712 as a type of a global variable.
10714 When the compiled
10715 program exits it saves this data to a file called
10716 @file{@var{auxname}.gcda} for each source file.  The data may be used for
10717 profile-directed optimizations (@option{-fbranch-probabilities}), or for
10718 test coverage analysis (@option{-ftest-coverage}).  Each object file's
10719 @var{auxname} is generated from the name of the output file, if
10720 explicitly specified and it is not the final executable, otherwise it is
10721 the basename of the source file.  In both cases any suffix is removed
10722 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
10723 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
10724 @xref{Cross-profiling}.
10726 @cindex @command{gcov}
10727 @item --coverage
10728 @opindex coverage
10730 This option is used to compile and link code instrumented for coverage
10731 analysis.  The option is a synonym for @option{-fprofile-arcs}
10732 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
10733 linking).  See the documentation for those options for more details.
10735 @itemize
10737 @item
10738 Compile the source files with @option{-fprofile-arcs} plus optimization
10739 and code generation options.  For test coverage analysis, use the
10740 additional @option{-ftest-coverage} option.  You do not need to profile
10741 every source file in a program.
10743 @item
10744 Compile the source files additionally with @option{-fprofile-abs-path}
10745 to create absolute path names in the @file{.gcno} files.  This allows
10746 @command{gcov} to find the correct sources in projects where compilations
10747 occur with different working directories.
10749 @item
10750 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
10751 (the latter implies the former).
10753 @item
10754 Run the program on a representative workload to generate the arc profile
10755 information.  This may be repeated any number of times.  You can run
10756 concurrent instances of your program, and provided that the file system
10757 supports locking, the data files will be correctly updated.  Also
10758 @code{fork} calls are detected and correctly handled (double counting
10759 will not happen).
10761 @item
10762 For profile-directed optimizations, compile the source files again with
10763 the same optimization and code generation options plus
10764 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
10765 Control Optimization}).
10767 @item
10768 For test coverage analysis, use @command{gcov} to produce human readable
10769 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
10770 @command{gcov} documentation for further information.
10772 @end itemize
10774 With @option{-fprofile-arcs}, for each function of your program GCC
10775 creates a program flow graph, then finds a spanning tree for the graph.
10776 Only arcs that are not on the spanning tree have to be instrumented: the
10777 compiler adds code to count the number of times that these arcs are
10778 executed.  When an arc is the only exit or only entrance to a block, the
10779 instrumentation code can be added to the block; otherwise, a new basic
10780 block must be created to hold the instrumentation code.
10782 @need 2000
10783 @item -ftest-coverage
10784 @opindex ftest-coverage
10785 Produce a notes file that the @command{gcov} code-coverage utility
10786 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
10787 show program coverage.  Each source file's note file is called
10788 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
10789 above for a description of @var{auxname} and instructions on how to
10790 generate test coverage data.  Coverage data matches the source files
10791 more closely if you do not optimize.
10793 @item -fprofile-abs-path
10794 @opindex fprofile-abs-path
10795 Automatically convert relative source file names to absolute path names
10796 in the @file{.gcno} files.  This allows @command{gcov} to find the correct
10797 sources in projects where compilations occur with different working
10798 directories.
10800 @item -fprofile-dir=@var{path}
10801 @opindex fprofile-dir
10803 Set the directory to search for the profile data files in to @var{path}.
10804 This option affects only the profile data generated by
10805 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
10806 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
10807 and its related options.  Both absolute and relative paths can be used.
10808 By default, GCC uses the current directory as @var{path}, thus the
10809 profile data file appears in the same directory as the object file.
10811 @item -fprofile-generate
10812 @itemx -fprofile-generate=@var{path}
10813 @opindex fprofile-generate
10815 Enable options usually used for instrumenting application to produce
10816 profile useful for later recompilation with profile feedback based
10817 optimization.  You must use @option{-fprofile-generate} both when
10818 compiling and when linking your program.
10820 The following options are enabled: @option{-fprofile-arcs}, @option{-fprofile-values}, @option{-fvpt}.
10822 If @var{path} is specified, GCC looks at the @var{path} to find
10823 the profile feedback data files. See @option{-fprofile-dir}.
10825 To optimize the program based on the collected profile information, use
10826 @option{-fprofile-use}.  @xref{Optimize Options}, for more information.
10828 @item -fprofile-update=@var{method}
10829 @opindex fprofile-update
10831 Alter the update method for an application instrumented for profile
10832 feedback based optimization.  The @var{method} argument should be one of
10833 @samp{single}, @samp{atomic} or @samp{prefer-atomic}.
10834 The first one is useful for single-threaded applications,
10835 while the second one prevents profile corruption by emitting thread-safe code.
10837 @strong{Warning:} When an application does not properly join all threads
10838 (or creates an detached thread), a profile file can be still corrupted.
10840 Using @samp{prefer-atomic} would be transformed either to @samp{atomic},
10841 when supported by a target, or to @samp{single} otherwise.  The GCC driver
10842 automatically selects @samp{prefer-atomic} when @option{-pthread}
10843 is present in the command line.
10845 @item -fsanitize=address
10846 @opindex fsanitize=address
10847 Enable AddressSanitizer, a fast memory error detector.
10848 Memory access instructions are instrumented to detect
10849 out-of-bounds and use-after-free bugs.
10850 The option enables @option{-fsanitize-address-use-after-scope}.
10851 See @uref{https://github.com/google/sanitizers/wiki/AddressSanitizer} for
10852 more details.  The run-time behavior can be influenced using the
10853 @env{ASAN_OPTIONS} environment variable.  When set to @code{help=1},
10854 the available options are shown at startup of the instrumented program.  See
10855 @url{https://github.com/google/sanitizers/wiki/AddressSanitizerFlags#run-time-flags}
10856 for a list of supported options.
10857 The option cannot be combined with @option{-fsanitize=thread}
10858 and/or @option{-fcheck-pointer-bounds}.
10860 @item -fsanitize=kernel-address
10861 @opindex fsanitize=kernel-address
10862 Enable AddressSanitizer for Linux kernel.
10863 See @uref{https://github.com/google/kasan/wiki} for more details.
10864 The option cannot be combined with @option{-fcheck-pointer-bounds}.
10866 @item -fsanitize=thread
10867 @opindex fsanitize=thread
10868 Enable ThreadSanitizer, a fast data race detector.
10869 Memory access instructions are instrumented to detect
10870 data race bugs.  See @uref{https://github.com/google/sanitizers/wiki#threadsanitizer} for more
10871 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
10872 environment variable; see
10873 @url{https://github.com/google/sanitizers/wiki/ThreadSanitizerFlags} for a list of
10874 supported options.
10875 The option cannot be combined with @option{-fsanitize=address},
10876 @option{-fsanitize=leak} and/or @option{-fcheck-pointer-bounds}.
10878 Note that sanitized atomic builtins cannot throw exceptions when
10879 operating on invalid memory addresses with non-call exceptions
10880 (@option{-fnon-call-exceptions}).
10882 @item -fsanitize=leak
10883 @opindex fsanitize=leak
10884 Enable LeakSanitizer, a memory leak detector.
10885 This option only matters for linking of executables and
10886 the executable is linked against a library that overrides @code{malloc}
10887 and other allocator functions.  See
10888 @uref{https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer} for more
10889 details.  The run-time behavior can be influenced using the
10890 @env{LSAN_OPTIONS} environment variable.
10891 The option cannot be combined with @option{-fsanitize=thread}.
10893 @item -fsanitize=undefined
10894 @opindex fsanitize=undefined
10895 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
10896 Various computations are instrumented to detect undefined behavior
10897 at runtime.  Current suboptions are:
10899 @table @gcctabopt
10901 @item -fsanitize=shift
10902 @opindex fsanitize=shift
10903 This option enables checking that the result of a shift operation is
10904 not undefined.  Note that what exactly is considered undefined differs
10905 slightly between C and C++, as well as between ISO C90 and C99, etc.
10906 This option has two suboptions, @option{-fsanitize=shift-base} and
10907 @option{-fsanitize=shift-exponent}.
10909 @item -fsanitize=shift-exponent
10910 @opindex fsanitize=shift-exponent
10911 This option enables checking that the second argument of a shift operation
10912 is not negative and is smaller than the precision of the promoted first
10913 argument.
10915 @item -fsanitize=shift-base
10916 @opindex fsanitize=shift-base
10917 If the second argument of a shift operation is within range, check that the
10918 result of a shift operation is not undefined.  Note that what exactly is
10919 considered undefined differs slightly between C and C++, as well as between
10920 ISO C90 and C99, etc.
10922 @item -fsanitize=integer-divide-by-zero
10923 @opindex fsanitize=integer-divide-by-zero
10924 Detect integer division by zero as well as @code{INT_MIN / -1} division.
10926 @item -fsanitize=unreachable
10927 @opindex fsanitize=unreachable
10928 With this option, the compiler turns the @code{__builtin_unreachable}
10929 call into a diagnostics message call instead.  When reaching the
10930 @code{__builtin_unreachable} call, the behavior is undefined.
10932 @item -fsanitize=vla-bound
10933 @opindex fsanitize=vla-bound
10934 This option instructs the compiler to check that the size of a variable
10935 length array is positive.
10937 @item -fsanitize=null
10938 @opindex fsanitize=null
10939 This option enables pointer checking.  Particularly, the application
10940 built with this option turned on will issue an error message when it
10941 tries to dereference a NULL pointer, or if a reference (possibly an
10942 rvalue reference) is bound to a NULL pointer, or if a method is invoked
10943 on an object pointed by a NULL pointer.
10945 @item -fsanitize=return
10946 @opindex fsanitize=return
10947 This option enables return statement checking.  Programs
10948 built with this option turned on will issue an error message
10949 when the end of a non-void function is reached without actually
10950 returning a value.  This option works in C++ only.
10952 @item -fsanitize=signed-integer-overflow
10953 @opindex fsanitize=signed-integer-overflow
10954 This option enables signed integer overflow checking.  We check that
10955 the result of @code{+}, @code{*}, and both unary and binary @code{-}
10956 does not overflow in the signed arithmetics.  Note, integer promotion
10957 rules must be taken into account.  That is, the following is not an
10958 overflow:
10959 @smallexample
10960 signed char a = SCHAR_MAX;
10961 a++;
10962 @end smallexample
10964 @item -fsanitize=bounds
10965 @opindex fsanitize=bounds
10966 This option enables instrumentation of array bounds.  Various out of bounds
10967 accesses are detected.  Flexible array members, flexible array member-like
10968 arrays, and initializers of variables with static storage are not instrumented.
10969 The option cannot be combined with @option{-fcheck-pointer-bounds}.
10971 @item -fsanitize=bounds-strict
10972 @opindex fsanitize=bounds-strict
10973 This option enables strict instrumentation of array bounds.  Most out of bounds
10974 accesses are detected, including flexible array members and flexible array
10975 member-like arrays.  Initializers of variables with static storage are not
10976 instrumented.  The option cannot be combined
10977 with @option{-fcheck-pointer-bounds}.
10979 @item -fsanitize=alignment
10980 @opindex fsanitize=alignment
10982 This option enables checking of alignment of pointers when they are
10983 dereferenced, or when a reference is bound to insufficiently aligned target,
10984 or when a method or constructor is invoked on insufficiently aligned object.
10986 @item -fsanitize=object-size
10987 @opindex fsanitize=object-size
10988 This option enables instrumentation of memory references using the
10989 @code{__builtin_object_size} function.  Various out of bounds pointer
10990 accesses are detected.
10992 @item -fsanitize=float-divide-by-zero
10993 @opindex fsanitize=float-divide-by-zero
10994 Detect floating-point division by zero.  Unlike other similar options,
10995 @option{-fsanitize=float-divide-by-zero} is not enabled by
10996 @option{-fsanitize=undefined}, since floating-point division by zero can
10997 be a legitimate way of obtaining infinities and NaNs.
10999 @item -fsanitize=float-cast-overflow
11000 @opindex fsanitize=float-cast-overflow
11001 This option enables floating-point type to integer conversion checking.
11002 We check that the result of the conversion does not overflow.
11003 Unlike other similar options, @option{-fsanitize=float-cast-overflow} is
11004 not enabled by @option{-fsanitize=undefined}.
11005 This option does not work well with @code{FE_INVALID} exceptions enabled.
11007 @item -fsanitize=nonnull-attribute
11008 @opindex fsanitize=nonnull-attribute
11010 This option enables instrumentation of calls, checking whether null values
11011 are not passed to arguments marked as requiring a non-null value by the
11012 @code{nonnull} function attribute.
11014 @item -fsanitize=returns-nonnull-attribute
11015 @opindex fsanitize=returns-nonnull-attribute
11017 This option enables instrumentation of return statements in functions
11018 marked with @code{returns_nonnull} function attribute, to detect returning
11019 of null values from such functions.
11021 @item -fsanitize=bool
11022 @opindex fsanitize=bool
11024 This option enables instrumentation of loads from bool.  If a value other
11025 than 0/1 is loaded, a run-time error is issued.
11027 @item -fsanitize=enum
11028 @opindex fsanitize=enum
11030 This option enables instrumentation of loads from an enum type.  If
11031 a value outside the range of values for the enum type is loaded,
11032 a run-time error is issued.
11034 @item -fsanitize=vptr
11035 @opindex fsanitize=vptr
11037 This option enables instrumentation of C++ member function calls, member
11038 accesses and some conversions between pointers to base and derived classes,
11039 to verify the referenced object has the correct dynamic type.
11041 @end table
11043 While @option{-ftrapv} causes traps for signed overflows to be emitted,
11044 @option{-fsanitize=undefined} gives a diagnostic message.
11045 This currently works only for the C family of languages.
11047 @item -fno-sanitize=all
11048 @opindex fno-sanitize=all
11050 This option disables all previously enabled sanitizers.
11051 @option{-fsanitize=all} is not allowed, as some sanitizers cannot be used
11052 together.
11054 @item -fasan-shadow-offset=@var{number}
11055 @opindex fasan-shadow-offset
11056 This option forces GCC to use custom shadow offset in AddressSanitizer checks.
11057 It is useful for experimenting with different shadow memory layouts in
11058 Kernel AddressSanitizer.
11060 @item -fsanitize-sections=@var{s1},@var{s2},...
11061 @opindex fsanitize-sections
11062 Sanitize global variables in selected user-defined sections.  @var{si} may
11063 contain wildcards.
11065 @item -fsanitize-recover@r{[}=@var{opts}@r{]}
11066 @opindex fsanitize-recover
11067 @opindex fno-sanitize-recover
11068 @option{-fsanitize-recover=} controls error recovery mode for sanitizers
11069 mentioned in comma-separated list of @var{opts}.  Enabling this option
11070 for a sanitizer component causes it to attempt to continue
11071 running the program as if no error happened.  This means multiple
11072 runtime errors can be reported in a single program run, and the exit
11073 code of the program may indicate success even when errors
11074 have been reported.  The @option{-fno-sanitize-recover=} option
11075 can be used to alter
11076 this behavior: only the first detected error is reported
11077 and program then exits with a non-zero exit code.
11079 Currently this feature only works for @option{-fsanitize=undefined} (and its suboptions
11080 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return}),
11081 @option{-fsanitize=float-cast-overflow}, @option{-fsanitize=float-divide-by-zero},
11082 @option{-fsanitize=bounds-strict},
11083 @option{-fsanitize=kernel-address} and @option{-fsanitize=address}.
11084 For these sanitizers error recovery is turned on by default,
11085 except @option{-fsanitize=address}, for which this feature is experimental.
11086 @option{-fsanitize-recover=all} and @option{-fno-sanitize-recover=all} is also
11087 accepted, the former enables recovery for all sanitizers that support it,
11088 the latter disables recovery for all sanitizers that support it.
11090 Even if a recovery mode is turned on the compiler side, it needs to be also
11091 enabled on the runtime library side, otherwise the failures are still fatal.
11092 The runtime library defaults to @code{halt_on_error=0} for
11093 ThreadSanitizer and UndefinedBehaviorSanitizer, while default value for
11094 AddressSanitizer is @code{halt_on_error=1}. This can be overridden through
11095 setting the @code{halt_on_error} flag in the corresponding environment variable.
11097 Syntax without an explicit @var{opts} parameter is deprecated.  It is
11098 equivalent to specifying an @var{opts} list of:
11100 @smallexample
11101 undefined,float-cast-overflow,float-divide-by-zero,bounds-strict
11102 @end smallexample
11104 @item -fsanitize-address-use-after-scope
11105 @opindex fsanitize-address-use-after-scope
11106 Enable sanitization of local variables to detect use-after-scope bugs.
11107 The option sets @option{-fstack-reuse} to @samp{none}.
11109 @item -fsanitize-undefined-trap-on-error
11110 @opindex fsanitize-undefined-trap-on-error
11111 The @option{-fsanitize-undefined-trap-on-error} option instructs the compiler to
11112 report undefined behavior using @code{__builtin_trap} rather than
11113 a @code{libubsan} library routine.  The advantage of this is that the
11114 @code{libubsan} library is not needed and is not linked in, so this
11115 is usable even in freestanding environments.
11117 @item -fsanitize-coverage=trace-pc
11118 @opindex fsanitize-coverage=trace-pc
11119 Enable coverage-guided fuzzing code instrumentation.
11120 Inserts a call to @code{__sanitizer_cov_trace_pc} into every basic block.
11122 @item -fbounds-check
11123 @opindex fbounds-check
11124 For front ends that support it, generate additional code to check that
11125 indices used to access arrays are within the declared range.  This is
11126 currently only supported by the Fortran front end, where this option
11127 defaults to false.
11129 @item -fcheck-pointer-bounds
11130 @opindex fcheck-pointer-bounds
11131 @opindex fno-check-pointer-bounds
11132 @cindex Pointer Bounds Checker options
11133 Enable Pointer Bounds Checker instrumentation.  Each memory reference
11134 is instrumented with checks of the pointer used for memory access against
11135 bounds associated with that pointer.  
11137 Currently there
11138 is only an implementation for Intel MPX available, thus x86 GNU/Linux target
11139 and @option{-mmpx} are required to enable this feature.  
11140 MPX-based instrumentation requires
11141 a runtime library to enable MPX in hardware and handle bounds
11142 violation signals.  By default when @option{-fcheck-pointer-bounds}
11143 and @option{-mmpx} options are used to link a program, the GCC driver
11144 links against the @file{libmpx} and @file{libmpxwrappers} libraries.
11145 Bounds checking on calls to dynamic libraries requires a linker
11146 with @option{-z bndplt} support; if GCC was configured with a linker
11147 without support for this option (including the Gold linker and older
11148 versions of ld), a warning is given if you link with @option{-mmpx}
11149 without also specifying @option{-static}, since the overall effectiveness
11150 of the bounds checking protection is reduced.
11151 See also @option{-static-libmpxwrappers}.
11153 MPX-based instrumentation
11154 may be used for debugging and also may be included in production code
11155 to increase program security.  Depending on usage, you may
11156 have different requirements for the runtime library.  The current version
11157 of the MPX runtime library is more oriented for use as a debugging
11158 tool.  MPX runtime library usage implies @option{-lpthread}.  See
11159 also @option{-static-libmpx}.  The runtime library  behavior can be
11160 influenced using various @env{CHKP_RT_*} environment variables.  See
11161 @uref{https://gcc.gnu.org/wiki/Intel%20MPX%20support%20in%20the%20GCC%20compiler}
11162 for more details.
11164 Generated instrumentation may be controlled by various
11165 @option{-fchkp-*} options and by the @code{bnd_variable_size}
11166 structure field attribute (@pxref{Type Attributes}) and
11167 @code{bnd_legacy}, and @code{bnd_instrument} function attributes
11168 (@pxref{Function Attributes}).  GCC also provides a number of built-in
11169 functions for controlling the Pointer Bounds Checker.  @xref{Pointer
11170 Bounds Checker builtins}, for more information.
11172 @item -fchkp-check-incomplete-type
11173 @opindex fchkp-check-incomplete-type
11174 @opindex fno-chkp-check-incomplete-type
11175 Generate pointer bounds checks for variables with incomplete type.
11176 Enabled by default.
11178 @item -fchkp-narrow-bounds
11179 @opindex fchkp-narrow-bounds
11180 @opindex fno-chkp-narrow-bounds
11181 Controls bounds used by Pointer Bounds Checker for pointers to object
11182 fields.  If narrowing is enabled then field bounds are used.  Otherwise
11183 object bounds are used.  See also @option{-fchkp-narrow-to-innermost-array}
11184 and @option{-fchkp-first-field-has-own-bounds}.  Enabled by default.
11186 @item -fchkp-first-field-has-own-bounds
11187 @opindex fchkp-first-field-has-own-bounds
11188 @opindex fno-chkp-first-field-has-own-bounds
11189 Forces Pointer Bounds Checker to use narrowed bounds for the address of the
11190 first field in the structure.  By default a pointer to the first field has
11191 the same bounds as a pointer to the whole structure.
11193 @item -fchkp-flexible-struct-trailing-arrays
11194 @opindex fchkp-flexible-struct-trailing-arrays
11195 @opindex fno-chkp-flexible-struct-trailing-arrays
11196 Forces Pointer Bounds Checker to treat all trailing arrays in structures as
11197 possibly flexible.  By default only array fields with zero length or that are
11198 marked with attribute bnd_variable_size are treated as flexible.
11200 @item -fchkp-narrow-to-innermost-array
11201 @opindex fchkp-narrow-to-innermost-array
11202 @opindex fno-chkp-narrow-to-innermost-array
11203 Forces Pointer Bounds Checker to use bounds of the innermost arrays in
11204 case of nested static array access.  By default this option is disabled and
11205 bounds of the outermost array are used.
11207 @item -fchkp-optimize
11208 @opindex fchkp-optimize
11209 @opindex fno-chkp-optimize
11210 Enables Pointer Bounds Checker optimizations.  Enabled by default at
11211 optimization levels @option{-O}, @option{-O2}, @option{-O3}.
11213 @item -fchkp-use-fast-string-functions
11214 @opindex fchkp-use-fast-string-functions
11215 @opindex fno-chkp-use-fast-string-functions
11216 Enables use of @code{*_nobnd} versions of string functions (not copying bounds)
11217 by Pointer Bounds Checker.  Disabled by default.
11219 @item -fchkp-use-nochk-string-functions
11220 @opindex fchkp-use-nochk-string-functions
11221 @opindex fno-chkp-use-nochk-string-functions
11222 Enables use of @code{*_nochk} versions of string functions (not checking bounds)
11223 by Pointer Bounds Checker.  Disabled by default.
11225 @item -fchkp-use-static-bounds
11226 @opindex fchkp-use-static-bounds
11227 @opindex fno-chkp-use-static-bounds
11228 Allow Pointer Bounds Checker to generate static bounds holding
11229 bounds of static variables.  Enabled by default.
11231 @item -fchkp-use-static-const-bounds
11232 @opindex fchkp-use-static-const-bounds
11233 @opindex fno-chkp-use-static-const-bounds
11234 Use statically-initialized bounds for constant bounds instead of
11235 generating them each time they are required.  By default enabled when
11236 @option{-fchkp-use-static-bounds} is enabled.
11238 @item -fchkp-treat-zero-dynamic-size-as-infinite
11239 @opindex fchkp-treat-zero-dynamic-size-as-infinite
11240 @opindex fno-chkp-treat-zero-dynamic-size-as-infinite
11241 With this option, objects with incomplete type whose
11242 dynamically-obtained size is zero are treated as having infinite size
11243 instead by Pointer Bounds
11244 Checker.  This option may be helpful if a program is linked with a library
11245 missing size information for some symbols.  Disabled by default.
11247 @item -fchkp-check-read
11248 @opindex fchkp-check-read
11249 @opindex fno-chkp-check-read
11250 Instructs Pointer Bounds Checker to generate checks for all read
11251 accesses to memory.  Enabled by default.
11253 @item -fchkp-check-write
11254 @opindex fchkp-check-write
11255 @opindex fno-chkp-check-write
11256 Instructs Pointer Bounds Checker to generate checks for all write
11257 accesses to memory.  Enabled by default.
11259 @item -fchkp-store-bounds
11260 @opindex fchkp-store-bounds
11261 @opindex fno-chkp-store-bounds
11262 Instructs Pointer Bounds Checker to generate bounds stores for
11263 pointer writes.  Enabled by default.
11265 @item -fchkp-instrument-calls
11266 @opindex fchkp-instrument-calls
11267 @opindex fno-chkp-instrument-calls
11268 Instructs Pointer Bounds Checker to pass pointer bounds to calls.
11269 Enabled by default.
11271 @item -fchkp-instrument-marked-only
11272 @opindex fchkp-instrument-marked-only
11273 @opindex fno-chkp-instrument-marked-only
11274 Instructs Pointer Bounds Checker to instrument only functions
11275 marked with the @code{bnd_instrument} attribute
11276 (@pxref{Function Attributes}).  Disabled by default.
11278 @item -fchkp-use-wrappers
11279 @opindex fchkp-use-wrappers
11280 @opindex fno-chkp-use-wrappers
11281 Allows Pointer Bounds Checker to replace calls to built-in functions
11282 with calls to wrapper functions.  When @option{-fchkp-use-wrappers}
11283 is used to link a program, the GCC driver automatically links
11284 against @file{libmpxwrappers}.  See also @option{-static-libmpxwrappers}.
11285 Enabled by default.
11287 @item -fstack-protector
11288 @opindex fstack-protector
11289 Emit extra code to check for buffer overflows, such as stack smashing
11290 attacks.  This is done by adding a guard variable to functions with
11291 vulnerable objects.  This includes functions that call @code{alloca}, and
11292 functions with buffers larger than 8 bytes.  The guards are initialized
11293 when a function is entered and then checked when the function exits.
11294 If a guard check fails, an error message is printed and the program exits.
11296 @item -fstack-protector-all
11297 @opindex fstack-protector-all
11298 Like @option{-fstack-protector} except that all functions are protected.
11300 @item -fstack-protector-strong
11301 @opindex fstack-protector-strong
11302 Like @option{-fstack-protector} but includes additional functions to
11303 be protected --- those that have local array definitions, or have
11304 references to local frame addresses.
11306 @item -fstack-protector-explicit
11307 @opindex fstack-protector-explicit
11308 Like @option{-fstack-protector} but only protects those functions which
11309 have the @code{stack_protect} attribute.
11311 @item -fstack-check
11312 @opindex fstack-check
11313 Generate code to verify that you do not go beyond the boundary of the
11314 stack.  You should specify this flag if you are running in an
11315 environment with multiple threads, but you only rarely need to specify it in
11316 a single-threaded environment since stack overflow is automatically
11317 detected on nearly all systems if there is only one stack.
11319 Note that this switch does not actually cause checking to be done; the
11320 operating system or the language runtime must do that.  The switch causes
11321 generation of code to ensure that they see the stack being extended.
11323 You can additionally specify a string parameter: @samp{no} means no
11324 checking, @samp{generic} means force the use of old-style checking,
11325 @samp{specific} means use the best checking method and is equivalent
11326 to bare @option{-fstack-check}.
11328 Old-style checking is a generic mechanism that requires no specific
11329 target support in the compiler but comes with the following drawbacks:
11331 @enumerate
11332 @item
11333 Modified allocation strategy for large objects: they are always
11334 allocated dynamically if their size exceeds a fixed threshold.
11336 @item
11337 Fixed limit on the size of the static frame of functions: when it is
11338 topped by a particular function, stack checking is not reliable and
11339 a warning is issued by the compiler.
11341 @item
11342 Inefficiency: because of both the modified allocation strategy and the
11343 generic implementation, code performance is hampered.
11344 @end enumerate
11346 Note that old-style stack checking is also the fallback method for
11347 @samp{specific} if no target support has been added in the compiler.
11349 @item -fstack-limit-register=@var{reg}
11350 @itemx -fstack-limit-symbol=@var{sym}
11351 @itemx -fno-stack-limit
11352 @opindex fstack-limit-register
11353 @opindex fstack-limit-symbol
11354 @opindex fno-stack-limit
11355 Generate code to ensure that the stack does not grow beyond a certain value,
11356 either the value of a register or the address of a symbol.  If a larger
11357 stack is required, a signal is raised at run time.  For most targets,
11358 the signal is raised before the stack overruns the boundary, so
11359 it is possible to catch the signal without taking special precautions.
11361 For instance, if the stack starts at absolute address @samp{0x80000000}
11362 and grows downwards, you can use the flags
11363 @option{-fstack-limit-symbol=__stack_limit} and
11364 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11365 of 128KB@.  Note that this may only work with the GNU linker.
11367 You can locally override stack limit checking by using the
11368 @code{no_stack_limit} function attribute (@pxref{Function Attributes}).
11370 @item -fsplit-stack
11371 @opindex fsplit-stack
11372 Generate code to automatically split the stack before it overflows.
11373 The resulting program has a discontiguous stack which can only
11374 overflow if the program is unable to allocate any more memory.  This
11375 is most useful when running threaded programs, as it is no longer
11376 necessary to calculate a good stack size to use for each thread.  This
11377 is currently only implemented for the x86 targets running
11378 GNU/Linux.
11380 When code compiled with @option{-fsplit-stack} calls code compiled
11381 without @option{-fsplit-stack}, there may not be much stack space
11382 available for the latter code to run.  If compiling all code,
11383 including library code, with @option{-fsplit-stack} is not an option,
11384 then the linker can fix up these calls so that the code compiled
11385 without @option{-fsplit-stack} always has a large stack.  Support for
11386 this is implemented in the gold linker in GNU binutils release 2.21
11387 and later.
11389 @item -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]}
11390 @opindex fvtable-verify
11391 This option is only available when compiling C++ code.
11392 It turns on (or off, if using @option{-fvtable-verify=none}) the security
11393 feature that verifies at run time, for every virtual call, that
11394 the vtable pointer through which the call is made is valid for the type of
11395 the object, and has not been corrupted or overwritten.  If an invalid vtable
11396 pointer is detected at run time, an error is reported and execution of the
11397 program is immediately halted.
11399 This option causes run-time data structures to be built at program startup,
11400 which are used for verifying the vtable pointers.  
11401 The options @samp{std} and @samp{preinit}
11402 control the timing of when these data structures are built.  In both cases the
11403 data structures are built before execution reaches @code{main}.  Using
11404 @option{-fvtable-verify=std} causes the data structures to be built after
11405 shared libraries have been loaded and initialized.
11406 @option{-fvtable-verify=preinit} causes them to be built before shared
11407 libraries have been loaded and initialized.
11409 If this option appears multiple times in the command line with different
11410 values specified, @samp{none} takes highest priority over both @samp{std} and
11411 @samp{preinit}; @samp{preinit} takes priority over @samp{std}.
11413 @item -fvtv-debug
11414 @opindex fvtv-debug
11415 When used in conjunction with @option{-fvtable-verify=std} or 
11416 @option{-fvtable-verify=preinit}, causes debug versions of the 
11417 runtime functions for the vtable verification feature to be called.  
11418 This flag also causes the compiler to log information about which 
11419 vtable pointers it finds for each class.
11420 This information is written to a file named @file{vtv_set_ptr_data.log} 
11421 in the directory named by the environment variable @env{VTV_LOGS_DIR} 
11422 if that is defined or the current working directory otherwise.
11424 Note:  This feature @emph{appends} data to the log file. If you want a fresh log
11425 file, be sure to delete any existing one.
11427 @item -fvtv-counts
11428 @opindex fvtv-counts
11429 This is a debugging flag.  When used in conjunction with
11430 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
11431 causes the compiler to keep track of the total number of virtual calls
11432 it encounters and the number of verifications it inserts.  It also
11433 counts the number of calls to certain run-time library functions
11434 that it inserts and logs this information for each compilation unit.
11435 The compiler writes this information to a file named
11436 @file{vtv_count_data.log} in the directory named by the environment
11437 variable @env{VTV_LOGS_DIR} if that is defined or the current working
11438 directory otherwise.  It also counts the size of the vtable pointer sets
11439 for each class, and writes this information to @file{vtv_class_set_sizes.log}
11440 in the same directory.
11442 Note:  This feature @emph{appends} data to the log files.  To get fresh log
11443 files, be sure to delete any existing ones.
11445 @item -finstrument-functions
11446 @opindex finstrument-functions
11447 Generate instrumentation calls for entry and exit to functions.  Just
11448 after function entry and just before function exit, the following
11449 profiling functions are called with the address of the current
11450 function and its call site.  (On some platforms,
11451 @code{__builtin_return_address} does not work beyond the current
11452 function, so the call site information may not be available to the
11453 profiling functions otherwise.)
11455 @smallexample
11456 void __cyg_profile_func_enter (void *this_fn,
11457                                void *call_site);
11458 void __cyg_profile_func_exit  (void *this_fn,
11459                                void *call_site);
11460 @end smallexample
11462 The first argument is the address of the start of the current function,
11463 which may be looked up exactly in the symbol table.
11465 This instrumentation is also done for functions expanded inline in other
11466 functions.  The profiling calls indicate where, conceptually, the
11467 inline function is entered and exited.  This means that addressable
11468 versions of such functions must be available.  If all your uses of a
11469 function are expanded inline, this may mean an additional expansion of
11470 code size.  If you use @code{extern inline} in your C code, an
11471 addressable version of such functions must be provided.  (This is
11472 normally the case anyway, but if you get lucky and the optimizer always
11473 expands the functions inline, you might have gotten away without
11474 providing static copies.)
11476 A function may be given the attribute @code{no_instrument_function}, in
11477 which case this instrumentation is not done.  This can be used, for
11478 example, for the profiling functions listed above, high-priority
11479 interrupt routines, and any functions from which the profiling functions
11480 cannot safely be called (perhaps signal handlers, if the profiling
11481 routines generate output or allocate memory).
11483 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
11484 @opindex finstrument-functions-exclude-file-list
11486 Set the list of functions that are excluded from instrumentation (see
11487 the description of @option{-finstrument-functions}).  If the file that
11488 contains a function definition matches with one of @var{file}, then
11489 that function is not instrumented.  The match is done on substrings:
11490 if the @var{file} parameter is a substring of the file name, it is
11491 considered to be a match.
11493 For example:
11495 @smallexample
11496 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
11497 @end smallexample
11499 @noindent
11500 excludes any inline function defined in files whose pathnames
11501 contain @file{/bits/stl} or @file{include/sys}.
11503 If, for some reason, you want to include letter @samp{,} in one of
11504 @var{sym}, write @samp{\,}. For example,
11505 @option{-finstrument-functions-exclude-file-list='\,\,tmp'}
11506 (note the single quote surrounding the option).
11508 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
11509 @opindex finstrument-functions-exclude-function-list
11511 This is similar to @option{-finstrument-functions-exclude-file-list},
11512 but this option sets the list of function names to be excluded from
11513 instrumentation.  The function name to be matched is its user-visible
11514 name, such as @code{vector<int> blah(const vector<int> &)}, not the
11515 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
11516 match is done on substrings: if the @var{sym} parameter is a substring
11517 of the function name, it is considered to be a match.  For C99 and C++
11518 extended identifiers, the function name must be given in UTF-8, not
11519 using universal character names.
11521 @item -fpatchable-function-entry=@var{N}[,@var{M}]
11522 @opindex fpatchable-function-entry
11523 Generate @var{N} NOPs right at the beginning
11524 of each function, with the function entry point before the @var{M}th NOP.
11525 If @var{M} is omitted, it defaults to @code{0} so the
11526 function entry points to the address just at the first NOP.
11527 The NOP instructions reserve extra space which can be used to patch in
11528 any desired instrumentation at run time, provided that the code segment
11529 is writable.  The amount of space is controllable indirectly via
11530 the number of NOPs; the NOP instruction used corresponds to the instruction
11531 emitted by the internal GCC back-end interface @code{gen_nop}.  This behavior
11532 is target-specific and may also depend on the architecture variant and/or
11533 other compilation options.
11535 For run-time identification, the starting addresses of these areas,
11536 which correspond to their respective function entries minus @var{M},
11537 are additionally collected in the @code{__patchable_function_entries}
11538 section of the resulting binary.
11540 Note that the value of @code{__attribute__ ((patchable_function_entry
11541 (N,M)))} takes precedence over command-line option
11542 @option{-fpatchable-function-entry=N,M}.  This can be used to increase
11543 the area size or to remove it completely on a single function.
11544 If @code{N=0}, no pad location is recorded.
11546 The NOP instructions are inserted at---and maybe before, depending on
11547 @var{M}---the function entry address, even before the prologue.
11549 @end table
11552 @node Preprocessor Options
11553 @section Options Controlling the Preprocessor
11554 @cindex preprocessor options
11555 @cindex options, preprocessor
11557 These options control the C preprocessor, which is run on each C source
11558 file before actual compilation.
11560 If you use the @option{-E} option, nothing is done except preprocessing.
11561 Some of these options make sense only together with @option{-E} because
11562 they cause the preprocessor output to be unsuitable for actual
11563 compilation.
11565 In addition to the options listed here, there are a number of options 
11566 to control search paths for include files documented in 
11567 @ref{Directory Options}.  
11568 Options to control preprocessor diagnostics are listed in 
11569 @ref{Warning Options}.
11571 @table @gcctabopt
11572 @include cppopts.texi
11574 @item -Wp,@var{option}
11575 @opindex Wp
11576 You can use @option{-Wp,@var{option}} to bypass the compiler driver
11577 and pass @var{option} directly through to the preprocessor.  If
11578 @var{option} contains commas, it is split into multiple options at the
11579 commas.  However, many options are modified, translated or interpreted
11580 by the compiler driver before being passed to the preprocessor, and
11581 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
11582 interface is undocumented and subject to change, so whenever possible
11583 you should avoid using @option{-Wp} and let the driver handle the
11584 options instead.
11586 @item -Xpreprocessor @var{option}
11587 @opindex Xpreprocessor
11588 Pass @var{option} as an option to the preprocessor.  You can use this to
11589 supply system-specific preprocessor options that GCC does not 
11590 recognize.
11592 If you want to pass an option that takes an argument, you must use
11593 @option{-Xpreprocessor} twice, once for the option and once for the argument.
11595 @item -no-integrated-cpp
11596 @opindex no-integrated-cpp
11597 Perform preprocessing as a separate pass before compilation.
11598 By default, GCC performs preprocessing as an integrated part of
11599 input tokenization and parsing.
11600 If this option is provided, the appropriate language front end
11601 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
11602 and Objective-C, respectively) is instead invoked twice,
11603 once for preprocessing only and once for actual compilation
11604 of the preprocessed input.
11605 This option may be useful in conjunction with the @option{-B} or
11606 @option{-wrapper} options to specify an alternate preprocessor or
11607 perform additional processing of the program source between
11608 normal preprocessing and compilation.
11610 @end table
11612 @node Assembler Options
11613 @section Passing Options to the Assembler
11615 @c prevent bad page break with this line
11616 You can pass options to the assembler.
11618 @table @gcctabopt
11619 @item -Wa,@var{option}
11620 @opindex Wa
11621 Pass @var{option} as an option to the assembler.  If @var{option}
11622 contains commas, it is split into multiple options at the commas.
11624 @item -Xassembler @var{option}
11625 @opindex Xassembler
11626 Pass @var{option} as an option to the assembler.  You can use this to
11627 supply system-specific assembler options that GCC does not
11628 recognize.
11630 If you want to pass an option that takes an argument, you must use
11631 @option{-Xassembler} twice, once for the option and once for the argument.
11633 @end table
11635 @node Link Options
11636 @section Options for Linking
11637 @cindex link options
11638 @cindex options, linking
11640 These options come into play when the compiler links object files into
11641 an executable output file.  They are meaningless if the compiler is
11642 not doing a link step.
11644 @table @gcctabopt
11645 @cindex file names
11646 @item @var{object-file-name}
11647 A file name that does not end in a special recognized suffix is
11648 considered to name an object file or library.  (Object files are
11649 distinguished from libraries by the linker according to the file
11650 contents.)  If linking is done, these object files are used as input
11651 to the linker.
11653 @item -c
11654 @itemx -S
11655 @itemx -E
11656 @opindex c
11657 @opindex S
11658 @opindex E
11659 If any of these options is used, then the linker is not run, and
11660 object file names should not be used as arguments.  @xref{Overall
11661 Options}.
11663 @item -fuse-ld=bfd
11664 @opindex fuse-ld=bfd
11665 Use the @command{bfd} linker instead of the default linker.
11667 @item -fuse-ld=gold
11668 @opindex fuse-ld=gold
11669 Use the @command{gold} linker instead of the default linker.
11671 @cindex Libraries
11672 @item -l@var{library}
11673 @itemx -l @var{library}
11674 @opindex l
11675 Search the library named @var{library} when linking.  (The second
11676 alternative with the library as a separate argument is only for
11677 POSIX compliance and is not recommended.)
11679 It makes a difference where in the command you write this option; the
11680 linker searches and processes libraries and object files in the order they
11681 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
11682 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
11683 to functions in @samp{z}, those functions may not be loaded.
11685 The linker searches a standard list of directories for the library,
11686 which is actually a file named @file{lib@var{library}.a}.  The linker
11687 then uses this file as if it had been specified precisely by name.
11689 The directories searched include several standard system directories
11690 plus any that you specify with @option{-L}.
11692 Normally the files found this way are library files---archive files
11693 whose members are object files.  The linker handles an archive file by
11694 scanning through it for members which define symbols that have so far
11695 been referenced but not defined.  But if the file that is found is an
11696 ordinary object file, it is linked in the usual fashion.  The only
11697 difference between using an @option{-l} option and specifying a file name
11698 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
11699 and searches several directories.
11701 @item -lobjc
11702 @opindex lobjc
11703 You need this special case of the @option{-l} option in order to
11704 link an Objective-C or Objective-C++ program.
11706 @item -nostartfiles
11707 @opindex nostartfiles
11708 Do not use the standard system startup files when linking.
11709 The standard system libraries are used normally, unless @option{-nostdlib}
11710 or @option{-nodefaultlibs} is used.
11712 @item -nodefaultlibs
11713 @opindex nodefaultlibs
11714 Do not use the standard system libraries when linking.
11715 Only the libraries you specify are passed to the linker, and options
11716 specifying linkage of the system libraries, such as @option{-static-libgcc}
11717 or @option{-shared-libgcc}, are ignored.  
11718 The standard startup files are used normally, unless @option{-nostartfiles}
11719 is used.  
11721 The compiler may generate calls to @code{memcmp},
11722 @code{memset}, @code{memcpy} and @code{memmove}.
11723 These entries are usually resolved by entries in
11724 libc.  These entry points should be supplied through some other
11725 mechanism when this option is specified.
11727 @item -nostdlib
11728 @opindex nostdlib
11729 Do not use the standard system startup files or libraries when linking.
11730 No startup files and only the libraries you specify are passed to
11731 the linker, and options specifying linkage of the system libraries, such as
11732 @option{-static-libgcc} or @option{-shared-libgcc}, are ignored.
11734 The compiler may generate calls to @code{memcmp}, @code{memset},
11735 @code{memcpy} and @code{memmove}.
11736 These entries are usually resolved by entries in
11737 libc.  These entry points should be supplied through some other
11738 mechanism when this option is specified.
11740 @cindex @option{-lgcc}, use with @option{-nostdlib}
11741 @cindex @option{-nostdlib} and unresolved references
11742 @cindex unresolved references and @option{-nostdlib}
11743 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
11744 @cindex @option{-nodefaultlibs} and unresolved references
11745 @cindex unresolved references and @option{-nodefaultlibs}
11746 One of the standard libraries bypassed by @option{-nostdlib} and
11747 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
11748 which GCC uses to overcome shortcomings of particular machines, or special
11749 needs for some languages.
11750 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
11751 Collection (GCC) Internals},
11752 for more discussion of @file{libgcc.a}.)
11753 In most cases, you need @file{libgcc.a} even when you want to avoid
11754 other standard libraries.  In other words, when you specify @option{-nostdlib}
11755 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
11756 This ensures that you have no unresolved references to internal GCC
11757 library subroutines.
11758 (An example of such an internal subroutine is @code{__main}, used to ensure C++
11759 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
11760 GNU Compiler Collection (GCC) Internals}.)
11762 @item -pie
11763 @opindex pie
11764 Produce a position independent executable on targets that support it.
11765 For predictable results, you must also specify the same set of options
11766 used for compilation (@option{-fpie}, @option{-fPIE},
11767 or model suboptions) when you specify this linker option.
11769 @item -no-pie
11770 @opindex no-pie
11771 Don't produce a position independent executable.
11773 @item -pthread
11774 @opindex pthread
11775 Link with the POSIX threads library.  This option is supported on 
11776 GNU/Linux targets, most other Unix derivatives, and also on 
11777 x86 Cygwin and MinGW targets.  On some targets this option also sets 
11778 flags for the preprocessor, so it should be used consistently for both
11779 compilation and linking.
11781 @item -rdynamic
11782 @opindex rdynamic
11783 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
11784 that support it. This instructs the linker to add all symbols, not
11785 only used ones, to the dynamic symbol table. This option is needed
11786 for some uses of @code{dlopen} or to allow obtaining backtraces
11787 from within a program.
11789 @item -s
11790 @opindex s
11791 Remove all symbol table and relocation information from the executable.
11793 @item -static
11794 @opindex static
11795 On systems that support dynamic linking, this prevents linking with the shared
11796 libraries.  On other systems, this option has no effect.
11798 @item -shared
11799 @opindex shared
11800 Produce a shared object which can then be linked with other objects to
11801 form an executable.  Not all systems support this option.  For predictable
11802 results, you must also specify the same set of options used for compilation
11803 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
11804 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
11805 needs to build supplementary stub code for constructors to work.  On
11806 multi-libbed systems, @samp{gcc -shared} must select the correct support
11807 libraries to link against.  Failing to supply the correct flags may lead
11808 to subtle defects.  Supplying them in cases where they are not necessary
11809 is innocuous.}
11811 @item -shared-libgcc
11812 @itemx -static-libgcc
11813 @opindex shared-libgcc
11814 @opindex static-libgcc
11815 On systems that provide @file{libgcc} as a shared library, these options
11816 force the use of either the shared or static version, respectively.
11817 If no shared version of @file{libgcc} was built when the compiler was
11818 configured, these options have no effect.
11820 There are several situations in which an application should use the
11821 shared @file{libgcc} instead of the static version.  The most common
11822 of these is when the application wishes to throw and catch exceptions
11823 across different shared libraries.  In that case, each of the libraries
11824 as well as the application itself should use the shared @file{libgcc}.
11826 Therefore, the G++ and driver automatically adds @option{-shared-libgcc}
11827  whenever you build a shared library or a main executable, because C++
11828  programs typically use exceptions, so this is the right thing to do.
11830 If, instead, you use the GCC driver to create shared libraries, you may
11831 find that they are not always linked with the shared @file{libgcc}.
11832 If GCC finds, at its configuration time, that you have a non-GNU linker
11833 or a GNU linker that does not support option @option{--eh-frame-hdr},
11834 it links the shared version of @file{libgcc} into shared libraries
11835 by default.  Otherwise, it takes advantage of the linker and optimizes
11836 away the linking with the shared version of @file{libgcc}, linking with
11837 the static version of libgcc by default.  This allows exceptions to
11838 propagate through such shared libraries, without incurring relocation
11839 costs at library load time.
11841 However, if a library or main executable is supposed to throw or catch
11842 exceptions, you must link it using the G++ driver, as appropriate
11843 for the languages used in the program, or using the option
11844 @option{-shared-libgcc}, such that it is linked with the shared
11845 @file{libgcc}.
11847 @item -static-libasan
11848 @opindex static-libasan
11849 When the @option{-fsanitize=address} option is used to link a program,
11850 the GCC driver automatically links against @option{libasan}.  If
11851 @file{libasan} is available as a shared library, and the @option{-static}
11852 option is not used, then this links against the shared version of
11853 @file{libasan}.  The @option{-static-libasan} option directs the GCC
11854 driver to link @file{libasan} statically, without necessarily linking
11855 other libraries statically.
11857 @item -static-libtsan
11858 @opindex static-libtsan
11859 When the @option{-fsanitize=thread} option is used to link a program,
11860 the GCC driver automatically links against @option{libtsan}.  If
11861 @file{libtsan} is available as a shared library, and the @option{-static}
11862 option is not used, then this links against the shared version of
11863 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
11864 driver to link @file{libtsan} statically, without necessarily linking
11865 other libraries statically.
11867 @item -static-liblsan
11868 @opindex static-liblsan
11869 When the @option{-fsanitize=leak} option is used to link a program,
11870 the GCC driver automatically links against @option{liblsan}.  If
11871 @file{liblsan} is available as a shared library, and the @option{-static}
11872 option is not used, then this links against the shared version of
11873 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
11874 driver to link @file{liblsan} statically, without necessarily linking
11875 other libraries statically.
11877 @item -static-libubsan
11878 @opindex static-libubsan
11879 When the @option{-fsanitize=undefined} option is used to link a program,
11880 the GCC driver automatically links against @option{libubsan}.  If
11881 @file{libubsan} is available as a shared library, and the @option{-static}
11882 option is not used, then this links against the shared version of
11883 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
11884 driver to link @file{libubsan} statically, without necessarily linking
11885 other libraries statically.
11887 @item -static-libmpx
11888 @opindex static-libmpx
11889 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are
11890 used to link a program, the GCC driver automatically links against
11891 @file{libmpx}.  If @file{libmpx} is available as a shared library,
11892 and the @option{-static} option is not used, then this links against
11893 the shared version of @file{libmpx}.  The @option{-static-libmpx}
11894 option directs the GCC driver to link @file{libmpx} statically,
11895 without necessarily linking other libraries statically.
11897 @item -static-libmpxwrappers
11898 @opindex static-libmpxwrappers
11899 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are used
11900 to link a program without also using @option{-fno-chkp-use-wrappers}, the
11901 GCC driver automatically links against @file{libmpxwrappers}.  If
11902 @file{libmpxwrappers} is available as a shared library, and the
11903 @option{-static} option is not used, then this links against the shared
11904 version of @file{libmpxwrappers}.  The @option{-static-libmpxwrappers}
11905 option directs the GCC driver to link @file{libmpxwrappers} statically,
11906 without necessarily linking other libraries statically.
11908 @item -static-libstdc++
11909 @opindex static-libstdc++
11910 When the @command{g++} program is used to link a C++ program, it
11911 normally automatically links against @option{libstdc++}.  If
11912 @file{libstdc++} is available as a shared library, and the
11913 @option{-static} option is not used, then this links against the
11914 shared version of @file{libstdc++}.  That is normally fine.  However, it
11915 is sometimes useful to freeze the version of @file{libstdc++} used by
11916 the program without going all the way to a fully static link.  The
11917 @option{-static-libstdc++} option directs the @command{g++} driver to
11918 link @file{libstdc++} statically, without necessarily linking other
11919 libraries statically.
11921 @item -symbolic
11922 @opindex symbolic
11923 Bind references to global symbols when building a shared object.  Warn
11924 about any unresolved references (unless overridden by the link editor
11925 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
11926 this option.
11928 @item -T @var{script}
11929 @opindex T
11930 @cindex linker script
11931 Use @var{script} as the linker script.  This option is supported by most
11932 systems using the GNU linker.  On some targets, such as bare-board
11933 targets without an operating system, the @option{-T} option may be required
11934 when linking to avoid references to undefined symbols.
11936 @item -Xlinker @var{option}
11937 @opindex Xlinker
11938 Pass @var{option} as an option to the linker.  You can use this to
11939 supply system-specific linker options that GCC does not recognize.
11941 If you want to pass an option that takes a separate argument, you must use
11942 @option{-Xlinker} twice, once for the option and once for the argument.
11943 For example, to pass @option{-assert definitions}, you must write
11944 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
11945 @option{-Xlinker "-assert definitions"}, because this passes the entire
11946 string as a single argument, which is not what the linker expects.
11948 When using the GNU linker, it is usually more convenient to pass
11949 arguments to linker options using the @option{@var{option}=@var{value}}
11950 syntax than as separate arguments.  For example, you can specify
11951 @option{-Xlinker -Map=output.map} rather than
11952 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
11953 this syntax for command-line options.
11955 @item -Wl,@var{option}
11956 @opindex Wl
11957 Pass @var{option} as an option to the linker.  If @var{option} contains
11958 commas, it is split into multiple options at the commas.  You can use this
11959 syntax to pass an argument to the option.
11960 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
11961 linker.  When using the GNU linker, you can also get the same effect with
11962 @option{-Wl,-Map=output.map}.
11964 @item -u @var{symbol}
11965 @opindex u
11966 Pretend the symbol @var{symbol} is undefined, to force linking of
11967 library modules to define it.  You can use @option{-u} multiple times with
11968 different symbols to force loading of additional library modules.
11970 @item -z @var{keyword}
11971 @opindex z
11972 @option{-z} is passed directly on to the linker along with the keyword
11973 @var{keyword}. See the section in the documentation of your linker for
11974 permitted values and their meanings.
11975 @end table
11977 @node Directory Options
11978 @section Options for Directory Search
11979 @cindex directory options
11980 @cindex options, directory search
11981 @cindex search path
11983 These options specify directories to search for header files, for
11984 libraries and for parts of the compiler:
11986 @table @gcctabopt
11987 @include cppdiropts.texi
11989 @item -iplugindir=@var{dir}
11990 @opindex iplugindir=
11991 Set the directory to search for plugins that are passed
11992 by @option{-fplugin=@var{name}} instead of
11993 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
11994 to be used by the user, but only passed by the driver.
11996 @item -L@var{dir}
11997 @opindex L
11998 Add directory @var{dir} to the list of directories to be searched
11999 for @option{-l}.
12001 @item -B@var{prefix}
12002 @opindex B
12003 This option specifies where to find the executables, libraries,
12004 include files, and data files of the compiler itself.
12006 The compiler driver program runs one or more of the subprograms
12007 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
12008 @var{prefix} as a prefix for each program it tries to run, both with and
12009 without @samp{@var{machine}/@var{version}/} for the corresponding target
12010 machine and compiler version.
12012 For each subprogram to be run, the compiler driver first tries the
12013 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
12014 is not specified, the driver tries two standard prefixes, 
12015 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
12016 those results in a file name that is found, the unmodified program
12017 name is searched for using the directories specified in your
12018 @env{PATH} environment variable.
12020 The compiler checks to see if the path provided by @option{-B}
12021 refers to a directory, and if necessary it adds a directory
12022 separator character at the end of the path.
12024 @option{-B} prefixes that effectively specify directory names also apply
12025 to libraries in the linker, because the compiler translates these
12026 options into @option{-L} options for the linker.  They also apply to
12027 include files in the preprocessor, because the compiler translates these
12028 options into @option{-isystem} options for the preprocessor.  In this case,
12029 the compiler appends @samp{include} to the prefix.
12031 The runtime support file @file{libgcc.a} can also be searched for using
12032 the @option{-B} prefix, if needed.  If it is not found there, the two
12033 standard prefixes above are tried, and that is all.  The file is left
12034 out of the link if it is not found by those means.
12036 Another way to specify a prefix much like the @option{-B} prefix is to use
12037 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
12038 Variables}.
12040 As a special kludge, if the path provided by @option{-B} is
12041 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
12042 9, then it is replaced by @file{[dir/]include}.  This is to help
12043 with boot-strapping the compiler.
12045 @item -no-canonical-prefixes
12046 @opindex no-canonical-prefixes
12047 Do not expand any symbolic links, resolve references to @samp{/../}
12048 or @samp{/./}, or make the path absolute when generating a relative
12049 prefix.
12051 @item --sysroot=@var{dir}
12052 @opindex sysroot
12053 Use @var{dir} as the logical root directory for headers and libraries.
12054 For example, if the compiler normally searches for headers in
12055 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
12056 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
12058 If you use both this option and the @option{-isysroot} option, then
12059 the @option{--sysroot} option applies to libraries, but the
12060 @option{-isysroot} option applies to header files.
12062 The GNU linker (beginning with version 2.16) has the necessary support
12063 for this option.  If your linker does not support this option, the
12064 header file aspect of @option{--sysroot} still works, but the
12065 library aspect does not.
12067 @item --no-sysroot-suffix
12068 @opindex no-sysroot-suffix
12069 For some targets, a suffix is added to the root directory specified
12070 with @option{--sysroot}, depending on the other options used, so that
12071 headers may for example be found in
12072 @file{@var{dir}/@var{suffix}/usr/include} instead of
12073 @file{@var{dir}/usr/include}.  This option disables the addition of
12074 such a suffix.
12076 @end table
12078 @node Code Gen Options
12079 @section Options for Code Generation Conventions
12080 @cindex code generation conventions
12081 @cindex options, code generation
12082 @cindex run-time options
12084 These machine-independent options control the interface conventions
12085 used in code generation.
12087 Most of them have both positive and negative forms; the negative form
12088 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
12089 one of the forms is listed---the one that is not the default.  You
12090 can figure out the other form by either removing @samp{no-} or adding
12093 @table @gcctabopt
12094 @item -fstack-reuse=@var{reuse-level}
12095 @opindex fstack_reuse
12096 This option controls stack space reuse for user declared local/auto variables
12097 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
12098 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
12099 local variables and temporaries, @samp{named_vars} enables the reuse only for
12100 user defined local variables with names, and @samp{none} disables stack reuse
12101 completely. The default value is @samp{all}. The option is needed when the
12102 program extends the lifetime of a scoped local variable or a compiler generated
12103 temporary beyond the end point defined by the language.  When a lifetime of
12104 a variable ends, and if the variable lives in memory, the optimizing compiler
12105 has the freedom to reuse its stack space with other temporaries or scoped
12106 local variables whose live range does not overlap with it. Legacy code extending
12107 local lifetime is likely to break with the stack reuse optimization.
12109 For example,
12111 @smallexample
12112    int *p;
12113    @{
12114      int local1;
12116      p = &local1;
12117      local1 = 10;
12118      ....
12119    @}
12120    @{
12121       int local2;
12122       local2 = 20;
12123       ...
12124    @}
12126    if (*p == 10)  // out of scope use of local1
12127      @{
12129      @}
12130 @end smallexample
12132 Another example:
12133 @smallexample
12135    struct A
12136    @{
12137        A(int k) : i(k), j(k) @{ @}
12138        int i;
12139        int j;
12140    @};
12142    A *ap;
12144    void foo(const A& ar)
12145    @{
12146       ap = &ar;
12147    @}
12149    void bar()
12150    @{
12151       foo(A(10)); // temp object's lifetime ends when foo returns
12153       @{
12154         A a(20);
12155         ....
12156       @}
12157       ap->i+= 10;  // ap references out of scope temp whose space
12158                    // is reused with a. What is the value of ap->i?
12159    @}
12161 @end smallexample
12163 The lifetime of a compiler generated temporary is well defined by the C++
12164 standard. When a lifetime of a temporary ends, and if the temporary lives
12165 in memory, the optimizing compiler has the freedom to reuse its stack
12166 space with other temporaries or scoped local variables whose live range
12167 does not overlap with it. However some of the legacy code relies on
12168 the behavior of older compilers in which temporaries' stack space is
12169 not reused, the aggressive stack reuse can lead to runtime errors. This
12170 option is used to control the temporary stack reuse optimization.
12172 @item -ftrapv
12173 @opindex ftrapv
12174 This option generates traps for signed overflow on addition, subtraction,
12175 multiplication operations.
12176 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12177 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12178 @option{-fwrapv} being effective.  Note that only active options override, so
12179 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12180 results in @option{-ftrapv} being effective.
12182 @item -fwrapv
12183 @opindex fwrapv
12184 This option instructs the compiler to assume that signed arithmetic
12185 overflow of addition, subtraction and multiplication wraps around
12186 using twos-complement representation.  This flag enables some optimizations
12187 and disables others.
12188 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12189 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12190 @option{-fwrapv} being effective.  Note that only active options override, so
12191 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12192 results in @option{-ftrapv} being effective.
12194 @item -fexceptions
12195 @opindex fexceptions
12196 Enable exception handling.  Generates extra code needed to propagate
12197 exceptions.  For some targets, this implies GCC generates frame
12198 unwind information for all functions, which can produce significant data
12199 size overhead, although it does not affect execution.  If you do not
12200 specify this option, GCC enables it by default for languages like
12201 C++ that normally require exception handling, and disables it for
12202 languages like C that do not normally require it.  However, you may need
12203 to enable this option when compiling C code that needs to interoperate
12204 properly with exception handlers written in C++.  You may also wish to
12205 disable this option if you are compiling older C++ programs that don't
12206 use exception handling.
12208 @item -fnon-call-exceptions
12209 @opindex fnon-call-exceptions
12210 Generate code that allows trapping instructions to throw exceptions.
12211 Note that this requires platform-specific runtime support that does
12212 not exist everywhere.  Moreover, it only allows @emph{trapping}
12213 instructions to throw exceptions, i.e.@: memory references or floating-point
12214 instructions.  It does not allow exceptions to be thrown from
12215 arbitrary signal handlers such as @code{SIGALRM}.
12217 @item -fdelete-dead-exceptions
12218 @opindex fdelete-dead-exceptions
12219 Consider that instructions that may throw exceptions but don't otherwise
12220 contribute to the execution of the program can be optimized away.
12221 This option is enabled by default for the Ada front end, as permitted by
12222 the Ada language specification.
12223 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
12225 @item -funwind-tables
12226 @opindex funwind-tables
12227 Similar to @option{-fexceptions}, except that it just generates any needed
12228 static data, but does not affect the generated code in any other way.
12229 You normally do not need to enable this option; instead, a language processor
12230 that needs this handling enables it on your behalf.
12232 @item -fasynchronous-unwind-tables
12233 @opindex fasynchronous-unwind-tables
12234 Generate unwind table in DWARF format, if supported by target machine.  The
12235 table is exact at each instruction boundary, so it can be used for stack
12236 unwinding from asynchronous events (such as debugger or garbage collector).
12238 @item -fno-gnu-unique
12239 @opindex fno-gnu-unique
12240 On systems with recent GNU assembler and C library, the C++ compiler
12241 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
12242 of template static data members and static local variables in inline
12243 functions are unique even in the presence of @code{RTLD_LOCAL}; this
12244 is necessary to avoid problems with a library used by two different
12245 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
12246 therefore disagreeing with the other one about the binding of the
12247 symbol.  But this causes @code{dlclose} to be ignored for affected
12248 DSOs; if your program relies on reinitialization of a DSO via
12249 @code{dlclose} and @code{dlopen}, you can use
12250 @option{-fno-gnu-unique}.
12252 @item -fpcc-struct-return
12253 @opindex fpcc-struct-return
12254 Return ``short'' @code{struct} and @code{union} values in memory like
12255 longer ones, rather than in registers.  This convention is less
12256 efficient, but it has the advantage of allowing intercallability between
12257 GCC-compiled files and files compiled with other compilers, particularly
12258 the Portable C Compiler (pcc).
12260 The precise convention for returning structures in memory depends
12261 on the target configuration macros.
12263 Short structures and unions are those whose size and alignment match
12264 that of some integer type.
12266 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12267 switch is not binary compatible with code compiled with the
12268 @option{-freg-struct-return} switch.
12269 Use it to conform to a non-default application binary interface.
12271 @item -freg-struct-return
12272 @opindex freg-struct-return
12273 Return @code{struct} and @code{union} values in registers when possible.
12274 This is more efficient for small structures than
12275 @option{-fpcc-struct-return}.
12277 If you specify neither @option{-fpcc-struct-return} nor
12278 @option{-freg-struct-return}, GCC defaults to whichever convention is
12279 standard for the target.  If there is no standard convention, GCC
12280 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12281 the principal compiler.  In those cases, we can choose the standard, and
12282 we chose the more efficient register return alternative.
12284 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12285 switch is not binary compatible with code compiled with the
12286 @option{-fpcc-struct-return} switch.
12287 Use it to conform to a non-default application binary interface.
12289 @item -fshort-enums
12290 @opindex fshort-enums
12291 Allocate to an @code{enum} type only as many bytes as it needs for the
12292 declared range of possible values.  Specifically, the @code{enum} type
12293 is equivalent to the smallest integer type that has enough room.
12295 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12296 code that is not binary compatible with code generated without that switch.
12297 Use it to conform to a non-default application binary interface.
12299 @item -fshort-wchar
12300 @opindex fshort-wchar
12301 Override the underlying type for @code{wchar_t} to be @code{short
12302 unsigned int} instead of the default for the target.  This option is
12303 useful for building programs to run under WINE@.
12305 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12306 code that is not binary compatible with code generated without that switch.
12307 Use it to conform to a non-default application binary interface.
12309 @item -fno-common
12310 @opindex fno-common
12311 @cindex tentative definitions
12312 In C code, this option controls the placement of global variables 
12313 defined without an initializer, known as @dfn{tentative definitions} 
12314 in the C standard.  Tentative definitions are distinct from declarations 
12315 of a variable with the @code{extern} keyword, which do not allocate storage.
12317 Unix C compilers have traditionally allocated storage for
12318 uninitialized global variables in a common block.  This allows the
12319 linker to resolve all tentative definitions of the same variable
12320 in different compilation units to the same object, or to a non-tentative
12321 definition.  
12322 This is the behavior specified by @option{-fcommon}, and is the default for 
12323 GCC on most targets.  
12324 On the other hand, this behavior is not required by ISO
12325 C, and on some targets may carry a speed or code size penalty on
12326 variable references.
12328 The @option{-fno-common} option specifies that the compiler should instead
12329 place uninitialized global variables in the data section of the object file.
12330 This inhibits the merging of tentative definitions by the linker so
12331 you get a multiple-definition error if the same 
12332 variable is defined in more than one compilation unit.
12333 Compiling with @option{-fno-common} is useful on targets for which
12334 it provides better performance, or if you wish to verify that the
12335 program will work on other systems that always treat uninitialized
12336 variable definitions this way.
12338 @item -fno-ident
12339 @opindex fno-ident
12340 Ignore the @code{#ident} directive.
12342 @item -finhibit-size-directive
12343 @opindex finhibit-size-directive
12344 Don't output a @code{.size} assembler directive, or anything else that
12345 would cause trouble if the function is split in the middle, and the
12346 two halves are placed at locations far apart in memory.  This option is
12347 used when compiling @file{crtstuff.c}; you should not need to use it
12348 for anything else.
12350 @item -fverbose-asm
12351 @opindex fverbose-asm
12352 Put extra commentary information in the generated assembly code to
12353 make it more readable.  This option is generally only of use to those
12354 who actually need to read the generated assembly code (perhaps while
12355 debugging the compiler itself).
12357 @option{-fno-verbose-asm}, the default, causes the
12358 extra information to be omitted and is useful when comparing two assembler
12359 files.
12361 The added comments include:
12363 @itemize @bullet
12365 @item
12366 information on the compiler version and command-line options,
12368 @item
12369 the source code lines associated with the assembly instructions,
12370 in the form FILENAME:LINENUMBER:CONTENT OF LINE,
12372 @item
12373 hints on which high-level expressions correspond to
12374 the various assembly instruction operands.
12376 @end itemize
12378 For example, given this C source file:
12380 @smallexample
12381 int test (int n)
12383   int i;
12384   int total = 0;
12386   for (i = 0; i < n; i++)
12387     total += i * i;
12389   return total;
12391 @end smallexample
12393 compiling to (x86_64) assembly via @option{-S} and emitting the result
12394 direct to stdout via @option{-o} @option{-}
12396 @smallexample
12397 gcc -S test.c -fverbose-asm -Os -o -
12398 @end smallexample
12400 gives output similar to this:
12402 @smallexample
12403         .file   "test.c"
12404 # GNU C11 (GCC) version 7.0.0 20160809 (experimental) (x86_64-pc-linux-gnu)
12405   [...snip...]
12406 # options passed:
12407   [...snip...]
12409         .text
12410         .globl  test
12411         .type   test, @@function
12412 test:
12413 .LFB0:
12414         .cfi_startproc
12415 # test.c:4:   int total = 0;
12416         xorl    %eax, %eax      # <retval>
12417 # test.c:6:   for (i = 0; i < n; i++)
12418         xorl    %edx, %edx      # i
12419 .L2:
12420 # test.c:6:   for (i = 0; i < n; i++)
12421         cmpl    %edi, %edx      # n, i
12422         jge     .L5     #,
12423 # test.c:7:     total += i * i;
12424         movl    %edx, %ecx      # i, tmp92
12425         imull   %edx, %ecx      # i, tmp92
12426 # test.c:6:   for (i = 0; i < n; i++)
12427         incl    %edx    # i
12428 # test.c:7:     total += i * i;
12429         addl    %ecx, %eax      # tmp92, <retval>
12430         jmp     .L2     #
12431 .L5:
12432 # test.c:10: @}
12433         ret
12434         .cfi_endproc
12435 .LFE0:
12436         .size   test, .-test
12437         .ident  "GCC: (GNU) 7.0.0 20160809 (experimental)"
12438         .section        .note.GNU-stack,"",@@progbits
12439 @end smallexample
12441 The comments are intended for humans rather than machines and hence the
12442 precise format of the comments is subject to change.
12444 @item -frecord-gcc-switches
12445 @opindex frecord-gcc-switches
12446 This switch causes the command line used to invoke the
12447 compiler to be recorded into the object file that is being created.
12448 This switch is only implemented on some targets and the exact format
12449 of the recording is target and binary file format dependent, but it
12450 usually takes the form of a section containing ASCII text.  This
12451 switch is related to the @option{-fverbose-asm} switch, but that
12452 switch only records information in the assembler output file as
12453 comments, so it never reaches the object file.
12454 See also @option{-grecord-gcc-switches} for another
12455 way of storing compiler options into the object file.
12457 @item -fpic
12458 @opindex fpic
12459 @cindex global offset table
12460 @cindex PIC
12461 Generate position-independent code (PIC) suitable for use in a shared
12462 library, if supported for the target machine.  Such code accesses all
12463 constant addresses through a global offset table (GOT)@.  The dynamic
12464 loader resolves the GOT entries when the program starts (the dynamic
12465 loader is not part of GCC; it is part of the operating system).  If
12466 the GOT size for the linked executable exceeds a machine-specific
12467 maximum size, you get an error message from the linker indicating that
12468 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
12469 instead.  (These maximums are 8k on the SPARC, 28k on AArch64 and 32k
12470 on the m68k and RS/6000.  The x86 has no such limit.)
12472 Position-independent code requires special support, and therefore works
12473 only on certain machines.  For the x86, GCC supports PIC for System V
12474 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
12475 position-independent.
12477 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12478 are defined to 1.
12480 @item -fPIC
12481 @opindex fPIC
12482 If supported for the target machine, emit position-independent code,
12483 suitable for dynamic linking and avoiding any limit on the size of the
12484 global offset table.  This option makes a difference on AArch64, m68k,
12485 PowerPC and SPARC@.
12487 Position-independent code requires special support, and therefore works
12488 only on certain machines.
12490 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12491 are defined to 2.
12493 @item -fpie
12494 @itemx -fPIE
12495 @opindex fpie
12496 @opindex fPIE
12497 These options are similar to @option{-fpic} and @option{-fPIC}, but
12498 generated position independent code can be only linked into executables.
12499 Usually these options are used when @option{-pie} GCC option is
12500 used during linking.
12502 @option{-fpie} and @option{-fPIE} both define the macros
12503 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
12504 for @option{-fpie} and 2 for @option{-fPIE}.
12506 @item -fno-plt
12507 @opindex fno-plt
12508 Do not use the PLT for external function calls in position-independent code.
12509 Instead, load the callee address at call sites from the GOT and branch to it.
12510 This leads to more efficient code by eliminating PLT stubs and exposing
12511 GOT loads to optimizations.  On architectures such as 32-bit x86 where
12512 PLT stubs expect the GOT pointer in a specific register, this gives more
12513 register allocation freedom to the compiler.
12514 Lazy binding requires use of the PLT; 
12515 with @option{-fno-plt} all external symbols are resolved at load time.
12517 Alternatively, the function attribute @code{noplt} can be used to avoid calls
12518 through the PLT for specific external functions.
12520 In position-dependent code, a few targets also convert calls to
12521 functions that are marked to not use the PLT to use the GOT instead.
12523 @item -fno-jump-tables
12524 @opindex fno-jump-tables
12525 Do not use jump tables for switch statements even where it would be
12526 more efficient than other code generation strategies.  This option is
12527 of use in conjunction with @option{-fpic} or @option{-fPIC} for
12528 building code that forms part of a dynamic linker and cannot
12529 reference the address of a jump table.  On some targets, jump tables
12530 do not require a GOT and this option is not needed.
12532 @item -ffixed-@var{reg}
12533 @opindex ffixed
12534 Treat the register named @var{reg} as a fixed register; generated code
12535 should never refer to it (except perhaps as a stack pointer, frame
12536 pointer or in some other fixed role).
12538 @var{reg} must be the name of a register.  The register names accepted
12539 are machine-specific and are defined in the @code{REGISTER_NAMES}
12540 macro in the machine description macro file.
12542 This flag does not have a negative form, because it specifies a
12543 three-way choice.
12545 @item -fcall-used-@var{reg}
12546 @opindex fcall-used
12547 Treat the register named @var{reg} as an allocable register that is
12548 clobbered by function calls.  It may be allocated for temporaries or
12549 variables that do not live across a call.  Functions compiled this way
12550 do not save and restore the register @var{reg}.
12552 It is an error to use this flag with the frame pointer or stack pointer.
12553 Use of this flag for other registers that have fixed pervasive roles in
12554 the machine's execution model produces disastrous results.
12556 This flag does not have a negative form, because it specifies a
12557 three-way choice.
12559 @item -fcall-saved-@var{reg}
12560 @opindex fcall-saved
12561 Treat the register named @var{reg} as an allocable register saved by
12562 functions.  It may be allocated even for temporaries or variables that
12563 live across a call.  Functions compiled this way save and restore
12564 the register @var{reg} if they use it.
12566 It is an error to use this flag with the frame pointer or stack pointer.
12567 Use of this flag for other registers that have fixed pervasive roles in
12568 the machine's execution model produces disastrous results.
12570 A different sort of disaster results from the use of this flag for
12571 a register in which function values may be returned.
12573 This flag does not have a negative form, because it specifies a
12574 three-way choice.
12576 @item -fpack-struct[=@var{n}]
12577 @opindex fpack-struct
12578 Without a value specified, pack all structure members together without
12579 holes.  When a value is specified (which must be a small power of two), pack
12580 structure members according to this value, representing the maximum
12581 alignment (that is, objects with default alignment requirements larger than
12582 this are output potentially unaligned at the next fitting location.
12584 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
12585 code that is not binary compatible with code generated without that switch.
12586 Additionally, it makes the code suboptimal.
12587 Use it to conform to a non-default application binary interface.
12589 @item -fleading-underscore
12590 @opindex fleading-underscore
12591 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
12592 change the way C symbols are represented in the object file.  One use
12593 is to help link with legacy assembly code.
12595 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
12596 generate code that is not binary compatible with code generated without that
12597 switch.  Use it to conform to a non-default application binary interface.
12598 Not all targets provide complete support for this switch.
12600 @item -ftls-model=@var{model}
12601 @opindex ftls-model
12602 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
12603 The @var{model} argument should be one of @samp{global-dynamic},
12604 @samp{local-dynamic}, @samp{initial-exec} or @samp{local-exec}.
12605 Note that the choice is subject to optimization: the compiler may use
12606 a more efficient model for symbols not visible outside of the translation
12607 unit, or if @option{-fpic} is not given on the command line.
12609 The default without @option{-fpic} is @samp{initial-exec}; with
12610 @option{-fpic} the default is @samp{global-dynamic}.
12612 @item -ftrampolines
12613 @opindex ftrampolines
12614 For targets that normally need trampolines for nested functions, always
12615 generate them instead of using descriptors.  Otherwise, for targets that
12616 do not need them, like for example HP-PA or IA-64, do nothing.
12618 A trampoline is a small piece of code that is created at run time on the
12619 stack when the address of a nested function is taken, and is used to call
12620 the nested function indirectly.  Therefore, it requires the stack to be
12621 made executable in order for the program to work properly.
12623 @option{-fno-trampolines} is enabled by default on a language by language
12624 basis to let the compiler avoid generating them, if it computes that this
12625 is safe, and replace them with descriptors.  Descriptors are made up of data
12626 only, but the generated code must be prepared to deal with them.  As of this
12627 writing, @option{-fno-trampolines} is enabled by default only for Ada.
12629 Moreover, code compiled with @option{-ftrampolines} and code compiled with
12630 @option{-fno-trampolines} are not binary compatible if nested functions are
12631 present.  This option must therefore be used on a program-wide basis and be
12632 manipulated with extreme care.
12634 @item -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]}
12635 @opindex fvisibility
12636 Set the default ELF image symbol visibility to the specified option---all
12637 symbols are marked with this unless overridden within the code.
12638 Using this feature can very substantially improve linking and
12639 load times of shared object libraries, produce more optimized
12640 code, provide near-perfect API export and prevent symbol clashes.
12641 It is @strong{strongly} recommended that you use this in any shared objects
12642 you distribute.
12644 Despite the nomenclature, @samp{default} always means public; i.e.,
12645 available to be linked against from outside the shared object.
12646 @samp{protected} and @samp{internal} are pretty useless in real-world
12647 usage so the only other commonly used option is @samp{hidden}.
12648 The default if @option{-fvisibility} isn't specified is
12649 @samp{default}, i.e., make every symbol public.
12651 A good explanation of the benefits offered by ensuring ELF
12652 symbols have the correct visibility is given by ``How To Write
12653 Shared Libraries'' by Ulrich Drepper (which can be found at
12654 @w{@uref{https://www.akkadia.org/drepper/}})---however a superior
12655 solution made possible by this option to marking things hidden when
12656 the default is public is to make the default hidden and mark things
12657 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
12658 and @code{__attribute__ ((visibility("default")))} instead of
12659 @code{__declspec(dllexport)} you get almost identical semantics with
12660 identical syntax.  This is a great boon to those working with
12661 cross-platform projects.
12663 For those adding visibility support to existing code, you may find
12664 @code{#pragma GCC visibility} of use.  This works by you enclosing
12665 the declarations you wish to set visibility for with (for example)
12666 @code{#pragma GCC visibility push(hidden)} and
12667 @code{#pragma GCC visibility pop}.
12668 Bear in mind that symbol visibility should be viewed @strong{as
12669 part of the API interface contract} and thus all new code should
12670 always specify visibility when it is not the default; i.e., declarations
12671 only for use within the local DSO should @strong{always} be marked explicitly
12672 as hidden as so to avoid PLT indirection overheads---making this
12673 abundantly clear also aids readability and self-documentation of the code.
12674 Note that due to ISO C++ specification requirements, @code{operator new} and
12675 @code{operator delete} must always be of default visibility.
12677 Be aware that headers from outside your project, in particular system
12678 headers and headers from any other library you use, may not be
12679 expecting to be compiled with visibility other than the default.  You
12680 may need to explicitly say @code{#pragma GCC visibility push(default)}
12681 before including any such headers.
12683 @code{extern} declarations are not affected by @option{-fvisibility}, so
12684 a lot of code can be recompiled with @option{-fvisibility=hidden} with
12685 no modifications.  However, this means that calls to @code{extern}
12686 functions with no explicit visibility use the PLT, so it is more
12687 effective to use @code{__attribute ((visibility))} and/or
12688 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
12689 declarations should be treated as hidden.
12691 Note that @option{-fvisibility} does affect C++ vague linkage
12692 entities. This means that, for instance, an exception class that is
12693 be thrown between DSOs must be explicitly marked with default
12694 visibility so that the @samp{type_info} nodes are unified between
12695 the DSOs.
12697 An overview of these techniques, their benefits and how to use them
12698 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
12700 @item -fstrict-volatile-bitfields
12701 @opindex fstrict-volatile-bitfields
12702 This option should be used if accesses to volatile bit-fields (or other
12703 structure fields, although the compiler usually honors those types
12704 anyway) should use a single access of the width of the
12705 field's type, aligned to a natural alignment if possible.  For
12706 example, targets with memory-mapped peripheral registers might require
12707 all such accesses to be 16 bits wide; with this flag you can
12708 declare all peripheral bit-fields as @code{unsigned short} (assuming short
12709 is 16 bits on these targets) to force GCC to use 16-bit accesses
12710 instead of, perhaps, a more efficient 32-bit access.
12712 If this option is disabled, the compiler uses the most efficient
12713 instruction.  In the previous example, that might be a 32-bit load
12714 instruction, even though that accesses bytes that do not contain
12715 any portion of the bit-field, or memory-mapped registers unrelated to
12716 the one being updated.
12718 In some cases, such as when the @code{packed} attribute is applied to a 
12719 structure field, it may not be possible to access the field with a single
12720 read or write that is correctly aligned for the target machine.  In this
12721 case GCC falls back to generating multiple accesses rather than code that 
12722 will fault or truncate the result at run time.
12724 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
12725 not allowed to touch non bit-field members.  It is therefore recommended
12726 to define all bits of the field's type as bit-field members.
12728 The default value of this option is determined by the application binary
12729 interface for the target processor.
12731 @item -fsync-libcalls
12732 @opindex fsync-libcalls
12733 This option controls whether any out-of-line instance of the @code{__sync}
12734 family of functions may be used to implement the C++11 @code{__atomic}
12735 family of functions.
12737 The default value of this option is enabled, thus the only useful form
12738 of the option is @option{-fno-sync-libcalls}.  This option is used in
12739 the implementation of the @file{libatomic} runtime library.
12741 @end table
12743 @node Developer Options
12744 @section GCC Developer Options
12745 @cindex developer options
12746 @cindex debugging GCC
12747 @cindex debug dump options
12748 @cindex dump options
12749 @cindex compilation statistics
12751 This section describes command-line options that are primarily of
12752 interest to GCC developers, including options to support compiler
12753 testing and investigation of compiler bugs and compile-time
12754 performance problems.  This includes options that produce debug dumps
12755 at various points in the compilation; that print statistics such as
12756 memory use and execution time; and that print information about GCC's
12757 configuration, such as where it searches for libraries.  You should
12758 rarely need to use any of these options for ordinary compilation and
12759 linking tasks.
12761 @table @gcctabopt
12763 @item -d@var{letters}
12764 @itemx -fdump-rtl-@var{pass}
12765 @itemx -fdump-rtl-@var{pass}=@var{filename}
12766 @opindex d
12767 @opindex fdump-rtl-@var{pass}
12768 Says to make debugging dumps during compilation at times specified by
12769 @var{letters}.  This is used for debugging the RTL-based passes of the
12770 compiler.  The file names for most of the dumps are made by appending
12771 a pass number and a word to the @var{dumpname}, and the files are
12772 created in the directory of the output file.  In case of
12773 @option{=@var{filename}} option, the dump is output on the given file
12774 instead of the pass numbered dump files.  Note that the pass number is
12775 assigned as passes are registered into the pass manager.  Most passes
12776 are registered in the order that they will execute and for these passes
12777 the number corresponds to the pass execution order.  However, passes
12778 registered by plugins, passes specific to compilation targets, or
12779 passes that are otherwise registered after all the other passes are
12780 numbered higher than a pass named "final", even if they are executed
12781 earlier.  @var{dumpname} is generated from the name of the output
12782 file if explicitly specified and not an executable, otherwise it is
12783 the basename of the source file.  
12785 Some @option{-d@var{letters}} switches have different meaning when
12786 @option{-E} is used for preprocessing.  @xref{Preprocessor Options},
12787 for information about preprocessor-specific dump options.
12789 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
12790 @option{-d} option @var{letters}.  Here are the possible
12791 letters for use in @var{pass} and @var{letters}, and their meanings:
12793 @table @gcctabopt
12795 @item -fdump-rtl-alignments
12796 @opindex fdump-rtl-alignments
12797 Dump after branch alignments have been computed.
12799 @item -fdump-rtl-asmcons
12800 @opindex fdump-rtl-asmcons
12801 Dump after fixing rtl statements that have unsatisfied in/out constraints.
12803 @item -fdump-rtl-auto_inc_dec
12804 @opindex fdump-rtl-auto_inc_dec
12805 Dump after auto-inc-dec discovery.  This pass is only run on
12806 architectures that have auto inc or auto dec instructions.
12808 @item -fdump-rtl-barriers
12809 @opindex fdump-rtl-barriers
12810 Dump after cleaning up the barrier instructions.
12812 @item -fdump-rtl-bbpart
12813 @opindex fdump-rtl-bbpart
12814 Dump after partitioning hot and cold basic blocks.
12816 @item -fdump-rtl-bbro
12817 @opindex fdump-rtl-bbro
12818 Dump after block reordering.
12820 @item -fdump-rtl-btl1
12821 @itemx -fdump-rtl-btl2
12822 @opindex fdump-rtl-btl2
12823 @opindex fdump-rtl-btl2
12824 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
12825 after the two branch
12826 target load optimization passes.
12828 @item -fdump-rtl-bypass
12829 @opindex fdump-rtl-bypass
12830 Dump after jump bypassing and control flow optimizations.
12832 @item -fdump-rtl-combine
12833 @opindex fdump-rtl-combine
12834 Dump after the RTL instruction combination pass.
12836 @item -fdump-rtl-compgotos
12837 @opindex fdump-rtl-compgotos
12838 Dump after duplicating the computed gotos.
12840 @item -fdump-rtl-ce1
12841 @itemx -fdump-rtl-ce2
12842 @itemx -fdump-rtl-ce3
12843 @opindex fdump-rtl-ce1
12844 @opindex fdump-rtl-ce2
12845 @opindex fdump-rtl-ce3
12846 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
12847 @option{-fdump-rtl-ce3} enable dumping after the three
12848 if conversion passes.
12850 @item -fdump-rtl-cprop_hardreg
12851 @opindex fdump-rtl-cprop_hardreg
12852 Dump after hard register copy propagation.
12854 @item -fdump-rtl-csa
12855 @opindex fdump-rtl-csa
12856 Dump after combining stack adjustments.
12858 @item -fdump-rtl-cse1
12859 @itemx -fdump-rtl-cse2
12860 @opindex fdump-rtl-cse1
12861 @opindex fdump-rtl-cse2
12862 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
12863 the two common subexpression elimination passes.
12865 @item -fdump-rtl-dce
12866 @opindex fdump-rtl-dce
12867 Dump after the standalone dead code elimination passes.
12869 @item -fdump-rtl-dbr
12870 @opindex fdump-rtl-dbr
12871 Dump after delayed branch scheduling.
12873 @item -fdump-rtl-dce1
12874 @itemx -fdump-rtl-dce2
12875 @opindex fdump-rtl-dce1
12876 @opindex fdump-rtl-dce2
12877 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
12878 the two dead store elimination passes.
12880 @item -fdump-rtl-eh
12881 @opindex fdump-rtl-eh
12882 Dump after finalization of EH handling code.
12884 @item -fdump-rtl-eh_ranges
12885 @opindex fdump-rtl-eh_ranges
12886 Dump after conversion of EH handling range regions.
12888 @item -fdump-rtl-expand
12889 @opindex fdump-rtl-expand
12890 Dump after RTL generation.
12892 @item -fdump-rtl-fwprop1
12893 @itemx -fdump-rtl-fwprop2
12894 @opindex fdump-rtl-fwprop1
12895 @opindex fdump-rtl-fwprop2
12896 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
12897 dumping after the two forward propagation passes.
12899 @item -fdump-rtl-gcse1
12900 @itemx -fdump-rtl-gcse2
12901 @opindex fdump-rtl-gcse1
12902 @opindex fdump-rtl-gcse2
12903 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
12904 after global common subexpression elimination.
12906 @item -fdump-rtl-init-regs
12907 @opindex fdump-rtl-init-regs
12908 Dump after the initialization of the registers.
12910 @item -fdump-rtl-initvals
12911 @opindex fdump-rtl-initvals
12912 Dump after the computation of the initial value sets.
12914 @item -fdump-rtl-into_cfglayout
12915 @opindex fdump-rtl-into_cfglayout
12916 Dump after converting to cfglayout mode.
12918 @item -fdump-rtl-ira
12919 @opindex fdump-rtl-ira
12920 Dump after iterated register allocation.
12922 @item -fdump-rtl-jump
12923 @opindex fdump-rtl-jump
12924 Dump after the second jump optimization.
12926 @item -fdump-rtl-loop2
12927 @opindex fdump-rtl-loop2
12928 @option{-fdump-rtl-loop2} enables dumping after the rtl
12929 loop optimization passes.
12931 @item -fdump-rtl-mach
12932 @opindex fdump-rtl-mach
12933 Dump after performing the machine dependent reorganization pass, if that
12934 pass exists.
12936 @item -fdump-rtl-mode_sw
12937 @opindex fdump-rtl-mode_sw
12938 Dump after removing redundant mode switches.
12940 @item -fdump-rtl-rnreg
12941 @opindex fdump-rtl-rnreg
12942 Dump after register renumbering.
12944 @item -fdump-rtl-outof_cfglayout
12945 @opindex fdump-rtl-outof_cfglayout
12946 Dump after converting from cfglayout mode.
12948 @item -fdump-rtl-peephole2
12949 @opindex fdump-rtl-peephole2
12950 Dump after the peephole pass.
12952 @item -fdump-rtl-postreload
12953 @opindex fdump-rtl-postreload
12954 Dump after post-reload optimizations.
12956 @item -fdump-rtl-pro_and_epilogue
12957 @opindex fdump-rtl-pro_and_epilogue
12958 Dump after generating the function prologues and epilogues.
12960 @item -fdump-rtl-sched1
12961 @itemx -fdump-rtl-sched2
12962 @opindex fdump-rtl-sched1
12963 @opindex fdump-rtl-sched2
12964 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
12965 after the basic block scheduling passes.
12967 @item -fdump-rtl-ree
12968 @opindex fdump-rtl-ree
12969 Dump after sign/zero extension elimination.
12971 @item -fdump-rtl-seqabstr
12972 @opindex fdump-rtl-seqabstr
12973 Dump after common sequence discovery.
12975 @item -fdump-rtl-shorten
12976 @opindex fdump-rtl-shorten
12977 Dump after shortening branches.
12979 @item -fdump-rtl-sibling
12980 @opindex fdump-rtl-sibling
12981 Dump after sibling call optimizations.
12983 @item -fdump-rtl-split1
12984 @itemx -fdump-rtl-split2
12985 @itemx -fdump-rtl-split3
12986 @itemx -fdump-rtl-split4
12987 @itemx -fdump-rtl-split5
12988 @opindex fdump-rtl-split1
12989 @opindex fdump-rtl-split2
12990 @opindex fdump-rtl-split3
12991 @opindex fdump-rtl-split4
12992 @opindex fdump-rtl-split5
12993 These options enable dumping after five rounds of
12994 instruction splitting.
12996 @item -fdump-rtl-sms
12997 @opindex fdump-rtl-sms
12998 Dump after modulo scheduling.  This pass is only run on some
12999 architectures.
13001 @item -fdump-rtl-stack
13002 @opindex fdump-rtl-stack
13003 Dump after conversion from GCC's ``flat register file'' registers to the
13004 x87's stack-like registers.  This pass is only run on x86 variants.
13006 @item -fdump-rtl-subreg1
13007 @itemx -fdump-rtl-subreg2
13008 @opindex fdump-rtl-subreg1
13009 @opindex fdump-rtl-subreg2
13010 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
13011 the two subreg expansion passes.
13013 @item -fdump-rtl-unshare
13014 @opindex fdump-rtl-unshare
13015 Dump after all rtl has been unshared.
13017 @item -fdump-rtl-vartrack
13018 @opindex fdump-rtl-vartrack
13019 Dump after variable tracking.
13021 @item -fdump-rtl-vregs
13022 @opindex fdump-rtl-vregs
13023 Dump after converting virtual registers to hard registers.
13025 @item -fdump-rtl-web
13026 @opindex fdump-rtl-web
13027 Dump after live range splitting.
13029 @item -fdump-rtl-regclass
13030 @itemx -fdump-rtl-subregs_of_mode_init
13031 @itemx -fdump-rtl-subregs_of_mode_finish
13032 @itemx -fdump-rtl-dfinit
13033 @itemx -fdump-rtl-dfinish
13034 @opindex fdump-rtl-regclass
13035 @opindex fdump-rtl-subregs_of_mode_init
13036 @opindex fdump-rtl-subregs_of_mode_finish
13037 @opindex fdump-rtl-dfinit
13038 @opindex fdump-rtl-dfinish
13039 These dumps are defined but always produce empty files.
13041 @item -da
13042 @itemx -fdump-rtl-all
13043 @opindex da
13044 @opindex fdump-rtl-all
13045 Produce all the dumps listed above.
13047 @item -dA
13048 @opindex dA
13049 Annotate the assembler output with miscellaneous debugging information.
13051 @item -dD
13052 @opindex dD
13053 Dump all macro definitions, at the end of preprocessing, in addition to
13054 normal output.
13056 @item -dH
13057 @opindex dH
13058 Produce a core dump whenever an error occurs.
13060 @item -dp
13061 @opindex dp
13062 Annotate the assembler output with a comment indicating which
13063 pattern and alternative is used.  The length of each instruction is
13064 also printed.
13066 @item -dP
13067 @opindex dP
13068 Dump the RTL in the assembler output as a comment before each instruction.
13069 Also turns on @option{-dp} annotation.
13071 @item -dx
13072 @opindex dx
13073 Just generate RTL for a function instead of compiling it.  Usually used
13074 with @option{-fdump-rtl-expand}.
13075 @end table
13077 @item -fdump-noaddr
13078 @opindex fdump-noaddr
13079 When doing debugging dumps, suppress address output.  This makes it more
13080 feasible to use diff on debugging dumps for compiler invocations with
13081 different compiler binaries and/or different
13082 text / bss / data / heap / stack / dso start locations.
13084 @item -freport-bug
13085 @opindex freport-bug
13086 Collect and dump debug information into a temporary file if an
13087 internal compiler error (ICE) occurs.
13089 @item -fdump-unnumbered
13090 @opindex fdump-unnumbered
13091 When doing debugging dumps, suppress instruction numbers and address output.
13092 This makes it more feasible to use diff on debugging dumps for compiler
13093 invocations with different options, in particular with and without
13094 @option{-g}.
13096 @item -fdump-unnumbered-links
13097 @opindex fdump-unnumbered-links
13098 When doing debugging dumps (see @option{-d} option above), suppress
13099 instruction numbers for the links to the previous and next instructions
13100 in a sequence.
13102 @item -fdump-ipa-@var{switch}
13103 @opindex fdump-ipa
13104 Control the dumping at various stages of inter-procedural analysis
13105 language tree to a file.  The file name is generated by appending a
13106 switch specific suffix to the source file name, and the file is created
13107 in the same directory as the output file.  The following dumps are
13108 possible:
13110 @table @samp
13111 @item all
13112 Enables all inter-procedural analysis dumps.
13114 @item cgraph
13115 Dumps information about call-graph optimization, unused function removal,
13116 and inlining decisions.
13118 @item inline
13119 Dump after function inlining.
13121 @end table
13123 @item -fdump-lang-all
13124 @itemx -fdump-lang-@var{switch}
13125 @itemx -fdump-lang-@var{switch}-@var{options}
13126 @itemx -fdump-lang-@var{switch}-@var{options}=@var{filename}
13127 @opindex fdump-lang-all
13128 @opindex fdump-lang
13129 Control the dumping of language-specific information.  The @var{options}
13130 and @var{filename} portions behave as described in the
13131 @option{-fdump-tree} option.  The following @var{switch} values are
13132 accepted:
13134 @table @samp
13135 @item all
13137 Enable all language-specific dumps.
13139 @item class
13140 Dump class hierarchy information.  Virtual table information is emitted
13141 unless '@option{slim}' is specified.  This option is applicable to C++ only.
13143 @item raw
13144 Dump the raw internal tree data.  This option is applicable to C++ only.
13146 @end table
13148 @item -fdump-passes
13149 @opindex fdump-passes
13150 Print on @file{stderr} the list of optimization passes that are turned
13151 on and off by the current command-line options.
13153 @item -fdump-statistics-@var{option}
13154 @opindex fdump-statistics
13155 Enable and control dumping of pass statistics in a separate file.  The
13156 file name is generated by appending a suffix ending in
13157 @samp{.statistics} to the source file name, and the file is created in
13158 the same directory as the output file.  If the @samp{-@var{option}}
13159 form is used, @samp{-stats} causes counters to be summed over the
13160 whole compilation unit while @samp{-details} dumps every event as
13161 the passes generate them.  The default with no option is to sum
13162 counters for each function compiled.
13164 @item -fdump-tree-all
13165 @itemx -fdump-tree-@var{switch}
13166 @itemx -fdump-tree-@var{switch}-@var{options}
13167 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
13168 @opindex fdump-tree-all
13169 @opindex fdump-tree
13170 Control the dumping at various stages of processing the intermediate
13171 language tree to a file.  The file name is generated by appending a
13172 switch-specific suffix to the source file name, and the file is
13173 created in the same directory as the output file. In case of
13174 @option{=@var{filename}} option, the dump is output on the given file
13175 instead of the auto named dump files.  If the @samp{-@var{options}}
13176 form is used, @var{options} is a list of @samp{-} separated options
13177 which control the details of the dump.  Not all options are applicable
13178 to all dumps; those that are not meaningful are ignored.  The
13179 following options are available
13181 @table @samp
13182 @item address
13183 Print the address of each node.  Usually this is not meaningful as it
13184 changes according to the environment and source file.  Its primary use
13185 is for tying up a dump file with a debug environment.
13186 @item asmname
13187 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
13188 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
13189 use working backward from mangled names in the assembly file.
13190 @item slim
13191 When dumping front-end intermediate representations, inhibit dumping
13192 of members of a scope or body of a function merely because that scope
13193 has been reached.  Only dump such items when they are directly reachable
13194 by some other path.
13196 When dumping pretty-printed trees, this option inhibits dumping the
13197 bodies of control structures.
13199 When dumping RTL, print the RTL in slim (condensed) form instead of
13200 the default LISP-like representation.
13201 @item raw
13202 Print a raw representation of the tree.  By default, trees are
13203 pretty-printed into a C-like representation.
13204 @item details
13205 Enable more detailed dumps (not honored by every dump option). Also
13206 include information from the optimization passes.
13207 @item stats
13208 Enable dumping various statistics about the pass (not honored by every dump
13209 option).
13210 @item blocks
13211 Enable showing basic block boundaries (disabled in raw dumps).
13212 @item graph
13213 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
13214 dump a representation of the control flow graph suitable for viewing with
13215 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
13216 the file is pretty-printed as a subgraph, so that GraphViz can render them
13217 all in a single plot.
13219 This option currently only works for RTL dumps, and the RTL is always
13220 dumped in slim form.
13221 @item vops
13222 Enable showing virtual operands for every statement.
13223 @item lineno
13224 Enable showing line numbers for statements.
13225 @item uid
13226 Enable showing the unique ID (@code{DECL_UID}) for each variable.
13227 @item verbose
13228 Enable showing the tree dump for each statement.
13229 @item eh
13230 Enable showing the EH region number holding each statement.
13231 @item scev
13232 Enable showing scalar evolution analysis details.
13233 @item optimized
13234 Enable showing optimization information (only available in certain
13235 passes).
13236 @item missed
13237 Enable showing missed optimization information (only available in certain
13238 passes).
13239 @item note
13240 Enable other detailed optimization information (only available in
13241 certain passes).
13242 @item =@var{filename}
13243 Instead of an auto named dump file, output into the given file
13244 name. The file names @file{stdout} and @file{stderr} are treated
13245 specially and are considered already open standard streams. For
13246 example,
13248 @smallexample
13249 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
13250      -fdump-tree-pre=/dev/stderr file.c
13251 @end smallexample
13253 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
13254 output on to @file{stderr}. If two conflicting dump filenames are
13255 given for the same pass, then the latter option overrides the earlier
13256 one.
13258 @item all
13259 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
13260 and @option{lineno}.
13262 @item optall
13263 Turn on all optimization options, i.e., @option{optimized},
13264 @option{missed}, and @option{note}.
13265 @end table
13267 To determine what tree dumps are available or find the dump for a pass
13268 of interest follow the steps below.
13270 @enumerate
13271 @item
13272 Invoke GCC with @option{-fdump-passes} and in the @file{stderr} output
13273 look for a code that corresponds to the pass you are interested in.
13274 For example, the codes @code{tree-evrp}, @code{tree-vrp1}, and
13275 @code{tree-vrp2} correspond to the three Value Range Propagation passes.
13276 The number at the end distinguishes distinct invocations of the same pass.
13277 @item
13278 To enable the creation of the dump file, append the pass code to
13279 the @option{-fdump-} option prefix and invoke GCC with it.  For example,
13280 to enable the dump from the Early Value Range Propagation pass, invoke
13281 GCC with the @option{-fdump-tree-evrp} option.  Optionally, you may
13282 specify the name of the dump file.  If you don't specify one, GCC
13283 creates as described below.
13284 @item
13285 Find the pass dump in a file whose name is composed of three components
13286 separated by a period: the name of the source file GCC was invoked to
13287 compile, a numeric suffix indicating the pass number followed by the
13288 letter @samp{t} for tree passes (and the letter @samp{r} for RTL passes),
13289 and finally the pass code.  For example, the Early VRP pass dump might
13290 be in a file named @file{myfile.c.038t.evrp} in the current working
13291 directory.  Note that the numeric codes are not stable and may change
13292 from one version of GCC to another.
13293 @end enumerate
13295 @item -fopt-info
13296 @itemx -fopt-info-@var{options}
13297 @itemx -fopt-info-@var{options}=@var{filename}
13298 @opindex fopt-info
13299 Controls optimization dumps from various optimization passes. If the
13300 @samp{-@var{options}} form is used, @var{options} is a list of
13301 @samp{-} separated option keywords to select the dump details and
13302 optimizations.  
13304 The @var{options} can be divided into two groups: options describing the
13305 verbosity of the dump, and options describing which optimizations
13306 should be included. The options from both the groups can be freely
13307 mixed as they are non-overlapping. However, in case of any conflicts,
13308 the later options override the earlier options on the command
13309 line. 
13311 The following options control the dump verbosity:
13313 @table @samp
13314 @item optimized
13315 Print information when an optimization is successfully applied. It is
13316 up to a pass to decide which information is relevant. For example, the
13317 vectorizer passes print the source location of loops which are
13318 successfully vectorized.
13319 @item missed
13320 Print information about missed optimizations. Individual passes
13321 control which information to include in the output. 
13322 @item note
13323 Print verbose information about optimizations, such as certain
13324 transformations, more detailed messages about decisions etc.
13325 @item all
13326 Print detailed optimization information. This includes
13327 @samp{optimized}, @samp{missed}, and @samp{note}.
13328 @end table
13330 One or more of the following option keywords can be used to describe a
13331 group of optimizations:
13333 @table @samp
13334 @item ipa
13335 Enable dumps from all interprocedural optimizations.
13336 @item loop
13337 Enable dumps from all loop optimizations.
13338 @item inline
13339 Enable dumps from all inlining optimizations.
13340 @item omp
13341 Enable dumps from all OMP (Offloading and Multi Processing) optimizations.
13342 @item vec
13343 Enable dumps from all vectorization optimizations.
13344 @item optall
13345 Enable dumps from all optimizations. This is a superset of
13346 the optimization groups listed above.
13347 @end table
13349 If @var{options} is
13350 omitted, it defaults to @samp{optimized-optall}, which means to dump all
13351 info about successful optimizations from all the passes.  
13353 If the @var{filename} is provided, then the dumps from all the
13354 applicable optimizations are concatenated into the @var{filename}.
13355 Otherwise the dump is output onto @file{stderr}. Though multiple
13356 @option{-fopt-info} options are accepted, only one of them can include
13357 a @var{filename}. If other filenames are provided then all but the
13358 first such option are ignored.
13360 Note that the output @var{filename} is overwritten
13361 in case of multiple translation units. If a combined output from
13362 multiple translation units is desired, @file{stderr} should be used
13363 instead.
13365 In the following example, the optimization info is output to
13366 @file{stderr}:
13368 @smallexample
13369 gcc -O3 -fopt-info
13370 @end smallexample
13372 This example:
13373 @smallexample
13374 gcc -O3 -fopt-info-missed=missed.all
13375 @end smallexample
13377 @noindent
13378 outputs missed optimization report from all the passes into
13379 @file{missed.all}, and this one:
13381 @smallexample
13382 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
13383 @end smallexample
13385 @noindent
13386 prints information about missed optimization opportunities from
13387 vectorization passes on @file{stderr}.  
13388 Note that @option{-fopt-info-vec-missed} is equivalent to 
13389 @option{-fopt-info-missed-vec}.  The order of the optimization group
13390 names and message types listed after @option{-fopt-info} does not matter.
13392 As another example,
13393 @smallexample
13394 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
13395 @end smallexample
13397 @noindent
13398 outputs information about missed optimizations as well as
13399 optimized locations from all the inlining passes into
13400 @file{inline.txt}.
13402 Finally, consider:
13404 @smallexample
13405 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
13406 @end smallexample
13408 @noindent
13409 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
13410 in conflict since only one output file is allowed. In this case, only
13411 the first option takes effect and the subsequent options are
13412 ignored. Thus only @file{vec.miss} is produced which contains
13413 dumps from the vectorizer about missed opportunities.
13415 @item -fsched-verbose=@var{n}
13416 @opindex fsched-verbose
13417 On targets that use instruction scheduling, this option controls the
13418 amount of debugging output the scheduler prints to the dump files.
13420 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
13421 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
13422 For @var{n} greater than one, it also output basic block probabilities,
13423 detailed ready list information and unit/insn info.  For @var{n} greater
13424 than two, it includes RTL at abort point, control-flow and regions info.
13425 And for @var{n} over four, @option{-fsched-verbose} also includes
13426 dependence info.
13430 @item -fenable-@var{kind}-@var{pass}
13431 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
13432 @opindex fdisable-
13433 @opindex fenable-
13435 This is a set of options that are used to explicitly disable/enable
13436 optimization passes.  These options are intended for use for debugging GCC.
13437 Compiler users should use regular options for enabling/disabling
13438 passes instead.
13440 @table @gcctabopt
13442 @item -fdisable-ipa-@var{pass}
13443 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
13444 statically invoked in the compiler multiple times, the pass name should be
13445 appended with a sequential number starting from 1.
13447 @item -fdisable-rtl-@var{pass}
13448 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
13449 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
13450 statically invoked in the compiler multiple times, the pass name should be
13451 appended with a sequential number starting from 1.  @var{range-list} is a 
13452 comma-separated list of function ranges or assembler names.  Each range is a number
13453 pair separated by a colon.  The range is inclusive in both ends.  If the range
13454 is trivial, the number pair can be simplified as a single number.  If the
13455 function's call graph node's @var{uid} falls within one of the specified ranges,
13456 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
13457 function header of a dump file, and the pass names can be dumped by using
13458 option @option{-fdump-passes}.
13460 @item -fdisable-tree-@var{pass}
13461 @itemx -fdisable-tree-@var{pass}=@var{range-list}
13462 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
13463 option arguments.
13465 @item -fenable-ipa-@var{pass}
13466 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
13467 statically invoked in the compiler multiple times, the pass name should be
13468 appended with a sequential number starting from 1.
13470 @item -fenable-rtl-@var{pass}
13471 @itemx -fenable-rtl-@var{pass}=@var{range-list}
13472 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
13473 description and examples.
13475 @item -fenable-tree-@var{pass}
13476 @itemx -fenable-tree-@var{pass}=@var{range-list}
13477 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
13478 of option arguments.
13480 @end table
13482 Here are some examples showing uses of these options.
13484 @smallexample
13486 # disable ccp1 for all functions
13487    -fdisable-tree-ccp1
13488 # disable complete unroll for function whose cgraph node uid is 1
13489    -fenable-tree-cunroll=1
13490 # disable gcse2 for functions at the following ranges [1,1],
13491 # [300,400], and [400,1000]
13492 # disable gcse2 for functions foo and foo2
13493    -fdisable-rtl-gcse2=foo,foo2
13494 # disable early inlining
13495    -fdisable-tree-einline
13496 # disable ipa inlining
13497    -fdisable-ipa-inline
13498 # enable tree full unroll
13499    -fenable-tree-unroll
13501 @end smallexample
13503 @item -fchecking
13504 @itemx -fchecking=@var{n}
13505 @opindex fchecking
13506 @opindex fno-checking
13507 Enable internal consistency checking.  The default depends on
13508 the compiler configuration.  @option{-fchecking=2} enables further
13509 internal consistency checking that might affect code generation.
13511 @item -frandom-seed=@var{string}
13512 @opindex frandom-seed
13513 This option provides a seed that GCC uses in place of
13514 random numbers in generating certain symbol names
13515 that have to be different in every compiled file.  It is also used to
13516 place unique stamps in coverage data files and the object files that
13517 produce them.  You can use the @option{-frandom-seed} option to produce
13518 reproducibly identical object files.
13520 The @var{string} can either be a number (decimal, octal or hex) or an
13521 arbitrary string (in which case it's converted to a number by
13522 computing CRC32).
13524 The @var{string} should be different for every file you compile.
13526 @item -save-temps
13527 @itemx -save-temps=cwd
13528 @opindex save-temps
13529 Store the usual ``temporary'' intermediate files permanently; place them
13530 in the current directory and name them based on the source file.  Thus,
13531 compiling @file{foo.c} with @option{-c -save-temps} produces files
13532 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
13533 preprocessed @file{foo.i} output file even though the compiler now
13534 normally uses an integrated preprocessor.
13536 When used in combination with the @option{-x} command-line option,
13537 @option{-save-temps} is sensible enough to avoid over writing an
13538 input source file with the same extension as an intermediate file.
13539 The corresponding intermediate file may be obtained by renaming the
13540 source file before using @option{-save-temps}.
13542 If you invoke GCC in parallel, compiling several different source
13543 files that share a common base name in different subdirectories or the
13544 same source file compiled for multiple output destinations, it is
13545 likely that the different parallel compilers will interfere with each
13546 other, and overwrite the temporary files.  For instance:
13548 @smallexample
13549 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
13550 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
13551 @end smallexample
13553 may result in @file{foo.i} and @file{foo.o} being written to
13554 simultaneously by both compilers.
13556 @item -save-temps=obj
13557 @opindex save-temps=obj
13558 Store the usual ``temporary'' intermediate files permanently.  If the
13559 @option{-o} option is used, the temporary files are based on the
13560 object file.  If the @option{-o} option is not used, the
13561 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
13563 For example:
13565 @smallexample
13566 gcc -save-temps=obj -c foo.c
13567 gcc -save-temps=obj -c bar.c -o dir/xbar.o
13568 gcc -save-temps=obj foobar.c -o dir2/yfoobar
13569 @end smallexample
13571 @noindent
13572 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
13573 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
13574 @file{dir2/yfoobar.o}.
13576 @item -time@r{[}=@var{file}@r{]}
13577 @opindex time
13578 Report the CPU time taken by each subprocess in the compilation
13579 sequence.  For C source files, this is the compiler proper and assembler
13580 (plus the linker if linking is done).
13582 Without the specification of an output file, the output looks like this:
13584 @smallexample
13585 # cc1 0.12 0.01
13586 # as 0.00 0.01
13587 @end smallexample
13589 The first number on each line is the ``user time'', that is time spent
13590 executing the program itself.  The second number is ``system time'',
13591 time spent executing operating system routines on behalf of the program.
13592 Both numbers are in seconds.
13594 With the specification of an output file, the output is appended to the
13595 named file, and it looks like this:
13597 @smallexample
13598 0.12 0.01 cc1 @var{options}
13599 0.00 0.01 as @var{options}
13600 @end smallexample
13602 The ``user time'' and the ``system time'' are moved before the program
13603 name, and the options passed to the program are displayed, so that one
13604 can later tell what file was being compiled, and with which options.
13606 @item -fdump-final-insns@r{[}=@var{file}@r{]}
13607 @opindex fdump-final-insns
13608 Dump the final internal representation (RTL) to @var{file}.  If the
13609 optional argument is omitted (or if @var{file} is @code{.}), the name
13610 of the dump file is determined by appending @code{.gkd} to the
13611 compilation output file name.
13613 @item -fcompare-debug@r{[}=@var{opts}@r{]}
13614 @opindex fcompare-debug
13615 @opindex fno-compare-debug
13616 If no error occurs during compilation, run the compiler a second time,
13617 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
13618 passed to the second compilation.  Dump the final internal
13619 representation in both compilations, and print an error if they differ.
13621 If the equal sign is omitted, the default @option{-gtoggle} is used.
13623 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
13624 and nonzero, implicitly enables @option{-fcompare-debug}.  If
13625 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
13626 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
13627 is used.
13629 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
13630 is equivalent to @option{-fno-compare-debug}, which disables the dumping
13631 of the final representation and the second compilation, preventing even
13632 @env{GCC_COMPARE_DEBUG} from taking effect.
13634 To verify full coverage during @option{-fcompare-debug} testing, set
13635 @env{GCC_COMPARE_DEBUG} to say @option{-fcompare-debug-not-overridden},
13636 which GCC rejects as an invalid option in any actual compilation
13637 (rather than preprocessing, assembly or linking).  To get just a
13638 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
13639 not overridden} will do.
13641 @item -fcompare-debug-second
13642 @opindex fcompare-debug-second
13643 This option is implicitly passed to the compiler for the second
13644 compilation requested by @option{-fcompare-debug}, along with options to
13645 silence warnings, and omitting other options that would cause
13646 side-effect compiler outputs to files or to the standard output.  Dump
13647 files and preserved temporary files are renamed so as to contain the
13648 @code{.gk} additional extension during the second compilation, to avoid
13649 overwriting those generated by the first.
13651 When this option is passed to the compiler driver, it causes the
13652 @emph{first} compilation to be skipped, which makes it useful for little
13653 other than debugging the compiler proper.
13655 @item -gtoggle
13656 @opindex gtoggle
13657 Turn off generation of debug info, if leaving out this option
13658 generates it, or turn it on at level 2 otherwise.  The position of this
13659 argument in the command line does not matter; it takes effect after all
13660 other options are processed, and it does so only once, no matter how
13661 many times it is given.  This is mainly intended to be used with
13662 @option{-fcompare-debug}.
13664 @item -fvar-tracking-assignments-toggle
13665 @opindex fvar-tracking-assignments-toggle
13666 @opindex fno-var-tracking-assignments-toggle
13667 Toggle @option{-fvar-tracking-assignments}, in the same way that
13668 @option{-gtoggle} toggles @option{-g}.
13670 @item -Q
13671 @opindex Q
13672 Makes the compiler print out each function name as it is compiled, and
13673 print some statistics about each pass when it finishes.
13675 @item -ftime-report
13676 @opindex ftime-report
13677 Makes the compiler print some statistics about the time consumed by each
13678 pass when it finishes.
13680 @item -ftime-report-details
13681 @opindex ftime-report-details
13682 Record the time consumed by infrastructure parts separately for each pass.
13684 @item -fira-verbose=@var{n}
13685 @opindex fira-verbose
13686 Control the verbosity of the dump file for the integrated register allocator.
13687 The default value is 5.  If the value @var{n} is greater or equal to 10,
13688 the dump output is sent to stderr using the same format as @var{n} minus 10.
13690 @item -flto-report
13691 @opindex flto-report
13692 Prints a report with internal details on the workings of the link-time
13693 optimizer.  The contents of this report vary from version to version.
13694 It is meant to be useful to GCC developers when processing object
13695 files in LTO mode (via @option{-flto}).
13697 Disabled by default.
13699 @item -flto-report-wpa
13700 @opindex flto-report-wpa
13701 Like @option{-flto-report}, but only print for the WPA phase of Link
13702 Time Optimization.
13704 @item -fmem-report
13705 @opindex fmem-report
13706 Makes the compiler print some statistics about permanent memory
13707 allocation when it finishes.
13709 @item -fmem-report-wpa
13710 @opindex fmem-report-wpa
13711 Makes the compiler print some statistics about permanent memory
13712 allocation for the WPA phase only.
13714 @item -fpre-ipa-mem-report
13715 @opindex fpre-ipa-mem-report
13716 @item -fpost-ipa-mem-report
13717 @opindex fpost-ipa-mem-report
13718 Makes the compiler print some statistics about permanent memory
13719 allocation before or after interprocedural optimization.
13721 @item -fprofile-report
13722 @opindex fprofile-report
13723 Makes the compiler print some statistics about consistency of the
13724 (estimated) profile and effect of individual passes.
13726 @item -fstack-usage
13727 @opindex fstack-usage
13728 Makes the compiler output stack usage information for the program, on a
13729 per-function basis.  The filename for the dump is made by appending
13730 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
13731 the output file, if explicitly specified and it is not an executable,
13732 otherwise it is the basename of the source file.  An entry is made up
13733 of three fields:
13735 @itemize
13736 @item
13737 The name of the function.
13738 @item
13739 A number of bytes.
13740 @item
13741 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
13742 @end itemize
13744 The qualifier @code{static} means that the function manipulates the stack
13745 statically: a fixed number of bytes are allocated for the frame on function
13746 entry and released on function exit; no stack adjustments are otherwise made
13747 in the function.  The second field is this fixed number of bytes.
13749 The qualifier @code{dynamic} means that the function manipulates the stack
13750 dynamically: in addition to the static allocation described above, stack
13751 adjustments are made in the body of the function, for example to push/pop
13752 arguments around function calls.  If the qualifier @code{bounded} is also
13753 present, the amount of these adjustments is bounded at compile time and
13754 the second field is an upper bound of the total amount of stack used by
13755 the function.  If it is not present, the amount of these adjustments is
13756 not bounded at compile time and the second field only represents the
13757 bounded part.
13759 @item -fstats
13760 @opindex fstats
13761 Emit statistics about front-end processing at the end of the compilation.
13762 This option is supported only by the C++ front end, and
13763 the information is generally only useful to the G++ development team.
13765 @item -fdbg-cnt-list
13766 @opindex fdbg-cnt-list
13767 Print the name and the counter upper bound for all debug counters.
13770 @item -fdbg-cnt=@var{counter-value-list}
13771 @opindex fdbg-cnt
13772 Set the internal debug counter upper bound.  @var{counter-value-list}
13773 is a comma-separated list of @var{name}:@var{value} pairs
13774 which sets the upper bound of each debug counter @var{name} to @var{value}.
13775 All debug counters have the initial upper bound of @code{UINT_MAX};
13776 thus @code{dbg_cnt} returns true always unless the upper bound
13777 is set by this option.
13778 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
13779 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
13781 @item -print-file-name=@var{library}
13782 @opindex print-file-name
13783 Print the full absolute name of the library file @var{library} that
13784 would be used when linking---and don't do anything else.  With this
13785 option, GCC does not compile or link anything; it just prints the
13786 file name.
13788 @item -print-multi-directory
13789 @opindex print-multi-directory
13790 Print the directory name corresponding to the multilib selected by any
13791 other switches present in the command line.  This directory is supposed
13792 to exist in @env{GCC_EXEC_PREFIX}.
13794 @item -print-multi-lib
13795 @opindex print-multi-lib
13796 Print the mapping from multilib directory names to compiler switches
13797 that enable them.  The directory name is separated from the switches by
13798 @samp{;}, and each switch starts with an @samp{@@} instead of the
13799 @samp{-}, without spaces between multiple switches.  This is supposed to
13800 ease shell processing.
13802 @item -print-multi-os-directory
13803 @opindex print-multi-os-directory
13804 Print the path to OS libraries for the selected
13805 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
13806 present in the @file{lib} subdirectory and no multilibs are used, this is
13807 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
13808 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
13809 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
13810 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
13812 @item -print-multiarch
13813 @opindex print-multiarch
13814 Print the path to OS libraries for the selected multiarch,
13815 relative to some @file{lib} subdirectory.
13817 @item -print-prog-name=@var{program}
13818 @opindex print-prog-name
13819 Like @option{-print-file-name}, but searches for a program such as @command{cpp}.
13821 @item -print-libgcc-file-name
13822 @opindex print-libgcc-file-name
13823 Same as @option{-print-file-name=libgcc.a}.
13825 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
13826 but you do want to link with @file{libgcc.a}.  You can do:
13828 @smallexample
13829 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
13830 @end smallexample
13832 @item -print-search-dirs
13833 @opindex print-search-dirs
13834 Print the name of the configured installation directory and a list of
13835 program and library directories @command{gcc} searches---and don't do anything else.
13837 This is useful when @command{gcc} prints the error message
13838 @samp{installation problem, cannot exec cpp0: No such file or directory}.
13839 To resolve this you either need to put @file{cpp0} and the other compiler
13840 components where @command{gcc} expects to find them, or you can set the environment
13841 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
13842 Don't forget the trailing @samp{/}.
13843 @xref{Environment Variables}.
13845 @item -print-sysroot
13846 @opindex print-sysroot
13847 Print the target sysroot directory that is used during
13848 compilation.  This is the target sysroot specified either at configure
13849 time or using the @option{--sysroot} option, possibly with an extra
13850 suffix that depends on compilation options.  If no target sysroot is
13851 specified, the option prints nothing.
13853 @item -print-sysroot-headers-suffix
13854 @opindex print-sysroot-headers-suffix
13855 Print the suffix added to the target sysroot when searching for
13856 headers, or give an error if the compiler is not configured with such
13857 a suffix---and don't do anything else.
13859 @item -dumpmachine
13860 @opindex dumpmachine
13861 Print the compiler's target machine (for example,
13862 @samp{i686-pc-linux-gnu})---and don't do anything else.
13864 @item -dumpversion
13865 @opindex dumpversion
13866 Print the compiler version (for example, @code{3.0}, @code{6.3.0} or @code{7})---and don't do
13867 anything else.  This is the compiler version used in filesystem paths,
13868 specs, can be depending on how the compiler has been configured just
13869 a single number (major version), two numbers separated by dot (major and
13870 minor version) or three numbers separated by dots (major, minor and patchlevel
13871 version).
13873 @item -dumpfullversion
13874 @opindex dumpfullversion
13875 Print the full compiler version, always 3 numbers separated by dots,
13876 major, minor and patchlevel version.
13878 @item -dumpspecs
13879 @opindex dumpspecs
13880 Print the compiler's built-in specs---and don't do anything else.  (This
13881 is used when GCC itself is being built.)  @xref{Spec Files}.
13882 @end table
13884 @node Submodel Options
13885 @section Machine-Dependent Options
13886 @cindex submodel options
13887 @cindex specifying hardware config
13888 @cindex hardware models and configurations, specifying
13889 @cindex target-dependent options
13890 @cindex machine-dependent options
13892 Each target machine supported by GCC can have its own options---for
13893 example, to allow you to compile for a particular processor variant or
13894 ABI, or to control optimizations specific to that machine.  By
13895 convention, the names of machine-specific options start with
13896 @samp{-m}.
13898 Some configurations of the compiler also support additional target-specific
13899 options, usually for compatibility with other compilers on the same
13900 platform.
13902 @c This list is ordered alphanumerically by subsection name.
13903 @c It should be the same order and spelling as these options are listed
13904 @c in Machine Dependent Options
13906 @menu
13907 * AArch64 Options::
13908 * Adapteva Epiphany Options::
13909 * ARC Options::
13910 * ARM Options::
13911 * AVR Options::
13912 * Blackfin Options::
13913 * C6X Options::
13914 * CRIS Options::
13915 * CR16 Options::
13916 * Darwin Options::
13917 * DEC Alpha Options::
13918 * FR30 Options::
13919 * FT32 Options::
13920 * FRV Options::
13921 * GNU/Linux Options::
13922 * H8/300 Options::
13923 * HPPA Options::
13924 * IA-64 Options::
13925 * LM32 Options::
13926 * M32C Options::
13927 * M32R/D Options::
13928 * M680x0 Options::
13929 * MCore Options::
13930 * MeP Options::
13931 * MicroBlaze Options::
13932 * MIPS Options::
13933 * MMIX Options::
13934 * MN10300 Options::
13935 * Moxie Options::
13936 * MSP430 Options::
13937 * NDS32 Options::
13938 * Nios II Options::
13939 * Nvidia PTX Options::
13940 * PDP-11 Options::
13941 * picoChip Options::
13942 * PowerPC Options::
13943 * RISC-V Options::
13944 * RL78 Options::
13945 * RS/6000 and PowerPC Options::
13946 * RX Options::
13947 * S/390 and zSeries Options::
13948 * Score Options::
13949 * SH Options::
13950 * Solaris 2 Options::
13951 * SPARC Options::
13952 * SPU Options::
13953 * System V Options::
13954 * TILE-Gx Options::
13955 * TILEPro Options::
13956 * V850 Options::
13957 * VAX Options::
13958 * Visium Options::
13959 * VMS Options::
13960 * VxWorks Options::
13961 * x86 Options::
13962 * x86 Windows Options::
13963 * Xstormy16 Options::
13964 * Xtensa Options::
13965 * zSeries Options::
13966 @end menu
13968 @node AArch64 Options
13969 @subsection AArch64 Options
13970 @cindex AArch64 Options
13972 These options are defined for AArch64 implementations:
13974 @table @gcctabopt
13976 @item -mabi=@var{name}
13977 @opindex mabi
13978 Generate code for the specified data model.  Permissible values
13979 are @samp{ilp32} for SysV-like data model where int, long int and pointers
13980 are 32 bits, and @samp{lp64} for SysV-like data model where int is 32 bits,
13981 but long int and pointers are 64 bits.
13983 The default depends on the specific target configuration.  Note that
13984 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
13985 entire program with the same ABI, and link with a compatible set of libraries.
13987 @item -mbig-endian
13988 @opindex mbig-endian
13989 Generate big-endian code.  This is the default when GCC is configured for an
13990 @samp{aarch64_be-*-*} target.
13992 @item -mgeneral-regs-only
13993 @opindex mgeneral-regs-only
13994 Generate code which uses only the general-purpose registers.  This will prevent
13995 the compiler from using floating-point and Advanced SIMD registers but will not
13996 impose any restrictions on the assembler.
13998 @item -mlittle-endian
13999 @opindex mlittle-endian
14000 Generate little-endian code.  This is the default when GCC is configured for an
14001 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
14003 @item -mcmodel=tiny
14004 @opindex mcmodel=tiny
14005 Generate code for the tiny code model.  The program and its statically defined
14006 symbols must be within 1MB of each other.  Programs can be statically or
14007 dynamically linked.
14009 @item -mcmodel=small
14010 @opindex mcmodel=small
14011 Generate code for the small code model.  The program and its statically defined
14012 symbols must be within 4GB of each other.  Programs can be statically or
14013 dynamically linked.  This is the default code model.
14015 @item -mcmodel=large
14016 @opindex mcmodel=large
14017 Generate code for the large code model.  This makes no assumptions about
14018 addresses and sizes of sections.  Programs can be statically linked only.
14020 @item -mstrict-align
14021 @opindex mstrict-align
14022 Avoid generating memory accesses that may not be aligned on a natural object
14023 boundary as described in the architecture specification.
14025 @item -momit-leaf-frame-pointer
14026 @itemx -mno-omit-leaf-frame-pointer
14027 @opindex momit-leaf-frame-pointer
14028 @opindex mno-omit-leaf-frame-pointer
14029 Omit or keep the frame pointer in leaf functions.  The former behavior is the
14030 default.
14032 @item -mtls-dialect=desc
14033 @opindex mtls-dialect=desc
14034 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
14035 of TLS variables.  This is the default.
14037 @item -mtls-dialect=traditional
14038 @opindex mtls-dialect=traditional
14039 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
14040 of TLS variables.
14042 @item -mtls-size=@var{size}
14043 @opindex mtls-size
14044 Specify bit size of immediate TLS offsets.  Valid values are 12, 24, 32, 48.
14045 This option requires binutils 2.26 or newer.
14047 @item -mfix-cortex-a53-835769
14048 @itemx -mno-fix-cortex-a53-835769
14049 @opindex mfix-cortex-a53-835769
14050 @opindex mno-fix-cortex-a53-835769
14051 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
14052 This involves inserting a NOP instruction between memory instructions and
14053 64-bit integer multiply-accumulate instructions.
14055 @item -mfix-cortex-a53-843419
14056 @itemx -mno-fix-cortex-a53-843419
14057 @opindex mfix-cortex-a53-843419
14058 @opindex mno-fix-cortex-a53-843419
14059 Enable or disable the workaround for the ARM Cortex-A53 erratum number 843419.
14060 This erratum workaround is made at link time and this will only pass the
14061 corresponding flag to the linker.
14063 @item -mlow-precision-recip-sqrt
14064 @item -mno-low-precision-recip-sqrt
14065 @opindex mlow-precision-recip-sqrt
14066 @opindex mno-low-precision-recip-sqrt
14067 Enable or disable the reciprocal square root approximation.
14068 This option only has an effect if @option{-ffast-math} or
14069 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14070 precision of reciprocal square root results to about 16 bits for
14071 single precision and to 32 bits for double precision.
14073 @item -mlow-precision-sqrt
14074 @item -mno-low-precision-sqrt
14075 @opindex -mlow-precision-sqrt
14076 @opindex -mno-low-precision-sqrt
14077 Enable or disable the square root approximation.
14078 This option only has an effect if @option{-ffast-math} or
14079 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14080 precision of square root results to about 16 bits for
14081 single precision and to 32 bits for double precision.
14082 If enabled, it implies @option{-mlow-precision-recip-sqrt}.
14084 @item -mlow-precision-div
14085 @item -mno-low-precision-div
14086 @opindex -mlow-precision-div
14087 @opindex -mno-low-precision-div
14088 Enable or disable the division approximation.
14089 This option only has an effect if @option{-ffast-math} or
14090 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14091 precision of division results to about 16 bits for
14092 single precision and to 32 bits for double precision.
14094 @item -march=@var{name}
14095 @opindex march
14096 Specify the name of the target architecture and, optionally, one or
14097 more feature modifiers.  This option has the form
14098 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}.
14100 The permissible values for @var{arch} are @samp{armv8-a},
14101 @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a} or @var{native}.
14103 The value @samp{armv8.3-a} implies @samp{armv8.2-a} and enables compiler
14104 support for the ARMv8.3-A architecture extensions.
14106 The value @samp{armv8.2-a} implies @samp{armv8.1-a} and enables compiler
14107 support for the ARMv8.2-A architecture extensions.
14109 The value @samp{armv8.1-a} implies @samp{armv8-a} and enables compiler
14110 support for the ARMv8.1-A architecture extension.  In particular, it
14111 enables the @samp{+crc}, @samp{+lse}, and @samp{+rdma} features.
14113 The value @samp{native} is available on native AArch64 GNU/Linux and
14114 causes the compiler to pick the architecture of the host system.  This
14115 option has no effect if the compiler is unable to recognize the
14116 architecture of the host system,
14118 The permissible values for @var{feature} are listed in the sub-section
14119 on @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14120 Feature Modifiers}.  Where conflicting feature modifiers are
14121 specified, the right-most feature is used.
14123 GCC uses @var{name} to determine what kind of instructions it can emit
14124 when generating assembly code.  If @option{-march} is specified
14125 without either of @option{-mtune} or @option{-mcpu} also being
14126 specified, the code is tuned to perform well across a range of target
14127 processors implementing the target architecture.
14129 @item -mtune=@var{name}
14130 @opindex mtune
14131 Specify the name of the target processor for which GCC should tune the
14132 performance of the code.  Permissible values for this option are:
14133 @samp{generic}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
14134 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
14135 @samp{exynos-m1}, @samp{falkor}, @samp{qdf24xx},
14136 @samp{xgene1}, @samp{vulcan}, @samp{thunderx},
14137 @samp{thunderxt88}, @samp{thunderxt88p1}, @samp{thunderxt81},
14138 @samp{thunderxt83}, @samp{thunderx2t99}, @samp{cortex-a57.cortex-a53},
14139 @samp{cortex-a72.cortex-a53}, @samp{cortex-a73.cortex-a35},
14140 @samp{cortex-a73.cortex-a53}, @samp{cortex-a75.cortex-a55},
14141 @samp{native}.
14143 The values @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
14144 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53},
14145 @samp{cortex-a75.cortex-a55} specify that GCC should tune for a
14146 big.LITTLE system.
14148 Additionally on native AArch64 GNU/Linux systems the value
14149 @samp{native} tunes performance to the host system.  This option has no effect
14150 if the compiler is unable to recognize the processor of the host system.
14152 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
14153 are specified, the code is tuned to perform well across a range
14154 of target processors.
14156 This option cannot be suffixed by feature modifiers.
14158 @item -mcpu=@var{name}
14159 @opindex mcpu
14160 Specify the name of the target processor, optionally suffixed by one
14161 or more feature modifiers.  This option has the form
14162 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where
14163 the permissible values for @var{cpu} are the same as those available
14164 for @option{-mtune}.  The permissible values for @var{feature} are
14165 documented in the sub-section on
14166 @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14167 Feature Modifiers}.  Where conflicting feature modifiers are
14168 specified, the right-most feature is used.
14170 GCC uses @var{name} to determine what kind of instructions it can emit when
14171 generating assembly code (as if by @option{-march}) and to determine
14172 the target processor for which to tune for performance (as if
14173 by @option{-mtune}).  Where this option is used in conjunction
14174 with @option{-march} or @option{-mtune}, those options take precedence
14175 over the appropriate part of this option.
14177 @item -moverride=@var{string}
14178 @opindex moverride
14179 Override tuning decisions made by the back-end in response to a
14180 @option{-mtune=} switch.  The syntax, semantics, and accepted values
14181 for @var{string} in this option are not guaranteed to be consistent
14182 across releases.
14184 This option is only intended to be useful when developing GCC.
14186 @item -mpc-relative-literal-loads
14187 @itemx -mno-pc-relative-literal-loads
14188 @opindex mpc-relative-literal-loads
14189 @opindex mno-pc-relative-literal-loads
14190 Enable or disable PC-relative literal loads.  With this option literal pools are
14191 accessed using a single instruction and emitted after each function.  This
14192 limits the maximum size of functions to 1MB.  This is enabled by default for
14193 @option{-mcmodel=tiny}.
14195 @item -msign-return-address=@var{scope}
14196 @opindex msign-return-address
14197 Select the function scope on which return address signing will be applied.
14198 Permissible values are @samp{none}, which disables return address signing,
14199 @samp{non-leaf}, which enables pointer signing for functions which are not leaf
14200 functions, and @samp{all}, which enables pointer signing for all functions.  The
14201 default value is @samp{none}.
14203 @end table
14205 @subsubsection @option{-march} and @option{-mcpu} Feature Modifiers
14206 @anchor{aarch64-feature-modifiers}
14207 @cindex @option{-march} feature modifiers
14208 @cindex @option{-mcpu} feature modifiers
14209 Feature modifiers used with @option{-march} and @option{-mcpu} can be any of
14210 the following and their inverses @option{no@var{feature}}:
14212 @table @samp
14213 @item crc
14214 Enable CRC extension.  This is on by default for
14215 @option{-march=armv8.1-a}.
14216 @item crypto
14217 Enable Crypto extension.  This also enables Advanced SIMD and floating-point
14218 instructions.
14219 @item fp
14220 Enable floating-point instructions.  This is on by default for all possible
14221 values for options @option{-march} and @option{-mcpu}.
14222 @item simd
14223 Enable Advanced SIMD instructions.  This also enables floating-point
14224 instructions.  This is on by default for all possible values for options
14225 @option{-march} and @option{-mcpu}.
14226 @item lse
14227 Enable Large System Extension instructions.  This is on by default for
14228 @option{-march=armv8.1-a}.
14229 @item rdma
14230 Enable Round Double Multiply Accumulate instructions.  This is on by default
14231 for @option{-march=armv8.1-a}.
14232 @item fp16
14233 Enable FP16 extension.  This also enables floating-point instructions.
14234 @item rcpc
14235 Enable the RcPc extension.  This does not change code generation from GCC,
14236 but is passed on to the assembler, enabling inline asm statements to use
14237 instructions from the RcPc extension.
14239 @end table
14241 Feature @option{crypto} implies @option{simd}, which implies @option{fp}.
14242 Conversely, @option{nofp} implies @option{nosimd}, which implies
14243 @option{nocrypto}.
14245 @node Adapteva Epiphany Options
14246 @subsection Adapteva Epiphany Options
14248 These @samp{-m} options are defined for Adapteva Epiphany:
14250 @table @gcctabopt
14251 @item -mhalf-reg-file
14252 @opindex mhalf-reg-file
14253 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
14254 That allows code to run on hardware variants that lack these registers.
14256 @item -mprefer-short-insn-regs
14257 @opindex mprefer-short-insn-regs
14258 Preferentially allocate registers that allow short instruction generation.
14259 This can result in increased instruction count, so this may either reduce or
14260 increase overall code size.
14262 @item -mbranch-cost=@var{num}
14263 @opindex mbranch-cost
14264 Set the cost of branches to roughly @var{num} ``simple'' instructions.
14265 This cost is only a heuristic and is not guaranteed to produce
14266 consistent results across releases.
14268 @item -mcmove
14269 @opindex mcmove
14270 Enable the generation of conditional moves.
14272 @item -mnops=@var{num}
14273 @opindex mnops
14274 Emit @var{num} NOPs before every other generated instruction.
14276 @item -mno-soft-cmpsf
14277 @opindex mno-soft-cmpsf
14278 For single-precision floating-point comparisons, emit an @code{fsub} instruction
14279 and test the flags.  This is faster than a software comparison, but can
14280 get incorrect results in the presence of NaNs, or when two different small
14281 numbers are compared such that their difference is calculated as zero.
14282 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
14283 software comparisons.
14285 @item -mstack-offset=@var{num}
14286 @opindex mstack-offset
14287 Set the offset between the top of the stack and the stack pointer.
14288 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
14289 can be used by leaf functions without stack allocation.
14290 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
14291 Note also that this option changes the ABI; compiling a program with a
14292 different stack offset than the libraries have been compiled with
14293 generally does not work.
14294 This option can be useful if you want to evaluate if a different stack
14295 offset would give you better code, but to actually use a different stack
14296 offset to build working programs, it is recommended to configure the
14297 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
14299 @item -mno-round-nearest
14300 @opindex mno-round-nearest
14301 Make the scheduler assume that the rounding mode has been set to
14302 truncating.  The default is @option{-mround-nearest}.
14304 @item -mlong-calls
14305 @opindex mlong-calls
14306 If not otherwise specified by an attribute, assume all calls might be beyond
14307 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
14308 function address into a register before performing a (otherwise direct) call.
14309 This is the default.
14311 @item -mshort-calls
14312 @opindex short-calls
14313 If not otherwise specified by an attribute, assume all direct calls are
14314 in the range of the @code{b} / @code{bl} instructions, so use these instructions
14315 for direct calls.  The default is @option{-mlong-calls}.
14317 @item -msmall16
14318 @opindex msmall16
14319 Assume addresses can be loaded as 16-bit unsigned values.  This does not
14320 apply to function addresses for which @option{-mlong-calls} semantics
14321 are in effect.
14323 @item -mfp-mode=@var{mode}
14324 @opindex mfp-mode
14325 Set the prevailing mode of the floating-point unit.
14326 This determines the floating-point mode that is provided and expected
14327 at function call and return time.  Making this mode match the mode you
14328 predominantly need at function start can make your programs smaller and
14329 faster by avoiding unnecessary mode switches.
14331 @var{mode} can be set to one the following values:
14333 @table @samp
14334 @item caller
14335 Any mode at function entry is valid, and retained or restored when
14336 the function returns, and when it calls other functions.
14337 This mode is useful for compiling libraries or other compilation units
14338 you might want to incorporate into different programs with different
14339 prevailing FPU modes, and the convenience of being able to use a single
14340 object file outweighs the size and speed overhead for any extra
14341 mode switching that might be needed, compared with what would be needed
14342 with a more specific choice of prevailing FPU mode.
14344 @item truncate
14345 This is the mode used for floating-point calculations with
14346 truncating (i.e.@: round towards zero) rounding mode.  That includes
14347 conversion from floating point to integer.
14349 @item round-nearest
14350 This is the mode used for floating-point calculations with
14351 round-to-nearest-or-even rounding mode.
14353 @item int
14354 This is the mode used to perform integer calculations in the FPU, e.g.@:
14355 integer multiply, or integer multiply-and-accumulate.
14356 @end table
14358 The default is @option{-mfp-mode=caller}
14360 @item -mnosplit-lohi
14361 @itemx -mno-postinc
14362 @itemx -mno-postmodify
14363 @opindex mnosplit-lohi
14364 @opindex mno-postinc
14365 @opindex mno-postmodify
14366 Code generation tweaks that disable, respectively, splitting of 32-bit
14367 loads, generation of post-increment addresses, and generation of
14368 post-modify addresses.  The defaults are @option{msplit-lohi},
14369 @option{-mpost-inc}, and @option{-mpost-modify}.
14371 @item -mnovect-double
14372 @opindex mno-vect-double
14373 Change the preferred SIMD mode to SImode.  The default is
14374 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
14376 @item -max-vect-align=@var{num}
14377 @opindex max-vect-align
14378 The maximum alignment for SIMD vector mode types.
14379 @var{num} may be 4 or 8.  The default is 8.
14380 Note that this is an ABI change, even though many library function
14381 interfaces are unaffected if they don't use SIMD vector modes
14382 in places that affect size and/or alignment of relevant types.
14384 @item -msplit-vecmove-early
14385 @opindex msplit-vecmove-early
14386 Split vector moves into single word moves before reload.  In theory this
14387 can give better register allocation, but so far the reverse seems to be
14388 generally the case.
14390 @item -m1reg-@var{reg}
14391 @opindex m1reg-
14392 Specify a register to hold the constant @minus{}1, which makes loading small negative
14393 constants and certain bitmasks faster.
14394 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
14395 which specify use of that register as a fixed register,
14396 and @samp{none}, which means that no register is used for this
14397 purpose.  The default is @option{-m1reg-none}.
14399 @end table
14401 @node ARC Options
14402 @subsection ARC Options
14403 @cindex ARC options
14405 The following options control the architecture variant for which code
14406 is being compiled:
14408 @c architecture variants
14409 @table @gcctabopt
14411 @item -mbarrel-shifter
14412 @opindex mbarrel-shifter
14413 Generate instructions supported by barrel shifter.  This is the default
14414 unless @option{-mcpu=ARC601} or @samp{-mcpu=ARCEM} is in effect.
14416 @item -mcpu=@var{cpu}
14417 @opindex mcpu
14418 Set architecture type, register usage, and instruction scheduling
14419 parameters for @var{cpu}.  There are also shortcut alias options
14420 available for backward compatibility and convenience.  Supported
14421 values for @var{cpu} are
14423 @table @samp
14424 @opindex mA6
14425 @opindex mARC600
14426 @item arc600
14427 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
14429 @item arc601
14430 @opindex mARC601
14431 Compile for ARC601.  Alias: @option{-mARC601}.
14433 @item arc700
14434 @opindex mA7
14435 @opindex mARC700
14436 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
14437 This is the default when configured with @option{--with-cpu=arc700}@.
14439 @item arcem
14440 Compile for ARC EM.
14442 @item archs
14443 Compile for ARC HS.
14445 @item em
14446 Compile for ARC EM CPU with no hardware extensions.
14448 @item em4
14449 Compile for ARC EM4 CPU.
14451 @item em4_dmips
14452 Compile for ARC EM4 DMIPS CPU.
14454 @item em4_fpus
14455 Compile for ARC EM4 DMIPS CPU with the single-precision floating-point
14456 extension.
14458 @item em4_fpuda
14459 Compile for ARC EM4 DMIPS CPU with single-precision floating-point and
14460 double assist instructions.
14462 @item hs
14463 Compile for ARC HS CPU with no hardware extensions except the atomic
14464 instructions.
14466 @item hs34
14467 Compile for ARC HS34 CPU.
14469 @item hs38
14470 Compile for ARC HS38 CPU.
14472 @item hs38_linux
14473 Compile for ARC HS38 CPU with all hardware extensions on.
14475 @item arc600_norm
14476 Compile for ARC 600 CPU with @code{norm} instructions enabled.
14478 @item arc600_mul32x16
14479 Compile for ARC 600 CPU with @code{norm} and 32x16-bit multiply 
14480 instructions enabled.
14482 @item arc600_mul64
14483 Compile for ARC 600 CPU with @code{norm} and @code{mul64}-family 
14484 instructions enabled.
14486 @item arc601_norm
14487 Compile for ARC 601 CPU with @code{norm} instructions enabled.
14489 @item arc601_mul32x16
14490 Compile for ARC 601 CPU with @code{norm} and 32x16-bit multiply
14491 instructions enabled.
14493 @item arc601_mul64
14494 Compile for ARC 601 CPU with @code{norm} and @code{mul64}-family
14495 instructions enabled.
14497 @item nps400
14498 Compile for ARC 700 on NPS400 chip.
14500 @end table
14502 @item -mdpfp
14503 @opindex mdpfp
14504 @itemx -mdpfp-compact
14505 @opindex mdpfp-compact
14506 Generate double-precision FPX instructions, tuned for the compact
14507 implementation.
14509 @item -mdpfp-fast
14510 @opindex mdpfp-fast
14511 Generate double-precision FPX instructions, tuned for the fast
14512 implementation.
14514 @item -mno-dpfp-lrsr
14515 @opindex mno-dpfp-lrsr
14516 Disable @code{lr} and @code{sr} instructions from using FPX extension
14517 aux registers.
14519 @item -mea
14520 @opindex mea
14521 Generate extended arithmetic instructions.  Currently only
14522 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
14523 supported.  This is always enabled for @option{-mcpu=ARC700}.
14525 @item -mno-mpy
14526 @opindex mno-mpy
14527 Do not generate @code{mpy}-family instructions for ARC700.  This option is
14528 deprecated.
14530 @item -mmul32x16
14531 @opindex mmul32x16
14532 Generate 32x16-bit multiply and multiply-accumulate instructions.
14534 @item -mmul64
14535 @opindex mmul64
14536 Generate @code{mul64} and @code{mulu64} instructions.  
14537 Only valid for @option{-mcpu=ARC600}.
14539 @item -mnorm
14540 @opindex mnorm
14541 Generate @code{norm} instructions.  This is the default if @option{-mcpu=ARC700}
14542 is in effect.
14544 @item -mspfp
14545 @opindex mspfp
14546 @itemx -mspfp-compact
14547 @opindex mspfp-compact
14548 Generate single-precision FPX instructions, tuned for the compact
14549 implementation.
14551 @item -mspfp-fast
14552 @opindex mspfp-fast
14553 Generate single-precision FPX instructions, tuned for the fast
14554 implementation.
14556 @item -msimd
14557 @opindex msimd
14558 Enable generation of ARC SIMD instructions via target-specific
14559 builtins.  Only valid for @option{-mcpu=ARC700}.
14561 @item -msoft-float
14562 @opindex msoft-float
14563 This option ignored; it is provided for compatibility purposes only.
14564 Software floating-point code is emitted by default, and this default
14565 can overridden by FPX options; @option{-mspfp}, @option{-mspfp-compact}, or
14566 @option{-mspfp-fast} for single precision, and @option{-mdpfp},
14567 @option{-mdpfp-compact}, or @option{-mdpfp-fast} for double precision.
14569 @item -mswap
14570 @opindex mswap
14571 Generate @code{swap} instructions.
14573 @item -matomic
14574 @opindex matomic
14575 This enables use of the locked load/store conditional extension to implement
14576 atomic memory built-in functions.  Not available for ARC 6xx or ARC
14577 EM cores.
14579 @item -mdiv-rem
14580 @opindex mdiv-rem
14581 Enable @code{div} and @code{rem} instructions for ARCv2 cores.
14583 @item -mcode-density
14584 @opindex mcode-density
14585 Enable code density instructions for ARC EM.  
14586 This option is on by default for ARC HS.
14588 @item -mll64
14589 @opindex mll64
14590 Enable double load/store operations for ARC HS cores.
14592 @item -mtp-regno=@var{regno}
14593 @opindex mtp-regno
14594 Specify thread pointer register number.
14596 @item -mmpy-option=@var{multo}
14597 @opindex mmpy-option
14598 Compile ARCv2 code with a multiplier design option.  You can specify 
14599 the option using either a string or numeric value for @var{multo}.  
14600 @samp{wlh1} is the default value.  The recognized values are:
14602 @table @samp
14603 @item 0
14604 @itemx none
14605 No multiplier available.
14607 @item 1
14608 @itemx w
14609 16x16 multiplier, fully pipelined.
14610 The following instructions are enabled: @code{mpyw} and @code{mpyuw}.
14612 @item 2
14613 @itemx wlh1
14614 32x32 multiplier, fully
14615 pipelined (1 stage).  The following instructions are additionally
14616 enabled: @code{mpy}, @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14618 @item 3
14619 @itemx wlh2
14620 32x32 multiplier, fully pipelined
14621 (2 stages).  The following instructions are additionally enabled: @code{mpy},
14622 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14624 @item 4
14625 @itemx wlh3
14626 Two 16x16 multipliers, blocking,
14627 sequential.  The following instructions are additionally enabled: @code{mpy},
14628 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14630 @item 5
14631 @itemx wlh4
14632 One 16x16 multiplier, blocking,
14633 sequential.  The following instructions are additionally enabled: @code{mpy},
14634 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14636 @item 6
14637 @itemx wlh5
14638 One 32x4 multiplier, blocking,
14639 sequential.  The following instructions are additionally enabled: @code{mpy},
14640 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14642 @item 7
14643 @itemx plus_dmpy
14644 ARC HS SIMD support.
14646 @item 8
14647 @itemx plus_macd
14648 ARC HS SIMD support.
14650 @item 9
14651 @itemx plus_qmacw
14652 ARC HS SIMD support.
14654 @end table
14656 This option is only available for ARCv2 cores@.
14658 @item -mfpu=@var{fpu}
14659 @opindex mfpu
14660 Enables support for specific floating-point hardware extensions for ARCv2
14661 cores.  Supported values for @var{fpu} are:
14663 @table @samp
14665 @item fpus
14666 Enables support for single-precision floating-point hardware
14667 extensions@.
14669 @item fpud
14670 Enables support for double-precision floating-point hardware
14671 extensions.  The single-precision floating-point extension is also
14672 enabled.  Not available for ARC EM@.
14674 @item fpuda
14675 Enables support for double-precision floating-point hardware
14676 extensions using double-precision assist instructions.  The single-precision
14677 floating-point extension is also enabled.  This option is
14678 only available for ARC EM@.
14680 @item fpuda_div
14681 Enables support for double-precision floating-point hardware
14682 extensions using double-precision assist instructions.
14683 The single-precision floating-point, square-root, and divide 
14684 extensions are also enabled.  This option is
14685 only available for ARC EM@.
14687 @item fpuda_fma
14688 Enables support for double-precision floating-point hardware
14689 extensions using double-precision assist instructions.
14690 The single-precision floating-point and fused multiply and add 
14691 hardware extensions are also enabled.  This option is
14692 only available for ARC EM@.
14694 @item fpuda_all
14695 Enables support for double-precision floating-point hardware
14696 extensions using double-precision assist instructions.
14697 All single-precision floating-point hardware extensions are also
14698 enabled.  This option is only available for ARC EM@.
14700 @item fpus_div
14701 Enables support for single-precision floating-point, square-root and divide 
14702 hardware extensions@.
14704 @item fpud_div
14705 Enables support for double-precision floating-point, square-root and divide 
14706 hardware extensions.  This option
14707 includes option @samp{fpus_div}. Not available for ARC EM@.
14709 @item fpus_fma
14710 Enables support for single-precision floating-point and 
14711 fused multiply and add hardware extensions@.
14713 @item fpud_fma
14714 Enables support for double-precision floating-point and 
14715 fused multiply and add hardware extensions.  This option
14716 includes option @samp{fpus_fma}.  Not available for ARC EM@.
14718 @item fpus_all
14719 Enables support for all single-precision floating-point hardware
14720 extensions@.
14722 @item fpud_all
14723 Enables support for all single- and double-precision floating-point
14724 hardware extensions.  Not available for ARC EM@.
14726 @end table
14728 @item -mirq-ctrl-saved=@var{register-range}, @var{blink}, @var{lp_count}
14729 @opindex mirq-ctrl-saved
14730 Specifies general-purposes registers that the processor automatically
14731 saves/restores on interrupt entry and exit.  @var{register-range} is
14732 specified as two registers separated by a dash.  The register range
14733 always starts with @code{r0}, the upper limit is @code{fp} register.
14734 @var{blink} and @var{lp_count} are optional.  This option is only
14735 valid for ARC EM and ARC HS cores.
14737 @item -mrgf-banked-regs=@var{number}
14738 @opindex mrgf-banked-regs
14739 Specifies the number of registers replicated in second register bank
14740 on entry to fast interrupt.  Fast interrupts are interrupts with the
14741 highest priority level P0.  These interrupts save only PC and STATUS32
14742 registers to avoid memory transactions during interrupt entry and exit
14743 sequences.  Use this option when you are using fast interrupts in an
14744 ARC V2 family processor.  Permitted values are 4, 8, 16, and 32.
14746 @end table
14748 The following options are passed through to the assembler, and also
14749 define preprocessor macro symbols.
14751 @c Flags used by the assembler, but for which we define preprocessor
14752 @c macro symbols as well.
14753 @table @gcctabopt
14754 @item -mdsp-packa
14755 @opindex mdsp-packa
14756 Passed down to the assembler to enable the DSP Pack A extensions.
14757 Also sets the preprocessor symbol @code{__Xdsp_packa}.  This option is
14758 deprecated.
14760 @item -mdvbf
14761 @opindex mdvbf
14762 Passed down to the assembler to enable the dual Viterbi butterfly
14763 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.  This
14764 option is deprecated.
14766 @c ARC700 4.10 extension instruction
14767 @item -mlock
14768 @opindex mlock
14769 Passed down to the assembler to enable the locked load/store
14770 conditional extension.  Also sets the preprocessor symbol
14771 @code{__Xlock}.
14773 @item -mmac-d16
14774 @opindex mmac-d16
14775 Passed down to the assembler.  Also sets the preprocessor symbol
14776 @code{__Xxmac_d16}.  This option is deprecated.
14778 @item -mmac-24
14779 @opindex mmac-24
14780 Passed down to the assembler.  Also sets the preprocessor symbol
14781 @code{__Xxmac_24}.  This option is deprecated.
14783 @c ARC700 4.10 extension instruction
14784 @item -mrtsc
14785 @opindex mrtsc
14786 Passed down to the assembler to enable the 64-bit time-stamp counter
14787 extension instruction.  Also sets the preprocessor symbol
14788 @code{__Xrtsc}.  This option is deprecated.
14790 @c ARC700 4.10 extension instruction
14791 @item -mswape
14792 @opindex mswape
14793 Passed down to the assembler to enable the swap byte ordering
14794 extension instruction.  Also sets the preprocessor symbol
14795 @code{__Xswape}.
14797 @item -mtelephony
14798 @opindex mtelephony
14799 Passed down to the assembler to enable dual- and single-operand
14800 instructions for telephony.  Also sets the preprocessor symbol
14801 @code{__Xtelephony}.  This option is deprecated.
14803 @item -mxy
14804 @opindex mxy
14805 Passed down to the assembler to enable the XY memory extension.  Also
14806 sets the preprocessor symbol @code{__Xxy}.
14808 @end table
14810 The following options control how the assembly code is annotated:
14812 @c Assembly annotation options
14813 @table @gcctabopt
14814 @item -misize
14815 @opindex misize
14816 Annotate assembler instructions with estimated addresses.
14818 @item -mannotate-align
14819 @opindex mannotate-align
14820 Explain what alignment considerations lead to the decision to make an
14821 instruction short or long.
14823 @end table
14825 The following options are passed through to the linker:
14827 @c options passed through to the linker
14828 @table @gcctabopt
14829 @item -marclinux
14830 @opindex marclinux
14831 Passed through to the linker, to specify use of the @code{arclinux} emulation.
14832 This option is enabled by default in tool chains built for
14833 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
14834 when profiling is not requested.
14836 @item -marclinux_prof
14837 @opindex marclinux_prof
14838 Passed through to the linker, to specify use of the
14839 @code{arclinux_prof} emulation.  This option is enabled by default in
14840 tool chains built for @w{@code{arc-linux-uclibc}} and
14841 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
14843 @end table
14845 The following options control the semantics of generated code:
14847 @c semantically relevant code generation options
14848 @table @gcctabopt
14849 @item -mlong-calls
14850 @opindex mlong-calls
14851 Generate calls as register indirect calls, thus providing access
14852 to the full 32-bit address range.
14854 @item -mmedium-calls
14855 @opindex mmedium-calls
14856 Don't use less than 25-bit addressing range for calls, which is the
14857 offset available for an unconditional branch-and-link
14858 instruction.  Conditional execution of function calls is suppressed, to
14859 allow use of the 25-bit range, rather than the 21-bit range with
14860 conditional branch-and-link.  This is the default for tool chains built
14861 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
14863 @item -mno-sdata
14864 @opindex mno-sdata
14865 Do not generate sdata references.  This is the default for tool chains
14866 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
14867 targets.
14869 @item -mvolatile-cache
14870 @opindex mvolatile-cache
14871 Use ordinarily cached memory accesses for volatile references.  This is the
14872 default.
14874 @item -mno-volatile-cache
14875 @opindex mno-volatile-cache
14876 Enable cache bypass for volatile references.
14878 @end table
14880 The following options fine tune code generation:
14881 @c code generation tuning options
14882 @table @gcctabopt
14883 @item -malign-call
14884 @opindex malign-call
14885 Do alignment optimizations for call instructions.
14887 @item -mauto-modify-reg
14888 @opindex mauto-modify-reg
14889 Enable the use of pre/post modify with register displacement.
14891 @item -mbbit-peephole
14892 @opindex mbbit-peephole
14893 Enable bbit peephole2.
14895 @item -mno-brcc
14896 @opindex mno-brcc
14897 This option disables a target-specific pass in @file{arc_reorg} to
14898 generate compare-and-branch (@code{br@var{cc}}) instructions.  
14899 It has no effect on
14900 generation of these instructions driven by the combiner pass.
14902 @item -mcase-vector-pcrel
14903 @opindex mcase-vector-pcrel
14904 Use PC-relative switch case tables to enable case table shortening.
14905 This is the default for @option{-Os}.
14907 @item -mcompact-casesi
14908 @opindex mcompact-casesi
14909 Enable compact @code{casesi} pattern.  This is the default for @option{-Os},
14910 and only available for ARCv1 cores.
14912 @item -mno-cond-exec
14913 @opindex mno-cond-exec
14914 Disable the ARCompact-specific pass to generate conditional 
14915 execution instructions.
14917 Due to delay slot scheduling and interactions between operand numbers,
14918 literal sizes, instruction lengths, and the support for conditional execution,
14919 the target-independent pass to generate conditional execution is often lacking,
14920 so the ARC port has kept a special pass around that tries to find more
14921 conditional execution generation opportunities after register allocation,
14922 branch shortening, and delay slot scheduling have been done.  This pass
14923 generally, but not always, improves performance and code size, at the cost of
14924 extra compilation time, which is why there is an option to switch it off.
14925 If you have a problem with call instructions exceeding their allowable
14926 offset range because they are conditionalized, you should consider using
14927 @option{-mmedium-calls} instead.
14929 @item -mearly-cbranchsi
14930 @opindex mearly-cbranchsi
14931 Enable pre-reload use of the @code{cbranchsi} pattern.
14933 @item -mexpand-adddi
14934 @opindex mexpand-adddi
14935 Expand @code{adddi3} and @code{subdi3} at RTL generation time into
14936 @code{add.f}, @code{adc} etc.  This option is deprecated.
14938 @item -mindexed-loads
14939 @opindex mindexed-loads
14940 Enable the use of indexed loads.  This can be problematic because some
14941 optimizers then assume that indexed stores exist, which is not
14942 the case.
14944 @opindex mlra
14945 Enable Local Register Allocation.  This is still experimental for ARC,
14946 so by default the compiler uses standard reload
14947 (i.e. @option{-mno-lra}).
14949 @item -mlra-priority-none
14950 @opindex mlra-priority-none
14951 Don't indicate any priority for target registers.
14953 @item -mlra-priority-compact
14954 @opindex mlra-priority-compact
14955 Indicate target register priority for r0..r3 / r12..r15.
14957 @item -mlra-priority-noncompact
14958 @opindex mlra-priority-noncompact
14959 Reduce target register priority for r0..r3 / r12..r15.
14961 @item -mno-millicode
14962 @opindex mno-millicode
14963 When optimizing for size (using @option{-Os}), prologues and epilogues
14964 that have to save or restore a large number of registers are often
14965 shortened by using call to a special function in libgcc; this is
14966 referred to as a @emph{millicode} call.  As these calls can pose
14967 performance issues, and/or cause linking issues when linking in a
14968 nonstandard way, this option is provided to turn off millicode call
14969 generation.
14971 @item -mmixed-code
14972 @opindex mmixed-code
14973 Tweak register allocation to help 16-bit instruction generation.
14974 This generally has the effect of decreasing the average instruction size
14975 while increasing the instruction count.
14977 @item -mq-class
14978 @opindex mq-class
14979 Enable @samp{q} instruction alternatives.
14980 This is the default for @option{-Os}.
14982 @item -mRcq
14983 @opindex mRcq
14984 Enable @samp{Rcq} constraint handling.  
14985 Most short code generation depends on this.
14986 This is the default.
14988 @item -mRcw
14989 @opindex mRcw
14990 Enable @samp{Rcw} constraint handling.  
14991 Most ccfsm condexec mostly depends on this.
14992 This is the default.
14994 @item -msize-level=@var{level}
14995 @opindex msize-level
14996 Fine-tune size optimization with regards to instruction lengths and alignment.
14997 The recognized values for @var{level} are:
14998 @table @samp
14999 @item 0
15000 No size optimization.  This level is deprecated and treated like @samp{1}.
15002 @item 1
15003 Short instructions are used opportunistically.
15005 @item 2
15006 In addition, alignment of loops and of code after barriers are dropped.
15008 @item 3
15009 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
15011 @end table
15013 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
15014 the behavior when this is not set is equivalent to level @samp{1}.
15016 @item -mtune=@var{cpu}
15017 @opindex mtune
15018 Set instruction scheduling parameters for @var{cpu}, overriding any implied
15019 by @option{-mcpu=}.
15021 Supported values for @var{cpu} are
15023 @table @samp
15024 @item ARC600
15025 Tune for ARC600 CPU.
15027 @item ARC601
15028 Tune for ARC601 CPU.
15030 @item ARC700
15031 Tune for ARC700 CPU with standard multiplier block.
15033 @item ARC700-xmac
15034 Tune for ARC700 CPU with XMAC block.
15036 @item ARC725D
15037 Tune for ARC725D CPU.
15039 @item ARC750D
15040 Tune for ARC750D CPU.
15042 @end table
15044 @item -mmultcost=@var{num}
15045 @opindex mmultcost
15046 Cost to assume for a multiply instruction, with @samp{4} being equal to a
15047 normal instruction.
15049 @item -munalign-prob-threshold=@var{probability}
15050 @opindex munalign-prob-threshold
15051 Set probability threshold for unaligning branches.
15052 When tuning for @samp{ARC700} and optimizing for speed, branches without
15053 filled delay slot are preferably emitted unaligned and long, unless
15054 profiling indicates that the probability for the branch to be taken
15055 is below @var{probability}.  @xref{Cross-profiling}.
15056 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
15058 @end table
15060 The following options are maintained for backward compatibility, but
15061 are now deprecated and will be removed in a future release:
15063 @c Deprecated options
15064 @table @gcctabopt
15066 @item -margonaut
15067 @opindex margonaut
15068 Obsolete FPX.
15070 @item -mbig-endian
15071 @opindex mbig-endian
15072 @itemx -EB
15073 @opindex EB
15074 Compile code for big-endian targets.  Use of these options is now
15075 deprecated.  Big-endian code is supported by configuring GCC to build
15076 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets,
15077 for which big endian is the default.
15079 @item -mlittle-endian
15080 @opindex mlittle-endian
15081 @itemx -EL
15082 @opindex EL
15083 Compile code for little-endian targets.  Use of these options is now
15084 deprecated.  Little-endian code is supported by configuring GCC to build 
15085 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets,
15086 for which little endian is the default.
15088 @item -mbarrel_shifter
15089 @opindex mbarrel_shifter
15090 Replaced by @option{-mbarrel-shifter}.
15092 @item -mdpfp_compact
15093 @opindex mdpfp_compact
15094 Replaced by @option{-mdpfp-compact}.
15096 @item -mdpfp_fast
15097 @opindex mdpfp_fast
15098 Replaced by @option{-mdpfp-fast}.
15100 @item -mdsp_packa
15101 @opindex mdsp_packa
15102 Replaced by @option{-mdsp-packa}.
15104 @item -mEA
15105 @opindex mEA
15106 Replaced by @option{-mea}.
15108 @item -mmac_24
15109 @opindex mmac_24
15110 Replaced by @option{-mmac-24}.
15112 @item -mmac_d16
15113 @opindex mmac_d16
15114 Replaced by @option{-mmac-d16}.
15116 @item -mspfp_compact
15117 @opindex mspfp_compact
15118 Replaced by @option{-mspfp-compact}.
15120 @item -mspfp_fast
15121 @opindex mspfp_fast
15122 Replaced by @option{-mspfp-fast}.
15124 @item -mtune=@var{cpu}
15125 @opindex mtune
15126 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
15127 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
15128 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively.
15130 @item -multcost=@var{num}
15131 @opindex multcost
15132 Replaced by @option{-mmultcost}.
15134 @end table
15136 @node ARM Options
15137 @subsection ARM Options
15138 @cindex ARM options
15140 These @samp{-m} options are defined for the ARM port:
15142 @table @gcctabopt
15143 @item -mabi=@var{name}
15144 @opindex mabi
15145 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
15146 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
15148 @item -mapcs-frame
15149 @opindex mapcs-frame
15150 Generate a stack frame that is compliant with the ARM Procedure Call
15151 Standard for all functions, even if this is not strictly necessary for
15152 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
15153 with this option causes the stack frames not to be generated for
15154 leaf functions.  The default is @option{-mno-apcs-frame}.
15155 This option is deprecated.
15157 @item -mapcs
15158 @opindex mapcs
15159 This is a synonym for @option{-mapcs-frame} and is deprecated.
15161 @ignore
15162 @c not currently implemented
15163 @item -mapcs-stack-check
15164 @opindex mapcs-stack-check
15165 Generate code to check the amount of stack space available upon entry to
15166 every function (that actually uses some stack space).  If there is
15167 insufficient space available then either the function
15168 @code{__rt_stkovf_split_small} or @code{__rt_stkovf_split_big} is
15169 called, depending upon the amount of stack space required.  The runtime
15170 system is required to provide these functions.  The default is
15171 @option{-mno-apcs-stack-check}, since this produces smaller code.
15173 @c not currently implemented
15174 @item -mapcs-reentrant
15175 @opindex mapcs-reentrant
15176 Generate reentrant, position-independent code.  The default is
15177 @option{-mno-apcs-reentrant}.
15178 @end ignore
15180 @item -mthumb-interwork
15181 @opindex mthumb-interwork
15182 Generate code that supports calling between the ARM and Thumb
15183 instruction sets.  Without this option, on pre-v5 architectures, the
15184 two instruction sets cannot be reliably used inside one program.  The
15185 default is @option{-mno-thumb-interwork}, since slightly larger code
15186 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
15187 configurations this option is meaningless.
15189 @item -mno-sched-prolog
15190 @opindex mno-sched-prolog
15191 Prevent the reordering of instructions in the function prologue, or the
15192 merging of those instruction with the instructions in the function's
15193 body.  This means that all functions start with a recognizable set
15194 of instructions (or in fact one of a choice from a small set of
15195 different function prologues), and this information can be used to
15196 locate the start of functions inside an executable piece of code.  The
15197 default is @option{-msched-prolog}.
15199 @item -mfloat-abi=@var{name}
15200 @opindex mfloat-abi
15201 Specifies which floating-point ABI to use.  Permissible values
15202 are: @samp{soft}, @samp{softfp} and @samp{hard}.
15204 Specifying @samp{soft} causes GCC to generate output containing
15205 library calls for floating-point operations.
15206 @samp{softfp} allows the generation of code using hardware floating-point
15207 instructions, but still uses the soft-float calling conventions.
15208 @samp{hard} allows generation of floating-point instructions
15209 and uses FPU-specific calling conventions.
15211 The default depends on the specific target configuration.  Note that
15212 the hard-float and soft-float ABIs are not link-compatible; you must
15213 compile your entire program with the same ABI, and link with a
15214 compatible set of libraries.
15216 @item -mlittle-endian
15217 @opindex mlittle-endian
15218 Generate code for a processor running in little-endian mode.  This is
15219 the default for all standard configurations.
15221 @item -mbig-endian
15222 @opindex mbig-endian
15223 Generate code for a processor running in big-endian mode; the default is
15224 to compile code for a little-endian processor.
15226 @item -mbe8
15227 @itemx -mbe32
15228 @opindex mbe8
15229 When linking a big-endian image select between BE8 and BE32 formats.
15230 The option has no effect for little-endian images and is ignored.  The
15231 default is dependent on the selected target architecture.  For ARMv6
15232 and later architectures the default is BE8, for older architectures
15233 the default is BE32.  BE32 format has been deprecated by ARM.
15235 @item -march=@var{name}@r{[}+extension@dots{}@r{]}
15236 @opindex march
15237 This specifies the name of the target ARM architecture.  GCC uses this
15238 name to determine what kind of instructions it can emit when generating
15239 assembly code.  This option can be used in conjunction with or instead
15240 of the @option{-mcpu=} option.
15242 Permissible names are:
15243 @samp{armv4t},
15244 @samp{armv5t}, @samp{armv5te},
15245 @samp{armv6}, @samp{armv6j}, @samp{armv6k}, @samp{armv6kz}, @samp{armv6t2},
15246 @samp{armv6z}, @samp{armv6zk},
15247 @samp{armv7}, @samp{armv7-a}, @samp{armv7ve}, 
15248 @samp{armv8-a}, @samp{armv8.1-a}, @samp{armv8.2-a},
15249 @samp{armv7-r},
15250 @samp{armv8-r},
15251 @samp{armv6-m}, @samp{armv6s-m},
15252 @samp{armv7-m}, @samp{armv7e-m},
15253 @samp{armv8-m.base}, @samp{armv8-m.main},
15254 @samp{iwmmxt} and @samp{iwmmxt2}.
15256 Additionally, the following architectures, which lack support for the
15257 Thumb exection state, are recognized but support is deprecated:
15258 @samp{armv2}, @samp{armv2a}, @samp{armv3}, @samp{armv3m},
15259 @samp{armv4}, @samp{armv5} and @samp{armv5e}.
15261 Many of the architectures support extensions.  These can be added by
15262 appending @samp{+@var{extension}} to the architecture name.  Extension
15263 options are processed in order and capabilities accumulate.  An extension
15264 will also enable any necessary base extensions
15265 upon which it depends.  For example, the @samp{+crypto} extension
15266 will always enable the @samp{+simd} extension.  The exception to the
15267 additive construction is for extensions that are prefixed with
15268 @samp{+no@dots{}}: these extensions disable the specified option and
15269 any other extensions that may depend on the presence of that
15270 extension.
15272 For example, @samp{-march=armv7-a+simd+nofp+vfpv4} is equivalent to
15273 writing @samp{-march=armv7-a+vfpv4} since the @samp{+simd} option is
15274 entirely disabled by the @samp{+nofp} option that follows it.
15276 Most extension names are generically named, but have an effect that is
15277 dependent upon the architecture to which it is applied.  For example,
15278 the @samp{+simd} option can be applied to both @samp{armv7-a} and
15279 @samp{armv8-a} architectures, but will enable the original ARMv7
15280 Advanced SIMD (Neon) extensions for @samp{armv7-a} and the ARMv8-a
15281 variant for @samp{armv8-a}.
15283 The table below lists the supported extensions for each architecture.
15284 Architectures not mentioned do not support any extensions.
15286 @table @samp
15287 @item  armv5e
15288 @itemx armv5te
15289 @itemx armv6
15290 @itemx armv6j
15291 @itemx armv6k
15292 @itemx armv6kz
15293 @itemx armv6t2
15294 @itemx armv6z
15295 @itemx armv6zk
15296 @table @samp
15297 @item +fp
15298 The VFPv2 floating-point instructions.  The extension @samp{+vfpv2} can be
15299 used as an alias for this extension.
15301 @item +nofp
15302 Disable the floating-point instructions.
15303 @end table
15305 @item armv7
15306 The common subset of the ARMv7-A, ARMv7-R and ARMv7-M architectures.
15307 @table @samp
15308 @item +fp
15309 The VFPv3 floating-point instructions, with 16 double-precision
15310 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
15311 for this extension.  Note that floating-point is not supported by the
15312 base ARMv7-M architecture, but is compatible with both the ARMv7-A and
15313 ARMv7-R architectures.
15315 @item +nofp
15316 Disable the floating-point instructions.
15317 @end table
15319 @item armv7-a
15320 @table @samp
15321 @item +fp
15322 The VFPv3 floating-point instructions, with 16 double-precision
15323 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
15324 for this extension.
15326 @item +simd
15327 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
15328 The extensions @samp{+neon} and @samp{+neon-vfpv3} can be used as aliases
15329 for this extension.
15331 @item +vfpv3
15332 The VFPv3 floating-point instructions, with 32 double-precision
15333 registers.
15335 @item +vfpv3-d16-fp16
15336 The VFPv3 floating-point instructions, with 16 double-precision
15337 registers and the half-precision floating-point conversion operations.
15339 @item +vfpv3-fp16
15340 The VFPv3 floating-point instructions, with 32 double-precision
15341 registers and the half-precision floating-point conversion operations.
15343 @item +vfpv4-d16
15344 The VFPv4 floating-point instructions, with 16 double-precision
15345 registers.
15347 @item +vfpv4
15348 The VFPv4 floating-point instructions, with 32 double-precision
15349 registers.
15351 @item +neon-fp16
15352 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
15353 the half-precision floating-point conversion operations.
15355 @item +neon-vfpv4
15356 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.
15358 @item +nosimd
15359 Disable the Advanced SIMD instructions (does not disable floating point).
15361 @item +nofp
15362 Disable the floating-point and Advanced SIMD instructions.
15363 @end table
15365 @item armv7ve
15366 The extended version of the ARMv7-A architecture with support for
15367 virtualization.
15368 @table @samp
15369 @item +fp
15370 The VFPv4 floating-point instructions, with 16 double-precision registers.
15371 The extension @samp{+vfpv4-d16} can be used as an alias for this extension.
15373 @item +simd
15374 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.  The
15375 extension @samp{+neon-vfpv4} can be used as an alias for this extension.
15377 @item +vfpv3-d16
15378 The VFPv3 floating-point instructions, with 16 double-precision
15379 registers.
15381 @item +vfpv3
15382 The VFPv3 floating-point instructions, with 32 double-precision
15383 registers.
15385 @item +vfpv3-d16-fp16
15386 The VFPv3 floating-point instructions, with 16 double-precision
15387 registers and the half-precision floating-point conversion operations.
15389 @item +vfpv3-fp16
15390 The VFPv3 floating-point instructions, with 32 double-precision
15391 registers and the half-precision floating-point conversion operations.
15393 @item +vfpv4-d16
15394 The VFPv4 floating-point instructions, with 16 double-precision
15395 registers.
15397 @item +vfpv4
15398 The VFPv4 floating-point instructions, with 32 double-precision
15399 registers.
15401 @item +neon
15402 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
15403 The extension @samp{+neon-vfpv3} can be used as an alias for this extension.
15405 @item +neon-fp16
15406 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
15407 the half-precision floating-point conversion operations.
15409 @item +nosimd
15410 Disable the Advanced SIMD instructions (does not disable floating point).
15412 @item +nofp
15413 Disable the floating-point and Advanced SIMD instructions.
15414 @end table
15416 @item armv8-a
15417 @table @samp
15418 @item +crc
15419 The Cyclic Redundancy Check (CRC) instructions.
15420 @item +simd
15421 The ARMv8 Advanced SIMD and floating-point instructions.
15422 @item +crypto
15423 The cryptographic instructions.
15424 @item +nocrypto
15425 Disable the cryptographic isntructions.
15426 @item +nofp
15427 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15428 @end table
15430 @item armv8.1-a
15431 @table @samp
15432 @item +simd
15433 The ARMv8.1 Advanced SIMD and floating-point instructions.
15435 @item +crypto
15436 The cryptographic instructions.  This also enables the Advanced SIMD and
15437 floating-point instructions.
15439 @item +nocrypto
15440 Disable the cryptographic isntructions.
15442 @item +nofp
15443 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15444 @end table
15446 @item armv8.2-a
15447 @table @samp
15448 @item +fp16
15449 The half-precision floating-point data processing instructions.
15450 This also enables the Advanced SIMD and floating-point instructions.
15452 @item +simd
15453 The ARMv8.1 Advanced SIMD and floating-point instructions.
15455 @item +crypto
15456 The cryptographic instructions.  This also enables the Advanced SIMD and
15457 floating-point instructions.
15459 @item +nocrypto
15460 Disable the cryptographic extension.
15462 @item +nofp
15463 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15464 @end table
15466 @item armv7-r
15467 @table @samp
15468 @item +fp.sp
15469 The single-precision VFPv3 floating-point instructions.  The extension
15470 @samp{+vfpv3xd} can be used as an alias for this extension.
15472 @item +fp
15473 The VFPv3 floating-point instructions with 16 double-precision registers.
15474 The extension +vfpv3-d16 can be used as an alias for this extension.
15476 @item +nofp
15477 Disable the floating-point extension.
15479 @item +idiv
15480 The ARM-state integer division instructions.
15482 @item +noidiv
15483 Disable the ARM-state integer division extension.
15484 @end table
15486 @item armv7e-m
15487 @table @samp
15488 @item +fp
15489 The single-precision VFPv4 floating-point instructions.
15491 @item +fpv5
15492 The single-precision FPv5 floating-point instructions.
15494 @item +fp.dp
15495 The single- and double-precision FPv5 floating-point instructions.
15497 @item +nofp
15498 Disable the floating-point extensions.
15499 @end table
15501 @item  armv8-m.main
15502 @table @samp
15503 @item +dsp
15504 The DSP instructions.
15506 @item +nodsp
15507 Disable the DSP extension.
15509 @item +fp
15510 The single-precision floating-point instructions.
15512 @item +fp.dp
15513 The single- and double-precision floating-point instructions.
15515 @item +nofp
15516 Disable the floating-point extension.
15517 @end table
15519 @item armv8-r
15520 @table @samp
15521 @item +crc
15522 The Cyclic Redundancy Check (CRC) instructions.
15523 @item +fp.sp
15524 The single-precision FPv5 floating-point instructions.
15525 @item +simd
15526 The ARMv8 Advanced SIMD and floating-point instructions.
15527 @item +crypto
15528 The cryptographic instructions.
15529 @item +nocrypto
15530 Disable the cryptographic isntructions.
15531 @item +nofp
15532 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15533 @end table
15535 @end table
15537 @option{-march=native} causes the compiler to auto-detect the architecture
15538 of the build computer.  At present, this feature is only supported on
15539 GNU/Linux, and not all architectures are recognized.  If the auto-detect
15540 is unsuccessful the option has no effect.
15542 @item -mtune=@var{name}
15543 @opindex mtune
15544 This option specifies the name of the target ARM processor for
15545 which GCC should tune the performance of the code.
15546 For some ARM implementations better performance can be obtained by using
15547 this option.
15548 Permissible names are: @samp{arm2}, @samp{arm250},
15549 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
15550 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
15551 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
15552 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
15553 @samp{arm720},
15554 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
15555 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
15556 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
15557 @samp{strongarm1110},
15558 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
15559 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
15560 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
15561 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
15562 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
15563 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
15564 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
15565 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8},
15566 @samp{cortex-a9}, @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a17},
15567 @samp{cortex-a32}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
15568 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
15569 @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7},
15570 @samp{cortex-r8}, @samp{cortex-r52},
15571 @samp{cortex-m33},
15572 @samp{cortex-m23},
15573 @samp{cortex-m7},
15574 @samp{cortex-m4},
15575 @samp{cortex-m3},
15576 @samp{cortex-m1},
15577 @samp{cortex-m0},
15578 @samp{cortex-m0plus},
15579 @samp{cortex-m1.small-multiply},
15580 @samp{cortex-m0.small-multiply},
15581 @samp{cortex-m0plus.small-multiply},
15582 @samp{exynos-m1},
15583 @samp{marvell-pj4},
15584 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
15585 @samp{fa526}, @samp{fa626},
15586 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te},
15587 @samp{xgene1}.
15589 Additionally, this option can specify that GCC should tune the performance
15590 of the code for a big.LITTLE system.  Permissible names are:
15591 @samp{cortex-a15.cortex-a7}, @samp{cortex-a17.cortex-a7},
15592 @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
15593 @samp{cortex-a72.cortex-a35}, @samp{cortex-a73.cortex-a53},
15594 @samp{cortex-a75.cortex-a55}.
15596 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
15597 performance for a blend of processors within architecture @var{arch}.
15598 The aim is to generate code that run well on the current most popular
15599 processors, balancing between optimizations that benefit some CPUs in the
15600 range, and avoiding performance pitfalls of other CPUs.  The effects of
15601 this option may change in future GCC versions as CPU models come and go.
15603 @option{-mtune} permits the same extension options as @option{-mcpu}, but
15604 the extension options do not affect the tuning of the generated code.
15606 @option{-mtune=native} causes the compiler to auto-detect the CPU
15607 of the build computer.  At present, this feature is only supported on
15608 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
15609 unsuccessful the option has no effect.
15611 @item -mcpu=@var{name}@r{[}+extension@dots{}@r{]}
15612 @opindex mcpu
15613 This specifies the name of the target ARM processor.  GCC uses this name
15614 to derive the name of the target ARM architecture (as if specified
15615 by @option{-march}) and the ARM processor type for which to tune for
15616 performance (as if specified by @option{-mtune}).  Where this option
15617 is used in conjunction with @option{-march} or @option{-mtune},
15618 those options take precedence over the appropriate part of this option.
15620 Many of the supported CPUs implement optional architectural
15621 extensions.  Where this is so the architectural extensions are
15622 normally enabled by default.  If implementations that lack the
15623 extension exist, then the extension syntax can be used to disable
15624 those extensions that have been omitted.  For floating-point and
15625 Advanced SIMD (Neon) instructions, the settings of the options
15626 @option{-mfloat-abi} and @option{-mfpu} must also be considered:
15627 floating-point and Advanced SIMD instructions will only be used if
15628 @option{-mfloat-abi} is not set to @samp{soft}; and any setting of
15629 @option{-mfpu} other than @samp{auto} will override the available
15630 floating-point and SIMD extension instructions.
15632 For example, @samp{cortex-a9} can be found in three major
15633 configurations: integer only, with just a floating-point unit or with
15634 floating-point and Advanced SIMD.  The default is to enable all the
15635 instructions, but the extensions @samp{+nosimd} and @samp{+nofp} can
15636 be used to disable just the SIMD or both the SIMD and floating-point
15637 instructions respectively.
15639 Permissible names for this option are the same as those for
15640 @option{-mtune}.
15642 The following extension options are common to the listed CPUs:
15644 @table @samp
15645 @item  +nofp
15646 Disables the floating-point instructions on @samp{arm9e},
15647 @samp{arm946e-s}, @samp{arm966e-s}, @samp{arm968e-s}, @samp{arm10e},
15648 @samp{arm1020e}, @samp{arm1022e}, @samp{arm926ej-s},
15649 @samp{arm1026ej-s}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-r8},
15650 @samp{cortex-m4}, @samp{cortex-m7} and @samp{cortex-m33}.
15651 Disables the floating-point and SIMD instructions on
15652 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7},
15653 @samp{cortex-a8}, @samp{cortex-a9}, @samp{cortex-a12},
15654 @samp{cortex-a15}, @samp{cortex-a17}, @samp{cortex-a15.cortex-a7},
15655 @samp{cortex-a17.cortex-a7}, @samp{cortex-a32}, @samp{cortex-a35},
15656 @samp{cortex-a53} and @samp{cortex-a55}.
15658 @item +nofp.dp
15659 Disables the double-precision component of the floating-point instructions
15660 on @samp{cortex-r5}, @samp{cortex-r52} and @samp{cortex-m7}.
15662 @item +nosimd
15663 Disables the SIMD (but not floating-point) instructions on
15664 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}
15665 and @samp{cortex-a9}.
15667 @item +crypto
15668 Enables the cryptographic instructions on @samp{cortex-a32},
15669 @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55}, @samp{cortex-a57},
15670 @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75}, @samp{exynos-m1},
15671 @samp{xgene1}, @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
15672 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53} and
15673 @samp{cortex-a75.cortex-a55}.
15674 @end table
15676 Additionally the @samp{generic-armv7-a} pseudo target defaults to
15677 VFPv3 with 16 double-precision registers.  It supports the following
15678 extension options: @samp{vfpv3-d16}, @samp{vfpv3},
15679 @samp{vfpv3-d16-fp16}, @samp{vfpv3-fp16}, @samp{vfpv4-d16},
15680 @samp{vfpv4}, @samp{neon}, @samp{neon-vfpv3}, @samp{neon-fp16},
15681 @samp{neon-vfpv4}.  The meanings are the same as for the extensions to
15682 @option{-march=armv7-a}.
15684 @option{-mcpu=generic-@var{arch}} is also permissible, and is
15685 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
15686 See @option{-mtune} for more information.
15688 @option{-mcpu=native} causes the compiler to auto-detect the CPU
15689 of the build computer.  At present, this feature is only supported on
15690 GNU/Linux, and not all architectures are recognized.  If the auto-detect
15691 is unsuccessful the option has no effect.
15693 @item -mfpu=@var{name}
15694 @opindex mfpu
15695 This specifies what floating-point hardware (or hardware emulation) is
15696 available on the target.  Permissible names are: @samp{auto}, @samp{vfpv2},
15697 @samp{vfpv3},
15698 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
15699 @samp{vfpv3xd-fp16}, @samp{neon-vfpv3}, @samp{neon-fp16}, @samp{vfpv4},
15700 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
15701 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
15702 @samp{fp-armv8}, @samp{neon-fp-armv8} and @samp{crypto-neon-fp-armv8}.
15703 Note that @samp{neon} is an alias for @samp{neon-vfpv3} and @samp{vfp}
15704 is an alias for @samp{vfpv2}.
15706 The setting @samp{auto} is the default and is special.  It causes the
15707 compiler to select the floating-point and Advanced SIMD instructions
15708 based on the settings of @option{-mcpu} and @option{-march}.
15710 If the selected floating-point hardware includes the NEON extension
15711 (e.g. @option{-mfpu=neon}), note that floating-point
15712 operations are not generated by GCC's auto-vectorization pass unless
15713 @option{-funsafe-math-optimizations} is also specified.  This is
15714 because NEON hardware does not fully implement the IEEE 754 standard for
15715 floating-point arithmetic (in particular denormal values are treated as
15716 zero), so the use of NEON instructions may lead to a loss of precision.
15718 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}).
15720 @item -mfp16-format=@var{name}
15721 @opindex mfp16-format
15722 Specify the format of the @code{__fp16} half-precision floating-point type.
15723 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
15724 the default is @samp{none}, in which case the @code{__fp16} type is not
15725 defined.  @xref{Half-Precision}, for more information.
15727 @item -mstructure-size-boundary=@var{n}
15728 @opindex mstructure-size-boundary
15729 The sizes of all structures and unions are rounded up to a multiple
15730 of the number of bits set by this option.  Permissible values are 8, 32
15731 and 64.  The default value varies for different toolchains.  For the COFF
15732 targeted toolchain the default value is 8.  A value of 64 is only allowed
15733 if the underlying ABI supports it.
15735 Specifying a larger number can produce faster, more efficient code, but
15736 can also increase the size of the program.  Different values are potentially
15737 incompatible.  Code compiled with one value cannot necessarily expect to
15738 work with code or libraries compiled with another value, if they exchange
15739 information using structures or unions.
15741 This option is deprecated.
15743 @item -mabort-on-noreturn
15744 @opindex mabort-on-noreturn
15745 Generate a call to the function @code{abort} at the end of a
15746 @code{noreturn} function.  It is executed if the function tries to
15747 return.
15749 @item -mlong-calls
15750 @itemx -mno-long-calls
15751 @opindex mlong-calls
15752 @opindex mno-long-calls
15753 Tells the compiler to perform function calls by first loading the
15754 address of the function into a register and then performing a subroutine
15755 call on this register.  This switch is needed if the target function
15756 lies outside of the 64-megabyte addressing range of the offset-based
15757 version of subroutine call instruction.
15759 Even if this switch is enabled, not all function calls are turned
15760 into long calls.  The heuristic is that static functions, functions
15761 that have the @code{short_call} attribute, functions that are inside
15762 the scope of a @code{#pragma no_long_calls} directive, and functions whose
15763 definitions have already been compiled within the current compilation
15764 unit are not turned into long calls.  The exceptions to this rule are
15765 that weak function definitions, functions with the @code{long_call}
15766 attribute or the @code{section} attribute, and functions that are within
15767 the scope of a @code{#pragma long_calls} directive are always
15768 turned into long calls.
15770 This feature is not enabled by default.  Specifying
15771 @option{-mno-long-calls} restores the default behavior, as does
15772 placing the function calls within the scope of a @code{#pragma
15773 long_calls_off} directive.  Note these switches have no effect on how
15774 the compiler generates code to handle function calls via function
15775 pointers.
15777 @item -msingle-pic-base
15778 @opindex msingle-pic-base
15779 Treat the register used for PIC addressing as read-only, rather than
15780 loading it in the prologue for each function.  The runtime system is
15781 responsible for initializing this register with an appropriate value
15782 before execution begins.
15784 @item -mpic-register=@var{reg}
15785 @opindex mpic-register
15786 Specify the register to be used for PIC addressing.
15787 For standard PIC base case, the default is any suitable register
15788 determined by compiler.  For single PIC base case, the default is
15789 @samp{R9} if target is EABI based or stack-checking is enabled,
15790 otherwise the default is @samp{R10}.
15792 @item -mpic-data-is-text-relative
15793 @opindex mpic-data-is-text-relative
15794 Assume that the displacement between the text and data segments is fixed
15795 at static link time.  This permits using PC-relative addressing
15796 operations to access data known to be in the data segment.  For
15797 non-VxWorks RTP targets, this option is enabled by default.  When
15798 disabled on such targets, it will enable @option{-msingle-pic-base} by
15799 default.
15801 @item -mpoke-function-name
15802 @opindex mpoke-function-name
15803 Write the name of each function into the text section, directly
15804 preceding the function prologue.  The generated code is similar to this:
15806 @smallexample
15807      t0
15808          .ascii "arm_poke_function_name", 0
15809          .align
15810      t1
15811          .word 0xff000000 + (t1 - t0)
15812      arm_poke_function_name
15813          mov     ip, sp
15814          stmfd   sp!, @{fp, ip, lr, pc@}
15815          sub     fp, ip, #4
15816 @end smallexample
15818 When performing a stack backtrace, code can inspect the value of
15819 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
15820 location @code{pc - 12} and the top 8 bits are set, then we know that
15821 there is a function name embedded immediately preceding this location
15822 and has length @code{((pc[-3]) & 0xff000000)}.
15824 @item -mthumb
15825 @itemx -marm
15826 @opindex marm
15827 @opindex mthumb
15829 Select between generating code that executes in ARM and Thumb
15830 states.  The default for most configurations is to generate code
15831 that executes in ARM state, but the default can be changed by
15832 configuring GCC with the @option{--with-mode=}@var{state}
15833 configure option.
15835 You can also override the ARM and Thumb mode for each function
15836 by using the @code{target("thumb")} and @code{target("arm")} function attributes
15837 (@pxref{ARM Function Attributes}) or pragmas (@pxref{Function Specific Option Pragmas}).
15839 @item -mtpcs-frame
15840 @opindex mtpcs-frame
15841 Generate a stack frame that is compliant with the Thumb Procedure Call
15842 Standard for all non-leaf functions.  (A leaf function is one that does
15843 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
15845 @item -mtpcs-leaf-frame
15846 @opindex mtpcs-leaf-frame
15847 Generate a stack frame that is compliant with the Thumb Procedure Call
15848 Standard for all leaf functions.  (A leaf function is one that does
15849 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
15851 @item -mcallee-super-interworking
15852 @opindex mcallee-super-interworking
15853 Gives all externally visible functions in the file being compiled an ARM
15854 instruction set header which switches to Thumb mode before executing the
15855 rest of the function.  This allows these functions to be called from
15856 non-interworking code.  This option is not valid in AAPCS configurations
15857 because interworking is enabled by default.
15859 @item -mcaller-super-interworking
15860 @opindex mcaller-super-interworking
15861 Allows calls via function pointers (including virtual functions) to
15862 execute correctly regardless of whether the target code has been
15863 compiled for interworking or not.  There is a small overhead in the cost
15864 of executing a function pointer if this option is enabled.  This option
15865 is not valid in AAPCS configurations because interworking is enabled
15866 by default.
15868 @item -mtp=@var{name}
15869 @opindex mtp
15870 Specify the access model for the thread local storage pointer.  The valid
15871 models are @samp{soft}, which generates calls to @code{__aeabi_read_tp},
15872 @samp{cp15}, which fetches the thread pointer from @code{cp15} directly
15873 (supported in the arm6k architecture), and @samp{auto}, which uses the
15874 best available method for the selected processor.  The default setting is
15875 @samp{auto}.
15877 @item -mtls-dialect=@var{dialect}
15878 @opindex mtls-dialect
15879 Specify the dialect to use for accessing thread local storage.  Two
15880 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
15881 @samp{gnu} dialect selects the original GNU scheme for supporting
15882 local and global dynamic TLS models.  The @samp{gnu2} dialect
15883 selects the GNU descriptor scheme, which provides better performance
15884 for shared libraries.  The GNU descriptor scheme is compatible with
15885 the original scheme, but does require new assembler, linker and
15886 library support.  Initial and local exec TLS models are unaffected by
15887 this option and always use the original scheme.
15889 @item -mword-relocations
15890 @opindex mword-relocations
15891 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
15892 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
15893 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
15894 is specified.
15896 @item -mfix-cortex-m3-ldrd
15897 @opindex mfix-cortex-m3-ldrd
15898 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
15899 with overlapping destination and base registers are used.  This option avoids
15900 generating these instructions.  This option is enabled by default when
15901 @option{-mcpu=cortex-m3} is specified.
15903 @item -munaligned-access
15904 @itemx -mno-unaligned-access
15905 @opindex munaligned-access
15906 @opindex mno-unaligned-access
15907 Enables (or disables) reading and writing of 16- and 32- bit values
15908 from addresses that are not 16- or 32- bit aligned.  By default
15909 unaligned access is disabled for all pre-ARMv6, all ARMv6-M and for
15910 ARMv8-M Baseline architectures, and enabled for all other
15911 architectures.  If unaligned access is not enabled then words in packed
15912 data structures are accessed a byte at a time.
15914 The ARM attribute @code{Tag_CPU_unaligned_access} is set in the
15915 generated object file to either true or false, depending upon the
15916 setting of this option.  If unaligned access is enabled then the
15917 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} is also
15918 defined.
15920 @item -mneon-for-64bits
15921 @opindex mneon-for-64bits
15922 Enables using Neon to handle scalar 64-bits operations. This is
15923 disabled by default since the cost of moving data from core registers
15924 to Neon is high.
15926 @item -mslow-flash-data
15927 @opindex mslow-flash-data
15928 Assume loading data from flash is slower than fetching instruction.
15929 Therefore literal load is minimized for better performance.
15930 This option is only supported when compiling for ARMv7 M-profile and
15931 off by default.
15933 @item -masm-syntax-unified
15934 @opindex masm-syntax-unified
15935 Assume inline assembler is using unified asm syntax.  The default is
15936 currently off which implies divided syntax.  This option has no impact
15937 on Thumb2. However, this may change in future releases of GCC.
15938 Divided syntax should be considered deprecated.
15940 @item -mrestrict-it
15941 @opindex mrestrict-it
15942 Restricts generation of IT blocks to conform to the rules of ARMv8.
15943 IT blocks can only contain a single 16-bit instruction from a select
15944 set of instructions. This option is on by default for ARMv8 Thumb mode.
15946 @item -mprint-tune-info
15947 @opindex mprint-tune-info
15948 Print CPU tuning information as comment in assembler file.  This is
15949 an option used only for regression testing of the compiler and not
15950 intended for ordinary use in compiling code.  This option is disabled
15951 by default.
15953 @item -mpure-code
15954 @opindex mpure-code
15955 Do not allow constant data to be placed in code sections.
15956 Additionally, when compiling for ELF object format give all text sections the
15957 ELF processor-specific section attribute @code{SHF_ARM_PURECODE}.  This option
15958 is only available when generating non-pic code for M-profile targets with the
15959 MOVT instruction.
15961 @item -mcmse
15962 @opindex mcmse
15963 Generate secure code as per the "ARMv8-M Security Extensions: Requirements on
15964 Development Tools Engineering Specification", which can be found on
15965 @url{http://infocenter.arm.com/help/topic/com.arm.doc.ecm0359818/ECM0359818_armv8m_security_extensions_reqs_on_dev_tools_1_0.pdf}.
15966 @end table
15968 @node AVR Options
15969 @subsection AVR Options
15970 @cindex AVR Options
15972 These options are defined for AVR implementations:
15974 @table @gcctabopt
15975 @item -mmcu=@var{mcu}
15976 @opindex mmcu
15977 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
15979 The default for this option is@tie{}@samp{avr2}.
15981 GCC supports the following AVR devices and ISAs:
15983 @include avr-mmcu.texi
15985 @item -mabsdata
15986 @opindex mabsdata
15988 Assume that all data in static storage can be accessed by LDS / STS
15989 instructions.  This option has only an effect on reduced Tiny devices like
15990 ATtiny40.  See also the @code{absdata}
15991 @ref{AVR Variable Attributes,variable attribute}.
15993 @item -maccumulate-args
15994 @opindex maccumulate-args
15995 Accumulate outgoing function arguments and acquire/release the needed
15996 stack space for outgoing function arguments once in function
15997 prologue/epilogue.  Without this option, outgoing arguments are pushed
15998 before calling a function and popped afterwards.
16000 Popping the arguments after the function call can be expensive on
16001 AVR so that accumulating the stack space might lead to smaller
16002 executables because arguments need not be removed from the
16003 stack after such a function call.
16005 This option can lead to reduced code size for functions that perform
16006 several calls to functions that get their arguments on the stack like
16007 calls to printf-like functions.
16009 @item -mbranch-cost=@var{cost}
16010 @opindex mbranch-cost
16011 Set the branch costs for conditional branch instructions to
16012 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
16013 integers. The default branch cost is 0.
16015 @item -mcall-prologues
16016 @opindex mcall-prologues
16017 Functions prologues/epilogues are expanded as calls to appropriate
16018 subroutines.  Code size is smaller.
16020 @item -mgas-isr-prologues
16021 @opindex mgas-isr-prologues
16022 Interrupt service routines (ISRs) may use the @code{__gcc_isr} pseudo
16023 instruction supported by GNU Binutils.
16024 If this option is on, the feature can still be disabled for individual
16025 ISRs by means of the @ref{AVR Function Attributes,,@code{no_gccisr}}
16026 function attribute.  This feature is activated per default
16027 if optimization is on (but not with @option{-Og}, @pxref{Optimize Options}),
16028 and if GNU Binutils support @w{@uref{https://sourceware.org/PR21683,PR21683}}.
16030 @item -mint8
16031 @opindex mint8
16032 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
16033 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
16034 and @code{long long} is 4 bytes.  Please note that this option does not
16035 conform to the C standards, but it results in smaller code
16036 size.
16038 @item -mn-flash=@var{num}
16039 @opindex mn-flash
16040 Assume that the flash memory has a size of 
16041 @var{num} times 64@tie{}KiB.
16043 @item -mno-interrupts
16044 @opindex mno-interrupts
16045 Generated code is not compatible with hardware interrupts.
16046 Code size is smaller.
16048 @item -mrelax
16049 @opindex mrelax
16050 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
16051 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
16052 Setting @option{-mrelax} just adds the @option{--mlink-relax} option to
16053 the assembler's command line and the @option{--relax} option to the
16054 linker's command line.
16056 Jump relaxing is performed by the linker because jump offsets are not
16057 known before code is located. Therefore, the assembler code generated by the
16058 compiler is the same, but the instructions in the executable may
16059 differ from instructions in the assembler code.
16061 Relaxing must be turned on if linker stubs are needed, see the
16062 section on @code{EIND} and linker stubs below.
16064 @item -mrmw
16065 @opindex mrmw
16066 Assume that the device supports the Read-Modify-Write
16067 instructions @code{XCH}, @code{LAC}, @code{LAS} and @code{LAT}.
16069 @item -mshort-calls
16070 @opindex mshort-calls
16072 Assume that @code{RJMP} and @code{RCALL} can target the whole
16073 program memory.
16075 This option is used internally for multilib selection.  It is
16076 not an optimization option, and you don't need to set it by hand.
16078 @item -msp8
16079 @opindex msp8
16080 Treat the stack pointer register as an 8-bit register,
16081 i.e.@: assume the high byte of the stack pointer is zero.
16082 In general, you don't need to set this option by hand.
16084 This option is used internally by the compiler to select and
16085 build multilibs for architectures @code{avr2} and @code{avr25}.
16086 These architectures mix devices with and without @code{SPH}.
16087 For any setting other than @option{-mmcu=avr2} or @option{-mmcu=avr25}
16088 the compiler driver adds or removes this option from the compiler
16089 proper's command line, because the compiler then knows if the device
16090 or architecture has an 8-bit stack pointer and thus no @code{SPH}
16091 register or not.
16093 @item -mstrict-X
16094 @opindex mstrict-X
16095 Use address register @code{X} in a way proposed by the hardware.  This means
16096 that @code{X} is only used in indirect, post-increment or
16097 pre-decrement addressing.
16099 Without this option, the @code{X} register may be used in the same way
16100 as @code{Y} or @code{Z} which then is emulated by additional
16101 instructions.  
16102 For example, loading a value with @code{X+const} addressing with a
16103 small non-negative @code{const < 64} to a register @var{Rn} is
16104 performed as
16106 @example
16107 adiw r26, const   ; X += const
16108 ld   @var{Rn}, X        ; @var{Rn} = *X
16109 sbiw r26, const   ; X -= const
16110 @end example
16112 @item -mtiny-stack
16113 @opindex mtiny-stack
16114 Only change the lower 8@tie{}bits of the stack pointer.
16116 @item -mfract-convert-truncate
16117 @opindex mfract-convert-truncate
16118 Allow to use truncation instead of rounding towards zero for fractional fixed-point types.
16120 @item -nodevicelib
16121 @opindex nodevicelib
16122 Don't link against AVR-LibC's device specific library @code{lib<mcu>.a}.
16124 @item -Waddr-space-convert
16125 @opindex Waddr-space-convert
16126 Warn about conversions between address spaces in the case where the
16127 resulting address space is not contained in the incoming address space.
16129 @item -Wmisspelled-isr
16130 @opindex Wmisspelled-isr
16131 Warn if the ISR is misspelled, i.e. without __vector prefix.
16132 Enabled by default.
16133 @end table
16135 @subsubsection @code{EIND} and Devices with More Than 128 Ki Bytes of Flash
16136 @cindex @code{EIND}
16137 Pointers in the implementation are 16@tie{}bits wide.
16138 The address of a function or label is represented as word address so
16139 that indirect jumps and calls can target any code address in the
16140 range of 64@tie{}Ki words.
16142 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
16143 bytes of program memory space, there is a special function register called
16144 @code{EIND} that serves as most significant part of the target address
16145 when @code{EICALL} or @code{EIJMP} instructions are used.
16147 Indirect jumps and calls on these devices are handled as follows by
16148 the compiler and are subject to some limitations:
16150 @itemize @bullet
16152 @item
16153 The compiler never sets @code{EIND}.
16155 @item
16156 The compiler uses @code{EIND} implicitly in @code{EICALL}/@code{EIJMP}
16157 instructions or might read @code{EIND} directly in order to emulate an
16158 indirect call/jump by means of a @code{RET} instruction.
16160 @item
16161 The compiler assumes that @code{EIND} never changes during the startup
16162 code or during the application. In particular, @code{EIND} is not
16163 saved/restored in function or interrupt service routine
16164 prologue/epilogue.
16166 @item
16167 For indirect calls to functions and computed goto, the linker
16168 generates @emph{stubs}. Stubs are jump pads sometimes also called
16169 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
16170 The stub contains a direct jump to the desired address.
16172 @item
16173 Linker relaxation must be turned on so that the linker generates
16174 the stubs correctly in all situations. See the compiler option
16175 @option{-mrelax} and the linker option @option{--relax}.
16176 There are corner cases where the linker is supposed to generate stubs
16177 but aborts without relaxation and without a helpful error message.
16179 @item
16180 The default linker script is arranged for code with @code{EIND = 0}.
16181 If code is supposed to work for a setup with @code{EIND != 0}, a custom
16182 linker script has to be used in order to place the sections whose
16183 name start with @code{.trampolines} into the segment where @code{EIND}
16184 points to.
16186 @item
16187 The startup code from libgcc never sets @code{EIND}.
16188 Notice that startup code is a blend of code from libgcc and AVR-LibC.
16189 For the impact of AVR-LibC on @code{EIND}, see the
16190 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
16192 @item
16193 It is legitimate for user-specific startup code to set up @code{EIND}
16194 early, for example by means of initialization code located in
16195 section @code{.init3}. Such code runs prior to general startup code
16196 that initializes RAM and calls constructors, but after the bit
16197 of startup code from AVR-LibC that sets @code{EIND} to the segment
16198 where the vector table is located.
16199 @example
16200 #include <avr/io.h>
16202 static void
16203 __attribute__((section(".init3"),naked,used,no_instrument_function))
16204 init3_set_eind (void)
16206   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
16207                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
16209 @end example
16211 @noindent
16212 The @code{__trampolines_start} symbol is defined in the linker script.
16214 @item
16215 Stubs are generated automatically by the linker if
16216 the following two conditions are met:
16217 @itemize @minus
16219 @item The address of a label is taken by means of the @code{gs} modifier
16220 (short for @emph{generate stubs}) like so:
16221 @example
16222 LDI r24, lo8(gs(@var{func}))
16223 LDI r25, hi8(gs(@var{func}))
16224 @end example
16225 @item The final location of that label is in a code segment
16226 @emph{outside} the segment where the stubs are located.
16227 @end itemize
16229 @item
16230 The compiler emits such @code{gs} modifiers for code labels in the
16231 following situations:
16232 @itemize @minus
16233 @item Taking address of a function or code label.
16234 @item Computed goto.
16235 @item If prologue-save function is used, see @option{-mcall-prologues}
16236 command-line option.
16237 @item Switch/case dispatch tables. If you do not want such dispatch
16238 tables you can specify the @option{-fno-jump-tables} command-line option.
16239 @item C and C++ constructors/destructors called during startup/shutdown.
16240 @item If the tools hit a @code{gs()} modifier explained above.
16241 @end itemize
16243 @item
16244 Jumping to non-symbolic addresses like so is @emph{not} supported:
16246 @example
16247 int main (void)
16249     /* Call function at word address 0x2 */
16250     return ((int(*)(void)) 0x2)();
16252 @end example
16254 Instead, a stub has to be set up, i.e.@: the function has to be called
16255 through a symbol (@code{func_4} in the example):
16257 @example
16258 int main (void)
16260     extern int func_4 (void);
16262     /* Call function at byte address 0x4 */
16263     return func_4();
16265 @end example
16267 and the application be linked with @option{-Wl,--defsym,func_4=0x4}.
16268 Alternatively, @code{func_4} can be defined in the linker script.
16269 @end itemize
16271 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
16272 @cindex @code{RAMPD}
16273 @cindex @code{RAMPX}
16274 @cindex @code{RAMPY}
16275 @cindex @code{RAMPZ}
16276 Some AVR devices support memories larger than the 64@tie{}KiB range
16277 that can be accessed with 16-bit pointers.  To access memory locations
16278 outside this 64@tie{}KiB range, the content of a @code{RAMP}
16279 register is used as high part of the address:
16280 The @code{X}, @code{Y}, @code{Z} address register is concatenated
16281 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
16282 register, respectively, to get a wide address. Similarly,
16283 @code{RAMPD} is used together with direct addressing.
16285 @itemize
16286 @item
16287 The startup code initializes the @code{RAMP} special function
16288 registers with zero.
16290 @item
16291 If a @ref{AVR Named Address Spaces,named address space} other than
16292 generic or @code{__flash} is used, then @code{RAMPZ} is set
16293 as needed before the operation.
16295 @item
16296 If the device supports RAM larger than 64@tie{}KiB and the compiler
16297 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
16298 is reset to zero after the operation.
16300 @item
16301 If the device comes with a specific @code{RAMP} register, the ISR
16302 prologue/epilogue saves/restores that SFR and initializes it with
16303 zero in case the ISR code might (implicitly) use it.
16305 @item
16306 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
16307 If you use inline assembler to read from locations outside the
16308 16-bit address range and change one of the @code{RAMP} registers,
16309 you must reset it to zero after the access.
16311 @end itemize
16313 @subsubsection AVR Built-in Macros
16315 GCC defines several built-in macros so that the user code can test
16316 for the presence or absence of features.  Almost any of the following
16317 built-in macros are deduced from device capabilities and thus
16318 triggered by the @option{-mmcu=} command-line option.
16320 For even more AVR-specific built-in macros see
16321 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
16323 @table @code
16325 @item __AVR_ARCH__
16326 Build-in macro that resolves to a decimal number that identifies the
16327 architecture and depends on the @option{-mmcu=@var{mcu}} option.
16328 Possible values are:
16330 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
16331 @code{4}, @code{5}, @code{51}, @code{6}
16333 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3}, @code{avr31},
16334 @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51}, @code{avr6},
16336 respectively and
16338 @code{100},
16339 @code{102}, @code{103}, @code{104},
16340 @code{105}, @code{106}, @code{107}
16342 for @var{mcu}=@code{avrtiny},
16343 @code{avrxmega2}, @code{avrxmega3}, @code{avrxmega4},
16344 @code{avrxmega5}, @code{avrxmega6}, @code{avrxmega7}, respectively.
16345 If @var{mcu} specifies a device, this built-in macro is set
16346 accordingly. For example, with @option{-mmcu=atmega8} the macro is
16347 defined to @code{4}.
16349 @item __AVR_@var{Device}__
16350 Setting @option{-mmcu=@var{device}} defines this built-in macro which reflects
16351 the device's name. For example, @option{-mmcu=atmega8} defines the
16352 built-in macro @code{__AVR_ATmega8__}, @option{-mmcu=attiny261a} defines
16353 @code{__AVR_ATtiny261A__}, etc.
16355 The built-in macros' names follow
16356 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
16357 the device name as from the AVR user manual. The difference between
16358 @var{Device} in the built-in macro and @var{device} in
16359 @option{-mmcu=@var{device}} is that the latter is always lowercase.
16361 If @var{device} is not a device but only a core architecture like
16362 @samp{avr51}, this macro is not defined.
16364 @item __AVR_DEVICE_NAME__
16365 Setting @option{-mmcu=@var{device}} defines this built-in macro to
16366 the device's name. For example, with @option{-mmcu=atmega8} the macro
16367 is defined to @code{atmega8}.
16369 If @var{device} is not a device but only a core architecture like
16370 @samp{avr51}, this macro is not defined.
16372 @item __AVR_XMEGA__
16373 The device / architecture belongs to the XMEGA family of devices.
16375 @item __AVR_HAVE_ELPM__
16376 The device has the @code{ELPM} instruction.
16378 @item __AVR_HAVE_ELPMX__
16379 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
16380 R@var{n},Z+} instructions.
16382 @item __AVR_HAVE_MOVW__
16383 The device has the @code{MOVW} instruction to perform 16-bit
16384 register-register moves.
16386 @item __AVR_HAVE_LPMX__
16387 The device has the @code{LPM R@var{n},Z} and
16388 @code{LPM R@var{n},Z+} instructions.
16390 @item __AVR_HAVE_MUL__
16391 The device has a hardware multiplier. 
16393 @item __AVR_HAVE_JMP_CALL__
16394 The device has the @code{JMP} and @code{CALL} instructions.
16395 This is the case for devices with more than 8@tie{}KiB of program
16396 memory.
16398 @item __AVR_HAVE_EIJMP_EICALL__
16399 @itemx __AVR_3_BYTE_PC__
16400 The device has the @code{EIJMP} and @code{EICALL} instructions.
16401 This is the case for devices with more than 128@tie{}KiB of program memory.
16402 This also means that the program counter
16403 (PC) is 3@tie{}bytes wide.
16405 @item __AVR_2_BYTE_PC__
16406 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
16407 with up to 128@tie{}KiB of program memory.
16409 @item __AVR_HAVE_8BIT_SP__
16410 @itemx __AVR_HAVE_16BIT_SP__
16411 The stack pointer (SP) register is treated as 8-bit respectively
16412 16-bit register by the compiler.
16413 The definition of these macros is affected by @option{-mtiny-stack}.
16415 @item __AVR_HAVE_SPH__
16416 @itemx __AVR_SP8__
16417 The device has the SPH (high part of stack pointer) special function
16418 register or has an 8-bit stack pointer, respectively.
16419 The definition of these macros is affected by @option{-mmcu=} and
16420 in the cases of @option{-mmcu=avr2} and @option{-mmcu=avr25} also
16421 by @option{-msp8}.
16423 @item __AVR_HAVE_RAMPD__
16424 @itemx __AVR_HAVE_RAMPX__
16425 @itemx __AVR_HAVE_RAMPY__
16426 @itemx __AVR_HAVE_RAMPZ__
16427 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
16428 @code{RAMPZ} special function register, respectively.
16430 @item __NO_INTERRUPTS__
16431 This macro reflects the @option{-mno-interrupts} command-line option.
16433 @item __AVR_ERRATA_SKIP__
16434 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
16435 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
16436 instructions because of a hardware erratum.  Skip instructions are
16437 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
16438 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
16439 set.
16441 @item __AVR_ISA_RMW__
16442 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
16444 @item __AVR_SFR_OFFSET__=@var{offset}
16445 Instructions that can address I/O special function registers directly
16446 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
16447 address as if addressed by an instruction to access RAM like @code{LD}
16448 or @code{STS}. This offset depends on the device architecture and has
16449 to be subtracted from the RAM address in order to get the
16450 respective I/O@tie{}address.
16452 @item __AVR_SHORT_CALLS__
16453 The @option{-mshort-calls} command line option is set.
16455 @item __AVR_PM_BASE_ADDRESS__=@var{addr}
16456 Some devices support reading from flash memory by means of @code{LD*}
16457 instructions.  The flash memory is seen in the data address space
16458 at an offset of @code{__AVR_PM_BASE_ADDRESS__}.  If this macro
16459 is not defined, this feature is not available.  If defined,
16460 the address space is linear and there is no need to put
16461 @code{.rodata} into RAM.  This is handled by the default linker
16462 description file, and is currently available for
16463 @code{avrtiny} and @code{avrxmega3}.  Even more convenient,
16464 there is no need to use address spaces like @code{__flash} or
16465 features like attribute @code{progmem} and @code{pgm_read_*}.
16467 @item __WITH_AVRLIBC__
16468 The compiler is configured to be used together with AVR-Libc.
16469 See the @option{--with-avrlibc} configure option.
16471 @end table
16473 @node Blackfin Options
16474 @subsection Blackfin Options
16475 @cindex Blackfin Options
16477 @table @gcctabopt
16478 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
16479 @opindex mcpu=
16480 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
16481 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
16482 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
16483 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
16484 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
16485 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
16486 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
16487 @samp{bf561}, @samp{bf592}.
16489 The optional @var{sirevision} specifies the silicon revision of the target
16490 Blackfin processor.  Any workarounds available for the targeted silicon revision
16491 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
16492 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
16493 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
16494 hexadecimal digits representing the major and minor numbers in the silicon
16495 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
16496 is not defined.  If @var{sirevision} is @samp{any}, the
16497 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
16498 If this optional @var{sirevision} is not used, GCC assumes the latest known
16499 silicon revision of the targeted Blackfin processor.
16501 GCC defines a preprocessor macro for the specified @var{cpu}.
16502 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
16503 provided by libgloss to be linked in if @option{-msim} is not given.
16505 Without this option, @samp{bf532} is used as the processor by default.
16507 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
16508 only the preprocessor macro is defined.
16510 @item -msim
16511 @opindex msim
16512 Specifies that the program will be run on the simulator.  This causes
16513 the simulator BSP provided by libgloss to be linked in.  This option
16514 has effect only for @samp{bfin-elf} toolchain.
16515 Certain other options, such as @option{-mid-shared-library} and
16516 @option{-mfdpic}, imply @option{-msim}.
16518 @item -momit-leaf-frame-pointer
16519 @opindex momit-leaf-frame-pointer
16520 Don't keep the frame pointer in a register for leaf functions.  This
16521 avoids the instructions to save, set up and restore frame pointers and
16522 makes an extra register available in leaf functions.  The option
16523 @option{-fomit-frame-pointer} removes the frame pointer for all functions,
16524 which might make debugging harder.
16526 @item -mspecld-anomaly
16527 @opindex mspecld-anomaly
16528 When enabled, the compiler ensures that the generated code does not
16529 contain speculative loads after jump instructions. If this option is used,
16530 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
16532 @item -mno-specld-anomaly
16533 @opindex mno-specld-anomaly
16534 Don't generate extra code to prevent speculative loads from occurring.
16536 @item -mcsync-anomaly
16537 @opindex mcsync-anomaly
16538 When enabled, the compiler ensures that the generated code does not
16539 contain CSYNC or SSYNC instructions too soon after conditional branches.
16540 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
16542 @item -mno-csync-anomaly
16543 @opindex mno-csync-anomaly
16544 Don't generate extra code to prevent CSYNC or SSYNC instructions from
16545 occurring too soon after a conditional branch.
16547 @item -mlow-64k
16548 @opindex mlow-64k
16549 When enabled, the compiler is free to take advantage of the knowledge that
16550 the entire program fits into the low 64k of memory.
16552 @item -mno-low-64k
16553 @opindex mno-low-64k
16554 Assume that the program is arbitrarily large.  This is the default.
16556 @item -mstack-check-l1
16557 @opindex mstack-check-l1
16558 Do stack checking using information placed into L1 scratchpad memory by the
16559 uClinux kernel.
16561 @item -mid-shared-library
16562 @opindex mid-shared-library
16563 Generate code that supports shared libraries via the library ID method.
16564 This allows for execute in place and shared libraries in an environment
16565 without virtual memory management.  This option implies @option{-fPIC}.
16566 With a @samp{bfin-elf} target, this option implies @option{-msim}.
16568 @item -mno-id-shared-library
16569 @opindex mno-id-shared-library
16570 Generate code that doesn't assume ID-based shared libraries are being used.
16571 This is the default.
16573 @item -mleaf-id-shared-library
16574 @opindex mleaf-id-shared-library
16575 Generate code that supports shared libraries via the library ID method,
16576 but assumes that this library or executable won't link against any other
16577 ID shared libraries.  That allows the compiler to use faster code for jumps
16578 and calls.
16580 @item -mno-leaf-id-shared-library
16581 @opindex mno-leaf-id-shared-library
16582 Do not assume that the code being compiled won't link against any ID shared
16583 libraries.  Slower code is generated for jump and call insns.
16585 @item -mshared-library-id=n
16586 @opindex mshared-library-id
16587 Specifies the identification number of the ID-based shared library being
16588 compiled.  Specifying a value of 0 generates more compact code; specifying
16589 other values forces the allocation of that number to the current
16590 library but is no more space- or time-efficient than omitting this option.
16592 @item -msep-data
16593 @opindex msep-data
16594 Generate code that allows the data segment to be located in a different
16595 area of memory from the text segment.  This allows for execute in place in
16596 an environment without virtual memory management by eliminating relocations
16597 against the text section.
16599 @item -mno-sep-data
16600 @opindex mno-sep-data
16601 Generate code that assumes that the data segment follows the text segment.
16602 This is the default.
16604 @item -mlong-calls
16605 @itemx -mno-long-calls
16606 @opindex mlong-calls
16607 @opindex mno-long-calls
16608 Tells the compiler to perform function calls by first loading the
16609 address of the function into a register and then performing a subroutine
16610 call on this register.  This switch is needed if the target function
16611 lies outside of the 24-bit addressing range of the offset-based
16612 version of subroutine call instruction.
16614 This feature is not enabled by default.  Specifying
16615 @option{-mno-long-calls} restores the default behavior.  Note these
16616 switches have no effect on how the compiler generates code to handle
16617 function calls via function pointers.
16619 @item -mfast-fp
16620 @opindex mfast-fp
16621 Link with the fast floating-point library. This library relaxes some of
16622 the IEEE floating-point standard's rules for checking inputs against
16623 Not-a-Number (NAN), in the interest of performance.
16625 @item -minline-plt
16626 @opindex minline-plt
16627 Enable inlining of PLT entries in function calls to functions that are
16628 not known to bind locally.  It has no effect without @option{-mfdpic}.
16630 @item -mmulticore
16631 @opindex mmulticore
16632 Build a standalone application for multicore Blackfin processors. 
16633 This option causes proper start files and link scripts supporting 
16634 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
16635 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
16637 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
16638 selects the one-application-per-core programming model.  Without
16639 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
16640 programming model is used. In this model, the main function of Core B
16641 should be named as @code{coreb_main}.
16643 If this option is not used, the single-core application programming
16644 model is used.
16646 @item -mcorea
16647 @opindex mcorea
16648 Build a standalone application for Core A of BF561 when using
16649 the one-application-per-core programming model. Proper start files
16650 and link scripts are used to support Core A, and the macro
16651 @code{__BFIN_COREA} is defined.
16652 This option can only be used in conjunction with @option{-mmulticore}.
16654 @item -mcoreb
16655 @opindex mcoreb
16656 Build a standalone application for Core B of BF561 when using
16657 the one-application-per-core programming model. Proper start files
16658 and link scripts are used to support Core B, and the macro
16659 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
16660 should be used instead of @code{main}. 
16661 This option can only be used in conjunction with @option{-mmulticore}.
16663 @item -msdram
16664 @opindex msdram
16665 Build a standalone application for SDRAM. Proper start files and
16666 link scripts are used to put the application into SDRAM, and the macro
16667 @code{__BFIN_SDRAM} is defined.
16668 The loader should initialize SDRAM before loading the application.
16670 @item -micplb
16671 @opindex micplb
16672 Assume that ICPLBs are enabled at run time.  This has an effect on certain
16673 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
16674 are enabled; for standalone applications the default is off.
16675 @end table
16677 @node C6X Options
16678 @subsection C6X Options
16679 @cindex C6X Options
16681 @table @gcctabopt
16682 @item -march=@var{name}
16683 @opindex march
16684 This specifies the name of the target architecture.  GCC uses this
16685 name to determine what kind of instructions it can emit when generating
16686 assembly code.  Permissible names are: @samp{c62x},
16687 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
16689 @item -mbig-endian
16690 @opindex mbig-endian
16691 Generate code for a big-endian target.
16693 @item -mlittle-endian
16694 @opindex mlittle-endian
16695 Generate code for a little-endian target.  This is the default.
16697 @item -msim
16698 @opindex msim
16699 Choose startup files and linker script suitable for the simulator.
16701 @item -msdata=default
16702 @opindex msdata=default
16703 Put small global and static data in the @code{.neardata} section,
16704 which is pointed to by register @code{B14}.  Put small uninitialized
16705 global and static data in the @code{.bss} section, which is adjacent
16706 to the @code{.neardata} section.  Put small read-only data into the
16707 @code{.rodata} section.  The corresponding sections used for large
16708 pieces of data are @code{.fardata}, @code{.far} and @code{.const}.
16710 @item -msdata=all
16711 @opindex msdata=all
16712 Put all data, not just small objects, into the sections reserved for
16713 small data, and use addressing relative to the @code{B14} register to
16714 access them.
16716 @item -msdata=none
16717 @opindex msdata=none
16718 Make no use of the sections reserved for small data, and use absolute
16719 addresses to access all data.  Put all initialized global and static
16720 data in the @code{.fardata} section, and all uninitialized data in the
16721 @code{.far} section.  Put all constant data into the @code{.const}
16722 section.
16723 @end table
16725 @node CRIS Options
16726 @subsection CRIS Options
16727 @cindex CRIS Options
16729 These options are defined specifically for the CRIS ports.
16731 @table @gcctabopt
16732 @item -march=@var{architecture-type}
16733 @itemx -mcpu=@var{architecture-type}
16734 @opindex march
16735 @opindex mcpu
16736 Generate code for the specified architecture.  The choices for
16737 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
16738 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
16739 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
16740 @samp{v10}.
16742 @item -mtune=@var{architecture-type}
16743 @opindex mtune
16744 Tune to @var{architecture-type} everything applicable about the generated
16745 code, except for the ABI and the set of available instructions.  The
16746 choices for @var{architecture-type} are the same as for
16747 @option{-march=@var{architecture-type}}.
16749 @item -mmax-stack-frame=@var{n}
16750 @opindex mmax-stack-frame
16751 Warn when the stack frame of a function exceeds @var{n} bytes.
16753 @item -metrax4
16754 @itemx -metrax100
16755 @opindex metrax4
16756 @opindex metrax100
16757 The options @option{-metrax4} and @option{-metrax100} are synonyms for
16758 @option{-march=v3} and @option{-march=v8} respectively.
16760 @item -mmul-bug-workaround
16761 @itemx -mno-mul-bug-workaround
16762 @opindex mmul-bug-workaround
16763 @opindex mno-mul-bug-workaround
16764 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
16765 models where it applies.  This option is active by default.
16767 @item -mpdebug
16768 @opindex mpdebug
16769 Enable CRIS-specific verbose debug-related information in the assembly
16770 code.  This option also has the effect of turning off the @samp{#NO_APP}
16771 formatted-code indicator to the assembler at the beginning of the
16772 assembly file.
16774 @item -mcc-init
16775 @opindex mcc-init
16776 Do not use condition-code results from previous instruction; always emit
16777 compare and test instructions before use of condition codes.
16779 @item -mno-side-effects
16780 @opindex mno-side-effects
16781 Do not emit instructions with side effects in addressing modes other than
16782 post-increment.
16784 @item -mstack-align
16785 @itemx -mno-stack-align
16786 @itemx -mdata-align
16787 @itemx -mno-data-align
16788 @itemx -mconst-align
16789 @itemx -mno-const-align
16790 @opindex mstack-align
16791 @opindex mno-stack-align
16792 @opindex mdata-align
16793 @opindex mno-data-align
16794 @opindex mconst-align
16795 @opindex mno-const-align
16796 These options (@samp{no-} options) arrange (eliminate arrangements) for the
16797 stack frame, individual data and constants to be aligned for the maximum
16798 single data access size for the chosen CPU model.  The default is to
16799 arrange for 32-bit alignment.  ABI details such as structure layout are
16800 not affected by these options.
16802 @item -m32-bit
16803 @itemx -m16-bit
16804 @itemx -m8-bit
16805 @opindex m32-bit
16806 @opindex m16-bit
16807 @opindex m8-bit
16808 Similar to the stack- data- and const-align options above, these options
16809 arrange for stack frame, writable data and constants to all be 32-bit,
16810 16-bit or 8-bit aligned.  The default is 32-bit alignment.
16812 @item -mno-prologue-epilogue
16813 @itemx -mprologue-epilogue
16814 @opindex mno-prologue-epilogue
16815 @opindex mprologue-epilogue
16816 With @option{-mno-prologue-epilogue}, the normal function prologue and
16817 epilogue which set up the stack frame are omitted and no return
16818 instructions or return sequences are generated in the code.  Use this
16819 option only together with visual inspection of the compiled code: no
16820 warnings or errors are generated when call-saved registers must be saved,
16821 or storage for local variables needs to be allocated.
16823 @item -mno-gotplt
16824 @itemx -mgotplt
16825 @opindex mno-gotplt
16826 @opindex mgotplt
16827 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
16828 instruction sequences that load addresses for functions from the PLT part
16829 of the GOT rather than (traditional on other architectures) calls to the
16830 PLT@.  The default is @option{-mgotplt}.
16832 @item -melf
16833 @opindex melf
16834 Legacy no-op option only recognized with the cris-axis-elf and
16835 cris-axis-linux-gnu targets.
16837 @item -mlinux
16838 @opindex mlinux
16839 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
16841 @item -sim
16842 @opindex sim
16843 This option, recognized for the cris-axis-elf, arranges
16844 to link with input-output functions from a simulator library.  Code,
16845 initialized data and zero-initialized data are allocated consecutively.
16847 @item -sim2
16848 @opindex sim2
16849 Like @option{-sim}, but pass linker options to locate initialized data at
16850 0x40000000 and zero-initialized data at 0x80000000.
16851 @end table
16853 @node CR16 Options
16854 @subsection CR16 Options
16855 @cindex CR16 Options
16857 These options are defined specifically for the CR16 ports.
16859 @table @gcctabopt
16861 @item -mmac
16862 @opindex mmac
16863 Enable the use of multiply-accumulate instructions. Disabled by default.
16865 @item -mcr16cplus
16866 @itemx -mcr16c
16867 @opindex mcr16cplus
16868 @opindex mcr16c
16869 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
16870 is default.
16872 @item -msim
16873 @opindex msim
16874 Links the library libsim.a which is in compatible with simulator. Applicable
16875 to ELF compiler only.
16877 @item -mint32
16878 @opindex mint32
16879 Choose integer type as 32-bit wide.
16881 @item -mbit-ops
16882 @opindex mbit-ops
16883 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
16885 @item -mdata-model=@var{model}
16886 @opindex mdata-model
16887 Choose a data model. The choices for @var{model} are @samp{near},
16888 @samp{far} or @samp{medium}. @samp{medium} is default.
16889 However, @samp{far} is not valid with @option{-mcr16c}, as the
16890 CR16C architecture does not support the far data model.
16891 @end table
16893 @node Darwin Options
16894 @subsection Darwin Options
16895 @cindex Darwin options
16897 These options are defined for all architectures running the Darwin operating
16898 system.
16900 FSF GCC on Darwin does not create ``fat'' object files; it creates
16901 an object file for the single architecture that GCC was built to
16902 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
16903 @option{-arch} options are used; it does so by running the compiler or
16904 linker multiple times and joining the results together with
16905 @file{lipo}.
16907 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
16908 @samp{i686}) is determined by the flags that specify the ISA
16909 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
16910 @option{-force_cpusubtype_ALL} option can be used to override this.
16912 The Darwin tools vary in their behavior when presented with an ISA
16913 mismatch.  The assembler, @file{as}, only permits instructions to
16914 be used that are valid for the subtype of the file it is generating,
16915 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
16916 The linker for shared libraries, @file{/usr/bin/libtool}, fails
16917 and prints an error if asked to create a shared library with a less
16918 restrictive subtype than its input files (for instance, trying to put
16919 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
16920 for executables, @command{ld}, quietly gives the executable the most
16921 restrictive subtype of any of its input files.
16923 @table @gcctabopt
16924 @item -F@var{dir}
16925 @opindex F
16926 Add the framework directory @var{dir} to the head of the list of
16927 directories to be searched for header files.  These directories are
16928 interleaved with those specified by @option{-I} options and are
16929 scanned in a left-to-right order.
16931 A framework directory is a directory with frameworks in it.  A
16932 framework is a directory with a @file{Headers} and/or
16933 @file{PrivateHeaders} directory contained directly in it that ends
16934 in @file{.framework}.  The name of a framework is the name of this
16935 directory excluding the @file{.framework}.  Headers associated with
16936 the framework are found in one of those two directories, with
16937 @file{Headers} being searched first.  A subframework is a framework
16938 directory that is in a framework's @file{Frameworks} directory.
16939 Includes of subframework headers can only appear in a header of a
16940 framework that contains the subframework, or in a sibling subframework
16941 header.  Two subframeworks are siblings if they occur in the same
16942 framework.  A subframework should not have the same name as a
16943 framework; a warning is issued if this is violated.  Currently a
16944 subframework cannot have subframeworks; in the future, the mechanism
16945 may be extended to support this.  The standard frameworks can be found
16946 in @file{/System/Library/Frameworks} and
16947 @file{/Library/Frameworks}.  An example include looks like
16948 @code{#include <Framework/header.h>}, where @file{Framework} denotes
16949 the name of the framework and @file{header.h} is found in the
16950 @file{PrivateHeaders} or @file{Headers} directory.
16952 @item -iframework@var{dir}
16953 @opindex iframework
16954 Like @option{-F} except the directory is a treated as a system
16955 directory.  The main difference between this @option{-iframework} and
16956 @option{-F} is that with @option{-iframework} the compiler does not
16957 warn about constructs contained within header files found via
16958 @var{dir}.  This option is valid only for the C family of languages.
16960 @item -gused
16961 @opindex gused
16962 Emit debugging information for symbols that are used.  For stabs
16963 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
16964 This is by default ON@.
16966 @item -gfull
16967 @opindex gfull
16968 Emit debugging information for all symbols and types.
16970 @item -mmacosx-version-min=@var{version}
16971 The earliest version of MacOS X that this executable will run on
16972 is @var{version}.  Typical values of @var{version} include @code{10.1},
16973 @code{10.2}, and @code{10.3.9}.
16975 If the compiler was built to use the system's headers by default,
16976 then the default for this option is the system version on which the
16977 compiler is running, otherwise the default is to make choices that
16978 are compatible with as many systems and code bases as possible.
16980 @item -mkernel
16981 @opindex mkernel
16982 Enable kernel development mode.  The @option{-mkernel} option sets
16983 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
16984 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
16985 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
16986 applicable.  This mode also sets @option{-mno-altivec},
16987 @option{-msoft-float}, @option{-fno-builtin} and
16988 @option{-mlong-branch} for PowerPC targets.
16990 @item -mone-byte-bool
16991 @opindex mone-byte-bool
16992 Override the defaults for @code{bool} so that @code{sizeof(bool)==1}.
16993 By default @code{sizeof(bool)} is @code{4} when compiling for
16994 Darwin/PowerPC and @code{1} when compiling for Darwin/x86, so this
16995 option has no effect on x86.
16997 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
16998 to generate code that is not binary compatible with code generated
16999 without that switch.  Using this switch may require recompiling all
17000 other modules in a program, including system libraries.  Use this
17001 switch to conform to a non-default data model.
17003 @item -mfix-and-continue
17004 @itemx -ffix-and-continue
17005 @itemx -findirect-data
17006 @opindex mfix-and-continue
17007 @opindex ffix-and-continue
17008 @opindex findirect-data
17009 Generate code suitable for fast turnaround development, such as to
17010 allow GDB to dynamically load @file{.o} files into already-running
17011 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
17012 are provided for backwards compatibility.
17014 @item -all_load
17015 @opindex all_load
17016 Loads all members of static archive libraries.
17017 See man ld(1) for more information.
17019 @item -arch_errors_fatal
17020 @opindex arch_errors_fatal
17021 Cause the errors having to do with files that have the wrong architecture
17022 to be fatal.
17024 @item -bind_at_load
17025 @opindex bind_at_load
17026 Causes the output file to be marked such that the dynamic linker will
17027 bind all undefined references when the file is loaded or launched.
17029 @item -bundle
17030 @opindex bundle
17031 Produce a Mach-o bundle format file.
17032 See man ld(1) for more information.
17034 @item -bundle_loader @var{executable}
17035 @opindex bundle_loader
17036 This option specifies the @var{executable} that will load the build
17037 output file being linked.  See man ld(1) for more information.
17039 @item -dynamiclib
17040 @opindex dynamiclib
17041 When passed this option, GCC produces a dynamic library instead of
17042 an executable when linking, using the Darwin @file{libtool} command.
17044 @item -force_cpusubtype_ALL
17045 @opindex force_cpusubtype_ALL
17046 This causes GCC's output file to have the @samp{ALL} subtype, instead of
17047 one controlled by the @option{-mcpu} or @option{-march} option.
17049 @item -allowable_client  @var{client_name}
17050 @itemx -client_name
17051 @itemx -compatibility_version
17052 @itemx -current_version
17053 @itemx -dead_strip
17054 @itemx -dependency-file
17055 @itemx -dylib_file
17056 @itemx -dylinker_install_name
17057 @itemx -dynamic
17058 @itemx -exported_symbols_list
17059 @itemx -filelist
17060 @need 800
17061 @itemx -flat_namespace
17062 @itemx -force_flat_namespace
17063 @itemx -headerpad_max_install_names
17064 @itemx -image_base
17065 @itemx -init
17066 @itemx -install_name
17067 @itemx -keep_private_externs
17068 @itemx -multi_module
17069 @itemx -multiply_defined
17070 @itemx -multiply_defined_unused
17071 @need 800
17072 @itemx -noall_load
17073 @itemx -no_dead_strip_inits_and_terms
17074 @itemx -nofixprebinding
17075 @itemx -nomultidefs
17076 @itemx -noprebind
17077 @itemx -noseglinkedit
17078 @itemx -pagezero_size
17079 @itemx -prebind
17080 @itemx -prebind_all_twolevel_modules
17081 @itemx -private_bundle
17082 @need 800
17083 @itemx -read_only_relocs
17084 @itemx -sectalign
17085 @itemx -sectobjectsymbols
17086 @itemx -whyload
17087 @itemx -seg1addr
17088 @itemx -sectcreate
17089 @itemx -sectobjectsymbols
17090 @itemx -sectorder
17091 @itemx -segaddr
17092 @itemx -segs_read_only_addr
17093 @need 800
17094 @itemx -segs_read_write_addr
17095 @itemx -seg_addr_table
17096 @itemx -seg_addr_table_filename
17097 @itemx -seglinkedit
17098 @itemx -segprot
17099 @itemx -segs_read_only_addr
17100 @itemx -segs_read_write_addr
17101 @itemx -single_module
17102 @itemx -static
17103 @itemx -sub_library
17104 @need 800
17105 @itemx -sub_umbrella
17106 @itemx -twolevel_namespace
17107 @itemx -umbrella
17108 @itemx -undefined
17109 @itemx -unexported_symbols_list
17110 @itemx -weak_reference_mismatches
17111 @itemx -whatsloaded
17112 @opindex allowable_client
17113 @opindex client_name
17114 @opindex compatibility_version
17115 @opindex current_version
17116 @opindex dead_strip
17117 @opindex dependency-file
17118 @opindex dylib_file
17119 @opindex dylinker_install_name
17120 @opindex dynamic
17121 @opindex exported_symbols_list
17122 @opindex filelist
17123 @opindex flat_namespace
17124 @opindex force_flat_namespace
17125 @opindex headerpad_max_install_names
17126 @opindex image_base
17127 @opindex init
17128 @opindex install_name
17129 @opindex keep_private_externs
17130 @opindex multi_module
17131 @opindex multiply_defined
17132 @opindex multiply_defined_unused
17133 @opindex noall_load
17134 @opindex no_dead_strip_inits_and_terms
17135 @opindex nofixprebinding
17136 @opindex nomultidefs
17137 @opindex noprebind
17138 @opindex noseglinkedit
17139 @opindex pagezero_size
17140 @opindex prebind
17141 @opindex prebind_all_twolevel_modules
17142 @opindex private_bundle
17143 @opindex read_only_relocs
17144 @opindex sectalign
17145 @opindex sectobjectsymbols
17146 @opindex whyload
17147 @opindex seg1addr
17148 @opindex sectcreate
17149 @opindex sectobjectsymbols
17150 @opindex sectorder
17151 @opindex segaddr
17152 @opindex segs_read_only_addr
17153 @opindex segs_read_write_addr
17154 @opindex seg_addr_table
17155 @opindex seg_addr_table_filename
17156 @opindex seglinkedit
17157 @opindex segprot
17158 @opindex segs_read_only_addr
17159 @opindex segs_read_write_addr
17160 @opindex single_module
17161 @opindex static
17162 @opindex sub_library
17163 @opindex sub_umbrella
17164 @opindex twolevel_namespace
17165 @opindex umbrella
17166 @opindex undefined
17167 @opindex unexported_symbols_list
17168 @opindex weak_reference_mismatches
17169 @opindex whatsloaded
17170 These options are passed to the Darwin linker.  The Darwin linker man page
17171 describes them in detail.
17172 @end table
17174 @node DEC Alpha Options
17175 @subsection DEC Alpha Options
17177 These @samp{-m} options are defined for the DEC Alpha implementations:
17179 @table @gcctabopt
17180 @item -mno-soft-float
17181 @itemx -msoft-float
17182 @opindex mno-soft-float
17183 @opindex msoft-float
17184 Use (do not use) the hardware floating-point instructions for
17185 floating-point operations.  When @option{-msoft-float} is specified,
17186 functions in @file{libgcc.a} are used to perform floating-point
17187 operations.  Unless they are replaced by routines that emulate the
17188 floating-point operations, or compiled in such a way as to call such
17189 emulations routines, these routines issue floating-point
17190 operations.   If you are compiling for an Alpha without floating-point
17191 operations, you must ensure that the library is built so as not to call
17192 them.
17194 Note that Alpha implementations without floating-point operations are
17195 required to have floating-point registers.
17197 @item -mfp-reg
17198 @itemx -mno-fp-regs
17199 @opindex mfp-reg
17200 @opindex mno-fp-regs
17201 Generate code that uses (does not use) the floating-point register set.
17202 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
17203 register set is not used, floating-point operands are passed in integer
17204 registers as if they were integers and floating-point results are passed
17205 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
17206 so any function with a floating-point argument or return value called by code
17207 compiled with @option{-mno-fp-regs} must also be compiled with that
17208 option.
17210 A typical use of this option is building a kernel that does not use,
17211 and hence need not save and restore, any floating-point registers.
17213 @item -mieee
17214 @opindex mieee
17215 The Alpha architecture implements floating-point hardware optimized for
17216 maximum performance.  It is mostly compliant with the IEEE floating-point
17217 standard.  However, for full compliance, software assistance is
17218 required.  This option generates code fully IEEE-compliant code
17219 @emph{except} that the @var{inexact-flag} is not maintained (see below).
17220 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
17221 defined during compilation.  The resulting code is less efficient but is
17222 able to correctly support denormalized numbers and exceptional IEEE
17223 values such as not-a-number and plus/minus infinity.  Other Alpha
17224 compilers call this option @option{-ieee_with_no_inexact}.
17226 @item -mieee-with-inexact
17227 @opindex mieee-with-inexact
17228 This is like @option{-mieee} except the generated code also maintains
17229 the IEEE @var{inexact-flag}.  Turning on this option causes the
17230 generated code to implement fully-compliant IEEE math.  In addition to
17231 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
17232 macro.  On some Alpha implementations the resulting code may execute
17233 significantly slower than the code generated by default.  Since there is
17234 very little code that depends on the @var{inexact-flag}, you should
17235 normally not specify this option.  Other Alpha compilers call this
17236 option @option{-ieee_with_inexact}.
17238 @item -mfp-trap-mode=@var{trap-mode}
17239 @opindex mfp-trap-mode
17240 This option controls what floating-point related traps are enabled.
17241 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
17242 The trap mode can be set to one of four values:
17244 @table @samp
17245 @item n
17246 This is the default (normal) setting.  The only traps that are enabled
17247 are the ones that cannot be disabled in software (e.g., division by zero
17248 trap).
17250 @item u
17251 In addition to the traps enabled by @samp{n}, underflow traps are enabled
17252 as well.
17254 @item su
17255 Like @samp{u}, but the instructions are marked to be safe for software
17256 completion (see Alpha architecture manual for details).
17258 @item sui
17259 Like @samp{su}, but inexact traps are enabled as well.
17260 @end table
17262 @item -mfp-rounding-mode=@var{rounding-mode}
17263 @opindex mfp-rounding-mode
17264 Selects the IEEE rounding mode.  Other Alpha compilers call this option
17265 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
17268 @table @samp
17269 @item n
17270 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
17271 the nearest machine number or towards the even machine number in case
17272 of a tie.
17274 @item m
17275 Round towards minus infinity.
17277 @item c
17278 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
17280 @item d
17281 Dynamic rounding mode.  A field in the floating-point control register
17282 (@var{fpcr}, see Alpha architecture reference manual) controls the
17283 rounding mode in effect.  The C library initializes this register for
17284 rounding towards plus infinity.  Thus, unless your program modifies the
17285 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
17286 @end table
17288 @item -mtrap-precision=@var{trap-precision}
17289 @opindex mtrap-precision
17290 In the Alpha architecture, floating-point traps are imprecise.  This
17291 means without software assistance it is impossible to recover from a
17292 floating trap and program execution normally needs to be terminated.
17293 GCC can generate code that can assist operating system trap handlers
17294 in determining the exact location that caused a floating-point trap.
17295 Depending on the requirements of an application, different levels of
17296 precisions can be selected:
17298 @table @samp
17299 @item p
17300 Program precision.  This option is the default and means a trap handler
17301 can only identify which program caused a floating-point exception.
17303 @item f
17304 Function precision.  The trap handler can determine the function that
17305 caused a floating-point exception.
17307 @item i
17308 Instruction precision.  The trap handler can determine the exact
17309 instruction that caused a floating-point exception.
17310 @end table
17312 Other Alpha compilers provide the equivalent options called
17313 @option{-scope_safe} and @option{-resumption_safe}.
17315 @item -mieee-conformant
17316 @opindex mieee-conformant
17317 This option marks the generated code as IEEE conformant.  You must not
17318 use this option unless you also specify @option{-mtrap-precision=i} and either
17319 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
17320 is to emit the line @samp{.eflag 48} in the function prologue of the
17321 generated assembly file.
17323 @item -mbuild-constants
17324 @opindex mbuild-constants
17325 Normally GCC examines a 32- or 64-bit integer constant to
17326 see if it can construct it from smaller constants in two or three
17327 instructions.  If it cannot, it outputs the constant as a literal and
17328 generates code to load it from the data segment at run time.
17330 Use this option to require GCC to construct @emph{all} integer constants
17331 using code, even if it takes more instructions (the maximum is six).
17333 You typically use this option to build a shared library dynamic
17334 loader.  Itself a shared library, it must relocate itself in memory
17335 before it can find the variables and constants in its own data segment.
17337 @item -mbwx
17338 @itemx -mno-bwx
17339 @itemx -mcix
17340 @itemx -mno-cix
17341 @itemx -mfix
17342 @itemx -mno-fix
17343 @itemx -mmax
17344 @itemx -mno-max
17345 @opindex mbwx
17346 @opindex mno-bwx
17347 @opindex mcix
17348 @opindex mno-cix
17349 @opindex mfix
17350 @opindex mno-fix
17351 @opindex mmax
17352 @opindex mno-max
17353 Indicate whether GCC should generate code to use the optional BWX,
17354 CIX, FIX and MAX instruction sets.  The default is to use the instruction
17355 sets supported by the CPU type specified via @option{-mcpu=} option or that
17356 of the CPU on which GCC was built if none is specified.
17358 @item -mfloat-vax
17359 @itemx -mfloat-ieee
17360 @opindex mfloat-vax
17361 @opindex mfloat-ieee
17362 Generate code that uses (does not use) VAX F and G floating-point
17363 arithmetic instead of IEEE single and double precision.
17365 @item -mexplicit-relocs
17366 @itemx -mno-explicit-relocs
17367 @opindex mexplicit-relocs
17368 @opindex mno-explicit-relocs
17369 Older Alpha assemblers provided no way to generate symbol relocations
17370 except via assembler macros.  Use of these macros does not allow
17371 optimal instruction scheduling.  GNU binutils as of version 2.12
17372 supports a new syntax that allows the compiler to explicitly mark
17373 which relocations should apply to which instructions.  This option
17374 is mostly useful for debugging, as GCC detects the capabilities of
17375 the assembler when it is built and sets the default accordingly.
17377 @item -msmall-data
17378 @itemx -mlarge-data
17379 @opindex msmall-data
17380 @opindex mlarge-data
17381 When @option{-mexplicit-relocs} is in effect, static data is
17382 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
17383 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
17384 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
17385 16-bit relocations off of the @code{$gp} register.  This limits the
17386 size of the small data area to 64KB, but allows the variables to be
17387 directly accessed via a single instruction.
17389 The default is @option{-mlarge-data}.  With this option the data area
17390 is limited to just below 2GB@.  Programs that require more than 2GB of
17391 data must use @code{malloc} or @code{mmap} to allocate the data in the
17392 heap instead of in the program's data segment.
17394 When generating code for shared libraries, @option{-fpic} implies
17395 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
17397 @item -msmall-text
17398 @itemx -mlarge-text
17399 @opindex msmall-text
17400 @opindex mlarge-text
17401 When @option{-msmall-text} is used, the compiler assumes that the
17402 code of the entire program (or shared library) fits in 4MB, and is
17403 thus reachable with a branch instruction.  When @option{-msmall-data}
17404 is used, the compiler can assume that all local symbols share the
17405 same @code{$gp} value, and thus reduce the number of instructions
17406 required for a function call from 4 to 1.
17408 The default is @option{-mlarge-text}.
17410 @item -mcpu=@var{cpu_type}
17411 @opindex mcpu
17412 Set the instruction set and instruction scheduling parameters for
17413 machine type @var{cpu_type}.  You can specify either the @samp{EV}
17414 style name or the corresponding chip number.  GCC supports scheduling
17415 parameters for the EV4, EV5 and EV6 family of processors and
17416 chooses the default values for the instruction set from the processor
17417 you specify.  If you do not specify a processor type, GCC defaults
17418 to the processor on which the compiler was built.
17420 Supported values for @var{cpu_type} are
17422 @table @samp
17423 @item ev4
17424 @itemx ev45
17425 @itemx 21064
17426 Schedules as an EV4 and has no instruction set extensions.
17428 @item ev5
17429 @itemx 21164
17430 Schedules as an EV5 and has no instruction set extensions.
17432 @item ev56
17433 @itemx 21164a
17434 Schedules as an EV5 and supports the BWX extension.
17436 @item pca56
17437 @itemx 21164pc
17438 @itemx 21164PC
17439 Schedules as an EV5 and supports the BWX and MAX extensions.
17441 @item ev6
17442 @itemx 21264
17443 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
17445 @item ev67
17446 @itemx 21264a
17447 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
17448 @end table
17450 Native toolchains also support the value @samp{native},
17451 which selects the best architecture option for the host processor.
17452 @option{-mcpu=native} has no effect if GCC does not recognize
17453 the processor.
17455 @item -mtune=@var{cpu_type}
17456 @opindex mtune
17457 Set only the instruction scheduling parameters for machine type
17458 @var{cpu_type}.  The instruction set is not changed.
17460 Native toolchains also support the value @samp{native},
17461 which selects the best architecture option for the host processor.
17462 @option{-mtune=native} has no effect if GCC does not recognize
17463 the processor.
17465 @item -mmemory-latency=@var{time}
17466 @opindex mmemory-latency
17467 Sets the latency the scheduler should assume for typical memory
17468 references as seen by the application.  This number is highly
17469 dependent on the memory access patterns used by the application
17470 and the size of the external cache on the machine.
17472 Valid options for @var{time} are
17474 @table @samp
17475 @item @var{number}
17476 A decimal number representing clock cycles.
17478 @item L1
17479 @itemx L2
17480 @itemx L3
17481 @itemx main
17482 The compiler contains estimates of the number of clock cycles for
17483 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
17484 (also called Dcache, Scache, and Bcache), as well as to main memory.
17485 Note that L3 is only valid for EV5.
17487 @end table
17488 @end table
17490 @node FR30 Options
17491 @subsection FR30 Options
17492 @cindex FR30 Options
17494 These options are defined specifically for the FR30 port.
17496 @table @gcctabopt
17498 @item -msmall-model
17499 @opindex msmall-model
17500 Use the small address space model.  This can produce smaller code, but
17501 it does assume that all symbolic values and addresses fit into a
17502 20-bit range.
17504 @item -mno-lsim
17505 @opindex mno-lsim
17506 Assume that runtime support has been provided and so there is no need
17507 to include the simulator library (@file{libsim.a}) on the linker
17508 command line.
17510 @end table
17512 @node FT32 Options
17513 @subsection FT32 Options
17514 @cindex FT32 Options
17516 These options are defined specifically for the FT32 port.
17518 @table @gcctabopt
17520 @item -msim
17521 @opindex msim
17522 Specifies that the program will be run on the simulator.  This causes
17523 an alternate runtime startup and library to be linked.
17524 You must not use this option when generating programs that will run on
17525 real hardware; you must provide your own runtime library for whatever
17526 I/O functions are needed.
17528 @item -mlra
17529 @opindex mlra
17530 Enable Local Register Allocation.  This is still experimental for FT32,
17531 so by default the compiler uses standard reload.
17533 @item -mnodiv
17534 @opindex mnodiv
17535 Do not use div and mod instructions.
17537 @end table
17539 @node FRV Options
17540 @subsection FRV Options
17541 @cindex FRV Options
17543 @table @gcctabopt
17544 @item -mgpr-32
17545 @opindex mgpr-32
17547 Only use the first 32 general-purpose registers.
17549 @item -mgpr-64
17550 @opindex mgpr-64
17552 Use all 64 general-purpose registers.
17554 @item -mfpr-32
17555 @opindex mfpr-32
17557 Use only the first 32 floating-point registers.
17559 @item -mfpr-64
17560 @opindex mfpr-64
17562 Use all 64 floating-point registers.
17564 @item -mhard-float
17565 @opindex mhard-float
17567 Use hardware instructions for floating-point operations.
17569 @item -msoft-float
17570 @opindex msoft-float
17572 Use library routines for floating-point operations.
17574 @item -malloc-cc
17575 @opindex malloc-cc
17577 Dynamically allocate condition code registers.
17579 @item -mfixed-cc
17580 @opindex mfixed-cc
17582 Do not try to dynamically allocate condition code registers, only
17583 use @code{icc0} and @code{fcc0}.
17585 @item -mdword
17586 @opindex mdword
17588 Change ABI to use double word insns.
17590 @item -mno-dword
17591 @opindex mno-dword
17593 Do not use double word instructions.
17595 @item -mdouble
17596 @opindex mdouble
17598 Use floating-point double instructions.
17600 @item -mno-double
17601 @opindex mno-double
17603 Do not use floating-point double instructions.
17605 @item -mmedia
17606 @opindex mmedia
17608 Use media instructions.
17610 @item -mno-media
17611 @opindex mno-media
17613 Do not use media instructions.
17615 @item -mmuladd
17616 @opindex mmuladd
17618 Use multiply and add/subtract instructions.
17620 @item -mno-muladd
17621 @opindex mno-muladd
17623 Do not use multiply and add/subtract instructions.
17625 @item -mfdpic
17626 @opindex mfdpic
17628 Select the FDPIC ABI, which uses function descriptors to represent
17629 pointers to functions.  Without any PIC/PIE-related options, it
17630 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
17631 assumes GOT entries and small data are within a 12-bit range from the
17632 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
17633 are computed with 32 bits.
17634 With a @samp{bfin-elf} target, this option implies @option{-msim}.
17636 @item -minline-plt
17637 @opindex minline-plt
17639 Enable inlining of PLT entries in function calls to functions that are
17640 not known to bind locally.  It has no effect without @option{-mfdpic}.
17641 It's enabled by default if optimizing for speed and compiling for
17642 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
17643 optimization option such as @option{-O3} or above is present in the
17644 command line.
17646 @item -mTLS
17647 @opindex mTLS
17649 Assume a large TLS segment when generating thread-local code.
17651 @item -mtls
17652 @opindex mtls
17654 Do not assume a large TLS segment when generating thread-local code.
17656 @item -mgprel-ro
17657 @opindex mgprel-ro
17659 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
17660 that is known to be in read-only sections.  It's enabled by default,
17661 except for @option{-fpic} or @option{-fpie}: even though it may help
17662 make the global offset table smaller, it trades 1 instruction for 4.
17663 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
17664 one of which may be shared by multiple symbols, and it avoids the need
17665 for a GOT entry for the referenced symbol, so it's more likely to be a
17666 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
17668 @item -multilib-library-pic
17669 @opindex multilib-library-pic
17671 Link with the (library, not FD) pic libraries.  It's implied by
17672 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
17673 @option{-fpic} without @option{-mfdpic}.  You should never have to use
17674 it explicitly.
17676 @item -mlinked-fp
17677 @opindex mlinked-fp
17679 Follow the EABI requirement of always creating a frame pointer whenever
17680 a stack frame is allocated.  This option is enabled by default and can
17681 be disabled with @option{-mno-linked-fp}.
17683 @item -mlong-calls
17684 @opindex mlong-calls
17686 Use indirect addressing to call functions outside the current
17687 compilation unit.  This allows the functions to be placed anywhere
17688 within the 32-bit address space.
17690 @item -malign-labels
17691 @opindex malign-labels
17693 Try to align labels to an 8-byte boundary by inserting NOPs into the
17694 previous packet.  This option only has an effect when VLIW packing
17695 is enabled.  It doesn't create new packets; it merely adds NOPs to
17696 existing ones.
17698 @item -mlibrary-pic
17699 @opindex mlibrary-pic
17701 Generate position-independent EABI code.
17703 @item -macc-4
17704 @opindex macc-4
17706 Use only the first four media accumulator registers.
17708 @item -macc-8
17709 @opindex macc-8
17711 Use all eight media accumulator registers.
17713 @item -mpack
17714 @opindex mpack
17716 Pack VLIW instructions.
17718 @item -mno-pack
17719 @opindex mno-pack
17721 Do not pack VLIW instructions.
17723 @item -mno-eflags
17724 @opindex mno-eflags
17726 Do not mark ABI switches in e_flags.
17728 @item -mcond-move
17729 @opindex mcond-move
17731 Enable the use of conditional-move instructions (default).
17733 This switch is mainly for debugging the compiler and will likely be removed
17734 in a future version.
17736 @item -mno-cond-move
17737 @opindex mno-cond-move
17739 Disable the use of conditional-move instructions.
17741 This switch is mainly for debugging the compiler and will likely be removed
17742 in a future version.
17744 @item -mscc
17745 @opindex mscc
17747 Enable the use of conditional set instructions (default).
17749 This switch is mainly for debugging the compiler and will likely be removed
17750 in a future version.
17752 @item -mno-scc
17753 @opindex mno-scc
17755 Disable the use of conditional set instructions.
17757 This switch is mainly for debugging the compiler and will likely be removed
17758 in a future version.
17760 @item -mcond-exec
17761 @opindex mcond-exec
17763 Enable the use of conditional execution (default).
17765 This switch is mainly for debugging the compiler and will likely be removed
17766 in a future version.
17768 @item -mno-cond-exec
17769 @opindex mno-cond-exec
17771 Disable the use of conditional execution.
17773 This switch is mainly for debugging the compiler and will likely be removed
17774 in a future version.
17776 @item -mvliw-branch
17777 @opindex mvliw-branch
17779 Run a pass to pack branches into VLIW instructions (default).
17781 This switch is mainly for debugging the compiler and will likely be removed
17782 in a future version.
17784 @item -mno-vliw-branch
17785 @opindex mno-vliw-branch
17787 Do not run a pass to pack branches into VLIW instructions.
17789 This switch is mainly for debugging the compiler and will likely be removed
17790 in a future version.
17792 @item -mmulti-cond-exec
17793 @opindex mmulti-cond-exec
17795 Enable optimization of @code{&&} and @code{||} in conditional execution
17796 (default).
17798 This switch is mainly for debugging the compiler and will likely be removed
17799 in a future version.
17801 @item -mno-multi-cond-exec
17802 @opindex mno-multi-cond-exec
17804 Disable optimization of @code{&&} and @code{||} in conditional execution.
17806 This switch is mainly for debugging the compiler and will likely be removed
17807 in a future version.
17809 @item -mnested-cond-exec
17810 @opindex mnested-cond-exec
17812 Enable nested conditional execution optimizations (default).
17814 This switch is mainly for debugging the compiler and will likely be removed
17815 in a future version.
17817 @item -mno-nested-cond-exec
17818 @opindex mno-nested-cond-exec
17820 Disable nested conditional execution optimizations.
17822 This switch is mainly for debugging the compiler and will likely be removed
17823 in a future version.
17825 @item -moptimize-membar
17826 @opindex moptimize-membar
17828 This switch removes redundant @code{membar} instructions from the
17829 compiler-generated code.  It is enabled by default.
17831 @item -mno-optimize-membar
17832 @opindex mno-optimize-membar
17834 This switch disables the automatic removal of redundant @code{membar}
17835 instructions from the generated code.
17837 @item -mtomcat-stats
17838 @opindex mtomcat-stats
17840 Cause gas to print out tomcat statistics.
17842 @item -mcpu=@var{cpu}
17843 @opindex mcpu
17845 Select the processor type for which to generate code.  Possible values are
17846 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
17847 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
17849 @end table
17851 @node GNU/Linux Options
17852 @subsection GNU/Linux Options
17854 These @samp{-m} options are defined for GNU/Linux targets:
17856 @table @gcctabopt
17857 @item -mglibc
17858 @opindex mglibc
17859 Use the GNU C library.  This is the default except
17860 on @samp{*-*-linux-*uclibc*}, @samp{*-*-linux-*musl*} and
17861 @samp{*-*-linux-*android*} targets.
17863 @item -muclibc
17864 @opindex muclibc
17865 Use uClibc C library.  This is the default on
17866 @samp{*-*-linux-*uclibc*} targets.
17868 @item -mmusl
17869 @opindex mmusl
17870 Use the musl C library.  This is the default on
17871 @samp{*-*-linux-*musl*} targets.
17873 @item -mbionic
17874 @opindex mbionic
17875 Use Bionic C library.  This is the default on
17876 @samp{*-*-linux-*android*} targets.
17878 @item -mandroid
17879 @opindex mandroid
17880 Compile code compatible with Android platform.  This is the default on
17881 @samp{*-*-linux-*android*} targets.
17883 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
17884 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
17885 this option makes the GCC driver pass Android-specific options to the linker.
17886 Finally, this option causes the preprocessor macro @code{__ANDROID__}
17887 to be defined.
17889 @item -tno-android-cc
17890 @opindex tno-android-cc
17891 Disable compilation effects of @option{-mandroid}, i.e., do not enable
17892 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
17893 @option{-fno-rtti} by default.
17895 @item -tno-android-ld
17896 @opindex tno-android-ld
17897 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
17898 linking options to the linker.
17900 @end table
17902 @node H8/300 Options
17903 @subsection H8/300 Options
17905 These @samp{-m} options are defined for the H8/300 implementations:
17907 @table @gcctabopt
17908 @item -mrelax
17909 @opindex mrelax
17910 Shorten some address references at link time, when possible; uses the
17911 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
17912 ld, Using ld}, for a fuller description.
17914 @item -mh
17915 @opindex mh
17916 Generate code for the H8/300H@.
17918 @item -ms
17919 @opindex ms
17920 Generate code for the H8S@.
17922 @item -mn
17923 @opindex mn
17924 Generate code for the H8S and H8/300H in the normal mode.  This switch
17925 must be used either with @option{-mh} or @option{-ms}.
17927 @item -ms2600
17928 @opindex ms2600
17929 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
17931 @item -mexr
17932 @opindex mexr
17933 Extended registers are stored on stack before execution of function
17934 with monitor attribute. Default option is @option{-mexr}.
17935 This option is valid only for H8S targets.
17937 @item -mno-exr
17938 @opindex mno-exr
17939 Extended registers are not stored on stack before execution of function 
17940 with monitor attribute. Default option is @option{-mno-exr}. 
17941 This option is valid only for H8S targets.
17943 @item -mint32
17944 @opindex mint32
17945 Make @code{int} data 32 bits by default.
17947 @item -malign-300
17948 @opindex malign-300
17949 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
17950 The default for the H8/300H and H8S is to align longs and floats on
17951 4-byte boundaries.
17952 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
17953 This option has no effect on the H8/300.
17954 @end table
17956 @node HPPA Options
17957 @subsection HPPA Options
17958 @cindex HPPA Options
17960 These @samp{-m} options are defined for the HPPA family of computers:
17962 @table @gcctabopt
17963 @item -march=@var{architecture-type}
17964 @opindex march
17965 Generate code for the specified architecture.  The choices for
17966 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
17967 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
17968 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
17969 architecture option for your machine.  Code compiled for lower numbered
17970 architectures runs on higher numbered architectures, but not the
17971 other way around.
17973 @item -mpa-risc-1-0
17974 @itemx -mpa-risc-1-1
17975 @itemx -mpa-risc-2-0
17976 @opindex mpa-risc-1-0
17977 @opindex mpa-risc-1-1
17978 @opindex mpa-risc-2-0
17979 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
17981 @item -mcaller-copies
17982 @opindex mcaller-copies
17983 The caller copies function arguments passed by hidden reference.  This
17984 option should be used with care as it is not compatible with the default
17985 32-bit runtime.  However, only aggregates larger than eight bytes are
17986 passed by hidden reference and the option provides better compatibility
17987 with OpenMP.
17989 @item -mjump-in-delay
17990 @opindex mjump-in-delay
17991 This option is ignored and provided for compatibility purposes only.
17993 @item -mdisable-fpregs
17994 @opindex mdisable-fpregs
17995 Prevent floating-point registers from being used in any manner.  This is
17996 necessary for compiling kernels that perform lazy context switching of
17997 floating-point registers.  If you use this option and attempt to perform
17998 floating-point operations, the compiler aborts.
18000 @item -mdisable-indexing
18001 @opindex mdisable-indexing
18002 Prevent the compiler from using indexing address modes.  This avoids some
18003 rather obscure problems when compiling MIG generated code under MACH@.
18005 @item -mno-space-regs
18006 @opindex mno-space-regs
18007 Generate code that assumes the target has no space registers.  This allows
18008 GCC to generate faster indirect calls and use unscaled index address modes.
18010 Such code is suitable for level 0 PA systems and kernels.
18012 @item -mfast-indirect-calls
18013 @opindex mfast-indirect-calls
18014 Generate code that assumes calls never cross space boundaries.  This
18015 allows GCC to emit code that performs faster indirect calls.
18017 This option does not work in the presence of shared libraries or nested
18018 functions.
18020 @item -mfixed-range=@var{register-range}
18021 @opindex mfixed-range
18022 Generate code treating the given register range as fixed registers.
18023 A fixed register is one that the register allocator cannot use.  This is
18024 useful when compiling kernel code.  A register range is specified as
18025 two registers separated by a dash.  Multiple register ranges can be
18026 specified separated by a comma.
18028 @item -mlong-load-store
18029 @opindex mlong-load-store
18030 Generate 3-instruction load and store sequences as sometimes required by
18031 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
18032 the HP compilers.
18034 @item -mportable-runtime
18035 @opindex mportable-runtime
18036 Use the portable calling conventions proposed by HP for ELF systems.
18038 @item -mgas
18039 @opindex mgas
18040 Enable the use of assembler directives only GAS understands.
18042 @item -mschedule=@var{cpu-type}
18043 @opindex mschedule
18044 Schedule code according to the constraints for the machine type
18045 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
18046 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
18047 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
18048 proper scheduling option for your machine.  The default scheduling is
18049 @samp{8000}.
18051 @item -mlinker-opt
18052 @opindex mlinker-opt
18053 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
18054 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
18055 linkers in which they give bogus error messages when linking some programs.
18057 @item -msoft-float
18058 @opindex msoft-float
18059 Generate output containing library calls for floating point.
18060 @strong{Warning:} the requisite libraries are not available for all HPPA
18061 targets.  Normally the facilities of the machine's usual C compiler are
18062 used, but this cannot be done directly in cross-compilation.  You must make
18063 your own arrangements to provide suitable library functions for
18064 cross-compilation.
18066 @option{-msoft-float} changes the calling convention in the output file;
18067 therefore, it is only useful if you compile @emph{all} of a program with
18068 this option.  In particular, you need to compile @file{libgcc.a}, the
18069 library that comes with GCC, with @option{-msoft-float} in order for
18070 this to work.
18072 @item -msio
18073 @opindex msio
18074 Generate the predefine, @code{_SIO}, for server IO@.  The default is
18075 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
18076 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
18077 options are available under HP-UX and HI-UX@.
18079 @item -mgnu-ld
18080 @opindex mgnu-ld
18081 Use options specific to GNU @command{ld}.
18082 This passes @option{-shared} to @command{ld} when
18083 building a shared library.  It is the default when GCC is configured,
18084 explicitly or implicitly, with the GNU linker.  This option does not
18085 affect which @command{ld} is called; it only changes what parameters
18086 are passed to that @command{ld}.
18087 The @command{ld} that is called is determined by the
18088 @option{--with-ld} configure option, GCC's program search path, and
18089 finally by the user's @env{PATH}.  The linker used by GCC can be printed
18090 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
18091 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
18093 @item -mhp-ld
18094 @opindex mhp-ld
18095 Use options specific to HP @command{ld}.
18096 This passes @option{-b} to @command{ld} when building
18097 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
18098 links.  It is the default when GCC is configured, explicitly or
18099 implicitly, with the HP linker.  This option does not affect
18100 which @command{ld} is called; it only changes what parameters are passed to that
18101 @command{ld}.
18102 The @command{ld} that is called is determined by the @option{--with-ld}
18103 configure option, GCC's program search path, and finally by the user's
18104 @env{PATH}.  The linker used by GCC can be printed using @samp{which
18105 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
18106 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
18108 @item -mlong-calls
18109 @opindex mno-long-calls
18110 Generate code that uses long call sequences.  This ensures that a call
18111 is always able to reach linker generated stubs.  The default is to generate
18112 long calls only when the distance from the call site to the beginning
18113 of the function or translation unit, as the case may be, exceeds a
18114 predefined limit set by the branch type being used.  The limits for
18115 normal calls are 7,600,000 and 240,000 bytes, respectively for the
18116 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
18117 240,000 bytes.
18119 Distances are measured from the beginning of functions when using the
18120 @option{-ffunction-sections} option, or when using the @option{-mgas}
18121 and @option{-mno-portable-runtime} options together under HP-UX with
18122 the SOM linker.
18124 It is normally not desirable to use this option as it degrades
18125 performance.  However, it may be useful in large applications,
18126 particularly when partial linking is used to build the application.
18128 The types of long calls used depends on the capabilities of the
18129 assembler and linker, and the type of code being generated.  The
18130 impact on systems that support long absolute calls, and long pic
18131 symbol-difference or pc-relative calls should be relatively small.
18132 However, an indirect call is used on 32-bit ELF systems in pic code
18133 and it is quite long.
18135 @item -munix=@var{unix-std}
18136 @opindex march
18137 Generate compiler predefines and select a startfile for the specified
18138 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
18139 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
18140 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
18141 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
18142 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
18143 and later.
18145 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
18146 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
18147 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
18148 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
18149 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
18150 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
18152 It is @emph{important} to note that this option changes the interfaces
18153 for various library routines.  It also affects the operational behavior
18154 of the C library.  Thus, @emph{extreme} care is needed in using this
18155 option.
18157 Library code that is intended to operate with more than one UNIX
18158 standard must test, set and restore the variable @code{__xpg4_extended_mask}
18159 as appropriate.  Most GNU software doesn't provide this capability.
18161 @item -nolibdld
18162 @opindex nolibdld
18163 Suppress the generation of link options to search libdld.sl when the
18164 @option{-static} option is specified on HP-UX 10 and later.
18166 @item -static
18167 @opindex static
18168 The HP-UX implementation of setlocale in libc has a dependency on
18169 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
18170 when the @option{-static} option is specified, special link options
18171 are needed to resolve this dependency.
18173 On HP-UX 10 and later, the GCC driver adds the necessary options to
18174 link with libdld.sl when the @option{-static} option is specified.
18175 This causes the resulting binary to be dynamic.  On the 64-bit port,
18176 the linkers generate dynamic binaries by default in any case.  The
18177 @option{-nolibdld} option can be used to prevent the GCC driver from
18178 adding these link options.
18180 @item -threads
18181 @opindex threads
18182 Add support for multithreading with the @dfn{dce thread} library
18183 under HP-UX@.  This option sets flags for both the preprocessor and
18184 linker.
18185 @end table
18187 @node IA-64 Options
18188 @subsection IA-64 Options
18189 @cindex IA-64 Options
18191 These are the @samp{-m} options defined for the Intel IA-64 architecture.
18193 @table @gcctabopt
18194 @item -mbig-endian
18195 @opindex mbig-endian
18196 Generate code for a big-endian target.  This is the default for HP-UX@.
18198 @item -mlittle-endian
18199 @opindex mlittle-endian
18200 Generate code for a little-endian target.  This is the default for AIX5
18201 and GNU/Linux.
18203 @item -mgnu-as
18204 @itemx -mno-gnu-as
18205 @opindex mgnu-as
18206 @opindex mno-gnu-as
18207 Generate (or don't) code for the GNU assembler.  This is the default.
18208 @c Also, this is the default if the configure option @option{--with-gnu-as}
18209 @c is used.
18211 @item -mgnu-ld
18212 @itemx -mno-gnu-ld
18213 @opindex mgnu-ld
18214 @opindex mno-gnu-ld
18215 Generate (or don't) code for the GNU linker.  This is the default.
18216 @c Also, this is the default if the configure option @option{--with-gnu-ld}
18217 @c is used.
18219 @item -mno-pic
18220 @opindex mno-pic
18221 Generate code that does not use a global pointer register.  The result
18222 is not position independent code, and violates the IA-64 ABI@.
18224 @item -mvolatile-asm-stop
18225 @itemx -mno-volatile-asm-stop
18226 @opindex mvolatile-asm-stop
18227 @opindex mno-volatile-asm-stop
18228 Generate (or don't) a stop bit immediately before and after volatile asm
18229 statements.
18231 @item -mregister-names
18232 @itemx -mno-register-names
18233 @opindex mregister-names
18234 @opindex mno-register-names
18235 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
18236 the stacked registers.  This may make assembler output more readable.
18238 @item -mno-sdata
18239 @itemx -msdata
18240 @opindex mno-sdata
18241 @opindex msdata
18242 Disable (or enable) optimizations that use the small data section.  This may
18243 be useful for working around optimizer bugs.
18245 @item -mconstant-gp
18246 @opindex mconstant-gp
18247 Generate code that uses a single constant global pointer value.  This is
18248 useful when compiling kernel code.
18250 @item -mauto-pic
18251 @opindex mauto-pic
18252 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
18253 This is useful when compiling firmware code.
18255 @item -minline-float-divide-min-latency
18256 @opindex minline-float-divide-min-latency
18257 Generate code for inline divides of floating-point values
18258 using the minimum latency algorithm.
18260 @item -minline-float-divide-max-throughput
18261 @opindex minline-float-divide-max-throughput
18262 Generate code for inline divides of floating-point values
18263 using the maximum throughput algorithm.
18265 @item -mno-inline-float-divide
18266 @opindex mno-inline-float-divide
18267 Do not generate inline code for divides of floating-point values.
18269 @item -minline-int-divide-min-latency
18270 @opindex minline-int-divide-min-latency
18271 Generate code for inline divides of integer values
18272 using the minimum latency algorithm.
18274 @item -minline-int-divide-max-throughput
18275 @opindex minline-int-divide-max-throughput
18276 Generate code for inline divides of integer values
18277 using the maximum throughput algorithm.
18279 @item -mno-inline-int-divide
18280 @opindex mno-inline-int-divide
18281 Do not generate inline code for divides of integer values.
18283 @item -minline-sqrt-min-latency
18284 @opindex minline-sqrt-min-latency
18285 Generate code for inline square roots
18286 using the minimum latency algorithm.
18288 @item -minline-sqrt-max-throughput
18289 @opindex minline-sqrt-max-throughput
18290 Generate code for inline square roots
18291 using the maximum throughput algorithm.
18293 @item -mno-inline-sqrt
18294 @opindex mno-inline-sqrt
18295 Do not generate inline code for @code{sqrt}.
18297 @item -mfused-madd
18298 @itemx -mno-fused-madd
18299 @opindex mfused-madd
18300 @opindex mno-fused-madd
18301 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
18302 instructions.  The default is to use these instructions.
18304 @item -mno-dwarf2-asm
18305 @itemx -mdwarf2-asm
18306 @opindex mno-dwarf2-asm
18307 @opindex mdwarf2-asm
18308 Don't (or do) generate assembler code for the DWARF line number debugging
18309 info.  This may be useful when not using the GNU assembler.
18311 @item -mearly-stop-bits
18312 @itemx -mno-early-stop-bits
18313 @opindex mearly-stop-bits
18314 @opindex mno-early-stop-bits
18315 Allow stop bits to be placed earlier than immediately preceding the
18316 instruction that triggered the stop bit.  This can improve instruction
18317 scheduling, but does not always do so.
18319 @item -mfixed-range=@var{register-range}
18320 @opindex mfixed-range
18321 Generate code treating the given register range as fixed registers.
18322 A fixed register is one that the register allocator cannot use.  This is
18323 useful when compiling kernel code.  A register range is specified as
18324 two registers separated by a dash.  Multiple register ranges can be
18325 specified separated by a comma.
18327 @item -mtls-size=@var{tls-size}
18328 @opindex mtls-size
18329 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
18332 @item -mtune=@var{cpu-type}
18333 @opindex mtune
18334 Tune the instruction scheduling for a particular CPU, Valid values are
18335 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
18336 and @samp{mckinley}.
18338 @item -milp32
18339 @itemx -mlp64
18340 @opindex milp32
18341 @opindex mlp64
18342 Generate code for a 32-bit or 64-bit environment.
18343 The 32-bit environment sets int, long and pointer to 32 bits.
18344 The 64-bit environment sets int to 32 bits and long and pointer
18345 to 64 bits.  These are HP-UX specific flags.
18347 @item -mno-sched-br-data-spec
18348 @itemx -msched-br-data-spec
18349 @opindex mno-sched-br-data-spec
18350 @opindex msched-br-data-spec
18351 (Dis/En)able data speculative scheduling before reload.
18352 This results in generation of @code{ld.a} instructions and
18353 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
18354 The default setting is disabled.
18356 @item -msched-ar-data-spec
18357 @itemx -mno-sched-ar-data-spec
18358 @opindex msched-ar-data-spec
18359 @opindex mno-sched-ar-data-spec
18360 (En/Dis)able data speculative scheduling after reload.
18361 This results in generation of @code{ld.a} instructions and
18362 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
18363 The default setting is enabled.
18365 @item -mno-sched-control-spec
18366 @itemx -msched-control-spec
18367 @opindex mno-sched-control-spec
18368 @opindex msched-control-spec
18369 (Dis/En)able control speculative scheduling.  This feature is
18370 available only during region scheduling (i.e.@: before reload).
18371 This results in generation of the @code{ld.s} instructions and
18372 the corresponding check instructions @code{chk.s}.
18373 The default setting is disabled.
18375 @item -msched-br-in-data-spec
18376 @itemx -mno-sched-br-in-data-spec
18377 @opindex msched-br-in-data-spec
18378 @opindex mno-sched-br-in-data-spec
18379 (En/Dis)able speculative scheduling of the instructions that
18380 are dependent on the data speculative loads before reload.
18381 This is effective only with @option{-msched-br-data-spec} enabled.
18382 The default setting is enabled.
18384 @item -msched-ar-in-data-spec
18385 @itemx -mno-sched-ar-in-data-spec
18386 @opindex msched-ar-in-data-spec
18387 @opindex mno-sched-ar-in-data-spec
18388 (En/Dis)able speculative scheduling of the instructions that
18389 are dependent on the data speculative loads after reload.
18390 This is effective only with @option{-msched-ar-data-spec} enabled.
18391 The default setting is enabled.
18393 @item -msched-in-control-spec
18394 @itemx -mno-sched-in-control-spec
18395 @opindex msched-in-control-spec
18396 @opindex mno-sched-in-control-spec
18397 (En/Dis)able speculative scheduling of the instructions that
18398 are dependent on the control speculative loads.
18399 This is effective only with @option{-msched-control-spec} enabled.
18400 The default setting is enabled.
18402 @item -mno-sched-prefer-non-data-spec-insns
18403 @itemx -msched-prefer-non-data-spec-insns
18404 @opindex mno-sched-prefer-non-data-spec-insns
18405 @opindex msched-prefer-non-data-spec-insns
18406 If enabled, data-speculative instructions are chosen for schedule
18407 only if there are no other choices at the moment.  This makes
18408 the use of the data speculation much more conservative.
18409 The default setting is disabled.
18411 @item -mno-sched-prefer-non-control-spec-insns
18412 @itemx -msched-prefer-non-control-spec-insns
18413 @opindex mno-sched-prefer-non-control-spec-insns
18414 @opindex msched-prefer-non-control-spec-insns
18415 If enabled, control-speculative instructions are chosen for schedule
18416 only if there are no other choices at the moment.  This makes
18417 the use of the control speculation much more conservative.
18418 The default setting is disabled.
18420 @item -mno-sched-count-spec-in-critical-path
18421 @itemx -msched-count-spec-in-critical-path
18422 @opindex mno-sched-count-spec-in-critical-path
18423 @opindex msched-count-spec-in-critical-path
18424 If enabled, speculative dependencies are considered during
18425 computation of the instructions priorities.  This makes the use of the
18426 speculation a bit more conservative.
18427 The default setting is disabled.
18429 @item -msched-spec-ldc
18430 @opindex msched-spec-ldc
18431 Use a simple data speculation check.  This option is on by default.
18433 @item -msched-control-spec-ldc
18434 @opindex msched-spec-ldc
18435 Use a simple check for control speculation.  This option is on by default.
18437 @item -msched-stop-bits-after-every-cycle
18438 @opindex msched-stop-bits-after-every-cycle
18439 Place a stop bit after every cycle when scheduling.  This option is on
18440 by default.
18442 @item -msched-fp-mem-deps-zero-cost
18443 @opindex msched-fp-mem-deps-zero-cost
18444 Assume that floating-point stores and loads are not likely to cause a conflict
18445 when placed into the same instruction group.  This option is disabled by
18446 default.
18448 @item -msel-sched-dont-check-control-spec
18449 @opindex msel-sched-dont-check-control-spec
18450 Generate checks for control speculation in selective scheduling.
18451 This flag is disabled by default.
18453 @item -msched-max-memory-insns=@var{max-insns}
18454 @opindex msched-max-memory-insns
18455 Limit on the number of memory insns per instruction group, giving lower
18456 priority to subsequent memory insns attempting to schedule in the same
18457 instruction group. Frequently useful to prevent cache bank conflicts.
18458 The default value is 1.
18460 @item -msched-max-memory-insns-hard-limit
18461 @opindex msched-max-memory-insns-hard-limit
18462 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
18463 disallowing more than that number in an instruction group.
18464 Otherwise, the limit is ``soft'', meaning that non-memory operations
18465 are preferred when the limit is reached, but memory operations may still
18466 be scheduled.
18468 @end table
18470 @node LM32 Options
18471 @subsection LM32 Options
18472 @cindex LM32 options
18474 These @option{-m} options are defined for the LatticeMico32 architecture:
18476 @table @gcctabopt
18477 @item -mbarrel-shift-enabled
18478 @opindex mbarrel-shift-enabled
18479 Enable barrel-shift instructions.
18481 @item -mdivide-enabled
18482 @opindex mdivide-enabled
18483 Enable divide and modulus instructions.
18485 @item -mmultiply-enabled
18486 @opindex multiply-enabled
18487 Enable multiply instructions.
18489 @item -msign-extend-enabled
18490 @opindex msign-extend-enabled
18491 Enable sign extend instructions.
18493 @item -muser-enabled
18494 @opindex muser-enabled
18495 Enable user-defined instructions.
18497 @end table
18499 @node M32C Options
18500 @subsection M32C Options
18501 @cindex M32C options
18503 @table @gcctabopt
18504 @item -mcpu=@var{name}
18505 @opindex mcpu=
18506 Select the CPU for which code is generated.  @var{name} may be one of
18507 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
18508 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
18509 the M32C/80 series.
18511 @item -msim
18512 @opindex msim
18513 Specifies that the program will be run on the simulator.  This causes
18514 an alternate runtime library to be linked in which supports, for
18515 example, file I/O@.  You must not use this option when generating
18516 programs that will run on real hardware; you must provide your own
18517 runtime library for whatever I/O functions are needed.
18519 @item -memregs=@var{number}
18520 @opindex memregs=
18521 Specifies the number of memory-based pseudo-registers GCC uses
18522 during code generation.  These pseudo-registers are used like real
18523 registers, so there is a tradeoff between GCC's ability to fit the
18524 code into available registers, and the performance penalty of using
18525 memory instead of registers.  Note that all modules in a program must
18526 be compiled with the same value for this option.  Because of that, you
18527 must not use this option with GCC's default runtime libraries.
18529 @end table
18531 @node M32R/D Options
18532 @subsection M32R/D Options
18533 @cindex M32R/D options
18535 These @option{-m} options are defined for Renesas M32R/D architectures:
18537 @table @gcctabopt
18538 @item -m32r2
18539 @opindex m32r2
18540 Generate code for the M32R/2@.
18542 @item -m32rx
18543 @opindex m32rx
18544 Generate code for the M32R/X@.
18546 @item -m32r
18547 @opindex m32r
18548 Generate code for the M32R@.  This is the default.
18550 @item -mmodel=small
18551 @opindex mmodel=small
18552 Assume all objects live in the lower 16MB of memory (so that their addresses
18553 can be loaded with the @code{ld24} instruction), and assume all subroutines
18554 are reachable with the @code{bl} instruction.
18555 This is the default.
18557 The addressability of a particular object can be set with the
18558 @code{model} attribute.
18560 @item -mmodel=medium
18561 @opindex mmodel=medium
18562 Assume objects may be anywhere in the 32-bit address space (the compiler
18563 generates @code{seth/add3} instructions to load their addresses), and
18564 assume all subroutines are reachable with the @code{bl} instruction.
18566 @item -mmodel=large
18567 @opindex mmodel=large
18568 Assume objects may be anywhere in the 32-bit address space (the compiler
18569 generates @code{seth/add3} instructions to load their addresses), and
18570 assume subroutines may not be reachable with the @code{bl} instruction
18571 (the compiler generates the much slower @code{seth/add3/jl}
18572 instruction sequence).
18574 @item -msdata=none
18575 @opindex msdata=none
18576 Disable use of the small data area.  Variables are put into
18577 one of @code{.data}, @code{.bss}, or @code{.rodata} (unless the
18578 @code{section} attribute has been specified).
18579 This is the default.
18581 The small data area consists of sections @code{.sdata} and @code{.sbss}.
18582 Objects may be explicitly put in the small data area with the
18583 @code{section} attribute using one of these sections.
18585 @item -msdata=sdata
18586 @opindex msdata=sdata
18587 Put small global and static data in the small data area, but do not
18588 generate special code to reference them.
18590 @item -msdata=use
18591 @opindex msdata=use
18592 Put small global and static data in the small data area, and generate
18593 special instructions to reference them.
18595 @item -G @var{num}
18596 @opindex G
18597 @cindex smaller data references
18598 Put global and static objects less than or equal to @var{num} bytes
18599 into the small data or BSS sections instead of the normal data or BSS
18600 sections.  The default value of @var{num} is 8.
18601 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
18602 for this option to have any effect.
18604 All modules should be compiled with the same @option{-G @var{num}} value.
18605 Compiling with different values of @var{num} may or may not work; if it
18606 doesn't the linker gives an error message---incorrect code is not
18607 generated.
18609 @item -mdebug
18610 @opindex mdebug
18611 Makes the M32R-specific code in the compiler display some statistics
18612 that might help in debugging programs.
18614 @item -malign-loops
18615 @opindex malign-loops
18616 Align all loops to a 32-byte boundary.
18618 @item -mno-align-loops
18619 @opindex mno-align-loops
18620 Do not enforce a 32-byte alignment for loops.  This is the default.
18622 @item -missue-rate=@var{number}
18623 @opindex missue-rate=@var{number}
18624 Issue @var{number} instructions per cycle.  @var{number} can only be 1
18625 or 2.
18627 @item -mbranch-cost=@var{number}
18628 @opindex mbranch-cost=@var{number}
18629 @var{number} can only be 1 or 2.  If it is 1 then branches are
18630 preferred over conditional code, if it is 2, then the opposite applies.
18632 @item -mflush-trap=@var{number}
18633 @opindex mflush-trap=@var{number}
18634 Specifies the trap number to use to flush the cache.  The default is
18635 12.  Valid numbers are between 0 and 15 inclusive.
18637 @item -mno-flush-trap
18638 @opindex mno-flush-trap
18639 Specifies that the cache cannot be flushed by using a trap.
18641 @item -mflush-func=@var{name}
18642 @opindex mflush-func=@var{name}
18643 Specifies the name of the operating system function to call to flush
18644 the cache.  The default is @samp{_flush_cache}, but a function call
18645 is only used if a trap is not available.
18647 @item -mno-flush-func
18648 @opindex mno-flush-func
18649 Indicates that there is no OS function for flushing the cache.
18651 @end table
18653 @node M680x0 Options
18654 @subsection M680x0 Options
18655 @cindex M680x0 options
18657 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
18658 The default settings depend on which architecture was selected when
18659 the compiler was configured; the defaults for the most common choices
18660 are given below.
18662 @table @gcctabopt
18663 @item -march=@var{arch}
18664 @opindex march
18665 Generate code for a specific M680x0 or ColdFire instruction set
18666 architecture.  Permissible values of @var{arch} for M680x0
18667 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
18668 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
18669 architectures are selected according to Freescale's ISA classification
18670 and the permissible values are: @samp{isaa}, @samp{isaaplus},
18671 @samp{isab} and @samp{isac}.
18673 GCC defines a macro @code{__mcf@var{arch}__} whenever it is generating
18674 code for a ColdFire target.  The @var{arch} in this macro is one of the
18675 @option{-march} arguments given above.
18677 When used together, @option{-march} and @option{-mtune} select code
18678 that runs on a family of similar processors but that is optimized
18679 for a particular microarchitecture.
18681 @item -mcpu=@var{cpu}
18682 @opindex mcpu
18683 Generate code for a specific M680x0 or ColdFire processor.
18684 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
18685 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
18686 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
18687 below, which also classifies the CPUs into families:
18689 @multitable @columnfractions 0.20 0.80
18690 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
18691 @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}
18692 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
18693 @item @samp{5206e} @tab @samp{5206e}
18694 @item @samp{5208} @tab @samp{5207} @samp{5208}
18695 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
18696 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
18697 @item @samp{5216} @tab @samp{5214} @samp{5216}
18698 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
18699 @item @samp{5225} @tab @samp{5224} @samp{5225}
18700 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
18701 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
18702 @item @samp{5249} @tab @samp{5249}
18703 @item @samp{5250} @tab @samp{5250}
18704 @item @samp{5271} @tab @samp{5270} @samp{5271}
18705 @item @samp{5272} @tab @samp{5272}
18706 @item @samp{5275} @tab @samp{5274} @samp{5275}
18707 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
18708 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
18709 @item @samp{5307} @tab @samp{5307}
18710 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
18711 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
18712 @item @samp{5407} @tab @samp{5407}
18713 @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}
18714 @end multitable
18716 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
18717 @var{arch} is compatible with @var{cpu}.  Other combinations of
18718 @option{-mcpu} and @option{-march} are rejected.
18720 GCC defines the macro @code{__mcf_cpu_@var{cpu}} when ColdFire target
18721 @var{cpu} is selected.  It also defines @code{__mcf_family_@var{family}},
18722 where the value of @var{family} is given by the table above.
18724 @item -mtune=@var{tune}
18725 @opindex mtune
18726 Tune the code for a particular microarchitecture within the
18727 constraints set by @option{-march} and @option{-mcpu}.
18728 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
18729 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
18730 and @samp{cpu32}.  The ColdFire microarchitectures
18731 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
18733 You can also use @option{-mtune=68020-40} for code that needs
18734 to run relatively well on 68020, 68030 and 68040 targets.
18735 @option{-mtune=68020-60} is similar but includes 68060 targets
18736 as well.  These two options select the same tuning decisions as
18737 @option{-m68020-40} and @option{-m68020-60} respectively.
18739 GCC defines the macros @code{__mc@var{arch}} and @code{__mc@var{arch}__}
18740 when tuning for 680x0 architecture @var{arch}.  It also defines
18741 @code{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
18742 option is used.  If GCC is tuning for a range of architectures,
18743 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
18744 it defines the macros for every architecture in the range.
18746 GCC also defines the macro @code{__m@var{uarch}__} when tuning for
18747 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
18748 of the arguments given above.
18750 @item -m68000
18751 @itemx -mc68000
18752 @opindex m68000
18753 @opindex mc68000
18754 Generate output for a 68000.  This is the default
18755 when the compiler is configured for 68000-based systems.
18756 It is equivalent to @option{-march=68000}.
18758 Use this option for microcontrollers with a 68000 or EC000 core,
18759 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
18761 @item -m68010
18762 @opindex m68010
18763 Generate output for a 68010.  This is the default
18764 when the compiler is configured for 68010-based systems.
18765 It is equivalent to @option{-march=68010}.
18767 @item -m68020
18768 @itemx -mc68020
18769 @opindex m68020
18770 @opindex mc68020
18771 Generate output for a 68020.  This is the default
18772 when the compiler is configured for 68020-based systems.
18773 It is equivalent to @option{-march=68020}.
18775 @item -m68030
18776 @opindex m68030
18777 Generate output for a 68030.  This is the default when the compiler is
18778 configured for 68030-based systems.  It is equivalent to
18779 @option{-march=68030}.
18781 @item -m68040
18782 @opindex m68040
18783 Generate output for a 68040.  This is the default when the compiler is
18784 configured for 68040-based systems.  It is equivalent to
18785 @option{-march=68040}.
18787 This option inhibits the use of 68881/68882 instructions that have to be
18788 emulated by software on the 68040.  Use this option if your 68040 does not
18789 have code to emulate those instructions.
18791 @item -m68060
18792 @opindex m68060
18793 Generate output for a 68060.  This is the default when the compiler is
18794 configured for 68060-based systems.  It is equivalent to
18795 @option{-march=68060}.
18797 This option inhibits the use of 68020 and 68881/68882 instructions that
18798 have to be emulated by software on the 68060.  Use this option if your 68060
18799 does not have code to emulate those instructions.
18801 @item -mcpu32
18802 @opindex mcpu32
18803 Generate output for a CPU32.  This is the default
18804 when the compiler is configured for CPU32-based systems.
18805 It is equivalent to @option{-march=cpu32}.
18807 Use this option for microcontrollers with a
18808 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
18809 68336, 68340, 68341, 68349 and 68360.
18811 @item -m5200
18812 @opindex m5200
18813 Generate output for a 520X ColdFire CPU@.  This is the default
18814 when the compiler is configured for 520X-based systems.
18815 It is equivalent to @option{-mcpu=5206}, and is now deprecated
18816 in favor of that option.
18818 Use this option for microcontroller with a 5200 core, including
18819 the MCF5202, MCF5203, MCF5204 and MCF5206.
18821 @item -m5206e
18822 @opindex m5206e
18823 Generate output for a 5206e ColdFire CPU@.  The option is now
18824 deprecated in favor of the equivalent @option{-mcpu=5206e}.
18826 @item -m528x
18827 @opindex m528x
18828 Generate output for a member of the ColdFire 528X family.
18829 The option is now deprecated in favor of the equivalent
18830 @option{-mcpu=528x}.
18832 @item -m5307
18833 @opindex m5307
18834 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
18835 in favor of the equivalent @option{-mcpu=5307}.
18837 @item -m5407
18838 @opindex m5407
18839 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
18840 in favor of the equivalent @option{-mcpu=5407}.
18842 @item -mcfv4e
18843 @opindex mcfv4e
18844 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
18845 This includes use of hardware floating-point instructions.
18846 The option is equivalent to @option{-mcpu=547x}, and is now
18847 deprecated in favor of that option.
18849 @item -m68020-40
18850 @opindex m68020-40
18851 Generate output for a 68040, without using any of the new instructions.
18852 This results in code that can run relatively efficiently on either a
18853 68020/68881 or a 68030 or a 68040.  The generated code does use the
18854 68881 instructions that are emulated on the 68040.
18856 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
18858 @item -m68020-60
18859 @opindex m68020-60
18860 Generate output for a 68060, without using any of the new instructions.
18861 This results in code that can run relatively efficiently on either a
18862 68020/68881 or a 68030 or a 68040.  The generated code does use the
18863 68881 instructions that are emulated on the 68060.
18865 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
18867 @item -mhard-float
18868 @itemx -m68881
18869 @opindex mhard-float
18870 @opindex m68881
18871 Generate floating-point instructions.  This is the default for 68020
18872 and above, and for ColdFire devices that have an FPU@.  It defines the
18873 macro @code{__HAVE_68881__} on M680x0 targets and @code{__mcffpu__}
18874 on ColdFire targets.
18876 @item -msoft-float
18877 @opindex msoft-float
18878 Do not generate floating-point instructions; use library calls instead.
18879 This is the default for 68000, 68010, and 68832 targets.  It is also
18880 the default for ColdFire devices that have no FPU.
18882 @item -mdiv
18883 @itemx -mno-div
18884 @opindex mdiv
18885 @opindex mno-div
18886 Generate (do not generate) ColdFire hardware divide and remainder
18887 instructions.  If @option{-march} is used without @option{-mcpu},
18888 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
18889 architectures.  Otherwise, the default is taken from the target CPU
18890 (either the default CPU, or the one specified by @option{-mcpu}).  For
18891 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
18892 @option{-mcpu=5206e}.
18894 GCC defines the macro @code{__mcfhwdiv__} when this option is enabled.
18896 @item -mshort
18897 @opindex mshort
18898 Consider type @code{int} to be 16 bits wide, like @code{short int}.
18899 Additionally, parameters passed on the stack are also aligned to a
18900 16-bit boundary even on targets whose API mandates promotion to 32-bit.
18902 @item -mno-short
18903 @opindex mno-short
18904 Do not consider type @code{int} to be 16 bits wide.  This is the default.
18906 @item -mnobitfield
18907 @itemx -mno-bitfield
18908 @opindex mnobitfield
18909 @opindex mno-bitfield
18910 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
18911 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
18913 @item -mbitfield
18914 @opindex mbitfield
18915 Do use the bit-field instructions.  The @option{-m68020} option implies
18916 @option{-mbitfield}.  This is the default if you use a configuration
18917 designed for a 68020.
18919 @item -mrtd
18920 @opindex mrtd
18921 Use a different function-calling convention, in which functions
18922 that take a fixed number of arguments return with the @code{rtd}
18923 instruction, which pops their arguments while returning.  This
18924 saves one instruction in the caller since there is no need to pop
18925 the arguments there.
18927 This calling convention is incompatible with the one normally
18928 used on Unix, so you cannot use it if you need to call libraries
18929 compiled with the Unix compiler.
18931 Also, you must provide function prototypes for all functions that
18932 take variable numbers of arguments (including @code{printf});
18933 otherwise incorrect code is generated for calls to those
18934 functions.
18936 In addition, seriously incorrect code results if you call a
18937 function with too many arguments.  (Normally, extra arguments are
18938 harmlessly ignored.)
18940 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
18941 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
18943 @item -mno-rtd
18944 @opindex mno-rtd
18945 Do not use the calling conventions selected by @option{-mrtd}.
18946 This is the default.
18948 @item -malign-int
18949 @itemx -mno-align-int
18950 @opindex malign-int
18951 @opindex mno-align-int
18952 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
18953 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
18954 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
18955 Aligning variables on 32-bit boundaries produces code that runs somewhat
18956 faster on processors with 32-bit busses at the expense of more memory.
18958 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
18959 aligns structures containing the above types differently than
18960 most published application binary interface specifications for the m68k.
18962 @item -mpcrel
18963 @opindex mpcrel
18964 Use the pc-relative addressing mode of the 68000 directly, instead of
18965 using a global offset table.  At present, this option implies @option{-fpic},
18966 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
18967 not presently supported with @option{-mpcrel}, though this could be supported for
18968 68020 and higher processors.
18970 @item -mno-strict-align
18971 @itemx -mstrict-align
18972 @opindex mno-strict-align
18973 @opindex mstrict-align
18974 Do not (do) assume that unaligned memory references are handled by
18975 the system.
18977 @item -msep-data
18978 Generate code that allows the data segment to be located in a different
18979 area of memory from the text segment.  This allows for execute-in-place in
18980 an environment without virtual memory management.  This option implies
18981 @option{-fPIC}.
18983 @item -mno-sep-data
18984 Generate code that assumes that the data segment follows the text segment.
18985 This is the default.
18987 @item -mid-shared-library
18988 Generate code that supports shared libraries via the library ID method.
18989 This allows for execute-in-place and shared libraries in an environment
18990 without virtual memory management.  This option implies @option{-fPIC}.
18992 @item -mno-id-shared-library
18993 Generate code that doesn't assume ID-based shared libraries are being used.
18994 This is the default.
18996 @item -mshared-library-id=n
18997 Specifies the identification number of the ID-based shared library being
18998 compiled.  Specifying a value of 0 generates more compact code; specifying
18999 other values forces the allocation of that number to the current
19000 library, but is no more space- or time-efficient than omitting this option.
19002 @item -mxgot
19003 @itemx -mno-xgot
19004 @opindex mxgot
19005 @opindex mno-xgot
19006 When generating position-independent code for ColdFire, generate code
19007 that works if the GOT has more than 8192 entries.  This code is
19008 larger and slower than code generated without this option.  On M680x0
19009 processors, this option is not needed; @option{-fPIC} suffices.
19011 GCC normally uses a single instruction to load values from the GOT@.
19012 While this is relatively efficient, it only works if the GOT
19013 is smaller than about 64k.  Anything larger causes the linker
19014 to report an error such as:
19016 @cindex relocation truncated to fit (ColdFire)
19017 @smallexample
19018 relocation truncated to fit: R_68K_GOT16O foobar
19019 @end smallexample
19021 If this happens, you should recompile your code with @option{-mxgot}.
19022 It should then work with very large GOTs.  However, code generated with
19023 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
19024 the value of a global symbol.
19026 Note that some linkers, including newer versions of the GNU linker,
19027 can create multiple GOTs and sort GOT entries.  If you have such a linker,
19028 you should only need to use @option{-mxgot} when compiling a single
19029 object file that accesses more than 8192 GOT entries.  Very few do.
19031 These options have no effect unless GCC is generating
19032 position-independent code.
19034 @item -mlong-jump-table-offsets
19035 @opindex mlong-jump-table-offsets
19036 Use 32-bit offsets in @code{switch} tables.  The default is to use
19037 16-bit offsets.
19039 @end table
19041 @node MCore Options
19042 @subsection MCore Options
19043 @cindex MCore options
19045 These are the @samp{-m} options defined for the Motorola M*Core
19046 processors.
19048 @table @gcctabopt
19050 @item -mhardlit
19051 @itemx -mno-hardlit
19052 @opindex mhardlit
19053 @opindex mno-hardlit
19054 Inline constants into the code stream if it can be done in two
19055 instructions or less.
19057 @item -mdiv
19058 @itemx -mno-div
19059 @opindex mdiv
19060 @opindex mno-div
19061 Use the divide instruction.  (Enabled by default).
19063 @item -mrelax-immediate
19064 @itemx -mno-relax-immediate
19065 @opindex mrelax-immediate
19066 @opindex mno-relax-immediate
19067 Allow arbitrary-sized immediates in bit operations.
19069 @item -mwide-bitfields
19070 @itemx -mno-wide-bitfields
19071 @opindex mwide-bitfields
19072 @opindex mno-wide-bitfields
19073 Always treat bit-fields as @code{int}-sized.
19075 @item -m4byte-functions
19076 @itemx -mno-4byte-functions
19077 @opindex m4byte-functions
19078 @opindex mno-4byte-functions
19079 Force all functions to be aligned to a 4-byte boundary.
19081 @item -mcallgraph-data
19082 @itemx -mno-callgraph-data
19083 @opindex mcallgraph-data
19084 @opindex mno-callgraph-data
19085 Emit callgraph information.
19087 @item -mslow-bytes
19088 @itemx -mno-slow-bytes
19089 @opindex mslow-bytes
19090 @opindex mno-slow-bytes
19091 Prefer word access when reading byte quantities.
19093 @item -mlittle-endian
19094 @itemx -mbig-endian
19095 @opindex mlittle-endian
19096 @opindex mbig-endian
19097 Generate code for a little-endian target.
19099 @item -m210
19100 @itemx -m340
19101 @opindex m210
19102 @opindex m340
19103 Generate code for the 210 processor.
19105 @item -mno-lsim
19106 @opindex mno-lsim
19107 Assume that runtime support has been provided and so omit the
19108 simulator library (@file{libsim.a)} from the linker command line.
19110 @item -mstack-increment=@var{size}
19111 @opindex mstack-increment
19112 Set the maximum amount for a single stack increment operation.  Large
19113 values can increase the speed of programs that contain functions
19114 that need a large amount of stack space, but they can also trigger a
19115 segmentation fault if the stack is extended too much.  The default
19116 value is 0x1000.
19118 @end table
19120 @node MeP Options
19121 @subsection MeP Options
19122 @cindex MeP options
19124 @table @gcctabopt
19126 @item -mabsdiff
19127 @opindex mabsdiff
19128 Enables the @code{abs} instruction, which is the absolute difference
19129 between two registers.
19131 @item -mall-opts
19132 @opindex mall-opts
19133 Enables all the optional instructions---average, multiply, divide, bit
19134 operations, leading zero, absolute difference, min/max, clip, and
19135 saturation.
19138 @item -maverage
19139 @opindex maverage
19140 Enables the @code{ave} instruction, which computes the average of two
19141 registers.
19143 @item -mbased=@var{n}
19144 @opindex mbased=
19145 Variables of size @var{n} bytes or smaller are placed in the
19146 @code{.based} section by default.  Based variables use the @code{$tp}
19147 register as a base register, and there is a 128-byte limit to the
19148 @code{.based} section.
19150 @item -mbitops
19151 @opindex mbitops
19152 Enables the bit operation instructions---bit test (@code{btstm}), set
19153 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
19154 test-and-set (@code{tas}).
19156 @item -mc=@var{name}
19157 @opindex mc=
19158 Selects which section constant data is placed in.  @var{name} may
19159 be @samp{tiny}, @samp{near}, or @samp{far}.
19161 @item -mclip
19162 @opindex mclip
19163 Enables the @code{clip} instruction.  Note that @option{-mclip} is not
19164 useful unless you also provide @option{-mminmax}.
19166 @item -mconfig=@var{name}
19167 @opindex mconfig=
19168 Selects one of the built-in core configurations.  Each MeP chip has
19169 one or more modules in it; each module has a core CPU and a variety of
19170 coprocessors, optional instructions, and peripherals.  The
19171 @code{MeP-Integrator} tool, not part of GCC, provides these
19172 configurations through this option; using this option is the same as
19173 using all the corresponding command-line options.  The default
19174 configuration is @samp{default}.
19176 @item -mcop
19177 @opindex mcop
19178 Enables the coprocessor instructions.  By default, this is a 32-bit
19179 coprocessor.  Note that the coprocessor is normally enabled via the
19180 @option{-mconfig=} option.
19182 @item -mcop32
19183 @opindex mcop32
19184 Enables the 32-bit coprocessor's instructions.
19186 @item -mcop64
19187 @opindex mcop64
19188 Enables the 64-bit coprocessor's instructions.
19190 @item -mivc2
19191 @opindex mivc2
19192 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
19194 @item -mdc
19195 @opindex mdc
19196 Causes constant variables to be placed in the @code{.near} section.
19198 @item -mdiv
19199 @opindex mdiv
19200 Enables the @code{div} and @code{divu} instructions.
19202 @item -meb
19203 @opindex meb
19204 Generate big-endian code.
19206 @item -mel
19207 @opindex mel
19208 Generate little-endian code.
19210 @item -mio-volatile
19211 @opindex mio-volatile
19212 Tells the compiler that any variable marked with the @code{io}
19213 attribute is to be considered volatile.
19215 @item -ml
19216 @opindex ml
19217 Causes variables to be assigned to the @code{.far} section by default.
19219 @item -mleadz
19220 @opindex mleadz
19221 Enables the @code{leadz} (leading zero) instruction.
19223 @item -mm
19224 @opindex mm
19225 Causes variables to be assigned to the @code{.near} section by default.
19227 @item -mminmax
19228 @opindex mminmax
19229 Enables the @code{min} and @code{max} instructions.
19231 @item -mmult
19232 @opindex mmult
19233 Enables the multiplication and multiply-accumulate instructions.
19235 @item -mno-opts
19236 @opindex mno-opts
19237 Disables all the optional instructions enabled by @option{-mall-opts}.
19239 @item -mrepeat
19240 @opindex mrepeat
19241 Enables the @code{repeat} and @code{erepeat} instructions, used for
19242 low-overhead looping.
19244 @item -ms
19245 @opindex ms
19246 Causes all variables to default to the @code{.tiny} section.  Note
19247 that there is a 65536-byte limit to this section.  Accesses to these
19248 variables use the @code{%gp} base register.
19250 @item -msatur
19251 @opindex msatur
19252 Enables the saturation instructions.  Note that the compiler does not
19253 currently generate these itself, but this option is included for
19254 compatibility with other tools, like @code{as}.
19256 @item -msdram
19257 @opindex msdram
19258 Link the SDRAM-based runtime instead of the default ROM-based runtime.
19260 @item -msim
19261 @opindex msim
19262 Link the simulator run-time libraries.
19264 @item -msimnovec
19265 @opindex msimnovec
19266 Link the simulator runtime libraries, excluding built-in support
19267 for reset and exception vectors and tables.
19269 @item -mtf
19270 @opindex mtf
19271 Causes all functions to default to the @code{.far} section.  Without
19272 this option, functions default to the @code{.near} section.
19274 @item -mtiny=@var{n}
19275 @opindex mtiny=
19276 Variables that are @var{n} bytes or smaller are allocated to the
19277 @code{.tiny} section.  These variables use the @code{$gp} base
19278 register.  The default for this option is 4, but note that there's a
19279 65536-byte limit to the @code{.tiny} section.
19281 @end table
19283 @node MicroBlaze Options
19284 @subsection MicroBlaze Options
19285 @cindex MicroBlaze Options
19287 @table @gcctabopt
19289 @item -msoft-float
19290 @opindex msoft-float
19291 Use software emulation for floating point (default).
19293 @item -mhard-float
19294 @opindex mhard-float
19295 Use hardware floating-point instructions.
19297 @item -mmemcpy
19298 @opindex mmemcpy
19299 Do not optimize block moves, use @code{memcpy}.
19301 @item -mno-clearbss
19302 @opindex mno-clearbss
19303 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
19305 @item -mcpu=@var{cpu-type}
19306 @opindex mcpu=
19307 Use features of, and schedule code for, the given CPU.
19308 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
19309 where @var{X} is a major version, @var{YY} is the minor version, and
19310 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
19311 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
19313 @item -mxl-soft-mul
19314 @opindex mxl-soft-mul
19315 Use software multiply emulation (default).
19317 @item -mxl-soft-div
19318 @opindex mxl-soft-div
19319 Use software emulation for divides (default).
19321 @item -mxl-barrel-shift
19322 @opindex mxl-barrel-shift
19323 Use the hardware barrel shifter.
19325 @item -mxl-pattern-compare
19326 @opindex mxl-pattern-compare
19327 Use pattern compare instructions.
19329 @item -msmall-divides
19330 @opindex msmall-divides
19331 Use table lookup optimization for small signed integer divisions.
19333 @item -mxl-stack-check
19334 @opindex mxl-stack-check
19335 This option is deprecated.  Use @option{-fstack-check} instead.
19337 @item -mxl-gp-opt
19338 @opindex mxl-gp-opt
19339 Use GP-relative @code{.sdata}/@code{.sbss} sections.
19341 @item -mxl-multiply-high
19342 @opindex mxl-multiply-high
19343 Use multiply high instructions for high part of 32x32 multiply.
19345 @item -mxl-float-convert
19346 @opindex mxl-float-convert
19347 Use hardware floating-point conversion instructions.
19349 @item -mxl-float-sqrt
19350 @opindex mxl-float-sqrt
19351 Use hardware floating-point square root instruction.
19353 @item -mbig-endian
19354 @opindex mbig-endian
19355 Generate code for a big-endian target.
19357 @item -mlittle-endian
19358 @opindex mlittle-endian
19359 Generate code for a little-endian target.
19361 @item -mxl-reorder
19362 @opindex mxl-reorder
19363 Use reorder instructions (swap and byte reversed load/store).
19365 @item -mxl-mode-@var{app-model}
19366 Select application model @var{app-model}.  Valid models are
19367 @table @samp
19368 @item executable
19369 normal executable (default), uses startup code @file{crt0.o}.
19371 @item xmdstub
19372 for use with Xilinx Microprocessor Debugger (XMD) based
19373 software intrusive debug agent called xmdstub. This uses startup file
19374 @file{crt1.o} and sets the start address of the program to 0x800.
19376 @item bootstrap
19377 for applications that are loaded using a bootloader.
19378 This model uses startup file @file{crt2.o} which does not contain a processor
19379 reset vector handler. This is suitable for transferring control on a
19380 processor reset to the bootloader rather than the application.
19382 @item novectors
19383 for applications that do not require any of the
19384 MicroBlaze vectors. This option may be useful for applications running
19385 within a monitoring application. This model uses @file{crt3.o} as a startup file.
19386 @end table
19388 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
19389 @option{-mxl-mode-@var{app-model}}.
19391 @end table
19393 @node MIPS Options
19394 @subsection MIPS Options
19395 @cindex MIPS options
19397 @table @gcctabopt
19399 @item -EB
19400 @opindex EB
19401 Generate big-endian code.
19403 @item -EL
19404 @opindex EL
19405 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
19406 configurations.
19408 @item -march=@var{arch}
19409 @opindex march
19410 Generate code that runs on @var{arch}, which can be the name of a
19411 generic MIPS ISA, or the name of a particular processor.
19412 The ISA names are:
19413 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
19414 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5},
19415 @samp{mips32r6}, @samp{mips64}, @samp{mips64r2}, @samp{mips64r3},
19416 @samp{mips64r5} and @samp{mips64r6}.
19417 The processor names are:
19418 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
19419 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
19420 @samp{5kc}, @samp{5kf},
19421 @samp{20kc},
19422 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
19423 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
19424 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
19425 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
19426 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
19427 @samp{i6400},
19428 @samp{interaptiv},
19429 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
19430 @samp{m4k},
19431 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
19432 @samp{m5100}, @samp{m5101},
19433 @samp{octeon}, @samp{octeon+}, @samp{octeon2}, @samp{octeon3},
19434 @samp{orion},
19435 @samp{p5600},
19436 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
19437 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
19438 @samp{rm7000}, @samp{rm9000},
19439 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
19440 @samp{sb1},
19441 @samp{sr71000},
19442 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
19443 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
19444 @samp{xlr} and @samp{xlp}.
19445 The special value @samp{from-abi} selects the
19446 most compatible architecture for the selected ABI (that is,
19447 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
19449 The native Linux/GNU toolchain also supports the value @samp{native},
19450 which selects the best architecture option for the host processor.
19451 @option{-march=native} has no effect if GCC does not recognize
19452 the processor.
19454 In processor names, a final @samp{000} can be abbreviated as @samp{k}
19455 (for example, @option{-march=r2k}).  Prefixes are optional, and
19456 @samp{vr} may be written @samp{r}.
19458 Names of the form @samp{@var{n}f2_1} refer to processors with
19459 FPUs clocked at half the rate of the core, names of the form
19460 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
19461 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
19462 processors with FPUs clocked a ratio of 3:2 with respect to the core.
19463 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
19464 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
19465 accepted as synonyms for @samp{@var{n}f1_1}.
19467 GCC defines two macros based on the value of this option.  The first
19468 is @code{_MIPS_ARCH}, which gives the name of target architecture, as
19469 a string.  The second has the form @code{_MIPS_ARCH_@var{foo}},
19470 where @var{foo} is the capitalized value of @code{_MIPS_ARCH}@.
19471 For example, @option{-march=r2000} sets @code{_MIPS_ARCH}
19472 to @code{"r2000"} and defines the macro @code{_MIPS_ARCH_R2000}.
19474 Note that the @code{_MIPS_ARCH} macro uses the processor names given
19475 above.  In other words, it has the full prefix and does not
19476 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
19477 the macro names the resolved architecture (either @code{"mips1"} or
19478 @code{"mips3"}).  It names the default architecture when no
19479 @option{-march} option is given.
19481 @item -mtune=@var{arch}
19482 @opindex mtune
19483 Optimize for @var{arch}.  Among other things, this option controls
19484 the way instructions are scheduled, and the perceived cost of arithmetic
19485 operations.  The list of @var{arch} values is the same as for
19486 @option{-march}.
19488 When this option is not used, GCC optimizes for the processor
19489 specified by @option{-march}.  By using @option{-march} and
19490 @option{-mtune} together, it is possible to generate code that
19491 runs on a family of processors, but optimize the code for one
19492 particular member of that family.
19494 @option{-mtune} defines the macros @code{_MIPS_TUNE} and
19495 @code{_MIPS_TUNE_@var{foo}}, which work in the same way as the
19496 @option{-march} ones described above.
19498 @item -mips1
19499 @opindex mips1
19500 Equivalent to @option{-march=mips1}.
19502 @item -mips2
19503 @opindex mips2
19504 Equivalent to @option{-march=mips2}.
19506 @item -mips3
19507 @opindex mips3
19508 Equivalent to @option{-march=mips3}.
19510 @item -mips4
19511 @opindex mips4
19512 Equivalent to @option{-march=mips4}.
19514 @item -mips32
19515 @opindex mips32
19516 Equivalent to @option{-march=mips32}.
19518 @item -mips32r3
19519 @opindex mips32r3
19520 Equivalent to @option{-march=mips32r3}.
19522 @item -mips32r5
19523 @opindex mips32r5
19524 Equivalent to @option{-march=mips32r5}.
19526 @item -mips32r6
19527 @opindex mips32r6
19528 Equivalent to @option{-march=mips32r6}.
19530 @item -mips64
19531 @opindex mips64
19532 Equivalent to @option{-march=mips64}.
19534 @item -mips64r2
19535 @opindex mips64r2
19536 Equivalent to @option{-march=mips64r2}.
19538 @item -mips64r3
19539 @opindex mips64r3
19540 Equivalent to @option{-march=mips64r3}.
19542 @item -mips64r5
19543 @opindex mips64r5
19544 Equivalent to @option{-march=mips64r5}.
19546 @item -mips64r6
19547 @opindex mips64r6
19548 Equivalent to @option{-march=mips64r6}.
19550 @item -mips16
19551 @itemx -mno-mips16
19552 @opindex mips16
19553 @opindex mno-mips16
19554 Generate (do not generate) MIPS16 code.  If GCC is targeting a
19555 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
19557 MIPS16 code generation can also be controlled on a per-function basis
19558 by means of @code{mips16} and @code{nomips16} attributes.
19559 @xref{Function Attributes}, for more information.
19561 @item -mflip-mips16
19562 @opindex mflip-mips16
19563 Generate MIPS16 code on alternating functions.  This option is provided
19564 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
19565 not intended for ordinary use in compiling user code.
19567 @item -minterlink-compressed
19568 @item -mno-interlink-compressed
19569 @opindex minterlink-compressed
19570 @opindex mno-interlink-compressed
19571 Require (do not require) that code using the standard (uncompressed) MIPS ISA
19572 be link-compatible with MIPS16 and microMIPS code, and vice versa.
19574 For example, code using the standard ISA encoding cannot jump directly
19575 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
19576 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
19577 knows that the target of the jump is not compressed.
19579 @item -minterlink-mips16
19580 @itemx -mno-interlink-mips16
19581 @opindex minterlink-mips16
19582 @opindex mno-interlink-mips16
19583 Aliases of @option{-minterlink-compressed} and
19584 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
19585 and are retained for backwards compatibility.
19587 @item -mabi=32
19588 @itemx -mabi=o64
19589 @itemx -mabi=n32
19590 @itemx -mabi=64
19591 @itemx -mabi=eabi
19592 @opindex mabi=32
19593 @opindex mabi=o64
19594 @opindex mabi=n32
19595 @opindex mabi=64
19596 @opindex mabi=eabi
19597 Generate code for the given ABI@.
19599 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
19600 generates 64-bit code when you select a 64-bit architecture, but you
19601 can use @option{-mgp32} to get 32-bit code instead.
19603 For information about the O64 ABI, see
19604 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
19606 GCC supports a variant of the o32 ABI in which floating-point registers
19607 are 64 rather than 32 bits wide.  You can select this combination with
19608 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
19609 and @code{mfhc1} instructions and is therefore only supported for
19610 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
19612 The register assignments for arguments and return values remain the
19613 same, but each scalar value is passed in a single 64-bit register
19614 rather than a pair of 32-bit registers.  For example, scalar
19615 floating-point values are returned in @samp{$f0} only, not a
19616 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
19617 remains the same in that the even-numbered double-precision registers
19618 are saved.
19620 Two additional variants of the o32 ABI are supported to enable
19621 a transition from 32-bit to 64-bit registers.  These are FPXX
19622 (@option{-mfpxx}) and FP64A (@option{-mfp64} @option{-mno-odd-spreg}).
19623 The FPXX extension mandates that all code must execute correctly
19624 when run using 32-bit or 64-bit registers.  The code can be interlinked
19625 with either FP32 or FP64, but not both.
19626 The FP64A extension is similar to the FP64 extension but forbids the
19627 use of odd-numbered single-precision registers.  This can be used
19628 in conjunction with the @code{FRE} mode of FPUs in MIPS32R5
19629 processors and allows both FP32 and FP64A code to interlink and
19630 run in the same process without changing FPU modes.
19632 @item -mabicalls
19633 @itemx -mno-abicalls
19634 @opindex mabicalls
19635 @opindex mno-abicalls
19636 Generate (do not generate) code that is suitable for SVR4-style
19637 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
19638 systems.
19640 @item -mshared
19641 @itemx -mno-shared
19642 Generate (do not generate) code that is fully position-independent,
19643 and that can therefore be linked into shared libraries.  This option
19644 only affects @option{-mabicalls}.
19646 All @option{-mabicalls} code has traditionally been position-independent,
19647 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
19648 as an extension, the GNU toolchain allows executables to use absolute
19649 accesses for locally-binding symbols.  It can also use shorter GP
19650 initialization sequences and generate direct calls to locally-defined
19651 functions.  This mode is selected by @option{-mno-shared}.
19653 @option{-mno-shared} depends on binutils 2.16 or higher and generates
19654 objects that can only be linked by the GNU linker.  However, the option
19655 does not affect the ABI of the final executable; it only affects the ABI
19656 of relocatable objects.  Using @option{-mno-shared} generally makes
19657 executables both smaller and quicker.
19659 @option{-mshared} is the default.
19661 @item -mplt
19662 @itemx -mno-plt
19663 @opindex mplt
19664 @opindex mno-plt
19665 Assume (do not assume) that the static and dynamic linkers
19666 support PLTs and copy relocations.  This option only affects
19667 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
19668 has no effect without @option{-msym32}.
19670 You can make @option{-mplt} the default by configuring
19671 GCC with @option{--with-mips-plt}.  The default is
19672 @option{-mno-plt} otherwise.
19674 @item -mxgot
19675 @itemx -mno-xgot
19676 @opindex mxgot
19677 @opindex mno-xgot
19678 Lift (do not lift) the usual restrictions on the size of the global
19679 offset table.
19681 GCC normally uses a single instruction to load values from the GOT@.
19682 While this is relatively efficient, it only works if the GOT
19683 is smaller than about 64k.  Anything larger causes the linker
19684 to report an error such as:
19686 @cindex relocation truncated to fit (MIPS)
19687 @smallexample
19688 relocation truncated to fit: R_MIPS_GOT16 foobar
19689 @end smallexample
19691 If this happens, you should recompile your code with @option{-mxgot}.
19692 This works with very large GOTs, although the code is also
19693 less efficient, since it takes three instructions to fetch the
19694 value of a global symbol.
19696 Note that some linkers can create multiple GOTs.  If you have such a
19697 linker, you should only need to use @option{-mxgot} when a single object
19698 file accesses more than 64k's worth of GOT entries.  Very few do.
19700 These options have no effect unless GCC is generating position
19701 independent code.
19703 @item -mgp32
19704 @opindex mgp32
19705 Assume that general-purpose registers are 32 bits wide.
19707 @item -mgp64
19708 @opindex mgp64
19709 Assume that general-purpose registers are 64 bits wide.
19711 @item -mfp32
19712 @opindex mfp32
19713 Assume that floating-point registers are 32 bits wide.
19715 @item -mfp64
19716 @opindex mfp64
19717 Assume that floating-point registers are 64 bits wide.
19719 @item -mfpxx
19720 @opindex mfpxx
19721 Do not assume the width of floating-point registers.
19723 @item -mhard-float
19724 @opindex mhard-float
19725 Use floating-point coprocessor instructions.
19727 @item -msoft-float
19728 @opindex msoft-float
19729 Do not use floating-point coprocessor instructions.  Implement
19730 floating-point calculations using library calls instead.
19732 @item -mno-float
19733 @opindex mno-float
19734 Equivalent to @option{-msoft-float}, but additionally asserts that the
19735 program being compiled does not perform any floating-point operations.
19736 This option is presently supported only by some bare-metal MIPS
19737 configurations, where it may select a special set of libraries
19738 that lack all floating-point support (including, for example, the
19739 floating-point @code{printf} formats).  
19740 If code compiled with @option{-mno-float} accidentally contains
19741 floating-point operations, it is likely to suffer a link-time
19742 or run-time failure.
19744 @item -msingle-float
19745 @opindex msingle-float
19746 Assume that the floating-point coprocessor only supports single-precision
19747 operations.
19749 @item -mdouble-float
19750 @opindex mdouble-float
19751 Assume that the floating-point coprocessor supports double-precision
19752 operations.  This is the default.
19754 @item -modd-spreg
19755 @itemx -mno-odd-spreg
19756 @opindex modd-spreg
19757 @opindex mno-odd-spreg
19758 Enable the use of odd-numbered single-precision floating-point registers
19759 for the o32 ABI.  This is the default for processors that are known to
19760 support these registers.  When using the o32 FPXX ABI, @option{-mno-odd-spreg}
19761 is set by default.
19763 @item -mabs=2008
19764 @itemx -mabs=legacy
19765 @opindex mabs=2008
19766 @opindex mabs=legacy
19767 These options control the treatment of the special not-a-number (NaN)
19768 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
19769 @code{neg.@i{fmt}} machine instructions.
19771 By default or when @option{-mabs=legacy} is used the legacy
19772 treatment is selected.  In this case these instructions are considered
19773 arithmetic and avoided where correct operation is required and the
19774 input operand might be a NaN.  A longer sequence of instructions that
19775 manipulate the sign bit of floating-point datum manually is used
19776 instead unless the @option{-ffinite-math-only} option has also been
19777 specified.
19779 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
19780 this case these instructions are considered non-arithmetic and therefore
19781 operating correctly in all cases, including in particular where the
19782 input operand is a NaN.  These instructions are therefore always used
19783 for the respective operations.
19785 @item -mnan=2008
19786 @itemx -mnan=legacy
19787 @opindex mnan=2008
19788 @opindex mnan=legacy
19789 These options control the encoding of the special not-a-number (NaN)
19790 IEEE 754 floating-point data.
19792 The @option{-mnan=legacy} option selects the legacy encoding.  In this
19793 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
19794 significand field being 0, whereas signaling NaNs (sNaNs) are denoted
19795 by the first bit of their trailing significand field being 1.
19797 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
19798 this case qNaNs are denoted by the first bit of their trailing
19799 significand field being 1, whereas sNaNs are denoted by the first bit of
19800 their trailing significand field being 0.
19802 The default is @option{-mnan=legacy} unless GCC has been configured with
19803 @option{--with-nan=2008}.
19805 @item -mllsc
19806 @itemx -mno-llsc
19807 @opindex mllsc
19808 @opindex mno-llsc
19809 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
19810 implement atomic memory built-in functions.  When neither option is
19811 specified, GCC uses the instructions if the target architecture
19812 supports them.
19814 @option{-mllsc} is useful if the runtime environment can emulate the
19815 instructions and @option{-mno-llsc} can be useful when compiling for
19816 nonstandard ISAs.  You can make either option the default by
19817 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
19818 respectively.  @option{--with-llsc} is the default for some
19819 configurations; see the installation documentation for details.
19821 @item -mdsp
19822 @itemx -mno-dsp
19823 @opindex mdsp
19824 @opindex mno-dsp
19825 Use (do not use) revision 1 of the MIPS DSP ASE@.
19826 @xref{MIPS DSP Built-in Functions}.  This option defines the
19827 preprocessor macro @code{__mips_dsp}.  It also defines
19828 @code{__mips_dsp_rev} to 1.
19830 @item -mdspr2
19831 @itemx -mno-dspr2
19832 @opindex mdspr2
19833 @opindex mno-dspr2
19834 Use (do not use) revision 2 of the MIPS DSP ASE@.
19835 @xref{MIPS DSP Built-in Functions}.  This option defines the
19836 preprocessor macros @code{__mips_dsp} and @code{__mips_dspr2}.
19837 It also defines @code{__mips_dsp_rev} to 2.
19839 @item -msmartmips
19840 @itemx -mno-smartmips
19841 @opindex msmartmips
19842 @opindex mno-smartmips
19843 Use (do not use) the MIPS SmartMIPS ASE.
19845 @item -mpaired-single
19846 @itemx -mno-paired-single
19847 @opindex mpaired-single
19848 @opindex mno-paired-single
19849 Use (do not use) paired-single floating-point instructions.
19850 @xref{MIPS Paired-Single Support}.  This option requires
19851 hardware floating-point support to be enabled.
19853 @item -mdmx
19854 @itemx -mno-mdmx
19855 @opindex mdmx
19856 @opindex mno-mdmx
19857 Use (do not use) MIPS Digital Media Extension instructions.
19858 This option can only be used when generating 64-bit code and requires
19859 hardware floating-point support to be enabled.
19861 @item -mips3d
19862 @itemx -mno-mips3d
19863 @opindex mips3d
19864 @opindex mno-mips3d
19865 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
19866 The option @option{-mips3d} implies @option{-mpaired-single}.
19868 @item -mmicromips
19869 @itemx -mno-micromips
19870 @opindex mmicromips
19871 @opindex mno-mmicromips
19872 Generate (do not generate) microMIPS code.
19874 MicroMIPS code generation can also be controlled on a per-function basis
19875 by means of @code{micromips} and @code{nomicromips} attributes.
19876 @xref{Function Attributes}, for more information.
19878 @item -mmt
19879 @itemx -mno-mt
19880 @opindex mmt
19881 @opindex mno-mt
19882 Use (do not use) MT Multithreading instructions.
19884 @item -mmcu
19885 @itemx -mno-mcu
19886 @opindex mmcu
19887 @opindex mno-mcu
19888 Use (do not use) the MIPS MCU ASE instructions.
19890 @item -meva
19891 @itemx -mno-eva
19892 @opindex meva
19893 @opindex mno-eva
19894 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
19896 @item -mvirt
19897 @itemx -mno-virt
19898 @opindex mvirt
19899 @opindex mno-virt
19900 Use (do not use) the MIPS Virtualization (VZ) instructions.
19902 @item -mxpa
19903 @itemx -mno-xpa
19904 @opindex mxpa
19905 @opindex mno-xpa
19906 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
19908 @item -mlong64
19909 @opindex mlong64
19910 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
19911 an explanation of the default and the way that the pointer size is
19912 determined.
19914 @item -mlong32
19915 @opindex mlong32
19916 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
19918 The default size of @code{int}s, @code{long}s and pointers depends on
19919 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
19920 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
19921 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
19922 or the same size as integer registers, whichever is smaller.
19924 @item -msym32
19925 @itemx -mno-sym32
19926 @opindex msym32
19927 @opindex mno-sym32
19928 Assume (do not assume) that all symbols have 32-bit values, regardless
19929 of the selected ABI@.  This option is useful in combination with
19930 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
19931 to generate shorter and faster references to symbolic addresses.
19933 @item -G @var{num}
19934 @opindex G
19935 Put definitions of externally-visible data in a small data section
19936 if that data is no bigger than @var{num} bytes.  GCC can then generate
19937 more efficient accesses to the data; see @option{-mgpopt} for details.
19939 The default @option{-G} option depends on the configuration.
19941 @item -mlocal-sdata
19942 @itemx -mno-local-sdata
19943 @opindex mlocal-sdata
19944 @opindex mno-local-sdata
19945 Extend (do not extend) the @option{-G} behavior to local data too,
19946 such as to static variables in C@.  @option{-mlocal-sdata} is the
19947 default for all configurations.
19949 If the linker complains that an application is using too much small data,
19950 you might want to try rebuilding the less performance-critical parts with
19951 @option{-mno-local-sdata}.  You might also want to build large
19952 libraries with @option{-mno-local-sdata}, so that the libraries leave
19953 more room for the main program.
19955 @item -mextern-sdata
19956 @itemx -mno-extern-sdata
19957 @opindex mextern-sdata
19958 @opindex mno-extern-sdata
19959 Assume (do not assume) that externally-defined data is in
19960 a small data section if the size of that data is within the @option{-G} limit.
19961 @option{-mextern-sdata} is the default for all configurations.
19963 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
19964 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
19965 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
19966 is placed in a small data section.  If @var{Var} is defined by another
19967 module, you must either compile that module with a high-enough
19968 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
19969 definition.  If @var{Var} is common, you must link the application
19970 with a high-enough @option{-G} setting.
19972 The easiest way of satisfying these restrictions is to compile
19973 and link every module with the same @option{-G} option.  However,
19974 you may wish to build a library that supports several different
19975 small data limits.  You can do this by compiling the library with
19976 the highest supported @option{-G} setting and additionally using
19977 @option{-mno-extern-sdata} to stop the library from making assumptions
19978 about externally-defined data.
19980 @item -mgpopt
19981 @itemx -mno-gpopt
19982 @opindex mgpopt
19983 @opindex mno-gpopt
19984 Use (do not use) GP-relative accesses for symbols that are known to be
19985 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
19986 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
19987 configurations.
19989 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
19990 might not hold the value of @code{_gp}.  For example, if the code is
19991 part of a library that might be used in a boot monitor, programs that
19992 call boot monitor routines pass an unknown value in @code{$gp}.
19993 (In such situations, the boot monitor itself is usually compiled
19994 with @option{-G0}.)
19996 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
19997 @option{-mno-extern-sdata}.
19999 @item -membedded-data
20000 @itemx -mno-embedded-data
20001 @opindex membedded-data
20002 @opindex mno-embedded-data
20003 Allocate variables to the read-only data section first if possible, then
20004 next in the small data section if possible, otherwise in data.  This gives
20005 slightly slower code than the default, but reduces the amount of RAM required
20006 when executing, and thus may be preferred for some embedded systems.
20008 @item -muninit-const-in-rodata
20009 @itemx -mno-uninit-const-in-rodata
20010 @opindex muninit-const-in-rodata
20011 @opindex mno-uninit-const-in-rodata
20012 Put uninitialized @code{const} variables in the read-only data section.
20013 This option is only meaningful in conjunction with @option{-membedded-data}.
20015 @item -mcode-readable=@var{setting}
20016 @opindex mcode-readable
20017 Specify whether GCC may generate code that reads from executable sections.
20018 There are three possible settings:
20020 @table @gcctabopt
20021 @item -mcode-readable=yes
20022 Instructions may freely access executable sections.  This is the
20023 default setting.
20025 @item -mcode-readable=pcrel
20026 MIPS16 PC-relative load instructions can access executable sections,
20027 but other instructions must not do so.  This option is useful on 4KSc
20028 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
20029 It is also useful on processors that can be configured to have a dual
20030 instruction/data SRAM interface and that, like the M4K, automatically
20031 redirect PC-relative loads to the instruction RAM.
20033 @item -mcode-readable=no
20034 Instructions must not access executable sections.  This option can be
20035 useful on targets that are configured to have a dual instruction/data
20036 SRAM interface but that (unlike the M4K) do not automatically redirect
20037 PC-relative loads to the instruction RAM.
20038 @end table
20040 @item -msplit-addresses
20041 @itemx -mno-split-addresses
20042 @opindex msplit-addresses
20043 @opindex mno-split-addresses
20044 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
20045 relocation operators.  This option has been superseded by
20046 @option{-mexplicit-relocs} but is retained for backwards compatibility.
20048 @item -mexplicit-relocs
20049 @itemx -mno-explicit-relocs
20050 @opindex mexplicit-relocs
20051 @opindex mno-explicit-relocs
20052 Use (do not use) assembler relocation operators when dealing with symbolic
20053 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
20054 is to use assembler macros instead.
20056 @option{-mexplicit-relocs} is the default if GCC was configured
20057 to use an assembler that supports relocation operators.
20059 @item -mcheck-zero-division
20060 @itemx -mno-check-zero-division
20061 @opindex mcheck-zero-division
20062 @opindex mno-check-zero-division
20063 Trap (do not trap) on integer division by zero.
20065 The default is @option{-mcheck-zero-division}.
20067 @item -mdivide-traps
20068 @itemx -mdivide-breaks
20069 @opindex mdivide-traps
20070 @opindex mdivide-breaks
20071 MIPS systems check for division by zero by generating either a
20072 conditional trap or a break instruction.  Using traps results in
20073 smaller code, but is only supported on MIPS II and later.  Also, some
20074 versions of the Linux kernel have a bug that prevents trap from
20075 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
20076 allow conditional traps on architectures that support them and
20077 @option{-mdivide-breaks} to force the use of breaks.
20079 The default is usually @option{-mdivide-traps}, but this can be
20080 overridden at configure time using @option{--with-divide=breaks}.
20081 Divide-by-zero checks can be completely disabled using
20082 @option{-mno-check-zero-division}.
20084 @item -mload-store-pairs
20085 @itemx -mno-load-store-pairs
20086 @opindex mload-store-pairs
20087 @opindex mno-load-store-pairs
20088 Enable (disable) an optimization that pairs consecutive load or store
20089 instructions to enable load/store bonding.  This option is enabled by
20090 default but only takes effect when the selected architecture is known
20091 to support bonding.
20093 @item -mmemcpy
20094 @itemx -mno-memcpy
20095 @opindex mmemcpy
20096 @opindex mno-memcpy
20097 Force (do not force) the use of @code{memcpy} for non-trivial block
20098 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
20099 most constant-sized copies.
20101 @item -mlong-calls
20102 @itemx -mno-long-calls
20103 @opindex mlong-calls
20104 @opindex mno-long-calls
20105 Disable (do not disable) use of the @code{jal} instruction.  Calling
20106 functions using @code{jal} is more efficient but requires the caller
20107 and callee to be in the same 256 megabyte segment.
20109 This option has no effect on abicalls code.  The default is
20110 @option{-mno-long-calls}.
20112 @item -mmad
20113 @itemx -mno-mad
20114 @opindex mmad
20115 @opindex mno-mad
20116 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
20117 instructions, as provided by the R4650 ISA@.
20119 @item -mimadd
20120 @itemx -mno-imadd
20121 @opindex mimadd
20122 @opindex mno-imadd
20123 Enable (disable) use of the @code{madd} and @code{msub} integer
20124 instructions.  The default is @option{-mimadd} on architectures
20125 that support @code{madd} and @code{msub} except for the 74k 
20126 architecture where it was found to generate slower code.
20128 @item -mfused-madd
20129 @itemx -mno-fused-madd
20130 @opindex mfused-madd
20131 @opindex mno-fused-madd
20132 Enable (disable) use of the floating-point multiply-accumulate
20133 instructions, when they are available.  The default is
20134 @option{-mfused-madd}.
20136 On the R8000 CPU when multiply-accumulate instructions are used,
20137 the intermediate product is calculated to infinite precision
20138 and is not subject to the FCSR Flush to Zero bit.  This may be
20139 undesirable in some circumstances.  On other processors the result
20140 is numerically identical to the equivalent computation using
20141 separate multiply, add, subtract and negate instructions.
20143 @item -nocpp
20144 @opindex nocpp
20145 Tell the MIPS assembler to not run its preprocessor over user
20146 assembler files (with a @samp{.s} suffix) when assembling them.
20148 @item -mfix-24k
20149 @item -mno-fix-24k
20150 @opindex mfix-24k
20151 @opindex mno-fix-24k
20152 Work around the 24K E48 (lost data on stores during refill) errata.
20153 The workarounds are implemented by the assembler rather than by GCC@.
20155 @item -mfix-r4000
20156 @itemx -mno-fix-r4000
20157 @opindex mfix-r4000
20158 @opindex mno-fix-r4000
20159 Work around certain R4000 CPU errata:
20160 @itemize @minus
20161 @item
20162 A double-word or a variable shift may give an incorrect result if executed
20163 immediately after starting an integer division.
20164 @item
20165 A double-word or a variable shift may give an incorrect result if executed
20166 while an integer multiplication is in progress.
20167 @item
20168 An integer division may give an incorrect result if started in a delay slot
20169 of a taken branch or a jump.
20170 @end itemize
20172 @item -mfix-r4400
20173 @itemx -mno-fix-r4400
20174 @opindex mfix-r4400
20175 @opindex mno-fix-r4400
20176 Work around certain R4400 CPU errata:
20177 @itemize @minus
20178 @item
20179 A double-word or a variable shift may give an incorrect result if executed
20180 immediately after starting an integer division.
20181 @end itemize
20183 @item -mfix-r10000
20184 @itemx -mno-fix-r10000
20185 @opindex mfix-r10000
20186 @opindex mno-fix-r10000
20187 Work around certain R10000 errata:
20188 @itemize @minus
20189 @item
20190 @code{ll}/@code{sc} sequences may not behave atomically on revisions
20191 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
20192 @end itemize
20194 This option can only be used if the target architecture supports
20195 branch-likely instructions.  @option{-mfix-r10000} is the default when
20196 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
20197 otherwise.
20199 @item -mfix-rm7000
20200 @itemx -mno-fix-rm7000
20201 @opindex mfix-rm7000
20202 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
20203 workarounds are implemented by the assembler rather than by GCC@.
20205 @item -mfix-vr4120
20206 @itemx -mno-fix-vr4120
20207 @opindex mfix-vr4120
20208 Work around certain VR4120 errata:
20209 @itemize @minus
20210 @item
20211 @code{dmultu} does not always produce the correct result.
20212 @item
20213 @code{div} and @code{ddiv} do not always produce the correct result if one
20214 of the operands is negative.
20215 @end itemize
20216 The workarounds for the division errata rely on special functions in
20217 @file{libgcc.a}.  At present, these functions are only provided by
20218 the @code{mips64vr*-elf} configurations.
20220 Other VR4120 errata require a NOP to be inserted between certain pairs of
20221 instructions.  These errata are handled by the assembler, not by GCC itself.
20223 @item -mfix-vr4130
20224 @opindex mfix-vr4130
20225 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
20226 workarounds are implemented by the assembler rather than by GCC,
20227 although GCC avoids using @code{mflo} and @code{mfhi} if the
20228 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
20229 instructions are available instead.
20231 @item -mfix-sb1
20232 @itemx -mno-fix-sb1
20233 @opindex mfix-sb1
20234 Work around certain SB-1 CPU core errata.
20235 (This flag currently works around the SB-1 revision 2
20236 ``F1'' and ``F2'' floating-point errata.)
20238 @item -mr10k-cache-barrier=@var{setting}
20239 @opindex mr10k-cache-barrier
20240 Specify whether GCC should insert cache barriers to avoid the
20241 side-effects of speculation on R10K processors.
20243 In common with many processors, the R10K tries to predict the outcome
20244 of a conditional branch and speculatively executes instructions from
20245 the ``taken'' branch.  It later aborts these instructions if the
20246 predicted outcome is wrong.  However, on the R10K, even aborted
20247 instructions can have side effects.
20249 This problem only affects kernel stores and, depending on the system,
20250 kernel loads.  As an example, a speculatively-executed store may load
20251 the target memory into cache and mark the cache line as dirty, even if
20252 the store itself is later aborted.  If a DMA operation writes to the
20253 same area of memory before the ``dirty'' line is flushed, the cached
20254 data overwrites the DMA-ed data.  See the R10K processor manual
20255 for a full description, including other potential problems.
20257 One workaround is to insert cache barrier instructions before every memory
20258 access that might be speculatively executed and that might have side
20259 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
20260 controls GCC's implementation of this workaround.  It assumes that
20261 aborted accesses to any byte in the following regions does not have
20262 side effects:
20264 @enumerate
20265 @item
20266 the memory occupied by the current function's stack frame;
20268 @item
20269 the memory occupied by an incoming stack argument;
20271 @item
20272 the memory occupied by an object with a link-time-constant address.
20273 @end enumerate
20275 It is the kernel's responsibility to ensure that speculative
20276 accesses to these regions are indeed safe.
20278 If the input program contains a function declaration such as:
20280 @smallexample
20281 void foo (void);
20282 @end smallexample
20284 then the implementation of @code{foo} must allow @code{j foo} and
20285 @code{jal foo} to be executed speculatively.  GCC honors this
20286 restriction for functions it compiles itself.  It expects non-GCC
20287 functions (such as hand-written assembly code) to do the same.
20289 The option has three forms:
20291 @table @gcctabopt
20292 @item -mr10k-cache-barrier=load-store
20293 Insert a cache barrier before a load or store that might be
20294 speculatively executed and that might have side effects even
20295 if aborted.
20297 @item -mr10k-cache-barrier=store
20298 Insert a cache barrier before a store that might be speculatively
20299 executed and that might have side effects even if aborted.
20301 @item -mr10k-cache-barrier=none
20302 Disable the insertion of cache barriers.  This is the default setting.
20303 @end table
20305 @item -mflush-func=@var{func}
20306 @itemx -mno-flush-func
20307 @opindex mflush-func
20308 Specifies the function to call to flush the I and D caches, or to not
20309 call any such function.  If called, the function must take the same
20310 arguments as the common @code{_flush_func}, that is, the address of the
20311 memory range for which the cache is being flushed, the size of the
20312 memory range, and the number 3 (to flush both caches).  The default
20313 depends on the target GCC was configured for, but commonly is either
20314 @code{_flush_func} or @code{__cpu_flush}.
20316 @item mbranch-cost=@var{num}
20317 @opindex mbranch-cost
20318 Set the cost of branches to roughly @var{num} ``simple'' instructions.
20319 This cost is only a heuristic and is not guaranteed to produce
20320 consistent results across releases.  A zero cost redundantly selects
20321 the default, which is based on the @option{-mtune} setting.
20323 @item -mbranch-likely
20324 @itemx -mno-branch-likely
20325 @opindex mbranch-likely
20326 @opindex mno-branch-likely
20327 Enable or disable use of Branch Likely instructions, regardless of the
20328 default for the selected architecture.  By default, Branch Likely
20329 instructions may be generated if they are supported by the selected
20330 architecture.  An exception is for the MIPS32 and MIPS64 architectures
20331 and processors that implement those architectures; for those, Branch
20332 Likely instructions are not be generated by default because the MIPS32
20333 and MIPS64 architectures specifically deprecate their use.
20335 @item -mcompact-branches=never
20336 @itemx -mcompact-branches=optimal
20337 @itemx -mcompact-branches=always
20338 @opindex mcompact-branches=never
20339 @opindex mcompact-branches=optimal
20340 @opindex mcompact-branches=always
20341 These options control which form of branches will be generated.  The
20342 default is @option{-mcompact-branches=optimal}.
20344 The @option{-mcompact-branches=never} option ensures that compact branch
20345 instructions will never be generated.
20347 The @option{-mcompact-branches=always} option ensures that a compact
20348 branch instruction will be generated if available.  If a compact branch
20349 instruction is not available, a delay slot form of the branch will be
20350 used instead.
20352 This option is supported from MIPS Release 6 onwards.
20354 The @option{-mcompact-branches=optimal} option will cause a delay slot
20355 branch to be used if one is available in the current ISA and the delay
20356 slot is successfully filled.  If the delay slot is not filled, a compact
20357 branch will be chosen if one is available.
20359 @item -mfp-exceptions
20360 @itemx -mno-fp-exceptions
20361 @opindex mfp-exceptions
20362 Specifies whether FP exceptions are enabled.  This affects how
20363 FP instructions are scheduled for some processors.
20364 The default is that FP exceptions are
20365 enabled.
20367 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
20368 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
20369 FP pipe.
20371 @item -mvr4130-align
20372 @itemx -mno-vr4130-align
20373 @opindex mvr4130-align
20374 The VR4130 pipeline is two-way superscalar, but can only issue two
20375 instructions together if the first one is 8-byte aligned.  When this
20376 option is enabled, GCC aligns pairs of instructions that it
20377 thinks should execute in parallel.
20379 This option only has an effect when optimizing for the VR4130.
20380 It normally makes code faster, but at the expense of making it bigger.
20381 It is enabled by default at optimization level @option{-O3}.
20383 @item -msynci
20384 @itemx -mno-synci
20385 @opindex msynci
20386 Enable (disable) generation of @code{synci} instructions on
20387 architectures that support it.  The @code{synci} instructions (if
20388 enabled) are generated when @code{__builtin___clear_cache} is
20389 compiled.
20391 This option defaults to @option{-mno-synci}, but the default can be
20392 overridden by configuring GCC with @option{--with-synci}.
20394 When compiling code for single processor systems, it is generally safe
20395 to use @code{synci}.  However, on many multi-core (SMP) systems, it
20396 does not invalidate the instruction caches on all cores and may lead
20397 to undefined behavior.
20399 @item -mrelax-pic-calls
20400 @itemx -mno-relax-pic-calls
20401 @opindex mrelax-pic-calls
20402 Try to turn PIC calls that are normally dispatched via register
20403 @code{$25} into direct calls.  This is only possible if the linker can
20404 resolve the destination at link time and if the destination is within
20405 range for a direct call.
20407 @option{-mrelax-pic-calls} is the default if GCC was configured to use
20408 an assembler and a linker that support the @code{.reloc} assembly
20409 directive and @option{-mexplicit-relocs} is in effect.  With
20410 @option{-mno-explicit-relocs}, this optimization can be performed by the
20411 assembler and the linker alone without help from the compiler.
20413 @item -mmcount-ra-address
20414 @itemx -mno-mcount-ra-address
20415 @opindex mmcount-ra-address
20416 @opindex mno-mcount-ra-address
20417 Emit (do not emit) code that allows @code{_mcount} to modify the
20418 calling function's return address.  When enabled, this option extends
20419 the usual @code{_mcount} interface with a new @var{ra-address}
20420 parameter, which has type @code{intptr_t *} and is passed in register
20421 @code{$12}.  @code{_mcount} can then modify the return address by
20422 doing both of the following:
20423 @itemize
20424 @item
20425 Returning the new address in register @code{$31}.
20426 @item
20427 Storing the new address in @code{*@var{ra-address}},
20428 if @var{ra-address} is nonnull.
20429 @end itemize
20431 The default is @option{-mno-mcount-ra-address}.
20433 @item -mframe-header-opt
20434 @itemx -mno-frame-header-opt
20435 @opindex mframe-header-opt
20436 Enable (disable) frame header optimization in the o32 ABI.  When using the
20437 o32 ABI, calling functions will allocate 16 bytes on the stack for the called
20438 function to write out register arguments.  When enabled, this optimization
20439 will suppress the allocation of the frame header if it can be determined that
20440 it is unused.
20442 This optimization is off by default at all optimization levels.
20444 @item -mlxc1-sxc1
20445 @itemx -mno-lxc1-sxc1
20446 @opindex mlxc1-sxc1
20447 When applicable, enable (disable) the generation of @code{lwxc1},
20448 @code{swxc1}, @code{ldxc1}, @code{sdxc1} instructions.  Enabled by default.
20450 @item -mmadd4
20451 @itemx -mno-madd4
20452 @opindex mmadd4
20453 When applicable, enable (disable) the generation of 4-operand @code{madd.s},
20454 @code{madd.d} and related instructions.  Enabled by default.
20456 @end table
20458 @node MMIX Options
20459 @subsection MMIX Options
20460 @cindex MMIX Options
20462 These options are defined for the MMIX:
20464 @table @gcctabopt
20465 @item -mlibfuncs
20466 @itemx -mno-libfuncs
20467 @opindex mlibfuncs
20468 @opindex mno-libfuncs
20469 Specify that intrinsic library functions are being compiled, passing all
20470 values in registers, no matter the size.
20472 @item -mepsilon
20473 @itemx -mno-epsilon
20474 @opindex mepsilon
20475 @opindex mno-epsilon
20476 Generate floating-point comparison instructions that compare with respect
20477 to the @code{rE} epsilon register.
20479 @item -mabi=mmixware
20480 @itemx -mabi=gnu
20481 @opindex mabi=mmixware
20482 @opindex mabi=gnu
20483 Generate code that passes function parameters and return values that (in
20484 the called function) are seen as registers @code{$0} and up, as opposed to
20485 the GNU ABI which uses global registers @code{$231} and up.
20487 @item -mzero-extend
20488 @itemx -mno-zero-extend
20489 @opindex mzero-extend
20490 @opindex mno-zero-extend
20491 When reading data from memory in sizes shorter than 64 bits, use (do not
20492 use) zero-extending load instructions by default, rather than
20493 sign-extending ones.
20495 @item -mknuthdiv
20496 @itemx -mno-knuthdiv
20497 @opindex mknuthdiv
20498 @opindex mno-knuthdiv
20499 Make the result of a division yielding a remainder have the same sign as
20500 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
20501 remainder follows the sign of the dividend.  Both methods are
20502 arithmetically valid, the latter being almost exclusively used.
20504 @item -mtoplevel-symbols
20505 @itemx -mno-toplevel-symbols
20506 @opindex mtoplevel-symbols
20507 @opindex mno-toplevel-symbols
20508 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
20509 code can be used with the @code{PREFIX} assembly directive.
20511 @item -melf
20512 @opindex melf
20513 Generate an executable in the ELF format, rather than the default
20514 @samp{mmo} format used by the @command{mmix} simulator.
20516 @item -mbranch-predict
20517 @itemx -mno-branch-predict
20518 @opindex mbranch-predict
20519 @opindex mno-branch-predict
20520 Use (do not use) the probable-branch instructions, when static branch
20521 prediction indicates a probable branch.
20523 @item -mbase-addresses
20524 @itemx -mno-base-addresses
20525 @opindex mbase-addresses
20526 @opindex mno-base-addresses
20527 Generate (do not generate) code that uses @emph{base addresses}.  Using a
20528 base address automatically generates a request (handled by the assembler
20529 and the linker) for a constant to be set up in a global register.  The
20530 register is used for one or more base address requests within the range 0
20531 to 255 from the value held in the register.  The generally leads to short
20532 and fast code, but the number of different data items that can be
20533 addressed is limited.  This means that a program that uses lots of static
20534 data may require @option{-mno-base-addresses}.
20536 @item -msingle-exit
20537 @itemx -mno-single-exit
20538 @opindex msingle-exit
20539 @opindex mno-single-exit
20540 Force (do not force) generated code to have a single exit point in each
20541 function.
20542 @end table
20544 @node MN10300 Options
20545 @subsection MN10300 Options
20546 @cindex MN10300 options
20548 These @option{-m} options are defined for Matsushita MN10300 architectures:
20550 @table @gcctabopt
20551 @item -mmult-bug
20552 @opindex mmult-bug
20553 Generate code to avoid bugs in the multiply instructions for the MN10300
20554 processors.  This is the default.
20556 @item -mno-mult-bug
20557 @opindex mno-mult-bug
20558 Do not generate code to avoid bugs in the multiply instructions for the
20559 MN10300 processors.
20561 @item -mam33
20562 @opindex mam33
20563 Generate code using features specific to the AM33 processor.
20565 @item -mno-am33
20566 @opindex mno-am33
20567 Do not generate code using features specific to the AM33 processor.  This
20568 is the default.
20570 @item -mam33-2
20571 @opindex mam33-2
20572 Generate code using features specific to the AM33/2.0 processor.
20574 @item -mam34
20575 @opindex mam34
20576 Generate code using features specific to the AM34 processor.
20578 @item -mtune=@var{cpu-type}
20579 @opindex mtune
20580 Use the timing characteristics of the indicated CPU type when
20581 scheduling instructions.  This does not change the targeted processor
20582 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
20583 @samp{am33-2} or @samp{am34}.
20585 @item -mreturn-pointer-on-d0
20586 @opindex mreturn-pointer-on-d0
20587 When generating a function that returns a pointer, return the pointer
20588 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
20589 only in @code{a0}, and attempts to call such functions without a prototype
20590 result in errors.  Note that this option is on by default; use
20591 @option{-mno-return-pointer-on-d0} to disable it.
20593 @item -mno-crt0
20594 @opindex mno-crt0
20595 Do not link in the C run-time initialization object file.
20597 @item -mrelax
20598 @opindex mrelax
20599 Indicate to the linker that it should perform a relaxation optimization pass
20600 to shorten branches, calls and absolute memory addresses.  This option only
20601 has an effect when used on the command line for the final link step.
20603 This option makes symbolic debugging impossible.
20605 @item -mliw
20606 @opindex mliw
20607 Allow the compiler to generate @emph{Long Instruction Word}
20608 instructions if the target is the @samp{AM33} or later.  This is the
20609 default.  This option defines the preprocessor macro @code{__LIW__}.
20611 @item -mnoliw
20612 @opindex mnoliw
20613 Do not allow the compiler to generate @emph{Long Instruction Word}
20614 instructions.  This option defines the preprocessor macro
20615 @code{__NO_LIW__}.
20617 @item -msetlb
20618 @opindex msetlb
20619 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
20620 instructions if the target is the @samp{AM33} or later.  This is the
20621 default.  This option defines the preprocessor macro @code{__SETLB__}.
20623 @item -mnosetlb
20624 @opindex mnosetlb
20625 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
20626 instructions.  This option defines the preprocessor macro
20627 @code{__NO_SETLB__}.
20629 @end table
20631 @node Moxie Options
20632 @subsection Moxie Options
20633 @cindex Moxie Options
20635 @table @gcctabopt
20637 @item -meb
20638 @opindex meb
20639 Generate big-endian code.  This is the default for @samp{moxie-*-*}
20640 configurations.
20642 @item -mel
20643 @opindex mel
20644 Generate little-endian code.
20646 @item -mmul.x
20647 @opindex mmul.x
20648 Generate mul.x and umul.x instructions.  This is the default for
20649 @samp{moxiebox-*-*} configurations.
20651 @item -mno-crt0
20652 @opindex mno-crt0
20653 Do not link in the C run-time initialization object file.
20655 @end table
20657 @node MSP430 Options
20658 @subsection MSP430 Options
20659 @cindex MSP430 Options
20661 These options are defined for the MSP430:
20663 @table @gcctabopt
20665 @item -masm-hex
20666 @opindex masm-hex
20667 Force assembly output to always use hex constants.  Normally such
20668 constants are signed decimals, but this option is available for
20669 testsuite and/or aesthetic purposes.
20671 @item -mmcu=
20672 @opindex mmcu=
20673 Select the MCU to target.  This is used to create a C preprocessor
20674 symbol based upon the MCU name, converted to upper case and pre- and
20675 post-fixed with @samp{__}.  This in turn is used by the
20676 @file{msp430.h} header file to select an MCU-specific supplementary
20677 header file.
20679 The option also sets the ISA to use.  If the MCU name is one that is
20680 known to only support the 430 ISA then that is selected, otherwise the
20681 430X ISA is selected.  A generic MCU name of @samp{msp430} can also be
20682 used to select the 430 ISA.  Similarly the generic @samp{msp430x} MCU
20683 name selects the 430X ISA.
20685 In addition an MCU-specific linker script is added to the linker
20686 command line.  The script's name is the name of the MCU with
20687 @file{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the @command{gcc}
20688 command line defines the C preprocessor symbol @code{__XXX__} and
20689 cause the linker to search for a script called @file{xxx.ld}.
20691 This option is also passed on to the assembler.
20693 @item -mwarn-mcu
20694 @itemx -mno-warn-mcu
20695 @opindex mwarn-mcu
20696 @opindex mno-warn-mcu
20697 This option enables or disables warnings about conflicts between the
20698 MCU name specified by the @option{-mmcu} option and the ISA set by the
20699 @option{-mcpu} option and/or the hardware multiply support set by the
20700 @option{-mhwmult} option.  It also toggles warnings about unrecognized
20701 MCU names.  This option is on by default.
20703 @item -mcpu=
20704 @opindex mcpu=
20705 Specifies the ISA to use.  Accepted values are @samp{msp430},
20706 @samp{msp430x} and @samp{msp430xv2}.  This option is deprecated.  The
20707 @option{-mmcu=} option should be used to select the ISA.
20709 @item -msim
20710 @opindex msim
20711 Link to the simulator runtime libraries and linker script.  Overrides
20712 any scripts that would be selected by the @option{-mmcu=} option.
20714 @item -mlarge
20715 @opindex mlarge
20716 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
20718 @item -msmall
20719 @opindex msmall
20720 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
20722 @item -mrelax
20723 @opindex mrelax
20724 This option is passed to the assembler and linker, and allows the
20725 linker to perform certain optimizations that cannot be done until
20726 the final link.
20728 @item mhwmult=
20729 @opindex mhwmult=
20730 Describes the type of hardware multiply supported by the target.
20731 Accepted values are @samp{none} for no hardware multiply, @samp{16bit}
20732 for the original 16-bit-only multiply supported by early MCUs.
20733 @samp{32bit} for the 16/32-bit multiply supported by later MCUs and
20734 @samp{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
20735 A value of @samp{auto} can also be given.  This tells GCC to deduce
20736 the hardware multiply support based upon the MCU name provided by the
20737 @option{-mmcu} option.  If no @option{-mmcu} option is specified or if
20738 the MCU name is not recognized then no hardware multiply support is
20739 assumed.  @code{auto} is the default setting.
20741 Hardware multiplies are normally performed by calling a library
20742 routine.  This saves space in the generated code.  When compiling at
20743 @option{-O3} or higher however the hardware multiplier is invoked
20744 inline.  This makes for bigger, but faster code.
20746 The hardware multiply routines disable interrupts whilst running and
20747 restore the previous interrupt state when they finish.  This makes
20748 them safe to use inside interrupt handlers as well as in normal code.
20750 @item -minrt
20751 @opindex minrt
20752 Enable the use of a minimum runtime environment - no static
20753 initializers or constructors.  This is intended for memory-constrained
20754 devices.  The compiler includes special symbols in some objects
20755 that tell the linker and runtime which code fragments are required.
20757 @item -mcode-region=
20758 @itemx -mdata-region=
20759 @opindex mcode-region
20760 @opindex mdata-region
20761 These options tell the compiler where to place functions and data that
20762 do not have one of the @code{lower}, @code{upper}, @code{either} or
20763 @code{section} attributes.  Possible values are @code{lower},
20764 @code{upper}, @code{either} or @code{any}.  The first three behave
20765 like the corresponding attribute.  The fourth possible value -
20766 @code{any} - is the default.  It leaves placement entirely up to the
20767 linker script and how it assigns the standard sections
20768 (@code{.text}, @code{.data}, etc) to the memory regions.
20770 @item -msilicon-errata=
20771 @opindex msilicon-errata
20772 This option passes on a request to assembler to enable the fixes for
20773 the named silicon errata.
20775 @item -msilicon-errata-warn=
20776 @opindex msilicon-errata-warn
20777 This option passes on a request to the assembler to enable warning
20778 messages when a silicon errata might need to be applied.
20780 @end table
20782 @node NDS32 Options
20783 @subsection NDS32 Options
20784 @cindex NDS32 Options
20786 These options are defined for NDS32 implementations:
20788 @table @gcctabopt
20790 @item -mbig-endian
20791 @opindex mbig-endian
20792 Generate code in big-endian mode.
20794 @item -mlittle-endian
20795 @opindex mlittle-endian
20796 Generate code in little-endian mode.
20798 @item -mreduced-regs
20799 @opindex mreduced-regs
20800 Use reduced-set registers for register allocation.
20802 @item -mfull-regs
20803 @opindex mfull-regs
20804 Use full-set registers for register allocation.
20806 @item -mcmov
20807 @opindex mcmov
20808 Generate conditional move instructions.
20810 @item -mno-cmov
20811 @opindex mno-cmov
20812 Do not generate conditional move instructions.
20814 @item -mperf-ext
20815 @opindex mperf-ext
20816 Generate performance extension instructions.
20818 @item -mno-perf-ext
20819 @opindex mno-perf-ext
20820 Do not generate performance extension instructions.
20822 @item -mv3push
20823 @opindex mv3push
20824 Generate v3 push25/pop25 instructions.
20826 @item -mno-v3push
20827 @opindex mno-v3push
20828 Do not generate v3 push25/pop25 instructions.
20830 @item -m16-bit
20831 @opindex m16-bit
20832 Generate 16-bit instructions.
20834 @item -mno-16-bit
20835 @opindex mno-16-bit
20836 Do not generate 16-bit instructions.
20838 @item -misr-vector-size=@var{num}
20839 @opindex misr-vector-size
20840 Specify the size of each interrupt vector, which must be 4 or 16.
20842 @item -mcache-block-size=@var{num}
20843 @opindex mcache-block-size
20844 Specify the size of each cache block,
20845 which must be a power of 2 between 4 and 512.
20847 @item -march=@var{arch}
20848 @opindex march
20849 Specify the name of the target architecture.
20851 @item -mcmodel=@var{code-model}
20852 @opindex mcmodel
20853 Set the code model to one of
20854 @table @asis
20855 @item @samp{small}
20856 All the data and read-only data segments must be within 512KB addressing space.
20857 The text segment must be within 16MB addressing space.
20858 @item @samp{medium}
20859 The data segment must be within 512KB while the read-only data segment can be
20860 within 4GB addressing space.  The text segment should be still within 16MB
20861 addressing space.
20862 @item @samp{large}
20863 All the text and data segments can be within 4GB addressing space.
20864 @end table
20866 @item -mctor-dtor
20867 @opindex mctor-dtor
20868 Enable constructor/destructor feature.
20870 @item -mrelax
20871 @opindex mrelax
20872 Guide linker to relax instructions.
20874 @end table
20876 @node Nios II Options
20877 @subsection Nios II Options
20878 @cindex Nios II options
20879 @cindex Altera Nios II options
20881 These are the options defined for the Altera Nios II processor.
20883 @table @gcctabopt
20885 @item -G @var{num}
20886 @opindex G
20887 @cindex smaller data references
20888 Put global and static objects less than or equal to @var{num} bytes
20889 into the small data or BSS sections instead of the normal data or BSS
20890 sections.  The default value of @var{num} is 8.
20892 @item -mgpopt=@var{option}
20893 @item -mgpopt
20894 @itemx -mno-gpopt
20895 @opindex mgpopt
20896 @opindex mno-gpopt
20897 Generate (do not generate) GP-relative accesses.  The following 
20898 @var{option} names are recognized:
20900 @table @samp
20902 @item none
20903 Do not generate GP-relative accesses.
20905 @item local
20906 Generate GP-relative accesses for small data objects that are not 
20907 external, weak, or uninitialized common symbols.  
20908 Also use GP-relative addressing for objects that
20909 have been explicitly placed in a small data section via a @code{section}
20910 attribute.
20912 @item global
20913 As for @samp{local}, but also generate GP-relative accesses for
20914 small data objects that are external, weak, or common.  If you use this option,
20915 you must ensure that all parts of your program (including libraries) are
20916 compiled with the same @option{-G} setting.
20918 @item data
20919 Generate GP-relative accesses for all data objects in the program.  If you
20920 use this option, the entire data and BSS segments
20921 of your program must fit in 64K of memory and you must use an appropriate
20922 linker script to allocate them within the addressable range of the
20923 global pointer.
20925 @item all
20926 Generate GP-relative addresses for function pointers as well as data
20927 pointers.  If you use this option, the entire text, data, and BSS segments
20928 of your program must fit in 64K of memory and you must use an appropriate
20929 linker script to allocate them within the addressable range of the
20930 global pointer.
20932 @end table
20934 @option{-mgpopt} is equivalent to @option{-mgpopt=local}, and
20935 @option{-mno-gpopt} is equivalent to @option{-mgpopt=none}.
20937 The default is @option{-mgpopt} except when @option{-fpic} or
20938 @option{-fPIC} is specified to generate position-independent code.
20939 Note that the Nios II ABI does not permit GP-relative accesses from
20940 shared libraries.
20942 You may need to specify @option{-mno-gpopt} explicitly when building
20943 programs that include large amounts of small data, including large
20944 GOT data sections.  In this case, the 16-bit offset for GP-relative
20945 addressing may not be large enough to allow access to the entire 
20946 small data section.
20948 @item -mel
20949 @itemx -meb
20950 @opindex mel
20951 @opindex meb
20952 Generate little-endian (default) or big-endian (experimental) code,
20953 respectively.
20955 @item -march=@var{arch}
20956 @opindex march
20957 This specifies the name of the target Nios II architecture.  GCC uses this
20958 name to determine what kind of instructions it can emit when generating
20959 assembly code.  Permissible names are: @samp{r1}, @samp{r2}.
20961 The preprocessor macro @code{__nios2_arch__} is available to programs,
20962 with value 1 or 2, indicating the targeted ISA level.
20964 @item -mbypass-cache
20965 @itemx -mno-bypass-cache
20966 @opindex mno-bypass-cache
20967 @opindex mbypass-cache
20968 Force all load and store instructions to always bypass cache by 
20969 using I/O variants of the instructions. The default is not to
20970 bypass the cache.
20972 @item -mno-cache-volatile 
20973 @itemx -mcache-volatile       
20974 @opindex mcache-volatile 
20975 @opindex mno-cache-volatile
20976 Volatile memory access bypass the cache using the I/O variants of 
20977 the load and store instructions. The default is not to bypass the cache.
20979 @item -mno-fast-sw-div
20980 @itemx -mfast-sw-div
20981 @opindex mno-fast-sw-div
20982 @opindex mfast-sw-div
20983 Do not use table-based fast divide for small numbers. The default 
20984 is to use the fast divide at @option{-O3} and above.
20986 @item -mno-hw-mul
20987 @itemx -mhw-mul
20988 @itemx -mno-hw-mulx
20989 @itemx -mhw-mulx
20990 @itemx -mno-hw-div
20991 @itemx -mhw-div
20992 @opindex mno-hw-mul
20993 @opindex mhw-mul
20994 @opindex mno-hw-mulx
20995 @opindex mhw-mulx
20996 @opindex mno-hw-div
20997 @opindex mhw-div
20998 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
20999 instructions by the compiler. The default is to emit @code{mul}
21000 and not emit @code{div} and @code{mulx}.
21002 @item -mbmx
21003 @itemx -mno-bmx
21004 @itemx -mcdx
21005 @itemx -mno-cdx
21006 Enable or disable generation of Nios II R2 BMX (bit manipulation) and
21007 CDX (code density) instructions.  Enabling these instructions also
21008 requires @option{-march=r2}.  Since these instructions are optional
21009 extensions to the R2 architecture, the default is not to emit them.
21011 @item -mcustom-@var{insn}=@var{N}
21012 @itemx -mno-custom-@var{insn}
21013 @opindex mcustom-@var{insn}
21014 @opindex mno-custom-@var{insn}
21015 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
21016 custom instruction with encoding @var{N} when generating code that uses 
21017 @var{insn}.  For example, @option{-mcustom-fadds=253} generates custom
21018 instruction 253 for single-precision floating-point add operations instead
21019 of the default behavior of using a library call.
21021 The following values of @var{insn} are supported.  Except as otherwise
21022 noted, floating-point operations are expected to be implemented with
21023 normal IEEE 754 semantics and correspond directly to the C operators or the
21024 equivalent GCC built-in functions (@pxref{Other Builtins}).
21026 Single-precision floating point:
21027 @table @asis
21029 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
21030 Binary arithmetic operations.
21032 @item @samp{fnegs}
21033 Unary negation.
21035 @item @samp{fabss}
21036 Unary absolute value.
21038 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
21039 Comparison operations.
21041 @item @samp{fmins}, @samp{fmaxs}
21042 Floating-point minimum and maximum.  These instructions are only
21043 generated if @option{-ffinite-math-only} is specified.
21045 @item @samp{fsqrts}
21046 Unary square root operation.
21048 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
21049 Floating-point trigonometric and exponential functions.  These instructions
21050 are only generated if @option{-funsafe-math-optimizations} is also specified.
21052 @end table
21054 Double-precision floating point:
21055 @table @asis
21057 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
21058 Binary arithmetic operations.
21060 @item @samp{fnegd}
21061 Unary negation.
21063 @item @samp{fabsd}
21064 Unary absolute value.
21066 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
21067 Comparison operations.
21069 @item @samp{fmind}, @samp{fmaxd}
21070 Double-precision minimum and maximum.  These instructions are only
21071 generated if @option{-ffinite-math-only} is specified.
21073 @item @samp{fsqrtd}
21074 Unary square root operation.
21076 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
21077 Double-precision trigonometric and exponential functions.  These instructions
21078 are only generated if @option{-funsafe-math-optimizations} is also specified.
21080 @end table
21082 Conversions:
21083 @table @asis
21084 @item @samp{fextsd}
21085 Conversion from single precision to double precision.
21087 @item @samp{ftruncds}
21088 Conversion from double precision to single precision.
21090 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
21091 Conversion from floating point to signed or unsigned integer types, with
21092 truncation towards zero.
21094 @item @samp{round}
21095 Conversion from single-precision floating point to signed integer,
21096 rounding to the nearest integer and ties away from zero.
21097 This corresponds to the @code{__builtin_lroundf} function when
21098 @option{-fno-math-errno} is used.
21100 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
21101 Conversion from signed or unsigned integer types to floating-point types.
21103 @end table
21105 In addition, all of the following transfer instructions for internal
21106 registers X and Y must be provided to use any of the double-precision
21107 floating-point instructions.  Custom instructions taking two
21108 double-precision source operands expect the first operand in the
21109 64-bit register X.  The other operand (or only operand of a unary
21110 operation) is given to the custom arithmetic instruction with the
21111 least significant half in source register @var{src1} and the most
21112 significant half in @var{src2}.  A custom instruction that returns a
21113 double-precision result returns the most significant 32 bits in the
21114 destination register and the other half in 32-bit register Y.  
21115 GCC automatically generates the necessary code sequences to write
21116 register X and/or read register Y when double-precision floating-point
21117 instructions are used.
21119 @table @asis
21121 @item @samp{fwrx}
21122 Write @var{src1} into the least significant half of X and @var{src2} into
21123 the most significant half of X.
21125 @item @samp{fwry}
21126 Write @var{src1} into Y.
21128 @item @samp{frdxhi}, @samp{frdxlo}
21129 Read the most or least (respectively) significant half of X and store it in
21130 @var{dest}.
21132 @item @samp{frdy}
21133 Read the value of Y and store it into @var{dest}.
21134 @end table
21136 Note that you can gain more local control over generation of Nios II custom
21137 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
21138 and @code{target("no-custom-@var{insn}")} function attributes
21139 (@pxref{Function Attributes})
21140 or pragmas (@pxref{Function Specific Option Pragmas}).
21142 @item -mcustom-fpu-cfg=@var{name}
21143 @opindex mcustom-fpu-cfg
21145 This option enables a predefined, named set of custom instruction encodings
21146 (see @option{-mcustom-@var{insn}} above).  
21147 Currently, the following sets are defined:
21149 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
21150 @gccoptlist{-mcustom-fmuls=252 @gol
21151 -mcustom-fadds=253 @gol
21152 -mcustom-fsubs=254 @gol
21153 -fsingle-precision-constant}
21155 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
21156 @gccoptlist{-mcustom-fmuls=252 @gol
21157 -mcustom-fadds=253 @gol
21158 -mcustom-fsubs=254 @gol
21159 -mcustom-fdivs=255 @gol
21160 -fsingle-precision-constant}
21162 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
21163 @gccoptlist{-mcustom-floatus=243 @gol
21164 -mcustom-fixsi=244 @gol
21165 -mcustom-floatis=245 @gol
21166 -mcustom-fcmpgts=246 @gol
21167 -mcustom-fcmples=249 @gol
21168 -mcustom-fcmpeqs=250 @gol
21169 -mcustom-fcmpnes=251 @gol
21170 -mcustom-fmuls=252 @gol
21171 -mcustom-fadds=253 @gol
21172 -mcustom-fsubs=254 @gol
21173 -mcustom-fdivs=255 @gol
21174 -fsingle-precision-constant}
21176 Custom instruction assignments given by individual
21177 @option{-mcustom-@var{insn}=} options override those given by
21178 @option{-mcustom-fpu-cfg=}, regardless of the
21179 order of the options on the command line.
21181 Note that you can gain more local control over selection of a FPU
21182 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
21183 function attribute (@pxref{Function Attributes})
21184 or pragma (@pxref{Function Specific Option Pragmas}).
21186 @end table
21188 These additional @samp{-m} options are available for the Altera Nios II
21189 ELF (bare-metal) target:
21191 @table @gcctabopt
21193 @item -mhal
21194 @opindex mhal
21195 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
21196 startup and termination code, and is typically used in conjunction with
21197 @option{-msys-crt0=} to specify the location of the alternate startup code
21198 provided by the HAL BSP.
21200 @item -msmallc
21201 @opindex msmallc
21202 Link with a limited version of the C library, @option{-lsmallc}, rather than
21203 Newlib.
21205 @item -msys-crt0=@var{startfile}
21206 @opindex msys-crt0
21207 @var{startfile} is the file name of the startfile (crt0) to use 
21208 when linking.  This option is only useful in conjunction with @option{-mhal}.
21210 @item -msys-lib=@var{systemlib}
21211 @opindex msys-lib
21212 @var{systemlib} is the library name of the library that provides
21213 low-level system calls required by the C library,
21214 e.g. @code{read} and @code{write}.
21215 This option is typically used to link with a library provided by a HAL BSP.
21217 @end table
21219 @node Nvidia PTX Options
21220 @subsection Nvidia PTX Options
21221 @cindex Nvidia PTX options
21222 @cindex nvptx options
21224 These options are defined for Nvidia PTX:
21226 @table @gcctabopt
21228 @item -m32
21229 @itemx -m64
21230 @opindex m32
21231 @opindex m64
21232 Generate code for 32-bit or 64-bit ABI.
21234 @item -mmainkernel
21235 @opindex mmainkernel
21236 Link in code for a __main kernel.  This is for stand-alone instead of
21237 offloading execution.
21239 @item -moptimize
21240 @opindex moptimize
21241 Apply partitioned execution optimizations.  This is the default when any
21242 level of optimization is selected.
21244 @item -msoft-stack
21245 @opindex msoft-stack
21246 Generate code that does not use @code{.local} memory
21247 directly for stack storage. Instead, a per-warp stack pointer is
21248 maintained explicitly. This enables variable-length stack allocation (with
21249 variable-length arrays or @code{alloca}), and when global memory is used for
21250 underlying storage, makes it possible to access automatic variables from other
21251 threads, or with atomic instructions. This code generation variant is used
21252 for OpenMP offloading, but the option is exposed on its own for the purpose
21253 of testing the compiler; to generate code suitable for linking into programs
21254 using OpenMP offloading, use option @option{-mgomp}.
21256 @item -muniform-simt
21257 @opindex muniform-simt
21258 Switch to code generation variant that allows to execute all threads in each
21259 warp, while maintaining memory state and side effects as if only one thread
21260 in each warp was active outside of OpenMP SIMD regions.  All atomic operations
21261 and calls to runtime (malloc, free, vprintf) are conditionally executed (iff
21262 current lane index equals the master lane index), and the register being
21263 assigned is copied via a shuffle instruction from the master lane.  Outside of
21264 SIMD regions lane 0 is the master; inside, each thread sees itself as the
21265 master.  Shared memory array @code{int __nvptx_uni[]} stores all-zeros or
21266 all-ones bitmasks for each warp, indicating current mode (0 outside of SIMD
21267 regions).  Each thread can bitwise-and the bitmask at position @code{tid.y}
21268 with current lane index to compute the master lane index.
21270 @item -mgomp
21271 @opindex mgomp
21272 Generate code for use in OpenMP offloading: enables @option{-msoft-stack} and
21273 @option{-muniform-simt} options, and selects corresponding multilib variant.
21275 @end table
21277 @node PDP-11 Options
21278 @subsection PDP-11 Options
21279 @cindex PDP-11 Options
21281 These options are defined for the PDP-11:
21283 @table @gcctabopt
21284 @item -mfpu
21285 @opindex mfpu
21286 Use hardware FPP floating point.  This is the default.  (FIS floating
21287 point on the PDP-11/40 is not supported.)
21289 @item -msoft-float
21290 @opindex msoft-float
21291 Do not use hardware floating point.
21293 @item -mac0
21294 @opindex mac0
21295 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
21297 @item -mno-ac0
21298 @opindex mno-ac0
21299 Return floating-point results in memory.  This is the default.
21301 @item -m40
21302 @opindex m40
21303 Generate code for a PDP-11/40.
21305 @item -m45
21306 @opindex m45
21307 Generate code for a PDP-11/45.  This is the default.
21309 @item -m10
21310 @opindex m10
21311 Generate code for a PDP-11/10.
21313 @item -mbcopy-builtin
21314 @opindex mbcopy-builtin
21315 Use inline @code{movmemhi} patterns for copying memory.  This is the
21316 default.
21318 @item -mbcopy
21319 @opindex mbcopy
21320 Do not use inline @code{movmemhi} patterns for copying memory.
21322 @item -mint16
21323 @itemx -mno-int32
21324 @opindex mint16
21325 @opindex mno-int32
21326 Use 16-bit @code{int}.  This is the default.
21328 @item -mint32
21329 @itemx -mno-int16
21330 @opindex mint32
21331 @opindex mno-int16
21332 Use 32-bit @code{int}.
21334 @item -mfloat64
21335 @itemx -mno-float32
21336 @opindex mfloat64
21337 @opindex mno-float32
21338 Use 64-bit @code{float}.  This is the default.
21340 @item -mfloat32
21341 @itemx -mno-float64
21342 @opindex mfloat32
21343 @opindex mno-float64
21344 Use 32-bit @code{float}.
21346 @item -mabshi
21347 @opindex mabshi
21348 Use @code{abshi2} pattern.  This is the default.
21350 @item -mno-abshi
21351 @opindex mno-abshi
21352 Do not use @code{abshi2} pattern.
21354 @item -mbranch-expensive
21355 @opindex mbranch-expensive
21356 Pretend that branches are expensive.  This is for experimenting with
21357 code generation only.
21359 @item -mbranch-cheap
21360 @opindex mbranch-cheap
21361 Do not pretend that branches are expensive.  This is the default.
21363 @item -munix-asm
21364 @opindex munix-asm
21365 Use Unix assembler syntax.  This is the default when configured for
21366 @samp{pdp11-*-bsd}.
21368 @item -mdec-asm
21369 @opindex mdec-asm
21370 Use DEC assembler syntax.  This is the default when configured for any
21371 PDP-11 target other than @samp{pdp11-*-bsd}.
21372 @end table
21374 @node picoChip Options
21375 @subsection picoChip Options
21376 @cindex picoChip options
21378 These @samp{-m} options are defined for picoChip implementations:
21380 @table @gcctabopt
21382 @item -mae=@var{ae_type}
21383 @opindex mcpu
21384 Set the instruction set, register set, and instruction scheduling
21385 parameters for array element type @var{ae_type}.  Supported values
21386 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
21388 @option{-mae=ANY} selects a completely generic AE type.  Code
21389 generated with this option runs on any of the other AE types.  The
21390 code is not as efficient as it would be if compiled for a specific
21391 AE type, and some types of operation (e.g., multiplication) do not
21392 work properly on all types of AE.
21394 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
21395 for compiled code, and is the default.
21397 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
21398 option may suffer from poor performance of byte (char) manipulation,
21399 since the DSP AE does not provide hardware support for byte load/stores.
21401 @item -msymbol-as-address
21402 Enable the compiler to directly use a symbol name as an address in a
21403 load/store instruction, without first loading it into a
21404 register.  Typically, the use of this option generates larger
21405 programs, which run faster than when the option isn't used.  However, the
21406 results vary from program to program, so it is left as a user option,
21407 rather than being permanently enabled.
21409 @item -mno-inefficient-warnings
21410 Disables warnings about the generation of inefficient code.  These
21411 warnings can be generated, for example, when compiling code that
21412 performs byte-level memory operations on the MAC AE type.  The MAC AE has
21413 no hardware support for byte-level memory operations, so all byte
21414 load/stores must be synthesized from word load/store operations.  This is
21415 inefficient and a warning is generated to indicate
21416 that you should rewrite the code to avoid byte operations, or to target
21417 an AE type that has the necessary hardware support.  This option disables
21418 these warnings.
21420 @end table
21422 @node PowerPC Options
21423 @subsection PowerPC Options
21424 @cindex PowerPC options
21426 These are listed under @xref{RS/6000 and PowerPC Options}.
21428 @node RISC-V Options
21429 @subsection RISC-V Options
21430 @cindex RISC-V Options
21432 These command-line options are defined for RISC-V targets:
21434 @table @gcctabopt
21435 @item -mbranch-cost=@var{n}
21436 @opindex mbranch-cost
21437 Set the cost of branches to roughly @var{n} instructions.
21439 @item -mmemcpy
21440 @itemx -mno-memcpy
21441 @opindex mmemcpy
21442 Don't optimize block moves.
21444 @item -mplt
21445 @itemx -mno-plt
21446 @opindex plt
21447 When generating PIC code, allow the use of PLTs. Ignored for non-PIC.
21449 @item -mabi=@var{ABI-string}
21450 @opindex mabi
21451 Specify integer and floating-point calling convention.  This defaults to the
21452 natural calling convention: e.g.@ LP64 for RV64I, ILP32 for RV32I, LP64D for
21453 RV64G.
21455 @item -mfdiv
21456 @itemx -mno-fdiv
21457 @opindex mfdiv
21458 Use hardware floating-point divide and square root instructions.  This requires
21459 the F or D extensions for floating-point registers.
21461 @item -mdiv
21462 @itemx -mno-div
21463 @opindex mdiv
21464 Use hardware instructions for integer division.  This requires the M extension.
21466 @item -march=@var{ISA-string}
21467 @opindex march
21468 Generate code for given RISC-V ISA (e.g.@ @samp{rv64im}).  ISA strings must be
21469 lower-case.  Examples include @samp{rv64i}, @samp{rv32g}, and @samp{rv32imaf}.
21471 @item -mtune=@var{processor-string}
21472 @opindex mtune
21473 Optimize the output for the given processor, specified by microarchitecture
21474 name.
21476 @item -msmall-data-limit=@var{n}
21477 @opindex msmall-data-limit
21478 Put global and static data smaller than @var{n} bytes into a special section
21479 (on some targets).
21481 @item -msave-restore
21482 @itemx -mno-save-restore
21483 @opindex msave-restore
21484 Use smaller but slower prologue and epilogue code.
21486 @item -mstrict-align
21487 @itemx -mno-strict-align
21488 @opindex mstrict-align
21489 Do not generate unaligned memory accesses.
21491 @item -mcmodel=@var{code-model}
21492 @opindex mcmodel
21493 Specify the code model.
21495 @end table
21497 @node RL78 Options
21498 @subsection RL78 Options
21499 @cindex RL78 Options
21501 @table @gcctabopt
21503 @item -msim
21504 @opindex msim
21505 Links in additional target libraries to support operation within a
21506 simulator.
21508 @item -mmul=none
21509 @itemx -mmul=g10
21510 @itemx -mmul=g13
21511 @itemx -mmul=g14
21512 @itemx -mmul=rl78
21513 @opindex mmul
21514 Specifies the type of hardware multiplication and division support to
21515 be used.  The simplest is @code{none}, which uses software for both
21516 multiplication and division.  This is the default.  The @code{g13}
21517 value is for the hardware multiply/divide peripheral found on the
21518 RL78/G13 (S2 core) targets.  The @code{g14} value selects the use of
21519 the multiplication and division instructions supported by the RL78/G14
21520 (S3 core) parts.  The value @code{rl78} is an alias for @code{g14} and
21521 the value @code{mg10} is an alias for @code{none}.
21523 In addition a C preprocessor macro is defined, based upon the setting
21524 of this option.  Possible values are: @code{__RL78_MUL_NONE__},
21525 @code{__RL78_MUL_G13__} or @code{__RL78_MUL_G14__}.
21527 @item -mcpu=g10
21528 @itemx -mcpu=g13
21529 @itemx -mcpu=g14
21530 @itemx -mcpu=rl78
21531 @opindex mcpu
21532 Specifies the RL78 core to target.  The default is the G14 core, also
21533 known as an S3 core or just RL78.  The G13 or S2 core does not have
21534 multiply or divide instructions, instead it uses a hardware peripheral
21535 for these operations.  The G10 or S1 core does not have register
21536 banks, so it uses a different calling convention.
21538 If this option is set it also selects the type of hardware multiply
21539 support to use, unless this is overridden by an explicit
21540 @option{-mmul=none} option on the command line.  Thus specifying
21541 @option{-mcpu=g13} enables the use of the G13 hardware multiply
21542 peripheral and specifying @option{-mcpu=g10} disables the use of
21543 hardware multiplications altogether.
21545 Note, although the RL78/G14 core is the default target, specifying
21546 @option{-mcpu=g14} or @option{-mcpu=rl78} on the command line does
21547 change the behavior of the toolchain since it also enables G14
21548 hardware multiply support.  If these options are not specified on the
21549 command line then software multiplication routines will be used even
21550 though the code targets the RL78 core.  This is for backwards
21551 compatibility with older toolchains which did not have hardware
21552 multiply and divide support.
21554 In addition a C preprocessor macro is defined, based upon the setting
21555 of this option.  Possible values are: @code{__RL78_G10__},
21556 @code{__RL78_G13__} or @code{__RL78_G14__}.
21558 @item -mg10
21559 @itemx -mg13
21560 @itemx -mg14
21561 @itemx -mrl78
21562 @opindex mg10
21563 @opindex mg13
21564 @opindex mg14
21565 @opindex mrl78
21566 These are aliases for the corresponding @option{-mcpu=} option.  They
21567 are provided for backwards compatibility.
21569 @item -mallregs
21570 @opindex mallregs
21571 Allow the compiler to use all of the available registers.  By default
21572 registers @code{r24..r31} are reserved for use in interrupt handlers.
21573 With this option enabled these registers can be used in ordinary
21574 functions as well.
21576 @item -m64bit-doubles
21577 @itemx -m32bit-doubles
21578 @opindex m64bit-doubles
21579 @opindex m32bit-doubles
21580 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
21581 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
21582 @option{-m32bit-doubles}.
21584 @item -msave-mduc-in-interrupts
21585 @item -mno-save-mduc-in-interrupts
21586 @opindex msave-mduc-in-interrupts
21587 @opindex mno-save-mduc-in-interrupts
21588 Specifies that interrupt handler functions should preserve the
21589 MDUC registers.  This is only necessary if normal code might use
21590 the MDUC registers, for example because it performs multiplication
21591 and division operations.  The default is to ignore the MDUC registers
21592 as this makes the interrupt handlers faster.  The target option -mg13
21593 needs to be passed for this to work as this feature is only available
21594 on the G13 target (S2 core).  The MDUC registers will only be saved
21595 if the interrupt handler performs a multiplication or division
21596 operation or it calls another function.
21598 @end table
21600 @node RS/6000 and PowerPC Options
21601 @subsection IBM RS/6000 and PowerPC Options
21602 @cindex RS/6000 and PowerPC Options
21603 @cindex IBM RS/6000 and PowerPC Options
21605 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
21606 @table @gcctabopt
21607 @item -mpowerpc-gpopt
21608 @itemx -mno-powerpc-gpopt
21609 @itemx -mpowerpc-gfxopt
21610 @itemx -mno-powerpc-gfxopt
21611 @need 800
21612 @itemx -mpowerpc64
21613 @itemx -mno-powerpc64
21614 @itemx -mmfcrf
21615 @itemx -mno-mfcrf
21616 @itemx -mpopcntb
21617 @itemx -mno-popcntb
21618 @itemx -mpopcntd
21619 @itemx -mno-popcntd
21620 @itemx -mfprnd
21621 @itemx -mno-fprnd
21622 @need 800
21623 @itemx -mcmpb
21624 @itemx -mno-cmpb
21625 @itemx -mmfpgpr
21626 @itemx -mno-mfpgpr
21627 @itemx -mhard-dfp
21628 @itemx -mno-hard-dfp
21629 @opindex mpowerpc-gpopt
21630 @opindex mno-powerpc-gpopt
21631 @opindex mpowerpc-gfxopt
21632 @opindex mno-powerpc-gfxopt
21633 @opindex mpowerpc64
21634 @opindex mno-powerpc64
21635 @opindex mmfcrf
21636 @opindex mno-mfcrf
21637 @opindex mpopcntb
21638 @opindex mno-popcntb
21639 @opindex mpopcntd
21640 @opindex mno-popcntd
21641 @opindex mfprnd
21642 @opindex mno-fprnd
21643 @opindex mcmpb
21644 @opindex mno-cmpb
21645 @opindex mmfpgpr
21646 @opindex mno-mfpgpr
21647 @opindex mhard-dfp
21648 @opindex mno-hard-dfp
21649 You use these options to specify which instructions are available on the
21650 processor you are using.  The default value of these options is
21651 determined when configuring GCC@.  Specifying the
21652 @option{-mcpu=@var{cpu_type}} overrides the specification of these
21653 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
21654 rather than the options listed above.
21656 Specifying @option{-mpowerpc-gpopt} allows
21657 GCC to use the optional PowerPC architecture instructions in the
21658 General Purpose group, including floating-point square root.  Specifying
21659 @option{-mpowerpc-gfxopt} allows GCC to
21660 use the optional PowerPC architecture instructions in the Graphics
21661 group, including floating-point select.
21663 The @option{-mmfcrf} option allows GCC to generate the move from
21664 condition register field instruction implemented on the POWER4
21665 processor and other processors that support the PowerPC V2.01
21666 architecture.
21667 The @option{-mpopcntb} option allows GCC to generate the popcount and
21668 double-precision FP reciprocal estimate instruction implemented on the
21669 POWER5 processor and other processors that support the PowerPC V2.02
21670 architecture.
21671 The @option{-mpopcntd} option allows GCC to generate the popcount
21672 instruction implemented on the POWER7 processor and other processors
21673 that support the PowerPC V2.06 architecture.
21674 The @option{-mfprnd} option allows GCC to generate the FP round to
21675 integer instructions implemented on the POWER5+ processor and other
21676 processors that support the PowerPC V2.03 architecture.
21677 The @option{-mcmpb} option allows GCC to generate the compare bytes
21678 instruction implemented on the POWER6 processor and other processors
21679 that support the PowerPC V2.05 architecture.
21680 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
21681 general-purpose register instructions implemented on the POWER6X
21682 processor and other processors that support the extended PowerPC V2.05
21683 architecture.
21684 The @option{-mhard-dfp} option allows GCC to generate the decimal
21685 floating-point instructions implemented on some POWER processors.
21687 The @option{-mpowerpc64} option allows GCC to generate the additional
21688 64-bit instructions that are found in the full PowerPC64 architecture
21689 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
21690 @option{-mno-powerpc64}.
21692 @item -mcpu=@var{cpu_type}
21693 @opindex mcpu
21694 Set architecture type, register usage, and
21695 instruction scheduling parameters for machine type @var{cpu_type}.
21696 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
21697 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
21698 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
21699 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
21700 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
21701 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
21702 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
21703 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
21704 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
21705 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8},
21706 @samp{power9}, @samp{powerpc}, @samp{powerpc64}, @samp{powerpc64le},
21707 and @samp{rs64}.
21709 @option{-mcpu=powerpc}, @option{-mcpu=powerpc64}, and
21710 @option{-mcpu=powerpc64le} specify pure 32-bit PowerPC (either
21711 endian), 64-bit big endian PowerPC and 64-bit little endian PowerPC
21712 architecture machine types, with an appropriate, generic processor
21713 model assumed for scheduling purposes.
21715 The other options specify a specific processor.  Code generated under
21716 those options runs best on that processor, and may not run at all on
21717 others.
21719 The @option{-mcpu} options automatically enable or disable the
21720 following options:
21722 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
21723 -mpopcntb -mpopcntd  -mpowerpc64 @gol
21724 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
21725 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
21726 -mcrypto -mdirect-move -mhtm -mpower8-fusion -mpower8-vector @gol
21727 -mquad-memory -mquad-memory-atomic -mfloat128 -mfloat128-hardware}
21729 The particular options set for any particular CPU varies between
21730 compiler versions, depending on what setting seems to produce optimal
21731 code for that CPU; it doesn't necessarily reflect the actual hardware's
21732 capabilities.  If you wish to set an individual option to a particular
21733 value, you may specify it after the @option{-mcpu} option, like
21734 @option{-mcpu=970 -mno-altivec}.
21736 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
21737 not enabled or disabled by the @option{-mcpu} option at present because
21738 AIX does not have full support for these options.  You may still
21739 enable or disable them individually if you're sure it'll work in your
21740 environment.
21742 @item -mtune=@var{cpu_type}
21743 @opindex mtune
21744 Set the instruction scheduling parameters for machine type
21745 @var{cpu_type}, but do not set the architecture type or register usage,
21746 as @option{-mcpu=@var{cpu_type}} does.  The same
21747 values for @var{cpu_type} are used for @option{-mtune} as for
21748 @option{-mcpu}.  If both are specified, the code generated uses the
21749 architecture and registers set by @option{-mcpu}, but the
21750 scheduling parameters set by @option{-mtune}.
21752 @item -mcmodel=small
21753 @opindex mcmodel=small
21754 Generate PowerPC64 code for the small model: The TOC is limited to
21755 64k.
21757 @item -mcmodel=medium
21758 @opindex mcmodel=medium
21759 Generate PowerPC64 code for the medium model: The TOC and other static
21760 data may be up to a total of 4G in size.  This is the default for 64-bit
21761 Linux.
21763 @item -mcmodel=large
21764 @opindex mcmodel=large
21765 Generate PowerPC64 code for the large model: The TOC may be up to 4G
21766 in size.  Other data and code is only limited by the 64-bit address
21767 space.
21769 @item -maltivec
21770 @itemx -mno-altivec
21771 @opindex maltivec
21772 @opindex mno-altivec
21773 Generate code that uses (does not use) AltiVec instructions, and also
21774 enable the use of built-in functions that allow more direct access to
21775 the AltiVec instruction set.  You may also need to set
21776 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
21777 enhancements.
21779 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
21780 @option{-maltivec=be}, the element order for AltiVec intrinsics such
21781 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} 
21782 match array element order corresponding to the endianness of the
21783 target.  That is, element zero identifies the leftmost element in a
21784 vector register when targeting a big-endian platform, and identifies
21785 the rightmost element in a vector register when targeting a
21786 little-endian platform.
21788 @item -maltivec=be
21789 @opindex maltivec=be
21790 Generate AltiVec instructions using big-endian element order,
21791 regardless of whether the target is big- or little-endian.  This is
21792 the default when targeting a big-endian platform.
21794 The element order is used to interpret element numbers in AltiVec
21795 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
21796 @code{vec_insert}.  By default, these match array element order
21797 corresponding to the endianness for the target.
21799 @item -maltivec=le
21800 @opindex maltivec=le
21801 Generate AltiVec instructions using little-endian element order,
21802 regardless of whether the target is big- or little-endian.  This is
21803 the default when targeting a little-endian platform.  This option is
21804 currently ignored when targeting a big-endian platform.
21806 The element order is used to interpret element numbers in AltiVec
21807 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
21808 @code{vec_insert}.  By default, these match array element order
21809 corresponding to the endianness for the target.
21811 @item -mvrsave
21812 @itemx -mno-vrsave
21813 @opindex mvrsave
21814 @opindex mno-vrsave
21815 Generate VRSAVE instructions when generating AltiVec code.
21817 @item -msecure-plt
21818 @opindex msecure-plt
21819 Generate code that allows @command{ld} and @command{ld.so}
21820 to build executables and shared
21821 libraries with non-executable @code{.plt} and @code{.got} sections.
21822 This is a PowerPC
21823 32-bit SYSV ABI option.
21825 @item -mbss-plt
21826 @opindex mbss-plt
21827 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
21828 fills in, and
21829 requires @code{.plt} and @code{.got}
21830 sections that are both writable and executable.
21831 This is a PowerPC 32-bit SYSV ABI option.
21833 @item -misel
21834 @itemx -mno-isel
21835 @opindex misel
21836 @opindex mno-isel
21837 This switch enables or disables the generation of ISEL instructions.
21839 @item -misel=@var{yes/no}
21840 This switch has been deprecated.  Use @option{-misel} and
21841 @option{-mno-isel} instead.
21843 @item -mspe
21844 @itemx -mno-spe
21845 @opindex mspe
21846 @opindex mno-spe
21847 This switch enables or disables the generation of SPE simd
21848 instructions.
21850 @item -mpaired
21851 @itemx -mno-paired
21852 @opindex mpaired
21853 @opindex mno-paired
21854 This switch enables or disables the generation of PAIRED simd
21855 instructions.
21857 @item -mspe=@var{yes/no}
21858 This option has been deprecated.  Use @option{-mspe} and
21859 @option{-mno-spe} instead.
21861 @item -mvsx
21862 @itemx -mno-vsx
21863 @opindex mvsx
21864 @opindex mno-vsx
21865 Generate code that uses (does not use) vector/scalar (VSX)
21866 instructions, and also enable the use of built-in functions that allow
21867 more direct access to the VSX instruction set.
21869 @item -mcrypto
21870 @itemx -mno-crypto
21871 @opindex mcrypto
21872 @opindex mno-crypto
21873 Enable the use (disable) of the built-in functions that allow direct
21874 access to the cryptographic instructions that were added in version
21875 2.07 of the PowerPC ISA.
21877 @item -mdirect-move
21878 @itemx -mno-direct-move
21879 @opindex mdirect-move
21880 @opindex mno-direct-move
21881 Generate code that uses (does not use) the instructions to move data
21882 between the general purpose registers and the vector/scalar (VSX)
21883 registers that were added in version 2.07 of the PowerPC ISA.
21885 @item -mhtm
21886 @itemx -mno-htm
21887 @opindex mhtm
21888 @opindex mno-htm
21889 Enable (disable) the use of the built-in functions that allow direct
21890 access to the Hardware Transactional Memory (HTM) instructions that
21891 were added in version 2.07 of the PowerPC ISA.
21893 @item -mpower8-fusion
21894 @itemx -mno-power8-fusion
21895 @opindex mpower8-fusion
21896 @opindex mno-power8-fusion
21897 Generate code that keeps (does not keeps) some integer operations
21898 adjacent so that the instructions can be fused together on power8 and
21899 later processors.
21901 @item -mpower8-vector
21902 @itemx -mno-power8-vector
21903 @opindex mpower8-vector
21904 @opindex mno-power8-vector
21905 Generate code that uses (does not use) the vector and scalar
21906 instructions that were added in version 2.07 of the PowerPC ISA.  Also
21907 enable the use of built-in functions that allow more direct access to
21908 the vector instructions.
21910 @item -mquad-memory
21911 @itemx -mno-quad-memory
21912 @opindex mquad-memory
21913 @opindex mno-quad-memory
21914 Generate code that uses (does not use) the non-atomic quad word memory
21915 instructions.  The @option{-mquad-memory} option requires use of
21916 64-bit mode.
21918 @item -mquad-memory-atomic
21919 @itemx -mno-quad-memory-atomic
21920 @opindex mquad-memory-atomic
21921 @opindex mno-quad-memory-atomic
21922 Generate code that uses (does not use) the atomic quad word memory
21923 instructions.  The @option{-mquad-memory-atomic} option requires use of
21924 64-bit mode.
21926 @item -mfloat128
21927 @itemx -mno-float128
21928 @opindex mfloat128
21929 @opindex mno-float128
21930 Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point
21931 and use either software emulation for IEEE 128-bit floating point or
21932 hardware instructions.
21934 The VSX instruction set (@option{-mvsx}, @option{-mcpu=power7}, or
21935 @option{-mcpu=power8}) must be enabled to use the @option{-mfloat128}
21936 option.  The @option{-mfloat128} option only works on PowerPC 64-bit
21937 Linux systems.
21939 If you use the ISA 3.0 instruction set (@option{-mcpu=power9}), the
21940 @option{-mfloat128} option will also enable the generation of ISA 3.0
21941 IEEE 128-bit floating point instructions.  Otherwise, IEEE 128-bit
21942 floating point will be done with software emulation.
21944 @item -mfloat128-hardware
21945 @itemx -mno-float128-hardware
21946 @opindex mfloat128-hardware
21947 @opindex mno-float128-hardware
21948 Enable/disable using ISA 3.0 hardware instructions to support the
21949 @var{__float128} data type.
21951 If you use @option{-mfloat128-hardware}, it will enable the option
21952 @option{-mfloat128} as well.
21954 If you select ISA 3.0 instructions with @option{-mcpu=power9}, but do
21955 not use either @option{-mfloat128} or @option{-mfloat128-hardware},
21956 the IEEE 128-bit floating point support will not be enabled.
21958 @item -mfloat-gprs=@var{yes/single/double/no}
21959 @itemx -mfloat-gprs
21960 @opindex mfloat-gprs
21961 This switch enables or disables the generation of floating-point
21962 operations on the general-purpose registers for architectures that
21963 support it.
21965 The argument @samp{yes} or @samp{single} enables the use of
21966 single-precision floating-point operations.
21968 The argument @samp{double} enables the use of single and
21969 double-precision floating-point operations.
21971 The argument @samp{no} disables floating-point operations on the
21972 general-purpose registers.
21974 This option is currently only available on the MPC854x.
21976 @item -m32
21977 @itemx -m64
21978 @opindex m32
21979 @opindex m64
21980 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
21981 targets (including GNU/Linux).  The 32-bit environment sets int, long
21982 and pointer to 32 bits and generates code that runs on any PowerPC
21983 variant.  The 64-bit environment sets int to 32 bits and long and
21984 pointer to 64 bits, and generates code for PowerPC64, as for
21985 @option{-mpowerpc64}.
21987 @item -mfull-toc
21988 @itemx -mno-fp-in-toc
21989 @itemx -mno-sum-in-toc
21990 @itemx -mminimal-toc
21991 @opindex mfull-toc
21992 @opindex mno-fp-in-toc
21993 @opindex mno-sum-in-toc
21994 @opindex mminimal-toc
21995 Modify generation of the TOC (Table Of Contents), which is created for
21996 every executable file.  The @option{-mfull-toc} option is selected by
21997 default.  In that case, GCC allocates at least one TOC entry for
21998 each unique non-automatic variable reference in your program.  GCC
21999 also places floating-point constants in the TOC@.  However, only
22000 16,384 entries are available in the TOC@.
22002 If you receive a linker error message that saying you have overflowed
22003 the available TOC space, you can reduce the amount of TOC space used
22004 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
22005 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
22006 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
22007 generate code to calculate the sum of an address and a constant at
22008 run time instead of putting that sum into the TOC@.  You may specify one
22009 or both of these options.  Each causes GCC to produce very slightly
22010 slower and larger code at the expense of conserving TOC space.
22012 If you still run out of space in the TOC even when you specify both of
22013 these options, specify @option{-mminimal-toc} instead.  This option causes
22014 GCC to make only one TOC entry for every file.  When you specify this
22015 option, GCC produces code that is slower and larger but which
22016 uses extremely little TOC space.  You may wish to use this option
22017 only on files that contain less frequently-executed code.
22019 @item -maix64
22020 @itemx -maix32
22021 @opindex maix64
22022 @opindex maix32
22023 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
22024 @code{long} type, and the infrastructure needed to support them.
22025 Specifying @option{-maix64} implies @option{-mpowerpc64},
22026 while @option{-maix32} disables the 64-bit ABI and
22027 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
22029 @item -mxl-compat
22030 @itemx -mno-xl-compat
22031 @opindex mxl-compat
22032 @opindex mno-xl-compat
22033 Produce code that conforms more closely to IBM XL compiler semantics
22034 when using AIX-compatible ABI@.  Pass floating-point arguments to
22035 prototyped functions beyond the register save area (RSA) on the stack
22036 in addition to argument FPRs.  Do not assume that most significant
22037 double in 128-bit long double value is properly rounded when comparing
22038 values and converting to double.  Use XL symbol names for long double
22039 support routines.
22041 The AIX calling convention was extended but not initially documented to
22042 handle an obscure K&R C case of calling a function that takes the
22043 address of its arguments with fewer arguments than declared.  IBM XL
22044 compilers access floating-point arguments that do not fit in the
22045 RSA from the stack when a subroutine is compiled without
22046 optimization.  Because always storing floating-point arguments on the
22047 stack is inefficient and rarely needed, this option is not enabled by
22048 default and only is necessary when calling subroutines compiled by IBM
22049 XL compilers without optimization.
22051 @item -mpe
22052 @opindex mpe
22053 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
22054 application written to use message passing with special startup code to
22055 enable the application to run.  The system must have PE installed in the
22056 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
22057 must be overridden with the @option{-specs=} option to specify the
22058 appropriate directory location.  The Parallel Environment does not
22059 support threads, so the @option{-mpe} option and the @option{-pthread}
22060 option are incompatible.
22062 @item -malign-natural
22063 @itemx -malign-power
22064 @opindex malign-natural
22065 @opindex malign-power
22066 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
22067 @option{-malign-natural} overrides the ABI-defined alignment of larger
22068 types, such as floating-point doubles, on their natural size-based boundary.
22069 The option @option{-malign-power} instructs GCC to follow the ABI-specified
22070 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
22072 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
22073 is not supported.
22075 @item -msoft-float
22076 @itemx -mhard-float
22077 @opindex msoft-float
22078 @opindex mhard-float
22079 Generate code that does not use (uses) the floating-point register set.
22080 Software floating-point emulation is provided if you use the
22081 @option{-msoft-float} option, and pass the option to GCC when linking.
22083 @item -msingle-float
22084 @itemx -mdouble-float
22085 @opindex msingle-float
22086 @opindex mdouble-float
22087 Generate code for single- or double-precision floating-point operations.
22088 @option{-mdouble-float} implies @option{-msingle-float}.
22090 @item -msimple-fpu
22091 @opindex msimple-fpu
22092 Do not generate @code{sqrt} and @code{div} instructions for hardware
22093 floating-point unit.
22095 @item -mfpu=@var{name}
22096 @opindex mfpu
22097 Specify type of floating-point unit.  Valid values for @var{name} are
22098 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
22099 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
22100 @samp{sp_full} (equivalent to @option{-msingle-float}),
22101 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
22103 @item -mxilinx-fpu
22104 @opindex mxilinx-fpu
22105 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
22107 @item -mmultiple
22108 @itemx -mno-multiple
22109 @opindex mmultiple
22110 @opindex mno-multiple
22111 Generate code that uses (does not use) the load multiple word
22112 instructions and the store multiple word instructions.  These
22113 instructions are generated by default on POWER systems, and not
22114 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
22115 PowerPC systems, since those instructions do not work when the
22116 processor is in little-endian mode.  The exceptions are PPC740 and
22117 PPC750 which permit these instructions in little-endian mode.
22119 @item -mstring
22120 @itemx -mno-string
22121 @opindex mstring
22122 @opindex mno-string
22123 Generate code that uses (does not use) the load string instructions
22124 and the store string word instructions to save multiple registers and
22125 do small block moves.  These instructions are generated by default on
22126 POWER systems, and not generated on PowerPC systems.  Do not use
22127 @option{-mstring} on little-endian PowerPC systems, since those
22128 instructions do not work when the processor is in little-endian mode.
22129 The exceptions are PPC740 and PPC750 which permit these instructions
22130 in little-endian mode.
22132 @item -mupdate
22133 @itemx -mno-update
22134 @opindex mupdate
22135 @opindex mno-update
22136 Generate code that uses (does not use) the load or store instructions
22137 that update the base register to the address of the calculated memory
22138 location.  These instructions are generated by default.  If you use
22139 @option{-mno-update}, there is a small window between the time that the
22140 stack pointer is updated and the address of the previous frame is
22141 stored, which means code that walks the stack frame across interrupts or
22142 signals may get corrupted data.
22144 @item -mavoid-indexed-addresses
22145 @itemx -mno-avoid-indexed-addresses
22146 @opindex mavoid-indexed-addresses
22147 @opindex mno-avoid-indexed-addresses
22148 Generate code that tries to avoid (not avoid) the use of indexed load
22149 or store instructions. These instructions can incur a performance
22150 penalty on Power6 processors in certain situations, such as when
22151 stepping through large arrays that cross a 16M boundary.  This option
22152 is enabled by default when targeting Power6 and disabled otherwise.
22154 @item -mfused-madd
22155 @itemx -mno-fused-madd
22156 @opindex mfused-madd
22157 @opindex mno-fused-madd
22158 Generate code that uses (does not use) the floating-point multiply and
22159 accumulate instructions.  These instructions are generated by default
22160 if hardware floating point is used.  The machine-dependent
22161 @option{-mfused-madd} option is now mapped to the machine-independent
22162 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
22163 mapped to @option{-ffp-contract=off}.
22165 @item -mmulhw
22166 @itemx -mno-mulhw
22167 @opindex mmulhw
22168 @opindex mno-mulhw
22169 Generate code that uses (does not use) the half-word multiply and
22170 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
22171 These instructions are generated by default when targeting those
22172 processors.
22174 @item -mdlmzb
22175 @itemx -mno-dlmzb
22176 @opindex mdlmzb
22177 @opindex mno-dlmzb
22178 Generate code that uses (does not use) the string-search @samp{dlmzb}
22179 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
22180 generated by default when targeting those processors.
22182 @item -mno-bit-align
22183 @itemx -mbit-align
22184 @opindex mno-bit-align
22185 @opindex mbit-align
22186 On System V.4 and embedded PowerPC systems do not (do) force structures
22187 and unions that contain bit-fields to be aligned to the base type of the
22188 bit-field.
22190 For example, by default a structure containing nothing but 8
22191 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
22192 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
22193 the structure is aligned to a 1-byte boundary and is 1 byte in
22194 size.
22196 @item -mno-strict-align
22197 @itemx -mstrict-align
22198 @opindex mno-strict-align
22199 @opindex mstrict-align
22200 On System V.4 and embedded PowerPC systems do not (do) assume that
22201 unaligned memory references are handled by the system.
22203 @item -mrelocatable
22204 @itemx -mno-relocatable
22205 @opindex mrelocatable
22206 @opindex mno-relocatable
22207 Generate code that allows (does not allow) a static executable to be
22208 relocated to a different address at run time.  A simple embedded
22209 PowerPC system loader should relocate the entire contents of
22210 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
22211 a table of 32-bit addresses generated by this option.  For this to
22212 work, all objects linked together must be compiled with
22213 @option{-mrelocatable} or @option{-mrelocatable-lib}.
22214 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
22216 @item -mrelocatable-lib
22217 @itemx -mno-relocatable-lib
22218 @opindex mrelocatable-lib
22219 @opindex mno-relocatable-lib
22220 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
22221 @code{.fixup} section to allow static executables to be relocated at
22222 run time, but @option{-mrelocatable-lib} does not use the smaller stack
22223 alignment of @option{-mrelocatable}.  Objects compiled with
22224 @option{-mrelocatable-lib} may be linked with objects compiled with
22225 any combination of the @option{-mrelocatable} options.
22227 @item -mno-toc
22228 @itemx -mtoc
22229 @opindex mno-toc
22230 @opindex mtoc
22231 On System V.4 and embedded PowerPC systems do not (do) assume that
22232 register 2 contains a pointer to a global area pointing to the addresses
22233 used in the program.
22235 @item -mlittle
22236 @itemx -mlittle-endian
22237 @opindex mlittle
22238 @opindex mlittle-endian
22239 On System V.4 and embedded PowerPC systems compile code for the
22240 processor in little-endian mode.  The @option{-mlittle-endian} option is
22241 the same as @option{-mlittle}.
22243 @item -mbig
22244 @itemx -mbig-endian
22245 @opindex mbig
22246 @opindex mbig-endian
22247 On System V.4 and embedded PowerPC systems compile code for the
22248 processor in big-endian mode.  The @option{-mbig-endian} option is
22249 the same as @option{-mbig}.
22251 @item -mdynamic-no-pic
22252 @opindex mdynamic-no-pic
22253 On Darwin and Mac OS X systems, compile code so that it is not
22254 relocatable, but that its external references are relocatable.  The
22255 resulting code is suitable for applications, but not shared
22256 libraries.
22258 @item -msingle-pic-base
22259 @opindex msingle-pic-base
22260 Treat the register used for PIC addressing as read-only, rather than
22261 loading it in the prologue for each function.  The runtime system is
22262 responsible for initializing this register with an appropriate value
22263 before execution begins.
22265 @item -mprioritize-restricted-insns=@var{priority}
22266 @opindex mprioritize-restricted-insns
22267 This option controls the priority that is assigned to
22268 dispatch-slot restricted instructions during the second scheduling
22269 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
22270 or @samp{2} to assign no, highest, or second-highest (respectively) 
22271 priority to dispatch-slot restricted
22272 instructions.
22274 @item -msched-costly-dep=@var{dependence_type}
22275 @opindex msched-costly-dep
22276 This option controls which dependences are considered costly
22277 by the target during instruction scheduling.  The argument
22278 @var{dependence_type} takes one of the following values:
22280 @table @asis
22281 @item @samp{no}
22282 No dependence is costly.
22284 @item @samp{all}
22285 All dependences are costly.
22287 @item @samp{true_store_to_load}
22288 A true dependence from store to load is costly.
22290 @item @samp{store_to_load}
22291 Any dependence from store to load is costly.
22293 @item @var{number}
22294 Any dependence for which the latency is greater than or equal to 
22295 @var{number} is costly.
22296 @end table
22298 @item -minsert-sched-nops=@var{scheme}
22299 @opindex minsert-sched-nops
22300 This option controls which NOP insertion scheme is used during
22301 the second scheduling pass.  The argument @var{scheme} takes one of the
22302 following values:
22304 @table @asis
22305 @item @samp{no}
22306 Don't insert NOPs.
22308 @item @samp{pad}
22309 Pad with NOPs any dispatch group that has vacant issue slots,
22310 according to the scheduler's grouping.
22312 @item @samp{regroup_exact}
22313 Insert NOPs to force costly dependent insns into
22314 separate groups.  Insert exactly as many NOPs as needed to force an insn
22315 to a new group, according to the estimated processor grouping.
22317 @item @var{number}
22318 Insert NOPs to force costly dependent insns into
22319 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
22320 @end table
22322 @item -mcall-sysv
22323 @opindex mcall-sysv
22324 On System V.4 and embedded PowerPC systems compile code using calling
22325 conventions that adhere to the March 1995 draft of the System V
22326 Application Binary Interface, PowerPC processor supplement.  This is the
22327 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
22329 @item -mcall-sysv-eabi
22330 @itemx -mcall-eabi
22331 @opindex mcall-sysv-eabi
22332 @opindex mcall-eabi
22333 Specify both @option{-mcall-sysv} and @option{-meabi} options.
22335 @item -mcall-sysv-noeabi
22336 @opindex mcall-sysv-noeabi
22337 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
22339 @item -mcall-aixdesc
22340 @opindex m
22341 On System V.4 and embedded PowerPC systems compile code for the AIX
22342 operating system.
22344 @item -mcall-linux
22345 @opindex mcall-linux
22346 On System V.4 and embedded PowerPC systems compile code for the
22347 Linux-based GNU system.
22349 @item -mcall-freebsd
22350 @opindex mcall-freebsd
22351 On System V.4 and embedded PowerPC systems compile code for the
22352 FreeBSD operating system.
22354 @item -mcall-netbsd
22355 @opindex mcall-netbsd
22356 On System V.4 and embedded PowerPC systems compile code for the
22357 NetBSD operating system.
22359 @item -mcall-openbsd
22360 @opindex mcall-netbsd
22361 On System V.4 and embedded PowerPC systems compile code for the
22362 OpenBSD operating system.
22364 @item -maix-struct-return
22365 @opindex maix-struct-return
22366 Return all structures in memory (as specified by the AIX ABI)@.
22368 @item -msvr4-struct-return
22369 @opindex msvr4-struct-return
22370 Return structures smaller than 8 bytes in registers (as specified by the
22371 SVR4 ABI)@.
22373 @item -mabi=@var{abi-type}
22374 @opindex mabi
22375 Extend the current ABI with a particular extension, or remove such extension.
22376 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
22377 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
22378 @samp{elfv1}, @samp{elfv2}@.
22380 @item -mabi=spe
22381 @opindex mabi=spe
22382 Extend the current ABI with SPE ABI extensions.  This does not change
22383 the default ABI, instead it adds the SPE ABI extensions to the current
22384 ABI@.
22386 @item -mabi=no-spe
22387 @opindex mabi=no-spe
22388 Disable Book-E SPE ABI extensions for the current ABI@.
22390 @item -mabi=ibmlongdouble
22391 @opindex mabi=ibmlongdouble
22392 Change the current ABI to use IBM extended-precision long double.
22393 This is a PowerPC 32-bit SYSV ABI option.
22395 @item -mabi=ieeelongdouble
22396 @opindex mabi=ieeelongdouble
22397 Change the current ABI to use IEEE extended-precision long double.
22398 This is a PowerPC 32-bit Linux ABI option.
22400 @item -mabi=elfv1
22401 @opindex mabi=elfv1
22402 Change the current ABI to use the ELFv1 ABI.
22403 This is the default ABI for big-endian PowerPC 64-bit Linux.
22404 Overriding the default ABI requires special system support and is
22405 likely to fail in spectacular ways.
22407 @item -mabi=elfv2
22408 @opindex mabi=elfv2
22409 Change the current ABI to use the ELFv2 ABI.
22410 This is the default ABI for little-endian PowerPC 64-bit Linux.
22411 Overriding the default ABI requires special system support and is
22412 likely to fail in spectacular ways.
22414 @item -mgnu-attribute
22415 @itemx -mno-gnu-attribute
22416 @opindex mgnu-attribute
22417 @opindex mno-gnu-attribute
22418 Emit .gnu_attribute assembly directives to set tag/value pairs in a
22419 .gnu.attributes section that specify ABI variations in function
22420 parameters or return values.
22422 @item -mprototype
22423 @itemx -mno-prototype
22424 @opindex mprototype
22425 @opindex mno-prototype
22426 On System V.4 and embedded PowerPC systems assume that all calls to
22427 variable argument functions are properly prototyped.  Otherwise, the
22428 compiler must insert an instruction before every non-prototyped call to
22429 set or clear bit 6 of the condition code register (@code{CR}) to
22430 indicate whether floating-point values are passed in the floating-point
22431 registers in case the function takes variable arguments.  With
22432 @option{-mprototype}, only calls to prototyped variable argument functions
22433 set or clear the bit.
22435 @item -msim
22436 @opindex msim
22437 On embedded PowerPC systems, assume that the startup module is called
22438 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
22439 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
22440 configurations.
22442 @item -mmvme
22443 @opindex mmvme
22444 On embedded PowerPC systems, assume that the startup module is called
22445 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
22446 @file{libc.a}.
22448 @item -mads
22449 @opindex mads
22450 On embedded PowerPC systems, assume that the startup module is called
22451 @file{crt0.o} and the standard C libraries are @file{libads.a} and
22452 @file{libc.a}.
22454 @item -myellowknife
22455 @opindex myellowknife
22456 On embedded PowerPC systems, assume that the startup module is called
22457 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
22458 @file{libc.a}.
22460 @item -mvxworks
22461 @opindex mvxworks
22462 On System V.4 and embedded PowerPC systems, specify that you are
22463 compiling for a VxWorks system.
22465 @item -memb
22466 @opindex memb
22467 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
22468 header to indicate that @samp{eabi} extended relocations are used.
22470 @item -meabi
22471 @itemx -mno-eabi
22472 @opindex meabi
22473 @opindex mno-eabi
22474 On System V.4 and embedded PowerPC systems do (do not) adhere to the
22475 Embedded Applications Binary Interface (EABI), which is a set of
22476 modifications to the System V.4 specifications.  Selecting @option{-meabi}
22477 means that the stack is aligned to an 8-byte boundary, a function
22478 @code{__eabi} is called from @code{main} to set up the EABI
22479 environment, and the @option{-msdata} option can use both @code{r2} and
22480 @code{r13} to point to two separate small data areas.  Selecting
22481 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
22482 no EABI initialization function is called from @code{main}, and the
22483 @option{-msdata} option only uses @code{r13} to point to a single
22484 small data area.  The @option{-meabi} option is on by default if you
22485 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
22487 @item -msdata=eabi
22488 @opindex msdata=eabi
22489 On System V.4 and embedded PowerPC systems, put small initialized
22490 @code{const} global and static data in the @code{.sdata2} section, which
22491 is pointed to by register @code{r2}.  Put small initialized
22492 non-@code{const} global and static data in the @code{.sdata} section,
22493 which is pointed to by register @code{r13}.  Put small uninitialized
22494 global and static data in the @code{.sbss} section, which is adjacent to
22495 the @code{.sdata} section.  The @option{-msdata=eabi} option is
22496 incompatible with the @option{-mrelocatable} option.  The
22497 @option{-msdata=eabi} option also sets the @option{-memb} option.
22499 @item -msdata=sysv
22500 @opindex msdata=sysv
22501 On System V.4 and embedded PowerPC systems, put small global and static
22502 data in the @code{.sdata} section, which is pointed to by register
22503 @code{r13}.  Put small uninitialized global and static data in the
22504 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
22505 The @option{-msdata=sysv} option is incompatible with the
22506 @option{-mrelocatable} option.
22508 @item -msdata=default
22509 @itemx -msdata
22510 @opindex msdata=default
22511 @opindex msdata
22512 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
22513 compile code the same as @option{-msdata=eabi}, otherwise compile code the
22514 same as @option{-msdata=sysv}.
22516 @item -msdata=data
22517 @opindex msdata=data
22518 On System V.4 and embedded PowerPC systems, put small global
22519 data in the @code{.sdata} section.  Put small uninitialized global
22520 data in the @code{.sbss} section.  Do not use register @code{r13}
22521 to address small data however.  This is the default behavior unless
22522 other @option{-msdata} options are used.
22524 @item -msdata=none
22525 @itemx -mno-sdata
22526 @opindex msdata=none
22527 @opindex mno-sdata
22528 On embedded PowerPC systems, put all initialized global and static data
22529 in the @code{.data} section, and all uninitialized data in the
22530 @code{.bss} section.
22532 @item -mblock-move-inline-limit=@var{num}
22533 @opindex mblock-move-inline-limit
22534 Inline all block moves (such as calls to @code{memcpy} or structure
22535 copies) less than or equal to @var{num} bytes.  The minimum value for
22536 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
22537 targets.  The default value is target-specific.
22539 @item -G @var{num}
22540 @opindex G
22541 @cindex smaller data references (PowerPC)
22542 @cindex .sdata/.sdata2 references (PowerPC)
22543 On embedded PowerPC systems, put global and static items less than or
22544 equal to @var{num} bytes into the small data or BSS sections instead of
22545 the normal data or BSS section.  By default, @var{num} is 8.  The
22546 @option{-G @var{num}} switch is also passed to the linker.
22547 All modules should be compiled with the same @option{-G @var{num}} value.
22549 @item -mregnames
22550 @itemx -mno-regnames
22551 @opindex mregnames
22552 @opindex mno-regnames
22553 On System V.4 and embedded PowerPC systems do (do not) emit register
22554 names in the assembly language output using symbolic forms.
22556 @item -mlongcall
22557 @itemx -mno-longcall
22558 @opindex mlongcall
22559 @opindex mno-longcall
22560 By default assume that all calls are far away so that a longer and more
22561 expensive calling sequence is required.  This is required for calls
22562 farther than 32 megabytes (33,554,432 bytes) from the current location.
22563 A short call is generated if the compiler knows
22564 the call cannot be that far away.  This setting can be overridden by
22565 the @code{shortcall} function attribute, or by @code{#pragma
22566 longcall(0)}.
22568 Some linkers are capable of detecting out-of-range calls and generating
22569 glue code on the fly.  On these systems, long calls are unnecessary and
22570 generate slower code.  As of this writing, the AIX linker can do this,
22571 as can the GNU linker for PowerPC/64.  It is planned to add this feature
22572 to the GNU linker for 32-bit PowerPC systems as well.
22574 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
22575 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
22576 addresses represent the callee and the branch island.  The
22577 Darwin/PPC linker prefers the first address and generates a @code{bl
22578 callee} if the PPC @code{bl} instruction reaches the callee directly;
22579 otherwise, the linker generates @code{bl L42} to call the branch
22580 island.  The branch island is appended to the body of the
22581 calling function; it computes the full 32-bit address of the callee
22582 and jumps to it.
22584 On Mach-O (Darwin) systems, this option directs the compiler emit to
22585 the glue for every direct call, and the Darwin linker decides whether
22586 to use or discard it.
22588 In the future, GCC may ignore all longcall specifications
22589 when the linker is known to generate glue.
22591 @item -mtls-markers
22592 @itemx -mno-tls-markers
22593 @opindex mtls-markers
22594 @opindex mno-tls-markers
22595 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
22596 specifying the function argument.  The relocation allows the linker to
22597 reliably associate function call with argument setup instructions for
22598 TLS optimization, which in turn allows GCC to better schedule the
22599 sequence.
22601 @item -mrecip
22602 @itemx -mno-recip
22603 @opindex mrecip
22604 This option enables use of the reciprocal estimate and
22605 reciprocal square root estimate instructions with additional
22606 Newton-Raphson steps to increase precision instead of doing a divide or
22607 square root and divide for floating-point arguments.  You should use
22608 the @option{-ffast-math} option when using @option{-mrecip} (or at
22609 least @option{-funsafe-math-optimizations},
22610 @option{-ffinite-math-only}, @option{-freciprocal-math} and
22611 @option{-fno-trapping-math}).  Note that while the throughput of the
22612 sequence is generally higher than the throughput of the non-reciprocal
22613 instruction, the precision of the sequence can be decreased by up to 2
22614 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
22615 roots.
22617 @item -mrecip=@var{opt}
22618 @opindex mrecip=opt
22619 This option controls which reciprocal estimate instructions
22620 may be used.  @var{opt} is a comma-separated list of options, which may
22621 be preceded by a @code{!} to invert the option:
22623 @table @samp
22625 @item all
22626 Enable all estimate instructions.
22628 @item default 
22629 Enable the default instructions, equivalent to @option{-mrecip}.
22631 @item none 
22632 Disable all estimate instructions, equivalent to @option{-mno-recip}.
22634 @item div 
22635 Enable the reciprocal approximation instructions for both 
22636 single and double precision.
22638 @item divf 
22639 Enable the single-precision reciprocal approximation instructions.
22641 @item divd 
22642 Enable the double-precision reciprocal approximation instructions.
22644 @item rsqrt 
22645 Enable the reciprocal square root approximation instructions for both
22646 single and double precision.
22648 @item rsqrtf 
22649 Enable the single-precision reciprocal square root approximation instructions.
22651 @item rsqrtd 
22652 Enable the double-precision reciprocal square root approximation instructions.
22654 @end table
22656 So, for example, @option{-mrecip=all,!rsqrtd} enables
22657 all of the reciprocal estimate instructions, except for the
22658 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
22659 which handle the double-precision reciprocal square root calculations.
22661 @item -mrecip-precision
22662 @itemx -mno-recip-precision
22663 @opindex mrecip-precision
22664 Assume (do not assume) that the reciprocal estimate instructions
22665 provide higher-precision estimates than is mandated by the PowerPC
22666 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
22667 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
22668 The double-precision square root estimate instructions are not generated by
22669 default on low-precision machines, since they do not provide an
22670 estimate that converges after three steps.
22672 @item -mveclibabi=@var{type}
22673 @opindex mveclibabi
22674 Specifies the ABI type to use for vectorizing intrinsics using an
22675 external library.  The only type supported at present is @samp{mass},
22676 which specifies to use IBM's Mathematical Acceleration Subsystem
22677 (MASS) libraries for vectorizing intrinsics using external libraries.
22678 GCC currently emits calls to @code{acosd2}, @code{acosf4},
22679 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
22680 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
22681 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
22682 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
22683 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
22684 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
22685 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
22686 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
22687 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
22688 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
22689 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
22690 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
22691 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
22692 for power7.  Both @option{-ftree-vectorize} and
22693 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
22694 libraries must be specified at link time.
22696 @item -mfriz
22697 @itemx -mno-friz
22698 @opindex mfriz
22699 Generate (do not generate) the @code{friz} instruction when the
22700 @option{-funsafe-math-optimizations} option is used to optimize
22701 rounding of floating-point values to 64-bit integer and back to floating
22702 point.  The @code{friz} instruction does not return the same value if
22703 the floating-point number is too large to fit in an integer.
22705 @item -mpointers-to-nested-functions
22706 @itemx -mno-pointers-to-nested-functions
22707 @opindex mpointers-to-nested-functions
22708 Generate (do not generate) code to load up the static chain register
22709 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
22710 systems where a function pointer points to a 3-word descriptor giving
22711 the function address, TOC value to be loaded in register @code{r2}, and
22712 static chain value to be loaded in register @code{r11}.  The
22713 @option{-mpointers-to-nested-functions} is on by default.  You cannot
22714 call through pointers to nested functions or pointers
22715 to functions compiled in other languages that use the static chain if
22716 you use @option{-mno-pointers-to-nested-functions}.
22718 @item -msave-toc-indirect
22719 @itemx -mno-save-toc-indirect
22720 @opindex msave-toc-indirect
22721 Generate (do not generate) code to save the TOC value in the reserved
22722 stack location in the function prologue if the function calls through
22723 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
22724 saved in the prologue, it is saved just before the call through the
22725 pointer.  The @option{-mno-save-toc-indirect} option is the default.
22727 @item -mcompat-align-parm
22728 @itemx -mno-compat-align-parm
22729 @opindex mcompat-align-parm
22730 Generate (do not generate) code to pass structure parameters with a
22731 maximum alignment of 64 bits, for compatibility with older versions
22732 of GCC.
22734 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
22735 structure parameter on a 128-bit boundary when that structure contained
22736 a member requiring 128-bit alignment.  This is corrected in more
22737 recent versions of GCC.  This option may be used to generate code
22738 that is compatible with functions compiled with older versions of
22739 GCC.
22741 The @option{-mno-compat-align-parm} option is the default.
22743 @item -mstack-protector-guard=@var{guard}
22744 @itemx -mstack-protector-guard-reg=@var{reg}
22745 @itemx -mstack-protector-guard-offset=@var{offset}
22746 @opindex mstack-protector-guard
22747 @opindex mstack-protector-guard-reg
22748 @opindex mstack-protector-guard-offset
22749 Generate stack protection code using canary at @var{guard}.  Supported
22750 locations are @samp{global} for global canary or @samp{tls} for per-thread
22751 canary in the TLS block (the default with GNU libc version 2.4 or later).
22753 With the latter choice the options
22754 @option{-mstack-protector-guard-reg=@var{reg}} and
22755 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
22756 which register to use as base register for reading the canary, and from what
22757 offset from that base register. The default for those is as specified in the
22758 relevant ABI.
22759 @end table
22761 @node RX Options
22762 @subsection RX Options
22763 @cindex RX Options
22765 These command-line options are defined for RX targets:
22767 @table @gcctabopt
22768 @item -m64bit-doubles
22769 @itemx -m32bit-doubles
22770 @opindex m64bit-doubles
22771 @opindex m32bit-doubles
22772 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
22773 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
22774 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
22775 works on 32-bit values, which is why the default is
22776 @option{-m32bit-doubles}.
22778 @item -fpu
22779 @itemx -nofpu
22780 @opindex fpu
22781 @opindex nofpu
22782 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
22783 floating-point hardware.  The default is enabled for the RX600
22784 series and disabled for the RX200 series.
22786 Floating-point instructions are only generated for 32-bit floating-point 
22787 values, however, so the FPU hardware is not used for doubles if the
22788 @option{-m64bit-doubles} option is used.
22790 @emph{Note} If the @option{-fpu} option is enabled then
22791 @option{-funsafe-math-optimizations} is also enabled automatically.
22792 This is because the RX FPU instructions are themselves unsafe.
22794 @item -mcpu=@var{name}
22795 @opindex mcpu
22796 Selects the type of RX CPU to be targeted.  Currently three types are
22797 supported, the generic @samp{RX600} and @samp{RX200} series hardware and
22798 the specific @samp{RX610} CPU.  The default is @samp{RX600}.
22800 The only difference between @samp{RX600} and @samp{RX610} is that the
22801 @samp{RX610} does not support the @code{MVTIPL} instruction.
22803 The @samp{RX200} series does not have a hardware floating-point unit
22804 and so @option{-nofpu} is enabled by default when this type is
22805 selected.
22807 @item -mbig-endian-data
22808 @itemx -mlittle-endian-data
22809 @opindex mbig-endian-data
22810 @opindex mlittle-endian-data
22811 Store data (but not code) in the big-endian format.  The default is
22812 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
22813 format.
22815 @item -msmall-data-limit=@var{N}
22816 @opindex msmall-data-limit
22817 Specifies the maximum size in bytes of global and static variables
22818 which can be placed into the small data area.  Using the small data
22819 area can lead to smaller and faster code, but the size of area is
22820 limited and it is up to the programmer to ensure that the area does
22821 not overflow.  Also when the small data area is used one of the RX's
22822 registers (usually @code{r13}) is reserved for use pointing to this
22823 area, so it is no longer available for use by the compiler.  This
22824 could result in slower and/or larger code if variables are pushed onto
22825 the stack instead of being held in this register.
22827 Note, common variables (variables that have not been initialized) and
22828 constants are not placed into the small data area as they are assigned
22829 to other sections in the output executable.
22831 The default value is zero, which disables this feature.  Note, this
22832 feature is not enabled by default with higher optimization levels
22833 (@option{-O2} etc) because of the potentially detrimental effects of
22834 reserving a register.  It is up to the programmer to experiment and
22835 discover whether this feature is of benefit to their program.  See the
22836 description of the @option{-mpid} option for a description of how the
22837 actual register to hold the small data area pointer is chosen.
22839 @item -msim
22840 @itemx -mno-sim
22841 @opindex msim
22842 @opindex mno-sim
22843 Use the simulator runtime.  The default is to use the libgloss
22844 board-specific runtime.
22846 @item -mas100-syntax
22847 @itemx -mno-as100-syntax
22848 @opindex mas100-syntax
22849 @opindex mno-as100-syntax
22850 When generating assembler output use a syntax that is compatible with
22851 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
22852 assembler, but it has some restrictions so it is not generated by default.
22854 @item -mmax-constant-size=@var{N}
22855 @opindex mmax-constant-size
22856 Specifies the maximum size, in bytes, of a constant that can be used as
22857 an operand in a RX instruction.  Although the RX instruction set does
22858 allow constants of up to 4 bytes in length to be used in instructions,
22859 a longer value equates to a longer instruction.  Thus in some
22860 circumstances it can be beneficial to restrict the size of constants
22861 that are used in instructions.  Constants that are too big are instead
22862 placed into a constant pool and referenced via register indirection.
22864 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
22865 or 4 means that constants of any size are allowed.
22867 @item -mrelax
22868 @opindex mrelax
22869 Enable linker relaxation.  Linker relaxation is a process whereby the
22870 linker attempts to reduce the size of a program by finding shorter
22871 versions of various instructions.  Disabled by default.
22873 @item -mint-register=@var{N}
22874 @opindex mint-register
22875 Specify the number of registers to reserve for fast interrupt handler
22876 functions.  The value @var{N} can be between 0 and 4.  A value of 1
22877 means that register @code{r13} is reserved for the exclusive use
22878 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
22879 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
22880 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
22881 A value of 0, the default, does not reserve any registers.
22883 @item -msave-acc-in-interrupts
22884 @opindex msave-acc-in-interrupts
22885 Specifies that interrupt handler functions should preserve the
22886 accumulator register.  This is only necessary if normal code might use
22887 the accumulator register, for example because it performs 64-bit
22888 multiplications.  The default is to ignore the accumulator as this
22889 makes the interrupt handlers faster.
22891 @item -mpid
22892 @itemx -mno-pid
22893 @opindex mpid
22894 @opindex mno-pid
22895 Enables the generation of position independent data.  When enabled any
22896 access to constant data is done via an offset from a base address
22897 held in a register.  This allows the location of constant data to be
22898 determined at run time without requiring the executable to be
22899 relocated, which is a benefit to embedded applications with tight
22900 memory constraints.  Data that can be modified is not affected by this
22901 option.
22903 Note, using this feature reserves a register, usually @code{r13}, for
22904 the constant data base address.  This can result in slower and/or
22905 larger code, especially in complicated functions.
22907 The actual register chosen to hold the constant data base address
22908 depends upon whether the @option{-msmall-data-limit} and/or the
22909 @option{-mint-register} command-line options are enabled.  Starting
22910 with register @code{r13} and proceeding downwards, registers are
22911 allocated first to satisfy the requirements of @option{-mint-register},
22912 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
22913 is possible for the small data area register to be @code{r8} if both
22914 @option{-mint-register=4} and @option{-mpid} are specified on the
22915 command line.
22917 By default this feature is not enabled.  The default can be restored
22918 via the @option{-mno-pid} command-line option.
22920 @item -mno-warn-multiple-fast-interrupts
22921 @itemx -mwarn-multiple-fast-interrupts
22922 @opindex mno-warn-multiple-fast-interrupts
22923 @opindex mwarn-multiple-fast-interrupts
22924 Prevents GCC from issuing a warning message if it finds more than one
22925 fast interrupt handler when it is compiling a file.  The default is to
22926 issue a warning for each extra fast interrupt handler found, as the RX
22927 only supports one such interrupt.
22929 @item -mallow-string-insns
22930 @itemx -mno-allow-string-insns
22931 @opindex mallow-string-insns
22932 @opindex mno-allow-string-insns
22933 Enables or disables the use of the string manipulation instructions
22934 @code{SMOVF}, @code{SCMPU}, @code{SMOVB}, @code{SMOVU}, @code{SUNTIL}
22935 @code{SWHILE} and also the @code{RMPA} instruction.  These
22936 instructions may prefetch data, which is not safe to do if accessing
22937 an I/O register.  (See section 12.2.7 of the RX62N Group User's Manual
22938 for more information).
22940 The default is to allow these instructions, but it is not possible for
22941 GCC to reliably detect all circumstances where a string instruction
22942 might be used to access an I/O register, so their use cannot be
22943 disabled automatically.  Instead it is reliant upon the programmer to
22944 use the @option{-mno-allow-string-insns} option if their program
22945 accesses I/O space.
22947 When the instructions are enabled GCC defines the C preprocessor
22948 symbol @code{__RX_ALLOW_STRING_INSNS__}, otherwise it defines the
22949 symbol @code{__RX_DISALLOW_STRING_INSNS__}.
22951 @item -mjsr
22952 @itemx -mno-jsr
22953 @opindex mjsr
22954 @opindex mno-jsr
22955 Use only (or not only) @code{JSR} instructions to access functions.
22956 This option can be used when code size exceeds the range of @code{BSR}
22957 instructions.  Note that @option{-mno-jsr} does not mean to not use
22958 @code{JSR} but instead means that any type of branch may be used.
22959 @end table
22961 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
22962 has special significance to the RX port when used with the
22963 @code{interrupt} function attribute.  This attribute indicates a
22964 function intended to process fast interrupts.  GCC ensures
22965 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
22966 and/or @code{r13} and only provided that the normal use of the
22967 corresponding registers have been restricted via the
22968 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
22969 options.
22971 @node S/390 and zSeries Options
22972 @subsection S/390 and zSeries Options
22973 @cindex S/390 and zSeries Options
22975 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
22977 @table @gcctabopt
22978 @item -mhard-float
22979 @itemx -msoft-float
22980 @opindex mhard-float
22981 @opindex msoft-float
22982 Use (do not use) the hardware floating-point instructions and registers
22983 for floating-point operations.  When @option{-msoft-float} is specified,
22984 functions in @file{libgcc.a} are used to perform floating-point
22985 operations.  When @option{-mhard-float} is specified, the compiler
22986 generates IEEE floating-point instructions.  This is the default.
22988 @item -mhard-dfp
22989 @itemx -mno-hard-dfp
22990 @opindex mhard-dfp
22991 @opindex mno-hard-dfp
22992 Use (do not use) the hardware decimal-floating-point instructions for
22993 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
22994 specified, functions in @file{libgcc.a} are used to perform
22995 decimal-floating-point operations.  When @option{-mhard-dfp} is
22996 specified, the compiler generates decimal-floating-point hardware
22997 instructions.  This is the default for @option{-march=z9-ec} or higher.
22999 @item -mlong-double-64
23000 @itemx -mlong-double-128
23001 @opindex mlong-double-64
23002 @opindex mlong-double-128
23003 These switches control the size of @code{long double} type. A size
23004 of 64 bits makes the @code{long double} type equivalent to the @code{double}
23005 type. This is the default.
23007 @item -mbackchain
23008 @itemx -mno-backchain
23009 @opindex mbackchain
23010 @opindex mno-backchain
23011 Store (do not store) the address of the caller's frame as backchain pointer
23012 into the callee's stack frame.
23013 A backchain may be needed to allow debugging using tools that do not understand
23014 DWARF call frame information.
23015 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
23016 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
23017 the backchain is placed into the topmost word of the 96/160 byte register
23018 save area.
23020 In general, code compiled with @option{-mbackchain} is call-compatible with
23021 code compiled with @option{-mmo-backchain}; however, use of the backchain
23022 for debugging purposes usually requires that the whole binary is built with
23023 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
23024 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
23025 to build a linux kernel use @option{-msoft-float}.
23027 The default is to not maintain the backchain.
23029 @item -mpacked-stack
23030 @itemx -mno-packed-stack
23031 @opindex mpacked-stack
23032 @opindex mno-packed-stack
23033 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
23034 specified, the compiler uses the all fields of the 96/160 byte register save
23035 area only for their default purpose; unused fields still take up stack space.
23036 When @option{-mpacked-stack} is specified, register save slots are densely
23037 packed at the top of the register save area; unused space is reused for other
23038 purposes, allowing for more efficient use of the available stack space.
23039 However, when @option{-mbackchain} is also in effect, the topmost word of
23040 the save area is always used to store the backchain, and the return address
23041 register is always saved two words below the backchain.
23043 As long as the stack frame backchain is not used, code generated with
23044 @option{-mpacked-stack} is call-compatible with code generated with
23045 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
23046 S/390 or zSeries generated code that uses the stack frame backchain at run
23047 time, not just for debugging purposes.  Such code is not call-compatible
23048 with code compiled with @option{-mpacked-stack}.  Also, note that the
23049 combination of @option{-mbackchain},
23050 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
23051 to build a linux kernel use @option{-msoft-float}.
23053 The default is to not use the packed stack layout.
23055 @item -msmall-exec
23056 @itemx -mno-small-exec
23057 @opindex msmall-exec
23058 @opindex mno-small-exec
23059 Generate (or do not generate) code using the @code{bras} instruction
23060 to do subroutine calls.
23061 This only works reliably if the total executable size does not
23062 exceed 64k.  The default is to use the @code{basr} instruction instead,
23063 which does not have this limitation.
23065 @item -m64
23066 @itemx -m31
23067 @opindex m64
23068 @opindex m31
23069 When @option{-m31} is specified, generate code compliant to the
23070 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
23071 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
23072 particular to generate 64-bit instructions.  For the @samp{s390}
23073 targets, the default is @option{-m31}, while the @samp{s390x}
23074 targets default to @option{-m64}.
23076 @item -mzarch
23077 @itemx -mesa
23078 @opindex mzarch
23079 @opindex mesa
23080 When @option{-mzarch} is specified, generate code using the
23081 instructions available on z/Architecture.
23082 When @option{-mesa} is specified, generate code using the
23083 instructions available on ESA/390.  Note that @option{-mesa} is
23084 not possible with @option{-m64}.
23085 When generating code compliant to the GNU/Linux for S/390 ABI,
23086 the default is @option{-mesa}.  When generating code compliant
23087 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
23089 @item -mhtm
23090 @itemx -mno-htm
23091 @opindex mhtm
23092 @opindex mno-htm
23093 The @option{-mhtm} option enables a set of builtins making use of
23094 instructions available with the transactional execution facility
23095 introduced with the IBM zEnterprise EC12 machine generation
23096 @ref{S/390 System z Built-in Functions}.
23097 @option{-mhtm} is enabled by default when using @option{-march=zEC12}.
23099 @item -mvx
23100 @itemx -mno-vx
23101 @opindex mvx
23102 @opindex mno-vx
23103 When @option{-mvx} is specified, generate code using the instructions
23104 available with the vector extension facility introduced with the IBM
23105 z13 machine generation.
23106 This option changes the ABI for some vector type values with regard to
23107 alignment and calling conventions.  In case vector type values are
23108 being used in an ABI-relevant context a GAS @samp{.gnu_attribute}
23109 command will be added to mark the resulting binary with the ABI used.
23110 @option{-mvx} is enabled by default when using @option{-march=z13}.
23112 @item -mzvector
23113 @itemx -mno-zvector
23114 @opindex mzvector
23115 @opindex mno-zvector
23116 The @option{-mzvector} option enables vector language extensions and
23117 builtins using instructions available with the vector extension
23118 facility introduced with the IBM z13 machine generation.
23119 This option adds support for @samp{vector} to be used as a keyword to
23120 define vector type variables and arguments.  @samp{vector} is only
23121 available when GNU extensions are enabled.  It will not be expanded
23122 when requesting strict standard compliance e.g. with @option{-std=c99}.
23123 In addition to the GCC low-level builtins @option{-mzvector} enables
23124 a set of builtins added for compatibility with AltiVec-style
23125 implementations like Power and Cell.  In order to make use of these
23126 builtins the header file @file{vecintrin.h} needs to be included.
23127 @option{-mzvector} is disabled by default.
23129 @item -mmvcle
23130 @itemx -mno-mvcle
23131 @opindex mmvcle
23132 @opindex mno-mvcle
23133 Generate (or do not generate) code using the @code{mvcle} instruction
23134 to perform block moves.  When @option{-mno-mvcle} is specified,
23135 use a @code{mvc} loop instead.  This is the default unless optimizing for
23136 size.
23138 @item -mdebug
23139 @itemx -mno-debug
23140 @opindex mdebug
23141 @opindex mno-debug
23142 Print (or do not print) additional debug information when compiling.
23143 The default is to not print debug information.
23145 @item -march=@var{cpu-type}
23146 @opindex march
23147 Generate code that runs on @var{cpu-type}, which is the name of a
23148 system representing a certain processor type.  Possible values for
23149 @var{cpu-type} are @samp{z900}/@samp{arch5}, @samp{z990}/@samp{arch6},
23150 @samp{z9-109}, @samp{z9-ec}/@samp{arch7}, @samp{z10}/@samp{arch8},
23151 @samp{z196}/@samp{arch9}, @samp{zEC12}, @samp{z13}/@samp{arch11}, and
23152 @samp{native}.
23154 The default is @option{-march=z900}.  @samp{g5}/@samp{arch3} and
23155 @samp{g6} are deprecated and will be removed with future releases.
23157 Specifying @samp{native} as cpu type can be used to select the best
23158 architecture option for the host processor.
23159 @option{-march=native} has no effect if GCC does not recognize the
23160 processor.
23162 @item -mtune=@var{cpu-type}
23163 @opindex mtune
23164 Tune to @var{cpu-type} everything applicable about the generated code,
23165 except for the ABI and the set of available instructions.
23166 The list of @var{cpu-type} values is the same as for @option{-march}.
23167 The default is the value used for @option{-march}.
23169 @item -mtpf-trace
23170 @itemx -mno-tpf-trace
23171 @opindex mtpf-trace
23172 @opindex mno-tpf-trace
23173 Generate code that adds (does not add) in TPF OS specific branches to trace
23174 routines in the operating system.  This option is off by default, even
23175 when compiling for the TPF OS@.
23177 @item -mfused-madd
23178 @itemx -mno-fused-madd
23179 @opindex mfused-madd
23180 @opindex mno-fused-madd
23181 Generate code that uses (does not use) the floating-point multiply and
23182 accumulate instructions.  These instructions are generated by default if
23183 hardware floating point is used.
23185 @item -mwarn-framesize=@var{framesize}
23186 @opindex mwarn-framesize
23187 Emit a warning if the current function exceeds the given frame size.  Because
23188 this is a compile-time check it doesn't need to be a real problem when the program
23189 runs.  It is intended to identify functions that most probably cause
23190 a stack overflow.  It is useful to be used in an environment with limited stack
23191 size e.g.@: the linux kernel.
23193 @item -mwarn-dynamicstack
23194 @opindex mwarn-dynamicstack
23195 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
23196 arrays.  This is generally a bad idea with a limited stack size.
23198 @item -mstack-guard=@var{stack-guard}
23199 @itemx -mstack-size=@var{stack-size}
23200 @opindex mstack-guard
23201 @opindex mstack-size
23202 If these options are provided the S/390 back end emits additional instructions in
23203 the function prologue that trigger a trap if the stack size is @var{stack-guard}
23204 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
23205 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
23206 the frame size of the compiled function is chosen.
23207 These options are intended to be used to help debugging stack overflow problems.
23208 The additionally emitted code causes only little overhead and hence can also be
23209 used in production-like systems without greater performance degradation.  The given
23210 values have to be exact powers of 2 and @var{stack-size} has to be greater than
23211 @var{stack-guard} without exceeding 64k.
23212 In order to be efficient the extra code makes the assumption that the stack starts
23213 at an address aligned to the value given by @var{stack-size}.
23214 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
23216 @item -mhotpatch=@var{pre-halfwords},@var{post-halfwords}
23217 @opindex mhotpatch
23218 If the hotpatch option is enabled, a ``hot-patching'' function
23219 prologue is generated for all functions in the compilation unit.
23220 The funtion label is prepended with the given number of two-byte
23221 NOP instructions (@var{pre-halfwords}, maximum 1000000).  After
23222 the label, 2 * @var{post-halfwords} bytes are appended, using the
23223 largest NOP like instructions the architecture allows (maximum
23224 1000000).
23226 If both arguments are zero, hotpatching is disabled.
23228 This option can be overridden for individual functions with the
23229 @code{hotpatch} attribute.
23230 @end table
23232 @node Score Options
23233 @subsection Score Options
23234 @cindex Score Options
23236 These options are defined for Score implementations:
23238 @table @gcctabopt
23239 @item -meb
23240 @opindex meb
23241 Compile code for big-endian mode.  This is the default.
23243 @item -mel
23244 @opindex mel
23245 Compile code for little-endian mode.
23247 @item -mnhwloop
23248 @opindex mnhwloop
23249 Disable generation of @code{bcnz} instructions.
23251 @item -muls
23252 @opindex muls
23253 Enable generation of unaligned load and store instructions.
23255 @item -mmac
23256 @opindex mmac
23257 Enable the use of multiply-accumulate instructions. Disabled by default.
23259 @item -mscore5
23260 @opindex mscore5
23261 Specify the SCORE5 as the target architecture.
23263 @item -mscore5u
23264 @opindex mscore5u
23265 Specify the SCORE5U of the target architecture.
23267 @item -mscore7
23268 @opindex mscore7
23269 Specify the SCORE7 as the target architecture. This is the default.
23271 @item -mscore7d
23272 @opindex mscore7d
23273 Specify the SCORE7D as the target architecture.
23274 @end table
23276 @node SH Options
23277 @subsection SH Options
23279 These @samp{-m} options are defined for the SH implementations:
23281 @table @gcctabopt
23282 @item -m1
23283 @opindex m1
23284 Generate code for the SH1.
23286 @item -m2
23287 @opindex m2
23288 Generate code for the SH2.
23290 @item -m2e
23291 Generate code for the SH2e.
23293 @item -m2a-nofpu
23294 @opindex m2a-nofpu
23295 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
23296 that the floating-point unit is not used.
23298 @item -m2a-single-only
23299 @opindex m2a-single-only
23300 Generate code for the SH2a-FPU, in such a way that no double-precision
23301 floating-point operations are used.
23303 @item -m2a-single
23304 @opindex m2a-single
23305 Generate code for the SH2a-FPU assuming the floating-point unit is in
23306 single-precision mode by default.
23308 @item -m2a
23309 @opindex m2a
23310 Generate code for the SH2a-FPU assuming the floating-point unit is in
23311 double-precision mode by default.
23313 @item -m3
23314 @opindex m3
23315 Generate code for the SH3.
23317 @item -m3e
23318 @opindex m3e
23319 Generate code for the SH3e.
23321 @item -m4-nofpu
23322 @opindex m4-nofpu
23323 Generate code for the SH4 without a floating-point unit.
23325 @item -m4-single-only
23326 @opindex m4-single-only
23327 Generate code for the SH4 with a floating-point unit that only
23328 supports single-precision arithmetic.
23330 @item -m4-single
23331 @opindex m4-single
23332 Generate code for the SH4 assuming the floating-point unit is in
23333 single-precision mode by default.
23335 @item -m4
23336 @opindex m4
23337 Generate code for the SH4.
23339 @item -m4-100
23340 @opindex m4-100
23341 Generate code for SH4-100.
23343 @item -m4-100-nofpu
23344 @opindex m4-100-nofpu
23345 Generate code for SH4-100 in such a way that the
23346 floating-point unit is not used.
23348 @item -m4-100-single
23349 @opindex m4-100-single
23350 Generate code for SH4-100 assuming the floating-point unit is in
23351 single-precision mode by default.
23353 @item -m4-100-single-only
23354 @opindex m4-100-single-only
23355 Generate code for SH4-100 in such a way that no double-precision
23356 floating-point operations are used.
23358 @item -m4-200
23359 @opindex m4-200
23360 Generate code for SH4-200.
23362 @item -m4-200-nofpu
23363 @opindex m4-200-nofpu
23364 Generate code for SH4-200 without in such a way that the
23365 floating-point unit is not used.
23367 @item -m4-200-single
23368 @opindex m4-200-single
23369 Generate code for SH4-200 assuming the floating-point unit is in
23370 single-precision mode by default.
23372 @item -m4-200-single-only
23373 @opindex m4-200-single-only
23374 Generate code for SH4-200 in such a way that no double-precision
23375 floating-point operations are used.
23377 @item -m4-300
23378 @opindex m4-300
23379 Generate code for SH4-300.
23381 @item -m4-300-nofpu
23382 @opindex m4-300-nofpu
23383 Generate code for SH4-300 without in such a way that the
23384 floating-point unit is not used.
23386 @item -m4-300-single
23387 @opindex m4-300-single
23388 Generate code for SH4-300 in such a way that no double-precision
23389 floating-point operations are used.
23391 @item -m4-300-single-only
23392 @opindex m4-300-single-only
23393 Generate code for SH4-300 in such a way that no double-precision
23394 floating-point operations are used.
23396 @item -m4-340
23397 @opindex m4-340
23398 Generate code for SH4-340 (no MMU, no FPU).
23400 @item -m4-500
23401 @opindex m4-500
23402 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
23403 assembler.
23405 @item -m4a-nofpu
23406 @opindex m4a-nofpu
23407 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
23408 floating-point unit is not used.
23410 @item -m4a-single-only
23411 @opindex m4a-single-only
23412 Generate code for the SH4a, in such a way that no double-precision
23413 floating-point operations are used.
23415 @item -m4a-single
23416 @opindex m4a-single
23417 Generate code for the SH4a assuming the floating-point unit is in
23418 single-precision mode by default.
23420 @item -m4a
23421 @opindex m4a
23422 Generate code for the SH4a.
23424 @item -m4al
23425 @opindex m4al
23426 Same as @option{-m4a-nofpu}, except that it implicitly passes
23427 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
23428 instructions at the moment.
23430 @item -mb
23431 @opindex mb
23432 Compile code for the processor in big-endian mode.
23434 @item -ml
23435 @opindex ml
23436 Compile code for the processor in little-endian mode.
23438 @item -mdalign
23439 @opindex mdalign
23440 Align doubles at 64-bit boundaries.  Note that this changes the calling
23441 conventions, and thus some functions from the standard C library do
23442 not work unless you recompile it first with @option{-mdalign}.
23444 @item -mrelax
23445 @opindex mrelax
23446 Shorten some address references at link time, when possible; uses the
23447 linker option @option{-relax}.
23449 @item -mbigtable
23450 @opindex mbigtable
23451 Use 32-bit offsets in @code{switch} tables.  The default is to use
23452 16-bit offsets.
23454 @item -mbitops
23455 @opindex mbitops
23456 Enable the use of bit manipulation instructions on SH2A.
23458 @item -mfmovd
23459 @opindex mfmovd
23460 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
23461 alignment constraints.
23463 @item -mrenesas
23464 @opindex mrenesas
23465 Comply with the calling conventions defined by Renesas.
23467 @item -mno-renesas
23468 @opindex mno-renesas
23469 Comply with the calling conventions defined for GCC before the Renesas
23470 conventions were available.  This option is the default for all
23471 targets of the SH toolchain.
23473 @item -mnomacsave
23474 @opindex mnomacsave
23475 Mark the @code{MAC} register as call-clobbered, even if
23476 @option{-mrenesas} is given.
23478 @item -mieee
23479 @itemx -mno-ieee
23480 @opindex mieee
23481 @opindex mno-ieee
23482 Control the IEEE compliance of floating-point comparisons, which affects the
23483 handling of cases where the result of a comparison is unordered.  By default
23484 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
23485 enabled @option{-mno-ieee} is implicitly set, which results in faster
23486 floating-point greater-equal and less-equal comparisons.  The implicit settings
23487 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
23489 @item -minline-ic_invalidate
23490 @opindex minline-ic_invalidate
23491 Inline code to invalidate instruction cache entries after setting up
23492 nested function trampolines.
23493 This option has no effect if @option{-musermode} is in effect and the selected
23494 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
23495 instruction.
23496 If the selected code generation option does not allow the use of the @code{icbi}
23497 instruction, and @option{-musermode} is not in effect, the inlined code
23498 manipulates the instruction cache address array directly with an associative
23499 write.  This not only requires privileged mode at run time, but it also
23500 fails if the cache line had been mapped via the TLB and has become unmapped.
23502 @item -misize
23503 @opindex misize
23504 Dump instruction size and location in the assembly code.
23506 @item -mpadstruct
23507 @opindex mpadstruct
23508 This option is deprecated.  It pads structures to multiple of 4 bytes,
23509 which is incompatible with the SH ABI@.
23511 @item -matomic-model=@var{model}
23512 @opindex matomic-model=@var{model}
23513 Sets the model of atomic operations and additional parameters as a comma
23514 separated list.  For details on the atomic built-in functions see
23515 @ref{__atomic Builtins}.  The following models and parameters are supported:
23517 @table @samp
23519 @item none
23520 Disable compiler generated atomic sequences and emit library calls for atomic
23521 operations.  This is the default if the target is not @code{sh*-*-linux*}.
23523 @item soft-gusa
23524 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
23525 built-in functions.  The generated atomic sequences require additional support
23526 from the interrupt/exception handling code of the system and are only suitable
23527 for SH3* and SH4* single-core systems.  This option is enabled by default when
23528 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
23529 this option also partially utilizes the hardware atomic instructions
23530 @code{movli.l} and @code{movco.l} to create more efficient code, unless
23531 @samp{strict} is specified.  
23533 @item soft-tcb
23534 Generate software atomic sequences that use a variable in the thread control
23535 block.  This is a variation of the gUSA sequences which can also be used on
23536 SH1* and SH2* targets.  The generated atomic sequences require additional
23537 support from the interrupt/exception handling code of the system and are only
23538 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
23539 parameter has to be specified as well.
23541 @item soft-imask
23542 Generate software atomic sequences that temporarily disable interrupts by
23543 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
23544 in privileged mode and is only suitable for single-core systems.  Additional
23545 support from the interrupt/exception handling code of the system is not
23546 required.  This model is enabled by default when the target is
23547 @code{sh*-*-linux*} and SH1* or SH2*.
23549 @item hard-llcs
23550 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
23551 instructions only.  This is only available on SH4A and is suitable for
23552 multi-core systems.  Since the hardware instructions support only 32 bit atomic
23553 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
23554 Code compiled with this option is also compatible with other software
23555 atomic model interrupt/exception handling systems if executed on an SH4A
23556 system.  Additional support from the interrupt/exception handling code of the
23557 system is not required for this model.
23559 @item gbr-offset=
23560 This parameter specifies the offset in bytes of the variable in the thread
23561 control block structure that should be used by the generated atomic sequences
23562 when the @samp{soft-tcb} model has been selected.  For other models this
23563 parameter is ignored.  The specified value must be an integer multiple of four
23564 and in the range 0-1020.
23566 @item strict
23567 This parameter prevents mixed usage of multiple atomic models, even if they
23568 are compatible, and makes the compiler generate atomic sequences of the
23569 specified model only.
23571 @end table
23573 @item -mtas
23574 @opindex mtas
23575 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
23576 Notice that depending on the particular hardware and software configuration
23577 this can degrade overall performance due to the operand cache line flushes
23578 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
23579 processors the @code{tas.b} instruction must be used with caution since it
23580 can result in data corruption for certain cache configurations.
23582 @item -mprefergot
23583 @opindex mprefergot
23584 When generating position-independent code, emit function calls using
23585 the Global Offset Table instead of the Procedure Linkage Table.
23587 @item -musermode
23588 @itemx -mno-usermode
23589 @opindex musermode
23590 @opindex mno-usermode
23591 Don't allow (allow) the compiler generating privileged mode code.  Specifying
23592 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
23593 inlined code would not work in user mode.  @option{-musermode} is the default
23594 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
23595 @option{-musermode} has no effect, since there is no user mode.
23597 @item -multcost=@var{number}
23598 @opindex multcost=@var{number}
23599 Set the cost to assume for a multiply insn.
23601 @item -mdiv=@var{strategy}
23602 @opindex mdiv=@var{strategy}
23603 Set the division strategy to be used for integer division operations.
23604 @var{strategy} can be one of: 
23606 @table @samp
23608 @item call-div1
23609 Calls a library function that uses the single-step division instruction
23610 @code{div1} to perform the operation.  Division by zero calculates an
23611 unspecified result and does not trap.  This is the default except for SH4,
23612 SH2A and SHcompact.
23614 @item call-fp
23615 Calls a library function that performs the operation in double precision
23616 floating point.  Division by zero causes a floating-point exception.  This is
23617 the default for SHcompact with FPU.  Specifying this for targets that do not
23618 have a double precision FPU defaults to @code{call-div1}.
23620 @item call-table
23621 Calls a library function that uses a lookup table for small divisors and
23622 the @code{div1} instruction with case distinction for larger divisors.  Division
23623 by zero calculates an unspecified result and does not trap.  This is the default
23624 for SH4.  Specifying this for targets that do not have dynamic shift
23625 instructions defaults to @code{call-div1}.
23627 @end table
23629 When a division strategy has not been specified the default strategy is
23630 selected based on the current target.  For SH2A the default strategy is to
23631 use the @code{divs} and @code{divu} instructions instead of library function
23632 calls.
23634 @item -maccumulate-outgoing-args
23635 @opindex maccumulate-outgoing-args
23636 Reserve space once for outgoing arguments in the function prologue rather
23637 than around each call.  Generally beneficial for performance and size.  Also
23638 needed for unwinding to avoid changing the stack frame around conditional code.
23640 @item -mdivsi3_libfunc=@var{name}
23641 @opindex mdivsi3_libfunc=@var{name}
23642 Set the name of the library function used for 32-bit signed division to
23643 @var{name}.
23644 This only affects the name used in the @samp{call} division strategies, and
23645 the compiler still expects the same sets of input/output/clobbered registers as
23646 if this option were not present.
23648 @item -mfixed-range=@var{register-range}
23649 @opindex mfixed-range
23650 Generate code treating the given register range as fixed registers.
23651 A fixed register is one that the register allocator can not use.  This is
23652 useful when compiling kernel code.  A register range is specified as
23653 two registers separated by a dash.  Multiple register ranges can be
23654 specified separated by a comma.
23656 @item -mbranch-cost=@var{num}
23657 @opindex mbranch-cost=@var{num}
23658 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
23659 make the compiler try to generate more branch-free code if possible.  
23660 If not specified the value is selected depending on the processor type that
23661 is being compiled for.
23663 @item -mzdcbranch
23664 @itemx -mno-zdcbranch
23665 @opindex mzdcbranch
23666 @opindex mno-zdcbranch
23667 Assume (do not assume) that zero displacement conditional branch instructions
23668 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
23669 compiler prefers zero displacement branch code sequences.  This is
23670 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
23671 disabled by specifying @option{-mno-zdcbranch}.
23673 @item -mcbranch-force-delay-slot
23674 @opindex mcbranch-force-delay-slot
23675 Force the usage of delay slots for conditional branches, which stuffs the delay
23676 slot with a @code{nop} if a suitable instruction cannot be found.  By default
23677 this option is disabled.  It can be enabled to work around hardware bugs as
23678 found in the original SH7055.
23680 @item -mfused-madd
23681 @itemx -mno-fused-madd
23682 @opindex mfused-madd
23683 @opindex mno-fused-madd
23684 Generate code that uses (does not use) the floating-point multiply and
23685 accumulate instructions.  These instructions are generated by default
23686 if hardware floating point is used.  The machine-dependent
23687 @option{-mfused-madd} option is now mapped to the machine-independent
23688 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
23689 mapped to @option{-ffp-contract=off}.
23691 @item -mfsca
23692 @itemx -mno-fsca
23693 @opindex mfsca
23694 @opindex mno-fsca
23695 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
23696 and cosine approximations.  The option @option{-mfsca} must be used in
23697 combination with @option{-funsafe-math-optimizations}.  It is enabled by default
23698 when generating code for SH4A.  Using @option{-mno-fsca} disables sine and cosine
23699 approximations even if @option{-funsafe-math-optimizations} is in effect.
23701 @item -mfsrra
23702 @itemx -mno-fsrra
23703 @opindex mfsrra
23704 @opindex mno-fsrra
23705 Allow or disallow the compiler to emit the @code{fsrra} instruction for
23706 reciprocal square root approximations.  The option @option{-mfsrra} must be used
23707 in combination with @option{-funsafe-math-optimizations} and
23708 @option{-ffinite-math-only}.  It is enabled by default when generating code for
23709 SH4A.  Using @option{-mno-fsrra} disables reciprocal square root approximations
23710 even if @option{-funsafe-math-optimizations} and @option{-ffinite-math-only} are
23711 in effect.
23713 @item -mpretend-cmove
23714 @opindex mpretend-cmove
23715 Prefer zero-displacement conditional branches for conditional move instruction
23716 patterns.  This can result in faster code on the SH4 processor.
23718 @item -mfdpic
23719 @opindex fdpic
23720 Generate code using the FDPIC ABI.
23722 @end table
23724 @node Solaris 2 Options
23725 @subsection Solaris 2 Options
23726 @cindex Solaris 2 options
23728 These @samp{-m} options are supported on Solaris 2:
23730 @table @gcctabopt
23731 @item -mclear-hwcap
23732 @opindex mclear-hwcap
23733 @option{-mclear-hwcap} tells the compiler to remove the hardware
23734 capabilities generated by the Solaris assembler.  This is only necessary
23735 when object files use ISA extensions not supported by the current
23736 machine, but check at runtime whether or not to use them.
23738 @item -mimpure-text
23739 @opindex mimpure-text
23740 @option{-mimpure-text}, used in addition to @option{-shared}, tells
23741 the compiler to not pass @option{-z text} to the linker when linking a
23742 shared object.  Using this option, you can link position-dependent
23743 code into a shared object.
23745 @option{-mimpure-text} suppresses the ``relocations remain against
23746 allocatable but non-writable sections'' linker error message.
23747 However, the necessary relocations trigger copy-on-write, and the
23748 shared object is not actually shared across processes.  Instead of
23749 using @option{-mimpure-text}, you should compile all source code with
23750 @option{-fpic} or @option{-fPIC}.
23752 @end table
23754 These switches are supported in addition to the above on Solaris 2:
23756 @table @gcctabopt
23757 @item -pthreads
23758 @opindex pthreads
23759 This is a synonym for @option{-pthread}.
23760 @end table
23762 @node SPARC Options
23763 @subsection SPARC Options
23764 @cindex SPARC options
23766 These @samp{-m} options are supported on the SPARC:
23768 @table @gcctabopt
23769 @item -mno-app-regs
23770 @itemx -mapp-regs
23771 @opindex mno-app-regs
23772 @opindex mapp-regs
23773 Specify @option{-mapp-regs} to generate output using the global registers
23774 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
23775 global register 1, each global register 2 through 4 is then treated as an
23776 allocable register that is clobbered by function calls.  This is the default.
23778 To be fully SVR4 ABI-compliant at the cost of some performance loss,
23779 specify @option{-mno-app-regs}.  You should compile libraries and system
23780 software with this option.
23782 @item -mflat
23783 @itemx -mno-flat
23784 @opindex mflat
23785 @opindex mno-flat
23786 With @option{-mflat}, the compiler does not generate save/restore instructions
23787 and uses a ``flat'' or single register window model.  This model is compatible
23788 with the regular register window model.  The local registers and the input
23789 registers (0--5) are still treated as ``call-saved'' registers and are
23790 saved on the stack as needed.
23792 With @option{-mno-flat} (the default), the compiler generates save/restore
23793 instructions (except for leaf functions).  This is the normal operating mode.
23795 @item -mfpu
23796 @itemx -mhard-float
23797 @opindex mfpu
23798 @opindex mhard-float
23799 Generate output containing floating-point instructions.  This is the
23800 default.
23802 @item -mno-fpu
23803 @itemx -msoft-float
23804 @opindex mno-fpu
23805 @opindex msoft-float
23806 Generate output containing library calls for floating point.
23807 @strong{Warning:} the requisite libraries are not available for all SPARC
23808 targets.  Normally the facilities of the machine's usual C compiler are
23809 used, but this cannot be done directly in cross-compilation.  You must make
23810 your own arrangements to provide suitable library functions for
23811 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
23812 @samp{sparclite-*-*} do provide software floating-point support.
23814 @option{-msoft-float} changes the calling convention in the output file;
23815 therefore, it is only useful if you compile @emph{all} of a program with
23816 this option.  In particular, you need to compile @file{libgcc.a}, the
23817 library that comes with GCC, with @option{-msoft-float} in order for
23818 this to work.
23820 @item -mhard-quad-float
23821 @opindex mhard-quad-float
23822 Generate output containing quad-word (long double) floating-point
23823 instructions.
23825 @item -msoft-quad-float
23826 @opindex msoft-quad-float
23827 Generate output containing library calls for quad-word (long double)
23828 floating-point instructions.  The functions called are those specified
23829 in the SPARC ABI@.  This is the default.
23831 As of this writing, there are no SPARC implementations that have hardware
23832 support for the quad-word floating-point instructions.  They all invoke
23833 a trap handler for one of these instructions, and then the trap handler
23834 emulates the effect of the instruction.  Because of the trap handler overhead,
23835 this is much slower than calling the ABI library routines.  Thus the
23836 @option{-msoft-quad-float} option is the default.
23838 @item -mno-unaligned-doubles
23839 @itemx -munaligned-doubles
23840 @opindex mno-unaligned-doubles
23841 @opindex munaligned-doubles
23842 Assume that doubles have 8-byte alignment.  This is the default.
23844 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
23845 alignment only if they are contained in another type, or if they have an
23846 absolute address.  Otherwise, it assumes they have 4-byte alignment.
23847 Specifying this option avoids some rare compatibility problems with code
23848 generated by other compilers.  It is not the default because it results
23849 in a performance loss, especially for floating-point code.
23851 @item -muser-mode
23852 @itemx -mno-user-mode
23853 @opindex muser-mode
23854 @opindex mno-user-mode
23855 Do not generate code that can only run in supervisor mode.  This is relevant
23856 only for the @code{casa} instruction emitted for the LEON3 processor.  This
23857 is the default.
23859 @item -mfaster-structs
23860 @itemx -mno-faster-structs
23861 @opindex mfaster-structs
23862 @opindex mno-faster-structs
23863 With @option{-mfaster-structs}, the compiler assumes that structures
23864 should have 8-byte alignment.  This enables the use of pairs of
23865 @code{ldd} and @code{std} instructions for copies in structure
23866 assignment, in place of twice as many @code{ld} and @code{st} pairs.
23867 However, the use of this changed alignment directly violates the SPARC
23868 ABI@.  Thus, it's intended only for use on targets where the developer
23869 acknowledges that their resulting code is not directly in line with
23870 the rules of the ABI@.
23872 @item -mstd-struct-return
23873 @itemx -mno-std-struct-return
23874 @opindex mstd-struct-return
23875 @opindex mno-std-struct-return
23876 With @option{-mstd-struct-return}, the compiler generates checking code
23877 in functions returning structures or unions to detect size mismatches
23878 between the two sides of function calls, as per the 32-bit ABI@.
23880 The default is @option{-mno-std-struct-return}.  This option has no effect
23881 in 64-bit mode.
23883 @item -mlra
23884 @itemx -mno-lra
23885 @opindex mlra
23886 @opindex mno-lra
23887 Enable Local Register Allocation.  This is the default for SPARC since GCC 7
23888 so @option{-mno-lra} needs to be passed to get old Reload.
23890 @item -mcpu=@var{cpu_type}
23891 @opindex mcpu
23892 Set the instruction set, register set, and instruction scheduling parameters
23893 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
23894 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
23895 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
23896 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
23897 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
23898 @samp{niagara3}, @samp{niagara4}, @samp{niagara7} and @samp{m8}.
23900 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
23901 which selects the best architecture option for the host processor.
23902 @option{-mcpu=native} has no effect if GCC does not recognize
23903 the processor.
23905 Default instruction scheduling parameters are used for values that select
23906 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
23907 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
23909 Here is a list of each supported architecture and their supported
23910 implementations.
23912 @table @asis
23913 @item v7
23914 cypress, leon3v7
23916 @item v8
23917 supersparc, hypersparc, leon, leon3
23919 @item sparclite
23920 f930, f934, sparclite86x
23922 @item sparclet
23923 tsc701
23925 @item v9
23926 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4,
23927 niagara7, m8
23928 @end table
23930 By default (unless configured otherwise), GCC generates code for the V7
23931 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
23932 additionally optimizes it for the Cypress CY7C602 chip, as used in the
23933 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
23934 SPARCStation 1, 2, IPX etc.
23936 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
23937 architecture.  The only difference from V7 code is that the compiler emits
23938 the integer multiply and integer divide instructions which exist in SPARC-V8
23939 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
23940 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
23941 2000 series.
23943 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
23944 the SPARC architecture.  This adds the integer multiply, integer divide step
23945 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
23946 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
23947 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
23948 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
23949 MB86934 chip, which is the more recent SPARClite with FPU@.
23951 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
23952 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
23953 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
23954 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
23955 optimizes it for the TEMIC SPARClet chip.
23957 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
23958 architecture.  This adds 64-bit integer and floating-point move instructions,
23959 3 additional floating-point condition code registers and conditional move
23960 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
23961 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
23962 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
23963 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
23964 @option{-mcpu=niagara}, the compiler additionally optimizes it for
23965 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
23966 additionally optimizes it for Sun UltraSPARC T2 chips. With
23967 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
23968 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
23969 additionally optimizes it for Sun UltraSPARC T4 chips.  With
23970 @option{-mcpu=niagara7}, the compiler additionally optimizes it for
23971 Oracle SPARC M7 chips.  With @option{-mcpu=m8}, the compiler
23972 additionally optimizes it for Oracle M8 chips.
23974 @item -mtune=@var{cpu_type}
23975 @opindex mtune
23976 Set the instruction scheduling parameters for machine type
23977 @var{cpu_type}, but do not set the instruction set or register set that the
23978 option @option{-mcpu=@var{cpu_type}} does.
23980 The same values for @option{-mcpu=@var{cpu_type}} can be used for
23981 @option{-mtune=@var{cpu_type}}, but the only useful values are those
23982 that select a particular CPU implementation.  Those are
23983 @samp{cypress}, @samp{supersparc}, @samp{hypersparc}, @samp{leon},
23984 @samp{leon3}, @samp{leon3v7}, @samp{f930}, @samp{f934},
23985 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
23986 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3},
23987 @samp{niagara4}, @samp{niagara7} and @samp{m8}.  With native Solaris
23988 and GNU/Linux toolchains, @samp{native} can also be used.
23990 @item -mv8plus
23991 @itemx -mno-v8plus
23992 @opindex mv8plus
23993 @opindex mno-v8plus
23994 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
23995 difference from the V8 ABI is that the global and out registers are
23996 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
23997 mode for all SPARC-V9 processors.
23999 @item -mvis
24000 @itemx -mno-vis
24001 @opindex mvis
24002 @opindex mno-vis
24003 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
24004 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
24006 @item -mvis2
24007 @itemx -mno-vis2
24008 @opindex mvis2
24009 @opindex mno-vis2
24010 With @option{-mvis2}, GCC generates code that takes advantage of
24011 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
24012 default is @option{-mvis2} when targeting a cpu that supports such
24013 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
24014 also sets @option{-mvis}.
24016 @item -mvis3
24017 @itemx -mno-vis3
24018 @opindex mvis3
24019 @opindex mno-vis3
24020 With @option{-mvis3}, GCC generates code that takes advantage of
24021 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
24022 default is @option{-mvis3} when targeting a cpu that supports such
24023 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
24024 also sets @option{-mvis2} and @option{-mvis}.
24026 @item -mvis4
24027 @itemx -mno-vis4
24028 @opindex mvis4
24029 @opindex mno-vis4
24030 With @option{-mvis4}, GCC generates code that takes advantage of
24031 version 4.0 of the UltraSPARC Visual Instruction Set extensions.  The
24032 default is @option{-mvis4} when targeting a cpu that supports such
24033 instructions, such as niagara-7 and later.  Setting @option{-mvis4}
24034 also sets @option{-mvis3}, @option{-mvis2} and @option{-mvis}.
24036 @item -mvis4b
24037 @itemx -mno-vis4b
24038 @opindex mvis4b
24039 @opindex mno-vis4b
24040 With @option{-mvis4b}, GCC generates code that takes advantage of
24041 version 4.0 of the UltraSPARC Visual Instruction Set extensions, plus
24042 the additional VIS instructions introduced in the Oracle SPARC
24043 Architecture 2017.  The default is @option{-mvis4b} when targeting a
24044 cpu that supports such instructions, such as m8 and later.  Setting
24045 @option{-mvis4b} also sets @option{-mvis4}, @option{-mvis3},
24046 @option{-mvis2} and @option{-mvis}.
24048 @item -mcbcond
24049 @itemx -mno-cbcond
24050 @opindex mcbcond
24051 @opindex mno-cbcond
24052 With @option{-mcbcond}, GCC generates code that takes advantage of the UltraSPARC
24053 Compare-and-Branch-on-Condition instructions.  The default is @option{-mcbcond}
24054 when targeting a CPU that supports such instructions, such as Niagara-4 and
24055 later.
24057 @item -mfmaf
24058 @itemx -mno-fmaf
24059 @opindex mfmaf
24060 @opindex mno-fmaf
24061 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
24062 Fused Multiply-Add Floating-point instructions.  The default is @option{-mfmaf}
24063 when targeting a CPU that supports such instructions, such as Niagara-3 and
24064 later.
24066 @item -mfsmuld
24067 @itemx -mno-fsmuld
24068 @opindex mfsmuld
24069 @opindex mno-fsmuld
24070 With @option{-mfsmuld}, GCC generates code that takes advantage of the
24071 Floating-point Multiply Single to Double (FsMULd) instruction.  The default is
24072 @option{-mfsmuld} when targeting a CPU supporting the architecture versions V8
24073 or V9 with FPU except @option{-mcpu=leon}.
24075 @item -mpopc
24076 @itemx -mno-popc
24077 @opindex mpopc
24078 @opindex mno-popc
24079 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
24080 Population Count instruction.  The default is @option{-mpopc}
24081 when targeting a CPU that supports such an instruction, such as Niagara-2 and
24082 later.
24084 @item -msubxc
24085 @itemx -mno-subxc
24086 @opindex msubxc
24087 @opindex mno-subxc
24088 With @option{-msubxc}, GCC generates code that takes advantage of the UltraSPARC
24089 Subtract-Extended-with-Carry instruction.  The default is @option{-msubxc}
24090 when targeting a CPU that supports such an instruction, such as Niagara-7 and
24091 later.
24093 @item -mfix-at697f
24094 @opindex mfix-at697f
24095 Enable the documented workaround for the single erratum of the Atmel AT697F
24096 processor (which corresponds to erratum #13 of the AT697E processor).
24098 @item -mfix-ut699
24099 @opindex mfix-ut699
24100 Enable the documented workarounds for the floating-point errata and the data
24101 cache nullify errata of the UT699 processor.
24103 @item -mfix-ut700
24104 @opindex mfix-ut700
24105 Enable the documented workaround for the back-to-back store errata of
24106 the UT699E/UT700 processor.
24108 @item -mfix-gr712rc
24109 @opindex mfix-gr712rc
24110 Enable the documented workaround for the back-to-back store errata of
24111 the GR712RC processor.
24112 @end table
24114 These @samp{-m} options are supported in addition to the above
24115 on SPARC-V9 processors in 64-bit environments:
24117 @table @gcctabopt
24118 @item -m32
24119 @itemx -m64
24120 @opindex m32
24121 @opindex m64
24122 Generate code for a 32-bit or 64-bit environment.
24123 The 32-bit environment sets int, long and pointer to 32 bits.
24124 The 64-bit environment sets int to 32 bits and long and pointer
24125 to 64 bits.
24127 @item -mcmodel=@var{which}
24128 @opindex mcmodel
24129 Set the code model to one of
24131 @table @samp
24132 @item medlow
24133 The Medium/Low code model: 64-bit addresses, programs
24134 must be linked in the low 32 bits of memory.  Programs can be statically
24135 or dynamically linked.
24137 @item medmid
24138 The Medium/Middle code model: 64-bit addresses, programs
24139 must be linked in the low 44 bits of memory, the text and data segments must
24140 be less than 2GB in size and the data segment must be located within 2GB of
24141 the text segment.
24143 @item medany
24144 The Medium/Anywhere code model: 64-bit addresses, programs
24145 may be linked anywhere in memory, the text and data segments must be less
24146 than 2GB in size and the data segment must be located within 2GB of the
24147 text segment.
24149 @item embmedany
24150 The Medium/Anywhere code model for embedded systems:
24151 64-bit addresses, the text and data segments must be less than 2GB in
24152 size, both starting anywhere in memory (determined at link time).  The
24153 global register %g4 points to the base of the data segment.  Programs
24154 are statically linked and PIC is not supported.
24155 @end table
24157 @item -mmemory-model=@var{mem-model}
24158 @opindex mmemory-model
24159 Set the memory model in force on the processor to one of
24161 @table @samp
24162 @item default
24163 The default memory model for the processor and operating system.
24165 @item rmo
24166 Relaxed Memory Order
24168 @item pso
24169 Partial Store Order
24171 @item tso
24172 Total Store Order
24174 @item sc
24175 Sequential Consistency
24176 @end table
24178 These memory models are formally defined in Appendix D of the SPARC-V9
24179 architecture manual, as set in the processor's @code{PSTATE.MM} field.
24181 @item -mstack-bias
24182 @itemx -mno-stack-bias
24183 @opindex mstack-bias
24184 @opindex mno-stack-bias
24185 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
24186 frame pointer if present, are offset by @minus{}2047 which must be added back
24187 when making stack frame references.  This is the default in 64-bit mode.
24188 Otherwise, assume no such offset is present.
24189 @end table
24191 @node SPU Options
24192 @subsection SPU Options
24193 @cindex SPU options
24195 These @samp{-m} options are supported on the SPU:
24197 @table @gcctabopt
24198 @item -mwarn-reloc
24199 @itemx -merror-reloc
24200 @opindex mwarn-reloc
24201 @opindex merror-reloc
24203 The loader for SPU does not handle dynamic relocations.  By default, GCC
24204 gives an error when it generates code that requires a dynamic
24205 relocation.  @option{-mno-error-reloc} disables the error,
24206 @option{-mwarn-reloc} generates a warning instead.
24208 @item -msafe-dma
24209 @itemx -munsafe-dma
24210 @opindex msafe-dma
24211 @opindex munsafe-dma
24213 Instructions that initiate or test completion of DMA must not be
24214 reordered with respect to loads and stores of the memory that is being
24215 accessed.
24216 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
24217 memory accesses, but that can lead to inefficient code in places where the
24218 memory is known to not change.  Rather than mark the memory as volatile,
24219 you can use @option{-msafe-dma} to tell the compiler to treat
24220 the DMA instructions as potentially affecting all memory.  
24222 @item -mbranch-hints
24223 @opindex mbranch-hints
24225 By default, GCC generates a branch hint instruction to avoid
24226 pipeline stalls for always-taken or probably-taken branches.  A hint
24227 is not generated closer than 8 instructions away from its branch.
24228 There is little reason to disable them, except for debugging purposes,
24229 or to make an object a little bit smaller.
24231 @item -msmall-mem
24232 @itemx -mlarge-mem
24233 @opindex msmall-mem
24234 @opindex mlarge-mem
24236 By default, GCC generates code assuming that addresses are never larger
24237 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
24238 a full 32-bit address.
24240 @item -mstdmain
24241 @opindex mstdmain
24243 By default, GCC links against startup code that assumes the SPU-style
24244 main function interface (which has an unconventional parameter list).
24245 With @option{-mstdmain}, GCC links your program against startup
24246 code that assumes a C99-style interface to @code{main}, including a
24247 local copy of @code{argv} strings.
24249 @item -mfixed-range=@var{register-range}
24250 @opindex mfixed-range
24251 Generate code treating the given register range as fixed registers.
24252 A fixed register is one that the register allocator cannot use.  This is
24253 useful when compiling kernel code.  A register range is specified as
24254 two registers separated by a dash.  Multiple register ranges can be
24255 specified separated by a comma.
24257 @item -mea32
24258 @itemx -mea64
24259 @opindex mea32
24260 @opindex mea64
24261 Compile code assuming that pointers to the PPU address space accessed
24262 via the @code{__ea} named address space qualifier are either 32 or 64
24263 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
24264 all object code in an executable must be compiled with the same setting.
24266 @item -maddress-space-conversion
24267 @itemx -mno-address-space-conversion
24268 @opindex maddress-space-conversion
24269 @opindex mno-address-space-conversion
24270 Allow/disallow treating the @code{__ea} address space as superset
24271 of the generic address space.  This enables explicit type casts
24272 between @code{__ea} and generic pointer as well as implicit
24273 conversions of generic pointers to @code{__ea} pointers.  The
24274 default is to allow address space pointer conversions.
24276 @item -mcache-size=@var{cache-size}
24277 @opindex mcache-size
24278 This option controls the version of libgcc that the compiler links to an
24279 executable and selects a software-managed cache for accessing variables
24280 in the @code{__ea} address space with a particular cache size.  Possible
24281 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
24282 and @samp{128}.  The default cache size is 64KB.
24284 @item -matomic-updates
24285 @itemx -mno-atomic-updates
24286 @opindex matomic-updates
24287 @opindex mno-atomic-updates
24288 This option controls the version of libgcc that the compiler links to an
24289 executable and selects whether atomic updates to the software-managed
24290 cache of PPU-side variables are used.  If you use atomic updates, changes
24291 to a PPU variable from SPU code using the @code{__ea} named address space
24292 qualifier do not interfere with changes to other PPU variables residing
24293 in the same cache line from PPU code.  If you do not use atomic updates,
24294 such interference may occur; however, writing back cache lines is
24295 more efficient.  The default behavior is to use atomic updates.
24297 @item -mdual-nops
24298 @itemx -mdual-nops=@var{n}
24299 @opindex mdual-nops
24300 By default, GCC inserts NOPs to increase dual issue when it expects
24301 it to increase performance.  @var{n} can be a value from 0 to 10.  A
24302 smaller @var{n} inserts fewer NOPs.  10 is the default, 0 is the
24303 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
24305 @item -mhint-max-nops=@var{n}
24306 @opindex mhint-max-nops
24307 Maximum number of NOPs to insert for a branch hint.  A branch hint must
24308 be at least 8 instructions away from the branch it is affecting.  GCC
24309 inserts up to @var{n} NOPs to enforce this, otherwise it does not
24310 generate the branch hint.
24312 @item -mhint-max-distance=@var{n}
24313 @opindex mhint-max-distance
24314 The encoding of the branch hint instruction limits the hint to be within
24315 256 instructions of the branch it is affecting.  By default, GCC makes
24316 sure it is within 125.
24318 @item -msafe-hints
24319 @opindex msafe-hints
24320 Work around a hardware bug that causes the SPU to stall indefinitely.
24321 By default, GCC inserts the @code{hbrp} instruction to make sure
24322 this stall won't happen.
24324 @end table
24326 @node System V Options
24327 @subsection Options for System V
24329 These additional options are available on System V Release 4 for
24330 compatibility with other compilers on those systems:
24332 @table @gcctabopt
24333 @item -G
24334 @opindex G
24335 Create a shared object.
24336 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
24338 @item -Qy
24339 @opindex Qy
24340 Identify the versions of each tool used by the compiler, in a
24341 @code{.ident} assembler directive in the output.
24343 @item -Qn
24344 @opindex Qn
24345 Refrain from adding @code{.ident} directives to the output file (this is
24346 the default).
24348 @item -YP,@var{dirs}
24349 @opindex YP
24350 Search the directories @var{dirs}, and no others, for libraries
24351 specified with @option{-l}.
24353 @item -Ym,@var{dir}
24354 @opindex Ym
24355 Look in the directory @var{dir} to find the M4 preprocessor.
24356 The assembler uses this option.
24357 @c This is supposed to go with a -Yd for predefined M4 macro files, but
24358 @c the generic assembler that comes with Solaris takes just -Ym.
24359 @end table
24361 @node TILE-Gx Options
24362 @subsection TILE-Gx Options
24363 @cindex TILE-Gx options
24365 These @samp{-m} options are supported on the TILE-Gx:
24367 @table @gcctabopt
24368 @item -mcmodel=small
24369 @opindex mcmodel=small
24370 Generate code for the small model.  The distance for direct calls is
24371 limited to 500M in either direction.  PC-relative addresses are 32
24372 bits.  Absolute addresses support the full address range.
24374 @item -mcmodel=large
24375 @opindex mcmodel=large
24376 Generate code for the large model.  There is no limitation on call
24377 distance, pc-relative addresses, or absolute addresses.
24379 @item -mcpu=@var{name}
24380 @opindex mcpu
24381 Selects the type of CPU to be targeted.  Currently the only supported
24382 type is @samp{tilegx}.
24384 @item -m32
24385 @itemx -m64
24386 @opindex m32
24387 @opindex m64
24388 Generate code for a 32-bit or 64-bit environment.  The 32-bit
24389 environment sets int, long, and pointer to 32 bits.  The 64-bit
24390 environment sets int to 32 bits and long and pointer to 64 bits.
24392 @item -mbig-endian
24393 @itemx -mlittle-endian
24394 @opindex mbig-endian
24395 @opindex mlittle-endian
24396 Generate code in big/little endian mode, respectively.
24397 @end table
24399 @node TILEPro Options
24400 @subsection TILEPro Options
24401 @cindex TILEPro options
24403 These @samp{-m} options are supported on the TILEPro:
24405 @table @gcctabopt
24406 @item -mcpu=@var{name}
24407 @opindex mcpu
24408 Selects the type of CPU to be targeted.  Currently the only supported
24409 type is @samp{tilepro}.
24411 @item -m32
24412 @opindex m32
24413 Generate code for a 32-bit environment, which sets int, long, and
24414 pointer to 32 bits.  This is the only supported behavior so the flag
24415 is essentially ignored.
24416 @end table
24418 @node V850 Options
24419 @subsection V850 Options
24420 @cindex V850 Options
24422 These @samp{-m} options are defined for V850 implementations:
24424 @table @gcctabopt
24425 @item -mlong-calls
24426 @itemx -mno-long-calls
24427 @opindex mlong-calls
24428 @opindex mno-long-calls
24429 Treat all calls as being far away (near).  If calls are assumed to be
24430 far away, the compiler always loads the function's address into a
24431 register, and calls indirect through the pointer.
24433 @item -mno-ep
24434 @itemx -mep
24435 @opindex mno-ep
24436 @opindex mep
24437 Do not optimize (do optimize) basic blocks that use the same index
24438 pointer 4 or more times to copy pointer into the @code{ep} register, and
24439 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
24440 option is on by default if you optimize.
24442 @item -mno-prolog-function
24443 @itemx -mprolog-function
24444 @opindex mno-prolog-function
24445 @opindex mprolog-function
24446 Do not use (do use) external functions to save and restore registers
24447 at the prologue and epilogue of a function.  The external functions
24448 are slower, but use less code space if more than one function saves
24449 the same number of registers.  The @option{-mprolog-function} option
24450 is on by default if you optimize.
24452 @item -mspace
24453 @opindex mspace
24454 Try to make the code as small as possible.  At present, this just turns
24455 on the @option{-mep} and @option{-mprolog-function} options.
24457 @item -mtda=@var{n}
24458 @opindex mtda
24459 Put static or global variables whose size is @var{n} bytes or less into
24460 the tiny data area that register @code{ep} points to.  The tiny data
24461 area can hold up to 256 bytes in total (128 bytes for byte references).
24463 @item -msda=@var{n}
24464 @opindex msda
24465 Put static or global variables whose size is @var{n} bytes or less into
24466 the small data area that register @code{gp} points to.  The small data
24467 area can hold up to 64 kilobytes.
24469 @item -mzda=@var{n}
24470 @opindex mzda
24471 Put static or global variables whose size is @var{n} bytes or less into
24472 the first 32 kilobytes of memory.
24474 @item -mv850
24475 @opindex mv850
24476 Specify that the target processor is the V850.
24478 @item -mv850e3v5
24479 @opindex mv850e3v5
24480 Specify that the target processor is the V850E3V5.  The preprocessor
24481 constant @code{__v850e3v5__} is defined if this option is used.
24483 @item -mv850e2v4
24484 @opindex mv850e2v4
24485 Specify that the target processor is the V850E3V5.  This is an alias for
24486 the @option{-mv850e3v5} option.
24488 @item -mv850e2v3
24489 @opindex mv850e2v3
24490 Specify that the target processor is the V850E2V3.  The preprocessor
24491 constant @code{__v850e2v3__} is defined if this option is used.
24493 @item -mv850e2
24494 @opindex mv850e2
24495 Specify that the target processor is the V850E2.  The preprocessor
24496 constant @code{__v850e2__} is defined if this option is used.
24498 @item -mv850e1
24499 @opindex mv850e1
24500 Specify that the target processor is the V850E1.  The preprocessor
24501 constants @code{__v850e1__} and @code{__v850e__} are defined if
24502 this option is used.
24504 @item -mv850es
24505 @opindex mv850es
24506 Specify that the target processor is the V850ES.  This is an alias for
24507 the @option{-mv850e1} option.
24509 @item -mv850e
24510 @opindex mv850e
24511 Specify that the target processor is the V850E@.  The preprocessor
24512 constant @code{__v850e__} is defined if this option is used.
24514 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
24515 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
24516 are defined then a default target processor is chosen and the
24517 relevant @samp{__v850*__} preprocessor constant is defined.
24519 The preprocessor constants @code{__v850} and @code{__v851__} are always
24520 defined, regardless of which processor variant is the target.
24522 @item -mdisable-callt
24523 @itemx -mno-disable-callt
24524 @opindex mdisable-callt
24525 @opindex mno-disable-callt
24526 This option suppresses generation of the @code{CALLT} instruction for the
24527 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
24528 architecture.
24530 This option is enabled by default when the RH850 ABI is
24531 in use (see @option{-mrh850-abi}), and disabled by default when the
24532 GCC ABI is in use.  If @code{CALLT} instructions are being generated
24533 then the C preprocessor symbol @code{__V850_CALLT__} is defined.
24535 @item -mrelax
24536 @itemx -mno-relax
24537 @opindex mrelax
24538 @opindex mno-relax
24539 Pass on (or do not pass on) the @option{-mrelax} command-line option
24540 to the assembler.
24542 @item -mlong-jumps
24543 @itemx -mno-long-jumps
24544 @opindex mlong-jumps
24545 @opindex mno-long-jumps
24546 Disable (or re-enable) the generation of PC-relative jump instructions.
24548 @item -msoft-float
24549 @itemx -mhard-float
24550 @opindex msoft-float
24551 @opindex mhard-float
24552 Disable (or re-enable) the generation of hardware floating point
24553 instructions.  This option is only significant when the target
24554 architecture is @samp{V850E2V3} or higher.  If hardware floating point
24555 instructions are being generated then the C preprocessor symbol
24556 @code{__FPU_OK__} is defined, otherwise the symbol
24557 @code{__NO_FPU__} is defined.
24559 @item -mloop
24560 @opindex mloop
24561 Enables the use of the e3v5 LOOP instruction.  The use of this
24562 instruction is not enabled by default when the e3v5 architecture is
24563 selected because its use is still experimental.
24565 @item -mrh850-abi
24566 @itemx -mghs
24567 @opindex mrh850-abi
24568 @opindex mghs
24569 Enables support for the RH850 version of the V850 ABI.  This is the
24570 default.  With this version of the ABI the following rules apply:
24572 @itemize
24573 @item
24574 Integer sized structures and unions are returned via a memory pointer
24575 rather than a register.
24577 @item
24578 Large structures and unions (more than 8 bytes in size) are passed by
24579 value.
24581 @item
24582 Functions are aligned to 16-bit boundaries.
24584 @item
24585 The @option{-m8byte-align} command-line option is supported.
24587 @item
24588 The @option{-mdisable-callt} command-line option is enabled by
24589 default.  The @option{-mno-disable-callt} command-line option is not
24590 supported.
24591 @end itemize
24593 When this version of the ABI is enabled the C preprocessor symbol
24594 @code{__V850_RH850_ABI__} is defined.
24596 @item -mgcc-abi
24597 @opindex mgcc-abi
24598 Enables support for the old GCC version of the V850 ABI.  With this
24599 version of the ABI the following rules apply:
24601 @itemize
24602 @item
24603 Integer sized structures and unions are returned in register @code{r10}.
24605 @item
24606 Large structures and unions (more than 8 bytes in size) are passed by
24607 reference.
24609 @item
24610 Functions are aligned to 32-bit boundaries, unless optimizing for
24611 size.
24613 @item
24614 The @option{-m8byte-align} command-line option is not supported.
24616 @item
24617 The @option{-mdisable-callt} command-line option is supported but not
24618 enabled by default.
24619 @end itemize
24621 When this version of the ABI is enabled the C preprocessor symbol
24622 @code{__V850_GCC_ABI__} is defined.
24624 @item -m8byte-align
24625 @itemx -mno-8byte-align
24626 @opindex m8byte-align
24627 @opindex mno-8byte-align
24628 Enables support for @code{double} and @code{long long} types to be
24629 aligned on 8-byte boundaries.  The default is to restrict the
24630 alignment of all objects to at most 4-bytes.  When
24631 @option{-m8byte-align} is in effect the C preprocessor symbol
24632 @code{__V850_8BYTE_ALIGN__} is defined.
24634 @item -mbig-switch
24635 @opindex mbig-switch
24636 Generate code suitable for big switch tables.  Use this option only if
24637 the assembler/linker complain about out of range branches within a switch
24638 table.
24640 @item -mapp-regs
24641 @opindex mapp-regs
24642 This option causes r2 and r5 to be used in the code generated by
24643 the compiler.  This setting is the default.
24645 @item -mno-app-regs
24646 @opindex mno-app-regs
24647 This option causes r2 and r5 to be treated as fixed registers.
24649 @end table
24651 @node VAX Options
24652 @subsection VAX Options
24653 @cindex VAX options
24655 These @samp{-m} options are defined for the VAX:
24657 @table @gcctabopt
24658 @item -munix
24659 @opindex munix
24660 Do not output certain jump instructions (@code{aobleq} and so on)
24661 that the Unix assembler for the VAX cannot handle across long
24662 ranges.
24664 @item -mgnu
24665 @opindex mgnu
24666 Do output those jump instructions, on the assumption that the
24667 GNU assembler is being used.
24669 @item -mg
24670 @opindex mg
24671 Output code for G-format floating-point numbers instead of D-format.
24672 @end table
24674 @node Visium Options
24675 @subsection Visium Options
24676 @cindex Visium options
24678 @table @gcctabopt
24680 @item -mdebug
24681 @opindex mdebug
24682 A program which performs file I/O and is destined to run on an MCM target
24683 should be linked with this option.  It causes the libraries libc.a and
24684 libdebug.a to be linked.  The program should be run on the target under
24685 the control of the GDB remote debugging stub.
24687 @item -msim
24688 @opindex msim
24689 A program which performs file I/O and is destined to run on the simulator
24690 should be linked with option.  This causes libraries libc.a and libsim.a to
24691 be linked.
24693 @item -mfpu
24694 @itemx -mhard-float
24695 @opindex mfpu
24696 @opindex mhard-float
24697 Generate code containing floating-point instructions.  This is the
24698 default.
24700 @item -mno-fpu
24701 @itemx -msoft-float
24702 @opindex mno-fpu
24703 @opindex msoft-float
24704 Generate code containing library calls for floating-point.
24706 @option{-msoft-float} changes the calling convention in the output file;
24707 therefore, it is only useful if you compile @emph{all} of a program with
24708 this option.  In particular, you need to compile @file{libgcc.a}, the
24709 library that comes with GCC, with @option{-msoft-float} in order for
24710 this to work.
24712 @item -mcpu=@var{cpu_type}
24713 @opindex mcpu
24714 Set the instruction set, register set, and instruction scheduling parameters
24715 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
24716 @samp{mcm}, @samp{gr5} and @samp{gr6}.
24718 @samp{mcm} is a synonym of @samp{gr5} present for backward compatibility.
24720 By default (unless configured otherwise), GCC generates code for the GR5
24721 variant of the Visium architecture.  
24723 With @option{-mcpu=gr6}, GCC generates code for the GR6 variant of the Visium
24724 architecture.  The only difference from GR5 code is that the compiler will
24725 generate block move instructions.
24727 @item -mtune=@var{cpu_type}
24728 @opindex mtune
24729 Set the instruction scheduling parameters for machine type @var{cpu_type},
24730 but do not set the instruction set or register set that the option
24731 @option{-mcpu=@var{cpu_type}} would.
24733 @item -msv-mode
24734 @opindex msv-mode
24735 Generate code for the supervisor mode, where there are no restrictions on
24736 the access to general registers.  This is the default.
24738 @item -muser-mode
24739 @opindex muser-mode
24740 Generate code for the user mode, where the access to some general registers
24741 is forbidden: on the GR5, registers r24 to r31 cannot be accessed in this
24742 mode; on the GR6, only registers r29 to r31 are affected.
24743 @end table
24745 @node VMS Options
24746 @subsection VMS Options
24748 These @samp{-m} options are defined for the VMS implementations:
24750 @table @gcctabopt
24751 @item -mvms-return-codes
24752 @opindex mvms-return-codes
24753 Return VMS condition codes from @code{main}. The default is to return POSIX-style
24754 condition (e.g.@ error) codes.
24756 @item -mdebug-main=@var{prefix}
24757 @opindex mdebug-main=@var{prefix}
24758 Flag the first routine whose name starts with @var{prefix} as the main
24759 routine for the debugger.
24761 @item -mmalloc64
24762 @opindex mmalloc64
24763 Default to 64-bit memory allocation routines.
24765 @item -mpointer-size=@var{size}
24766 @opindex mpointer-size=@var{size}
24767 Set the default size of pointers. Possible options for @var{size} are
24768 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
24769 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
24770 The later option disables @code{pragma pointer_size}.
24771 @end table
24773 @node VxWorks Options
24774 @subsection VxWorks Options
24775 @cindex VxWorks Options
24777 The options in this section are defined for all VxWorks targets.
24778 Options specific to the target hardware are listed with the other
24779 options for that target.
24781 @table @gcctabopt
24782 @item -mrtp
24783 @opindex mrtp
24784 GCC can generate code for both VxWorks kernels and real time processes
24785 (RTPs).  This option switches from the former to the latter.  It also
24786 defines the preprocessor macro @code{__RTP__}.
24788 @item -non-static
24789 @opindex non-static
24790 Link an RTP executable against shared libraries rather than static
24791 libraries.  The options @option{-static} and @option{-shared} can
24792 also be used for RTPs (@pxref{Link Options}); @option{-static}
24793 is the default.
24795 @item -Bstatic
24796 @itemx -Bdynamic
24797 @opindex Bstatic
24798 @opindex Bdynamic
24799 These options are passed down to the linker.  They are defined for
24800 compatibility with Diab.
24802 @item -Xbind-lazy
24803 @opindex Xbind-lazy
24804 Enable lazy binding of function calls.  This option is equivalent to
24805 @option{-Wl,-z,now} and is defined for compatibility with Diab.
24807 @item -Xbind-now
24808 @opindex Xbind-now
24809 Disable lazy binding of function calls.  This option is the default and
24810 is defined for compatibility with Diab.
24811 @end table
24813 @node x86 Options
24814 @subsection x86 Options
24815 @cindex x86 Options
24817 These @samp{-m} options are defined for the x86 family of computers.
24819 @table @gcctabopt
24821 @item -march=@var{cpu-type}
24822 @opindex march
24823 Generate instructions for the machine type @var{cpu-type}.  In contrast to
24824 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
24825 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
24826 to generate code that may not run at all on processors other than the one
24827 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
24828 @option{-mtune=@var{cpu-type}}.
24830 The choices for @var{cpu-type} are:
24832 @table @samp
24833 @item native
24834 This selects the CPU to generate code for at compilation time by determining
24835 the processor type of the compiling machine.  Using @option{-march=native}
24836 enables all instruction subsets supported by the local machine (hence
24837 the result might not run on different machines).  Using @option{-mtune=native}
24838 produces code optimized for the local machine under the constraints
24839 of the selected instruction set.  
24841 @item i386
24842 Original Intel i386 CPU@.
24844 @item i486
24845 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
24847 @item i586
24848 @itemx pentium
24849 Intel Pentium CPU with no MMX support.
24851 @item lakemont
24852 Intel Lakemont MCU, based on Intel Pentium CPU.
24854 @item pentium-mmx
24855 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
24857 @item pentiumpro
24858 Intel Pentium Pro CPU@.
24860 @item i686
24861 When used with @option{-march}, the Pentium Pro
24862 instruction set is used, so the code runs on all i686 family chips.
24863 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
24865 @item pentium2
24866 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
24867 support.
24869 @item pentium3
24870 @itemx pentium3m
24871 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
24872 set support.
24874 @item pentium-m
24875 Intel Pentium M; low-power version of Intel Pentium III CPU
24876 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
24878 @item pentium4
24879 @itemx pentium4m
24880 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
24882 @item prescott
24883 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
24884 set support.
24886 @item nocona
24887 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
24888 SSE2 and SSE3 instruction set support.
24890 @item core2
24891 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
24892 instruction set support.
24894 @item nehalem
24895 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
24896 SSE4.1, SSE4.2 and POPCNT instruction set support.
24898 @item westmere
24899 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
24900 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
24902 @item sandybridge
24903 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
24904 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
24906 @item ivybridge
24907 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
24908 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
24909 instruction set support.
24911 @item haswell
24912 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
24913 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24914 BMI, BMI2 and F16C instruction set support.
24916 @item broadwell
24917 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
24918 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24919 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
24921 @item skylake
24922 Intel Skylake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
24923 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24924 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC and
24925 XSAVES instruction set support.
24927 @item bonnell
24928 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
24929 instruction set support.
24931 @item silvermont
24932 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
24933 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
24935 @item knl
24936 Intel Knight's Landing CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
24937 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24938 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER and
24939 AVX512CD instruction set support.
24941 @item skylake-avx512
24942 Intel Skylake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
24943 SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24944 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F,
24945 AVX512VL, AVX512BW, AVX512DQ and AVX512CD instruction set support.
24947 @item k6
24948 AMD K6 CPU with MMX instruction set support.
24950 @item k6-2
24951 @itemx k6-3
24952 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
24954 @item athlon
24955 @itemx athlon-tbird
24956 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
24957 support.
24959 @item athlon-4
24960 @itemx athlon-xp
24961 @itemx athlon-mp
24962 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
24963 instruction set support.
24965 @item k8
24966 @itemx opteron
24967 @itemx athlon64
24968 @itemx athlon-fx
24969 Processors based on the AMD K8 core with x86-64 instruction set support,
24970 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
24971 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
24972 instruction set extensions.)
24974 @item k8-sse3
24975 @itemx opteron-sse3
24976 @itemx athlon64-sse3
24977 Improved versions of AMD K8 cores with SSE3 instruction set support.
24979 @item amdfam10
24980 @itemx barcelona
24981 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
24982 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
24983 instruction set extensions.)
24985 @item bdver1
24986 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
24987 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
24988 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
24989 @item bdver2
24990 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
24991 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
24992 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
24993 extensions.)
24994 @item bdver3
24995 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
24996 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
24997 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
24998 64-bit instruction set extensions.
24999 @item bdver4
25000 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
25001 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
25002 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
25003 SSE4.2, ABM and 64-bit instruction set extensions.
25005 @item znver1
25006 AMD Family 17h core based CPUs with x86-64 instruction set support.  (This
25007 supersets BMI, BMI2, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX,
25008 SHA, CLZERO, AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3,
25009 SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, and 64-bit
25010 instruction set extensions.
25012 @item btver1
25013 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
25014 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
25015 instruction set extensions.)
25017 @item btver2
25018 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
25019 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
25020 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
25022 @item winchip-c6
25023 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
25024 set support.
25026 @item winchip2
25027 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
25028 instruction set support.
25030 @item c3
25031 VIA C3 CPU with MMX and 3DNow!@: instruction set support.
25032 (No scheduling is implemented for this chip.)
25034 @item c3-2
25035 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
25036 (No scheduling is implemented for this chip.)
25038 @item c7
25039 VIA C7 (Esther) CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
25040 (No scheduling is implemented for this chip.)
25042 @item samuel-2
25043 VIA Eden Samuel 2 CPU with MMX and 3DNow!@: instruction set support.
25044 (No scheduling is implemented for this chip.)
25046 @item nehemiah
25047 VIA Eden Nehemiah CPU with MMX and SSE instruction set support.
25048 (No scheduling is implemented for this chip.)
25050 @item esther
25051 VIA Eden Esther CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
25052 (No scheduling is implemented for this chip.)
25054 @item eden-x2
25055 VIA Eden X2 CPU with x86-64, MMX, SSE, SSE2 and SSE3 instruction set support.
25056 (No scheduling is implemented for this chip.)
25058 @item eden-x4
25059 VIA Eden X4 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2,
25060 AVX and AVX2 instruction set support.
25061 (No scheduling is implemented for this chip.)
25063 @item nano
25064 Generic VIA Nano CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
25065 instruction set support.
25066 (No scheduling is implemented for this chip.)
25068 @item nano-1000
25069 VIA Nano 1xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
25070 instruction set support.
25071 (No scheduling is implemented for this chip.)
25073 @item nano-2000
25074 VIA Nano 2xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
25075 instruction set support.
25076 (No scheduling is implemented for this chip.)
25078 @item nano-3000
25079 VIA Nano 3xxx CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
25080 instruction set support.
25081 (No scheduling is implemented for this chip.)
25083 @item nano-x2
25084 VIA Nano Dual Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
25085 instruction set support.
25086 (No scheduling is implemented for this chip.)
25088 @item nano-x4
25089 VIA Nano Quad Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
25090 instruction set support.
25091 (No scheduling is implemented for this chip.)
25093 @item geode
25094 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
25095 @end table
25097 @item -mtune=@var{cpu-type}
25098 @opindex mtune
25099 Tune to @var{cpu-type} everything applicable about the generated code, except
25100 for the ABI and the set of available instructions.  
25101 While picking a specific @var{cpu-type} schedules things appropriately
25102 for that particular chip, the compiler does not generate any code that
25103 cannot run on the default machine type unless you use a
25104 @option{-march=@var{cpu-type}} option.
25105 For example, if GCC is configured for i686-pc-linux-gnu
25106 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
25107 but still runs on i686 machines.
25109 The choices for @var{cpu-type} are the same as for @option{-march}.
25110 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
25112 @table @samp
25113 @item generic
25114 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
25115 If you know the CPU on which your code will run, then you should use
25116 the corresponding @option{-mtune} or @option{-march} option instead of
25117 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
25118 of your application will have, then you should use this option.
25120 As new processors are deployed in the marketplace, the behavior of this
25121 option will change.  Therefore, if you upgrade to a newer version of
25122 GCC, code generation controlled by this option will change to reflect
25123 the processors
25124 that are most common at the time that version of GCC is released.
25126 There is no @option{-march=generic} option because @option{-march}
25127 indicates the instruction set the compiler can use, and there is no
25128 generic instruction set applicable to all processors.  In contrast,
25129 @option{-mtune} indicates the processor (or, in this case, collection of
25130 processors) for which the code is optimized.
25132 @item intel
25133 Produce code optimized for the most current Intel processors, which are
25134 Haswell and Silvermont for this version of GCC.  If you know the CPU
25135 on which your code will run, then you should use the corresponding
25136 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
25137 But, if you want your application performs better on both Haswell and
25138 Silvermont, then you should use this option.
25140 As new Intel processors are deployed in the marketplace, the behavior of
25141 this option will change.  Therefore, if you upgrade to a newer version of
25142 GCC, code generation controlled by this option will change to reflect
25143 the most current Intel processors at the time that version of GCC is
25144 released.
25146 There is no @option{-march=intel} option because @option{-march} indicates
25147 the instruction set the compiler can use, and there is no common
25148 instruction set applicable to all processors.  In contrast,
25149 @option{-mtune} indicates the processor (or, in this case, collection of
25150 processors) for which the code is optimized.
25151 @end table
25153 @item -mcpu=@var{cpu-type}
25154 @opindex mcpu
25155 A deprecated synonym for @option{-mtune}.
25157 @item -mfpmath=@var{unit}
25158 @opindex mfpmath
25159 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
25160 for @var{unit} are:
25162 @table @samp
25163 @item 387
25164 Use the standard 387 floating-point coprocessor present on the majority of chips and
25165 emulated otherwise.  Code compiled with this option runs almost everywhere.
25166 The temporary results are computed in 80-bit precision instead of the precision
25167 specified by the type, resulting in slightly different results compared to most
25168 of other chips.  See @option{-ffloat-store} for more detailed description.
25170 This is the default choice for non-Darwin x86-32 targets.
25172 @item sse
25173 Use scalar floating-point instructions present in the SSE instruction set.
25174 This instruction set is supported by Pentium III and newer chips,
25175 and in the AMD line
25176 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
25177 instruction set supports only single-precision arithmetic, thus the double and
25178 extended-precision arithmetic are still done using 387.  A later version, present
25179 only in Pentium 4 and AMD x86-64 chips, supports double-precision
25180 arithmetic too.
25182 For the x86-32 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
25183 or @option{-msse2} switches to enable SSE extensions and make this option
25184 effective.  For the x86-64 compiler, these extensions are enabled by default.
25186 The resulting code should be considerably faster in the majority of cases and avoid
25187 the numerical instability problems of 387 code, but may break some existing
25188 code that expects temporaries to be 80 bits.
25190 This is the default choice for the x86-64 compiler, Darwin x86-32 targets,
25191 and the default choice for x86-32 targets with the SSE2 instruction set
25192 when @option{-ffast-math} is enabled.
25194 @item sse,387
25195 @itemx sse+387
25196 @itemx both
25197 Attempt to utilize both instruction sets at once.  This effectively doubles the
25198 amount of available registers, and on chips with separate execution units for
25199 387 and SSE the execution resources too.  Use this option with care, as it is
25200 still experimental, because the GCC register allocator does not model separate
25201 functional units well, resulting in unstable performance.
25202 @end table
25204 @item -masm=@var{dialect}
25205 @opindex masm=@var{dialect}
25206 Output assembly instructions using selected @var{dialect}.  Also affects
25207 which dialect is used for basic @code{asm} (@pxref{Basic Asm}) and
25208 extended @code{asm} (@pxref{Extended Asm}). Supported choices (in dialect
25209 order) are @samp{att} or @samp{intel}. The default is @samp{att}. Darwin does
25210 not support @samp{intel}.
25212 @item -mieee-fp
25213 @itemx -mno-ieee-fp
25214 @opindex mieee-fp
25215 @opindex mno-ieee-fp
25216 Control whether or not the compiler uses IEEE floating-point
25217 comparisons.  These correctly handle the case where the result of a
25218 comparison is unordered.
25220 @item -m80387
25221 @item -mhard-float
25222 @opindex 80387
25223 @opindex mhard-float
25224 Generate output containing 80387 instructions for floating point.
25226 @item -mno-80387
25227 @item -msoft-float
25228 @opindex no-80387
25229 @opindex msoft-float
25230 Generate output containing library calls for floating point.
25232 @strong{Warning:} the requisite libraries are not part of GCC@.
25233 Normally the facilities of the machine's usual C compiler are used, but
25234 this cannot be done directly in cross-compilation.  You must make your
25235 own arrangements to provide suitable library functions for
25236 cross-compilation.
25238 On machines where a function returns floating-point results in the 80387
25239 register stack, some floating-point opcodes may be emitted even if
25240 @option{-msoft-float} is used.
25242 @item -mno-fp-ret-in-387
25243 @opindex mno-fp-ret-in-387
25244 Do not use the FPU registers for return values of functions.
25246 The usual calling convention has functions return values of types
25247 @code{float} and @code{double} in an FPU register, even if there
25248 is no FPU@.  The idea is that the operating system should emulate
25249 an FPU@.
25251 The option @option{-mno-fp-ret-in-387} causes such values to be returned
25252 in ordinary CPU registers instead.
25254 @item -mno-fancy-math-387
25255 @opindex mno-fancy-math-387
25256 Some 387 emulators do not support the @code{sin}, @code{cos} and
25257 @code{sqrt} instructions for the 387.  Specify this option to avoid
25258 generating those instructions.  This option is the default on
25259 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
25260 indicates that the target CPU always has an FPU and so the
25261 instruction does not need emulation.  These
25262 instructions are not generated unless you also use the
25263 @option{-funsafe-math-optimizations} switch.
25265 @item -malign-double
25266 @itemx -mno-align-double
25267 @opindex malign-double
25268 @opindex mno-align-double
25269 Control whether GCC aligns @code{double}, @code{long double}, and
25270 @code{long long} variables on a two-word boundary or a one-word
25271 boundary.  Aligning @code{double} variables on a two-word boundary
25272 produces code that runs somewhat faster on a Pentium at the
25273 expense of more memory.
25275 On x86-64, @option{-malign-double} is enabled by default.
25277 @strong{Warning:} if you use the @option{-malign-double} switch,
25278 structures containing the above types are aligned differently than
25279 the published application binary interface specifications for the x86-32
25280 and are not binary compatible with structures in code compiled
25281 without that switch.
25283 @item -m96bit-long-double
25284 @itemx -m128bit-long-double
25285 @opindex m96bit-long-double
25286 @opindex m128bit-long-double
25287 These switches control the size of @code{long double} type.  The x86-32
25288 application binary interface specifies the size to be 96 bits,
25289 so @option{-m96bit-long-double} is the default in 32-bit mode.
25291 Modern architectures (Pentium and newer) prefer @code{long double}
25292 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
25293 conforming to the ABI, this is not possible.  So specifying
25294 @option{-m128bit-long-double} aligns @code{long double}
25295 to a 16-byte boundary by padding the @code{long double} with an additional
25296 32-bit zero.
25298 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
25299 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
25301 Notice that neither of these options enable any extra precision over the x87
25302 standard of 80 bits for a @code{long double}.
25304 @strong{Warning:} if you override the default value for your target ABI, this
25305 changes the size of 
25306 structures and arrays containing @code{long double} variables,
25307 as well as modifying the function calling convention for functions taking
25308 @code{long double}.  Hence they are not binary-compatible
25309 with code compiled without that switch.
25311 @item -mlong-double-64
25312 @itemx -mlong-double-80
25313 @itemx -mlong-double-128
25314 @opindex mlong-double-64
25315 @opindex mlong-double-80
25316 @opindex mlong-double-128
25317 These switches control the size of @code{long double} type. A size
25318 of 64 bits makes the @code{long double} type equivalent to the @code{double}
25319 type. This is the default for 32-bit Bionic C library.  A size
25320 of 128 bits makes the @code{long double} type equivalent to the
25321 @code{__float128} type. This is the default for 64-bit Bionic C library.
25323 @strong{Warning:} if you override the default value for your target ABI, this
25324 changes the size of
25325 structures and arrays containing @code{long double} variables,
25326 as well as modifying the function calling convention for functions taking
25327 @code{long double}.  Hence they are not binary-compatible
25328 with code compiled without that switch.
25330 @item -malign-data=@var{type}
25331 @opindex malign-data
25332 Control how GCC aligns variables.  Supported values for @var{type} are
25333 @samp{compat} uses increased alignment value compatible uses GCC 4.8
25334 and earlier, @samp{abi} uses alignment value as specified by the
25335 psABI, and @samp{cacheline} uses increased alignment value to match
25336 the cache line size.  @samp{compat} is the default.
25338 @item -mlarge-data-threshold=@var{threshold}
25339 @opindex mlarge-data-threshold
25340 When @option{-mcmodel=medium} is specified, data objects larger than
25341 @var{threshold} are placed in the large data section.  This value must be the
25342 same across all objects linked into the binary, and defaults to 65535.
25344 @item -mrtd
25345 @opindex mrtd
25346 Use a different function-calling convention, in which functions that
25347 take a fixed number of arguments return with the @code{ret @var{num}}
25348 instruction, which pops their arguments while returning.  This saves one
25349 instruction in the caller since there is no need to pop the arguments
25350 there.
25352 You can specify that an individual function is called with this calling
25353 sequence with the function attribute @code{stdcall}.  You can also
25354 override the @option{-mrtd} option by using the function attribute
25355 @code{cdecl}.  @xref{Function Attributes}.
25357 @strong{Warning:} this calling convention is incompatible with the one
25358 normally used on Unix, so you cannot use it if you need to call
25359 libraries compiled with the Unix compiler.
25361 Also, you must provide function prototypes for all functions that
25362 take variable numbers of arguments (including @code{printf});
25363 otherwise incorrect code is generated for calls to those
25364 functions.
25366 In addition, seriously incorrect code results if you call a
25367 function with too many arguments.  (Normally, extra arguments are
25368 harmlessly ignored.)
25370 @item -mregparm=@var{num}
25371 @opindex mregparm
25372 Control how many registers are used to pass integer arguments.  By
25373 default, no registers are used to pass arguments, and at most 3
25374 registers can be used.  You can control this behavior for a specific
25375 function by using the function attribute @code{regparm}.
25376 @xref{Function Attributes}.
25378 @strong{Warning:} if you use this switch, and
25379 @var{num} is nonzero, then you must build all modules with the same
25380 value, including any libraries.  This includes the system libraries and
25381 startup modules.
25383 @item -msseregparm
25384 @opindex msseregparm
25385 Use SSE register passing conventions for float and double arguments
25386 and return values.  You can control this behavior for a specific
25387 function by using the function attribute @code{sseregparm}.
25388 @xref{Function Attributes}.
25390 @strong{Warning:} if you use this switch then you must build all
25391 modules with the same value, including any libraries.  This includes
25392 the system libraries and startup modules.
25394 @item -mvect8-ret-in-mem
25395 @opindex mvect8-ret-in-mem
25396 Return 8-byte vectors in memory instead of MMX registers.  This is the
25397 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
25398 Studio compilers until version 12.  Later compiler versions (starting
25399 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
25400 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
25401 you need to remain compatible with existing code produced by those
25402 previous compiler versions or older versions of GCC@.
25404 @item -mpc32
25405 @itemx -mpc64
25406 @itemx -mpc80
25407 @opindex mpc32
25408 @opindex mpc64
25409 @opindex mpc80
25411 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
25412 is specified, the significands of results of floating-point operations are
25413 rounded to 24 bits (single precision); @option{-mpc64} rounds the
25414 significands of results of floating-point operations to 53 bits (double
25415 precision) and @option{-mpc80} rounds the significands of results of
25416 floating-point operations to 64 bits (extended double precision), which is
25417 the default.  When this option is used, floating-point operations in higher
25418 precisions are not available to the programmer without setting the FPU
25419 control word explicitly.
25421 Setting the rounding of floating-point operations to less than the default
25422 80 bits can speed some programs by 2% or more.  Note that some mathematical
25423 libraries assume that extended-precision (80-bit) floating-point operations
25424 are enabled by default; routines in such libraries could suffer significant
25425 loss of accuracy, typically through so-called ``catastrophic cancellation'',
25426 when this option is used to set the precision to less than extended precision.
25428 @item -mstackrealign
25429 @opindex mstackrealign
25430 Realign the stack at entry.  On the x86, the @option{-mstackrealign}
25431 option generates an alternate prologue and epilogue that realigns the
25432 run-time stack if necessary.  This supports mixing legacy codes that keep
25433 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
25434 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
25435 applicable to individual functions.
25437 @item -mpreferred-stack-boundary=@var{num}
25438 @opindex mpreferred-stack-boundary
25439 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
25440 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
25441 the default is 4 (16 bytes or 128 bits).
25443 @strong{Warning:} When generating code for the x86-64 architecture with
25444 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
25445 used to keep the stack boundary aligned to 8 byte boundary.  Since
25446 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
25447 intended to be used in controlled environment where stack space is
25448 important limitation.  This option leads to wrong code when functions
25449 compiled with 16 byte stack alignment (such as functions from a standard
25450 library) are called with misaligned stack.  In this case, SSE
25451 instructions may lead to misaligned memory access traps.  In addition,
25452 variable arguments are handled incorrectly for 16 byte aligned
25453 objects (including x87 long double and __int128), leading to wrong
25454 results.  You must build all modules with
25455 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
25456 includes the system libraries and startup modules.
25458 @item -mincoming-stack-boundary=@var{num}
25459 @opindex mincoming-stack-boundary
25460 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
25461 boundary.  If @option{-mincoming-stack-boundary} is not specified,
25462 the one specified by @option{-mpreferred-stack-boundary} is used.
25464 On Pentium and Pentium Pro, @code{double} and @code{long double} values
25465 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
25466 suffer significant run time performance penalties.  On Pentium III, the
25467 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
25468 properly if it is not 16-byte aligned.
25470 To ensure proper alignment of this values on the stack, the stack boundary
25471 must be as aligned as that required by any value stored on the stack.
25472 Further, every function must be generated such that it keeps the stack
25473 aligned.  Thus calling a function compiled with a higher preferred
25474 stack boundary from a function compiled with a lower preferred stack
25475 boundary most likely misaligns the stack.  It is recommended that
25476 libraries that use callbacks always use the default setting.
25478 This extra alignment does consume extra stack space, and generally
25479 increases code size.  Code that is sensitive to stack space usage, such
25480 as embedded systems and operating system kernels, may want to reduce the
25481 preferred alignment to @option{-mpreferred-stack-boundary=2}.
25483 @need 200
25484 @item -mmmx
25485 @opindex mmmx
25486 @need 200
25487 @itemx -msse
25488 @opindex msse
25489 @need 200
25490 @itemx -msse2
25491 @opindex msse2
25492 @need 200
25493 @itemx -msse3
25494 @opindex msse3
25495 @need 200
25496 @itemx -mssse3
25497 @opindex mssse3
25498 @need 200
25499 @itemx -msse4
25500 @opindex msse4
25501 @need 200
25502 @itemx -msse4a
25503 @opindex msse4a
25504 @need 200
25505 @itemx -msse4.1
25506 @opindex msse4.1
25507 @need 200
25508 @itemx -msse4.2
25509 @opindex msse4.2
25510 @need 200
25511 @itemx -mavx
25512 @opindex mavx
25513 @need 200
25514 @itemx -mavx2
25515 @opindex mavx2
25516 @need 200
25517 @itemx -mavx512f
25518 @opindex mavx512f
25519 @need 200
25520 @itemx -mavx512pf
25521 @opindex mavx512pf
25522 @need 200
25523 @itemx -mavx512er
25524 @opindex mavx512er
25525 @need 200
25526 @itemx -mavx512cd
25527 @opindex mavx512cd
25528 @need 200
25529 @itemx -mavx512vl
25530 @opindex mavx512vl
25531 @need 200
25532 @itemx -mavx512bw
25533 @opindex mavx512bw
25534 @need 200
25535 @itemx -mavx512dq
25536 @opindex mavx512dq
25537 @need 200
25538 @itemx -mavx512ifma
25539 @opindex mavx512ifma
25540 @need 200
25541 @itemx -mavx512vbmi
25542 @opindex mavx512vbmi
25543 @need 200
25544 @itemx -msha
25545 @opindex msha
25546 @need 200
25547 @itemx -maes
25548 @opindex maes
25549 @need 200
25550 @itemx -mpclmul
25551 @opindex mpclmul
25552 @need 200
25553 @itemx -mclfushopt
25554 @opindex mclfushopt
25555 @need 200
25556 @itemx -mfsgsbase
25557 @opindex mfsgsbase
25558 @need 200
25559 @itemx -mrdrnd
25560 @opindex mrdrnd
25561 @need 200
25562 @itemx -mf16c
25563 @opindex mf16c
25564 @need 200
25565 @itemx -mfma
25566 @opindex mfma
25567 @need 200
25568 @itemx -mfma4
25569 @opindex mfma4
25570 @need 200
25571 @itemx -mprefetchwt1
25572 @opindex mprefetchwt1
25573 @need 200
25574 @itemx -mxop
25575 @opindex mxop
25576 @need 200
25577 @itemx -mlwp
25578 @opindex mlwp
25579 @need 200
25580 @itemx -m3dnow
25581 @opindex m3dnow
25582 @need 200
25583 @itemx -m3dnowa
25584 @opindex m3dnowa
25585 @need 200
25586 @itemx -mpopcnt
25587 @opindex mpopcnt
25588 @need 200
25589 @itemx -mabm
25590 @opindex mabm
25591 @need 200
25592 @itemx -mbmi
25593 @opindex mbmi
25594 @need 200
25595 @itemx -mbmi2
25596 @need 200
25597 @itemx -mlzcnt
25598 @opindex mlzcnt
25599 @need 200
25600 @itemx -mfxsr
25601 @opindex mfxsr
25602 @need 200
25603 @itemx -mxsave
25604 @opindex mxsave
25605 @need 200
25606 @itemx -mxsaveopt
25607 @opindex mxsaveopt
25608 @need 200
25609 @itemx -mxsavec
25610 @opindex mxsavec
25611 @need 200
25612 @itemx -mxsaves
25613 @opindex mxsaves
25614 @need 200
25615 @itemx -mrtm
25616 @opindex mrtm
25617 @need 200
25618 @itemx -mtbm
25619 @opindex mtbm
25620 @need 200
25621 @itemx -mmpx
25622 @opindex mmpx
25623 @need 200
25624 @itemx -mmwaitx
25625 @opindex mmwaitx
25626 @need 200
25627 @itemx -mclzero
25628 @opindex mclzero
25629 @itemx -mpku
25630 @opindex mpku
25631 These switches enable the use of instructions in the MMX, SSE,
25632 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
25633 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
25634 AVX512VL, AVX512BW, AVX512DQ, AVX512IFMA AVX512VBMI, BMI, BMI2, FXSR,
25635 XSAVE, XSAVEOPT, LZCNT, RTM, MPX, MWAITX, PKU, 3DNow!@: or enhanced 3DNow!@:
25636 extended instruction sets.  Each has a corresponding @option{-mno-} option
25637 to disable use of these instructions.
25639 These extensions are also available as built-in functions: see
25640 @ref{x86 Built-in Functions}, for details of the functions enabled and
25641 disabled by these switches.
25643 To generate SSE/SSE2 instructions automatically from floating-point
25644 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
25646 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
25647 generates new AVX instructions or AVX equivalence for all SSEx instructions
25648 when needed.
25650 These options enable GCC to use these extended instructions in
25651 generated code, even without @option{-mfpmath=sse}.  Applications that
25652 perform run-time CPU detection must compile separate files for each
25653 supported architecture, using the appropriate flags.  In particular,
25654 the file containing the CPU detection code should be compiled without
25655 these options.
25657 @item -mdump-tune-features
25658 @opindex mdump-tune-features
25659 This option instructs GCC to dump the names of the x86 performance 
25660 tuning features and default settings. The names can be used in 
25661 @option{-mtune-ctrl=@var{feature-list}}.
25663 @item -mtune-ctrl=@var{feature-list}
25664 @opindex mtune-ctrl=@var{feature-list}
25665 This option is used to do fine grain control of x86 code generation features.
25666 @var{feature-list} is a comma separated list of @var{feature} names. See also
25667 @option{-mdump-tune-features}. When specified, the @var{feature} is turned
25668 on if it is not preceded with @samp{^}, otherwise, it is turned off. 
25669 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
25670 developers. Using it may lead to code paths not covered by testing and can
25671 potentially result in compiler ICEs or runtime errors.
25673 @item -mno-default
25674 @opindex mno-default
25675 This option instructs GCC to turn off all tunable features. See also 
25676 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
25678 @item -mcld
25679 @opindex mcld
25680 This option instructs GCC to emit a @code{cld} instruction in the prologue
25681 of functions that use string instructions.  String instructions depend on
25682 the DF flag to select between autoincrement or autodecrement mode.  While the
25683 ABI specifies the DF flag to be cleared on function entry, some operating
25684 systems violate this specification by not clearing the DF flag in their
25685 exception dispatchers.  The exception handler can be invoked with the DF flag
25686 set, which leads to wrong direction mode when string instructions are used.
25687 This option can be enabled by default on 32-bit x86 targets by configuring
25688 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
25689 instructions can be suppressed with the @option{-mno-cld} compiler option
25690 in this case.
25692 @item -mvzeroupper
25693 @opindex mvzeroupper
25694 This option instructs GCC to emit a @code{vzeroupper} instruction
25695 before a transfer of control flow out of the function to minimize
25696 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
25697 intrinsics.
25699 @item -mprefer-avx128
25700 @opindex mprefer-avx128
25701 This option instructs GCC to use 128-bit AVX instructions instead of
25702 256-bit AVX instructions in the auto-vectorizer.
25704 @item -mcx16
25705 @opindex mcx16
25706 This option enables GCC to generate @code{CMPXCHG16B} instructions in 64-bit
25707 code to implement compare-and-exchange operations on 16-byte aligned 128-bit
25708 objects.  This is useful for atomic updates of data structures exceeding one
25709 machine word in size.  The compiler uses this instruction to implement
25710 @ref{__sync Builtins}.  However, for @ref{__atomic Builtins} operating on
25711 128-bit integers, a library call is always used.
25713 @item -msahf
25714 @opindex msahf
25715 This option enables generation of @code{SAHF} instructions in 64-bit code.
25716 Early Intel Pentium 4 CPUs with Intel 64 support,
25717 prior to the introduction of Pentium 4 G1 step in December 2005,
25718 lacked the @code{LAHF} and @code{SAHF} instructions
25719 which are supported by AMD64.
25720 These are load and store instructions, respectively, for certain status flags.
25721 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
25722 @code{drem}, and @code{remainder} built-in functions;
25723 see @ref{Other Builtins} for details.
25725 @item -mmovbe
25726 @opindex mmovbe
25727 This option enables use of the @code{movbe} instruction to implement
25728 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
25730 @item -mcrc32
25731 @opindex mcrc32
25732 This option enables built-in functions @code{__builtin_ia32_crc32qi},
25733 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
25734 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
25736 @item -mrecip
25737 @opindex mrecip
25738 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
25739 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
25740 with an additional Newton-Raphson step
25741 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
25742 (and their vectorized
25743 variants) for single-precision floating-point arguments.  These instructions
25744 are generated only when @option{-funsafe-math-optimizations} is enabled
25745 together with @option{-ffinite-math-only} and @option{-fno-trapping-math}.
25746 Note that while the throughput of the sequence is higher than the throughput
25747 of the non-reciprocal instruction, the precision of the sequence can be
25748 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
25750 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
25751 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
25752 combination), and doesn't need @option{-mrecip}.
25754 Also note that GCC emits the above sequence with additional Newton-Raphson step
25755 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
25756 already with @option{-ffast-math} (or the above option combination), and
25757 doesn't need @option{-mrecip}.
25759 @item -mrecip=@var{opt}
25760 @opindex mrecip=opt
25761 This option controls which reciprocal estimate instructions
25762 may be used.  @var{opt} is a comma-separated list of options, which may
25763 be preceded by a @samp{!} to invert the option:
25765 @table @samp
25766 @item all
25767 Enable all estimate instructions.
25769 @item default
25770 Enable the default instructions, equivalent to @option{-mrecip}.
25772 @item none
25773 Disable all estimate instructions, equivalent to @option{-mno-recip}.
25775 @item div
25776 Enable the approximation for scalar division.
25778 @item vec-div
25779 Enable the approximation for vectorized division.
25781 @item sqrt
25782 Enable the approximation for scalar square root.
25784 @item vec-sqrt
25785 Enable the approximation for vectorized square root.
25786 @end table
25788 So, for example, @option{-mrecip=all,!sqrt} enables
25789 all of the reciprocal approximations, except for square root.
25791 @item -mveclibabi=@var{type}
25792 @opindex mveclibabi
25793 Specifies the ABI type to use for vectorizing intrinsics using an
25794 external library.  Supported values for @var{type} are @samp{svml} 
25795 for the Intel short
25796 vector math library and @samp{acml} for the AMD math core library.
25797 To use this option, both @option{-ftree-vectorize} and
25798 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
25799 ABI-compatible library must be specified at link time.
25801 GCC currently emits calls to @code{vmldExp2},
25802 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
25803 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
25804 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
25805 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
25806 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
25807 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
25808 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
25809 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
25810 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
25811 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
25812 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
25813 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
25814 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
25815 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
25816 when @option{-mveclibabi=acml} is used.  
25818 @item -mabi=@var{name}
25819 @opindex mabi
25820 Generate code for the specified calling convention.  Permissible values
25821 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
25822 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
25823 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
25824 You can control this behavior for specific functions by
25825 using the function attributes @code{ms_abi} and @code{sysv_abi}.
25826 @xref{Function Attributes}.
25828 @item -mcall-ms2sysv-xlogues
25829 @opindex mcall-ms2sysv-xlogues
25830 @opindex mno-call-ms2sysv-xlogues
25831 Due to differences in 64-bit ABIs, any Microsoft ABI function that calls a
25832 System V ABI function must consider RSI, RDI and XMM6-15 as clobbered.  By
25833 default, the code for saving and restoring these registers is emitted inline,
25834 resulting in fairly lengthy prologues and epilogues.  Using
25835 @option{-mcall-ms2sysv-xlogues} emits prologues and epilogues that
25836 use stubs in the static portion of libgcc to perform these saves and restores,
25837 thus reducing function size at the cost of a few extra instructions.
25839 @item -mtls-dialect=@var{type}
25840 @opindex mtls-dialect
25841 Generate code to access thread-local storage using the @samp{gnu} or
25842 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
25843 @samp{gnu2} is more efficient, but it may add compile- and run-time
25844 requirements that cannot be satisfied on all systems.
25846 @item -mpush-args
25847 @itemx -mno-push-args
25848 @opindex mpush-args
25849 @opindex mno-push-args
25850 Use PUSH operations to store outgoing parameters.  This method is shorter
25851 and usually equally fast as method using SUB/MOV operations and is enabled
25852 by default.  In some cases disabling it may improve performance because of
25853 improved scheduling and reduced dependencies.
25855 @item -maccumulate-outgoing-args
25856 @opindex maccumulate-outgoing-args
25857 If enabled, the maximum amount of space required for outgoing arguments is
25858 computed in the function prologue.  This is faster on most modern CPUs
25859 because of reduced dependencies, improved scheduling and reduced stack usage
25860 when the preferred stack boundary is not equal to 2.  The drawback is a notable
25861 increase in code size.  This switch implies @option{-mno-push-args}.
25863 @item -mthreads
25864 @opindex mthreads
25865 Support thread-safe exception handling on MinGW.  Programs that rely
25866 on thread-safe exception handling must compile and link all code with the
25867 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
25868 @option{-D_MT}; when linking, it links in a special thread helper library
25869 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
25871 @item -mms-bitfields
25872 @itemx -mno-ms-bitfields
25873 @opindex mms-bitfields
25874 @opindex mno-ms-bitfields
25876 Enable/disable bit-field layout compatible with the native Microsoft
25877 Windows compiler.  
25879 If @code{packed} is used on a structure, or if bit-fields are used,
25880 it may be that the Microsoft ABI lays out the structure differently
25881 than the way GCC normally does.  Particularly when moving packed
25882 data between functions compiled with GCC and the native Microsoft compiler
25883 (either via function call or as data in a file), it may be necessary to access
25884 either format.
25886 This option is enabled by default for Microsoft Windows
25887 targets.  This behavior can also be controlled locally by use of variable
25888 or type attributes.  For more information, see @ref{x86 Variable Attributes}
25889 and @ref{x86 Type Attributes}.
25891 The Microsoft structure layout algorithm is fairly simple with the exception
25892 of the bit-field packing.  
25893 The padding and alignment of members of structures and whether a bit-field 
25894 can straddle a storage-unit boundary are determine by these rules:
25896 @enumerate
25897 @item Structure members are stored sequentially in the order in which they are
25898 declared: the first member has the lowest memory address and the last member
25899 the highest.
25901 @item Every data object has an alignment requirement.  The alignment requirement
25902 for all data except structures, unions, and arrays is either the size of the
25903 object or the current packing size (specified with either the
25904 @code{aligned} attribute or the @code{pack} pragma),
25905 whichever is less.  For structures, unions, and arrays,
25906 the alignment requirement is the largest alignment requirement of its members.
25907 Every object is allocated an offset so that:
25909 @smallexample
25910 offset % alignment_requirement == 0
25911 @end smallexample
25913 @item Adjacent bit-fields are packed into the same 1-, 2-, or 4-byte allocation
25914 unit if the integral types are the same size and if the next bit-field fits
25915 into the current allocation unit without crossing the boundary imposed by the
25916 common alignment requirements of the bit-fields.
25917 @end enumerate
25919 MSVC interprets zero-length bit-fields in the following ways:
25921 @enumerate
25922 @item If a zero-length bit-field is inserted between two bit-fields that
25923 are normally coalesced, the bit-fields are not coalesced.
25925 For example:
25927 @smallexample
25928 struct
25929  @{
25930    unsigned long bf_1 : 12;
25931    unsigned long : 0;
25932    unsigned long bf_2 : 12;
25933  @} t1;
25934 @end smallexample
25936 @noindent
25937 The size of @code{t1} is 8 bytes with the zero-length bit-field.  If the
25938 zero-length bit-field were removed, @code{t1}'s size would be 4 bytes.
25940 @item If a zero-length bit-field is inserted after a bit-field, @code{foo}, and the
25941 alignment of the zero-length bit-field is greater than the member that follows it,
25942 @code{bar}, @code{bar} is aligned as the type of the zero-length bit-field.
25944 For example:
25946 @smallexample
25947 struct
25948  @{
25949    char foo : 4;
25950    short : 0;
25951    char bar;
25952  @} t2;
25954 struct
25955  @{
25956    char foo : 4;
25957    short : 0;
25958    double bar;
25959  @} t3;
25960 @end smallexample
25962 @noindent
25963 For @code{t2}, @code{bar} is placed at offset 2, rather than offset 1.
25964 Accordingly, the size of @code{t2} is 4.  For @code{t3}, the zero-length
25965 bit-field does not affect the alignment of @code{bar} or, as a result, the size
25966 of the structure.
25968 Taking this into account, it is important to note the following:
25970 @enumerate
25971 @item If a zero-length bit-field follows a normal bit-field, the type of the
25972 zero-length bit-field may affect the alignment of the structure as whole. For
25973 example, @code{t2} has a size of 4 bytes, since the zero-length bit-field follows a
25974 normal bit-field, and is of type short.
25976 @item Even if a zero-length bit-field is not followed by a normal bit-field, it may
25977 still affect the alignment of the structure:
25979 @smallexample
25980 struct
25981  @{
25982    char foo : 6;
25983    long : 0;
25984  @} t4;
25985 @end smallexample
25987 @noindent
25988 Here, @code{t4} takes up 4 bytes.
25989 @end enumerate
25991 @item Zero-length bit-fields following non-bit-field members are ignored:
25993 @smallexample
25994 struct
25995  @{
25996    char foo;
25997    long : 0;
25998    char bar;
25999  @} t5;
26000 @end smallexample
26002 @noindent
26003 Here, @code{t5} takes up 2 bytes.
26004 @end enumerate
26007 @item -mno-align-stringops
26008 @opindex mno-align-stringops
26009 Do not align the destination of inlined string operations.  This switch reduces
26010 code size and improves performance in case the destination is already aligned,
26011 but GCC doesn't know about it.
26013 @item -minline-all-stringops
26014 @opindex minline-all-stringops
26015 By default GCC inlines string operations only when the destination is 
26016 known to be aligned to least a 4-byte boundary.  
26017 This enables more inlining and increases code
26018 size, but may improve performance of code that depends on fast
26019 @code{memcpy}, @code{strlen},
26020 and @code{memset} for short lengths.
26022 @item -minline-stringops-dynamically
26023 @opindex minline-stringops-dynamically
26024 For string operations of unknown size, use run-time checks with
26025 inline code for small blocks and a library call for large blocks.
26027 @item -mstringop-strategy=@var{alg}
26028 @opindex mstringop-strategy=@var{alg}
26029 Override the internal decision heuristic for the particular algorithm to use
26030 for inlining string operations.  The allowed values for @var{alg} are:
26032 @table @samp
26033 @item rep_byte
26034 @itemx rep_4byte
26035 @itemx rep_8byte
26036 Expand using i386 @code{rep} prefix of the specified size.
26038 @item byte_loop
26039 @itemx loop
26040 @itemx unrolled_loop
26041 Expand into an inline loop.
26043 @item libcall
26044 Always use a library call.
26045 @end table
26047 @item -mmemcpy-strategy=@var{strategy}
26048 @opindex mmemcpy-strategy=@var{strategy}
26049 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
26050 should be inlined and what inline algorithm to use when the expected size
26051 of the copy operation is known. @var{strategy} 
26052 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
26053 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
26054 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
26055 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
26056 in the list must be specified in increasing order.  The minimal byte size for 
26057 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
26058 preceding range.
26060 @item -mmemset-strategy=@var{strategy}
26061 @opindex mmemset-strategy=@var{strategy}
26062 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
26063 @code{__builtin_memset} expansion.
26065 @item -momit-leaf-frame-pointer
26066 @opindex momit-leaf-frame-pointer
26067 Don't keep the frame pointer in a register for leaf functions.  This
26068 avoids the instructions to save, set up, and restore frame pointers and
26069 makes an extra register available in leaf functions.  The option
26070 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
26071 which might make debugging harder.
26073 @item -mtls-direct-seg-refs
26074 @itemx -mno-tls-direct-seg-refs
26075 @opindex mtls-direct-seg-refs
26076 Controls whether TLS variables may be accessed with offsets from the
26077 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
26078 or whether the thread base pointer must be added.  Whether or not this
26079 is valid depends on the operating system, and whether it maps the
26080 segment to cover the entire TLS area.
26082 For systems that use the GNU C Library, the default is on.
26084 @item -msse2avx
26085 @itemx -mno-sse2avx
26086 @opindex msse2avx
26087 Specify that the assembler should encode SSE instructions with VEX
26088 prefix.  The option @option{-mavx} turns this on by default.
26090 @item -mfentry
26091 @itemx -mno-fentry
26092 @opindex mfentry
26093 If profiling is active (@option{-pg}), put the profiling
26094 counter call before the prologue.
26095 Note: On x86 architectures the attribute @code{ms_hook_prologue}
26096 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
26098 @item -mrecord-mcount
26099 @itemx -mno-record-mcount
26100 @opindex mrecord-mcount
26101 If profiling is active (@option{-pg}), generate a __mcount_loc section
26102 that contains pointers to each profiling call. This is useful for
26103 automatically patching and out calls.
26105 @item -mnop-mcount
26106 @itemx -mno-nop-mcount
26107 @opindex mnop-mcount
26108 If profiling is active (@option{-pg}), generate the calls to
26109 the profiling functions as NOPs. This is useful when they
26110 should be patched in later dynamically. This is likely only
26111 useful together with @option{-mrecord-mcount}.
26113 @item -mskip-rax-setup
26114 @itemx -mno-skip-rax-setup
26115 @opindex mskip-rax-setup
26116 When generating code for the x86-64 architecture with SSE extensions
26117 disabled, @option{-mskip-rax-setup} can be used to skip setting up RAX
26118 register when there are no variable arguments passed in vector registers.
26120 @strong{Warning:} Since RAX register is used to avoid unnecessarily
26121 saving vector registers on stack when passing variable arguments, the
26122 impacts of this option are callees may waste some stack space,
26123 misbehave or jump to a random location.  GCC 4.4 or newer don't have
26124 those issues, regardless the RAX register value.
26126 @item -m8bit-idiv
26127 @itemx -mno-8bit-idiv
26128 @opindex m8bit-idiv
26129 On some processors, like Intel Atom, 8-bit unsigned integer divide is
26130 much faster than 32-bit/64-bit integer divide.  This option generates a
26131 run-time check.  If both dividend and divisor are within range of 0
26132 to 255, 8-bit unsigned integer divide is used instead of
26133 32-bit/64-bit integer divide.
26135 @item -mavx256-split-unaligned-load
26136 @itemx -mavx256-split-unaligned-store
26137 @opindex mavx256-split-unaligned-load
26138 @opindex mavx256-split-unaligned-store
26139 Split 32-byte AVX unaligned load and store.
26141 @item -mstack-protector-guard=@var{guard}
26142 @opindex mstack-protector-guard=@var{guard}
26143 Generate stack protection code using canary at @var{guard}.  Supported
26144 locations are @samp{global} for global canary or @samp{tls} for per-thread
26145 canary in the TLS block (the default).  This option has effect only when
26146 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
26148 @item -mmitigate-rop
26149 @opindex mmitigate-rop
26150 Try to avoid generating code sequences that contain unintended return
26151 opcodes, to mitigate against certain forms of attack. At the moment,
26152 this option is limited in what it can do and should not be relied
26153 on to provide serious protection.
26155 @item -mgeneral-regs-only
26156 @opindex mgeneral-regs-only
26157 Generate code that uses only the general-purpose registers.  This
26158 prevents the compiler from using floating-point, vector, mask and bound
26159 registers.
26161 @end table
26163 These @samp{-m} switches are supported in addition to the above
26164 on x86-64 processors in 64-bit environments.
26166 @table @gcctabopt
26167 @item -m32
26168 @itemx -m64
26169 @itemx -mx32
26170 @itemx -m16
26171 @itemx -miamcu
26172 @opindex m32
26173 @opindex m64
26174 @opindex mx32
26175 @opindex m16
26176 @opindex miamcu
26177 Generate code for a 16-bit, 32-bit or 64-bit environment.
26178 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
26179 to 32 bits, and
26180 generates code that runs on any i386 system.
26182 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
26183 types to 64 bits, and generates code for the x86-64 architecture.
26184 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
26185 and @option{-mdynamic-no-pic} options.
26187 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
26188 to 32 bits, and
26189 generates code for the x86-64 architecture.
26191 The @option{-m16} option is the same as @option{-m32}, except for that
26192 it outputs the @code{.code16gcc} assembly directive at the beginning of
26193 the assembly output so that the binary can run in 16-bit mode.
26195 The @option{-miamcu} option generates code which conforms to Intel MCU
26196 psABI.  It requires the @option{-m32} option to be turned on.
26198 @item -mno-red-zone
26199 @opindex mno-red-zone
26200 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
26201 by the x86-64 ABI; it is a 128-byte area beyond the location of the
26202 stack pointer that is not modified by signal or interrupt handlers
26203 and therefore can be used for temporary data without adjusting the stack
26204 pointer.  The flag @option{-mno-red-zone} disables this red zone.
26206 @item -mcmodel=small
26207 @opindex mcmodel=small
26208 Generate code for the small code model: the program and its symbols must
26209 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
26210 Programs can be statically or dynamically linked.  This is the default
26211 code model.
26213 @item -mcmodel=kernel
26214 @opindex mcmodel=kernel
26215 Generate code for the kernel code model.  The kernel runs in the
26216 negative 2 GB of the address space.
26217 This model has to be used for Linux kernel code.
26219 @item -mcmodel=medium
26220 @opindex mcmodel=medium
26221 Generate code for the medium model: the program is linked in the lower 2
26222 GB of the address space.  Small symbols are also placed there.  Symbols
26223 with sizes larger than @option{-mlarge-data-threshold} are put into
26224 large data or BSS sections and can be located above 2GB.  Programs can
26225 be statically or dynamically linked.
26227 @item -mcmodel=large
26228 @opindex mcmodel=large
26229 Generate code for the large model.  This model makes no assumptions
26230 about addresses and sizes of sections.
26232 @item -maddress-mode=long
26233 @opindex maddress-mode=long
26234 Generate code for long address mode.  This is only supported for 64-bit
26235 and x32 environments.  It is the default address mode for 64-bit
26236 environments.
26238 @item -maddress-mode=short
26239 @opindex maddress-mode=short
26240 Generate code for short address mode.  This is only supported for 32-bit
26241 and x32 environments.  It is the default address mode for 32-bit and
26242 x32 environments.
26243 @end table
26245 @node x86 Windows Options
26246 @subsection x86 Windows Options
26247 @cindex x86 Windows Options
26248 @cindex Windows Options for x86
26250 These additional options are available for Microsoft Windows targets:
26252 @table @gcctabopt
26253 @item -mconsole
26254 @opindex mconsole
26255 This option
26256 specifies that a console application is to be generated, by
26257 instructing the linker to set the PE header subsystem type
26258 required for console applications.
26259 This option is available for Cygwin and MinGW targets and is
26260 enabled by default on those targets.
26262 @item -mdll
26263 @opindex mdll
26264 This option is available for Cygwin and MinGW targets.  It
26265 specifies that a DLL---a dynamic link library---is to be
26266 generated, enabling the selection of the required runtime
26267 startup object and entry point.
26269 @item -mnop-fun-dllimport
26270 @opindex mnop-fun-dllimport
26271 This option is available for Cygwin and MinGW targets.  It
26272 specifies that the @code{dllimport} attribute should be ignored.
26274 @item -mthread
26275 @opindex mthread
26276 This option is available for MinGW targets. It specifies
26277 that MinGW-specific thread support is to be used.
26279 @item -municode
26280 @opindex municode
26281 This option is available for MinGW-w64 targets.  It causes
26282 the @code{UNICODE} preprocessor macro to be predefined, and
26283 chooses Unicode-capable runtime startup code.
26285 @item -mwin32
26286 @opindex mwin32
26287 This option is available for Cygwin and MinGW targets.  It
26288 specifies that the typical Microsoft Windows predefined macros are to
26289 be set in the pre-processor, but does not influence the choice
26290 of runtime library/startup code.
26292 @item -mwindows
26293 @opindex mwindows
26294 This option is available for Cygwin and MinGW targets.  It
26295 specifies that a GUI application is to be generated by
26296 instructing the linker to set the PE header subsystem type
26297 appropriately.
26299 @item -fno-set-stack-executable
26300 @opindex fno-set-stack-executable
26301 This option is available for MinGW targets. It specifies that
26302 the executable flag for the stack used by nested functions isn't
26303 set. This is necessary for binaries running in kernel mode of
26304 Microsoft Windows, as there the User32 API, which is used to set executable
26305 privileges, isn't available.
26307 @item -fwritable-relocated-rdata
26308 @opindex fno-writable-relocated-rdata
26309 This option is available for MinGW and Cygwin targets.  It specifies
26310 that relocated-data in read-only section is put into the @code{.data}
26311 section.  This is a necessary for older runtimes not supporting
26312 modification of @code{.rdata} sections for pseudo-relocation.
26314 @item -mpe-aligned-commons
26315 @opindex mpe-aligned-commons
26316 This option is available for Cygwin and MinGW targets.  It
26317 specifies that the GNU extension to the PE file format that
26318 permits the correct alignment of COMMON variables should be
26319 used when generating code.  It is enabled by default if
26320 GCC detects that the target assembler found during configuration
26321 supports the feature.
26322 @end table
26324 See also under @ref{x86 Options} for standard options.
26326 @node Xstormy16 Options
26327 @subsection Xstormy16 Options
26328 @cindex Xstormy16 Options
26330 These options are defined for Xstormy16:
26332 @table @gcctabopt
26333 @item -msim
26334 @opindex msim
26335 Choose startup files and linker script suitable for the simulator.
26336 @end table
26338 @node Xtensa Options
26339 @subsection Xtensa Options
26340 @cindex Xtensa Options
26342 These options are supported for Xtensa targets:
26344 @table @gcctabopt
26345 @item -mconst16
26346 @itemx -mno-const16
26347 @opindex mconst16
26348 @opindex mno-const16
26349 Enable or disable use of @code{CONST16} instructions for loading
26350 constant values.  The @code{CONST16} instruction is currently not a
26351 standard option from Tensilica.  When enabled, @code{CONST16}
26352 instructions are always used in place of the standard @code{L32R}
26353 instructions.  The use of @code{CONST16} is enabled by default only if
26354 the @code{L32R} instruction is not available.
26356 @item -mfused-madd
26357 @itemx -mno-fused-madd
26358 @opindex mfused-madd
26359 @opindex mno-fused-madd
26360 Enable or disable use of fused multiply/add and multiply/subtract
26361 instructions in the floating-point option.  This has no effect if the
26362 floating-point option is not also enabled.  Disabling fused multiply/add
26363 and multiply/subtract instructions forces the compiler to use separate
26364 instructions for the multiply and add/subtract operations.  This may be
26365 desirable in some cases where strict IEEE 754-compliant results are
26366 required: the fused multiply add/subtract instructions do not round the
26367 intermediate result, thereby producing results with @emph{more} bits of
26368 precision than specified by the IEEE standard.  Disabling fused multiply
26369 add/subtract instructions also ensures that the program output is not
26370 sensitive to the compiler's ability to combine multiply and add/subtract
26371 operations.
26373 @item -mserialize-volatile
26374 @itemx -mno-serialize-volatile
26375 @opindex mserialize-volatile
26376 @opindex mno-serialize-volatile
26377 When this option is enabled, GCC inserts @code{MEMW} instructions before
26378 @code{volatile} memory references to guarantee sequential consistency.
26379 The default is @option{-mserialize-volatile}.  Use
26380 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
26382 @item -mforce-no-pic
26383 @opindex mforce-no-pic
26384 For targets, like GNU/Linux, where all user-mode Xtensa code must be
26385 position-independent code (PIC), this option disables PIC for compiling
26386 kernel code.
26388 @item -mtext-section-literals
26389 @itemx -mno-text-section-literals
26390 @opindex mtext-section-literals
26391 @opindex mno-text-section-literals
26392 These options control the treatment of literal pools.  The default is
26393 @option{-mno-text-section-literals}, which places literals in a separate
26394 section in the output file.  This allows the literal pool to be placed
26395 in a data RAM/ROM, and it also allows the linker to combine literal
26396 pools from separate object files to remove redundant literals and
26397 improve code size.  With @option{-mtext-section-literals}, the literals
26398 are interspersed in the text section in order to keep them as close as
26399 possible to their references.  This may be necessary for large assembly
26400 files.  Literals for each function are placed right before that function.
26402 @item -mauto-litpools
26403 @itemx -mno-auto-litpools
26404 @opindex mauto-litpools
26405 @opindex mno-auto-litpools
26406 These options control the treatment of literal pools.  The default is
26407 @option{-mno-auto-litpools}, which places literals in a separate
26408 section in the output file unless @option{-mtext-section-literals} is
26409 used.  With @option{-mauto-litpools} the literals are interspersed in
26410 the text section by the assembler.  Compiler does not produce explicit
26411 @code{.literal} directives and loads literals into registers with
26412 @code{MOVI} instructions instead of @code{L32R} to let the assembler
26413 do relaxation and place literals as necessary.  This option allows
26414 assembler to create several literal pools per function and assemble
26415 very big functions, which may not be possible with
26416 @option{-mtext-section-literals}.
26418 @item -mtarget-align
26419 @itemx -mno-target-align
26420 @opindex mtarget-align
26421 @opindex mno-target-align
26422 When this option is enabled, GCC instructs the assembler to
26423 automatically align instructions to reduce branch penalties at the
26424 expense of some code density.  The assembler attempts to widen density
26425 instructions to align branch targets and the instructions following call
26426 instructions.  If there are not enough preceding safe density
26427 instructions to align a target, no widening is performed.  The
26428 default is @option{-mtarget-align}.  These options do not affect the
26429 treatment of auto-aligned instructions like @code{LOOP}, which the
26430 assembler always aligns, either by widening density instructions or
26431 by inserting NOP instructions.
26433 @item -mlongcalls
26434 @itemx -mno-longcalls
26435 @opindex mlongcalls
26436 @opindex mno-longcalls
26437 When this option is enabled, GCC instructs the assembler to translate
26438 direct calls to indirect calls unless it can determine that the target
26439 of a direct call is in the range allowed by the call instruction.  This
26440 translation typically occurs for calls to functions in other source
26441 files.  Specifically, the assembler translates a direct @code{CALL}
26442 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
26443 The default is @option{-mno-longcalls}.  This option should be used in
26444 programs where the call target can potentially be out of range.  This
26445 option is implemented in the assembler, not the compiler, so the
26446 assembly code generated by GCC still shows direct call
26447 instructions---look at the disassembled object code to see the actual
26448 instructions.  Note that the assembler uses an indirect call for
26449 every cross-file call, not just those that really are out of range.
26450 @end table
26452 @node zSeries Options
26453 @subsection zSeries Options
26454 @cindex zSeries options
26456 These are listed under @xref{S/390 and zSeries Options}.
26459 @c man end
26461 @node Spec Files
26462 @section Specifying Subprocesses and the Switches to Pass to Them
26463 @cindex Spec Files
26465 @command{gcc} is a driver program.  It performs its job by invoking a
26466 sequence of other programs to do the work of compiling, assembling and
26467 linking.  GCC interprets its command-line parameters and uses these to
26468 deduce which programs it should invoke, and which command-line options
26469 it ought to place on their command lines.  This behavior is controlled
26470 by @dfn{spec strings}.  In most cases there is one spec string for each
26471 program that GCC can invoke, but a few programs have multiple spec
26472 strings to control their behavior.  The spec strings built into GCC can
26473 be overridden by using the @option{-specs=} command-line switch to specify
26474 a spec file.
26476 @dfn{Spec files} are plain-text files that are used to construct spec
26477 strings.  They consist of a sequence of directives separated by blank
26478 lines.  The type of directive is determined by the first non-whitespace
26479 character on the line, which can be one of the following:
26481 @table @code
26482 @item %@var{command}
26483 Issues a @var{command} to the spec file processor.  The commands that can
26484 appear here are:
26486 @table @code
26487 @item %include <@var{file}>
26488 @cindex @code{%include}
26489 Search for @var{file} and insert its text at the current point in the
26490 specs file.
26492 @item %include_noerr <@var{file}>
26493 @cindex @code{%include_noerr}
26494 Just like @samp{%include}, but do not generate an error message if the include
26495 file cannot be found.
26497 @item %rename @var{old_name} @var{new_name}
26498 @cindex @code{%rename}
26499 Rename the spec string @var{old_name} to @var{new_name}.
26501 @end table
26503 @item *[@var{spec_name}]:
26504 This tells the compiler to create, override or delete the named spec
26505 string.  All lines after this directive up to the next directive or
26506 blank line are considered to be the text for the spec string.  If this
26507 results in an empty string then the spec is deleted.  (Or, if the
26508 spec did not exist, then nothing happens.)  Otherwise, if the spec
26509 does not currently exist a new spec is created.  If the spec does
26510 exist then its contents are overridden by the text of this
26511 directive, unless the first character of that text is the @samp{+}
26512 character, in which case the text is appended to the spec.
26514 @item [@var{suffix}]:
26515 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
26516 and up to the next directive or blank line are considered to make up the
26517 spec string for the indicated suffix.  When the compiler encounters an
26518 input file with the named suffix, it processes the spec string in
26519 order to work out how to compile that file.  For example:
26521 @smallexample
26522 .ZZ:
26523 z-compile -input %i
26524 @end smallexample
26526 This says that any input file whose name ends in @samp{.ZZ} should be
26527 passed to the program @samp{z-compile}, which should be invoked with the
26528 command-line switch @option{-input} and with the result of performing the
26529 @samp{%i} substitution.  (See below.)
26531 As an alternative to providing a spec string, the text following a
26532 suffix directive can be one of the following:
26534 @table @code
26535 @item @@@var{language}
26536 This says that the suffix is an alias for a known @var{language}.  This is
26537 similar to using the @option{-x} command-line switch to GCC to specify a
26538 language explicitly.  For example:
26540 @smallexample
26541 .ZZ:
26542 @@c++
26543 @end smallexample
26545 Says that .ZZ files are, in fact, C++ source files.
26547 @item #@var{name}
26548 This causes an error messages saying:
26550 @smallexample
26551 @var{name} compiler not installed on this system.
26552 @end smallexample
26553 @end table
26555 GCC already has an extensive list of suffixes built into it.
26556 This directive adds an entry to the end of the list of suffixes, but
26557 since the list is searched from the end backwards, it is effectively
26558 possible to override earlier entries using this technique.
26560 @end table
26562 GCC has the following spec strings built into it.  Spec files can
26563 override these strings or create their own.  Note that individual
26564 targets can also add their own spec strings to this list.
26566 @smallexample
26567 asm          Options to pass to the assembler
26568 asm_final    Options to pass to the assembler post-processor
26569 cpp          Options to pass to the C preprocessor
26570 cc1          Options to pass to the C compiler
26571 cc1plus      Options to pass to the C++ compiler
26572 endfile      Object files to include at the end of the link
26573 link         Options to pass to the linker
26574 lib          Libraries to include on the command line to the linker
26575 libgcc       Decides which GCC support library to pass to the linker
26576 linker       Sets the name of the linker
26577 predefines   Defines to be passed to the C preprocessor
26578 signed_char  Defines to pass to CPP to say whether @code{char} is signed
26579              by default
26580 startfile    Object files to include at the start of the link
26581 @end smallexample
26583 Here is a small example of a spec file:
26585 @smallexample
26586 %rename lib                 old_lib
26588 *lib:
26589 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
26590 @end smallexample
26592 This example renames the spec called @samp{lib} to @samp{old_lib} and
26593 then overrides the previous definition of @samp{lib} with a new one.
26594 The new definition adds in some extra command-line options before
26595 including the text of the old definition.
26597 @dfn{Spec strings} are a list of command-line options to be passed to their
26598 corresponding program.  In addition, the spec strings can contain
26599 @samp{%}-prefixed sequences to substitute variable text or to
26600 conditionally insert text into the command line.  Using these constructs
26601 it is possible to generate quite complex command lines.
26603 Here is a table of all defined @samp{%}-sequences for spec
26604 strings.  Note that spaces are not generated automatically around the
26605 results of expanding these sequences.  Therefore you can concatenate them
26606 together or combine them with constant text in a single argument.
26608 @table @code
26609 @item %%
26610 Substitute one @samp{%} into the program name or argument.
26612 @item %i
26613 Substitute the name of the input file being processed.
26615 @item %b
26616 Substitute the basename of the input file being processed.
26617 This is the substring up to (and not including) the last period
26618 and not including the directory.
26620 @item %B
26621 This is the same as @samp{%b}, but include the file suffix (text after
26622 the last period).
26624 @item %d
26625 Marks the argument containing or following the @samp{%d} as a
26626 temporary file name, so that that file is deleted if GCC exits
26627 successfully.  Unlike @samp{%g}, this contributes no text to the
26628 argument.
26630 @item %g@var{suffix}
26631 Substitute a file name that has suffix @var{suffix} and is chosen
26632 once per compilation, and mark the argument in the same way as
26633 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
26634 name is now chosen in a way that is hard to predict even when previously
26635 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
26636 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
26637 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
26638 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
26639 was simply substituted with a file name chosen once per compilation,
26640 without regard to any appended suffix (which was therefore treated
26641 just like ordinary text), making such attacks more likely to succeed.
26643 @item %u@var{suffix}
26644 Like @samp{%g}, but generates a new temporary file name
26645 each time it appears instead of once per compilation.
26647 @item %U@var{suffix}
26648 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
26649 new one if there is no such last file name.  In the absence of any
26650 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
26651 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
26652 involves the generation of two distinct file names, one
26653 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
26654 simply substituted with a file name chosen for the previous @samp{%u},
26655 without regard to any appended suffix.
26657 @item %j@var{suffix}
26658 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
26659 writable, and if @option{-save-temps} is not used; 
26660 otherwise, substitute the name
26661 of a temporary file, just like @samp{%u}.  This temporary file is not
26662 meant for communication between processes, but rather as a junk
26663 disposal mechanism.
26665 @item %|@var{suffix}
26666 @itemx %m@var{suffix}
26667 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
26668 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
26669 all.  These are the two most common ways to instruct a program that it
26670 should read from standard input or write to standard output.  If you
26671 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
26672 construct: see for example @file{f/lang-specs.h}.
26674 @item %.@var{SUFFIX}
26675 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
26676 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
26677 terminated by the next space or %.
26679 @item %w
26680 Marks the argument containing or following the @samp{%w} as the
26681 designated output file of this compilation.  This puts the argument
26682 into the sequence of arguments that @samp{%o} substitutes.
26684 @item %o
26685 Substitutes the names of all the output files, with spaces
26686 automatically placed around them.  You should write spaces
26687 around the @samp{%o} as well or the results are undefined.
26688 @samp{%o} is for use in the specs for running the linker.
26689 Input files whose names have no recognized suffix are not compiled
26690 at all, but they are included among the output files, so they are
26691 linked.
26693 @item %O
26694 Substitutes the suffix for object files.  Note that this is
26695 handled specially when it immediately follows @samp{%g, %u, or %U},
26696 because of the need for those to form complete file names.  The
26697 handling is such that @samp{%O} is treated exactly as if it had already
26698 been substituted, except that @samp{%g, %u, and %U} do not currently
26699 support additional @var{suffix} characters following @samp{%O} as they do
26700 following, for example, @samp{.o}.
26702 @item %p
26703 Substitutes the standard macro predefinitions for the
26704 current target machine.  Use this when running @command{cpp}.
26706 @item %P
26707 Like @samp{%p}, but puts @samp{__} before and after the name of each
26708 predefined macro, except for macros that start with @samp{__} or with
26709 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
26712 @item %I
26713 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
26714 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
26715 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
26716 and @option{-imultilib} as necessary.
26718 @item %s
26719 Current argument is the name of a library or startup file of some sort.
26720 Search for that file in a standard list of directories and substitute
26721 the full name found.  The current working directory is included in the
26722 list of directories scanned.
26724 @item %T
26725 Current argument is the name of a linker script.  Search for that file
26726 in the current list of directories to scan for libraries. If the file
26727 is located insert a @option{--script} option into the command line
26728 followed by the full path name found.  If the file is not found then
26729 generate an error message.  Note: the current working directory is not
26730 searched.
26732 @item %e@var{str}
26733 Print @var{str} as an error message.  @var{str} is terminated by a newline.
26734 Use this when inconsistent options are detected.
26736 @item %(@var{name})
26737 Substitute the contents of spec string @var{name} at this point.
26739 @item %x@{@var{option}@}
26740 Accumulate an option for @samp{%X}.
26742 @item %X
26743 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
26744 spec string.
26746 @item %Y
26747 Output the accumulated assembler options specified by @option{-Wa}.
26749 @item %Z
26750 Output the accumulated preprocessor options specified by @option{-Wp}.
26752 @item %a
26753 Process the @code{asm} spec.  This is used to compute the
26754 switches to be passed to the assembler.
26756 @item %A
26757 Process the @code{asm_final} spec.  This is a spec string for
26758 passing switches to an assembler post-processor, if such a program is
26759 needed.
26761 @item %l
26762 Process the @code{link} spec.  This is the spec for computing the
26763 command line passed to the linker.  Typically it makes use of the
26764 @samp{%L %G %S %D and %E} sequences.
26766 @item %D
26767 Dump out a @option{-L} option for each directory that GCC believes might
26768 contain startup files.  If the target supports multilibs then the
26769 current multilib directory is prepended to each of these paths.
26771 @item %L
26772 Process the @code{lib} spec.  This is a spec string for deciding which
26773 libraries are included on the command line to the linker.
26775 @item %G
26776 Process the @code{libgcc} spec.  This is a spec string for deciding
26777 which GCC support library is included on the command line to the linker.
26779 @item %S
26780 Process the @code{startfile} spec.  This is a spec for deciding which
26781 object files are the first ones passed to the linker.  Typically
26782 this might be a file named @file{crt0.o}.
26784 @item %E
26785 Process the @code{endfile} spec.  This is a spec string that specifies
26786 the last object files that are passed to the linker.
26788 @item %C
26789 Process the @code{cpp} spec.  This is used to construct the arguments
26790 to be passed to the C preprocessor.
26792 @item %1
26793 Process the @code{cc1} spec.  This is used to construct the options to be
26794 passed to the actual C compiler (@command{cc1}).
26796 @item %2
26797 Process the @code{cc1plus} spec.  This is used to construct the options to be
26798 passed to the actual C++ compiler (@command{cc1plus}).
26800 @item %*
26801 Substitute the variable part of a matched option.  See below.
26802 Note that each comma in the substituted string is replaced by
26803 a single space.
26805 @item %<S
26806 Remove all occurrences of @code{-S} from the command line.  Note---this
26807 command is position dependent.  @samp{%} commands in the spec string
26808 before this one see @code{-S}, @samp{%} commands in the spec string
26809 after this one do not.
26811 @item %:@var{function}(@var{args})
26812 Call the named function @var{function}, passing it @var{args}.
26813 @var{args} is first processed as a nested spec string, then split
26814 into an argument vector in the usual fashion.  The function returns
26815 a string which is processed as if it had appeared literally as part
26816 of the current spec.
26818 The following built-in spec functions are provided:
26820 @table @code
26821 @item @code{getenv}
26822 The @code{getenv} spec function takes two arguments: an environment
26823 variable name and a string.  If the environment variable is not
26824 defined, a fatal error is issued.  Otherwise, the return value is the
26825 value of the environment variable concatenated with the string.  For
26826 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
26828 @smallexample
26829 %:getenv(TOPDIR /include)
26830 @end smallexample
26832 expands to @file{/path/to/top/include}.
26834 @item @code{if-exists}
26835 The @code{if-exists} spec function takes one argument, an absolute
26836 pathname to a file.  If the file exists, @code{if-exists} returns the
26837 pathname.  Here is a small example of its usage:
26839 @smallexample
26840 *startfile:
26841 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
26842 @end smallexample
26844 @item @code{if-exists-else}
26845 The @code{if-exists-else} spec function is similar to the @code{if-exists}
26846 spec function, except that it takes two arguments.  The first argument is
26847 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
26848 returns the pathname.  If it does not exist, it returns the second argument.
26849 This way, @code{if-exists-else} can be used to select one file or another,
26850 based on the existence of the first.  Here is a small example of its usage:
26852 @smallexample
26853 *startfile:
26854 crt0%O%s %:if-exists(crti%O%s) \
26855 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
26856 @end smallexample
26858 @item @code{replace-outfile}
26859 The @code{replace-outfile} spec function takes two arguments.  It looks for the
26860 first argument in the outfiles array and replaces it with the second argument.  Here
26861 is a small example of its usage:
26863 @smallexample
26864 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
26865 @end smallexample
26867 @item @code{remove-outfile}
26868 The @code{remove-outfile} spec function takes one argument.  It looks for the
26869 first argument in the outfiles array and removes it.  Here is a small example
26870 its usage:
26872 @smallexample
26873 %:remove-outfile(-lm)
26874 @end smallexample
26876 @item @code{pass-through-libs}
26877 The @code{pass-through-libs} spec function takes any number of arguments.  It
26878 finds any @option{-l} options and any non-options ending in @file{.a} (which it
26879 assumes are the names of linker input library archive files) and returns a
26880 result containing all the found arguments each prepended by
26881 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
26882 intended to be passed to the LTO linker plugin.
26884 @smallexample
26885 %:pass-through-libs(%G %L %G)
26886 @end smallexample
26888 @item @code{print-asm-header}
26889 The @code{print-asm-header} function takes no arguments and simply
26890 prints a banner like:
26892 @smallexample
26893 Assembler options
26894 =================
26896 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
26897 @end smallexample
26899 It is used to separate compiler options from assembler options
26900 in the @option{--target-help} output.
26901 @end table
26903 @item %@{S@}
26904 Substitutes the @code{-S} switch, if that switch is given to GCC@.
26905 If that switch is not specified, this substitutes nothing.  Note that
26906 the leading dash is omitted when specifying this option, and it is
26907 automatically inserted if the substitution is performed.  Thus the spec
26908 string @samp{%@{foo@}} matches the command-line option @option{-foo}
26909 and outputs the command-line option @option{-foo}.
26911 @item %W@{S@}
26912 Like %@{@code{S}@} but mark last argument supplied within as a file to be
26913 deleted on failure.
26915 @item %@{S*@}
26916 Substitutes all the switches specified to GCC whose names start
26917 with @code{-S}, but which also take an argument.  This is used for
26918 switches like @option{-o}, @option{-D}, @option{-I}, etc.
26919 GCC considers @option{-o foo} as being
26920 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
26921 text, including the space.  Thus two arguments are generated.
26923 @item %@{S*&T*@}
26924 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
26925 (the order of @code{S} and @code{T} in the spec is not significant).
26926 There can be any number of ampersand-separated variables; for each the
26927 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
26929 @item %@{S:X@}
26930 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
26932 @item %@{!S:X@}
26933 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
26935 @item %@{S*:X@}
26936 Substitutes @code{X} if one or more switches whose names start with
26937 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
26938 once, no matter how many such switches appeared.  However, if @code{%*}
26939 appears somewhere in @code{X}, then @code{X} is substituted once
26940 for each matching switch, with the @code{%*} replaced by the part of
26941 that switch matching the @code{*}.
26943 If @code{%*} appears as the last part of a spec sequence then a space
26944 is added after the end of the last substitution.  If there is more
26945 text in the sequence, however, then a space is not generated.  This
26946 allows the @code{%*} substitution to be used as part of a larger
26947 string.  For example, a spec string like this:
26949 @smallexample
26950 %@{mcu=*:--script=%*/memory.ld@}
26951 @end smallexample
26953 @noindent
26954 when matching an option like @option{-mcu=newchip} produces:
26956 @smallexample
26957 --script=newchip/memory.ld
26958 @end smallexample
26960 @item %@{.S:X@}
26961 Substitutes @code{X}, if processing a file with suffix @code{S}.
26963 @item %@{!.S:X@}
26964 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
26966 @item %@{,S:X@}
26967 Substitutes @code{X}, if processing a file for language @code{S}.
26969 @item %@{!,S:X@}
26970 Substitutes @code{X}, if not processing a file for language @code{S}.
26972 @item %@{S|P:X@}
26973 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
26974 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
26975 @code{*} sequences as well, although they have a stronger binding than
26976 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
26977 alternatives must be starred, and only the first matching alternative
26978 is substituted.
26980 For example, a spec string like this:
26982 @smallexample
26983 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
26984 @end smallexample
26986 @noindent
26987 outputs the following command-line options from the following input
26988 command-line options:
26990 @smallexample
26991 fred.c        -foo -baz
26992 jim.d         -bar -boggle
26993 -d fred.c     -foo -baz -boggle
26994 -d jim.d      -bar -baz -boggle
26995 @end smallexample
26997 @item %@{S:X; T:Y; :D@}
26999 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
27000 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
27001 be as many clauses as you need.  This may be combined with @code{.},
27002 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
27005 @end table
27007 The switch matching text @code{S} in a @samp{%@{S@}}, @samp{%@{S:X@}}
27008 or similar construct can use a backslash to ignore the special meaning
27009 of the character following it, thus allowing literal matching of a
27010 character that is otherwise specially treated.  For example,
27011 @samp{%@{std=iso9899\:1999:X@}} substitutes @code{X} if the
27012 @option{-std=iso9899:1999} option is given.
27014 The conditional text @code{X} in a @samp{%@{S:X@}} or similar
27015 construct may contain other nested @samp{%} constructs or spaces, or
27016 even newlines.  They are processed as usual, as described above.
27017 Trailing white space in @code{X} is ignored.  White space may also
27018 appear anywhere on the left side of the colon in these constructs,
27019 except between @code{.} or @code{*} and the corresponding word.
27021 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
27022 handled specifically in these constructs.  If another value of
27023 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
27024 @option{-W} switch is found later in the command line, the earlier
27025 switch value is ignored, except with @{@code{S}*@} where @code{S} is
27026 just one letter, which passes all matching options.
27028 The character @samp{|} at the beginning of the predicate text is used to
27029 indicate that a command should be piped to the following command, but
27030 only if @option{-pipe} is specified.
27032 It is built into GCC which switches take arguments and which do not.
27033 (You might think it would be useful to generalize this to allow each
27034 compiler's spec to say which switches take arguments.  But this cannot
27035 be done in a consistent fashion.  GCC cannot even decide which input
27036 files have been specified without knowing which switches take arguments,
27037 and it must know which input files to compile in order to tell which
27038 compilers to run).
27040 GCC also knows implicitly that arguments starting in @option{-l} are to be
27041 treated as compiler output files, and passed to the linker in their
27042 proper position among the other output files.
27044 @node Environment Variables
27045 @section Environment Variables Affecting GCC
27046 @cindex environment variables
27048 @c man begin ENVIRONMENT
27049 This section describes several environment variables that affect how GCC
27050 operates.  Some of them work by specifying directories or prefixes to use
27051 when searching for various kinds of files.  Some are used to specify other
27052 aspects of the compilation environment.
27054 Note that you can also specify places to search using options such as
27055 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
27056 take precedence over places specified using environment variables, which
27057 in turn take precedence over those specified by the configuration of GCC@.
27058 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
27059 GNU Compiler Collection (GCC) Internals}.
27061 @table @env
27062 @item LANG
27063 @itemx LC_CTYPE
27064 @c @itemx LC_COLLATE
27065 @itemx LC_MESSAGES
27066 @c @itemx LC_MONETARY
27067 @c @itemx LC_NUMERIC
27068 @c @itemx LC_TIME
27069 @itemx LC_ALL
27070 @findex LANG
27071 @findex LC_CTYPE
27072 @c @findex LC_COLLATE
27073 @findex LC_MESSAGES
27074 @c @findex LC_MONETARY
27075 @c @findex LC_NUMERIC
27076 @c @findex LC_TIME
27077 @findex LC_ALL
27078 @cindex locale
27079 These environment variables control the way that GCC uses
27080 localization information which allows GCC to work with different
27081 national conventions.  GCC inspects the locale categories
27082 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
27083 so.  These locale categories can be set to any value supported by your
27084 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
27085 Kingdom encoded in UTF-8.
27087 The @env{LC_CTYPE} environment variable specifies character
27088 classification.  GCC uses it to determine the character boundaries in
27089 a string; this is needed for some multibyte encodings that contain quote
27090 and escape characters that are otherwise interpreted as a string
27091 end or escape.
27093 The @env{LC_MESSAGES} environment variable specifies the language to
27094 use in diagnostic messages.
27096 If the @env{LC_ALL} environment variable is set, it overrides the value
27097 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
27098 and @env{LC_MESSAGES} default to the value of the @env{LANG}
27099 environment variable.  If none of these variables are set, GCC
27100 defaults to traditional C English behavior.
27102 @item TMPDIR
27103 @findex TMPDIR
27104 If @env{TMPDIR} is set, it specifies the directory to use for temporary
27105 files.  GCC uses temporary files to hold the output of one stage of
27106 compilation which is to be used as input to the next stage: for example,
27107 the output of the preprocessor, which is the input to the compiler
27108 proper.
27110 @item GCC_COMPARE_DEBUG
27111 @findex GCC_COMPARE_DEBUG
27112 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
27113 @option{-fcompare-debug} to the compiler driver.  See the documentation
27114 of this option for more details.
27116 @item GCC_EXEC_PREFIX
27117 @findex GCC_EXEC_PREFIX
27118 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
27119 names of the subprograms executed by the compiler.  No slash is added
27120 when this prefix is combined with the name of a subprogram, but you can
27121 specify a prefix that ends with a slash if you wish.
27123 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
27124 an appropriate prefix to use based on the pathname it is invoked with.
27126 If GCC cannot find the subprogram using the specified prefix, it
27127 tries looking in the usual places for the subprogram.
27129 The default value of @env{GCC_EXEC_PREFIX} is
27130 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
27131 the installed compiler. In many cases @var{prefix} is the value
27132 of @code{prefix} when you ran the @file{configure} script.
27134 Other prefixes specified with @option{-B} take precedence over this prefix.
27136 This prefix is also used for finding files such as @file{crt0.o} that are
27137 used for linking.
27139 In addition, the prefix is used in an unusual way in finding the
27140 directories to search for header files.  For each of the standard
27141 directories whose name normally begins with @samp{/usr/local/lib/gcc}
27142 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
27143 replacing that beginning with the specified prefix to produce an
27144 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
27145 @file{foo/bar} just before it searches the standard directory 
27146 @file{/usr/local/lib/bar}.
27147 If a standard directory begins with the configured
27148 @var{prefix} then the value of @var{prefix} is replaced by
27149 @env{GCC_EXEC_PREFIX} when looking for header files.
27151 @item COMPILER_PATH
27152 @findex COMPILER_PATH
27153 The value of @env{COMPILER_PATH} is a colon-separated list of
27154 directories, much like @env{PATH}.  GCC tries the directories thus
27155 specified when searching for subprograms, if it cannot find the
27156 subprograms using @env{GCC_EXEC_PREFIX}.
27158 @item LIBRARY_PATH
27159 @findex LIBRARY_PATH
27160 The value of @env{LIBRARY_PATH} is a colon-separated list of
27161 directories, much like @env{PATH}.  When configured as a native compiler,
27162 GCC tries the directories thus specified when searching for special
27163 linker files, if it cannot find them using @env{GCC_EXEC_PREFIX}.  Linking
27164 using GCC also uses these directories when searching for ordinary
27165 libraries for the @option{-l} option (but directories specified with
27166 @option{-L} come first).
27168 @item LANG
27169 @findex LANG
27170 @cindex locale definition
27171 This variable is used to pass locale information to the compiler.  One way in
27172 which this information is used is to determine the character set to be used
27173 when character literals, string literals and comments are parsed in C and C++.
27174 When the compiler is configured to allow multibyte characters,
27175 the following values for @env{LANG} are recognized:
27177 @table @samp
27178 @item C-JIS
27179 Recognize JIS characters.
27180 @item C-SJIS
27181 Recognize SJIS characters.
27182 @item C-EUCJP
27183 Recognize EUCJP characters.
27184 @end table
27186 If @env{LANG} is not defined, or if it has some other value, then the
27187 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
27188 recognize and translate multibyte characters.
27189 @end table
27191 @noindent
27192 Some additional environment variables affect the behavior of the
27193 preprocessor.
27195 @include cppenv.texi
27197 @c man end
27199 @node Precompiled Headers
27200 @section Using Precompiled Headers
27201 @cindex precompiled headers
27202 @cindex speed of compilation
27204 Often large projects have many header files that are included in every
27205 source file.  The time the compiler takes to process these header files
27206 over and over again can account for nearly all of the time required to
27207 build the project.  To make builds faster, GCC allows you to
27208 @dfn{precompile} a header file.
27210 To create a precompiled header file, simply compile it as you would any
27211 other file, if necessary using the @option{-x} option to make the driver
27212 treat it as a C or C++ header file.  You may want to use a
27213 tool like @command{make} to keep the precompiled header up-to-date when
27214 the headers it contains change.
27216 A precompiled header file is searched for when @code{#include} is
27217 seen in the compilation.  As it searches for the included file
27218 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
27219 compiler looks for a precompiled header in each directory just before it
27220 looks for the include file in that directory.  The name searched for is
27221 the name specified in the @code{#include} with @samp{.gch} appended.  If
27222 the precompiled header file cannot be used, it is ignored.
27224 For instance, if you have @code{#include "all.h"}, and you have
27225 @file{all.h.gch} in the same directory as @file{all.h}, then the
27226 precompiled header file is used if possible, and the original
27227 header is used otherwise.
27229 Alternatively, you might decide to put the precompiled header file in a
27230 directory and use @option{-I} to ensure that directory is searched
27231 before (or instead of) the directory containing the original header.
27232 Then, if you want to check that the precompiled header file is always
27233 used, you can put a file of the same name as the original header in this
27234 directory containing an @code{#error} command.
27236 This also works with @option{-include}.  So yet another way to use
27237 precompiled headers, good for projects not designed with precompiled
27238 header files in mind, is to simply take most of the header files used by
27239 a project, include them from another header file, precompile that header
27240 file, and @option{-include} the precompiled header.  If the header files
27241 have guards against multiple inclusion, they are skipped because
27242 they've already been included (in the precompiled header).
27244 If you need to precompile the same header file for different
27245 languages, targets, or compiler options, you can instead make a
27246 @emph{directory} named like @file{all.h.gch}, and put each precompiled
27247 header in the directory, perhaps using @option{-o}.  It doesn't matter
27248 what you call the files in the directory; every precompiled header in
27249 the directory is considered.  The first precompiled header
27250 encountered in the directory that is valid for this compilation is
27251 used; they're searched in no particular order.
27253 There are many other possibilities, limited only by your imagination,
27254 good sense, and the constraints of your build system.
27256 A precompiled header file can be used only when these conditions apply:
27258 @itemize
27259 @item
27260 Only one precompiled header can be used in a particular compilation.
27262 @item
27263 A precompiled header cannot be used once the first C token is seen.  You
27264 can have preprocessor directives before a precompiled header; you cannot
27265 include a precompiled header from inside another header.
27267 @item
27268 The precompiled header file must be produced for the same language as
27269 the current compilation.  You cannot use a C precompiled header for a C++
27270 compilation.
27272 @item
27273 The precompiled header file must have been produced by the same compiler
27274 binary as the current compilation is using.
27276 @item
27277 Any macros defined before the precompiled header is included must
27278 either be defined in the same way as when the precompiled header was
27279 generated, or must not affect the precompiled header, which usually
27280 means that they don't appear in the precompiled header at all.
27282 The @option{-D} option is one way to define a macro before a
27283 precompiled header is included; using a @code{#define} can also do it.
27284 There are also some options that define macros implicitly, like
27285 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
27286 defined this way.
27288 @item If debugging information is output when using the precompiled
27289 header, using @option{-g} or similar, the same kind of debugging information
27290 must have been output when building the precompiled header.  However,
27291 a precompiled header built using @option{-g} can be used in a compilation
27292 when no debugging information is being output.
27294 @item The same @option{-m} options must generally be used when building
27295 and using the precompiled header.  @xref{Submodel Options},
27296 for any cases where this rule is relaxed.
27298 @item Each of the following options must be the same when building and using
27299 the precompiled header:
27301 @gccoptlist{-fexceptions}
27303 @item
27304 Some other command-line options starting with @option{-f},
27305 @option{-p}, or @option{-O} must be defined in the same way as when
27306 the precompiled header was generated.  At present, it's not clear
27307 which options are safe to change and which are not; the safest choice
27308 is to use exactly the same options when generating and using the
27309 precompiled header.  The following are known to be safe:
27311 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
27312 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
27313 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
27314 -pedantic-errors}
27316 @end itemize
27318 For all of these except the last, the compiler automatically
27319 ignores the precompiled header if the conditions aren't met.  If you
27320 find an option combination that doesn't work and doesn't cause the
27321 precompiled header to be ignored, please consider filing a bug report,
27322 see @ref{Bugs}.
27324 If you do use differing options when generating and using the
27325 precompiled header, the actual behavior is a mixture of the
27326 behavior for the options.  For instance, if you use @option{-g} to
27327 generate the precompiled header but not when using it, you may or may
27328 not get debugging information for routines in the precompiled header.