gcc/:
[official-gcc.git] / gcc / doc / invoke.texi
blob5d416490d49f976be9cd60ad77cee713d5c2412f
1 @c Copyright (C) 1988-2017 Free Software Foundation, Inc.
2 @c This is part of the GCC manual.
3 @c For copying conditions, see the file gcc.texi.
5 @ignore
6 @c man begin INCLUDE
7 @include gcc-vers.texi
8 @c man end
10 @c man begin COPYRIGHT
11 Copyright @copyright{} 1988-2017 Free Software Foundation, Inc.
13 Permission is granted to copy, distribute and/or modify this document
14 under the terms of the GNU Free Documentation License, Version 1.3 or
15 any later version published by the Free Software Foundation; with the
16 Invariant Sections being ``GNU General Public License'' and ``Funding
17 Free Software'', the Front-Cover texts being (a) (see below), and with
18 the Back-Cover Texts being (b) (see below).  A copy of the license is
19 included in the gfdl(7) man page.
21 (a) The FSF's Front-Cover Text is:
23      A GNU Manual
25 (b) The FSF's Back-Cover Text is:
27      You have freedom to copy and modify this GNU Manual, like GNU
28      software.  Copies published by the Free Software Foundation raise
29      funds for GNU development.
30 @c man end
31 @c Set file name and title for the man page.
32 @setfilename gcc
33 @settitle GNU project C and C++ compiler
34 @c man begin SYNOPSIS
35 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
36     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
37     [@option{-W}@var{warn}@dots{}] [@option{-Wpedantic}]
38     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
39     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
40     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
41     [@option{-o} @var{outfile}] [@@@var{file}] @var{infile}@dots{}
43 Only the most useful options are listed here; see below for the
44 remainder.  @command{g++} accepts mostly the same options as @command{gcc}.
45 @c man end
46 @c man begin SEEALSO
47 gpl(7), gfdl(7), fsf-funding(7),
48 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
49 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
50 @file{ld}, @file{binutils} and @file{gdb}.
51 @c man end
52 @c man begin BUGS
53 For instructions on reporting bugs, see
54 @w{@value{BUGURL}}.
55 @c man end
56 @c man begin AUTHOR
57 See the Info entry for @command{gcc}, or
58 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
59 for contributors to GCC@.
60 @c man end
61 @end ignore
63 @node Invoking GCC
64 @chapter GCC Command Options
65 @cindex GCC command options
66 @cindex command options
67 @cindex options, GCC command
69 @c man begin DESCRIPTION
70 When you invoke GCC, it normally does preprocessing, compilation,
71 assembly and linking.  The ``overall options'' allow you to stop this
72 process at an intermediate stage.  For example, the @option{-c} option
73 says not to run the linker.  Then the output consists of object files
74 output by the assembler.
75 @xref{Overall Options,,Options Controlling the Kind of Output}.
77 Other options are passed on to one or more stages of processing.  Some options
78 control the preprocessor and others the compiler itself.  Yet other
79 options control the assembler and linker; most of these are not
80 documented here, since you rarely need to use any of them.
82 @cindex C compilation options
83 Most of the command-line options that you can use with GCC are useful
84 for C programs; when an option is only useful with another language
85 (usually C++), the explanation says so explicitly.  If the description
86 for a particular option does not mention a source language, you can use
87 that option with all supported languages.
89 @cindex cross compiling
90 @cindex specifying machine version
91 @cindex specifying compiler version and target machine
92 @cindex compiler version, specifying
93 @cindex target machine, specifying
94 The usual way to run GCC is to run the executable called @command{gcc}, or
95 @command{@var{machine}-gcc} when cross-compiling, or
96 @command{@var{machine}-gcc-@var{version}} to run a specific version of GCC.
97 When you compile C++ programs, you should invoke GCC as @command{g++} 
98 instead.  @xref{Invoking G++,,Compiling C++ Programs}, 
99 for information about the differences in behavior between @command{gcc} 
100 and @code{g++} when compiling C++ programs.
102 @cindex grouping options
103 @cindex options, grouping
104 The @command{gcc} program accepts options and file names as operands.  Many
105 options have multi-letter names; therefore multiple single-letter options
106 may @emph{not} be grouped: @option{-dv} is very different from @w{@samp{-d
107 -v}}.
109 @cindex order of options
110 @cindex options, order
111 You can mix options and other arguments.  For the most part, the order
112 you use doesn't matter.  Order does matter when you use several
113 options of the same kind; for example, if you specify @option{-L} more
114 than once, the directories are searched in the order specified.  Also,
115 the placement of the @option{-l} option is significant.
117 Many options have long names starting with @samp{-f} or with
118 @samp{-W}---for example,
119 @option{-fmove-loop-invariants}, @option{-Wformat} and so on.  Most of
120 these have both positive and negative forms; the negative form of
121 @option{-ffoo} is @option{-fno-foo}.  This manual documents
122 only one of these two forms, whichever one is not the default.
124 @c man end
126 @xref{Option Index}, for an index to GCC's options.
128 @menu
129 * Option Summary::      Brief list of all options, without explanations.
130 * Overall Options::     Controlling the kind of output:
131                         an executable, object files, assembler files,
132                         or preprocessed source.
133 * Invoking G++::        Compiling C++ programs.
134 * C Dialect Options::   Controlling the variant of C language compiled.
135 * C++ Dialect Options:: Variations on C++.
136 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
137                         and Objective-C++.
138 * Diagnostic Message Formatting Options:: Controlling how diagnostics should
139                         be formatted.
140 * Warning Options::     How picky should the compiler be?
141 * Debugging Options::   Producing debuggable code.
142 * Optimize Options::    How much optimization?
143 * Instrumentation Options:: Enabling profiling and extra run-time error checking.
144 * Preprocessor Options:: Controlling header files and macro definitions.
145                          Also, getting dependency information for Make.
146 * Assembler Options::   Passing options to the assembler.
147 * Link Options::        Specifying libraries and so on.
148 * Directory Options::   Where to find header files and libraries.
149                         Where to find the compiler executable files.
150 * Code Gen Options::    Specifying conventions for function calls, data layout
151                         and register usage.
152 * Developer Options::   Printing GCC configuration info, statistics, and
153                         debugging dumps.
154 * Submodel Options::    Target-specific options, such as compiling for a
155                         specific processor variant.
156 * Spec Files::          How to pass switches to sub-processes.
157 * Environment Variables:: Env vars that affect GCC.
158 * Precompiled Headers:: Compiling a header once, and using it many times.
159 @end menu
161 @c man begin OPTIONS
163 @node Option Summary
164 @section Option Summary
166 Here is a summary of all the options, grouped by type.  Explanations are
167 in the following sections.
169 @table @emph
170 @item Overall Options
171 @xref{Overall Options,,Options Controlling the Kind of Output}.
172 @gccoptlist{-c  -S  -E  -o @var{file}  -x @var{language}  @gol
173 -v  -###  --help@r{[}=@var{class}@r{[},@dots{}@r{]]}  --target-help  --version @gol
174 -pass-exit-codes  -pipe  -specs=@var{file}  -wrapper  @gol
175 @@@var{file}  -fplugin=@var{file}  -fplugin-arg-@var{name}=@var{arg}  @gol
176 -fdump-ada-spec@r{[}-slim@r{]}  -fada-spec-parent=@var{unit}  -fdump-go-spec=@var{file}}
178 @item C Language Options
179 @xref{C Dialect Options,,Options Controlling C Dialect}.
180 @gccoptlist{-ansi  -std=@var{standard}  -fgnu89-inline @gol
181 -fpermitted-flt-eval-methods=@var{standard} @gol
182 -aux-info @var{filename}  -fallow-parameterless-variadic-functions @gol
183 -fno-asm  -fno-builtin  -fno-builtin-@var{function}  -fgimple@gol
184 -fhosted  -ffreestanding  -fopenacc  -fopenmp  -fopenmp-simd @gol
185 -fms-extensions  -fplan9-extensions  -fsso-struct=@var{endianness} @gol
186 -fallow-single-precision  -fcond-mismatch  -flax-vector-conversions @gol
187 -fsigned-bitfields  -fsigned-char @gol
188 -funsigned-bitfields  -funsigned-char}
190 @item C++ Language Options
191 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
192 @gccoptlist{-fabi-version=@var{n}  -fno-access-control @gol
193 -faligned-new=@var{n}  -fargs-in-order=@var{n}  -fcheck-new @gol
194 -fconstexpr-depth=@var{n}  -fconstexpr-loop-limit=@var{n} @gol
195 -ffriend-injection @gol
196 -fno-elide-constructors @gol
197 -fno-enforce-eh-specs @gol
198 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
199 -fno-implicit-templates @gol
200 -fno-implicit-inline-templates @gol
201 -fno-implement-inlines  -fms-extensions @gol
202 -fnew-inheriting-ctors @gol
203 -fnew-ttp-matching @gol
204 -fno-nonansi-builtins  -fnothrow-opt  -fno-operator-names @gol
205 -fno-optional-diags  -fpermissive @gol
206 -fno-pretty-templates @gol
207 -frepo  -fno-rtti  -fsized-deallocation @gol
208 -ftemplate-backtrace-limit=@var{n} @gol
209 -ftemplate-depth=@var{n} @gol
210 -fno-threadsafe-statics  -fuse-cxa-atexit @gol
211 -fno-weak  -nostdinc++ @gol
212 -fvisibility-inlines-hidden @gol
213 -fvisibility-ms-compat @gol
214 -fext-numeric-literals @gol
215 -Wabi=@var{n}  -Wabi-tag  -Wconversion-null  -Wctor-dtor-privacy @gol
216 -Wdelete-non-virtual-dtor  -Wliteral-suffix  -Wmultiple-inheritance @gol
217 -Wnamespaces  -Wnarrowing @gol
218 -Wnoexcept  -Wnoexcept-type  -Wnon-virtual-dtor  -Wreorder  -Wregister @gol
219 -Weffc++  -Wstrict-null-sentinel  -Wtemplates @gol
220 -Wno-non-template-friend  -Wold-style-cast @gol
221 -Woverloaded-virtual  -Wno-pmf-conversions @gol
222 -Wsign-promo  -Wvirtual-inheritance}
224 @item Objective-C and Objective-C++ Language Options
225 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
226 Objective-C and Objective-C++ Dialects}.
227 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
228 -fgnu-runtime  -fnext-runtime @gol
229 -fno-nil-receivers @gol
230 -fobjc-abi-version=@var{n} @gol
231 -fobjc-call-cxx-cdtors @gol
232 -fobjc-direct-dispatch @gol
233 -fobjc-exceptions @gol
234 -fobjc-gc @gol
235 -fobjc-nilcheck @gol
236 -fobjc-std=objc1 @gol
237 -fno-local-ivars @gol
238 -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]} @gol
239 -freplace-objc-classes @gol
240 -fzero-link @gol
241 -gen-decls @gol
242 -Wassign-intercept @gol
243 -Wno-protocol  -Wselector @gol
244 -Wstrict-selector-match @gol
245 -Wundeclared-selector}
247 @item Diagnostic Message Formatting Options
248 @xref{Diagnostic Message Formatting Options,,Options to Control Diagnostic Messages Formatting}.
249 @gccoptlist{-fmessage-length=@var{n}  @gol
250 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
251 -fdiagnostics-color=@r{[}auto@r{|}never@r{|}always@r{]}  @gol
252 -fno-diagnostics-show-option  -fno-diagnostics-show-caret @gol
253 -fdiagnostics-parseable-fixits  -fdiagnostics-generate-patch @gol
254 -fdiagnostics-show-template-tree -fno-elide-type @gol
255 -fno-show-column}
257 @item Warning Options
258 @xref{Warning Options,,Options to Request or Suppress Warnings}.
259 @gccoptlist{-fsyntax-only  -fmax-errors=@var{n}  -Wpedantic @gol
260 -pedantic-errors @gol
261 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  @gol
262 -Walloc-zero  -Walloc-size-larger-than=@var{n}
263 -Walloca  -Walloca-larger-than=@var{n} @gol
264 -Wno-aggressive-loop-optimizations  -Warray-bounds  -Warray-bounds=@var{n} @gol
265 -Wno-attributes  -Wbool-compare  -Wbool-operation @gol
266 -Wno-builtin-declaration-mismatch @gol
267 -Wno-builtin-macro-redefined  -Wc90-c99-compat  -Wc99-c11-compat @gol
268 -Wc++-compat  -Wc++11-compat  -Wc++14-compat  -Wcast-align  -Wcast-qual  @gol
269 -Wchar-subscripts  -Wchkp  -Wcatch-value  -Wcatch-value=@var{n} @gol
270 -Wclobbered  -Wcomment  -Wconditionally-supported @gol
271 -Wconversion  -Wcoverage-mismatch  -Wno-cpp  -Wdangling-else  -Wdate-time @gol
272 -Wdelete-incomplete @gol
273 -Wno-deprecated  -Wno-deprecated-declarations  -Wno-designated-init @gol
274 -Wdisabled-optimization @gol
275 -Wno-discarded-qualifiers  -Wno-discarded-array-qualifiers @gol
276 -Wno-div-by-zero  -Wdouble-promotion @gol
277 -Wduplicated-branches  -Wduplicated-cond @gol
278 -Wempty-body  -Wenum-compare  -Wno-endif-labels  -Wexpansion-to-defined @gol
279 -Werror  -Werror=*  -Wextra-semi  -Wfatal-errors @gol
280 -Wfloat-equal  -Wformat  -Wformat=2 @gol
281 -Wno-format-contains-nul  -Wno-format-extra-args  @gol
282 -Wformat-nonliteral -Wformat-overflow=@var{n} @gol
283 -Wformat-security  -Wformat-signedness  -Wformat-truncation=@var{n} @gol
284 -Wformat-y2k  -Wframe-address @gol
285 -Wframe-larger-than=@var{len}  -Wno-free-nonheap-object  -Wjump-misses-init @gol
286 -Wignored-qualifiers  -Wignored-attributes  -Wincompatible-pointer-types @gol
287 -Wimplicit  -Wimplicit-fallthrough  -Wimplicit-fallthrough=@var{n} @gol
288 -Wimplicit-function-declaration  -Wimplicit-int @gol
289 -Winit-self  -Winline  -Wno-int-conversion  -Wint-in-bool-context @gol
290 -Wno-int-to-pointer-cast  -Winvalid-memory-model  -Wno-invalid-offsetof @gol
291 -Winvalid-pch  -Wlarger-than=@var{len} @gol
292 -Wlogical-op  -Wlogical-not-parentheses  -Wlong-long @gol
293 -Wmain  -Wmaybe-uninitialized  -Wmemset-elt-size  -Wmemset-transposed-args @gol
294 -Wmisleading-indentation  -Wmissing-braces @gol
295 -Wmissing-field-initializers  -Wmissing-include-dirs @gol
296 -Wno-multichar  -Wnonnull  -Wnonnull-compare @gol
297 -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]} @gol
298 -Wnull-dereference  -Wodr  -Wno-overflow  -Wopenmp-simd  @gol
299 -Woverride-init-side-effects  -Woverlength-strings @gol
300 -Wpacked  -Wpacked-bitfield-compat  -Wpadded @gol
301 -Wparentheses  -Wno-pedantic-ms-format @gol
302 -Wplacement-new  -Wplacement-new=@var{n} @gol
303 -Wpointer-arith  -Wpointer-compare  -Wno-pointer-to-int-cast @gol
304 -Wno-pragmas  -Wredundant-decls  -Wrestrict  -Wno-return-local-addr @gol
305 -Wreturn-type  -Wsequence-point  -Wshadow  -Wno-shadow-ivar @gol
306 -Wshadow=global,  -Wshadow=local,  -Wshadow=compatible-local @gol
307 -Wshift-overflow  -Wshift-overflow=@var{n} @gol
308 -Wshift-count-negative  -Wshift-count-overflow  -Wshift-negative-value @gol
309 -Wsign-compare  -Wsign-conversion  -Wfloat-conversion @gol
310 -Wno-scalar-storage-order  -Wsizeof-pointer-div @gol
311 -Wsizeof-pointer-memaccess  -Wsizeof-array-argument @gol
312 -Wstack-protector  -Wstack-usage=@var{len}  -Wstrict-aliasing @gol
313 -Wstrict-aliasing=n  -Wstrict-overflow  -Wstrict-overflow=@var{n} @gol
314 -Wstringop-overflow=@var{n} @gol
315 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]} @gol
316 -Wsuggest-final-types @gol  -Wsuggest-final-methods  -Wsuggest-override @gol
317 -Wmissing-format-attribute  -Wsubobject-linkage @gol
318 -Wswitch  -Wswitch-bool  -Wswitch-default  -Wswitch-enum @gol
319 -Wswitch-unreachable  -Wsync-nand @gol
320 -Wsystem-headers  -Wtautological-compare  -Wtrampolines  -Wtrigraphs @gol
321 -Wtype-limits  -Wundef @gol
322 -Wuninitialized  -Wunknown-pragmas  -Wunsafe-loop-optimizations @gol
323 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
324 -Wunused-label  -Wunused-local-typedefs  -Wunused-macros @gol
325 -Wunused-parameter  -Wno-unused-result @gol
326 -Wunused-value  -Wunused-variable @gol
327 -Wunused-const-variable  -Wunused-const-variable=@var{n} @gol
328 -Wunused-but-set-parameter  -Wunused-but-set-variable @gol
329 -Wuseless-cast  -Wvariadic-macros  -Wvector-operation-performance @gol
330 -Wvla  -Wvla-larger-than=@var{n}  -Wvolatile-register-var  -Wwrite-strings @gol
331 -Wzero-as-null-pointer-constant  -Whsa}
333 @item C and Objective-C-only Warning Options
334 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
335 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
336 -Wold-style-declaration  -Wold-style-definition @gol
337 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
338 -Wdeclaration-after-statement  -Wpointer-sign}
340 @item Debugging Options
341 @xref{Debugging Options,,Options for Debugging Your Program}.
342 @gccoptlist{-g  -g@var{level}  -gcoff  -gdwarf  -gdwarf-@var{version} @gol
343 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
344 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
345 -gcolumn-info  -gno-column-info @gol
346 -gvms  -gxcoff  -gxcoff+  -gz@r{[}=@var{type}@r{]} @gol
347 -fdebug-prefix-map=@var{old}=@var{new}  -fdebug-types-section @gol
348 -feliminate-dwarf2-dups  -fno-eliminate-unused-debug-types @gol
349 -femit-struct-debug-baseonly  -femit-struct-debug-reduced @gol
350 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
351 -feliminate-unused-debug-symbols  -femit-class-debug-always @gol
352 -fno-merge-debug-strings  -fno-dwarf2-cfi-asm @gol
353 -fvar-tracking  -fvar-tracking-assignments}
355 @item Optimization Options
356 @xref{Optimize Options,,Options that Control Optimization}.
357 @gccoptlist{-faggressive-loop-optimizations  -falign-functions[=@var{n}] @gol
358 -falign-jumps[=@var{n}] @gol
359 -falign-labels[=@var{n}]  -falign-loops[=@var{n}] @gol
360 -fassociative-math  -fauto-profile  -fauto-profile[=@var{path}] @gol
361 -fauto-inc-dec  -fbranch-probabilities @gol
362 -fbranch-target-load-optimize  -fbranch-target-load-optimize2 @gol
363 -fbtr-bb-exclusive  -fcaller-saves @gol
364 -fcombine-stack-adjustments  -fconserve-stack @gol
365 -fcompare-elim  -fcprop-registers  -fcrossjumping @gol
366 -fcse-follow-jumps  -fcse-skip-blocks  -fcx-fortran-rules @gol
367 -fcx-limited-range @gol
368 -fdata-sections  -fdce  -fdelayed-branch @gol
369 -fdelete-null-pointer-checks  -fdevirtualize  -fdevirtualize-speculatively @gol
370 -fdevirtualize-at-ltrans  -fdse @gol
371 -fearly-inlining  -fipa-sra  -fexpensive-optimizations  -ffat-lto-objects @gol
372 -ffast-math  -ffinite-math-only  -ffloat-store  -fexcess-precision=@var{style} @gol
373 -fforward-propagate  -ffp-contract=@var{style}  -ffunction-sections @gol
374 -fgcse  -fgcse-after-reload  -fgcse-las  -fgcse-lm  -fgraphite-identity @gol
375 -fgcse-sm  -fhoist-adjacent-loads  -fif-conversion @gol
376 -fif-conversion2  -findirect-inlining @gol
377 -finline-functions  -finline-functions-called-once  -finline-limit=@var{n} @gol
378 -finline-small-functions  -fipa-cp  -fipa-cp-clone @gol
379 -fipa-bit-cp -fipa-vrp @gol
380 -fipa-pta  -fipa-profile  -fipa-pure-const  -fipa-reference  -fipa-icf @gol
381 -fira-algorithm=@var{algorithm} @gol
382 -fira-region=@var{region}  -fira-hoist-pressure @gol
383 -fira-loop-pressure  -fno-ira-share-save-slots @gol
384 -fno-ira-share-spill-slots @gol
385 -fisolate-erroneous-paths-dereference  -fisolate-erroneous-paths-attribute @gol
386 -fivopts  -fkeep-inline-functions  -fkeep-static-functions @gol
387 -fkeep-static-consts  -flimit-function-alignment  -flive-range-shrinkage @gol
388 -floop-block  -floop-interchange  -floop-strip-mine @gol
389 -floop-unroll-and-jam  -floop-nest-optimize @gol
390 -floop-parallelize-all  -flra-remat  -flto  -flto-compression-level @gol
391 -flto-partition=@var{alg}  -fmerge-all-constants @gol
392 -fmerge-constants  -fmodulo-sched  -fmodulo-sched-allow-regmoves @gol
393 -fmove-loop-invariants  -fno-branch-count-reg @gol
394 -fno-defer-pop  -fno-fp-int-builtin-inexact  -fno-function-cse @gol
395 -fno-guess-branch-probability  -fno-inline  -fno-math-errno  -fno-peephole @gol
396 -fno-peephole2  -fno-printf-return-value  -fno-sched-interblock @gol
397 -fno-sched-spec  -fno-signed-zeros @gol
398 -fno-toplevel-reorder  -fno-trapping-math  -fno-zero-initialized-in-bss @gol
399 -fomit-frame-pointer  -foptimize-sibling-calls @gol
400 -fpartial-inlining  -fpeel-loops  -fpredictive-commoning @gol
401 -fprefetch-loop-arrays @gol
402 -fprofile-correction @gol
403 -fprofile-use  -fprofile-use=@var{path}  -fprofile-values @gol
404 -fprofile-reorder-functions @gol
405 -freciprocal-math  -free  -frename-registers  -freorder-blocks @gol
406 -freorder-blocks-algorithm=@var{algorithm} @gol
407 -freorder-blocks-and-partition  -freorder-functions @gol
408 -frerun-cse-after-loop  -freschedule-modulo-scheduled-loops @gol
409 -frounding-math  -fsched2-use-superblocks  -fsched-pressure @gol
410 -fsched-spec-load  -fsched-spec-load-dangerous @gol
411 -fsched-stalled-insns-dep[=@var{n}]  -fsched-stalled-insns[=@var{n}] @gol
412 -fsched-group-heuristic  -fsched-critical-path-heuristic @gol
413 -fsched-spec-insn-heuristic  -fsched-rank-heuristic @gol
414 -fsched-last-insn-heuristic  -fsched-dep-count-heuristic @gol
415 -fschedule-fusion @gol
416 -fschedule-insns  -fschedule-insns2  -fsection-anchors @gol
417 -fselective-scheduling  -fselective-scheduling2 @gol
418 -fsel-sched-pipelining  -fsel-sched-pipelining-outer-loops @gol
419 -fsemantic-interposition  -fshrink-wrap  -fshrink-wrap-separate @gol
420 -fsignaling-nans @gol
421 -fsingle-precision-constant  -fsplit-ivs-in-unroller  -fsplit-loops@gol
422 -fsplit-paths @gol
423 -fsplit-wide-types  -fssa-backprop  -fssa-phiopt @gol
424 -fstdarg-opt  -fstore-merging  -fstrict-aliasing @gol
425 -fthread-jumps  -ftracer  -ftree-bit-ccp @gol
426 -ftree-builtin-call-dce  -ftree-ccp  -ftree-ch @gol
427 -ftree-coalesce-vars  -ftree-copy-prop  -ftree-dce  -ftree-dominator-opts @gol
428 -ftree-dse  -ftree-forwprop  -ftree-fre  -fcode-hoisting @gol
429 -ftree-loop-if-convert  -ftree-loop-im @gol
430 -ftree-phiprop  -ftree-loop-distribution  -ftree-loop-distribute-patterns @gol
431 -ftree-loop-ivcanon  -ftree-loop-linear  -ftree-loop-optimize @gol
432 -ftree-loop-vectorize @gol
433 -ftree-parallelize-loops=@var{n}  -ftree-pre  -ftree-partial-pre  -ftree-pta @gol
434 -ftree-reassoc  -ftree-sink  -ftree-slsr  -ftree-sra @gol
435 -ftree-switch-conversion  -ftree-tail-merge @gol
436 -ftree-ter  -ftree-vectorize  -ftree-vrp  -funconstrained-commons @gol
437 -funit-at-a-time  -funroll-all-loops  -funroll-loops @gol
438 -funsafe-math-optimizations  -funswitch-loops @gol
439 -fipa-ra  -fvariable-expansion-in-unroller  -fvect-cost-model  -fvpt @gol
440 -fweb  -fwhole-program  -fwpa  -fuse-linker-plugin @gol
441 --param @var{name}=@var{value}
442 -O  -O0  -O1  -O2  -O3  -Os  -Ofast  -Og}
444 @item Program Instrumentation Options
445 @xref{Instrumentation Options,,Program Instrumentation Options}.
446 @gccoptlist{-p  -pg  -fprofile-arcs  --coverage  -ftest-coverage @gol
447 -fprofile-abs-path @gol
448 -fprofile-dir=@var{path}  -fprofile-generate  -fprofile-generate=@var{path} @gol
449 -fsanitize=@var{style}  -fsanitize-recover  -fsanitize-recover=@var{style} @gol
450 -fasan-shadow-offset=@var{number}  -fsanitize-sections=@var{s1},@var{s2},... @gol
451 -fsanitize-undefined-trap-on-error  -fbounds-check @gol
452 -fcheck-pointer-bounds  -fchkp-check-incomplete-type @gol
453 -fchkp-first-field-has-own-bounds  -fchkp-narrow-bounds @gol
454 -fchkp-narrow-to-innermost-array  -fchkp-optimize @gol
455 -fchkp-use-fast-string-functions  -fchkp-use-nochk-string-functions @gol
456 -fchkp-use-static-bounds  -fchkp-use-static-const-bounds @gol
457 -fchkp-treat-zero-dynamic-size-as-infinite  -fchkp-check-read @gol
458 -fchkp-check-read  -fchkp-check-write  -fchkp-store-bounds @gol
459 -fchkp-instrument-calls  -fchkp-instrument-marked-only @gol
460 -fchkp-use-wrappers  -fchkp-flexible-struct-trailing-arrays@gol
461 -fstack-protector  -fstack-protector-all  -fstack-protector-strong @gol
462 -fstack-protector-explicit  -fstack-check @gol
463 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
464 -fno-stack-limit  -fsplit-stack @gol
465 -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]} @gol
466 -fvtv-counts  -fvtv-debug @gol
467 -finstrument-functions @gol
468 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
469 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}}
471 @item Preprocessor Options
472 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
473 @gccoptlist{-A@var{question}=@var{answer} @gol
474 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
475 -C  -CC  -D@var{macro}@r{[}=@var{defn}@r{]} @gol
476 -dD  -dI  -dM  -dN  -dU @gol
477 -fdebug-cpp  -fdirectives-only  -fdollars-in-identifiers  @gol
478 -fexec-charset=@var{charset}  -fextended-identifiers  @gol
479 -finput-charset=@var{charset}  -fno-canonical-system-headers @gol
480 -fpch-deps  -fpch-preprocess  -fpreprocessed @gol
481 -ftabstop=@var{width}  -ftrack-macro-expansion  @gol
482 -fwide-exec-charset=@var{charset}  -fworking-directory @gol
483 -H  -imacros @var{file}  -include @var{file} @gol
484 -M  -MD  -MF  -MG  -MM  -MMD  -MP  -MQ  -MT @gol
485 -no-integrated-cpp  -P  -pthread  -remap @gol
486 -traditional  -traditional-cpp  -trigraphs @gol
487 -U@var{macro}  -undef  @gol
488 -Wp,@var{option}  -Xpreprocessor @var{option}}
490 @item Assembler Options
491 @xref{Assembler Options,,Passing Options to the Assembler}.
492 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
494 @item Linker Options
495 @xref{Link Options,,Options for Linking}.
496 @gccoptlist{@var{object-file-name}  -fuse-ld=@var{linker}  -l@var{library} @gol
497 -nostartfiles  -nodefaultlibs  -nostdlib  -pie  -pthread  -rdynamic @gol
498 -s  -static  -static-libgcc  -static-libstdc++ @gol
499 -static-libasan  -static-libtsan  -static-liblsan  -static-libubsan @gol
500 -static-libmpx  -static-libmpxwrappers @gol
501 -shared  -shared-libgcc  -symbolic @gol
502 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
503 -u @var{symbol}  -z @var{keyword}}
505 @item Directory Options
506 @xref{Directory Options,,Options for Directory Search}.
507 @gccoptlist{-B@var{prefix}  -I@var{dir}  -I- @gol
508 -idirafter @var{dir} @gol
509 -imacros @var{file}  -imultilib @var{dir} @gol
510 -iplugindir=@var{dir}  -iprefix @var{file} @gol
511 -iquote @var{dir}  -isysroot @var{dir}  -isystem @var{dir} @gol
512 -iwithprefix @var{dir}  -iwithprefixbefore @var{dir}  @gol
513 -L@var{dir}  -no-canonical-prefixes  --no-sysroot-suffix @gol
514 -nostdinc  -nostdinc++  --sysroot=@var{dir}}
516 @item Code Generation Options
517 @xref{Code Gen Options,,Options for Code Generation Conventions}.
518 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
519 -ffixed-@var{reg}  -fexceptions @gol
520 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
521 -fasynchronous-unwind-tables @gol
522 -fno-gnu-unique @gol
523 -finhibit-size-directive  -fno-common  -fno-ident @gol
524 -fpcc-struct-return  -fpic  -fPIC  -fpie  -fPIE  -fno-plt @gol
525 -fno-jump-tables @gol
526 -frecord-gcc-switches @gol
527 -freg-struct-return  -fshort-enums  -fshort-wchar @gol
528 -fverbose-asm  -fpack-struct[=@var{n}]  @gol
529 -fleading-underscore  -ftls-model=@var{model} @gol
530 -fstack-reuse=@var{reuse_level} @gol
531 -ftrampolines  -ftrapv  -fwrapv @gol
532 -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]} @gol
533 -fstrict-volatile-bitfields  -fsync-libcalls}
535 @item Developer Options
536 @xref{Developer Options,,GCC Developer Options}.
537 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
538 -dumpfullversion  -fchecking  -fchecking=@var{n}  -fdbg-cnt-list @gol
539 -fdbg-cnt=@var{counter-value-list} @gol
540 -fdisable-ipa-@var{pass_name} @gol
541 -fdisable-rtl-@var{pass_name} @gol
542 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
543 -fdisable-tree-@var{pass_name} @gol
544 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
545 -fdump-noaddr  -fdump-unnumbered  -fdump-unnumbered-links @gol
546 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
547 -fdump-final-insns@r{[}=@var{file}@r{]}
548 -fdump-ipa-all  -fdump-ipa-cgraph  -fdump-ipa-inline @gol
549 -fdump-lang-all @gol
550 -fdump-lang-@var{switch} @gol
551 -fdump-lang-@var{switch}-@var{options} @gol
552 -fdump-lang-@var{switch}-@var{options}=@var{filename} @gol
553 -fdump-passes @gol
554 -fdump-rtl-@var{pass}  -fdump-rtl-@var{pass}=@var{filename} @gol
555 -fdump-statistics @gol
556 -fdump-tree-all @gol
557 -fdump-tree-@var{switch} @gol
558 -fdump-tree-@var{switch}-@var{options} @gol
559 -fdump-tree-@var{switch}-@var{options}=@var{filename} @gol
560 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
561 -fenable-@var{kind}-@var{pass} @gol
562 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
563 -fira-verbose=@var{n} @gol
564 -flto-report  -flto-report-wpa  -fmem-report-wpa @gol
565 -fmem-report  -fpre-ipa-mem-report  -fpost-ipa-mem-report @gol
566 -fopt-info  -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
567 -fprofile-report @gol
568 -frandom-seed=@var{string}  -fsched-verbose=@var{n} @gol
569 -fsel-sched-verbose  -fsel-sched-dump-cfg  -fsel-sched-pipelining-verbose @gol
570 -fstats  -fstack-usage  -ftime-report  -ftime-report-details @gol
571 -fvar-tracking-assignments-toggle  -gtoggle @gol
572 -print-file-name=@var{library}  -print-libgcc-file-name @gol
573 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
574 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
575 -print-sysroot  -print-sysroot-headers-suffix @gol
576 -save-temps  -save-temps=cwd  -save-temps=obj  -time@r{[}=@var{file}@r{]}}
578 @item Machine-Dependent Options
579 @xref{Submodel Options,,Machine-Dependent Options}.
580 @c This list is ordered alphanumerically by subsection name.
581 @c Try and put the significant identifier (CPU or system) first,
582 @c so users have a clue at guessing where the ones they want will be.
584 @emph{AArch64 Options}
585 @gccoptlist{-mabi=@var{name}  -mbig-endian  -mlittle-endian @gol
586 -mgeneral-regs-only @gol
587 -mcmodel=tiny  -mcmodel=small  -mcmodel=large @gol
588 -mstrict-align @gol
589 -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
590 -mtls-dialect=desc  -mtls-dialect=traditional @gol
591 -mtls-size=@var{size} @gol
592 -mfix-cortex-a53-835769  -mno-fix-cortex-a53-835769 @gol
593 -mfix-cortex-a53-843419  -mno-fix-cortex-a53-843419 @gol
594 -mlow-precision-recip-sqrt  -mno-low-precision-recip-sqrt@gol
595 -mlow-precision-sqrt  -mno-low-precision-sqrt@gol
596 -mlow-precision-div  -mno-low-precision-div @gol
597 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}}
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 -mfloat-abi=@var{name} @gol
635 -mfp16-format=@var{name}
636 -mthumb-interwork  -mno-thumb-interwork @gol
637 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
638 -mtune=@var{name}  -mprint-tune-info @gol
639 -mstructure-size-boundary=@var{n} @gol
640 -mabort-on-noreturn @gol
641 -mlong-calls  -mno-long-calls @gol
642 -msingle-pic-base  -mno-single-pic-base @gol
643 -mpic-register=@var{reg} @gol
644 -mnop-fun-dllimport @gol
645 -mpoke-function-name @gol
646 -mthumb  -marm @gol
647 -mtpcs-frame  -mtpcs-leaf-frame @gol
648 -mcaller-super-interworking  -mcallee-super-interworking @gol
649 -mtp=@var{name}  -mtls-dialect=@var{dialect} @gol
650 -mword-relocations @gol
651 -mfix-cortex-m3-ldrd @gol
652 -munaligned-access @gol
653 -mneon-for-64bits @gol
654 -mslow-flash-data @gol
655 -masm-syntax-unified @gol
656 -mrestrict-it @gol
657 -mpure-code @gol
658 -mcmse}
660 @emph{AVR Options}
661 @gccoptlist{-mmcu=@var{mcu}  -mabsdata  -maccumulate-args @gol
662 -mbranch-cost=@var{cost} @gol
663 -mcall-prologues  -mint8  -mn_flash=@var{size}  -mno-interrupts @gol
664 -mrelax  -mrmw  -mstrict-X  -mtiny-stack  -mfract-convert-truncate @gol
665 -nodevicelib @gol
666 -Waddr-space-convert  -Wmisspelled-isr}
668 @emph{Blackfin Options}
669 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
670 -msim  -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
671 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
672 -mlow-64k  -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
673 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
674 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
675 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
676 -mfast-fp  -minline-plt  -mmulticore  -mcorea  -mcoreb  -msdram @gol
677 -micplb}
679 @emph{C6X Options}
680 @gccoptlist{-mbig-endian  -mlittle-endian  -march=@var{cpu} @gol
681 -msim  -msdata=@var{sdata-type}}
683 @emph{CRIS Options}
684 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
685 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
686 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
687 -mstack-align  -mdata-align  -mconst-align @gol
688 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
689 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
690 -mmul-bug-workaround  -mno-mul-bug-workaround}
692 @emph{CR16 Options}
693 @gccoptlist{-mmac @gol
694 -mcr16cplus  -mcr16c @gol
695 -msim  -mint32  -mbit-ops
696 -mdata-model=@var{model}}
698 @emph{Darwin Options}
699 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
700 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
701 -client_name  -compatibility_version  -current_version @gol
702 -dead_strip @gol
703 -dependency-file  -dylib_file  -dylinker_install_name @gol
704 -dynamic  -dynamiclib  -exported_symbols_list @gol
705 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
706 -force_flat_namespace  -headerpad_max_install_names @gol
707 -iframework @gol
708 -image_base  -init  -install_name  -keep_private_externs @gol
709 -multi_module  -multiply_defined  -multiply_defined_unused @gol
710 -noall_load   -no_dead_strip_inits_and_terms @gol
711 -nofixprebinding  -nomultidefs  -noprebind  -noseglinkedit @gol
712 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
713 -private_bundle  -read_only_relocs  -sectalign @gol
714 -sectobjectsymbols  -whyload  -seg1addr @gol
715 -sectcreate  -sectobjectsymbols  -sectorder @gol
716 -segaddr  -segs_read_only_addr  -segs_read_write_addr @gol
717 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
718 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
719 -single_module  -static  -sub_library  -sub_umbrella @gol
720 -twolevel_namespace  -umbrella  -undefined @gol
721 -unexported_symbols_list  -weak_reference_mismatches @gol
722 -whatsloaded  -F  -gused  -gfull  -mmacosx-version-min=@var{version} @gol
723 -mkernel  -mone-byte-bool}
725 @emph{DEC Alpha Options}
726 @gccoptlist{-mno-fp-regs  -msoft-float @gol
727 -mieee  -mieee-with-inexact  -mieee-conformant @gol
728 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
729 -mtrap-precision=@var{mode}  -mbuild-constants @gol
730 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
731 -mbwx  -mmax  -mfix  -mcix @gol
732 -mfloat-vax  -mfloat-ieee @gol
733 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
734 -msmall-text  -mlarge-text @gol
735 -mmemory-latency=@var{time}}
737 @emph{FR30 Options}
738 @gccoptlist{-msmall-model  -mno-lsim}
740 @emph{FT32 Options}
741 @gccoptlist{-msim  -mlra  -mnodiv}
743 @emph{FRV Options}
744 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
745 -mhard-float  -msoft-float @gol
746 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
747 -mdouble  -mno-double @gol
748 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
749 -mfdpic  -minline-plt  -mgprel-ro  -multilib-library-pic @gol
750 -mlinked-fp  -mlong-calls  -malign-labels @gol
751 -mlibrary-pic  -macc-4  -macc-8 @gol
752 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
753 -moptimize-membar  -mno-optimize-membar @gol
754 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
755 -mvliw-branch  -mno-vliw-branch @gol
756 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
757 -mno-nested-cond-exec  -mtomcat-stats @gol
758 -mTLS  -mtls @gol
759 -mcpu=@var{cpu}}
761 @emph{GNU/Linux Options}
762 @gccoptlist{-mglibc  -muclibc  -mmusl  -mbionic  -mandroid @gol
763 -tno-android-cc  -tno-android-ld}
765 @emph{H8/300 Options}
766 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr  -mno-exr  -mint32  -malign-300}
768 @emph{HPPA Options}
769 @gccoptlist{-march=@var{architecture-type} @gol
770 -mcaller-copies  -mdisable-fpregs  -mdisable-indexing @gol
771 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
772 -mfixed-range=@var{register-range} @gol
773 -mjump-in-delay  -mlinker-opt  -mlong-calls @gol
774 -mlong-load-store  -mno-disable-fpregs @gol
775 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
776 -mno-jump-in-delay  -mno-long-load-store @gol
777 -mno-portable-runtime  -mno-soft-float @gol
778 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
779 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
780 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
781 -munix=@var{unix-std}  -nolibdld  -static  -threads}
783 @emph{IA-64 Options}
784 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
785 -mvolatile-asm-stop  -mregister-names  -msdata  -mno-sdata @gol
786 -mconstant-gp  -mauto-pic  -mfused-madd @gol
787 -minline-float-divide-min-latency @gol
788 -minline-float-divide-max-throughput @gol
789 -mno-inline-float-divide @gol
790 -minline-int-divide-min-latency @gol
791 -minline-int-divide-max-throughput  @gol
792 -mno-inline-int-divide @gol
793 -minline-sqrt-min-latency  -minline-sqrt-max-throughput @gol
794 -mno-inline-sqrt @gol
795 -mdwarf2-asm  -mearly-stop-bits @gol
796 -mfixed-range=@var{register-range}  -mtls-size=@var{tls-size} @gol
797 -mtune=@var{cpu-type}  -milp32  -mlp64 @gol
798 -msched-br-data-spec  -msched-ar-data-spec  -msched-control-spec @gol
799 -msched-br-in-data-spec  -msched-ar-in-data-spec  -msched-in-control-spec @gol
800 -msched-spec-ldc  -msched-spec-control-ldc @gol
801 -msched-prefer-non-data-spec-insns  -msched-prefer-non-control-spec-insns @gol
802 -msched-stop-bits-after-every-cycle  -msched-count-spec-in-critical-path @gol
803 -msel-sched-dont-check-control-spec  -msched-fp-mem-deps-zero-cost @gol
804 -msched-max-memory-insns-hard-limit  -msched-max-memory-insns=@var{max-insns}}
806 @emph{LM32 Options}
807 @gccoptlist{-mbarrel-shift-enabled  -mdivide-enabled  -mmultiply-enabled @gol
808 -msign-extend-enabled  -muser-enabled}
810 @emph{M32R/D Options}
811 @gccoptlist{-m32r2  -m32rx  -m32r @gol
812 -mdebug @gol
813 -malign-loops  -mno-align-loops @gol
814 -missue-rate=@var{number} @gol
815 -mbranch-cost=@var{number} @gol
816 -mmodel=@var{code-size-model-type} @gol
817 -msdata=@var{sdata-type} @gol
818 -mno-flush-func  -mflush-func=@var{name} @gol
819 -mno-flush-trap  -mflush-trap=@var{number} @gol
820 -G @var{num}}
822 @emph{M32C Options}
823 @gccoptlist{-mcpu=@var{cpu}  -msim  -memregs=@var{number}}
825 @emph{M680x0 Options}
826 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune} @gol
827 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
828 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
829 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
830 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
831 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
832 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
833 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
834 -mxgot  -mno-xgot  -mlong-jump-table-offsets}
836 @emph{MCore Options}
837 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
838 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
839 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
840 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
841 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
843 @emph{MeP Options}
844 @gccoptlist{-mabsdiff  -mall-opts  -maverage  -mbased=@var{n}  -mbitops @gol
845 -mc=@var{n}  -mclip  -mconfig=@var{name}  -mcop  -mcop32  -mcop64  -mivc2 @gol
846 -mdc  -mdiv  -meb  -mel  -mio-volatile  -ml  -mleadz  -mm  -mminmax @gol
847 -mmult  -mno-opts  -mrepeat  -ms  -msatur  -msdram  -msim  -msimnovec  -mtf @gol
848 -mtiny=@var{n}}
850 @emph{MicroBlaze Options}
851 @gccoptlist{-msoft-float  -mhard-float  -msmall-divides  -mcpu=@var{cpu} @gol
852 -mmemcpy  -mxl-soft-mul  -mxl-soft-div  -mxl-barrel-shift @gol
853 -mxl-pattern-compare  -mxl-stack-check  -mxl-gp-opt  -mno-clearbss @gol
854 -mxl-multiply-high  -mxl-float-convert  -mxl-float-sqrt @gol
855 -mbig-endian  -mlittle-endian  -mxl-reorder  -mxl-mode-@var{app-model}}
857 @emph{MIPS Options}
858 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
859 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips32r3  -mips32r5 @gol
860 -mips32r6  -mips64  -mips64r2  -mips64r3  -mips64r5  -mips64r6 @gol
861 -mips16  -mno-mips16  -mflip-mips16 @gol
862 -minterlink-compressed  -mno-interlink-compressed @gol
863 -minterlink-mips16  -mno-interlink-mips16 @gol
864 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
865 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
866 -mgp32  -mgp64  -mfp32  -mfpxx  -mfp64  -mhard-float  -msoft-float @gol
867 -mno-float  -msingle-float  -mdouble-float @gol
868 -modd-spreg  -mno-odd-spreg @gol
869 -mabs=@var{mode}  -mnan=@var{encoding} @gol
870 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
871 -mmcu  -mmno-mcu @gol
872 -meva  -mno-eva @gol
873 -mvirt  -mno-virt @gol
874 -mxpa  -mno-xpa @gol
875 -mmicromips  -mno-micromips @gol
876 -mmsa  -mno-msa @gol
877 -mfpu=@var{fpu-type} @gol
878 -msmartmips  -mno-smartmips @gol
879 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
880 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
881 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
882 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
883 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
884 -membedded-data  -mno-embedded-data @gol
885 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
886 -mcode-readable=@var{setting} @gol
887 -msplit-addresses  -mno-split-addresses @gol
888 -mexplicit-relocs  -mno-explicit-relocs @gol
889 -mcheck-zero-division  -mno-check-zero-division @gol
890 -mdivide-traps  -mdivide-breaks @gol
891 -mload-store-pairs  -mno-load-store-pairs @gol
892 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
893 -mmad  -mno-mad  -mimadd  -mno-imadd  -mfused-madd  -mno-fused-madd  -nocpp @gol
894 -mfix-24k  -mno-fix-24k @gol
895 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
896 -mfix-r10000  -mno-fix-r10000  -mfix-rm7000  -mno-fix-rm7000 @gol
897 -mfix-vr4120  -mno-fix-vr4120 @gol
898 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
899 -mflush-func=@var{func}  -mno-flush-func @gol
900 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
901 -mcompact-branches=@var{policy} @gol
902 -mfp-exceptions  -mno-fp-exceptions @gol
903 -mvr4130-align  -mno-vr4130-align  -msynci  -mno-synci @gol
904 -mlxc1-sxc1 -mno-lxc1-sxc1 -mmadd4 -mno-madd4 @gol
905 -mrelax-pic-calls  -mno-relax-pic-calls  -mmcount-ra-address @gol
906 -mframe-header-opt  -mno-frame-header-opt}
908 @emph{MMIX Options}
909 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
910 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
911 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
912 -mno-base-addresses  -msingle-exit  -mno-single-exit}
914 @emph{MN10300 Options}
915 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
916 -mno-am33  -mam33  -mam33-2  -mam34 @gol
917 -mtune=@var{cpu-type} @gol
918 -mreturn-pointer-on-d0 @gol
919 -mno-crt0  -mrelax  -mliw  -msetlb}
921 @emph{Moxie Options}
922 @gccoptlist{-meb  -mel  -mmul.x  -mno-crt0}
924 @emph{MSP430 Options}
925 @gccoptlist{-msim  -masm-hex  -mmcu=  -mcpu=  -mlarge  -msmall  -mrelax @gol
926 -mwarn-mcu @gol
927 -mcode-region=  -mdata-region= @gol
928 -msilicon-errata=  -msilicon-errata-warn= @gol
929 -mhwmult=  -minrt}
931 @emph{NDS32 Options}
932 @gccoptlist{-mbig-endian  -mlittle-endian @gol
933 -mreduced-regs  -mfull-regs @gol
934 -mcmov  -mno-cmov @gol
935 -mperf-ext  -mno-perf-ext @gol
936 -mv3push  -mno-v3push @gol
937 -m16bit  -mno-16bit @gol
938 -misr-vector-size=@var{num} @gol
939 -mcache-block-size=@var{num} @gol
940 -march=@var{arch} @gol
941 -mcmodel=@var{code-model} @gol
942 -mctor-dtor  -mrelax}
944 @emph{Nios II Options}
945 @gccoptlist{-G @var{num}  -mgpopt=@var{option}  -mgpopt  -mno-gpopt @gol
946 -mel  -meb @gol
947 -mno-bypass-cache  -mbypass-cache @gol
948 -mno-cache-volatile  -mcache-volatile @gol
949 -mno-fast-sw-div  -mfast-sw-div @gol
950 -mhw-mul  -mno-hw-mul  -mhw-mulx  -mno-hw-mulx  -mno-hw-div  -mhw-div @gol
951 -mcustom-@var{insn}=@var{N}  -mno-custom-@var{insn} @gol
952 -mcustom-fpu-cfg=@var{name} @gol
953 -mhal  -msmallc  -msys-crt0=@var{name}  -msys-lib=@var{name} @gol
954 -march=@var{arch}  -mbmx  -mno-bmx  -mcdx  -mno-cdx}
956 @emph{Nvidia PTX Options}
957 @gccoptlist{-m32  -m64  -mmainkernel  -moptimize}
959 @emph{PDP-11 Options}
960 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
961 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
962 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
963 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
964 -mbranch-expensive  -mbranch-cheap @gol
965 -munix-asm  -mdec-asm}
967 @emph{picoChip Options}
968 @gccoptlist{-mae=@var{ae_type}  -mvliw-lookahead=@var{N} @gol
969 -msymbol-as-address  -mno-inefficient-warnings}
971 @emph{PowerPC Options}
972 See RS/6000 and PowerPC Options.
974 @emph{RISC-V Options}
975 @gccoptlist{-mbranch-cost=@var{N-instruction} @gol
976 -mmemcpy  -mno-memcpy @gol
977 -mplt  -mno-plt @gol
978 -mabi=@var{ABI-string} @gol
979 -mfdiv  -mno-fdiv @gol
980 -mdiv  -mno-div @gol
981 -march=@var{ISA-string} @gol
982 -mtune=@var{processor-string} @gol
983 -msmall-data-limit=@var{N-bytes} @gol
984 -msave-restore  -mno-save-restore @gol
985 -mstrict-align -mno-strict-align @gol
986 -mcmodel=@var{code-model} @gol
987 -mexplicit-relocs  -mno-explicit-relocs @gol}
989 @emph{RL78 Options}
990 @gccoptlist{-msim  -mmul=none  -mmul=g13  -mmul=g14  -mallregs @gol
991 -mcpu=g10  -mcpu=g13  -mcpu=g14  -mg10  -mg13  -mg14 @gol
992 -m64bit-doubles  -m32bit-doubles  -msave-mduc-in-interrupts}
994 @emph{RS/6000 and PowerPC Options}
995 @gccoptlist{-mcpu=@var{cpu-type} @gol
996 -mtune=@var{cpu-type} @gol
997 -mcmodel=@var{code-model} @gol
998 -mpowerpc64 @gol
999 -maltivec  -mno-altivec @gol
1000 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
1001 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
1002 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mpopcntd  -mno-popcntd @gol
1003 -mfprnd  -mno-fprnd @gol
1004 -mcmpb  -mno-cmpb  -mmfpgpr  -mno-mfpgpr  -mhard-dfp  -mno-hard-dfp @gol
1005 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
1006 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
1007 -malign-power  -malign-natural @gol
1008 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
1009 -msingle-float  -mdouble-float  -msimple-fpu @gol
1010 -mstring  -mno-string  -mupdate  -mno-update @gol
1011 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
1012 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
1013 -mstrict-align  -mno-strict-align  -mrelocatable @gol
1014 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
1015 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
1016 -mdynamic-no-pic  -maltivec  -mswdiv  -msingle-pic-base @gol
1017 -mprioritize-restricted-insns=@var{priority} @gol
1018 -msched-costly-dep=@var{dependence_type} @gol
1019 -minsert-sched-nops=@var{scheme} @gol
1020 -mcall-sysv  -mcall-netbsd @gol
1021 -maix-struct-return  -msvr4-struct-return @gol
1022 -mabi=@var{abi-type}  -msecure-plt  -mbss-plt @gol
1023 -mblock-move-inline-limit=@var{num} @gol
1024 -misel  -mno-isel @gol
1025 -misel=yes  -misel=no @gol
1026 -mspe  -mno-spe @gol
1027 -mspe=yes  -mspe=no @gol
1028 -mpaired @gol
1029 -mvrsave  -mno-vrsave @gol
1030 -mmulhw  -mno-mulhw @gol
1031 -mdlmzb  -mno-dlmzb @gol
1032 -mfloat-gprs=yes  -mfloat-gprs=no  -mfloat-gprs=single  -mfloat-gprs=double @gol
1033 -mprototype  -mno-prototype @gol
1034 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
1035 -msdata=@var{opt}  -mvxworks  -G @var{num} @gol
1036 -mrecip  -mrecip=@var{opt}  -mno-recip  -mrecip-precision @gol
1037 -mno-recip-precision @gol
1038 -mveclibabi=@var{type}  -mfriz  -mno-friz @gol
1039 -mpointers-to-nested-functions  -mno-pointers-to-nested-functions @gol
1040 -msave-toc-indirect  -mno-save-toc-indirect @gol
1041 -mpower8-fusion  -mno-mpower8-fusion  -mpower8-vector  -mno-power8-vector @gol
1042 -mcrypto  -mno-crypto  -mhtm  -mno-htm  -mdirect-move  -mno-direct-move @gol
1043 -mquad-memory  -mno-quad-memory @gol
1044 -mquad-memory-atomic  -mno-quad-memory-atomic @gol
1045 -mcompat-align-parm  -mno-compat-align-parm @gol
1046 -mupper-regs-df  -mno-upper-regs-df  -mupper-regs-sf  -mno-upper-regs-sf @gol
1047 -mupper-regs-di  -mno-upper-regs-di @gol
1048 -mupper-regs  -mno-upper-regs @gol
1049 -mfloat128  -mno-float128  -mfloat128-hardware  -mno-float128-hardware @gol
1050 -mgnu-attribute  -mno-gnu-attribute @gol
1051 -mstack-protector-guard=@var{guard} -mstack-protector-guard-reg=@var{reg} @gol
1052 -mstack-protector-guard-offset=@var{offset} @gol
1053 -mlra  -mno-lra}
1055 @emph{RX Options}
1056 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
1057 -mcpu=@gol
1058 -mbig-endian-data  -mlittle-endian-data @gol
1059 -msmall-data @gol
1060 -msim  -mno-sim@gol
1061 -mas100-syntax  -mno-as100-syntax@gol
1062 -mrelax@gol
1063 -mmax-constant-size=@gol
1064 -mint-register=@gol
1065 -mpid@gol
1066 -mallow-string-insns  -mno-allow-string-insns@gol
1067 -mjsr@gol
1068 -mno-warn-multiple-fast-interrupts@gol
1069 -msave-acc-in-interrupts}
1071 @emph{S/390 and zSeries Options}
1072 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1073 -mhard-float  -msoft-float  -mhard-dfp  -mno-hard-dfp @gol
1074 -mlong-double-64  -mlong-double-128 @gol
1075 -mbackchain  -mno-backchain  -mpacked-stack  -mno-packed-stack @gol
1076 -msmall-exec  -mno-small-exec  -mmvcle  -mno-mvcle @gol
1077 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
1078 -mhtm  -mvx  -mzvector @gol
1079 -mtpf-trace  -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
1080 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size  -mstack-guard @gol
1081 -mhotpatch=@var{halfwords},@var{halfwords}}
1083 @emph{Score Options}
1084 @gccoptlist{-meb  -mel @gol
1085 -mnhwloop @gol
1086 -muls @gol
1087 -mmac @gol
1088 -mscore5  -mscore5u  -mscore7  -mscore7d}
1090 @emph{SH Options}
1091 @gccoptlist{-m1  -m2  -m2e @gol
1092 -m2a-nofpu  -m2a-single-only  -m2a-single  -m2a @gol
1093 -m3  -m3e @gol
1094 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
1095 -m4a-nofpu  -m4a-single-only  -m4a-single  -m4a  -m4al @gol
1096 -mb  -ml  -mdalign  -mrelax @gol
1097 -mbigtable  -mfmovd  -mrenesas  -mno-renesas  -mnomacsave @gol
1098 -mieee  -mno-ieee  -mbitops  -misize  -minline-ic_invalidate  -mpadstruct @gol
1099 -mprefergot  -musermode  -multcost=@var{number}  -mdiv=@var{strategy} @gol
1100 -mdivsi3_libfunc=@var{name}  -mfixed-range=@var{register-range} @gol
1101 -maccumulate-outgoing-args @gol
1102 -matomic-model=@var{atomic-model} @gol
1103 -mbranch-cost=@var{num}  -mzdcbranch  -mno-zdcbranch @gol
1104 -mcbranch-force-delay-slot @gol
1105 -mfused-madd  -mno-fused-madd  -mfsca  -mno-fsca  -mfsrra  -mno-fsrra @gol
1106 -mpretend-cmove  -mtas}
1108 @emph{Solaris 2 Options}
1109 @gccoptlist{-mclear-hwcap  -mno-clear-hwcap  -mimpure-text  -mno-impure-text @gol
1110 -pthreads}
1112 @emph{SPARC Options}
1113 @gccoptlist{-mcpu=@var{cpu-type} @gol
1114 -mtune=@var{cpu-type} @gol
1115 -mcmodel=@var{code-model} @gol
1116 -mmemory-model=@var{mem-model} @gol
1117 -m32  -m64  -mapp-regs  -mno-app-regs @gol
1118 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
1119 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1120 -mhard-quad-float  -msoft-quad-float @gol
1121 -mstack-bias  -mno-stack-bias @gol
1122 -mstd-struct-return  -mno-std-struct-return @gol
1123 -munaligned-doubles  -mno-unaligned-doubles @gol
1124 -muser-mode  -mno-user-mode @gol
1125 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
1126 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
1127 -mcbcond  -mno-cbcond  -mfmaf  -mno-fmaf  @gol
1128 -mpopc  -mno-popc  -msubxc  -mno-subxc@gol
1129 -mfix-at697f  -mfix-ut699 @gol
1130 -mlra  -mno-lra}
1132 @emph{SPU Options}
1133 @gccoptlist{-mwarn-reloc  -merror-reloc @gol
1134 -msafe-dma  -munsafe-dma @gol
1135 -mbranch-hints @gol
1136 -msmall-mem  -mlarge-mem  -mstdmain @gol
1137 -mfixed-range=@var{register-range} @gol
1138 -mea32  -mea64 @gol
1139 -maddress-space-conversion  -mno-address-space-conversion @gol
1140 -mcache-size=@var{cache-size} @gol
1141 -matomic-updates  -mno-atomic-updates}
1143 @emph{System V Options}
1144 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
1146 @emph{TILE-Gx Options}
1147 @gccoptlist{-mcpu=CPU  -m32  -m64  -mbig-endian  -mlittle-endian @gol
1148 -mcmodel=@var{code-model}}
1150 @emph{TILEPro Options}
1151 @gccoptlist{-mcpu=@var{cpu}  -m32}
1153 @emph{V850 Options}
1154 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
1155 -mprolog-function  -mno-prolog-function  -mspace @gol
1156 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
1157 -mapp-regs  -mno-app-regs @gol
1158 -mdisable-callt  -mno-disable-callt @gol
1159 -mv850e2v3  -mv850e2  -mv850e1  -mv850es @gol
1160 -mv850e  -mv850  -mv850e3v5 @gol
1161 -mloop @gol
1162 -mrelax @gol
1163 -mlong-jumps @gol
1164 -msoft-float @gol
1165 -mhard-float @gol
1166 -mgcc-abi @gol
1167 -mrh850-abi @gol
1168 -mbig-switch}
1170 @emph{VAX Options}
1171 @gccoptlist{-mg  -mgnu  -munix}
1173 @emph{Visium Options}
1174 @gccoptlist{-mdebug  -msim  -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1175 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type}  -msv-mode  -muser-mode}
1177 @emph{VMS Options}
1178 @gccoptlist{-mvms-return-codes  -mdebug-main=@var{prefix}  -mmalloc64 @gol
1179 -mpointer-size=@var{size}}
1181 @emph{VxWorks Options}
1182 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1183 -Xbind-lazy  -Xbind-now}
1185 @emph{x86 Options}
1186 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1187 -mtune-ctrl=@var{feature-list}  -mdump-tune-features  -mno-default @gol
1188 -mfpmath=@var{unit} @gol
1189 -masm=@var{dialect}  -mno-fancy-math-387 @gol
1190 -mno-fp-ret-in-387  -m80387  -mhard-float  -msoft-float @gol
1191 -mno-wide-multiply  -mrtd  -malign-double @gol
1192 -mpreferred-stack-boundary=@var{num} @gol
1193 -mincoming-stack-boundary=@var{num} @gol
1194 -mcld  -mcx16  -msahf  -mmovbe  -mcrc32 @gol
1195 -mrecip  -mrecip=@var{opt} @gol
1196 -mvzeroupper  -mprefer-avx128 @gol
1197 -mmmx  -msse  -msse2  -msse3  -mssse3  -msse4.1  -msse4.2  -msse4  -mavx @gol
1198 -mavx2  -mavx512f  -mavx512pf  -mavx512er  -mavx512cd  -mavx512vl @gol
1199 -mavx512bw  -mavx512dq  -mavx512ifma  -mavx512vbmi  -msha  -maes @gol
1200 -mpclmul  -mfsgsbase  -mrdrnd  -mf16c  -mfma @gol
1201 -mprefetchwt1  -mclflushopt  -mxsavec  -mxsaves @gol
1202 -msse4a  -m3dnow  -m3dnowa  -mpopcnt  -mabm  -mbmi  -mtbm  -mfma4  -mxop @gol
1203 -mlzcnt  -mbmi2  -mfxsr  -mxsave  -mxsaveopt  -mrtm  -mlwp  -mmpx  @gol
1204 -mmwaitx  -mclzero  -mpku  -mthreads @gol
1205 -mms-bitfields  -mno-align-stringops  -minline-all-stringops @gol
1206 -minline-stringops-dynamically  -mstringop-strategy=@var{alg} @gol
1207 -mmemcpy-strategy=@var{strategy}  -mmemset-strategy=@var{strategy} @gol
1208 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
1209 -m96bit-long-double  -mlong-double-64  -mlong-double-80  -mlong-double-128 @gol
1210 -mregparm=@var{num}  -msseregparm @gol
1211 -mveclibabi=@var{type}  -mvect8-ret-in-mem @gol
1212 -mpc32  -mpc64  -mpc80  -mstackrealign @gol
1213 -momit-leaf-frame-pointer  -mno-red-zone  -mno-tls-direct-seg-refs @gol
1214 -mcmodel=@var{code-model}  -mabi=@var{name}  -maddress-mode=@var{mode} @gol
1215 -m32  -m64  -mx32  -m16  -miamcu  -mlarge-data-threshold=@var{num} @gol
1216 -msse2avx  -mfentry  -mrecord-mcount  -mnop-mcount  -m8bit-idiv @gol
1217 -mavx256-split-unaligned-load  -mavx256-split-unaligned-store @gol
1218 -malign-data=@var{type}  -mstack-protector-guard=@var{guard} @gol
1219 -mmitigate-rop  -mgeneral-regs-only  -mcall-ms2sysv-xlogues}
1221 @emph{x86 Windows Options}
1222 @gccoptlist{-mconsole  -mcygwin  -mno-cygwin  -mdll @gol
1223 -mnop-fun-dllimport  -mthread @gol
1224 -municode  -mwin32  -mwindows  -fno-set-stack-executable}
1226 @emph{Xstormy16 Options}
1227 @gccoptlist{-msim}
1229 @emph{Xtensa Options}
1230 @gccoptlist{-mconst16  -mno-const16 @gol
1231 -mfused-madd  -mno-fused-madd @gol
1232 -mforce-no-pic @gol
1233 -mserialize-volatile  -mno-serialize-volatile @gol
1234 -mtext-section-literals  -mno-text-section-literals @gol
1235 -mauto-litpools  -mno-auto-litpools @gol
1236 -mtarget-align  -mno-target-align @gol
1237 -mlongcalls  -mno-longcalls}
1239 @emph{zSeries Options}
1240 See S/390 and zSeries Options.
1241 @end table
1244 @node Overall Options
1245 @section Options Controlling the Kind of Output
1247 Compilation can involve up to four stages: preprocessing, compilation
1248 proper, assembly and linking, always in that order.  GCC is capable of
1249 preprocessing and compiling several files either into several
1250 assembler input files, or into one assembler input file; then each
1251 assembler input file produces an object file, and linking combines all
1252 the object files (those newly compiled, and those specified as input)
1253 into an executable file.
1255 @cindex file name suffix
1256 For any given input file, the file name suffix determines what kind of
1257 compilation is done:
1259 @table @gcctabopt
1260 @item @var{file}.c
1261 C source code that must be preprocessed.
1263 @item @var{file}.i
1264 C source code that should not be preprocessed.
1266 @item @var{file}.ii
1267 C++ source code that should not be preprocessed.
1269 @item @var{file}.m
1270 Objective-C source code.  Note that you must link with the @file{libobjc}
1271 library to make an Objective-C program work.
1273 @item @var{file}.mi
1274 Objective-C source code that should not be preprocessed.
1276 @item @var{file}.mm
1277 @itemx @var{file}.M
1278 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1279 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1280 to a literal capital M@.
1282 @item @var{file}.mii
1283 Objective-C++ source code that should not be preprocessed.
1285 @item @var{file}.h
1286 C, C++, Objective-C or Objective-C++ header file to be turned into a
1287 precompiled header (default), or C, C++ header file to be turned into an
1288 Ada spec (via the @option{-fdump-ada-spec} switch).
1290 @item @var{file}.cc
1291 @itemx @var{file}.cp
1292 @itemx @var{file}.cxx
1293 @itemx @var{file}.cpp
1294 @itemx @var{file}.CPP
1295 @itemx @var{file}.c++
1296 @itemx @var{file}.C
1297 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1298 the last two letters must both be literally @samp{x}.  Likewise,
1299 @samp{.C} refers to a literal capital C@.
1301 @item @var{file}.mm
1302 @itemx @var{file}.M
1303 Objective-C++ source code that must be preprocessed.
1305 @item @var{file}.mii
1306 Objective-C++ source code that should not be preprocessed.
1308 @item @var{file}.hh
1309 @itemx @var{file}.H
1310 @itemx @var{file}.hp
1311 @itemx @var{file}.hxx
1312 @itemx @var{file}.hpp
1313 @itemx @var{file}.HPP
1314 @itemx @var{file}.h++
1315 @itemx @var{file}.tcc
1316 C++ header file to be turned into a precompiled header or Ada spec.
1318 @item @var{file}.f
1319 @itemx @var{file}.for
1320 @itemx @var{file}.ftn
1321 Fixed form Fortran source code that should not be preprocessed.
1323 @item @var{file}.F
1324 @itemx @var{file}.FOR
1325 @itemx @var{file}.fpp
1326 @itemx @var{file}.FPP
1327 @itemx @var{file}.FTN
1328 Fixed form Fortran source code that must be preprocessed (with the traditional
1329 preprocessor).
1331 @item @var{file}.f90
1332 @itemx @var{file}.f95
1333 @itemx @var{file}.f03
1334 @itemx @var{file}.f08
1335 Free form Fortran source code that should not be preprocessed.
1337 @item @var{file}.F90
1338 @itemx @var{file}.F95
1339 @itemx @var{file}.F03
1340 @itemx @var{file}.F08
1341 Free form Fortran source code that must be preprocessed (with the
1342 traditional preprocessor).
1344 @item @var{file}.go
1345 Go source code.
1347 @item @var{file}.brig
1348 BRIG files (binary representation of HSAIL).
1350 @item @var{file}.ads
1351 Ada source code file that contains a library unit declaration (a
1352 declaration of a package, subprogram, or generic, or a generic
1353 instantiation), or a library unit renaming declaration (a package,
1354 generic, or subprogram renaming declaration).  Such files are also
1355 called @dfn{specs}.
1357 @item @var{file}.adb
1358 Ada source code file containing a library unit body (a subprogram or
1359 package body).  Such files are also called @dfn{bodies}.
1361 @c GCC also knows about some suffixes for languages not yet included:
1362 @c Pascal:
1363 @c @var{file}.p
1364 @c @var{file}.pas
1365 @c Ratfor:
1366 @c @var{file}.r
1368 @item @var{file}.s
1369 Assembler code.
1371 @item @var{file}.S
1372 @itemx @var{file}.sx
1373 Assembler code that must be preprocessed.
1375 @item @var{other}
1376 An object file to be fed straight into linking.
1377 Any file name with no recognized suffix is treated this way.
1378 @end table
1380 @opindex x
1381 You can specify the input language explicitly with the @option{-x} option:
1383 @table @gcctabopt
1384 @item -x @var{language}
1385 Specify explicitly the @var{language} for the following input files
1386 (rather than letting the compiler choose a default based on the file
1387 name suffix).  This option applies to all following input files until
1388 the next @option{-x} option.  Possible values for @var{language} are:
1389 @smallexample
1390 c  c-header  cpp-output
1391 c++  c++-header  c++-cpp-output
1392 objective-c  objective-c-header  objective-c-cpp-output
1393 objective-c++ objective-c++-header objective-c++-cpp-output
1394 assembler  assembler-with-cpp
1396 f77  f77-cpp-input f95  f95-cpp-input
1398 brig
1399 @end smallexample
1401 @item -x none
1402 Turn off any specification of a language, so that subsequent files are
1403 handled according to their file name suffixes (as they are if @option{-x}
1404 has not been used at all).
1405 @end table
1407 If you only want some of the stages of compilation, you can use
1408 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1409 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1410 @command{gcc} is to stop.  Note that some combinations (for example,
1411 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1413 @table @gcctabopt
1414 @item -c
1415 @opindex c
1416 Compile or assemble the source files, but do not link.  The linking
1417 stage simply is not done.  The ultimate output is in the form of an
1418 object file for each source file.
1420 By default, the object file name for a source file is made by replacing
1421 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1423 Unrecognized input files, not requiring compilation or assembly, are
1424 ignored.
1426 @item -S
1427 @opindex S
1428 Stop after the stage of compilation proper; do not assemble.  The output
1429 is in the form of an assembler code file for each non-assembler input
1430 file specified.
1432 By default, the assembler file name for a source file is made by
1433 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1435 Input files that don't require compilation are ignored.
1437 @item -E
1438 @opindex E
1439 Stop after the preprocessing stage; do not run the compiler proper.  The
1440 output is in the form of preprocessed source code, which is sent to the
1441 standard output.
1443 Input files that don't require preprocessing are ignored.
1445 @cindex output file option
1446 @item -o @var{file}
1447 @opindex o
1448 Place output in file @var{file}.  This applies to whatever
1449 sort of output is being produced, whether it be an executable file,
1450 an object file, an assembler file or preprocessed C code.
1452 If @option{-o} is not specified, the default is to put an executable
1453 file in @file{a.out}, the object file for
1454 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1455 assembler file in @file{@var{source}.s}, a precompiled header file in
1456 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1457 standard output.
1459 @item -v
1460 @opindex v
1461 Print (on standard error output) the commands executed to run the stages
1462 of compilation.  Also print the version number of the compiler driver
1463 program and of the preprocessor and the compiler proper.
1465 @item -###
1466 @opindex ###
1467 Like @option{-v} except the commands are not executed and arguments
1468 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1469 This is useful for shell scripts to capture the driver-generated command lines.
1471 @item --help
1472 @opindex help
1473 Print (on the standard output) a description of the command-line options
1474 understood by @command{gcc}.  If the @option{-v} option is also specified
1475 then @option{--help} is also passed on to the various processes
1476 invoked by @command{gcc}, so that they can display the command-line options
1477 they accept.  If the @option{-Wextra} option has also been specified
1478 (prior to the @option{--help} option), then command-line options that
1479 have no documentation associated with them are also displayed.
1481 @item --target-help
1482 @opindex target-help
1483 Print (on the standard output) a description of target-specific command-line
1484 options for each tool.  For some targets extra target-specific
1485 information may also be printed.
1487 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1488 Print (on the standard output) a description of the command-line
1489 options understood by the compiler that fit into all specified classes
1490 and qualifiers.  These are the supported classes:
1492 @table @asis
1493 @item @samp{optimizers}
1494 Display all of the optimization options supported by the
1495 compiler.
1497 @item @samp{warnings}
1498 Display all of the options controlling warning messages
1499 produced by the compiler.
1501 @item @samp{target}
1502 Display target-specific options.  Unlike the
1503 @option{--target-help} option however, target-specific options of the
1504 linker and assembler are not displayed.  This is because those
1505 tools do not currently support the extended @option{--help=} syntax.
1507 @item @samp{params}
1508 Display the values recognized by the @option{--param}
1509 option.
1511 @item @var{language}
1512 Display the options supported for @var{language}, where
1513 @var{language} is the name of one of the languages supported in this
1514 version of GCC@.
1516 @item @samp{common}
1517 Display the options that are common to all languages.
1518 @end table
1520 These are the supported qualifiers:
1522 @table @asis
1523 @item @samp{undocumented}
1524 Display only those options that are undocumented.
1526 @item @samp{joined}
1527 Display options taking an argument that appears after an equal
1528 sign in the same continuous piece of text, such as:
1529 @samp{--help=target}.
1531 @item @samp{separate}
1532 Display options taking an argument that appears as a separate word
1533 following the original option, such as: @samp{-o output-file}.
1534 @end table
1536 Thus for example to display all the undocumented target-specific
1537 switches supported by the compiler, use:
1539 @smallexample
1540 --help=target,undocumented
1541 @end smallexample
1543 The sense of a qualifier can be inverted by prefixing it with the
1544 @samp{^} character, so for example to display all binary warning
1545 options (i.e., ones that are either on or off and that do not take an
1546 argument) that have a description, use:
1548 @smallexample
1549 --help=warnings,^joined,^undocumented
1550 @end smallexample
1552 The argument to @option{--help=} should not consist solely of inverted
1553 qualifiers.
1555 Combining several classes is possible, although this usually
1556 restricts the output so much that there is nothing to display.  One
1557 case where it does work, however, is when one of the classes is
1558 @var{target}.  For example, to display all the target-specific
1559 optimization options, use:
1561 @smallexample
1562 --help=target,optimizers
1563 @end smallexample
1565 The @option{--help=} option can be repeated on the command line.  Each
1566 successive use displays its requested class of options, skipping
1567 those that have already been displayed.
1569 If the @option{-Q} option appears on the command line before the
1570 @option{--help=} option, then the descriptive text displayed by
1571 @option{--help=} is changed.  Instead of describing the displayed
1572 options, an indication is given as to whether the option is enabled,
1573 disabled or set to a specific value (assuming that the compiler
1574 knows this at the point where the @option{--help=} option is used).
1576 Here is a truncated example from the ARM port of @command{gcc}:
1578 @smallexample
1579   % gcc -Q -mabi=2 --help=target -c
1580   The following options are target specific:
1581   -mabi=                                2
1582   -mabort-on-noreturn                   [disabled]
1583   -mapcs                                [disabled]
1584 @end smallexample
1586 The output is sensitive to the effects of previous command-line
1587 options, so for example it is possible to find out which optimizations
1588 are enabled at @option{-O2} by using:
1590 @smallexample
1591 -Q -O2 --help=optimizers
1592 @end smallexample
1594 Alternatively you can discover which binary optimizations are enabled
1595 by @option{-O3} by using:
1597 @smallexample
1598 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1599 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1600 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1601 @end smallexample
1603 @item --version
1604 @opindex version
1605 Display the version number and copyrights of the invoked GCC@.
1607 @item -pass-exit-codes
1608 @opindex pass-exit-codes
1609 Normally the @command{gcc} program exits with the code of 1 if any
1610 phase of the compiler returns a non-success return code.  If you specify
1611 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1612 the numerically highest error produced by any phase returning an error
1613 indication.  The C, C++, and Fortran front ends return 4 if an internal
1614 compiler error is encountered.
1616 @item -pipe
1617 @opindex pipe
1618 Use pipes rather than temporary files for communication between the
1619 various stages of compilation.  This fails to work on some systems where
1620 the assembler is unable to read from a pipe; but the GNU assembler has
1621 no trouble.
1623 @item -specs=@var{file}
1624 @opindex specs
1625 Process @var{file} after the compiler reads in the standard @file{specs}
1626 file, in order to override the defaults which the @command{gcc} driver
1627 program uses when determining what switches to pass to @command{cc1},
1628 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
1629 @option{-specs=@var{file}} can be specified on the command line, and they
1630 are processed in order, from left to right.  @xref{Spec Files}, for
1631 information about the format of the @var{file}.
1633 @item -wrapper
1634 @opindex wrapper
1635 Invoke all subcommands under a wrapper program.  The name of the
1636 wrapper program and its parameters are passed as a comma separated
1637 list.
1639 @smallexample
1640 gcc -c t.c -wrapper gdb,--args
1641 @end smallexample
1643 @noindent
1644 This invokes all subprograms of @command{gcc} under
1645 @samp{gdb --args}, thus the invocation of @command{cc1} is
1646 @samp{gdb --args cc1 @dots{}}.
1648 @item -fplugin=@var{name}.so
1649 @opindex fplugin
1650 Load the plugin code in file @var{name}.so, assumed to be a
1651 shared object to be dlopen'd by the compiler.  The base name of
1652 the shared object file is used to identify the plugin for the
1653 purposes of argument parsing (See
1654 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1655 Each plugin should define the callback functions specified in the
1656 Plugins API.
1658 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1659 @opindex fplugin-arg
1660 Define an argument called @var{key} with a value of @var{value}
1661 for the plugin called @var{name}.
1663 @item -fdump-ada-spec@r{[}-slim@r{]}
1664 @opindex fdump-ada-spec
1665 For C and C++ source and include files, generate corresponding Ada specs.
1666 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1667 GNAT User's Guide}, which provides detailed documentation on this feature.
1669 @item -fada-spec-parent=@var{unit}
1670 @opindex fada-spec-parent
1671 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1672 Ada specs as child units of parent @var{unit}.
1674 @item -fdump-go-spec=@var{file}
1675 @opindex fdump-go-spec
1676 For input files in any language, generate corresponding Go
1677 declarations in @var{file}.  This generates Go @code{const},
1678 @code{type}, @code{var}, and @code{func} declarations which may be a
1679 useful way to start writing a Go interface to code written in some
1680 other language.
1682 @include @value{srcdir}/../libiberty/at-file.texi
1683 @end table
1685 @node Invoking G++
1686 @section Compiling C++ Programs
1688 @cindex suffixes for C++ source
1689 @cindex C++ source file suffixes
1690 C++ source files conventionally use one of the suffixes @samp{.C},
1691 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1692 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1693 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1694 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1695 files with these names and compiles them as C++ programs even if you
1696 call the compiler the same way as for compiling C programs (usually
1697 with the name @command{gcc}).
1699 @findex g++
1700 @findex c++
1701 However, the use of @command{gcc} does not add the C++ library.
1702 @command{g++} is a program that calls GCC and automatically specifies linking
1703 against the C++ library.  It treats @samp{.c},
1704 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1705 files unless @option{-x} is used.  This program is also useful when
1706 precompiling a C header file with a @samp{.h} extension for use in C++
1707 compilations.  On many systems, @command{g++} is also installed with
1708 the name @command{c++}.
1710 @cindex invoking @command{g++}
1711 When you compile C++ programs, you may specify many of the same
1712 command-line options that you use for compiling programs in any
1713 language; or command-line options meaningful for C and related
1714 languages; or options that are meaningful only for C++ programs.
1715 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1716 explanations of options for languages related to C@.
1717 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1718 explanations of options that are meaningful only for C++ programs.
1720 @node C Dialect Options
1721 @section Options Controlling C Dialect
1722 @cindex dialect options
1723 @cindex language dialect options
1724 @cindex options, dialect
1726 The following options control the dialect of C (or languages derived
1727 from C, such as C++, Objective-C and Objective-C++) that the compiler
1728 accepts:
1730 @table @gcctabopt
1731 @cindex ANSI support
1732 @cindex ISO support
1733 @item -ansi
1734 @opindex ansi
1735 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1736 equivalent to @option{-std=c++98}.
1738 This turns off certain features of GCC that are incompatible with ISO
1739 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1740 such as the @code{asm} and @code{typeof} keywords, and
1741 predefined macros such as @code{unix} and @code{vax} that identify the
1742 type of system you are using.  It also enables the undesirable and
1743 rarely used ISO trigraph feature.  For the C compiler,
1744 it disables recognition of C++ style @samp{//} comments as well as
1745 the @code{inline} keyword.
1747 The alternate keywords @code{__asm__}, @code{__extension__},
1748 @code{__inline__} and @code{__typeof__} continue to work despite
1749 @option{-ansi}.  You would not want to use them in an ISO C program, of
1750 course, but it is useful to put them in header files that might be included
1751 in compilations done with @option{-ansi}.  Alternate predefined macros
1752 such as @code{__unix__} and @code{__vax__} are also available, with or
1753 without @option{-ansi}.
1755 The @option{-ansi} option does not cause non-ISO programs to be
1756 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1757 addition to @option{-ansi}.  @xref{Warning Options}.
1759 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1760 option is used.  Some header files may notice this macro and refrain
1761 from declaring certain functions or defining certain macros that the
1762 ISO standard doesn't call for; this is to avoid interfering with any
1763 programs that might use these names for other things.
1765 Functions that are normally built in but do not have semantics
1766 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1767 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1768 built-in functions provided by GCC}, for details of the functions
1769 affected.
1771 @item -std=
1772 @opindex std
1773 Determine the language standard. @xref{Standards,,Language Standards
1774 Supported by GCC}, for details of these standard versions.  This option
1775 is currently only supported when compiling C or C++.
1777 The compiler can accept several base standards, such as @samp{c90} or
1778 @samp{c++98}, and GNU dialects of those standards, such as
1779 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1780 compiler accepts all programs following that standard plus those
1781 using GNU extensions that do not contradict it.  For example,
1782 @option{-std=c90} turns off certain features of GCC that are
1783 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1784 keywords, but not other GNU extensions that do not have a meaning in
1785 ISO C90, such as omitting the middle term of a @code{?:}
1786 expression. On the other hand, when a GNU dialect of a standard is
1787 specified, all features supported by the compiler are enabled, even when
1788 those features change the meaning of the base standard.  As a result, some
1789 strict-conforming programs may be rejected.  The particular standard
1790 is used by @option{-Wpedantic} to identify which features are GNU
1791 extensions given that version of the standard. For example
1792 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1793 comments, while @option{-std=gnu99 -Wpedantic} does not.
1795 A value for this option must be provided; possible values are
1797 @table @samp
1798 @item c90
1799 @itemx c89
1800 @itemx iso9899:1990
1801 Support all ISO C90 programs (certain GNU extensions that conflict
1802 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1804 @item iso9899:199409
1805 ISO C90 as modified in amendment 1.
1807 @item c99
1808 @itemx c9x
1809 @itemx iso9899:1999
1810 @itemx iso9899:199x
1811 ISO C99.  This standard is substantially completely supported, modulo
1812 bugs and floating-point issues
1813 (mainly but not entirely relating to optional C99 features from
1814 Annexes F and G).  See
1815 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1816 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1818 @item c11
1819 @itemx c1x
1820 @itemx iso9899:2011
1821 ISO C11, the 2011 revision of the ISO C standard.  This standard is
1822 substantially completely supported, modulo bugs, floating-point issues
1823 (mainly but not entirely relating to optional C11 features from
1824 Annexes F and G) and the optional Annexes K (Bounds-checking
1825 interfaces) and L (Analyzability).  The name @samp{c1x} is deprecated.
1827 @item gnu90
1828 @itemx gnu89
1829 GNU dialect of ISO C90 (including some C99 features).
1831 @item gnu99
1832 @itemx gnu9x
1833 GNU dialect of ISO C99.  The name @samp{gnu9x} is deprecated.
1835 @item gnu11
1836 @itemx gnu1x
1837 GNU dialect of ISO C11.  This is the default for C code.
1838 The name @samp{gnu1x} is deprecated.
1840 @item c++98
1841 @itemx c++03
1842 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1843 additional defect reports. Same as @option{-ansi} for C++ code.
1845 @item gnu++98
1846 @itemx gnu++03
1847 GNU dialect of @option{-std=c++98}.
1849 @item c++11
1850 @itemx c++0x
1851 The 2011 ISO C++ standard plus amendments.
1852 The name @samp{c++0x} is deprecated.
1854 @item gnu++11
1855 @itemx gnu++0x
1856 GNU dialect of @option{-std=c++11}.
1857 The name @samp{gnu++0x} is deprecated.
1859 @item c++14
1860 @itemx c++1y
1861 The 2014 ISO C++ standard plus amendments.
1862 The name @samp{c++1y} is deprecated.
1864 @item gnu++14
1865 @itemx gnu++1y
1866 GNU dialect of @option{-std=c++14}.
1867 This is the default for C++ code.
1868 The name @samp{gnu++1y} is deprecated.
1870 @item c++1z
1871 The next revision of the ISO C++ standard, tentatively planned for
1872 2017.  Support is highly experimental, and will almost certainly
1873 change in incompatible ways in future releases.
1875 @item gnu++1z
1876 GNU dialect of @option{-std=c++1z}.  Support is highly experimental,
1877 and will almost certainly change in incompatible ways in future
1878 releases.
1879 @end table
1881 @item -fgnu89-inline
1882 @opindex fgnu89-inline
1883 The option @option{-fgnu89-inline} tells GCC to use the traditional
1884 GNU semantics for @code{inline} functions when in C99 mode.
1885 @xref{Inline,,An Inline Function is As Fast As a Macro}.
1886 Using this option is roughly equivalent to adding the
1887 @code{gnu_inline} function attribute to all inline functions
1888 (@pxref{Function Attributes}).
1890 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1891 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1892 specifies the default behavior).
1893 This option is not supported in @option{-std=c90} or
1894 @option{-std=gnu90} mode.
1896 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1897 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1898 in effect for @code{inline} functions.  @xref{Common Predefined
1899 Macros,,,cpp,The C Preprocessor}.
1901 @item -fpermitted-flt-eval-methods=@var{style}
1902 @opindex fpermitted-flt-eval-methods
1903 @opindex fpermitted-flt-eval-methods=c11
1904 @opindex fpermitted-flt-eval-methods=ts-18661-3
1905 ISO/IEC TS 18661-3 defines new permissible values for
1906 @code{FLT_EVAL_METHOD} that indicate that operations and constants with
1907 a semantic type that is an interchange or extended format should be
1908 evaluated to the precision and range of that type.  These new values are
1909 a superset of those permitted under C99/C11, which does not specify the
1910 meaning of other positive values of @code{FLT_EVAL_METHOD}.  As such, code
1911 conforming to C11 may not have been written expecting the possibility of
1912 the new values.
1914 @option{-fpermitted-flt-eval-methods} specifies whether the compiler
1915 should allow only the values of @code{FLT_EVAL_METHOD} specified in C99/C11,
1916 or the extended set of values specified in ISO/IEC TS 18661-3.
1918 @var{style} is either @code{c11} or @code{ts-18661-3} as appropriate.
1920 The default when in a standards compliant mode (@option{-std=c11} or similar)
1921 is @option{-fpermitted-flt-eval-methods=c11}.  The default when in a GNU
1922 dialect (@option{-std=gnu11} or similar) is
1923 @option{-fpermitted-flt-eval-methods=ts-18661-3}.
1925 @item -aux-info @var{filename}
1926 @opindex aux-info
1927 Output to the given filename prototyped declarations for all functions
1928 declared and/or defined in a translation unit, including those in header
1929 files.  This option is silently ignored in any language other than C@.
1931 Besides declarations, the file indicates, in comments, the origin of
1932 each declaration (source file and line), whether the declaration was
1933 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1934 @samp{O} for old, respectively, in the first character after the line
1935 number and the colon), and whether it came from a declaration or a
1936 definition (@samp{C} or @samp{F}, respectively, in the following
1937 character).  In the case of function definitions, a K&R-style list of
1938 arguments followed by their declarations is also provided, inside
1939 comments, after the declaration.
1941 @item -fallow-parameterless-variadic-functions
1942 @opindex fallow-parameterless-variadic-functions
1943 Accept variadic functions without named parameters.
1945 Although it is possible to define such a function, this is not very
1946 useful as it is not possible to read the arguments.  This is only
1947 supported for C as this construct is allowed by C++.
1949 @item -fno-asm
1950 @opindex fno-asm
1951 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1952 keyword, so that code can use these words as identifiers.  You can use
1953 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1954 instead.  @option{-ansi} implies @option{-fno-asm}.
1956 In C++, this switch only affects the @code{typeof} keyword, since
1957 @code{asm} and @code{inline} are standard keywords.  You may want to
1958 use the @option{-fno-gnu-keywords} flag instead, which has the same
1959 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1960 switch only affects the @code{asm} and @code{typeof} keywords, since
1961 @code{inline} is a standard keyword in ISO C99.
1963 @item -fno-builtin
1964 @itemx -fno-builtin-@var{function}
1965 @opindex fno-builtin
1966 @cindex built-in functions
1967 Don't recognize built-in functions that do not begin with
1968 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1969 functions provided by GCC}, for details of the functions affected,
1970 including those which are not built-in functions when @option{-ansi} or
1971 @option{-std} options for strict ISO C conformance are used because they
1972 do not have an ISO standard meaning.
1974 GCC normally generates special code to handle certain built-in functions
1975 more efficiently; for instance, calls to @code{alloca} may become single
1976 instructions which adjust the stack directly, and calls to @code{memcpy}
1977 may become inline copy loops.  The resulting code is often both smaller
1978 and faster, but since the function calls no longer appear as such, you
1979 cannot set a breakpoint on those calls, nor can you change the behavior
1980 of the functions by linking with a different library.  In addition,
1981 when a function is recognized as a built-in function, GCC may use
1982 information about that function to warn about problems with calls to
1983 that function, or to generate more efficient code, even if the
1984 resulting code still contains calls to that function.  For example,
1985 warnings are given with @option{-Wformat} for bad calls to
1986 @code{printf} when @code{printf} is built in and @code{strlen} is
1987 known not to modify global memory.
1989 With the @option{-fno-builtin-@var{function}} option
1990 only the built-in function @var{function} is
1991 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1992 function is named that is not built-in in this version of GCC, this
1993 option is ignored.  There is no corresponding
1994 @option{-fbuiltin-@var{function}} option; if you wish to enable
1995 built-in functions selectively when using @option{-fno-builtin} or
1996 @option{-ffreestanding}, you may define macros such as:
1998 @smallexample
1999 #define abs(n)          __builtin_abs ((n))
2000 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
2001 @end smallexample
2003 @item -fgimple
2004 @opindex fgimple
2006 Enable parsing of function definitions marked with @code{__GIMPLE}.
2007 This is an experimental feature that allows unit testing of GIMPLE
2008 passes.
2010 @item -fhosted
2011 @opindex fhosted
2012 @cindex hosted environment
2014 Assert that compilation targets a hosted environment.  This implies
2015 @option{-fbuiltin}.  A hosted environment is one in which the
2016 entire standard library is available, and in which @code{main} has a return
2017 type of @code{int}.  Examples are nearly everything except a kernel.
2018 This is equivalent to @option{-fno-freestanding}.
2020 @item -ffreestanding
2021 @opindex ffreestanding
2022 @cindex hosted environment
2024 Assert that compilation targets a freestanding environment.  This
2025 implies @option{-fno-builtin}.  A freestanding environment
2026 is one in which the standard library may not exist, and program startup may
2027 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
2028 This is equivalent to @option{-fno-hosted}.
2030 @xref{Standards,,Language Standards Supported by GCC}, for details of
2031 freestanding and hosted environments.
2033 @item -fopenacc
2034 @opindex fopenacc
2035 @cindex OpenACC accelerator programming
2036 Enable handling of OpenACC directives @code{#pragma acc} in C/C++ and
2037 @code{!$acc} in Fortran.  When @option{-fopenacc} is specified, the
2038 compiler generates accelerated code according to the OpenACC Application
2039 Programming Interface v2.0 @w{@uref{http://www.openacc.org/}}.  This option
2040 implies @option{-pthread}, and thus is only supported on targets that
2041 have support for @option{-pthread}.
2043 @item -fopenacc-dim=@var{geom}
2044 @opindex fopenacc-dim
2045 @cindex OpenACC accelerator programming
2046 Specify default compute dimensions for parallel offload regions that do
2047 not explicitly specify.  The @var{geom} value is a triple of
2048 ':'-separated sizes, in order 'gang', 'worker' and, 'vector'.  A size
2049 can be omitted, to use a target-specific default value.
2051 @item -fopenmp
2052 @opindex fopenmp
2053 @cindex OpenMP parallel
2054 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
2055 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
2056 compiler generates parallel code according to the OpenMP Application
2057 Program Interface v4.5 @w{@uref{http://www.openmp.org/}}.  This option
2058 implies @option{-pthread}, and thus is only supported on targets that
2059 have support for @option{-pthread}. @option{-fopenmp} implies
2060 @option{-fopenmp-simd}.
2062 @item -fopenmp-simd
2063 @opindex fopenmp-simd
2064 @cindex OpenMP SIMD
2065 @cindex SIMD
2066 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
2067 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
2068 are ignored.
2070 @item -fcilkplus
2071 @opindex fcilkplus
2072 @cindex Enable Cilk Plus
2073 Enable the usage of Cilk Plus language extension features for C/C++.
2074 When the option @option{-fcilkplus} is specified, enable the usage of
2075 the Cilk Plus Language extension features for C/C++.  The present
2076 implementation follows ABI version 1.2.  This is an experimental
2077 feature that is only partially complete, and whose interface may
2078 change in future versions of GCC as the official specification
2079 changes.  Currently, all features but @code{_Cilk_for} have been
2080 implemented.
2082 @item -fgnu-tm
2083 @opindex fgnu-tm
2084 When the option @option{-fgnu-tm} is specified, the compiler
2085 generates code for the Linux variant of Intel's current Transactional
2086 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
2087 an experimental feature whose interface may change in future versions
2088 of GCC, as the official specification changes.  Please note that not
2089 all architectures are supported for this feature.
2091 For more information on GCC's support for transactional memory,
2092 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
2093 Transactional Memory Library}.
2095 Note that the transactional memory feature is not supported with
2096 non-call exceptions (@option{-fnon-call-exceptions}).
2098 @item -fms-extensions
2099 @opindex fms-extensions
2100 Accept some non-standard constructs used in Microsoft header files.
2102 In C++ code, this allows member names in structures to be similar
2103 to previous types declarations.
2105 @smallexample
2106 typedef int UOW;
2107 struct ABC @{
2108   UOW UOW;
2110 @end smallexample
2112 Some cases of unnamed fields in structures and unions are only
2113 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
2114 fields within structs/unions}, for details.
2116 Note that this option is off for all targets but x86 
2117 targets using ms-abi.
2119 @item -fplan9-extensions
2120 @opindex fplan9-extensions
2121 Accept some non-standard constructs used in Plan 9 code.
2123 This enables @option{-fms-extensions}, permits passing pointers to
2124 structures with anonymous fields to functions that expect pointers to
2125 elements of the type of the field, and permits referring to anonymous
2126 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
2127 struct/union fields within structs/unions}, for details.  This is only
2128 supported for C, not C++.
2130 @item -fcond-mismatch
2131 @opindex fcond-mismatch
2132 Allow conditional expressions with mismatched types in the second and
2133 third arguments.  The value of such an expression is void.  This option
2134 is not supported for C++.
2136 @item -flax-vector-conversions
2137 @opindex flax-vector-conversions
2138 Allow implicit conversions between vectors with differing numbers of
2139 elements and/or incompatible element types.  This option should not be
2140 used for new code.
2142 @item -funsigned-char
2143 @opindex funsigned-char
2144 Let the type @code{char} be unsigned, like @code{unsigned char}.
2146 Each kind of machine has a default for what @code{char} should
2147 be.  It is either like @code{unsigned char} by default or like
2148 @code{signed char} by default.
2150 Ideally, a portable program should always use @code{signed char} or
2151 @code{unsigned char} when it depends on the signedness of an object.
2152 But many programs have been written to use plain @code{char} and
2153 expect it to be signed, or expect it to be unsigned, depending on the
2154 machines they were written for.  This option, and its inverse, let you
2155 make such a program work with the opposite default.
2157 The type @code{char} is always a distinct type from each of
2158 @code{signed char} or @code{unsigned char}, even though its behavior
2159 is always just like one of those two.
2161 @item -fsigned-char
2162 @opindex fsigned-char
2163 Let the type @code{char} be signed, like @code{signed char}.
2165 Note that this is equivalent to @option{-fno-unsigned-char}, which is
2166 the negative form of @option{-funsigned-char}.  Likewise, the option
2167 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
2169 @item -fsigned-bitfields
2170 @itemx -funsigned-bitfields
2171 @itemx -fno-signed-bitfields
2172 @itemx -fno-unsigned-bitfields
2173 @opindex fsigned-bitfields
2174 @opindex funsigned-bitfields
2175 @opindex fno-signed-bitfields
2176 @opindex fno-unsigned-bitfields
2177 These options control whether a bit-field is signed or unsigned, when the
2178 declaration does not use either @code{signed} or @code{unsigned}.  By
2179 default, such a bit-field is signed, because this is consistent: the
2180 basic integer types such as @code{int} are signed types.
2182 @item -fsso-struct=@var{endianness}
2183 @opindex fsso-struct
2184 Set the default scalar storage order of structures and unions to the
2185 specified endianness.  The accepted values are @samp{big-endian},
2186 @samp{little-endian} and @samp{native} for the native endianness of
2187 the target (the default).  This option is not supported for C++.
2189 @strong{Warning:} the @option{-fsso-struct} switch causes GCC to generate
2190 code that is not binary compatible with code generated without it if the
2191 specified endianness is not the native endianness of the target.
2192 @end table
2194 @node C++ Dialect Options
2195 @section Options Controlling C++ Dialect
2197 @cindex compiler options, C++
2198 @cindex C++ options, command-line
2199 @cindex options, C++
2200 This section describes the command-line options that are only meaningful
2201 for C++ programs.  You can also use most of the GNU compiler options
2202 regardless of what language your program is in.  For example, you
2203 might compile a file @file{firstClass.C} like this:
2205 @smallexample
2206 g++ -g -fstrict-enums -O -c firstClass.C
2207 @end smallexample
2209 @noindent
2210 In this example, only @option{-fstrict-enums} is an option meant
2211 only for C++ programs; you can use the other options with any
2212 language supported by GCC@.
2214 Some options for compiling C programs, such as @option{-std}, are also
2215 relevant for C++ programs.
2216 @xref{C Dialect Options,,Options Controlling C Dialect}.
2218 Here is a list of options that are @emph{only} for compiling C++ programs:
2220 @table @gcctabopt
2222 @item -fabi-version=@var{n}
2223 @opindex fabi-version
2224 Use version @var{n} of the C++ ABI@.  The default is version 0.
2226 Version 0 refers to the version conforming most closely to
2227 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2228 will change in different versions of G++ as ABI bugs are fixed.
2230 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.
2232 Version 2 is the version of the C++ ABI that first appeared in G++
2233 3.4, and was the default through G++ 4.9.
2235 Version 3 corrects an error in mangling a constant address as a
2236 template argument.
2238 Version 4, which first appeared in G++ 4.5, implements a standard
2239 mangling for vector types.
2241 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2242 attribute const/volatile on function pointer types, decltype of a
2243 plain decl, and use of a function parameter in the declaration of
2244 another parameter.
2246 Version 6, which first appeared in G++ 4.7, corrects the promotion
2247 behavior of C++11 scoped enums and the mangling of template argument
2248 packs, const/static_cast, prefix ++ and --, and a class scope function
2249 used as a template argument.
2251 Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a
2252 builtin type and corrects the mangling of lambdas in default argument
2253 scope.
2255 Version 8, which first appeared in G++ 4.9, corrects the substitution
2256 behavior of function types with function-cv-qualifiers.
2258 Version 9, which first appeared in G++ 5.2, corrects the alignment of
2259 @code{nullptr_t}.
2261 Version 10, which first appeared in G++ 6.1, adds mangling of
2262 attributes that affect type identity, such as ia32 calling convention
2263 attributes (e.g. @samp{stdcall}).
2265 Version 11, which first appeared in G++ 7, corrects the mangling of
2266 sizeof... expressions and operator names.  For multiple entities with
2267 the same name within a function, that are declared in different scopes,
2268 the mangling now changes starting with the twelfth occurrence.  It also
2269 implies @option{-fnew-inheriting-ctors}.
2271 See also @option{-Wabi}.
2273 @item -fabi-compat-version=@var{n}
2274 @opindex fabi-compat-version
2275 On targets that support strong aliases, G++
2276 works around mangling changes by creating an alias with the correct
2277 mangled name when defining a symbol with an incorrect mangled name.
2278 This switch specifies which ABI version to use for the alias.
2280 With @option{-fabi-version=0} (the default), this defaults to 8 (GCC 5
2281 compatibility).  If another ABI version is explicitly selected, this
2282 defaults to 0.  For compatibility with GCC versions 3.2 through 4.9,
2283 use @option{-fabi-compat-version=2}.
2285 If this option is not provided but @option{-Wabi=@var{n}} is, that
2286 version is used for compatibility aliases.  If this option is provided
2287 along with @option{-Wabi} (without the version), the version from this
2288 option is used for the warning.
2290 @item -fno-access-control
2291 @opindex fno-access-control
2292 Turn off all access checking.  This switch is mainly useful for working
2293 around bugs in the access control code.
2295 @item -faligned-new
2296 @opindex faligned-new
2297 Enable support for C++17 @code{new} of types that require more
2298 alignment than @code{void* ::operator new(std::size_t)} provides.  A
2299 numeric argument such as @code{-faligned-new=32} can be used to
2300 specify how much alignment (in bytes) is provided by that function,
2301 but few users will need to override the default of
2302 @code{alignof(std::max_align_t)}.
2304 This flag is enabled by default for @option{-std=c++1z}.
2306 @item -fcheck-new
2307 @opindex fcheck-new
2308 Check that the pointer returned by @code{operator new} is non-null
2309 before attempting to modify the storage allocated.  This check is
2310 normally unnecessary because the C++ standard specifies that
2311 @code{operator new} only returns @code{0} if it is declared
2312 @code{throw()}, in which case the compiler always checks the
2313 return value even without this option.  In all other cases, when
2314 @code{operator new} has a non-empty exception specification, memory
2315 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2316 @samp{new (nothrow)}.
2318 @item -fconcepts
2319 @opindex fconcepts
2320 Enable support for the C++ Extensions for Concepts Technical
2321 Specification, ISO 19217 (2015), which allows code like
2323 @smallexample
2324 template <class T> concept bool Addable = requires (T t) @{ t + t; @};
2325 template <Addable T> T add (T a, T b) @{ return a + b; @}
2326 @end smallexample
2328 @item -fconstexpr-depth=@var{n}
2329 @opindex fconstexpr-depth
2330 Set the maximum nested evaluation depth for C++11 constexpr functions
2331 to @var{n}.  A limit is needed to detect endless recursion during
2332 constant expression evaluation.  The minimum specified by the standard
2333 is 512.
2335 @item -fconstexpr-loop-limit=@var{n}
2336 @opindex fconstexpr-loop-limit
2337 Set the maximum number of iterations for a loop in C++14 constexpr functions
2338 to @var{n}.  A limit is needed to detect infinite loops during
2339 constant expression evaluation.  The default is 262144 (1<<18).
2341 @item -fdeduce-init-list
2342 @opindex fdeduce-init-list
2343 Enable deduction of a template type parameter as
2344 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2346 @smallexample
2347 template <class T> auto forward(T t) -> decltype (realfn (t))
2349   return realfn (t);
2352 void f()
2354   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2356 @end smallexample
2358 This deduction was implemented as a possible extension to the
2359 originally proposed semantics for the C++11 standard, but was not part
2360 of the final standard, so it is disabled by default.  This option is
2361 deprecated, and may be removed in a future version of G++.
2363 @item -ffriend-injection
2364 @opindex ffriend-injection
2365 Inject friend functions into the enclosing namespace, so that they are
2366 visible outside the scope of the class in which they are declared.
2367 Friend functions were documented to work this way in the old Annotated
2368 C++ Reference Manual.  
2369 However, in ISO C++ a friend function that is not declared
2370 in an enclosing scope can only be found using argument dependent
2371 lookup.  GCC defaults to the standard behavior.
2373 This option is for compatibility, and may be removed in a future
2374 release of G++.
2376 @item -fno-elide-constructors
2377 @opindex fno-elide-constructors
2378 The C++ standard allows an implementation to omit creating a temporary
2379 that is only used to initialize another object of the same type.
2380 Specifying this option disables that optimization, and forces G++ to
2381 call the copy constructor in all cases.  This option also causes G++
2382 to call trivial member functions which otherwise would be expanded inline.
2384 In C++17, the compiler is required to omit these temporaries, but this
2385 option still affects trivial member functions.
2387 @item -fno-enforce-eh-specs
2388 @opindex fno-enforce-eh-specs
2389 Don't generate code to check for violation of exception specifications
2390 at run time.  This option violates the C++ standard, but may be useful
2391 for reducing code size in production builds, much like defining
2392 @code{NDEBUG}.  This does not give user code permission to throw
2393 exceptions in violation of the exception specifications; the compiler
2394 still optimizes based on the specifications, so throwing an
2395 unexpected exception results in undefined behavior at run time.
2397 @item -fextern-tls-init
2398 @itemx -fno-extern-tls-init
2399 @opindex fextern-tls-init
2400 @opindex fno-extern-tls-init
2401 The C++11 and OpenMP standards allow @code{thread_local} and
2402 @code{threadprivate} variables to have dynamic (runtime)
2403 initialization.  To support this, any use of such a variable goes
2404 through a wrapper function that performs any necessary initialization.
2405 When the use and definition of the variable are in the same
2406 translation unit, this overhead can be optimized away, but when the
2407 use is in a different translation unit there is significant overhead
2408 even if the variable doesn't actually need dynamic initialization.  If
2409 the programmer can be sure that no use of the variable in a
2410 non-defining TU needs to trigger dynamic initialization (either
2411 because the variable is statically initialized, or a use of the
2412 variable in the defining TU will be executed before any uses in
2413 another TU), they can avoid this overhead with the
2414 @option{-fno-extern-tls-init} option.
2416 On targets that support symbol aliases, the default is
2417 @option{-fextern-tls-init}.  On targets that do not support symbol
2418 aliases, the default is @option{-fno-extern-tls-init}.
2420 @item -ffor-scope
2421 @itemx -fno-for-scope
2422 @opindex ffor-scope
2423 @opindex fno-for-scope
2424 If @option{-ffor-scope} is specified, the scope of variables declared in
2425 a @i{for-init-statement} is limited to the @code{for} loop itself,
2426 as specified by the C++ standard.
2427 If @option{-fno-for-scope} is specified, the scope of variables declared in
2428 a @i{for-init-statement} extends to the end of the enclosing scope,
2429 as was the case in old versions of G++, and other (traditional)
2430 implementations of C++.
2432 If neither flag is given, the default is to follow the standard,
2433 but to allow and give a warning for old-style code that would
2434 otherwise be invalid, or have different behavior.
2436 @item -fno-gnu-keywords
2437 @opindex fno-gnu-keywords
2438 Do not recognize @code{typeof} as a keyword, so that code can use this
2439 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2440 This option is implied by the strict ISO C++ dialects: @option{-ansi},
2441 @option{-std=c++98}, @option{-std=c++11}, etc.
2443 @item -fno-implicit-templates
2444 @opindex fno-implicit-templates
2445 Never emit code for non-inline templates that are instantiated
2446 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2447 @xref{Template Instantiation}, for more information.
2449 @item -fno-implicit-inline-templates
2450 @opindex fno-implicit-inline-templates
2451 Don't emit code for implicit instantiations of inline templates, either.
2452 The default is to handle inlines differently so that compiles with and
2453 without optimization need the same set of explicit instantiations.
2455 @item -fno-implement-inlines
2456 @opindex fno-implement-inlines
2457 To save space, do not emit out-of-line copies of inline functions
2458 controlled by @code{#pragma implementation}.  This causes linker
2459 errors if these functions are not inlined everywhere they are called.
2461 @item -fms-extensions
2462 @opindex fms-extensions
2463 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2464 int and getting a pointer to member function via non-standard syntax.
2466 @item -fnew-inheriting-ctors
2467 @opindex fnew-inheriting-ctors
2468 Enable the P0136 adjustment to the semantics of C++11 constructor
2469 inheritance.  This is part of C++17 but also considered to be a Defect
2470 Report against C++11 and C++14.  This flag is enabled by default
2471 unless @option{-fabi-version=10} or lower is specified.
2473 @item -fnew-ttp-matching
2474 @opindex fnew-ttp-matching
2475 Enable the P0522 resolution to Core issue 150, template template
2476 parameters and default arguments: this allows a template with default
2477 template arguments as an argument for a template template parameter
2478 with fewer template parameters.  This flag is enabled by default for
2479 @option{-std=c++1z}.
2481 @item -fno-nonansi-builtins
2482 @opindex fno-nonansi-builtins
2483 Disable built-in declarations of functions that are not mandated by
2484 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2485 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2487 @item -fnothrow-opt
2488 @opindex fnothrow-opt
2489 Treat a @code{throw()} exception specification as if it were a
2490 @code{noexcept} specification to reduce or eliminate the text size
2491 overhead relative to a function with no exception specification.  If
2492 the function has local variables of types with non-trivial
2493 destructors, the exception specification actually makes the
2494 function smaller because the EH cleanups for those variables can be
2495 optimized away.  The semantic effect is that an exception thrown out of
2496 a function with such an exception specification results in a call
2497 to @code{terminate} rather than @code{unexpected}.
2499 @item -fno-operator-names
2500 @opindex fno-operator-names
2501 Do not treat the operator name keywords @code{and}, @code{bitand},
2502 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2503 synonyms as keywords.
2505 @item -fno-optional-diags
2506 @opindex fno-optional-diags
2507 Disable diagnostics that the standard says a compiler does not need to
2508 issue.  Currently, the only such diagnostic issued by G++ is the one for
2509 a name having multiple meanings within a class.
2511 @item -fpermissive
2512 @opindex fpermissive
2513 Downgrade some diagnostics about nonconformant code from errors to
2514 warnings.  Thus, using @option{-fpermissive} allows some
2515 nonconforming code to compile.
2517 @item -fno-pretty-templates
2518 @opindex fno-pretty-templates
2519 When an error message refers to a specialization of a function
2520 template, the compiler normally prints the signature of the
2521 template followed by the template arguments and any typedefs or
2522 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2523 rather than @code{void f(int)}) so that it's clear which template is
2524 involved.  When an error message refers to a specialization of a class
2525 template, the compiler omits any template arguments that match
2526 the default template arguments for that template.  If either of these
2527 behaviors make it harder to understand the error message rather than
2528 easier, you can use @option{-fno-pretty-templates} to disable them.
2530 @item -frepo
2531 @opindex frepo
2532 Enable automatic template instantiation at link time.  This option also
2533 implies @option{-fno-implicit-templates}.  @xref{Template
2534 Instantiation}, for more information.
2536 @item -fno-rtti
2537 @opindex fno-rtti
2538 Disable generation of information about every class with virtual
2539 functions for use by the C++ run-time type identification features
2540 (@code{dynamic_cast} and @code{typeid}).  If you don't use those parts
2541 of the language, you can save some space by using this flag.  Note that
2542 exception handling uses the same information, but G++ generates it as
2543 needed. The @code{dynamic_cast} operator can still be used for casts that
2544 do not require run-time type information, i.e.@: casts to @code{void *} or to
2545 unambiguous base classes.
2547 @item -fsized-deallocation
2548 @opindex fsized-deallocation
2549 Enable the built-in global declarations
2550 @smallexample
2551 void operator delete (void *, std::size_t) noexcept;
2552 void operator delete[] (void *, std::size_t) noexcept;
2553 @end smallexample
2554 as introduced in C++14.  This is useful for user-defined replacement
2555 deallocation functions that, for example, use the size of the object
2556 to make deallocation faster.  Enabled by default under
2557 @option{-std=c++14} and above.  The flag @option{-Wsized-deallocation}
2558 warns about places that might want to add a definition.
2560 @item -fstrict-enums
2561 @opindex fstrict-enums
2562 Allow the compiler to optimize using the assumption that a value of
2563 enumerated type can only be one of the values of the enumeration (as
2564 defined in the C++ standard; basically, a value that can be
2565 represented in the minimum number of bits needed to represent all the
2566 enumerators).  This assumption may not be valid if the program uses a
2567 cast to convert an arbitrary integer value to the enumerated type.
2569 @item -fstrong-eval-order
2570 @opindex fstrong-eval-order
2571 Evaluate member access, array subscripting, and shift expressions in
2572 left-to-right order, and evaluate assignment in right-to-left order,
2573 as adopted for C++17.  Enabled by default with @option{-std=c++1z}.
2574 @option{-fstrong-eval-order=some} enables just the ordering of member
2575 access and shift expressions, and is the default without
2576 @option{-std=c++1z}.
2578 @item -ftemplate-backtrace-limit=@var{n}
2579 @opindex ftemplate-backtrace-limit
2580 Set the maximum number of template instantiation notes for a single
2581 warning or error to @var{n}.  The default value is 10.
2583 @item -ftemplate-depth=@var{n}
2584 @opindex ftemplate-depth
2585 Set the maximum instantiation depth for template classes to @var{n}.
2586 A limit on the template instantiation depth is needed to detect
2587 endless recursions during template class instantiation.  ANSI/ISO C++
2588 conforming programs must not rely on a maximum depth greater than 17
2589 (changed to 1024 in C++11).  The default value is 900, as the compiler
2590 can run out of stack space before hitting 1024 in some situations.
2592 @item -fno-threadsafe-statics
2593 @opindex fno-threadsafe-statics
2594 Do not emit the extra code to use the routines specified in the C++
2595 ABI for thread-safe initialization of local statics.  You can use this
2596 option to reduce code size slightly in code that doesn't need to be
2597 thread-safe.
2599 @item -fuse-cxa-atexit
2600 @opindex fuse-cxa-atexit
2601 Register destructors for objects with static storage duration with the
2602 @code{__cxa_atexit} function rather than the @code{atexit} function.
2603 This option is required for fully standards-compliant handling of static
2604 destructors, but only works if your C library supports
2605 @code{__cxa_atexit}.
2607 @item -fno-use-cxa-get-exception-ptr
2608 @opindex fno-use-cxa-get-exception-ptr
2609 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2610 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2611 if the runtime routine is not available.
2613 @item -fvisibility-inlines-hidden
2614 @opindex fvisibility-inlines-hidden
2615 This switch declares that the user does not attempt to compare
2616 pointers to inline functions or methods where the addresses of the two functions
2617 are taken in different shared objects.
2619 The effect of this is that GCC may, effectively, mark inline methods with
2620 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2621 appear in the export table of a DSO and do not require a PLT indirection
2622 when used within the DSO@.  Enabling this option can have a dramatic effect
2623 on load and link times of a DSO as it massively reduces the size of the
2624 dynamic export table when the library makes heavy use of templates.
2626 The behavior of this switch is not quite the same as marking the
2627 methods as hidden directly, because it does not affect static variables
2628 local to the function or cause the compiler to deduce that
2629 the function is defined in only one shared object.
2631 You may mark a method as having a visibility explicitly to negate the
2632 effect of the switch for that method.  For example, if you do want to
2633 compare pointers to a particular inline method, you might mark it as
2634 having default visibility.  Marking the enclosing class with explicit
2635 visibility has no effect.
2637 Explicitly instantiated inline methods are unaffected by this option
2638 as their linkage might otherwise cross a shared library boundary.
2639 @xref{Template Instantiation}.
2641 @item -fvisibility-ms-compat
2642 @opindex fvisibility-ms-compat
2643 This flag attempts to use visibility settings to make GCC's C++
2644 linkage model compatible with that of Microsoft Visual Studio.
2646 The flag makes these changes to GCC's linkage model:
2648 @enumerate
2649 @item
2650 It sets the default visibility to @code{hidden}, like
2651 @option{-fvisibility=hidden}.
2653 @item
2654 Types, but not their members, are not hidden by default.
2656 @item
2657 The One Definition Rule is relaxed for types without explicit
2658 visibility specifications that are defined in more than one
2659 shared object: those declarations are permitted if they are
2660 permitted when this option is not used.
2661 @end enumerate
2663 In new code it is better to use @option{-fvisibility=hidden} and
2664 export those classes that are intended to be externally visible.
2665 Unfortunately it is possible for code to rely, perhaps accidentally,
2666 on the Visual Studio behavior.
2668 Among the consequences of these changes are that static data members
2669 of the same type with the same name but defined in different shared
2670 objects are different, so changing one does not change the other;
2671 and that pointers to function members defined in different shared
2672 objects may not compare equal.  When this flag is given, it is a
2673 violation of the ODR to define types with the same name differently.
2675 @item -fno-weak
2676 @opindex fno-weak
2677 Do not use weak symbol support, even if it is provided by the linker.
2678 By default, G++ uses weak symbols if they are available.  This
2679 option exists only for testing, and should not be used by end-users;
2680 it results in inferior code and has no benefits.  This option may
2681 be removed in a future release of G++.
2683 @item -nostdinc++
2684 @opindex nostdinc++
2685 Do not search for header files in the standard directories specific to
2686 C++, but do still search the other standard directories.  (This option
2687 is used when building the C++ library.)
2688 @end table
2690 In addition, these optimization, warning, and code generation options
2691 have meanings only for C++ programs:
2693 @table @gcctabopt
2694 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2695 @opindex Wabi
2696 @opindex Wno-abi
2697 Warn when G++ it generates code that is probably not compatible with
2698 the vendor-neutral C++ ABI@.  Since G++ now defaults to updating the
2699 ABI with each major release, normally @option{-Wabi} will warn only if
2700 there is a check added later in a release series for an ABI issue
2701 discovered since the initial release.  @option{-Wabi} will warn about
2702 more things if an older ABI version is selected (with
2703 @option{-fabi-version=@var{n}}).
2705 @option{-Wabi} can also be used with an explicit version number to
2706 warn about compatibility with a particular @option{-fabi-version}
2707 level, e.g. @option{-Wabi=2} to warn about changes relative to
2708 @option{-fabi-version=2}.
2710 If an explicit version number is provided and
2711 @option{-fabi-compat-version} is not specified, the version number
2712 from this option is used for compatibility aliases.  If no explicit
2713 version number is provided with this option, but
2714 @option{-fabi-compat-version} is specified, that version number is
2715 used for ABI warnings.
2717 Although an effort has been made to warn about
2718 all such cases, there are probably some cases that are not warned about,
2719 even though G++ is generating incompatible code.  There may also be
2720 cases where warnings are emitted even though the code that is generated
2721 is compatible.
2723 You should rewrite your code to avoid these warnings if you are
2724 concerned about the fact that code generated by G++ may not be binary
2725 compatible with code generated by other compilers.
2727 Known incompatibilities in @option{-fabi-version=2} (which was the
2728 default from GCC 3.4 to 4.9) include:
2730 @itemize @bullet
2732 @item
2733 A template with a non-type template parameter of reference type was
2734 mangled incorrectly:
2735 @smallexample
2736 extern int N;
2737 template <int &> struct S @{@};
2738 void n (S<N>) @{2@}
2739 @end smallexample
2741 This was fixed in @option{-fabi-version=3}.
2743 @item
2744 SIMD vector types declared using @code{__attribute ((vector_size))} were
2745 mangled in a non-standard way that does not allow for overloading of
2746 functions taking vectors of different sizes.
2748 The mangling was changed in @option{-fabi-version=4}.
2750 @item
2751 @code{__attribute ((const))} and @code{noreturn} were mangled as type
2752 qualifiers, and @code{decltype} of a plain declaration was folded away.
2754 These mangling issues were fixed in @option{-fabi-version=5}.
2756 @item
2757 Scoped enumerators passed as arguments to a variadic function are
2758 promoted like unscoped enumerators, causing @code{va_arg} to complain.
2759 On most targets this does not actually affect the parameter passing
2760 ABI, as there is no way to pass an argument smaller than @code{int}.
2762 Also, the ABI changed the mangling of template argument packs,
2763 @code{const_cast}, @code{static_cast}, prefix increment/decrement, and
2764 a class scope function used as a template argument.
2766 These issues were corrected in @option{-fabi-version=6}.
2768 @item
2769 Lambdas in default argument scope were mangled incorrectly, and the
2770 ABI changed the mangling of @code{nullptr_t}.
2772 These issues were corrected in @option{-fabi-version=7}.
2774 @item
2775 When mangling a function type with function-cv-qualifiers, the
2776 un-qualified function type was incorrectly treated as a substitution
2777 candidate.
2779 This was fixed in @option{-fabi-version=8}, the default for GCC 5.1.
2781 @item
2782 @code{decltype(nullptr)} incorrectly had an alignment of 1, leading to
2783 unaligned accesses.  Note that this did not affect the ABI of a
2784 function with a @code{nullptr_t} parameter, as parameters have a
2785 minimum alignment.
2787 This was fixed in @option{-fabi-version=9}, the default for GCC 5.2.
2789 @item
2790 Target-specific attributes that affect the identity of a type, such as
2791 ia32 calling conventions on a function type (stdcall, regparm, etc.),
2792 did not affect the mangled name, leading to name collisions when
2793 function pointers were used as template arguments.
2795 This was fixed in @option{-fabi-version=10}, the default for GCC 6.1.
2797 @end itemize
2799 It also warns about psABI-related changes.  The known psABI changes at this
2800 point include:
2802 @itemize @bullet
2804 @item
2805 For SysV/x86-64, unions with @code{long double} members are 
2806 passed in memory as specified in psABI.  For example:
2808 @smallexample
2809 union U @{
2810   long double ld;
2811   int i;
2813 @end smallexample
2815 @noindent
2816 @code{union U} is always passed in memory.
2818 @end itemize
2820 @item -Wabi-tag @r{(C++ and Objective-C++ only)}
2821 @opindex Wabi-tag
2822 @opindex -Wabi-tag
2823 Warn when a type with an ABI tag is used in a context that does not
2824 have that ABI tag.  See @ref{C++ Attributes} for more information
2825 about ABI tags.
2827 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2828 @opindex Wctor-dtor-privacy
2829 @opindex Wno-ctor-dtor-privacy
2830 Warn when a class seems unusable because all the constructors or
2831 destructors in that class are private, and it has neither friends nor
2832 public static member functions.  Also warn if there are no non-private
2833 methods, and there's at least one private member function that isn't
2834 a constructor or destructor.
2836 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2837 @opindex Wdelete-non-virtual-dtor
2838 @opindex Wno-delete-non-virtual-dtor
2839 Warn when @code{delete} is used to destroy an instance of a class that
2840 has virtual functions and non-virtual destructor. It is unsafe to delete
2841 an instance of a derived class through a pointer to a base class if the
2842 base class does not have a virtual destructor.  This warning is enabled
2843 by @option{-Wall}.
2845 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2846 @opindex Wliteral-suffix
2847 @opindex Wno-literal-suffix
2848 Warn when a string or character literal is followed by a ud-suffix which does
2849 not begin with an underscore.  As a conforming extension, GCC treats such
2850 suffixes as separate preprocessing tokens in order to maintain backwards
2851 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2852 For example:
2854 @smallexample
2855 #define __STDC_FORMAT_MACROS
2856 #include <inttypes.h>
2857 #include <stdio.h>
2859 int main() @{
2860   int64_t i64 = 123;
2861   printf("My int64: %" PRId64"\n", i64);
2863 @end smallexample
2865 In this case, @code{PRId64} is treated as a separate preprocessing token.
2867 Additionally, warn when a user-defined literal operator is declared with
2868 a literal suffix identifier that doesn't begin with an underscore. Literal
2869 suffix identifiers that don't begin with an underscore are reserved for
2870 future standardization.
2872 This warning is enabled by default.
2874 @item -Wlto-type-mismatch
2875 @opindex Wlto-type-mismatch
2876 @opindex Wno-lto-type-mismatch
2878 During the link-time optimization warn about type mismatches in
2879 global declarations from different compilation units.
2880 Requires @option{-flto} to be enabled.  Enabled by default.
2882 @item -Wno-narrowing @r{(C++ and Objective-C++ only)}
2883 @opindex Wnarrowing
2884 @opindex Wno-narrowing
2885 For C++11 and later standards, narrowing conversions are diagnosed by default,
2886 as required by the standard.  A narrowing conversion from a constant produces
2887 an error, and a narrowing conversion from a non-constant produces a warning,
2888 but @option{-Wno-narrowing} suppresses the diagnostic.
2889 Note that this does not affect the meaning of well-formed code;
2890 narrowing conversions are still considered ill-formed in SFINAE contexts.
2892 With @option{-Wnarrowing} in C++98, warn when a narrowing
2893 conversion prohibited by C++11 occurs within
2894 @samp{@{ @}}, e.g.
2896 @smallexample
2897 int i = @{ 2.2 @}; // error: narrowing from double to int
2898 @end smallexample
2900 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2902 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2903 @opindex Wnoexcept
2904 @opindex Wno-noexcept
2905 Warn when a noexcept-expression evaluates to false because of a call
2906 to a function that does not have a non-throwing exception
2907 specification (i.e. @code{throw()} or @code{noexcept}) but is known by
2908 the compiler to never throw an exception.
2910 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2911 @opindex Wnoexcept-type
2912 @opindex Wno-noexcept-type
2913 Warn if the C++1z feature making @code{noexcept} part of a function
2914 type changes the mangled name of a symbol relative to C++14.  Enabled
2915 by @option{-Wabi} and @option{-Wc++1z-compat}.
2917 @smallexample
2918 template <class T> void f(T t) @{ t(); @};
2919 void g() noexcept;
2920 void h() @{ f(g); @} // in C++14 calls f<void(*)()>, in C++1z calls f<void(*)()noexcept>
2921 @end smallexample
2924 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2925 @opindex Wnon-virtual-dtor
2926 @opindex Wno-non-virtual-dtor
2927 Warn when a class has virtual functions and an accessible non-virtual
2928 destructor itself or in an accessible polymorphic base class, in which
2929 case it is possible but unsafe to delete an instance of a derived
2930 class through a pointer to the class itself or base class.  This
2931 warning is automatically enabled if @option{-Weffc++} is specified.
2933 @item -Wregister @r{(C++ and Objective-C++ only)}
2934 @opindex Wregister
2935 @opindex Wno-register
2936 Warn on uses of the @code{register} storage class specifier, except
2937 when it is part of the GNU @ref{Explicit Register Variables} extension.
2938 The use of the @code{register} keyword as storage class specifier has
2939 been deprecated in C++11 and removed in C++17.
2940 Enabled by default with @option{-std=c++1z}.
2942 @item -Wreorder @r{(C++ and Objective-C++ only)}
2943 @opindex Wreorder
2944 @opindex Wno-reorder
2945 @cindex reordering, warning
2946 @cindex warning for reordering of member initializers
2947 Warn when the order of member initializers given in the code does not
2948 match the order in which they must be executed.  For instance:
2950 @smallexample
2951 struct A @{
2952   int i;
2953   int j;
2954   A(): j (0), i (1) @{ @}
2956 @end smallexample
2958 @noindent
2959 The compiler rearranges the member initializers for @code{i}
2960 and @code{j} to match the declaration order of the members, emitting
2961 a warning to that effect.  This warning is enabled by @option{-Wall}.
2963 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
2964 @opindex fext-numeric-literals
2965 @opindex fno-ext-numeric-literals
2966 Accept imaginary, fixed-point, or machine-defined
2967 literal number suffixes as GNU extensions.
2968 When this option is turned off these suffixes are treated
2969 as C++11 user-defined literal numeric suffixes.
2970 This is on by default for all pre-C++11 dialects and all GNU dialects:
2971 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
2972 @option{-std=gnu++14}.
2973 This option is off by default
2974 for ISO C++11 onwards (@option{-std=c++11}, ...).
2975 @end table
2977 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2979 @table @gcctabopt
2980 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2981 @opindex Weffc++
2982 @opindex Wno-effc++
2983 Warn about violations of the following style guidelines from Scott Meyers'
2984 @cite{Effective C++} series of books:
2986 @itemize @bullet
2987 @item
2988 Define a copy constructor and an assignment operator for classes
2989 with dynamically-allocated memory.
2991 @item
2992 Prefer initialization to assignment in constructors.
2994 @item
2995 Have @code{operator=} return a reference to @code{*this}.
2997 @item
2998 Don't try to return a reference when you must return an object.
3000 @item
3001 Distinguish between prefix and postfix forms of increment and
3002 decrement operators.
3004 @item
3005 Never overload @code{&&}, @code{||}, or @code{,}.
3007 @end itemize
3009 This option also enables @option{-Wnon-virtual-dtor}, which is also
3010 one of the effective C++ recommendations.  However, the check is
3011 extended to warn about the lack of virtual destructor in accessible
3012 non-polymorphic bases classes too.
3014 When selecting this option, be aware that the standard library
3015 headers do not obey all of these guidelines; use @samp{grep -v}
3016 to filter out those warnings.
3018 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
3019 @opindex Wstrict-null-sentinel
3020 @opindex Wno-strict-null-sentinel
3021 Warn about the use of an uncasted @code{NULL} as sentinel.  When
3022 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
3023 to @code{__null}.  Although it is a null pointer constant rather than a
3024 null pointer, it is guaranteed to be of the same size as a pointer.
3025 But this use is not portable across different compilers.
3027 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
3028 @opindex Wno-non-template-friend
3029 @opindex Wnon-template-friend
3030 Disable warnings when non-template friend functions are declared
3031 within a template.  In very old versions of GCC that predate implementation
3032 of the ISO standard, declarations such as 
3033 @samp{friend int foo(int)}, where the name of the friend is an unqualified-id,
3034 could be interpreted as a particular specialization of a template
3035 function; the warning exists to diagnose compatibility problems, 
3036 and is enabled by default.
3038 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
3039 @opindex Wold-style-cast
3040 @opindex Wno-old-style-cast
3041 Warn if an old-style (C-style) cast to a non-void type is used within
3042 a C++ program.  The new-style casts (@code{dynamic_cast},
3043 @code{static_cast}, @code{reinterpret_cast}, and @code{const_cast}) are
3044 less vulnerable to unintended effects and much easier to search for.
3046 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
3047 @opindex Woverloaded-virtual
3048 @opindex Wno-overloaded-virtual
3049 @cindex overloaded virtual function, warning
3050 @cindex warning for overloaded virtual function
3051 Warn when a function declaration hides virtual functions from a
3052 base class.  For example, in:
3054 @smallexample
3055 struct A @{
3056   virtual void f();
3059 struct B: public A @{
3060   void f(int);
3062 @end smallexample
3064 the @code{A} class version of @code{f} is hidden in @code{B}, and code
3065 like:
3067 @smallexample
3068 B* b;
3069 b->f();
3070 @end smallexample
3072 @noindent
3073 fails to compile.
3075 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
3076 @opindex Wno-pmf-conversions
3077 @opindex Wpmf-conversions
3078 Disable the diagnostic for converting a bound pointer to member function
3079 to a plain pointer.
3081 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
3082 @opindex Wsign-promo
3083 @opindex Wno-sign-promo
3084 Warn when overload resolution chooses a promotion from unsigned or
3085 enumerated type to a signed type, over a conversion to an unsigned type of
3086 the same size.  Previous versions of G++ tried to preserve
3087 unsignedness, but the standard mandates the current behavior.
3089 @item -Wtemplates @r{(C++ and Objective-C++ only)}
3090 @opindex Wtemplates
3091 Warn when a primary template declaration is encountered.  Some coding
3092 rules disallow templates, and this may be used to enforce that rule.
3093 The warning is inactive inside a system header file, such as the STL, so
3094 one can still use the STL.  One may also instantiate or specialize
3095 templates.
3097 @item -Wmultiple-inheritance @r{(C++ and Objective-C++ only)}
3098 @opindex Wmultiple-inheritance
3099 Warn when a class is defined with multiple direct base classes.  Some
3100 coding rules disallow multiple inheritance, and this may be used to
3101 enforce that rule.  The warning is inactive inside a system header file,
3102 such as the STL, so one can still use the STL.  One may also define
3103 classes that indirectly use multiple inheritance.
3105 @item -Wvirtual-inheritance
3106 @opindex Wvirtual-inheritance
3107 Warn when a class is defined with a virtual direct base class.  Some
3108 coding rules disallow multiple inheritance, and this may be used to
3109 enforce that rule.  The warning is inactive inside a system header file,
3110 such as the STL, so one can still use the STL.  One may also define
3111 classes that indirectly use virtual inheritance.
3113 @item -Wnamespaces
3114 @opindex Wnamespaces
3115 Warn when a namespace definition is opened.  Some coding rules disallow
3116 namespaces, and this may be used to enforce that rule.  The warning is
3117 inactive inside a system header file, such as the STL, so one can still
3118 use the STL.  One may also use using directives and qualified names.
3120 @item -Wno-terminate @r{(C++ and Objective-C++ only)}
3121 @opindex Wterminate
3122 @opindex Wno-terminate
3123 Disable the warning about a throw-expression that will immediately
3124 result in a call to @code{terminate}.
3125 @end table
3127 @node Objective-C and Objective-C++ Dialect Options
3128 @section Options Controlling Objective-C and Objective-C++ Dialects
3130 @cindex compiler options, Objective-C and Objective-C++
3131 @cindex Objective-C and Objective-C++ options, command-line
3132 @cindex options, Objective-C and Objective-C++
3133 (NOTE: This manual does not describe the Objective-C and Objective-C++
3134 languages themselves.  @xref{Standards,,Language Standards
3135 Supported by GCC}, for references.)
3137 This section describes the command-line options that are only meaningful
3138 for Objective-C and Objective-C++ programs.  You can also use most of
3139 the language-independent GNU compiler options.
3140 For example, you might compile a file @file{some_class.m} like this:
3142 @smallexample
3143 gcc -g -fgnu-runtime -O -c some_class.m
3144 @end smallexample
3146 @noindent
3147 In this example, @option{-fgnu-runtime} is an option meant only for
3148 Objective-C and Objective-C++ programs; you can use the other options with
3149 any language supported by GCC@.
3151 Note that since Objective-C is an extension of the C language, Objective-C
3152 compilations may also use options specific to the C front-end (e.g.,
3153 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
3154 C++-specific options (e.g., @option{-Wabi}).
3156 Here is a list of options that are @emph{only} for compiling Objective-C
3157 and Objective-C++ programs:
3159 @table @gcctabopt
3160 @item -fconstant-string-class=@var{class-name}
3161 @opindex fconstant-string-class
3162 Use @var{class-name} as the name of the class to instantiate for each
3163 literal string specified with the syntax @code{@@"@dots{}"}.  The default
3164 class name is @code{NXConstantString} if the GNU runtime is being used, and
3165 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
3166 @option{-fconstant-cfstrings} option, if also present, overrides the
3167 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
3168 to be laid out as constant CoreFoundation strings.
3170 @item -fgnu-runtime
3171 @opindex fgnu-runtime
3172 Generate object code compatible with the standard GNU Objective-C
3173 runtime.  This is the default for most types of systems.
3175 @item -fnext-runtime
3176 @opindex fnext-runtime
3177 Generate output compatible with the NeXT runtime.  This is the default
3178 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
3179 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
3180 used.
3182 @item -fno-nil-receivers
3183 @opindex fno-nil-receivers
3184 Assume that all Objective-C message dispatches (@code{[receiver
3185 message:arg]}) in this translation unit ensure that the receiver is
3186 not @code{nil}.  This allows for more efficient entry points in the
3187 runtime to be used.  This option is only available in conjunction with
3188 the NeXT runtime and ABI version 0 or 1.
3190 @item -fobjc-abi-version=@var{n}
3191 @opindex fobjc-abi-version
3192 Use version @var{n} of the Objective-C ABI for the selected runtime.
3193 This option is currently supported only for the NeXT runtime.  In that
3194 case, Version 0 is the traditional (32-bit) ABI without support for
3195 properties and other Objective-C 2.0 additions.  Version 1 is the
3196 traditional (32-bit) ABI with support for properties and other
3197 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
3198 nothing is specified, the default is Version 0 on 32-bit target
3199 machines, and Version 2 on 64-bit target machines.
3201 @item -fobjc-call-cxx-cdtors
3202 @opindex fobjc-call-cxx-cdtors
3203 For each Objective-C class, check if any of its instance variables is a
3204 C++ object with a non-trivial default constructor.  If so, synthesize a
3205 special @code{- (id) .cxx_construct} instance method which runs
3206 non-trivial default constructors on any such instance variables, in order,
3207 and then return @code{self}.  Similarly, check if any instance variable
3208 is a C++ object with a non-trivial destructor, and if so, synthesize a
3209 special @code{- (void) .cxx_destruct} method which runs
3210 all such default destructors, in reverse order.
3212 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
3213 methods thusly generated only operate on instance variables
3214 declared in the current Objective-C class, and not those inherited
3215 from superclasses.  It is the responsibility of the Objective-C
3216 runtime to invoke all such methods in an object's inheritance
3217 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
3218 by the runtime immediately after a new object instance is allocated;
3219 the @code{- (void) .cxx_destruct} methods are invoked immediately
3220 before the runtime deallocates an object instance.
3222 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
3223 support for invoking the @code{- (id) .cxx_construct} and
3224 @code{- (void) .cxx_destruct} methods.
3226 @item -fobjc-direct-dispatch
3227 @opindex fobjc-direct-dispatch
3228 Allow fast jumps to the message dispatcher.  On Darwin this is
3229 accomplished via the comm page.
3231 @item -fobjc-exceptions
3232 @opindex fobjc-exceptions
3233 Enable syntactic support for structured exception handling in
3234 Objective-C, similar to what is offered by C++.  This option
3235 is required to use the Objective-C keywords @code{@@try},
3236 @code{@@throw}, @code{@@catch}, @code{@@finally} and
3237 @code{@@synchronized}.  This option is available with both the GNU
3238 runtime and the NeXT runtime (but not available in conjunction with
3239 the NeXT runtime on Mac OS X 10.2 and earlier).
3241 @item -fobjc-gc
3242 @opindex fobjc-gc
3243 Enable garbage collection (GC) in Objective-C and Objective-C++
3244 programs.  This option is only available with the NeXT runtime; the
3245 GNU runtime has a different garbage collection implementation that
3246 does not require special compiler flags.
3248 @item -fobjc-nilcheck
3249 @opindex fobjc-nilcheck
3250 For the NeXT runtime with version 2 of the ABI, check for a nil
3251 receiver in method invocations before doing the actual method call.
3252 This is the default and can be disabled using
3253 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
3254 checked for nil in this way no matter what this flag is set to.
3255 Currently this flag does nothing when the GNU runtime, or an older
3256 version of the NeXT runtime ABI, is used.
3258 @item -fobjc-std=objc1
3259 @opindex fobjc-std
3260 Conform to the language syntax of Objective-C 1.0, the language
3261 recognized by GCC 4.0.  This only affects the Objective-C additions to
3262 the C/C++ language; it does not affect conformance to C/C++ standards,
3263 which is controlled by the separate C/C++ dialect option flags.  When
3264 this option is used with the Objective-C or Objective-C++ compiler,
3265 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
3266 This is useful if you need to make sure that your Objective-C code can
3267 be compiled with older versions of GCC@.
3269 @item -freplace-objc-classes
3270 @opindex freplace-objc-classes
3271 Emit a special marker instructing @command{ld(1)} not to statically link in
3272 the resulting object file, and allow @command{dyld(1)} to load it in at
3273 run time instead.  This is used in conjunction with the Fix-and-Continue
3274 debugging mode, where the object file in question may be recompiled and
3275 dynamically reloaded in the course of program execution, without the need
3276 to restart the program itself.  Currently, Fix-and-Continue functionality
3277 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
3278 and later.
3280 @item -fzero-link
3281 @opindex fzero-link
3282 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
3283 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
3284 compile time) with static class references that get initialized at load time,
3285 which improves run-time performance.  Specifying the @option{-fzero-link} flag
3286 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
3287 to be retained.  This is useful in Zero-Link debugging mode, since it allows
3288 for individual class implementations to be modified during program execution.
3289 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
3290 regardless of command-line options.
3292 @item -fno-local-ivars
3293 @opindex fno-local-ivars
3294 @opindex flocal-ivars
3295 By default instance variables in Objective-C can be accessed as if
3296 they were local variables from within the methods of the class they're
3297 declared in.  This can lead to shadowing between instance variables
3298 and other variables declared either locally inside a class method or
3299 globally with the same name.  Specifying the @option{-fno-local-ivars}
3300 flag disables this behavior thus avoiding variable shadowing issues.
3302 @item -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]}
3303 @opindex fivar-visibility
3304 Set the default instance variable visibility to the specified option
3305 so that instance variables declared outside the scope of any access
3306 modifier directives default to the specified visibility.
3308 @item -gen-decls
3309 @opindex gen-decls
3310 Dump interface declarations for all classes seen in the source file to a
3311 file named @file{@var{sourcename}.decl}.
3313 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
3314 @opindex Wassign-intercept
3315 @opindex Wno-assign-intercept
3316 Warn whenever an Objective-C assignment is being intercepted by the
3317 garbage collector.
3319 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
3320 @opindex Wno-protocol
3321 @opindex Wprotocol
3322 If a class is declared to implement a protocol, a warning is issued for
3323 every method in the protocol that is not implemented by the class.  The
3324 default behavior is to issue a warning for every method not explicitly
3325 implemented in the class, even if a method implementation is inherited
3326 from the superclass.  If you use the @option{-Wno-protocol} option, then
3327 methods inherited from the superclass are considered to be implemented,
3328 and no warning is issued for them.
3330 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3331 @opindex Wselector
3332 @opindex Wno-selector
3333 Warn if multiple methods of different types for the same selector are
3334 found during compilation.  The check is performed on the list of methods
3335 in the final stage of compilation.  Additionally, a check is performed
3336 for each selector appearing in a @code{@@selector(@dots{})}
3337 expression, and a corresponding method for that selector has been found
3338 during compilation.  Because these checks scan the method table only at
3339 the end of compilation, these warnings are not produced if the final
3340 stage of compilation is not reached, for example because an error is
3341 found during compilation, or because the @option{-fsyntax-only} option is
3342 being used.
3344 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3345 @opindex Wstrict-selector-match
3346 @opindex Wno-strict-selector-match
3347 Warn if multiple methods with differing argument and/or return types are
3348 found for a given selector when attempting to send a message using this
3349 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3350 is off (which is the default behavior), the compiler omits such warnings
3351 if any differences found are confined to types that share the same size
3352 and alignment.
3354 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3355 @opindex Wundeclared-selector
3356 @opindex Wno-undeclared-selector
3357 Warn if a @code{@@selector(@dots{})} expression referring to an
3358 undeclared selector is found.  A selector is considered undeclared if no
3359 method with that name has been declared before the
3360 @code{@@selector(@dots{})} expression, either explicitly in an
3361 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3362 an @code{@@implementation} section.  This option always performs its
3363 checks as soon as a @code{@@selector(@dots{})} expression is found,
3364 while @option{-Wselector} only performs its checks in the final stage of
3365 compilation.  This also enforces the coding style convention
3366 that methods and selectors must be declared before being used.
3368 @item -print-objc-runtime-info
3369 @opindex print-objc-runtime-info
3370 Generate C header describing the largest structure that is passed by
3371 value, if any.
3373 @end table
3375 @node Diagnostic Message Formatting Options
3376 @section Options to Control Diagnostic Messages Formatting
3377 @cindex options to control diagnostics formatting
3378 @cindex diagnostic messages
3379 @cindex message formatting
3381 Traditionally, diagnostic messages have been formatted irrespective of
3382 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3383 options described below
3384 to control the formatting algorithm for diagnostic messages, 
3385 e.g.@: how many characters per line, how often source location
3386 information should be reported.  Note that some language front ends may not
3387 honor these options.
3389 @table @gcctabopt
3390 @item -fmessage-length=@var{n}
3391 @opindex fmessage-length
3392 Try to format error messages so that they fit on lines of about
3393 @var{n} characters.  If @var{n} is zero, then no line-wrapping is
3394 done; each error message appears on a single line.  This is the
3395 default for all front ends.
3397 @item -fdiagnostics-show-location=once
3398 @opindex fdiagnostics-show-location
3399 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3400 reporter to emit source location information @emph{once}; that is, in
3401 case the message is too long to fit on a single physical line and has to
3402 be wrapped, the source location won't be emitted (as prefix) again,
3403 over and over, in subsequent continuation lines.  This is the default
3404 behavior.
3406 @item -fdiagnostics-show-location=every-line
3407 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3408 messages reporter to emit the same source location information (as
3409 prefix) for physical lines that result from the process of breaking
3410 a message which is too long to fit on a single line.
3412 @item -fdiagnostics-color[=@var{WHEN}]
3413 @itemx -fno-diagnostics-color
3414 @opindex fdiagnostics-color
3415 @cindex highlight, color
3416 @vindex GCC_COLORS @r{environment variable}
3417 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3418 or @samp{auto}.  The default depends on how the compiler has been configured,
3419 it can be any of the above @var{WHEN} options or also @samp{never}
3420 if @env{GCC_COLORS} environment variable isn't present in the environment,
3421 and @samp{auto} otherwise.
3422 @samp{auto} means to use color only when the standard error is a terminal.
3423 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3424 aliases for @option{-fdiagnostics-color=always} and
3425 @option{-fdiagnostics-color=never}, respectively.
3427 The colors are defined by the environment variable @env{GCC_COLORS}.
3428 Its value is a colon-separated list of capabilities and Select Graphic
3429 Rendition (SGR) substrings. SGR commands are interpreted by the
3430 terminal or terminal emulator.  (See the section in the documentation
3431 of your text terminal for permitted values and their meanings as
3432 character attributes.)  These substring values are integers in decimal
3433 representation and can be concatenated with semicolons.
3434 Common values to concatenate include
3435 @samp{1} for bold,
3436 @samp{4} for underline,
3437 @samp{5} for blink,
3438 @samp{7} for inverse,
3439 @samp{39} for default foreground color,
3440 @samp{30} to @samp{37} for foreground colors,
3441 @samp{90} to @samp{97} for 16-color mode foreground colors,
3442 @samp{38;5;0} to @samp{38;5;255}
3443 for 88-color and 256-color modes foreground colors,
3444 @samp{49} for default background color,
3445 @samp{40} to @samp{47} for background colors,
3446 @samp{100} to @samp{107} for 16-color mode background colors,
3447 and @samp{48;5;0} to @samp{48;5;255}
3448 for 88-color and 256-color modes background colors.
3450 The default @env{GCC_COLORS} is
3451 @smallexample
3452 error=01;31:warning=01;35:note=01;36:range1=32:range2=34:locus=01:\
3453 quote=01:fixit-insert=32:fixit-delete=31:\
3454 diff-filename=01:diff-hunk=32:diff-delete=31:diff-insert=32:\
3455 type-diff=01;32
3456 @end smallexample
3457 @noindent
3458 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3459 @samp{01;36} is bold cyan, @samp{32} is green, @samp{34} is blue,
3460 @samp{01} is bold, and @samp{31} is red.
3461 Setting @env{GCC_COLORS} to the empty string disables colors.
3462 Supported capabilities are as follows.
3464 @table @code
3465 @item error=
3466 @vindex error GCC_COLORS @r{capability}
3467 SGR substring for error: markers.
3469 @item warning=
3470 @vindex warning GCC_COLORS @r{capability}
3471 SGR substring for warning: markers.
3473 @item note=
3474 @vindex note GCC_COLORS @r{capability}
3475 SGR substring for note: markers.
3477 @item range1=
3478 @vindex range1 GCC_COLORS @r{capability}
3479 SGR substring for first additional range.
3481 @item range2=
3482 @vindex range2 GCC_COLORS @r{capability}
3483 SGR substring for second additional range.
3485 @item locus=
3486 @vindex locus GCC_COLORS @r{capability}
3487 SGR substring for location information, @samp{file:line} or
3488 @samp{file:line:column} etc.
3490 @item quote=
3491 @vindex quote GCC_COLORS @r{capability}
3492 SGR substring for information printed within quotes.
3494 @item fixit-insert=
3495 @vindex fixit-insert GCC_COLORS @r{capability}
3496 SGR substring for fix-it hints suggesting text to
3497 be inserted or replaced.
3499 @item fixit-delete=
3500 @vindex fixit-delete GCC_COLORS @r{capability}
3501 SGR substring for fix-it hints suggesting text to
3502 be deleted.
3504 @item diff-filename=
3505 @vindex diff-filename GCC_COLORS @r{capability}
3506 SGR substring for filename headers within generated patches.
3508 @item diff-hunk=
3509 @vindex diff-hunk GCC_COLORS @r{capability}
3510 SGR substring for the starts of hunks within generated patches.
3512 @item diff-delete=
3513 @vindex diff-delete GCC_COLORS @r{capability}
3514 SGR substring for deleted lines within generated patches.
3516 @item diff-insert=
3517 @vindex diff-insert GCC_COLORS @r{capability}
3518 SGR substring for inserted lines within generated patches.
3520 @item type-diff=
3521 @vindex type-diff GCC_COLORS @r{capability}
3522 SGR substring for highlighting mismatching types within template
3523 arguments in the C++ frontend.
3524 @end table
3526 @item -fno-diagnostics-show-option
3527 @opindex fno-diagnostics-show-option
3528 @opindex fdiagnostics-show-option
3529 By default, each diagnostic emitted includes text indicating the
3530 command-line option that directly controls the diagnostic (if such an
3531 option is known to the diagnostic machinery).  Specifying the
3532 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3534 @item -fno-diagnostics-show-caret
3535 @opindex fno-diagnostics-show-caret
3536 @opindex fdiagnostics-show-caret
3537 By default, each diagnostic emitted includes the original source line
3538 and a caret @samp{^} indicating the column.  This option suppresses this
3539 information.  The source line is truncated to @var{n} characters, if
3540 the @option{-fmessage-length=n} option is given.  When the output is done
3541 to the terminal, the width is limited to the width given by the
3542 @env{COLUMNS} environment variable or, if not set, to the terminal width.
3544 @item -fdiagnostics-parseable-fixits
3545 @opindex fdiagnostics-parseable-fixits
3546 Emit fix-it hints in a machine-parseable format, suitable for consumption
3547 by IDEs.  For each fix-it, a line will be printed after the relevant
3548 diagnostic, starting with the string ``fix-it:''.  For example:
3550 @smallexample
3551 fix-it:"test.c":@{45:3-45:21@}:"gtk_widget_show_all"
3552 @end smallexample
3554 The location is expressed as a half-open range, expressed as a count of
3555 bytes, starting at byte 1 for the initial column.  In the above example,
3556 bytes 3 through 20 of line 45 of ``test.c'' are to be replaced with the
3557 given string:
3559 @smallexample
3560 00000000011111111112222222222
3561 12345678901234567890123456789
3562   gtk_widget_showall (dlg);
3563   ^^^^^^^^^^^^^^^^^^
3564   gtk_widget_show_all
3565 @end smallexample
3567 The filename and replacement string escape backslash as ``\\", tab as ``\t'',
3568 newline as ``\n'', double quotes as ``\"'', non-printable characters as octal
3569 (e.g. vertical tab as ``\013'').
3571 An empty replacement string indicates that the given range is to be removed.
3572 An empty range (e.g. ``45:3-45:3'') indicates that the string is to
3573 be inserted at the given position.
3575 @item -fdiagnostics-generate-patch
3576 @opindex fdiagnostics-generate-patch
3577 Print fix-it hints to stderr in unified diff format, after any diagnostics
3578 are printed.  For example:
3580 @smallexample
3581 --- test.c
3582 +++ test.c
3583 @@ -42,5 +42,5 @@
3585  void show_cb(GtkDialog *dlg)
3586  @{
3587 -  gtk_widget_showall(dlg);
3588 +  gtk_widget_show_all(dlg);
3589  @}
3591 @end smallexample
3593 The diff may or may not be colorized, following the same rules
3594 as for diagnostics (see @option{-fdiagnostics-color}).
3596 @item -fdiagnostics-show-template-tree
3597 @opindex fdiagnostics-show-template-tree
3599 In the C++ frontend, when printing diagnostics showing mismatching
3600 template types, such as:
3602 @smallexample
3603   could not convert 'std::map<int, std::vector<double> >()'
3604     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3605 @end smallexample
3607 the @option{-fdiagnostics-show-template-tree} flag enables printing a
3608 tree-like structure showing the common and differing parts of the types,
3609 such as:
3611 @smallexample
3612   map<
3613     [...],
3614     vector<
3615       [double != float]>>
3616 @end smallexample
3618 The parts that differ are highlighted with color (``double'' and
3619 ``float'' in this case).
3621 @item -fno-elide-type
3622 @opindex fno-elide-type
3623 @opindex felide-type
3624 By default when the C++ frontend prints diagnostics showing mismatching
3625 template types, common parts of the types are printed as ``[...]'' to
3626 simplify the error message.  For example:
3628 @smallexample
3629   could not convert 'std::map<int, std::vector<double> >()'
3630     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3631 @end smallexample
3633 Specifying the @option{-fno-elide-type} flag suppresses that behavior.
3634 This flag also affects the output of the
3635 @option{-fdiagnostics-show-template-tree} flag.
3637 @item -fno-show-column
3638 @opindex fno-show-column
3639 Do not print column numbers in diagnostics.  This may be necessary if
3640 diagnostics are being scanned by a program that does not understand the
3641 column numbers, such as @command{dejagnu}.
3643 @end table
3645 @node Warning Options
3646 @section Options to Request or Suppress Warnings
3647 @cindex options to control warnings
3648 @cindex warning messages
3649 @cindex messages, warning
3650 @cindex suppressing warnings
3652 Warnings are diagnostic messages that report constructions that
3653 are not inherently erroneous but that are risky or suggest there
3654 may have been an error.
3656 The following language-independent options do not enable specific
3657 warnings but control the kinds of diagnostics produced by GCC@.
3659 @table @gcctabopt
3660 @cindex syntax checking
3661 @item -fsyntax-only
3662 @opindex fsyntax-only
3663 Check the code for syntax errors, but don't do anything beyond that.
3665 @item -fmax-errors=@var{n}
3666 @opindex fmax-errors
3667 Limits the maximum number of error messages to @var{n}, at which point
3668 GCC bails out rather than attempting to continue processing the source
3669 code.  If @var{n} is 0 (the default), there is no limit on the number
3670 of error messages produced.  If @option{-Wfatal-errors} is also
3671 specified, then @option{-Wfatal-errors} takes precedence over this
3672 option.
3674 @item -w
3675 @opindex w
3676 Inhibit all warning messages.
3678 @item -Werror
3679 @opindex Werror
3680 @opindex Wno-error
3681 Make all warnings into errors.
3683 @item -Werror=
3684 @opindex Werror=
3685 @opindex Wno-error=
3686 Make the specified warning into an error.  The specifier for a warning
3687 is appended; for example @option{-Werror=switch} turns the warnings
3688 controlled by @option{-Wswitch} into errors.  This switch takes a
3689 negative form, to be used to negate @option{-Werror} for specific
3690 warnings; for example @option{-Wno-error=switch} makes
3691 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3692 is in effect.
3694 The warning message for each controllable warning includes the
3695 option that controls the warning.  That option can then be used with
3696 @option{-Werror=} and @option{-Wno-error=} as described above.
3697 (Printing of the option in the warning message can be disabled using the
3698 @option{-fno-diagnostics-show-option} flag.)
3700 Note that specifying @option{-Werror=}@var{foo} automatically implies
3701 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3702 imply anything.
3704 @item -Wfatal-errors
3705 @opindex Wfatal-errors
3706 @opindex Wno-fatal-errors
3707 This option causes the compiler to abort compilation on the first error
3708 occurred rather than trying to keep going and printing further error
3709 messages.
3711 @end table
3713 You can request many specific warnings with options beginning with
3714 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3715 implicit declarations.  Each of these specific warning options also
3716 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3717 example, @option{-Wno-implicit}.  This manual lists only one of the
3718 two forms, whichever is not the default.  For further
3719 language-specific options also refer to @ref{C++ Dialect Options} and
3720 @ref{Objective-C and Objective-C++ Dialect Options}.
3722 Some options, such as @option{-Wall} and @option{-Wextra}, turn on other
3723 options, such as @option{-Wunused}, which may turn on further options,
3724 such as @option{-Wunused-value}. The combined effect of positive and
3725 negative forms is that more specific options have priority over less
3726 specific ones, independently of their position in the command-line. For
3727 options of the same specificity, the last one takes effect. Options
3728 enabled or disabled via pragmas (@pxref{Diagnostic Pragmas}) take effect
3729 as if they appeared at the end of the command-line.
3731 When an unrecognized warning option is requested (e.g.,
3732 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3733 that the option is not recognized.  However, if the @option{-Wno-} form
3734 is used, the behavior is slightly different: no diagnostic is
3735 produced for @option{-Wno-unknown-warning} unless other diagnostics
3736 are being produced.  This allows the use of new @option{-Wno-} options
3737 with old compilers, but if something goes wrong, the compiler
3738 warns that an unrecognized option is present.
3740 @table @gcctabopt
3741 @item -Wpedantic
3742 @itemx -pedantic
3743 @opindex pedantic
3744 @opindex Wpedantic
3745 Issue all the warnings demanded by strict ISO C and ISO C++;
3746 reject all programs that use forbidden extensions, and some other
3747 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3748 version of the ISO C standard specified by any @option{-std} option used.
3750 Valid ISO C and ISO C++ programs should compile properly with or without
3751 this option (though a rare few require @option{-ansi} or a
3752 @option{-std} option specifying the required version of ISO C)@.  However,
3753 without this option, certain GNU extensions and traditional C and C++
3754 features are supported as well.  With this option, they are rejected.
3756 @option{-Wpedantic} does not cause warning messages for use of the
3757 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3758 warnings are also disabled in the expression that follows
3759 @code{__extension__}.  However, only system header files should use
3760 these escape routes; application programs should avoid them.
3761 @xref{Alternate Keywords}.
3763 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3764 C conformance.  They soon find that it does not do quite what they want:
3765 it finds some non-ISO practices, but not all---only those for which
3766 ISO C @emph{requires} a diagnostic, and some others for which
3767 diagnostics have been added.
3769 A feature to report any failure to conform to ISO C might be useful in
3770 some instances, but would require considerable additional work and would
3771 be quite different from @option{-Wpedantic}.  We don't have plans to
3772 support such a feature in the near future.
3774 Where the standard specified with @option{-std} represents a GNU
3775 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3776 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3777 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3778 where they are required by the base standard.  (It does not make sense
3779 for such warnings to be given only for features not in the specified GNU
3780 C dialect, since by definition the GNU dialects of C include all
3781 features the compiler supports with the given option, and there would be
3782 nothing to warn about.)
3784 @item -pedantic-errors
3785 @opindex pedantic-errors
3786 Give an error whenever the @dfn{base standard} (see @option{-Wpedantic})
3787 requires a diagnostic, in some cases where there is undefined behavior
3788 at compile-time and in some other cases that do not prevent compilation
3789 of programs that are valid according to the standard. This is not
3790 equivalent to @option{-Werror=pedantic}, since there are errors enabled
3791 by this option and not enabled by the latter and vice versa.
3793 @item -Wall
3794 @opindex Wall
3795 @opindex Wno-all
3796 This enables all the warnings about constructions that some users
3797 consider questionable, and that are easy to avoid (or modify to
3798 prevent the warning), even in conjunction with macros.  This also
3799 enables some language-specific warnings described in @ref{C++ Dialect
3800 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3802 @option{-Wall} turns on the following warning flags:
3804 @gccoptlist{-Waddress   @gol
3805 -Warray-bounds=1 @r{(only with} @option{-O2}@r{)}  @gol
3806 -Wbool-compare  @gol
3807 -Wbool-operation  @gol
3808 -Wc++11-compat  -Wc++14-compat  @gol
3809 -Wcatch-value @r{(C++ and Objective-C++ only)}  @gol
3810 -Wchar-subscripts  @gol
3811 -Wcomment  @gol
3812 -Wduplicate-decl-specifier @r{(C and Objective-C only)} @gol
3813 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3814 -Wformat   @gol
3815 -Wint-in-bool-context  @gol
3816 -Wimplicit @r{(C and Objective-C only)} @gol
3817 -Wimplicit-int @r{(C and Objective-C only)} @gol
3818 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3819 -Winit-self @r{(only for C++)} @gol
3820 -Wlogical-not-parentheses @gol
3821 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3822 -Wmaybe-uninitialized @gol
3823 -Wmemset-elt-size @gol
3824 -Wmemset-transposed-args @gol
3825 -Wmisleading-indentation @r{(only for C/C++)} @gol
3826 -Wmissing-braces @r{(only for C/ObjC)} @gol
3827 -Wnarrowing @r{(only for C++)}  @gol
3828 -Wnonnull  @gol
3829 -Wnonnull-compare  @gol
3830 -Wopenmp-simd @gol
3831 -Wparentheses  @gol
3832 -Wpointer-sign  @gol
3833 -Wreorder   @gol
3834 -Wreturn-type  @gol
3835 -Wsequence-point  @gol
3836 -Wsign-compare @r{(only in C++)}  @gol
3837 -Wsizeof-pointer-div @gol
3838 -Wsizeof-pointer-memaccess @gol
3839 -Wstrict-aliasing  @gol
3840 -Wstrict-overflow=1  @gol
3841 -Wswitch  @gol
3842 -Wtautological-compare  @gol
3843 -Wtrigraphs  @gol
3844 -Wuninitialized  @gol
3845 -Wunknown-pragmas  @gol
3846 -Wunused-function  @gol
3847 -Wunused-label     @gol
3848 -Wunused-value     @gol
3849 -Wunused-variable  @gol
3850 -Wvolatile-register-var @gol
3853 Note that some warning flags are not implied by @option{-Wall}.  Some of
3854 them warn about constructions that users generally do not consider
3855 questionable, but which occasionally you might wish to check for;
3856 others warn about constructions that are necessary or hard to avoid in
3857 some cases, and there is no simple way to modify the code to suppress
3858 the warning. Some of them are enabled by @option{-Wextra} but many of
3859 them must be enabled individually.
3861 @item -Wextra
3862 @opindex W
3863 @opindex Wextra
3864 @opindex Wno-extra
3865 This enables some extra warning flags that are not enabled by
3866 @option{-Wall}. (This option used to be called @option{-W}.  The older
3867 name is still supported, but the newer name is more descriptive.)
3869 @gccoptlist{-Wclobbered  @gol
3870 -Wempty-body  @gol
3871 -Wignored-qualifiers @gol
3872 -Wimplicit-fallthrough=3 @gol
3873 -Wmissing-field-initializers  @gol
3874 -Wmissing-parameter-type @r{(C only)}  @gol
3875 -Wold-style-declaration @r{(C only)}  @gol
3876 -Woverride-init  @gol
3877 -Wsign-compare @r{(C only)} @gol
3878 -Wtype-limits  @gol
3879 -Wuninitialized  @gol
3880 -Wshift-negative-value @r{(in C++03 and in C99 and newer)}  @gol
3881 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3882 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3885 The option @option{-Wextra} also prints warning messages for the
3886 following cases:
3888 @itemize @bullet
3890 @item
3891 A pointer is compared against integer zero with @code{<}, @code{<=},
3892 @code{>}, or @code{>=}.
3894 @item
3895 (C++ only) An enumerator and a non-enumerator both appear in a
3896 conditional expression.
3898 @item
3899 (C++ only) Ambiguous virtual bases.
3901 @item
3902 (C++ only) Subscripting an array that has been declared @code{register}.
3904 @item
3905 (C++ only) Taking the address of a variable that has been declared
3906 @code{register}.
3908 @item
3909 (C++ only) A base class is not initialized in the copy constructor
3910 of a derived class.
3912 @end itemize
3914 @item -Wchar-subscripts
3915 @opindex Wchar-subscripts
3916 @opindex Wno-char-subscripts
3917 Warn if an array subscript has type @code{char}.  This is a common cause
3918 of error, as programmers often forget that this type is signed on some
3919 machines.
3920 This warning is enabled by @option{-Wall}.
3922 @item -Wchkp
3923 @opindex Wchkp
3924 Warn about an invalid memory access that is found by Pointer Bounds Checker
3925 (@option{-fcheck-pointer-bounds}).
3927 @item -Wno-coverage-mismatch
3928 @opindex Wno-coverage-mismatch
3929 Warn if feedback profiles do not match when using the
3930 @option{-fprofile-use} option.
3931 If a source file is changed between compiling with @option{-fprofile-gen} and
3932 with @option{-fprofile-use}, the files with the profile feedback can fail
3933 to match the source file and GCC cannot use the profile feedback
3934 information.  By default, this warning is enabled and is treated as an
3935 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3936 warning or @option{-Wno-error=coverage-mismatch} can be used to
3937 disable the error.  Disabling the error for this warning can result in
3938 poorly optimized code and is useful only in the
3939 case of very minor changes such as bug fixes to an existing code-base.
3940 Completely disabling the warning is not recommended.
3942 @item -Wno-cpp
3943 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3945 Suppress warning messages emitted by @code{#warning} directives.
3947 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3948 @opindex Wdouble-promotion
3949 @opindex Wno-double-promotion
3950 Give a warning when a value of type @code{float} is implicitly
3951 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
3952 floating-point unit implement @code{float} in hardware, but emulate
3953 @code{double} in software.  On such a machine, doing computations
3954 using @code{double} values is much more expensive because of the
3955 overhead required for software emulation.
3957 It is easy to accidentally do computations with @code{double} because
3958 floating-point literals are implicitly of type @code{double}.  For
3959 example, in:
3960 @smallexample
3961 @group
3962 float area(float radius)
3964    return 3.14159 * radius * radius;
3966 @end group
3967 @end smallexample
3968 the compiler performs the entire computation with @code{double}
3969 because the floating-point literal is a @code{double}.
3971 @item -Wduplicate-decl-specifier @r{(C and Objective-C only)}
3972 @opindex Wduplicate-decl-specifier
3973 @opindex Wno-duplicate-decl-specifier
3974 Warn if a declaration has duplicate @code{const}, @code{volatile},
3975 @code{restrict} or @code{_Atomic} specifier.  This warning is enabled by
3976 @option{-Wall}.
3978 @item -Wformat
3979 @itemx -Wformat=@var{n}
3980 @opindex Wformat
3981 @opindex Wno-format
3982 @opindex ffreestanding
3983 @opindex fno-builtin
3984 @opindex Wformat=
3985 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
3986 the arguments supplied have types appropriate to the format string
3987 specified, and that the conversions specified in the format string make
3988 sense.  This includes standard functions, and others specified by format
3989 attributes (@pxref{Function Attributes}), in the @code{printf},
3990 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
3991 not in the C standard) families (or other target-specific families).
3992 Which functions are checked without format attributes having been
3993 specified depends on the standard version selected, and such checks of
3994 functions without the attribute specified are disabled by
3995 @option{-ffreestanding} or @option{-fno-builtin}.
3997 The formats are checked against the format features supported by GNU
3998 libc version 2.2.  These include all ISO C90 and C99 features, as well
3999 as features from the Single Unix Specification and some BSD and GNU
4000 extensions.  Other library implementations may not support all these
4001 features; GCC does not support warning about features that go beyond a
4002 particular library's limitations.  However, if @option{-Wpedantic} is used
4003 with @option{-Wformat}, warnings are given about format features not
4004 in the selected standard version (but not for @code{strfmon} formats,
4005 since those are not in any version of the C standard).  @xref{C Dialect
4006 Options,,Options Controlling C Dialect}.
4008 @table @gcctabopt
4009 @item -Wformat=1
4010 @itemx -Wformat
4011 @opindex Wformat
4012 @opindex Wformat=1
4013 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
4014 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
4015 @option{-Wformat} also checks for null format arguments for several
4016 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
4017 aspects of this level of format checking can be disabled by the
4018 options: @option{-Wno-format-contains-nul},
4019 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
4020 @option{-Wformat} is enabled by @option{-Wall}.
4022 @item -Wno-format-contains-nul
4023 @opindex Wno-format-contains-nul
4024 @opindex Wformat-contains-nul
4025 If @option{-Wformat} is specified, do not warn about format strings that
4026 contain NUL bytes.
4028 @item -Wno-format-extra-args
4029 @opindex Wno-format-extra-args
4030 @opindex Wformat-extra-args
4031 If @option{-Wformat} is specified, do not warn about excess arguments to a
4032 @code{printf} or @code{scanf} format function.  The C standard specifies
4033 that such arguments are ignored.
4035 Where the unused arguments lie between used arguments that are
4036 specified with @samp{$} operand number specifications, normally
4037 warnings are still given, since the implementation could not know what
4038 type to pass to @code{va_arg} to skip the unused arguments.  However,
4039 in the case of @code{scanf} formats, this option suppresses the
4040 warning if the unused arguments are all pointers, since the Single
4041 Unix Specification says that such unused arguments are allowed.
4043 @item -Wformat-overflow
4044 @itemx -Wformat-overflow=@var{level}
4045 @opindex Wformat-overflow
4046 @opindex Wno-format-overflow
4047 Warn about calls to formatted input/output functions such as @code{sprintf}
4048 and @code{vsprintf} that might overflow the destination buffer.  When the
4049 exact number of bytes written by a format directive cannot be determined
4050 at compile-time it is estimated based on heuristics that depend on the
4051 @var{level} argument and on optimization.  While enabling optimization
4052 will in most cases improve the accuracy of the warning, it may also
4053 result in false positives.
4055 @table @gcctabopt
4056 @item -Wformat-overflow
4057 @item -Wformat-overflow=1
4058 @opindex Wformat-overflow
4059 @opindex Wno-format-overflow
4060 Level @var{1} of @option{-Wformat-overflow} enabled by @option{-Wformat}
4061 employs a conservative approach that warns only about calls that most
4062 likely overflow the buffer.  At this level, numeric arguments to format
4063 directives with unknown values are assumed to have the value of one, and
4064 strings of unknown length to be empty.  Numeric arguments that are known
4065 to be bounded to a subrange of their type, or string arguments whose output
4066 is bounded either by their directive's precision or by a finite set of
4067 string literals, are assumed to take on the value within the range that
4068 results in the most bytes on output.  For example, the call to @code{sprintf}
4069 below is diagnosed because even with both @var{a} and @var{b} equal to zero,
4070 the terminating NUL character (@code{'\0'}) appended by the function
4071 to the destination buffer will be written past its end.  Increasing
4072 the size of the buffer by a single byte is sufficient to avoid the
4073 warning, though it may not be sufficient to avoid the overflow.
4075 @smallexample
4076 void f (int a, int b)
4078   char buf [12];
4079   sprintf (buf, "a = %i, b = %i\n", a, b);
4081 @end smallexample
4083 @item -Wformat-overflow=2
4084 Level @var{2} warns also about calls that might overflow the destination
4085 buffer given an argument of sufficient length or magnitude.  At level
4086 @var{2}, unknown numeric arguments are assumed to have the minimum
4087 representable value for signed types with a precision greater than 1, and
4088 the maximum representable value otherwise.  Unknown string arguments whose
4089 length cannot be assumed to be bounded either by the directive's precision,
4090 or by a finite set of string literals they may evaluate to, or the character
4091 array they may point to, are assumed to be 1 character long.
4093 At level @var{2}, the call in the example above is again diagnosed, but
4094 this time because with @var{a} equal to a 32-bit @code{INT_MIN} the first
4095 @code{%i} directive will write some of its digits beyond the end of
4096 the destination buffer.  To make the call safe regardless of the values
4097 of the two variables, the size of the destination buffer must be increased
4098 to at least 34 bytes.  GCC includes the minimum size of the buffer in
4099 an informational note following the warning.
4101 An alternative to increasing the size of the destination buffer is to
4102 constrain the range of formatted values.  The maximum length of string
4103 arguments can be bounded by specifying the precision in the format
4104 directive.  When numeric arguments of format directives can be assumed
4105 to be bounded by less than the precision of their type, choosing
4106 an appropriate length modifier to the format specifier will reduce
4107 the required buffer size.  For example, if @var{a} and @var{b} in the
4108 example above can be assumed to be within the precision of
4109 the @code{short int} type then using either the @code{%hi} format
4110 directive or casting the argument to @code{short} reduces the maximum
4111 required size of the buffer to 24 bytes.
4113 @smallexample
4114 void f (int a, int b)
4116   char buf [23];
4117   sprintf (buf, "a = %hi, b = %i\n", a, (short)b);
4119 @end smallexample
4120 @end table
4122 @item -Wno-format-zero-length
4123 @opindex Wno-format-zero-length
4124 @opindex Wformat-zero-length
4125 If @option{-Wformat} is specified, do not warn about zero-length formats.
4126 The C standard specifies that zero-length formats are allowed.
4129 @item -Wformat=2
4130 @opindex Wformat=2
4131 Enable @option{-Wformat} plus additional format checks.  Currently
4132 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
4133 -Wformat-y2k}.
4135 @item -Wformat-nonliteral
4136 @opindex Wformat-nonliteral
4137 @opindex Wno-format-nonliteral
4138 If @option{-Wformat} is specified, also warn if the format string is not a
4139 string literal and so cannot be checked, unless the format function
4140 takes its format arguments as a @code{va_list}.
4142 @item -Wformat-security
4143 @opindex Wformat-security
4144 @opindex Wno-format-security
4145 If @option{-Wformat} is specified, also warn about uses of format
4146 functions that represent possible security problems.  At present, this
4147 warns about calls to @code{printf} and @code{scanf} functions where the
4148 format string is not a string literal and there are no format arguments,
4149 as in @code{printf (foo);}.  This may be a security hole if the format
4150 string came from untrusted input and contains @samp{%n}.  (This is
4151 currently a subset of what @option{-Wformat-nonliteral} warns about, but
4152 in future warnings may be added to @option{-Wformat-security} that are not
4153 included in @option{-Wformat-nonliteral}.)
4155 @item -Wformat-signedness
4156 @opindex Wformat-signedness
4157 @opindex Wno-format-signedness
4158 If @option{-Wformat} is specified, also warn if the format string
4159 requires an unsigned argument and the argument is signed and vice versa.
4161 @item -Wformat-truncation
4162 @itemx -Wformat-truncation=@var{level}
4163 @opindex Wformat-truncation
4164 @opindex Wno-format-truncation
4165 Warn about calls to formatted input/output functions such as @code{snprintf}
4166 and @code{vsnprintf} that might result in output truncation.  When the exact
4167 number of bytes written by a format directive cannot be determined at
4168 compile-time it is estimated based on heuristics that depend on
4169 the @var{level} argument and on optimization.  While enabling optimization
4170 will in most cases improve the accuracy of the warning, it may also result
4171 in false positives.  Except as noted otherwise, the option uses the same
4172 logic @option{-Wformat-overflow}.
4174 @table @gcctabopt
4175 @item -Wformat-truncation
4176 @item -Wformat-truncation=1
4177 @opindex Wformat-truncation
4178 @opindex Wno-format-overflow
4179 Level @var{1} of @option{-Wformat-truncation} enabled by @option{-Wformat}
4180 employs a conservative approach that warns only about calls to bounded
4181 functions whose return value is unused and that will most likely result
4182 in output truncation.
4184 @item -Wformat-truncation=2
4185 Level @var{2} warns also about calls to bounded functions whose return
4186 value is used and that might result in truncation given an argument of
4187 sufficient length or magnitude.
4188 @end table
4190 @item -Wformat-y2k
4191 @opindex Wformat-y2k
4192 @opindex Wno-format-y2k
4193 If @option{-Wformat} is specified, also warn about @code{strftime}
4194 formats that may yield only a two-digit year.
4195 @end table
4197 @item -Wnonnull
4198 @opindex Wnonnull
4199 @opindex Wno-nonnull
4200 Warn about passing a null pointer for arguments marked as
4201 requiring a non-null value by the @code{nonnull} function attribute.
4203 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
4204 can be disabled with the @option{-Wno-nonnull} option.
4206 @item -Wnonnull-compare
4207 @opindex Wnonnull-compare
4208 @opindex Wno-nonnull-compare
4209 Warn when comparing an argument marked with the @code{nonnull}
4210 function attribute against null inside the function.
4212 @option{-Wnonnull-compare} is included in @option{-Wall}.  It
4213 can be disabled with the @option{-Wno-nonnull-compare} option.
4215 @item -Wnull-dereference
4216 @opindex Wnull-dereference
4217 @opindex Wno-null-dereference
4218 Warn if the compiler detects paths that trigger erroneous or
4219 undefined behavior due to dereferencing a null pointer.  This option
4220 is only active when @option{-fdelete-null-pointer-checks} is active,
4221 which is enabled by optimizations in most targets.  The precision of
4222 the warnings depends on the optimization options used.
4224 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
4225 @opindex Winit-self
4226 @opindex Wno-init-self
4227 Warn about uninitialized variables that are initialized with themselves.
4228 Note this option can only be used with the @option{-Wuninitialized} option.
4230 For example, GCC warns about @code{i} being uninitialized in the
4231 following snippet only when @option{-Winit-self} has been specified:
4232 @smallexample
4233 @group
4234 int f()
4236   int i = i;
4237   return i;
4239 @end group
4240 @end smallexample
4242 This warning is enabled by @option{-Wall} in C++.
4244 @item -Wimplicit-int @r{(C and Objective-C only)}
4245 @opindex Wimplicit-int
4246 @opindex Wno-implicit-int
4247 Warn when a declaration does not specify a type.
4248 This warning is enabled by @option{-Wall}.
4250 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
4251 @opindex Wimplicit-function-declaration
4252 @opindex Wno-implicit-function-declaration
4253 Give a warning whenever a function is used before being declared. In
4254 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
4255 enabled by default and it is made into an error by
4256 @option{-pedantic-errors}. This warning is also enabled by
4257 @option{-Wall}.
4259 @item -Wimplicit @r{(C and Objective-C only)}
4260 @opindex Wimplicit
4261 @opindex Wno-implicit
4262 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
4263 This warning is enabled by @option{-Wall}.
4265 @item -Wimplicit-fallthrough
4266 @opindex Wimplicit-fallthrough
4267 @opindex Wno-implicit-fallthrough
4268 @option{-Wimplicit-fallthrough} is the same as @option{-Wimplicit-fallthrough=3}
4269 and @option{-Wno-implicit-fallthrough} is the same as
4270 @option{-Wimplicit-fallthrough=0}.
4272 @item -Wimplicit-fallthrough=@var{n}
4273 @opindex Wimplicit-fallthrough=
4274 Warn when a switch case falls through.  For example:
4276 @smallexample
4277 @group
4278 switch (cond)
4279   @{
4280   case 1:
4281     a = 1;
4282     break;
4283   case 2:
4284     a = 2;
4285   case 3:
4286     a = 3;
4287     break;
4288   @}
4289 @end group
4290 @end smallexample
4292 This warning does not warn when the last statement of a case cannot
4293 fall through, e.g. when there is a return statement or a call to function
4294 declared with the noreturn attribute.  @option{-Wimplicit-fallthrough=}
4295 also takes into account control flow statements, such as ifs, and only
4296 warns when appropriate.  E.g.@:
4298 @smallexample
4299 @group
4300 switch (cond)
4301   @{
4302   case 1:
4303     if (i > 3) @{
4304       bar (5);
4305       break;
4306     @} else if (i < 1) @{
4307       bar (0);
4308     @} else
4309       return;
4310   default:
4311     @dots{}
4312   @}
4313 @end group
4314 @end smallexample
4316 Since there are occasions where a switch case fall through is desirable,
4317 GCC provides an attribute, @code{__attribute__ ((fallthrough))}, that is
4318 to be used along with a null statement to suppress this warning that
4319 would normally occur:
4321 @smallexample
4322 @group
4323 switch (cond)
4324   @{
4325   case 1:
4326     bar (0);
4327     __attribute__ ((fallthrough));
4328   default:
4329     @dots{}
4330   @}
4331 @end group
4332 @end smallexample
4334 C++17 provides a standard way to suppress the @option{-Wimplicit-fallthrough}
4335 warning using @code{[[fallthrough]];} instead of the GNU attribute.  In C++11
4336 or C++14 users can use @code{[[gnu::fallthrough]];}, which is a GNU extension.
4337 Instead of these attributes, it is also possible to add a fallthrough comment
4338 to silence the warning.  The whole body of the C or C++ style comment should
4339 match the given regular expressions listed below.  The option argument @var{n}
4340 specifies what kind of comments are accepted:
4342 @itemize @bullet
4344 @item @option{-Wimplicit-fallthrough=0} disables the warning altogether.
4346 @item @option{-Wimplicit-fallthrough=1} matches @code{.*} regular
4347 expression, any comment is used as fallthrough comment.
4349 @item @option{-Wimplicit-fallthrough=2} case insensitively matches
4350 @code{.*falls?[ \t-]*thr(ough|u).*} regular expression.
4352 @item @option{-Wimplicit-fallthrough=3} case sensitively matches one of the
4353 following regular expressions:
4355 @itemize @bullet
4357 @item @code{-fallthrough}
4359 @item @code{@@fallthrough@@}
4361 @item @code{lint -fallthrough[ \t]*}
4363 @item @code{[ \t.!]*(ELSE,? |INTENTIONAL(LY)? )?@*FALL(S | |-)?THR(OUGH|U)[ \t.!]*(-[^\n\r]*)?}
4365 @item @code{[ \t.!]*(Else,? |Intentional(ly)? )?@*Fall((s | |-)[Tt]|t)hr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4367 @item @code{[ \t.!]*([Ee]lse,? |[Ii]ntentional(ly)? )?@*fall(s | |-)?thr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4369 @end itemize
4371 @item @option{-Wimplicit-fallthrough=4} case sensitively matches one of the
4372 following regular expressions:
4374 @itemize @bullet
4376 @item @code{-fallthrough}
4378 @item @code{@@fallthrough@@}
4380 @item @code{lint -fallthrough[ \t]*}
4382 @item @code{[ \t]*FALLTHR(OUGH|U)[ \t]*}
4384 @end itemize
4386 @item @option{-Wimplicit-fallthrough=5} doesn't recognize any comments as
4387 fallthrough comments, only attributes disable the warning.
4389 @end itemize
4391 The comment needs to be followed after optional whitespace and other comments
4392 by @code{case} or @code{default} keywords or by a user label that precedes some
4393 @code{case} or @code{default} label.
4395 @smallexample
4396 @group
4397 switch (cond)
4398   @{
4399   case 1:
4400     bar (0);
4401     /* FALLTHRU */
4402   default:
4403     @dots{}
4404   @}
4405 @end group
4406 @end smallexample
4408 The @option{-Wimplicit-fallthrough=3} warning is enabled by @option{-Wextra}.
4410 @item -Wignored-qualifiers @r{(C and C++ only)}
4411 @opindex Wignored-qualifiers
4412 @opindex Wno-ignored-qualifiers
4413 Warn if the return type of a function has a type qualifier
4414 such as @code{const}.  For ISO C such a type qualifier has no effect,
4415 since the value returned by a function is not an lvalue.
4416 For C++, the warning is only emitted for scalar types or @code{void}.
4417 ISO C prohibits qualified @code{void} return types on function
4418 definitions, so such return types always receive a warning
4419 even without this option.
4421 This warning is also enabled by @option{-Wextra}.
4423 @item -Wignored-attributes @r{(C and C++ only)}
4424 @opindex Wignored-attributes
4425 @opindex Wno-ignored-attributes
4426 Warn when an attribute is ignored.  This is different from the
4427 @option{-Wattributes} option in that it warns whenever the compiler decides
4428 to drop an attribute, not that the attribute is either unknown, used in a
4429 wrong place, etc.  This warning is enabled by default.
4431 @item -Wmain
4432 @opindex Wmain
4433 @opindex Wno-main
4434 Warn if the type of @code{main} is suspicious.  @code{main} should be
4435 a function with external linkage, returning int, taking either zero
4436 arguments, two, or three arguments of appropriate types.  This warning
4437 is enabled by default in C++ and is enabled by either @option{-Wall}
4438 or @option{-Wpedantic}.
4440 @item -Wmisleading-indentation @r{(C and C++ only)}
4441 @opindex Wmisleading-indentation
4442 @opindex Wno-misleading-indentation
4443 Warn when the indentation of the code does not reflect the block structure.
4444 Specifically, a warning is issued for @code{if}, @code{else}, @code{while}, and
4445 @code{for} clauses with a guarded statement that does not use braces,
4446 followed by an unguarded statement with the same indentation.
4448 In the following example, the call to ``bar'' is misleadingly indented as
4449 if it were guarded by the ``if'' conditional.
4451 @smallexample
4452   if (some_condition ())
4453     foo ();
4454     bar ();  /* Gotcha: this is not guarded by the "if".  */
4455 @end smallexample
4457 In the case of mixed tabs and spaces, the warning uses the
4458 @option{-ftabstop=} option to determine if the statements line up
4459 (defaulting to 8).
4461 The warning is not issued for code involving multiline preprocessor logic
4462 such as the following example.
4464 @smallexample
4465   if (flagA)
4466     foo (0);
4467 #if SOME_CONDITION_THAT_DOES_NOT_HOLD
4468   if (flagB)
4469 #endif
4470     foo (1);
4471 @end smallexample
4473 The warning is not issued after a @code{#line} directive, since this
4474 typically indicates autogenerated code, and no assumptions can be made
4475 about the layout of the file that the directive references.
4477 This warning is enabled by @option{-Wall} in C and C++.
4479 @item -Wmissing-braces
4480 @opindex Wmissing-braces
4481 @opindex Wno-missing-braces
4482 Warn if an aggregate or union initializer is not fully bracketed.  In
4483 the following example, the initializer for @code{a} is not fully
4484 bracketed, but that for @code{b} is fully bracketed.  This warning is
4485 enabled by @option{-Wall} in C.
4487 @smallexample
4488 int a[2][2] = @{ 0, 1, 2, 3 @};
4489 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
4490 @end smallexample
4492 This warning is enabled by @option{-Wall}.
4494 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
4495 @opindex Wmissing-include-dirs
4496 @opindex Wno-missing-include-dirs
4497 Warn if a user-supplied include directory does not exist.
4499 @item -Wparentheses
4500 @opindex Wparentheses
4501 @opindex Wno-parentheses
4502 Warn if parentheses are omitted in certain contexts, such
4503 as when there is an assignment in a context where a truth value
4504 is expected, or when operators are nested whose precedence people
4505 often get confused about.
4507 Also warn if a comparison like @code{x<=y<=z} appears; this is
4508 equivalent to @code{(x<=y ? 1 : 0) <= z}, which is a different
4509 interpretation from that of ordinary mathematical notation.
4511 Also warn for dangerous uses of the GNU extension to
4512 @code{?:} with omitted middle operand. When the condition
4513 in the @code{?}: operator is a boolean expression, the omitted value is
4514 always 1.  Often programmers expect it to be a value computed
4515 inside the conditional expression instead.
4517 This warning is enabled by @option{-Wall}.
4519 @item -Wsequence-point
4520 @opindex Wsequence-point
4521 @opindex Wno-sequence-point
4522 Warn about code that may have undefined semantics because of violations
4523 of sequence point rules in the C and C++ standards.
4525 The C and C++ standards define the order in which expressions in a C/C++
4526 program are evaluated in terms of @dfn{sequence points}, which represent
4527 a partial ordering between the execution of parts of the program: those
4528 executed before the sequence point, and those executed after it.  These
4529 occur after the evaluation of a full expression (one which is not part
4530 of a larger expression), after the evaluation of the first operand of a
4531 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
4532 function is called (but after the evaluation of its arguments and the
4533 expression denoting the called function), and in certain other places.
4534 Other than as expressed by the sequence point rules, the order of
4535 evaluation of subexpressions of an expression is not specified.  All
4536 these rules describe only a partial order rather than a total order,
4537 since, for example, if two functions are called within one expression
4538 with no sequence point between them, the order in which the functions
4539 are called is not specified.  However, the standards committee have
4540 ruled that function calls do not overlap.
4542 It is not specified when between sequence points modifications to the
4543 values of objects take effect.  Programs whose behavior depends on this
4544 have undefined behavior; the C and C++ standards specify that ``Between
4545 the previous and next sequence point an object shall have its stored
4546 value modified at most once by the evaluation of an expression.
4547 Furthermore, the prior value shall be read only to determine the value
4548 to be stored.''.  If a program breaks these rules, the results on any
4549 particular implementation are entirely unpredictable.
4551 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
4552 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
4553 diagnosed by this option, and it may give an occasional false positive
4554 result, but in general it has been found fairly effective at detecting
4555 this sort of problem in programs.
4557 The C++17 standard will define the order of evaluation of operands in
4558 more cases: in particular it requires that the right-hand side of an
4559 assignment be evaluated before the left-hand side, so the above
4560 examples are no longer undefined.  But this warning will still warn
4561 about them, to help people avoid writing code that is undefined in C
4562 and earlier revisions of C++.
4564 The standard is worded confusingly, therefore there is some debate
4565 over the precise meaning of the sequence point rules in subtle cases.
4566 Links to discussions of the problem, including proposed formal
4567 definitions, may be found on the GCC readings page, at
4568 @uref{http://gcc.gnu.org/@/readings.html}.
4570 This warning is enabled by @option{-Wall} for C and C++.
4572 @item -Wno-return-local-addr
4573 @opindex Wno-return-local-addr
4574 @opindex Wreturn-local-addr
4575 Do not warn about returning a pointer (or in C++, a reference) to a
4576 variable that goes out of scope after the function returns.
4578 @item -Wreturn-type
4579 @opindex Wreturn-type
4580 @opindex Wno-return-type
4581 Warn whenever a function is defined with a return type that defaults
4582 to @code{int}.  Also warn about any @code{return} statement with no
4583 return value in a function whose return type is not @code{void}
4584 (falling off the end of the function body is considered returning
4585 without a value).
4587 For C only, warn about a @code{return} statement with an expression in a
4588 function whose return type is @code{void}, unless the expression type is
4589 also @code{void}.  As a GNU extension, the latter case is accepted
4590 without a warning unless @option{-Wpedantic} is used.
4592 For C++, a function without return type always produces a diagnostic
4593 message, even when @option{-Wno-return-type} is specified.  The only
4594 exceptions are @code{main} and functions defined in system headers.
4596 This warning is enabled by @option{-Wall}.
4598 @item -Wshift-count-negative
4599 @opindex Wshift-count-negative
4600 @opindex Wno-shift-count-negative
4601 Warn if shift count is negative. This warning is enabled by default.
4603 @item -Wshift-count-overflow
4604 @opindex Wshift-count-overflow
4605 @opindex Wno-shift-count-overflow
4606 Warn if shift count >= width of type. This warning is enabled by default.
4608 @item -Wshift-negative-value
4609 @opindex Wshift-negative-value
4610 @opindex Wno-shift-negative-value
4611 Warn if left shifting a negative value.  This warning is enabled by
4612 @option{-Wextra} in C99 and C++11 modes (and newer).
4614 @item -Wshift-overflow
4615 @itemx -Wshift-overflow=@var{n}
4616 @opindex Wshift-overflow
4617 @opindex Wno-shift-overflow
4618 Warn about left shift overflows.  This warning is enabled by
4619 default in C99 and C++11 modes (and newer).
4621 @table @gcctabopt
4622 @item -Wshift-overflow=1
4623 This is the warning level of @option{-Wshift-overflow} and is enabled
4624 by default in C99 and C++11 modes (and newer).  This warning level does
4625 not warn about left-shifting 1 into the sign bit.  (However, in C, such
4626 an overflow is still rejected in contexts where an integer constant expression
4627 is required.)
4629 @item -Wshift-overflow=2
4630 This warning level also warns about left-shifting 1 into the sign bit,
4631 unless C++14 mode is active.
4632 @end table
4634 @item -Wswitch
4635 @opindex Wswitch
4636 @opindex Wno-switch
4637 Warn whenever a @code{switch} statement has an index of enumerated type
4638 and lacks a @code{case} for one or more of the named codes of that
4639 enumeration.  (The presence of a @code{default} label prevents this
4640 warning.)  @code{case} labels outside the enumeration range also
4641 provoke warnings when this option is used (even if there is a
4642 @code{default} label).
4643 This warning is enabled by @option{-Wall}.
4645 @item -Wswitch-default
4646 @opindex Wswitch-default
4647 @opindex Wno-switch-default
4648 Warn whenever a @code{switch} statement does not have a @code{default}
4649 case.
4651 @item -Wswitch-enum
4652 @opindex Wswitch-enum
4653 @opindex Wno-switch-enum
4654 Warn whenever a @code{switch} statement has an index of enumerated type
4655 and lacks a @code{case} for one or more of the named codes of that
4656 enumeration.  @code{case} labels outside the enumeration range also
4657 provoke warnings when this option is used.  The only difference
4658 between @option{-Wswitch} and this option is that this option gives a
4659 warning about an omitted enumeration code even if there is a
4660 @code{default} label.
4662 @item -Wswitch-bool
4663 @opindex Wswitch-bool
4664 @opindex Wno-switch-bool
4665 Warn whenever a @code{switch} statement has an index of boolean type
4666 and the case values are outside the range of a boolean type.
4667 It is possible to suppress this warning by casting the controlling
4668 expression to a type other than @code{bool}.  For example:
4669 @smallexample
4670 @group
4671 switch ((int) (a == 4))
4672   @{
4673   @dots{}
4674   @}
4675 @end group
4676 @end smallexample
4677 This warning is enabled by default for C and C++ programs.
4679 @item -Wswitch-unreachable
4680 @opindex Wswitch-unreachable
4681 @opindex Wno-switch-unreachable
4682 Warn whenever a @code{switch} statement contains statements between the
4683 controlling expression and the first case label, which will never be
4684 executed.  For example:
4685 @smallexample
4686 @group
4687 switch (cond)
4688   @{
4689    i = 15;
4690   @dots{}
4691    case 5:
4692   @dots{}
4693   @}
4694 @end group
4695 @end smallexample
4696 @option{-Wswitch-unreachable} does not warn if the statement between the
4697 controlling expression and the first case label is just a declaration:
4698 @smallexample
4699 @group
4700 switch (cond)
4701   @{
4702    int i;
4703   @dots{}
4704    case 5:
4705    i = 5;
4706   @dots{}
4707   @}
4708 @end group
4709 @end smallexample
4710 This warning is enabled by default for C and C++ programs.
4712 @item -Wsync-nand @r{(C and C++ only)}
4713 @opindex Wsync-nand
4714 @opindex Wno-sync-nand
4715 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
4716 built-in functions are used.  These functions changed semantics in GCC 4.4.
4718 @item -Wunused-but-set-parameter
4719 @opindex Wunused-but-set-parameter
4720 @opindex Wno-unused-but-set-parameter
4721 Warn whenever a function parameter is assigned to, but otherwise unused
4722 (aside from its declaration).
4724 To suppress this warning use the @code{unused} attribute
4725 (@pxref{Variable Attributes}).
4727 This warning is also enabled by @option{-Wunused} together with
4728 @option{-Wextra}.
4730 @item -Wunused-but-set-variable
4731 @opindex Wunused-but-set-variable
4732 @opindex Wno-unused-but-set-variable
4733 Warn whenever a local variable is assigned to, but otherwise unused
4734 (aside from its declaration).
4735 This warning is enabled by @option{-Wall}.
4737 To suppress this warning use the @code{unused} attribute
4738 (@pxref{Variable Attributes}).
4740 This warning is also enabled by @option{-Wunused}, which is enabled
4741 by @option{-Wall}.
4743 @item -Wunused-function
4744 @opindex Wunused-function
4745 @opindex Wno-unused-function
4746 Warn whenever a static function is declared but not defined or a
4747 non-inline static function is unused.
4748 This warning is enabled by @option{-Wall}.
4750 @item -Wunused-label
4751 @opindex Wunused-label
4752 @opindex Wno-unused-label
4753 Warn whenever a label is declared but not used.
4754 This warning is enabled by @option{-Wall}.
4756 To suppress this warning use the @code{unused} attribute
4757 (@pxref{Variable Attributes}).
4759 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
4760 @opindex Wunused-local-typedefs
4761 Warn when a typedef locally defined in a function is not used.
4762 This warning is enabled by @option{-Wall}.
4764 @item -Wunused-parameter
4765 @opindex Wunused-parameter
4766 @opindex Wno-unused-parameter
4767 Warn whenever a function parameter is unused aside from its declaration.
4769 To suppress this warning use the @code{unused} attribute
4770 (@pxref{Variable Attributes}).
4772 @item -Wno-unused-result
4773 @opindex Wunused-result
4774 @opindex Wno-unused-result
4775 Do not warn if a caller of a function marked with attribute
4776 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
4777 its return value. The default is @option{-Wunused-result}.
4779 @item -Wunused-variable
4780 @opindex Wunused-variable
4781 @opindex Wno-unused-variable
4782 Warn whenever a local or static variable is unused aside from its
4783 declaration. This option implies @option{-Wunused-const-variable=1} for C,
4784 but not for C++. This warning is enabled by @option{-Wall}.
4786 To suppress this warning use the @code{unused} attribute
4787 (@pxref{Variable Attributes}).
4789 @item -Wunused-const-variable
4790 @itemx -Wunused-const-variable=@var{n}
4791 @opindex Wunused-const-variable
4792 @opindex Wno-unused-const-variable
4793 Warn whenever a constant static variable is unused aside from its declaration.
4794 @option{-Wunused-const-variable=1} is enabled by @option{-Wunused-variable}
4795 for C, but not for C++. In C this declares variable storage, but in C++ this
4796 is not an error since const variables take the place of @code{#define}s.
4798 To suppress this warning use the @code{unused} attribute
4799 (@pxref{Variable Attributes}).
4801 @table @gcctabopt
4802 @item -Wunused-const-variable=1
4803 This is the warning level that is enabled by @option{-Wunused-variable} for
4804 C.  It warns only about unused static const variables defined in the main
4805 compilation unit, but not about static const variables declared in any
4806 header included.
4808 @item -Wunused-const-variable=2
4809 This warning level also warns for unused constant static variables in
4810 headers (excluding system headers).  This is the warning level of
4811 @option{-Wunused-const-variable} and must be explicitly requested since
4812 in C++ this isn't an error and in C it might be harder to clean up all
4813 headers included.
4814 @end table
4816 @item -Wunused-value
4817 @opindex Wunused-value
4818 @opindex Wno-unused-value
4819 Warn whenever a statement computes a result that is explicitly not
4820 used. To suppress this warning cast the unused expression to
4821 @code{void}. This includes an expression-statement or the left-hand
4822 side of a comma expression that contains no side effects. For example,
4823 an expression such as @code{x[i,j]} causes a warning, while
4824 @code{x[(void)i,j]} does not.
4826 This warning is enabled by @option{-Wall}.
4828 @item -Wunused
4829 @opindex Wunused
4830 @opindex Wno-unused
4831 All the above @option{-Wunused} options combined.
4833 In order to get a warning about an unused function parameter, you must
4834 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
4835 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
4837 @item -Wuninitialized
4838 @opindex Wuninitialized
4839 @opindex Wno-uninitialized
4840 Warn if an automatic variable is used without first being initialized
4841 or if a variable may be clobbered by a @code{setjmp} call. In C++,
4842 warn if a non-static reference or non-static @code{const} member
4843 appears in a class without constructors.
4845 If you want to warn about code that uses the uninitialized value of the
4846 variable in its own initializer, use the @option{-Winit-self} option.
4848 These warnings occur for individual uninitialized or clobbered
4849 elements of structure, union or array variables as well as for
4850 variables that are uninitialized or clobbered as a whole.  They do
4851 not occur for variables or elements declared @code{volatile}.  Because
4852 these warnings depend on optimization, the exact variables or elements
4853 for which there are warnings depends on the precise optimization
4854 options and version of GCC used.
4856 Note that there may be no warning about a variable that is used only
4857 to compute a value that itself is never used, because such
4858 computations may be deleted by data flow analysis before the warnings
4859 are printed.
4861 @item -Winvalid-memory-model
4862 @opindex Winvalid-memory-model
4863 @opindex Wno-invalid-memory-model
4864 Warn for invocations of @ref{__atomic Builtins}, @ref{__sync Builtins},
4865 and the C11 atomic generic functions with a memory consistency argument
4866 that is either invalid for the operation or outside the range of values
4867 of the @code{memory_order} enumeration.  For example, since the
4868 @code{__atomic_store} and @code{__atomic_store_n} built-ins are only
4869 defined for the relaxed, release, and sequentially consistent memory
4870 orders the following code is diagnosed:
4872 @smallexample
4873 void store (int *i)
4875   __atomic_store_n (i, 0, memory_order_consume);
4877 @end smallexample
4879 @option{-Winvalid-memory-model} is enabled by default.
4881 @item -Wmaybe-uninitialized
4882 @opindex Wmaybe-uninitialized
4883 @opindex Wno-maybe-uninitialized
4884 For an automatic variable, if there exists a path from the function
4885 entry to a use of the variable that is initialized, but there exist
4886 some other paths for which the variable is not initialized, the compiler
4887 emits a warning if it cannot prove the uninitialized paths are not
4888 executed at run time. These warnings are made optional because GCC is
4889 not smart enough to see all the reasons why the code might be correct
4890 in spite of appearing to have an error.  Here is one example of how
4891 this can happen:
4893 @smallexample
4894 @group
4896   int x;
4897   switch (y)
4898     @{
4899     case 1: x = 1;
4900       break;
4901     case 2: x = 4;
4902       break;
4903     case 3: x = 5;
4904     @}
4905   foo (x);
4907 @end group
4908 @end smallexample
4910 @noindent
4911 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
4912 always initialized, but GCC doesn't know this. To suppress the
4913 warning, you need to provide a default case with assert(0) or
4914 similar code.
4916 @cindex @code{longjmp} warnings
4917 This option also warns when a non-volatile automatic variable might be
4918 changed by a call to @code{longjmp}.  These warnings as well are possible
4919 only in optimizing compilation.
4921 The compiler sees only the calls to @code{setjmp}.  It cannot know
4922 where @code{longjmp} will be called; in fact, a signal handler could
4923 call it at any point in the code.  As a result, you may get a warning
4924 even when there is in fact no problem because @code{longjmp} cannot
4925 in fact be called at the place that would cause a problem.
4927 Some spurious warnings can be avoided if you declare all the functions
4928 you use that never return as @code{noreturn}.  @xref{Function
4929 Attributes}.
4931 This warning is enabled by @option{-Wall} or @option{-Wextra}.
4933 @item -Wunknown-pragmas
4934 @opindex Wunknown-pragmas
4935 @opindex Wno-unknown-pragmas
4936 @cindex warning for unknown pragmas
4937 @cindex unknown pragmas, warning
4938 @cindex pragmas, warning of unknown
4939 Warn when a @code{#pragma} directive is encountered that is not understood by 
4940 GCC@.  If this command-line option is used, warnings are even issued
4941 for unknown pragmas in system header files.  This is not the case if
4942 the warnings are only enabled by the @option{-Wall} command-line option.
4944 @item -Wno-pragmas
4945 @opindex Wno-pragmas
4946 @opindex Wpragmas
4947 Do not warn about misuses of pragmas, such as incorrect parameters,
4948 invalid syntax, or conflicts between pragmas.  See also
4949 @option{-Wunknown-pragmas}.
4951 @item -Wstrict-aliasing
4952 @opindex Wstrict-aliasing
4953 @opindex Wno-strict-aliasing
4954 This option is only active when @option{-fstrict-aliasing} is active.
4955 It warns about code that might break the strict aliasing rules that the
4956 compiler is using for optimization.  The warning does not catch all
4957 cases, but does attempt to catch the more common pitfalls.  It is
4958 included in @option{-Wall}.
4959 It is equivalent to @option{-Wstrict-aliasing=3}
4961 @item -Wstrict-aliasing=n
4962 @opindex Wstrict-aliasing=n
4963 This option is only active when @option{-fstrict-aliasing} is active.
4964 It warns about code that might break the strict aliasing rules that the
4965 compiler is using for optimization.
4966 Higher levels correspond to higher accuracy (fewer false positives).
4967 Higher levels also correspond to more effort, similar to the way @option{-O} 
4968 works.
4969 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
4971 Level 1: Most aggressive, quick, least accurate.
4972 Possibly useful when higher levels
4973 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
4974 false negatives.  However, it has many false positives.
4975 Warns for all pointer conversions between possibly incompatible types,
4976 even if never dereferenced.  Runs in the front end only.
4978 Level 2: Aggressive, quick, not too precise.
4979 May still have many false positives (not as many as level 1 though),
4980 and few false negatives (but possibly more than level 1).
4981 Unlike level 1, it only warns when an address is taken.  Warns about
4982 incomplete types.  Runs in the front end only.
4984 Level 3 (default for @option{-Wstrict-aliasing}):
4985 Should have very few false positives and few false
4986 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
4987 Takes care of the common pun+dereference pattern in the front end:
4988 @code{*(int*)&some_float}.
4989 If optimization is enabled, it also runs in the back end, where it deals
4990 with multiple statement cases using flow-sensitive points-to information.
4991 Only warns when the converted pointer is dereferenced.
4992 Does not warn about incomplete types.
4994 @item -Wstrict-overflow
4995 @itemx -Wstrict-overflow=@var{n}
4996 @opindex Wstrict-overflow
4997 @opindex Wno-strict-overflow
4998 This option is only active when signed overflow is undefined.
4999 It warns about cases where the compiler optimizes based on the
5000 assumption that signed overflow does not occur.  Note that it does not
5001 warn about all cases where the code might overflow: it only warns
5002 about cases where the compiler implements some optimization.  Thus
5003 this warning depends on the optimization level.
5005 An optimization that assumes that signed overflow does not occur is
5006 perfectly safe if the values of the variables involved are such that
5007 overflow never does, in fact, occur.  Therefore this warning can
5008 easily give a false positive: a warning about code that is not
5009 actually a problem.  To help focus on important issues, several
5010 warning levels are defined.  No warnings are issued for the use of
5011 undefined signed overflow when estimating how many iterations a loop
5012 requires, in particular when determining whether a loop will be
5013 executed at all.
5015 @table @gcctabopt
5016 @item -Wstrict-overflow=1
5017 Warn about cases that are both questionable and easy to avoid.  For
5018 example the compiler simplifies
5019 @code{x + 1 > x} to @code{1}.  This level of
5020 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
5021 are not, and must be explicitly requested.
5023 @item -Wstrict-overflow=2
5024 Also warn about other cases where a comparison is simplified to a
5025 constant.  For example: @code{abs (x) >= 0}.  This can only be
5026 simplified when signed integer overflow is undefined, because
5027 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
5028 zero.  @option{-Wstrict-overflow} (with no level) is the same as
5029 @option{-Wstrict-overflow=2}.
5031 @item -Wstrict-overflow=3
5032 Also warn about other cases where a comparison is simplified.  For
5033 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
5035 @item -Wstrict-overflow=4
5036 Also warn about other simplifications not covered by the above cases.
5037 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
5039 @item -Wstrict-overflow=5
5040 Also warn about cases where the compiler reduces the magnitude of a
5041 constant involved in a comparison.  For example: @code{x + 2 > y} is
5042 simplified to @code{x + 1 >= y}.  This is reported only at the
5043 highest warning level because this simplification applies to many
5044 comparisons, so this warning level gives a very large number of
5045 false positives.
5046 @end table
5048 @item -Wstringop-overflow
5049 @itemx -Wstringop-overflow=@var{type}
5050 @opindex Wstringop-overflow
5051 @opindex Wno-stringop-overflow
5052 Warn for calls to string manipulation functions such as @code{memcpy} and
5053 @code{strcpy} that are determined to overflow the destination buffer.  The
5054 optional argument is one greater than the type of Object Size Checking to
5055 perform to determine the size of the destination.  @xref{Object Size Checking}.
5056 The argument is meaningful only for functions that operate on character arrays
5057 but not for raw memory functions like @code{memcpy} which always make use
5058 of Object Size type-0.  The option also warns for calls that specify a size
5059 in excess of the largest possible object or at most @code{SIZE_MAX / 2} bytes.
5060 The option produces the best results with optimization enabled but can detect
5061 a small subset of simple buffer overflows even without optimization in
5062 calls to the GCC built-in functions like @code{__builtin_memcpy} that
5063 correspond to the standard functions.  In any case, the option warns about
5064 just a subset of buffer overflows detected by the corresponding overflow
5065 checking built-ins.  For example, the option will issue a warning for
5066 the @code{strcpy} call below because it copies at least 5 characters
5067 (the string @code{"blue"} including the terminating NUL) into the buffer
5068 of size 4.
5070 @smallexample
5071 enum Color @{ blue, purple, yellow @};
5072 const char* f (enum Color clr)
5074   static char buf [4];
5075   const char *str;
5076   switch (clr)
5077     @{
5078       case blue: str = "blue"; break;
5079       case purple: str = "purple"; break;
5080       case yellow: str = "yellow"; break;
5081     @}
5083   return strcpy (buf, str);   // warning here
5085 @end smallexample
5087 Option @option{-Wstringop-overflow=2} is enabled by default.
5089 @table @gcctabopt
5090 @item -Wstringop-overflow
5091 @item -Wstringop-overflow=1
5092 @opindex Wstringop-overflow
5093 @opindex Wno-stringop-overflow
5094 The @option{-Wstringop-overflow=1} option uses type-zero Object Size Checking
5095 to determine the sizes of destination objects.  This is the default setting
5096 of the option.  At this setting the option will not warn for writes past
5097 the end of subobjects of larger objects accessed by pointers unless the
5098 size of the largest surrounding object is known.  When the destination may
5099 be one of several objects it is assumed to be the largest one of them.  On
5100 Linux systems, when optimization is enabled at this setting the option warns
5101 for the same code as when the @code{_FORTIFY_SOURCE} macro is defined to
5102 a non-zero value.
5104 @item -Wstringop-overflow=2
5105 The @option{-Wstringop-overflow=2} option uses type-one Object Size Checking
5106 to determine the sizes of destination objects.  At this setting the option
5107 will warn about overflows when writing to members of the largest complete
5108 objects whose exact size is known.  It will, however, not warn for excessive
5109 writes to the same members of unknown objects referenced by pointers since
5110 they may point to arrays containing unknown numbers of elements.
5112 @item -Wstringop-overflow=3
5113 The @option{-Wstringop-overflow=3} option uses type-two Object Size Checking
5114 to determine the sizes of destination objects.  At this setting the option
5115 warns about overflowing the smallest object or data member.  This is the
5116 most restrictive setting of the option that may result in warnings for safe
5117 code.
5119 @item -Wstringop-overflow=4
5120 The @option{-Wstringop-overflow=4} option uses type-three Object Size Checking
5121 to determine the sizes of destination objects.  At this setting the option
5122 will warn about overflowing any data members, and when the destination is
5123 one of several objects it uses the size of the largest of them to decide
5124 whether to issue a warning.  Similarly to @option{-Wstringop-overflow=3} this
5125 setting of the option may result in warnings for benign code.
5126 @end table
5128 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]}
5129 @opindex Wsuggest-attribute=
5130 @opindex Wno-suggest-attribute=
5131 Warn for cases where adding an attribute may be beneficial. The
5132 attributes currently supported are listed below.
5134 @table @gcctabopt
5135 @item -Wsuggest-attribute=pure
5136 @itemx -Wsuggest-attribute=const
5137 @itemx -Wsuggest-attribute=noreturn
5138 @opindex Wsuggest-attribute=pure
5139 @opindex Wno-suggest-attribute=pure
5140 @opindex Wsuggest-attribute=const
5141 @opindex Wno-suggest-attribute=const
5142 @opindex Wsuggest-attribute=noreturn
5143 @opindex Wno-suggest-attribute=noreturn
5145 Warn about functions that might be candidates for attributes
5146 @code{pure}, @code{const} or @code{noreturn}.  The compiler only warns for
5147 functions visible in other compilation units or (in the case of @code{pure} and
5148 @code{const}) if it cannot prove that the function returns normally. A function
5149 returns normally if it doesn't contain an infinite loop or return abnormally
5150 by throwing, calling @code{abort} or trapping.  This analysis requires option
5151 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
5152 higher.  Higher optimization levels improve the accuracy of the analysis.
5154 @item -Wsuggest-attribute=format
5155 @itemx -Wmissing-format-attribute
5156 @opindex Wsuggest-attribute=format
5157 @opindex Wmissing-format-attribute
5158 @opindex Wno-suggest-attribute=format
5159 @opindex Wno-missing-format-attribute
5160 @opindex Wformat
5161 @opindex Wno-format
5163 Warn about function pointers that might be candidates for @code{format}
5164 attributes.  Note these are only possible candidates, not absolute ones.
5165 GCC guesses that function pointers with @code{format} attributes that
5166 are used in assignment, initialization, parameter passing or return
5167 statements should have a corresponding @code{format} attribute in the
5168 resulting type.  I.e.@: the left-hand side of the assignment or
5169 initialization, the type of the parameter variable, or the return type
5170 of the containing function respectively should also have a @code{format}
5171 attribute to avoid the warning.
5173 GCC also warns about function definitions that might be
5174 candidates for @code{format} attributes.  Again, these are only
5175 possible candidates.  GCC guesses that @code{format} attributes
5176 might be appropriate for any function that calls a function like
5177 @code{vprintf} or @code{vscanf}, but this might not always be the
5178 case, and some functions for which @code{format} attributes are
5179 appropriate may not be detected.
5180 @end table
5182 @item -Wsuggest-final-types
5183 @opindex Wno-suggest-final-types
5184 @opindex Wsuggest-final-types
5185 Warn about types with virtual methods where code quality would be improved
5186 if the type were declared with the C++11 @code{final} specifier, 
5187 or, if possible,
5188 declared in an anonymous namespace. This allows GCC to more aggressively
5189 devirtualize the polymorphic calls. This warning is more effective with link
5190 time optimization, where the information about the class hierarchy graph is
5191 more complete.
5193 @item -Wsuggest-final-methods
5194 @opindex Wno-suggest-final-methods
5195 @opindex Wsuggest-final-methods
5196 Warn about virtual methods where code quality would be improved if the method
5197 were declared with the C++11 @code{final} specifier, 
5198 or, if possible, its type were
5199 declared in an anonymous namespace or with the @code{final} specifier.
5200 This warning is
5201 more effective with link-time optimization, where the information about the
5202 class hierarchy graph is more complete. It is recommended to first consider
5203 suggestions of @option{-Wsuggest-final-types} and then rebuild with new
5204 annotations.
5206 @item -Wsuggest-override
5207 Warn about overriding virtual functions that are not marked with the override
5208 keyword.
5210 @item -Walloc-zero
5211 @opindex Wno-alloc-zero
5212 @opindex Walloc-zero
5213 Warn about calls to allocation functions decorated with attribute
5214 @code{alloc_size} that specify zero bytes, including those to the built-in
5215 forms of the functions @code{aligned_alloc}, @code{alloca}, @code{calloc},
5216 @code{malloc}, and @code{realloc}.  Because the behavior of these functions
5217 when called with a zero size differs among implementations (and in the case
5218 of @code{realloc} has been deprecated) relying on it may result in subtle
5219 portability bugs and should be avoided.
5221 @item -Walloc-size-larger-than=@var{n}
5222 Warn about calls to functions decorated with attribute @code{alloc_size}
5223 that attempt to allocate objects larger than the specified number of bytes,
5224 or where the result of the size computation in an integer type with infinite
5225 precision would exceed @code{SIZE_MAX / 2}.  The option argument @var{n}
5226 may end in one of the standard suffixes designating a multiple of bytes
5227 such as @code{kB} and @code{KiB} for kilobyte and kibibyte, respectively,
5228 @code{MB} and @code{MiB} for megabyte and mebibyte, and so on.
5229 @xref{Function Attributes}.
5231 @item -Walloca
5232 @opindex Wno-alloca
5233 @opindex Walloca
5234 This option warns on all uses of @code{alloca} in the source.
5236 @item -Walloca-larger-than=@var{n}
5237 This option warns on calls to @code{alloca} that are not bounded by a
5238 controlling predicate limiting its argument of integer type to at most
5239 @var{n} bytes, or calls to @code{alloca} where the bound is unknown.
5240 Arguments of non-integer types are considered unbounded even if they
5241 appear to be constrained to the expected range.
5243 For example, a bounded case of @code{alloca} could be:
5245 @smallexample
5246 void func (size_t n)
5248   void *p;
5249   if (n <= 1000)
5250     p = alloca (n);
5251   else
5252     p = malloc (n);
5253   f (p);
5255 @end smallexample
5257 In the above example, passing @code{-Walloca-larger-than=1000} would not
5258 issue a warning because the call to @code{alloca} is known to be at most
5259 1000 bytes.  However, if @code{-Walloca-larger-than=500} were passed,
5260 the compiler would emit a warning.
5262 Unbounded uses, on the other hand, are uses of @code{alloca} with no
5263 controlling predicate constraining its integer argument.  For example:
5265 @smallexample
5266 void func ()
5268   void *p = alloca (n);
5269   f (p);
5271 @end smallexample
5273 If @code{-Walloca-larger-than=500} were passed, the above would trigger
5274 a warning, but this time because of the lack of bounds checking.
5276 Note, that even seemingly correct code involving signed integers could
5277 cause a warning:
5279 @smallexample
5280 void func (signed int n)
5282   if (n < 500)
5283     @{
5284       p = alloca (n);
5285       f (p);
5286     @}
5288 @end smallexample
5290 In the above example, @var{n} could be negative, causing a larger than
5291 expected argument to be implicitly cast into the @code{alloca} call.
5293 This option also warns when @code{alloca} is used in a loop.
5295 This warning is not enabled by @option{-Wall}, and is only active when
5296 @option{-ftree-vrp} is active (default for @option{-O2} and above).
5298 See also @option{-Wvla-larger-than=@var{n}}.
5300 @item -Warray-bounds
5301 @itemx -Warray-bounds=@var{n}
5302 @opindex Wno-array-bounds
5303 @opindex Warray-bounds
5304 This option is only active when @option{-ftree-vrp} is active
5305 (default for @option{-O2} and above). It warns about subscripts to arrays
5306 that are always out of bounds. This warning is enabled by @option{-Wall}.
5308 @table @gcctabopt
5309 @item -Warray-bounds=1
5310 This is the warning level of @option{-Warray-bounds} and is enabled
5311 by @option{-Wall}; higher levels are not, and must be explicitly requested.
5313 @item -Warray-bounds=2
5314 This warning level also warns about out of bounds access for
5315 arrays at the end of a struct and for arrays accessed through
5316 pointers. This warning level may give a larger number of
5317 false positives and is deactivated by default.
5318 @end table
5320 @item -Wbool-compare
5321 @opindex Wno-bool-compare
5322 @opindex Wbool-compare
5323 Warn about boolean expression compared with an integer value different from
5324 @code{true}/@code{false}.  For instance, the following comparison is
5325 always false:
5326 @smallexample
5327 int n = 5;
5328 @dots{}
5329 if ((n > 1) == 2) @{ @dots{} @}
5330 @end smallexample
5331 This warning is enabled by @option{-Wall}.
5333 @item -Wbool-operation
5334 @opindex Wno-bool-operation
5335 @opindex Wbool-operation
5336 Warn about suspicious operations on expressions of a boolean type.  For
5337 instance, bitwise negation of a boolean is very likely a bug in the program.
5338 For C, this warning also warns about incrementing or decrementing a boolean,
5339 which rarely makes sense.  (In C++, decrementing a boolean is always invalid.
5340 Incrementing a boolean is invalid in C++1z, and deprecated otherwise.)
5342 This warning is enabled by @option{-Wall}.
5344 @item -Wduplicated-branches
5345 @opindex Wno-duplicated-branches
5346 @opindex Wduplicated-branches
5347 Warn when an if-else has identical branches.  This warning detects cases like
5348 @smallexample
5349 if (p != NULL)
5350   return 0;
5351 else
5352   return 0;
5353 @end smallexample
5354 It doesn't warn when both branches contain just a null statement.  This warning
5355 also warn for conditional operators:
5356 @smallexample
5357   int i = x ? *p : *p;
5358 @end smallexample
5360 @item -Wduplicated-cond
5361 @opindex Wno-duplicated-cond
5362 @opindex Wduplicated-cond
5363 Warn about duplicated conditions in an if-else-if chain.  For instance,
5364 warn for the following code:
5365 @smallexample
5366 if (p->q != NULL) @{ @dots{} @}
5367 else if (p->q != NULL) @{ @dots{} @}
5368 @end smallexample
5370 @item -Wframe-address
5371 @opindex Wno-frame-address
5372 @opindex Wframe-address
5373 Warn when the @samp{__builtin_frame_address} or @samp{__builtin_return_address}
5374 is called with an argument greater than 0.  Such calls may return indeterminate
5375 values or crash the program.  The warning is included in @option{-Wall}.
5377 @item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
5378 @opindex Wno-discarded-qualifiers
5379 @opindex Wdiscarded-qualifiers
5380 Do not warn if type qualifiers on pointers are being discarded.
5381 Typically, the compiler warns if a @code{const char *} variable is
5382 passed to a function that takes a @code{char *} parameter.  This option
5383 can be used to suppress such a warning.
5385 @item -Wno-discarded-array-qualifiers @r{(C and Objective-C only)}
5386 @opindex Wno-discarded-array-qualifiers
5387 @opindex Wdiscarded-array-qualifiers
5388 Do not warn if type qualifiers on arrays which are pointer targets
5389 are being discarded. Typically, the compiler warns if a
5390 @code{const int (*)[]} variable is passed to a function that
5391 takes a @code{int (*)[]} parameter.  This option can be used to
5392 suppress such a warning.
5394 @item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
5395 @opindex Wno-incompatible-pointer-types
5396 @opindex Wincompatible-pointer-types
5397 Do not warn when there is a conversion between pointers that have incompatible
5398 types.  This warning is for cases not covered by @option{-Wno-pointer-sign},
5399 which warns for pointer argument passing or assignment with different
5400 signedness.
5402 @item -Wno-int-conversion @r{(C and Objective-C only)}
5403 @opindex Wno-int-conversion
5404 @opindex Wint-conversion
5405 Do not warn about incompatible integer to pointer and pointer to integer
5406 conversions.  This warning is about implicit conversions; for explicit
5407 conversions the warnings @option{-Wno-int-to-pointer-cast} and
5408 @option{-Wno-pointer-to-int-cast} may be used.
5410 @item -Wno-div-by-zero
5411 @opindex Wno-div-by-zero
5412 @opindex Wdiv-by-zero
5413 Do not warn about compile-time integer division by zero.  Floating-point
5414 division by zero is not warned about, as it can be a legitimate way of
5415 obtaining infinities and NaNs.
5417 @item -Wsystem-headers
5418 @opindex Wsystem-headers
5419 @opindex Wno-system-headers
5420 @cindex warnings from system headers
5421 @cindex system headers, warnings from
5422 Print warning messages for constructs found in system header files.
5423 Warnings from system headers are normally suppressed, on the assumption
5424 that they usually do not indicate real problems and would only make the
5425 compiler output harder to read.  Using this command-line option tells
5426 GCC to emit warnings from system headers as if they occurred in user
5427 code.  However, note that using @option{-Wall} in conjunction with this
5428 option does @emph{not} warn about unknown pragmas in system
5429 headers---for that, @option{-Wunknown-pragmas} must also be used.
5431 @item -Wtautological-compare
5432 @opindex Wtautological-compare
5433 @opindex Wno-tautological-compare
5434 Warn if a self-comparison always evaluates to true or false.  This
5435 warning detects various mistakes such as:
5436 @smallexample
5437 int i = 1;
5438 @dots{}
5439 if (i > i) @{ @dots{} @}
5440 @end smallexample
5441 This warning is enabled by @option{-Wall}.
5443 @item -Wtrampolines
5444 @opindex Wtrampolines
5445 @opindex Wno-trampolines
5446 Warn about trampolines generated for pointers to nested functions.
5447 A trampoline is a small piece of data or code that is created at run
5448 time on the stack when the address of a nested function is taken, and is
5449 used to call the nested function indirectly.  For some targets, it is
5450 made up of data only and thus requires no special treatment.  But, for
5451 most targets, it is made up of code and thus requires the stack to be
5452 made executable in order for the program to work properly.
5454 @item -Wfloat-equal
5455 @opindex Wfloat-equal
5456 @opindex Wno-float-equal
5457 Warn if floating-point values are used in equality comparisons.
5459 The idea behind this is that sometimes it is convenient (for the
5460 programmer) to consider floating-point values as approximations to
5461 infinitely precise real numbers.  If you are doing this, then you need
5462 to compute (by analyzing the code, or in some other way) the maximum or
5463 likely maximum error that the computation introduces, and allow for it
5464 when performing comparisons (and when producing output, but that's a
5465 different problem).  In particular, instead of testing for equality, you
5466 should check to see whether the two values have ranges that overlap; and
5467 this is done with the relational operators, so equality comparisons are
5468 probably mistaken.
5470 @item -Wtraditional @r{(C and Objective-C only)}
5471 @opindex Wtraditional
5472 @opindex Wno-traditional
5473 Warn about certain constructs that behave differently in traditional and
5474 ISO C@.  Also warn about ISO C constructs that have no traditional C
5475 equivalent, and/or problematic constructs that should be avoided.
5477 @itemize @bullet
5478 @item
5479 Macro parameters that appear within string literals in the macro body.
5480 In traditional C macro replacement takes place within string literals,
5481 but in ISO C it does not.
5483 @item
5484 In traditional C, some preprocessor directives did not exist.
5485 Traditional preprocessors only considered a line to be a directive
5486 if the @samp{#} appeared in column 1 on the line.  Therefore
5487 @option{-Wtraditional} warns about directives that traditional C
5488 understands but ignores because the @samp{#} does not appear as the
5489 first character on the line.  It also suggests you hide directives like
5490 @code{#pragma} not understood by traditional C by indenting them.  Some
5491 traditional implementations do not recognize @code{#elif}, so this option
5492 suggests avoiding it altogether.
5494 @item
5495 A function-like macro that appears without arguments.
5497 @item
5498 The unary plus operator.
5500 @item
5501 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
5502 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
5503 constants.)  Note, these suffixes appear in macros defined in the system
5504 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
5505 Use of these macros in user code might normally lead to spurious
5506 warnings, however GCC's integrated preprocessor has enough context to
5507 avoid warning in these cases.
5509 @item
5510 A function declared external in one block and then used after the end of
5511 the block.
5513 @item
5514 A @code{switch} statement has an operand of type @code{long}.
5516 @item
5517 A non-@code{static} function declaration follows a @code{static} one.
5518 This construct is not accepted by some traditional C compilers.
5520 @item
5521 The ISO type of an integer constant has a different width or
5522 signedness from its traditional type.  This warning is only issued if
5523 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
5524 typically represent bit patterns, are not warned about.
5526 @item
5527 Usage of ISO string concatenation is detected.
5529 @item
5530 Initialization of automatic aggregates.
5532 @item
5533 Identifier conflicts with labels.  Traditional C lacks a separate
5534 namespace for labels.
5536 @item
5537 Initialization of unions.  If the initializer is zero, the warning is
5538 omitted.  This is done under the assumption that the zero initializer in
5539 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
5540 initializer warnings and relies on default initialization to zero in the
5541 traditional C case.
5543 @item
5544 Conversions by prototypes between fixed/floating-point values and vice
5545 versa.  The absence of these prototypes when compiling with traditional
5546 C causes serious problems.  This is a subset of the possible
5547 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
5549 @item
5550 Use of ISO C style function definitions.  This warning intentionally is
5551 @emph{not} issued for prototype declarations or variadic functions
5552 because these ISO C features appear in your code when using
5553 libiberty's traditional C compatibility macros, @code{PARAMS} and
5554 @code{VPARAMS}.  This warning is also bypassed for nested functions
5555 because that feature is already a GCC extension and thus not relevant to
5556 traditional C compatibility.
5557 @end itemize
5559 @item -Wtraditional-conversion @r{(C and Objective-C only)}
5560 @opindex Wtraditional-conversion
5561 @opindex Wno-traditional-conversion
5562 Warn if a prototype causes a type conversion that is different from what
5563 would happen to the same argument in the absence of a prototype.  This
5564 includes conversions of fixed point to floating and vice versa, and
5565 conversions changing the width or signedness of a fixed-point argument
5566 except when the same as the default promotion.
5568 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
5569 @opindex Wdeclaration-after-statement
5570 @opindex Wno-declaration-after-statement
5571 Warn when a declaration is found after a statement in a block.  This
5572 construct, known from C++, was introduced with ISO C99 and is by default
5573 allowed in GCC@.  It is not supported by ISO C90.  @xref{Mixed Declarations}.
5575 @item -Wshadow
5576 @opindex Wshadow
5577 @opindex Wno-shadow
5578 Warn whenever a local variable or type declaration shadows another
5579 variable, parameter, type, class member (in C++), or instance variable
5580 (in Objective-C) or whenever a built-in function is shadowed. Note
5581 that in C++, the compiler warns if a local variable shadows an
5582 explicit typedef, but not if it shadows a struct/class/enum.
5583 Same as @option{-Wshadow=global}.
5585 @item -Wno-shadow-ivar @r{(Objective-C only)}
5586 @opindex Wno-shadow-ivar
5587 @opindex Wshadow-ivar
5588 Do not warn whenever a local variable shadows an instance variable in an
5589 Objective-C method.
5591 @item -Wshadow=global
5592 @opindex Wshadow=local
5593 The default for @option{-Wshadow}. Warns for any (global) shadowing.
5595 @item -Wshadow=local
5596 @opindex Wshadow=local
5597 Warn when a local variable shadows another local variable or parameter.
5598 This warning is enabled by @option{-Wshadow=global}.
5600 @item -Wshadow=compatible-local
5601 @opindex Wshadow=compatible-local
5602 Warn when a local variable shadows another local variable or parameter
5603 whose type is compatible with that of the shadowing variable. In C++,
5604 type compatibility here means the type of the shadowing variable can be
5605 converted to that of the shadowed variable. The creation of this flag
5606 (in addition to @option{-Wshadow=local}) is based on the idea that when
5607 a local variable shadows another one of incompatible type, it is most
5608 likely intentional, not a bug or typo, as shown in the following example:
5610 @smallexample
5611 @group
5612 for (SomeIterator i = SomeObj.begin(); i != SomeObj.end(); ++i)
5614   for (int i = 0; i < N; ++i)
5615   @{
5616     ...
5617   @}
5618   ...
5620 @end group
5621 @end smallexample
5623 Since the two variable @code{i} in the example above have incompatible types,
5624 enabling only @option{-Wshadow=compatible-local} will not emit a warning.
5625 Because their types are incompatible, if a programmer accidentally uses one
5626 in place of the other, type checking will catch that and emit an error or
5627 warning. So not warning (about shadowing) in this case will not lead to
5628 undetected bugs. Use of this flag instead of @option{-Wshadow=local} can
5629 possibly reduce the number of warnings triggered by intentional shadowing.
5631 This warning is enabled by @option{-Wshadow=local}.
5633 @item -Wlarger-than=@var{len}
5634 @opindex Wlarger-than=@var{len}
5635 @opindex Wlarger-than-@var{len}
5636 Warn whenever an object of larger than @var{len} bytes is defined.
5638 @item -Wframe-larger-than=@var{len}
5639 @opindex Wframe-larger-than
5640 Warn if the size of a function frame is larger than @var{len} bytes.
5641 The computation done to determine the stack frame size is approximate
5642 and not conservative.
5643 The actual requirements may be somewhat greater than @var{len}
5644 even if you do not get a warning.  In addition, any space allocated
5645 via @code{alloca}, variable-length arrays, or related constructs
5646 is not included by the compiler when determining
5647 whether or not to issue a warning.
5649 @item -Wno-free-nonheap-object
5650 @opindex Wno-free-nonheap-object
5651 @opindex Wfree-nonheap-object
5652 Do not warn when attempting to free an object that was not allocated
5653 on the heap.
5655 @item -Wstack-usage=@var{len}
5656 @opindex Wstack-usage
5657 Warn if the stack usage of a function might be larger than @var{len} bytes.
5658 The computation done to determine the stack usage is conservative.
5659 Any space allocated via @code{alloca}, variable-length arrays, or related
5660 constructs is included by the compiler when determining whether or not to
5661 issue a warning.
5663 The message is in keeping with the output of @option{-fstack-usage}.
5665 @itemize
5666 @item
5667 If the stack usage is fully static but exceeds the specified amount, it's:
5669 @smallexample
5670   warning: stack usage is 1120 bytes
5671 @end smallexample
5672 @item
5673 If the stack usage is (partly) dynamic but bounded, it's:
5675 @smallexample
5676   warning: stack usage might be 1648 bytes
5677 @end smallexample
5678 @item
5679 If the stack usage is (partly) dynamic and not bounded, it's:
5681 @smallexample
5682   warning: stack usage might be unbounded
5683 @end smallexample
5684 @end itemize
5686 @item -Wunsafe-loop-optimizations
5687 @opindex Wunsafe-loop-optimizations
5688 @opindex Wno-unsafe-loop-optimizations
5689 Warn if the loop cannot be optimized because the compiler cannot
5690 assume anything on the bounds of the loop indices.  With
5691 @option{-funsafe-loop-optimizations} warn if the compiler makes
5692 such assumptions.
5694 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
5695 @opindex Wno-pedantic-ms-format
5696 @opindex Wpedantic-ms-format
5697 When used in combination with @option{-Wformat}
5698 and @option{-pedantic} without GNU extensions, this option
5699 disables the warnings about non-ISO @code{printf} / @code{scanf} format
5700 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
5701 which depend on the MS runtime.
5703 @item -Waligned-new
5704 @opindex Waligned-new
5705 @opindex Wno-aligned-new
5706 Warn about a new-expression of a type that requires greater alignment
5707 than the @code{alignof(std::max_align_t)} but uses an allocation
5708 function without an explicit alignment parameter. This option is
5709 enabled by @option{-Wall}.
5711 Normally this only warns about global allocation functions, but
5712 @option{-Waligned-new=all} also warns about class member allocation
5713 functions.
5715 @item -Wplacement-new
5716 @itemx -Wplacement-new=@var{n}
5717 @opindex Wplacement-new
5718 @opindex Wno-placement-new
5719 Warn about placement new expressions with undefined behavior, such as
5720 constructing an object in a buffer that is smaller than the type of
5721 the object.  For example, the placement new expression below is diagnosed
5722 because it attempts to construct an array of 64 integers in a buffer only
5723 64 bytes large.
5724 @smallexample
5725 char buf [64];
5726 new (buf) int[64];
5727 @end smallexample
5728 This warning is enabled by default.
5730 @table @gcctabopt
5731 @item -Wplacement-new=1
5732 This is the default warning level of @option{-Wplacement-new}.  At this
5733 level the warning is not issued for some strictly undefined constructs that
5734 GCC allows as extensions for compatibility with legacy code.  For example,
5735 the following @code{new} expression is not diagnosed at this level even
5736 though it has undefined behavior according to the C++ standard because
5737 it writes past the end of the one-element array.
5738 @smallexample
5739 struct S @{ int n, a[1]; @};
5740 S *s = (S *)malloc (sizeof *s + 31 * sizeof s->a[0]);
5741 new (s->a)int [32]();
5742 @end smallexample
5744 @item -Wplacement-new=2
5745 At this level, in addition to diagnosing all the same constructs as at level
5746 1, a diagnostic is also issued for placement new expressions that construct
5747 an object in the last member of structure whose type is an array of a single
5748 element and whose size is less than the size of the object being constructed.
5749 While the previous example would be diagnosed, the following construct makes
5750 use of the flexible member array extension to avoid the warning at level 2.
5751 @smallexample
5752 struct S @{ int n, a[]; @};
5753 S *s = (S *)malloc (sizeof *s + 32 * sizeof s->a[0]);
5754 new (s->a)int [32]();
5755 @end smallexample
5757 @end table
5759 @item -Wpointer-arith
5760 @opindex Wpointer-arith
5761 @opindex Wno-pointer-arith
5762 Warn about anything that depends on the ``size of'' a function type or
5763 of @code{void}.  GNU C assigns these types a size of 1, for
5764 convenience in calculations with @code{void *} pointers and pointers
5765 to functions.  In C++, warn also when an arithmetic operation involves
5766 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
5768 @item -Wpointer-compare
5769 @opindex Wpointer-compare
5770 @opindex Wno-pointer-compare
5771 Warn if a pointer is compared with a zero character constant.  This usually
5772 means that the pointer was meant to be dereferenced.  For example:
5774 @smallexample
5775 const char *p = foo ();
5776 if (p == '\0')
5777   return 42;
5778 @end smallexample
5780 Note that the code above is invalid in C++11.
5782 This warning is enabled by default.
5784 @item -Wtype-limits
5785 @opindex Wtype-limits
5786 @opindex Wno-type-limits
5787 Warn if a comparison is always true or always false due to the limited
5788 range of the data type, but do not warn for constant expressions.  For
5789 example, warn if an unsigned variable is compared against zero with
5790 @code{<} or @code{>=}.  This warning is also enabled by
5791 @option{-Wextra}.
5793 @include cppwarnopts.texi
5795 @item -Wbad-function-cast @r{(C and Objective-C only)}
5796 @opindex Wbad-function-cast
5797 @opindex Wno-bad-function-cast
5798 Warn when a function call is cast to a non-matching type.
5799 For example, warn if a call to a function returning an integer type 
5800 is cast to a pointer type.
5802 @item -Wc90-c99-compat @r{(C and Objective-C only)}
5803 @opindex Wc90-c99-compat
5804 @opindex Wno-c90-c99-compat
5805 Warn about features not present in ISO C90, but present in ISO C99.
5806 For instance, warn about use of variable length arrays, @code{long long}
5807 type, @code{bool} type, compound literals, designated initializers, and so
5808 on.  This option is independent of the standards mode.  Warnings are disabled
5809 in the expression that follows @code{__extension__}.
5811 @item -Wc99-c11-compat @r{(C and Objective-C only)}
5812 @opindex Wc99-c11-compat
5813 @opindex Wno-c99-c11-compat
5814 Warn about features not present in ISO C99, but present in ISO C11.
5815 For instance, warn about use of anonymous structures and unions,
5816 @code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier,
5817 @code{_Alignas} specifier, @code{Alignof} operator, @code{_Generic} keyword,
5818 and so on.  This option is independent of the standards mode.  Warnings are
5819 disabled in the expression that follows @code{__extension__}.
5821 @item -Wc++-compat @r{(C and Objective-C only)}
5822 @opindex Wc++-compat
5823 Warn about ISO C constructs that are outside of the common subset of
5824 ISO C and ISO C++, e.g.@: request for implicit conversion from
5825 @code{void *} to a pointer to non-@code{void} type.
5827 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
5828 @opindex Wc++11-compat
5829 Warn about C++ constructs whose meaning differs between ISO C++ 1998
5830 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
5831 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
5832 enabled by @option{-Wall}.
5834 @item -Wc++14-compat @r{(C++ and Objective-C++ only)}
5835 @opindex Wc++14-compat
5836 Warn about C++ constructs whose meaning differs between ISO C++ 2011
5837 and ISO C++ 2014.  This warning is enabled by @option{-Wall}.
5839 @item -Wc++1z-compat @r{(C++ and Objective-C++ only)}
5840 @opindex Wc++1z-compat
5841 Warn about C++ constructs whose meaning differs between ISO C++ 2014
5842 and the forthoming ISO C++ 2017(?).  This warning is enabled by @option{-Wall}.
5844 @item -Wcast-qual
5845 @opindex Wcast-qual
5846 @opindex Wno-cast-qual
5847 Warn whenever a pointer is cast so as to remove a type qualifier from
5848 the target type.  For example, warn if a @code{const char *} is cast
5849 to an ordinary @code{char *}.
5851 Also warn when making a cast that introduces a type qualifier in an
5852 unsafe way.  For example, casting @code{char **} to @code{const char **}
5853 is unsafe, as in this example:
5855 @smallexample
5856   /* p is char ** value.  */
5857   const char **q = (const char **) p;
5858   /* Assignment of readonly string to const char * is OK.  */
5859   *q = "string";
5860   /* Now char** pointer points to read-only memory.  */
5861   **p = 'b';
5862 @end smallexample
5864 @item -Wcast-align
5865 @opindex Wcast-align
5866 @opindex Wno-cast-align
5867 Warn whenever a pointer is cast such that the required alignment of the
5868 target is increased.  For example, warn if a @code{char *} is cast to
5869 an @code{int *} on machines where integers can only be accessed at
5870 two- or four-byte boundaries.
5872 @item -Wwrite-strings
5873 @opindex Wwrite-strings
5874 @opindex Wno-write-strings
5875 When compiling C, give string constants the type @code{const
5876 char[@var{length}]} so that copying the address of one into a
5877 non-@code{const} @code{char *} pointer produces a warning.  These
5878 warnings help you find at compile time code that can try to write
5879 into a string constant, but only if you have been very careful about
5880 using @code{const} in declarations and prototypes.  Otherwise, it is
5881 just a nuisance. This is why we did not make @option{-Wall} request
5882 these warnings.
5884 When compiling C++, warn about the deprecated conversion from string
5885 literals to @code{char *}.  This warning is enabled by default for C++
5886 programs.
5888 @item -Wcatch-value
5889 @itemx -Wcatch-value=@var{n} @r{(C++ and Objective-C++ only)}
5890 @opindex Wcatch-value
5891 @opindex Wno-catch-value
5892 Warn about catch handlers that do not catch via reference.
5893 With @option{-Wcatch-value=1} (or @option{-Wcatch-value} for short)
5894 warn about polymorphic class types that are caught by value.
5895 With @option{-Wcatch-value=2} warn about all class types that are caught
5896 by value. With @option{-Wcatch-value=3} warn about all types that are
5897 not caught by reference. @option{-Wcatch-value} is enabled by @option{-Wall}.
5899 @item -Wclobbered
5900 @opindex Wclobbered
5901 @opindex Wno-clobbered
5902 Warn for variables that might be changed by @code{longjmp} or
5903 @code{vfork}.  This warning is also enabled by @option{-Wextra}.
5905 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
5906 @opindex Wconditionally-supported
5907 @opindex Wno-conditionally-supported
5908 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
5910 @item -Wconversion
5911 @opindex Wconversion
5912 @opindex Wno-conversion
5913 Warn for implicit conversions that may alter a value. This includes
5914 conversions between real and integer, like @code{abs (x)} when
5915 @code{x} is @code{double}; conversions between signed and unsigned,
5916 like @code{unsigned ui = -1}; and conversions to smaller types, like
5917 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
5918 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
5919 changed by the conversion like in @code{abs (2.0)}.  Warnings about
5920 conversions between signed and unsigned integers can be disabled by
5921 using @option{-Wno-sign-conversion}.
5923 For C++, also warn for confusing overload resolution for user-defined
5924 conversions; and conversions that never use a type conversion
5925 operator: conversions to @code{void}, the same type, a base class or a
5926 reference to them. Warnings about conversions between signed and
5927 unsigned integers are disabled by default in C++ unless
5928 @option{-Wsign-conversion} is explicitly enabled.
5930 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
5931 @opindex Wconversion-null
5932 @opindex Wno-conversion-null
5933 Do not warn for conversions between @code{NULL} and non-pointer
5934 types. @option{-Wconversion-null} is enabled by default.
5936 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
5937 @opindex Wzero-as-null-pointer-constant
5938 @opindex Wno-zero-as-null-pointer-constant
5939 Warn when a literal @samp{0} is used as null pointer constant.  This can
5940 be useful to facilitate the conversion to @code{nullptr} in C++11.
5942 @item -Wsubobject-linkage @r{(C++ and Objective-C++ only)}
5943 @opindex Wsubobject-linkage
5944 @opindex Wno-subobject-linkage
5945 Warn if a class type has a base or a field whose type uses the anonymous
5946 namespace or depends on a type with no linkage.  If a type A depends on
5947 a type B with no or internal linkage, defining it in multiple
5948 translation units would be an ODR violation because the meaning of B
5949 is different in each translation unit.  If A only appears in a single
5950 translation unit, the best way to silence the warning is to give it
5951 internal linkage by putting it in an anonymous namespace as well.  The
5952 compiler doesn't give this warning for types defined in the main .C
5953 file, as those are unlikely to have multiple definitions.
5954 @option{-Wsubobject-linkage} is enabled by default.
5956 @item -Wdangling-else
5957 @opindex Wdangling-else
5958 @opindex Wno-dangling-else
5959 Warn about constructions where there may be confusion to which
5960 @code{if} statement an @code{else} branch belongs.  Here is an example of
5961 such a case:
5963 @smallexample
5964 @group
5966   if (a)
5967     if (b)
5968       foo ();
5969   else
5970     bar ();
5972 @end group
5973 @end smallexample
5975 In C/C++, every @code{else} branch belongs to the innermost possible
5976 @code{if} statement, which in this example is @code{if (b)}.  This is
5977 often not what the programmer expected, as illustrated in the above
5978 example by indentation the programmer chose.  When there is the
5979 potential for this confusion, GCC issues a warning when this flag
5980 is specified.  To eliminate the warning, add explicit braces around
5981 the innermost @code{if} statement so there is no way the @code{else}
5982 can belong to the enclosing @code{if}.  The resulting code
5983 looks like this:
5985 @smallexample
5986 @group
5988   if (a)
5989     @{
5990       if (b)
5991         foo ();
5992       else
5993         bar ();
5994     @}
5996 @end group
5997 @end smallexample
5999 This warning is enabled by @option{-Wparentheses}.
6001 @item -Wdate-time
6002 @opindex Wdate-time
6003 @opindex Wno-date-time
6004 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
6005 are encountered as they might prevent bit-wise-identical reproducible
6006 compilations.
6008 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
6009 @opindex Wdelete-incomplete
6010 @opindex Wno-delete-incomplete
6011 Warn when deleting a pointer to incomplete type, which may cause
6012 undefined behavior at runtime.  This warning is enabled by default.
6014 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
6015 @opindex Wuseless-cast
6016 @opindex Wno-useless-cast
6017 Warn when an expression is casted to its own type.
6019 @item -Wempty-body
6020 @opindex Wempty-body
6021 @opindex Wno-empty-body
6022 Warn if an empty body occurs in an @code{if}, @code{else} or @code{do
6023 while} statement.  This warning is also enabled by @option{-Wextra}.
6025 @item -Wenum-compare
6026 @opindex Wenum-compare
6027 @opindex Wno-enum-compare
6028 Warn about a comparison between values of different enumerated types.
6029 In C++ enumerated type mismatches in conditional expressions are also
6030 diagnosed and the warning is enabled by default.  In C this warning is 
6031 enabled by @option{-Wall}.
6033 @item -Wextra-semi @r{(C++, Objective-C++ only)}
6034 @opindex Wextra-semi
6035 @opindex Wno-extra-semi
6036 Warn about redundant semicolon after in-class function definition.
6038 @item -Wjump-misses-init @r{(C, Objective-C only)}
6039 @opindex Wjump-misses-init
6040 @opindex Wno-jump-misses-init
6041 Warn if a @code{goto} statement or a @code{switch} statement jumps
6042 forward across the initialization of a variable, or jumps backward to a
6043 label after the variable has been initialized.  This only warns about
6044 variables that are initialized when they are declared.  This warning is
6045 only supported for C and Objective-C; in C++ this sort of branch is an
6046 error in any case.
6048 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
6049 can be disabled with the @option{-Wno-jump-misses-init} option.
6051 @item -Wsign-compare
6052 @opindex Wsign-compare
6053 @opindex Wno-sign-compare
6054 @cindex warning for comparison of signed and unsigned values
6055 @cindex comparison of signed and unsigned values, warning
6056 @cindex signed and unsigned values, comparison warning
6057 Warn when a comparison between signed and unsigned values could produce
6058 an incorrect result when the signed value is converted to unsigned.
6059 In C++, this warning is also enabled by @option{-Wall}.  In C, it is
6060 also enabled by @option{-Wextra}.
6062 @item -Wsign-conversion
6063 @opindex Wsign-conversion
6064 @opindex Wno-sign-conversion
6065 Warn for implicit conversions that may change the sign of an integer
6066 value, like assigning a signed integer expression to an unsigned
6067 integer variable. An explicit cast silences the warning. In C, this
6068 option is enabled also by @option{-Wconversion}.
6070 @item -Wfloat-conversion
6071 @opindex Wfloat-conversion
6072 @opindex Wno-float-conversion
6073 Warn for implicit conversions that reduce the precision of a real value.
6074 This includes conversions from real to integer, and from higher precision
6075 real to lower precision real values.  This option is also enabled by
6076 @option{-Wconversion}.
6078 @item -Wno-scalar-storage-order
6079 @opindex -Wno-scalar-storage-order
6080 @opindex -Wscalar-storage-order
6081 Do not warn on suspicious constructs involving reverse scalar storage order.
6083 @item -Wsized-deallocation @r{(C++ and Objective-C++ only)}
6084 @opindex Wsized-deallocation
6085 @opindex Wno-sized-deallocation
6086 Warn about a definition of an unsized deallocation function
6087 @smallexample
6088 void operator delete (void *) noexcept;
6089 void operator delete[] (void *) noexcept;
6090 @end smallexample
6091 without a definition of the corresponding sized deallocation function
6092 @smallexample
6093 void operator delete (void *, std::size_t) noexcept;
6094 void operator delete[] (void *, std::size_t) noexcept;
6095 @end smallexample
6096 or vice versa.  Enabled by @option{-Wextra} along with
6097 @option{-fsized-deallocation}.
6099 @item -Wsizeof-pointer-div
6100 @opindex Wsizeof-pointer-div
6101 @opindex Wno-sizeof-pointer-div
6102 Warn for suspicious divisions of two sizeof expressions that divide
6103 the pointer size by the element size, which is the usual way to compute
6104 the array size but won't work out correctly with pointers.  This warning
6105 warns e.g.@: about @code{sizeof (ptr) / sizeof (ptr[0])} if @code{ptr} is
6106 not an array, but a pointer.  This warning is enabled by @option{-Wall}.
6108 @item -Wsizeof-pointer-memaccess
6109 @opindex Wsizeof-pointer-memaccess
6110 @opindex Wno-sizeof-pointer-memaccess
6111 Warn for suspicious length parameters to certain string and memory built-in
6112 functions if the argument uses @code{sizeof}.  This warning warns e.g.@:
6113 about @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not an array,
6114 but a pointer, and suggests a possible fix, or about
6115 @code{memcpy (&foo, ptr, sizeof (&foo));}.  This warning is enabled by
6116 @option{-Wall}.
6118 @item -Wsizeof-array-argument
6119 @opindex Wsizeof-array-argument
6120 @opindex Wno-sizeof-array-argument
6121 Warn when the @code{sizeof} operator is applied to a parameter that is
6122 declared as an array in a function definition.  This warning is enabled by
6123 default for C and C++ programs.
6125 @item -Wmemset-elt-size
6126 @opindex Wmemset-elt-size
6127 @opindex Wno-memset-elt-size
6128 Warn for suspicious calls to the @code{memset} built-in function, if the
6129 first argument references an array, and the third argument is a number
6130 equal to the number of elements, but not equal to the size of the array
6131 in memory.  This indicates that the user has omitted a multiplication by
6132 the element size.  This warning is enabled by @option{-Wall}.
6134 @item -Wmemset-transposed-args
6135 @opindex Wmemset-transposed-args
6136 @opindex Wno-memset-transposed-args
6137 Warn for suspicious calls to the @code{memset} built-in function, if the
6138 second argument is not zero and the third argument is zero.  This warns e.g.@
6139 about @code{memset (buf, sizeof buf, 0)} where most probably
6140 @code{memset (buf, 0, sizeof buf)} was meant instead.  The diagnostics
6141 is only emitted if the third argument is literal zero.  If it is some
6142 expression that is folded to zero, a cast of zero to some type, etc., 
6143 it is far less likely that the user has mistakenly exchanged the arguments 
6144 and no warning is emitted.  This warning is enabled by @option{-Wall}.
6146 @item -Waddress
6147 @opindex Waddress
6148 @opindex Wno-address
6149 Warn about suspicious uses of memory addresses. These include using
6150 the address of a function in a conditional expression, such as
6151 @code{void func(void); if (func)}, and comparisons against the memory
6152 address of a string literal, such as @code{if (x == "abc")}.  Such
6153 uses typically indicate a programmer error: the address of a function
6154 always evaluates to true, so their use in a conditional usually
6155 indicate that the programmer forgot the parentheses in a function
6156 call; and comparisons against string literals result in unspecified
6157 behavior and are not portable in C, so they usually indicate that the
6158 programmer intended to use @code{strcmp}.  This warning is enabled by
6159 @option{-Wall}.
6161 @item -Wlogical-op
6162 @opindex Wlogical-op
6163 @opindex Wno-logical-op
6164 Warn about suspicious uses of logical operators in expressions.
6165 This includes using logical operators in contexts where a
6166 bit-wise operator is likely to be expected.  Also warns when
6167 the operands of a logical operator are the same:
6168 @smallexample
6169 extern int a;
6170 if (a < 0 && a < 0) @{ @dots{} @}
6171 @end smallexample
6173 @item -Wlogical-not-parentheses
6174 @opindex Wlogical-not-parentheses
6175 @opindex Wno-logical-not-parentheses
6176 Warn about logical not used on the left hand side operand of a comparison.
6177 This option does not warn if the right operand is considered to be a boolean
6178 expression.  Its purpose is to detect suspicious code like the following:
6179 @smallexample
6180 int a;
6181 @dots{}
6182 if (!a > 1) @{ @dots{} @}
6183 @end smallexample
6185 It is possible to suppress the warning by wrapping the LHS into
6186 parentheses:
6187 @smallexample
6188 if ((!a) > 1) @{ @dots{} @}
6189 @end smallexample
6191 This warning is enabled by @option{-Wall}.
6193 @item -Waggregate-return
6194 @opindex Waggregate-return
6195 @opindex Wno-aggregate-return
6196 Warn if any functions that return structures or unions are defined or
6197 called.  (In languages where you can return an array, this also elicits
6198 a warning.)
6200 @item -Wno-aggressive-loop-optimizations
6201 @opindex Wno-aggressive-loop-optimizations
6202 @opindex Waggressive-loop-optimizations
6203 Warn if in a loop with constant number of iterations the compiler detects
6204 undefined behavior in some statement during one or more of the iterations.
6206 @item -Wno-attributes
6207 @opindex Wno-attributes
6208 @opindex Wattributes
6209 Do not warn if an unexpected @code{__attribute__} is used, such as
6210 unrecognized attributes, function attributes applied to variables,
6211 etc.  This does not stop errors for incorrect use of supported
6212 attributes.
6214 @item -Wno-builtin-declaration-mismatch
6215 @opindex Wno-builtin-declaration-mismatch
6216 @opindex Wbuiltin-declaration-mismatch
6217 Warn if a built-in function is declared with the wrong signature.
6218 This warning is enabled by default.
6220 @item -Wno-builtin-macro-redefined
6221 @opindex Wno-builtin-macro-redefined
6222 @opindex Wbuiltin-macro-redefined
6223 Do not warn if certain built-in macros are redefined.  This suppresses
6224 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
6225 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
6227 @item -Wstrict-prototypes @r{(C and Objective-C only)}
6228 @opindex Wstrict-prototypes
6229 @opindex Wno-strict-prototypes
6230 Warn if a function is declared or defined without specifying the
6231 argument types.  (An old-style function definition is permitted without
6232 a warning if preceded by a declaration that specifies the argument
6233 types.)
6235 @item -Wold-style-declaration @r{(C and Objective-C only)}
6236 @opindex Wold-style-declaration
6237 @opindex Wno-old-style-declaration
6238 Warn for obsolescent usages, according to the C Standard, in a
6239 declaration. For example, warn if storage-class specifiers like
6240 @code{static} are not the first things in a declaration.  This warning
6241 is also enabled by @option{-Wextra}.
6243 @item -Wold-style-definition @r{(C and Objective-C only)}
6244 @opindex Wold-style-definition
6245 @opindex Wno-old-style-definition
6246 Warn if an old-style function definition is used.  A warning is given
6247 even if there is a previous prototype.
6249 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
6250 @opindex Wmissing-parameter-type
6251 @opindex Wno-missing-parameter-type
6252 A function parameter is declared without a type specifier in K&R-style
6253 functions:
6255 @smallexample
6256 void foo(bar) @{ @}
6257 @end smallexample
6259 This warning is also enabled by @option{-Wextra}.
6261 @item -Wmissing-prototypes @r{(C and Objective-C only)}
6262 @opindex Wmissing-prototypes
6263 @opindex Wno-missing-prototypes
6264 Warn if a global function is defined without a previous prototype
6265 declaration.  This warning is issued even if the definition itself
6266 provides a prototype.  Use this option to detect global functions
6267 that do not have a matching prototype declaration in a header file.
6268 This option is not valid for C++ because all function declarations
6269 provide prototypes and a non-matching declaration declares an
6270 overload rather than conflict with an earlier declaration.
6271 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
6273 @item -Wmissing-declarations
6274 @opindex Wmissing-declarations
6275 @opindex Wno-missing-declarations
6276 Warn if a global function is defined without a previous declaration.
6277 Do so even if the definition itself provides a prototype.
6278 Use this option to detect global functions that are not declared in
6279 header files.  In C, no warnings are issued for functions with previous
6280 non-prototype declarations; use @option{-Wmissing-prototypes} to detect
6281 missing prototypes.  In C++, no warnings are issued for function templates,
6282 or for inline functions, or for functions in anonymous namespaces.
6284 @item -Wmissing-field-initializers
6285 @opindex Wmissing-field-initializers
6286 @opindex Wno-missing-field-initializers
6287 @opindex W
6288 @opindex Wextra
6289 @opindex Wno-extra
6290 Warn if a structure's initializer has some fields missing.  For
6291 example, the following code causes such a warning, because
6292 @code{x.h} is implicitly zero:
6294 @smallexample
6295 struct s @{ int f, g, h; @};
6296 struct s x = @{ 3, 4 @};
6297 @end smallexample
6299 This option does not warn about designated initializers, so the following
6300 modification does not trigger a warning:
6302 @smallexample
6303 struct s @{ int f, g, h; @};
6304 struct s x = @{ .f = 3, .g = 4 @};
6305 @end smallexample
6307 In C this option does not warn about the universal zero initializer
6308 @samp{@{ 0 @}}:
6310 @smallexample
6311 struct s @{ int f, g, h; @};
6312 struct s x = @{ 0 @};
6313 @end smallexample
6315 Likewise, in C++ this option does not warn about the empty @{ @}
6316 initializer, for example:
6318 @smallexample
6319 struct s @{ int f, g, h; @};
6320 s x = @{ @};
6321 @end smallexample
6323 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
6324 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
6326 @item -Wno-multichar
6327 @opindex Wno-multichar
6328 @opindex Wmultichar
6329 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
6330 Usually they indicate a typo in the user's code, as they have
6331 implementation-defined values, and should not be used in portable code.
6333 @item -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]}
6334 @opindex Wnormalized=
6335 @opindex Wnormalized
6336 @opindex Wno-normalized
6337 @cindex NFC
6338 @cindex NFKC
6339 @cindex character set, input normalization
6340 In ISO C and ISO C++, two identifiers are different if they are
6341 different sequences of characters.  However, sometimes when characters
6342 outside the basic ASCII character set are used, you can have two
6343 different character sequences that look the same.  To avoid confusion,
6344 the ISO 10646 standard sets out some @dfn{normalization rules} which
6345 when applied ensure that two sequences that look the same are turned into
6346 the same sequence.  GCC can warn you if you are using identifiers that
6347 have not been normalized; this option controls that warning.
6349 There are four levels of warning supported by GCC@.  The default is
6350 @option{-Wnormalized=nfc}, which warns about any identifier that is
6351 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
6352 recommended form for most uses.  It is equivalent to
6353 @option{-Wnormalized}.
6355 Unfortunately, there are some characters allowed in identifiers by
6356 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
6357 identifiers.  That is, there's no way to use these symbols in portable
6358 ISO C or C++ and have all your identifiers in NFC@.
6359 @option{-Wnormalized=id} suppresses the warning for these characters.
6360 It is hoped that future versions of the standards involved will correct
6361 this, which is why this option is not the default.
6363 You can switch the warning off for all characters by writing
6364 @option{-Wnormalized=none} or @option{-Wno-normalized}.  You should
6365 only do this if you are using some other normalization scheme (like
6366 ``D''), because otherwise you can easily create bugs that are
6367 literally impossible to see.
6369 Some characters in ISO 10646 have distinct meanings but look identical
6370 in some fonts or display methodologies, especially once formatting has
6371 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
6372 LETTER N'', displays just like a regular @code{n} that has been
6373 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
6374 normalization scheme to convert all these into a standard form as
6375 well, and GCC warns if your code is not in NFKC if you use
6376 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
6377 about every identifier that contains the letter O because it might be
6378 confused with the digit 0, and so is not the default, but may be
6379 useful as a local coding convention if the programming environment 
6380 cannot be fixed to display these characters distinctly.
6382 @item -Wno-deprecated
6383 @opindex Wno-deprecated
6384 @opindex Wdeprecated
6385 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
6387 @item -Wno-deprecated-declarations
6388 @opindex Wno-deprecated-declarations
6389 @opindex Wdeprecated-declarations
6390 Do not warn about uses of functions (@pxref{Function Attributes}),
6391 variables (@pxref{Variable Attributes}), and types (@pxref{Type
6392 Attributes}) marked as deprecated by using the @code{deprecated}
6393 attribute.
6395 @item -Wno-overflow
6396 @opindex Wno-overflow
6397 @opindex Woverflow
6398 Do not warn about compile-time overflow in constant expressions.
6400 @item -Wno-odr
6401 @opindex Wno-odr
6402 @opindex Wodr
6403 Warn about One Definition Rule violations during link-time optimization.
6404 Requires @option{-flto-odr-type-merging} to be enabled.  Enabled by default.
6406 @item -Wopenmp-simd
6407 @opindex Wopenm-simd
6408 Warn if the vectorizer cost model overrides the OpenMP or the Cilk Plus
6409 simd directive set by user.  The @option{-fsimd-cost-model=unlimited}
6410 option can be used to relax the cost model.
6412 @item -Woverride-init @r{(C and Objective-C only)}
6413 @opindex Woverride-init
6414 @opindex Wno-override-init
6415 @opindex W
6416 @opindex Wextra
6417 @opindex Wno-extra
6418 Warn if an initialized field without side effects is overridden when
6419 using designated initializers (@pxref{Designated Inits, , Designated
6420 Initializers}).
6422 This warning is included in @option{-Wextra}.  To get other
6423 @option{-Wextra} warnings without this one, use @option{-Wextra
6424 -Wno-override-init}.
6426 @item -Woverride-init-side-effects @r{(C and Objective-C only)}
6427 @opindex Woverride-init-side-effects
6428 @opindex Wno-override-init-side-effects
6429 Warn if an initialized field with side effects is overridden when
6430 using designated initializers (@pxref{Designated Inits, , Designated
6431 Initializers}).  This warning is enabled by default.
6433 @item -Wpacked
6434 @opindex Wpacked
6435 @opindex Wno-packed
6436 Warn if a structure is given the packed attribute, but the packed
6437 attribute has no effect on the layout or size of the structure.
6438 Such structures may be mis-aligned for little benefit.  For
6439 instance, in this code, the variable @code{f.x} in @code{struct bar}
6440 is misaligned even though @code{struct bar} does not itself
6441 have the packed attribute:
6443 @smallexample
6444 @group
6445 struct foo @{
6446   int x;
6447   char a, b, c, d;
6448 @} __attribute__((packed));
6449 struct bar @{
6450   char z;
6451   struct foo f;
6453 @end group
6454 @end smallexample
6456 @item -Wpacked-bitfield-compat
6457 @opindex Wpacked-bitfield-compat
6458 @opindex Wno-packed-bitfield-compat
6459 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
6460 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
6461 the change can lead to differences in the structure layout.  GCC
6462 informs you when the offset of such a field has changed in GCC 4.4.
6463 For example there is no longer a 4-bit padding between field @code{a}
6464 and @code{b} in this structure:
6466 @smallexample
6467 struct foo
6469   char a:4;
6470   char b:8;
6471 @} __attribute__ ((packed));
6472 @end smallexample
6474 This warning is enabled by default.  Use
6475 @option{-Wno-packed-bitfield-compat} to disable this warning.
6477 @item -Wpadded
6478 @opindex Wpadded
6479 @opindex Wno-padded
6480 Warn if padding is included in a structure, either to align an element
6481 of the structure or to align the whole structure.  Sometimes when this
6482 happens it is possible to rearrange the fields of the structure to
6483 reduce the padding and so make the structure smaller.
6485 @item -Wredundant-decls
6486 @opindex Wredundant-decls
6487 @opindex Wno-redundant-decls
6488 Warn if anything is declared more than once in the same scope, even in
6489 cases where multiple declaration is valid and changes nothing.
6491 @item -Wrestrict
6492 @opindex Wrestrict
6493 @opindex Wno-restrict
6494 Warn when an argument passed to a restrict-qualified parameter
6495 aliases with another argument.
6497 @item -Wnested-externs @r{(C and Objective-C only)}
6498 @opindex Wnested-externs
6499 @opindex Wno-nested-externs
6500 Warn if an @code{extern} declaration is encountered within a function.
6502 @item -Wno-inherited-variadic-ctor
6503 @opindex Winherited-variadic-ctor
6504 @opindex Wno-inherited-variadic-ctor
6505 Suppress warnings about use of C++11 inheriting constructors when the
6506 base class inherited from has a C variadic constructor; the warning is
6507 on by default because the ellipsis is not inherited.
6509 @item -Winline
6510 @opindex Winline
6511 @opindex Wno-inline
6512 Warn if a function that is declared as inline cannot be inlined.
6513 Even with this option, the compiler does not warn about failures to
6514 inline functions declared in system headers.
6516 The compiler uses a variety of heuristics to determine whether or not
6517 to inline a function.  For example, the compiler takes into account
6518 the size of the function being inlined and the amount of inlining
6519 that has already been done in the current function.  Therefore,
6520 seemingly insignificant changes in the source program can cause the
6521 warnings produced by @option{-Winline} to appear or disappear.
6523 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
6524 @opindex Wno-invalid-offsetof
6525 @opindex Winvalid-offsetof
6526 Suppress warnings from applying the @code{offsetof} macro to a non-POD
6527 type.  According to the 2014 ISO C++ standard, applying @code{offsetof}
6528 to a non-standard-layout type is undefined.  In existing C++ implementations,
6529 however, @code{offsetof} typically gives meaningful results.
6530 This flag is for users who are aware that they are
6531 writing nonportable code and who have deliberately chosen to ignore the
6532 warning about it.
6534 The restrictions on @code{offsetof} may be relaxed in a future version
6535 of the C++ standard.
6537 @item -Wint-in-bool-context
6538 @opindex Wint-in-bool-context
6539 @opindex Wno-int-in-bool-context
6540 Warn for suspicious use of integer values where boolean values are expected,
6541 such as conditional expressions (?:) using non-boolean integer constants in
6542 boolean context, like @code{if (a <= b ? 2 : 3)}.  Or left shifting of signed
6543 integers in boolean context, like @code{for (a = 0; 1 << a; a++);}.  Likewise
6544 for all kinds of multiplications regardless of the data type.
6545 This warning is enabled by @option{-Wall}.
6547 @item -Wno-int-to-pointer-cast
6548 @opindex Wno-int-to-pointer-cast
6549 @opindex Wint-to-pointer-cast
6550 Suppress warnings from casts to pointer type of an integer of a
6551 different size. In C++, casting to a pointer type of smaller size is
6552 an error. @option{Wint-to-pointer-cast} is enabled by default.
6555 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
6556 @opindex Wno-pointer-to-int-cast
6557 @opindex Wpointer-to-int-cast
6558 Suppress warnings from casts from a pointer to an integer type of a
6559 different size.
6561 @item -Winvalid-pch
6562 @opindex Winvalid-pch
6563 @opindex Wno-invalid-pch
6564 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
6565 the search path but cannot be used.
6567 @item -Wlong-long
6568 @opindex Wlong-long
6569 @opindex Wno-long-long
6570 Warn if @code{long long} type is used.  This is enabled by either
6571 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
6572 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
6574 @item -Wvariadic-macros
6575 @opindex Wvariadic-macros
6576 @opindex Wno-variadic-macros
6577 Warn if variadic macros are used in ISO C90 mode, or if the GNU
6578 alternate syntax is used in ISO C99 mode.  This is enabled by either
6579 @option{-Wpedantic} or @option{-Wtraditional}.  To inhibit the warning
6580 messages, use @option{-Wno-variadic-macros}.
6582 @item -Wvarargs
6583 @opindex Wvarargs
6584 @opindex Wno-varargs
6585 Warn upon questionable usage of the macros used to handle variable
6586 arguments like @code{va_start}.  This is default.  To inhibit the
6587 warning messages, use @option{-Wno-varargs}.
6589 @item -Wvector-operation-performance
6590 @opindex Wvector-operation-performance
6591 @opindex Wno-vector-operation-performance
6592 Warn if vector operation is not implemented via SIMD capabilities of the
6593 architecture.  Mainly useful for the performance tuning.
6594 Vector operation can be implemented @code{piecewise}, which means that the
6595 scalar operation is performed on every vector element; 
6596 @code{in parallel}, which means that the vector operation is implemented
6597 using scalars of wider type, which normally is more performance efficient;
6598 and @code{as a single scalar}, which means that vector fits into a
6599 scalar type.
6601 @item -Wno-virtual-move-assign
6602 @opindex Wvirtual-move-assign
6603 @opindex Wno-virtual-move-assign
6604 Suppress warnings about inheriting from a virtual base with a
6605 non-trivial C++11 move assignment operator.  This is dangerous because
6606 if the virtual base is reachable along more than one path, it is
6607 moved multiple times, which can mean both objects end up in the
6608 moved-from state.  If the move assignment operator is written to avoid
6609 moving from a moved-from object, this warning can be disabled.
6611 @item -Wvla
6612 @opindex Wvla
6613 @opindex Wno-vla
6614 Warn if a variable-length array is used in the code.
6615 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
6616 the variable-length array.
6618 @item -Wvla-larger-than=@var{n}
6619 If this option is used, the compiler will warn on uses of
6620 variable-length arrays where the size is either unbounded, or bounded
6621 by an argument that can be larger than @var{n} bytes.  This is similar
6622 to how @option{-Walloca-larger-than=@var{n}} works, but with
6623 variable-length arrays.
6625 Note that GCC may optimize small variable-length arrays of a known
6626 value into plain arrays, so this warning may not get triggered for
6627 such arrays.
6629 This warning is not enabled by @option{-Wall}, and is only active when
6630 @option{-ftree-vrp} is active (default for @option{-O2} and above).
6632 See also @option{-Walloca-larger-than=@var{n}}.
6634 @item -Wvolatile-register-var
6635 @opindex Wvolatile-register-var
6636 @opindex Wno-volatile-register-var
6637 Warn if a register variable is declared volatile.  The volatile
6638 modifier does not inhibit all optimizations that may eliminate reads
6639 and/or writes to register variables.  This warning is enabled by
6640 @option{-Wall}.
6642 @item -Wdisabled-optimization
6643 @opindex Wdisabled-optimization
6644 @opindex Wno-disabled-optimization
6645 Warn if a requested optimization pass is disabled.  This warning does
6646 not generally indicate that there is anything wrong with your code; it
6647 merely indicates that GCC's optimizers are unable to handle the code
6648 effectively.  Often, the problem is that your code is too big or too
6649 complex; GCC refuses to optimize programs when the optimization
6650 itself is likely to take inordinate amounts of time.
6652 @item -Wpointer-sign @r{(C and Objective-C only)}
6653 @opindex Wpointer-sign
6654 @opindex Wno-pointer-sign
6655 Warn for pointer argument passing or assignment with different signedness.
6656 This option is only supported for C and Objective-C@.  It is implied by
6657 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
6658 @option{-Wno-pointer-sign}.
6660 @item -Wstack-protector
6661 @opindex Wstack-protector
6662 @opindex Wno-stack-protector
6663 This option is only active when @option{-fstack-protector} is active.  It
6664 warns about functions that are not protected against stack smashing.
6666 @item -Woverlength-strings
6667 @opindex Woverlength-strings
6668 @opindex Wno-overlength-strings
6669 Warn about string constants that are longer than the ``minimum
6670 maximum'' length specified in the C standard.  Modern compilers
6671 generally allow string constants that are much longer than the
6672 standard's minimum limit, but very portable programs should avoid
6673 using longer strings.
6675 The limit applies @emph{after} string constant concatenation, and does
6676 not count the trailing NUL@.  In C90, the limit was 509 characters; in
6677 C99, it was raised to 4095.  C++98 does not specify a normative
6678 minimum maximum, so we do not diagnose overlength strings in C++@.
6680 This option is implied by @option{-Wpedantic}, and can be disabled with
6681 @option{-Wno-overlength-strings}.
6683 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
6684 @opindex Wunsuffixed-float-constants
6686 Issue a warning for any floating constant that does not have
6687 a suffix.  When used together with @option{-Wsystem-headers} it
6688 warns about such constants in system header files.  This can be useful
6689 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
6690 from the decimal floating-point extension to C99.
6692 @item -Wno-designated-init @r{(C and Objective-C only)}
6693 Suppress warnings when a positional initializer is used to initialize
6694 a structure that has been marked with the @code{designated_init}
6695 attribute.
6697 @item -Whsa
6698 Issue a warning when HSAIL cannot be emitted for the compiled function or
6699 OpenMP construct.
6701 @end table
6703 @node Debugging Options
6704 @section Options for Debugging Your Program
6705 @cindex options, debugging
6706 @cindex debugging information options
6708 To tell GCC to emit extra information for use by a debugger, in almost 
6709 all cases you need only to add @option{-g} to your other options.
6711 GCC allows you to use @option{-g} with
6712 @option{-O}.  The shortcuts taken by optimized code may occasionally
6713 be surprising: some variables you declared may not exist
6714 at all; flow of control may briefly move where you did not expect it;
6715 some statements may not be executed because they compute constant
6716 results or their values are already at hand; some statements may
6717 execute in different places because they have been moved out of loops.
6718 Nevertheless it is possible to debug optimized output.  This makes
6719 it reasonable to use the optimizer for programs that might have bugs.
6721 If you are not using some other optimization option, consider
6722 using @option{-Og} (@pxref{Optimize Options}) with @option{-g}.  
6723 With no @option{-O} option at all, some compiler passes that collect
6724 information useful for debugging do not run at all, so that
6725 @option{-Og} may result in a better debugging experience.
6727 @table @gcctabopt
6728 @item -g
6729 @opindex g
6730 Produce debugging information in the operating system's native format
6731 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
6732 information.
6734 On most systems that use stabs format, @option{-g} enables use of extra
6735 debugging information that only GDB can use; this extra information
6736 makes debugging work better in GDB but probably makes other debuggers
6737 crash or
6738 refuse to read the program.  If you want to control for certain whether
6739 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
6740 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
6742 @item -ggdb
6743 @opindex ggdb
6744 Produce debugging information for use by GDB@.  This means to use the
6745 most expressive format available (DWARF, stabs, or the native format
6746 if neither of those are supported), including GDB extensions if at all
6747 possible.
6749 @item -gdwarf
6750 @itemx -gdwarf-@var{version}
6751 @opindex gdwarf
6752 Produce debugging information in DWARF format (if that is supported).
6753 The value of @var{version} may be either 2, 3, 4 or 5; the default version
6754 for most targets is 4.  DWARF Version 5 is only experimental.
6756 Note that with DWARF Version 2, some ports require and always
6757 use some non-conflicting DWARF 3 extensions in the unwind tables.
6759 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
6760 for maximum benefit.
6762 GCC no longer supports DWARF Version 1, which is substantially
6763 different than Version 2 and later.  For historical reasons, some
6764 other DWARF-related options (including @option{-feliminate-dwarf2-dups} 
6765 and @option{-fno-dwarf2-cfi-asm}) retain a reference to DWARF Version 2
6766 in their names, but apply to all currently-supported versions of DWARF.
6768 @item -gstabs
6769 @opindex gstabs
6770 Produce debugging information in stabs format (if that is supported),
6771 without GDB extensions.  This is the format used by DBX on most BSD
6772 systems.  On MIPS, Alpha and System V Release 4 systems this option
6773 produces stabs debugging output that is not understood by DBX or SDB@.
6774 On System V Release 4 systems this option requires the GNU assembler.
6776 @item -gstabs+
6777 @opindex gstabs+
6778 Produce debugging information in stabs format (if that is supported),
6779 using GNU extensions understood only by the GNU debugger (GDB)@.  The
6780 use of these extensions is likely to make other debuggers crash or
6781 refuse to read the program.
6783 @item -gcoff
6784 @opindex gcoff
6785 Produce debugging information in COFF format (if that is supported).
6786 This is the format used by SDB on most System V systems prior to
6787 System V Release 4.
6789 @item -gxcoff
6790 @opindex gxcoff
6791 Produce debugging information in XCOFF format (if that is supported).
6792 This is the format used by the DBX debugger on IBM RS/6000 systems.
6794 @item -gxcoff+
6795 @opindex gxcoff+
6796 Produce debugging information in XCOFF format (if that is supported),
6797 using GNU extensions understood only by the GNU debugger (GDB)@.  The
6798 use of these extensions is likely to make other debuggers crash or
6799 refuse to read the program, and may cause assemblers other than the GNU
6800 assembler (GAS) to fail with an error.
6802 @item -gvms
6803 @opindex gvms
6804 Produce debugging information in Alpha/VMS debug format (if that is
6805 supported).  This is the format used by DEBUG on Alpha/VMS systems.
6807 @item -g@var{level}
6808 @itemx -ggdb@var{level}
6809 @itemx -gstabs@var{level}
6810 @itemx -gcoff@var{level}
6811 @itemx -gxcoff@var{level}
6812 @itemx -gvms@var{level}
6813 Request debugging information and also use @var{level} to specify how
6814 much information.  The default level is 2.
6816 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
6817 @option{-g}.
6819 Level 1 produces minimal information, enough for making backtraces in
6820 parts of the program that you don't plan to debug.  This includes
6821 descriptions of functions and external variables, and line number
6822 tables, but no information about local variables.
6824 Level 3 includes extra information, such as all the macro definitions
6825 present in the program.  Some debuggers support macro expansion when
6826 you use @option{-g3}.
6828 @option{-gdwarf} does not accept a concatenated debug level, to avoid
6829 confusion with @option{-gdwarf-@var{level}}.
6830 Instead use an additional @option{-g@var{level}} option to change the
6831 debug level for DWARF.
6833 @item -feliminate-unused-debug-symbols
6834 @opindex feliminate-unused-debug-symbols
6835 Produce debugging information in stabs format (if that is supported),
6836 for only symbols that are actually used.
6838 @item -femit-class-debug-always
6839 @opindex femit-class-debug-always
6840 Instead of emitting debugging information for a C++ class in only one
6841 object file, emit it in all object files using the class.  This option
6842 should be used only with debuggers that are unable to handle the way GCC
6843 normally emits debugging information for classes because using this
6844 option increases the size of debugging information by as much as a
6845 factor of two.
6847 @item -fno-merge-debug-strings
6848 @opindex fmerge-debug-strings
6849 @opindex fno-merge-debug-strings
6850 Direct the linker to not merge together strings in the debugging
6851 information that are identical in different object files.  Merging is
6852 not supported by all assemblers or linkers.  Merging decreases the size
6853 of the debug information in the output file at the cost of increasing
6854 link processing time.  Merging is enabled by default.
6856 @item -fdebug-prefix-map=@var{old}=@var{new}
6857 @opindex fdebug-prefix-map
6858 When compiling files in directory @file{@var{old}}, record debugging
6859 information describing them as in @file{@var{new}} instead.
6861 @item -fvar-tracking
6862 @opindex fvar-tracking
6863 Run variable tracking pass.  It computes where variables are stored at each
6864 position in code.  Better debugging information is then generated
6865 (if the debugging information format supports this information).
6867 It is enabled by default when compiling with optimization (@option{-Os},
6868 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
6869 the debug info format supports it.
6871 @item -fvar-tracking-assignments
6872 @opindex fvar-tracking-assignments
6873 @opindex fno-var-tracking-assignments
6874 Annotate assignments to user variables early in the compilation and
6875 attempt to carry the annotations over throughout the compilation all the
6876 way to the end, in an attempt to improve debug information while
6877 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
6879 It can be enabled even if var-tracking is disabled, in which case
6880 annotations are created and maintained, but discarded at the end.
6881 By default, this flag is enabled together with @option{-fvar-tracking},
6882 except when selective scheduling is enabled.
6884 @item -gsplit-dwarf
6885 @opindex gsplit-dwarf
6886 Separate as much DWARF debugging information as possible into a
6887 separate output file with the extension @file{.dwo}.  This option allows
6888 the build system to avoid linking files with debug information.  To
6889 be useful, this option requires a debugger capable of reading @file{.dwo}
6890 files.
6892 @item -gpubnames
6893 @opindex gpubnames
6894 Generate DWARF @code{.debug_pubnames} and @code{.debug_pubtypes} sections.
6896 @item -ggnu-pubnames
6897 @opindex ggnu-pubnames
6898 Generate @code{.debug_pubnames} and @code{.debug_pubtypes} sections in a format
6899 suitable for conversion into a GDB@ index.  This option is only useful
6900 with a linker that can produce GDB@ index version 7.
6902 @item -fdebug-types-section
6903 @opindex fdebug-types-section
6904 @opindex fno-debug-types-section
6905 When using DWARF Version 4 or higher, type DIEs can be put into
6906 their own @code{.debug_types} section instead of making them part of the
6907 @code{.debug_info} section.  It is more efficient to put them in a separate
6908 comdat sections since the linker can then remove duplicates.
6909 But not all DWARF consumers support @code{.debug_types} sections yet
6910 and on some objects @code{.debug_types} produces larger instead of smaller
6911 debugging information.
6913 @item -grecord-gcc-switches
6914 @item -gno-record-gcc-switches
6915 @opindex grecord-gcc-switches
6916 @opindex gno-record-gcc-switches
6917 This switch causes the command-line options used to invoke the
6918 compiler that may affect code generation to be appended to the
6919 DW_AT_producer attribute in DWARF debugging information.  The options
6920 are concatenated with spaces separating them from each other and from
6921 the compiler version.  
6922 It is enabled by default.
6923 See also @option{-frecord-gcc-switches} for another
6924 way of storing compiler options into the object file.  
6926 @item -gstrict-dwarf
6927 @opindex gstrict-dwarf
6928 Disallow using extensions of later DWARF standard version than selected
6929 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
6930 DWARF extensions from later standard versions is allowed.
6932 @item -gno-strict-dwarf
6933 @opindex gno-strict-dwarf
6934 Allow using extensions of later DWARF standard version than selected with
6935 @option{-gdwarf-@var{version}}.
6937 @item -gcolumn-info
6938 @item -gno-column-info
6939 @opindex gcolumn-info
6940 @opindex gno-column-info
6941 Emit location column information into DWARF debugging information, rather
6942 than just file and line.
6943 This option is disabled by default.
6945 @item -gz@r{[}=@var{type}@r{]}
6946 @opindex gz
6947 Produce compressed debug sections in DWARF format, if that is supported.
6948 If @var{type} is not given, the default type depends on the capabilities
6949 of the assembler and linker used.  @var{type} may be one of
6950 @samp{none} (don't compress debug sections), @samp{zlib} (use zlib
6951 compression in ELF gABI format), or @samp{zlib-gnu} (use zlib
6952 compression in traditional GNU format).  If the linker doesn't support
6953 writing compressed debug sections, the option is rejected.  Otherwise,
6954 if the assembler does not support them, @option{-gz} is silently ignored
6955 when producing object files.
6957 @item -feliminate-dwarf2-dups
6958 @opindex feliminate-dwarf2-dups
6959 Compress DWARF debugging information by eliminating duplicated
6960 information about each symbol.  This option only makes sense when
6961 generating DWARF debugging information.
6963 @item -femit-struct-debug-baseonly
6964 @opindex femit-struct-debug-baseonly
6965 Emit debug information for struct-like types
6966 only when the base name of the compilation source file
6967 matches the base name of file in which the struct is defined.
6969 This option substantially reduces the size of debugging information,
6970 but at significant potential loss in type information to the debugger.
6971 See @option{-femit-struct-debug-reduced} for a less aggressive option.
6972 See @option{-femit-struct-debug-detailed} for more detailed control.
6974 This option works only with DWARF debug output.
6976 @item -femit-struct-debug-reduced
6977 @opindex femit-struct-debug-reduced
6978 Emit debug information for struct-like types
6979 only when the base name of the compilation source file
6980 matches the base name of file in which the type is defined,
6981 unless the struct is a template or defined in a system header.
6983 This option significantly reduces the size of debugging information,
6984 with some potential loss in type information to the debugger.
6985 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
6986 See @option{-femit-struct-debug-detailed} for more detailed control.
6988 This option works only with DWARF debug output.
6990 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
6991 @opindex femit-struct-debug-detailed
6992 Specify the struct-like types
6993 for which the compiler generates debug information.
6994 The intent is to reduce duplicate struct debug information
6995 between different object files within the same program.
6997 This option is a detailed version of
6998 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
6999 which serves for most needs.
7001 A specification has the syntax@*
7002 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
7004 The optional first word limits the specification to
7005 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
7006 A struct type is used directly when it is the type of a variable, member.
7007 Indirect uses arise through pointers to structs.
7008 That is, when use of an incomplete struct is valid, the use is indirect.
7009 An example is
7010 @samp{struct one direct; struct two * indirect;}.
7012 The optional second word limits the specification to
7013 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
7014 Generic structs are a bit complicated to explain.
7015 For C++, these are non-explicit specializations of template classes,
7016 or non-template classes within the above.
7017 Other programming languages have generics,
7018 but @option{-femit-struct-debug-detailed} does not yet implement them.
7020 The third word specifies the source files for those
7021 structs for which the compiler should emit debug information.
7022 The values @samp{none} and @samp{any} have the normal meaning.
7023 The value @samp{base} means that
7024 the base of name of the file in which the type declaration appears
7025 must match the base of the name of the main compilation file.
7026 In practice, this means that when compiling @file{foo.c}, debug information
7027 is generated for types declared in that file and @file{foo.h},
7028 but not other header files.
7029 The value @samp{sys} means those types satisfying @samp{base}
7030 or declared in system or compiler headers.
7032 You may need to experiment to determine the best settings for your application.
7034 The default is @option{-femit-struct-debug-detailed=all}.
7036 This option works only with DWARF debug output.
7038 @item -fno-dwarf2-cfi-asm
7039 @opindex fdwarf2-cfi-asm
7040 @opindex fno-dwarf2-cfi-asm
7041 Emit DWARF unwind info as compiler generated @code{.eh_frame} section
7042 instead of using GAS @code{.cfi_*} directives.
7044 @item -fno-eliminate-unused-debug-types
7045 @opindex feliminate-unused-debug-types
7046 @opindex fno-eliminate-unused-debug-types
7047 Normally, when producing DWARF output, GCC avoids producing debug symbol 
7048 output for types that are nowhere used in the source file being compiled.
7049 Sometimes it is useful to have GCC emit debugging
7050 information for all types declared in a compilation
7051 unit, regardless of whether or not they are actually used
7052 in that compilation unit, for example 
7053 if, in the debugger, you want to cast a value to a type that is
7054 not actually used in your program (but is declared).  More often,
7055 however, this results in a significant amount of wasted space.
7056 @end table
7058 @node Optimize Options
7059 @section Options That Control Optimization
7060 @cindex optimize options
7061 @cindex options, optimization
7063 These options control various sorts of optimizations.
7065 Without any optimization option, the compiler's goal is to reduce the
7066 cost of compilation and to make debugging produce the expected
7067 results.  Statements are independent: if you stop the program with a
7068 breakpoint between statements, you can then assign a new value to any
7069 variable or change the program counter to any other statement in the
7070 function and get exactly the results you expect from the source
7071 code.
7073 Turning on optimization flags makes the compiler attempt to improve
7074 the performance and/or code size at the expense of compilation time
7075 and possibly the ability to debug the program.
7077 The compiler performs optimization based on the knowledge it has of the
7078 program.  Compiling multiple files at once to a single output file mode allows
7079 the compiler to use information gained from all of the files when compiling
7080 each of them.
7082 Not all optimizations are controlled directly by a flag.  Only
7083 optimizations that have a flag are listed in this section.
7085 Most optimizations are only enabled if an @option{-O} level is set on
7086 the command line.  Otherwise they are disabled, even if individual
7087 optimization flags are specified.
7089 Depending on the target and how GCC was configured, a slightly different
7090 set of optimizations may be enabled at each @option{-O} level than
7091 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
7092 to find out the exact set of optimizations that are enabled at each level.
7093 @xref{Overall Options}, for examples.
7095 @table @gcctabopt
7096 @item -O
7097 @itemx -O1
7098 @opindex O
7099 @opindex O1
7100 Optimize.  Optimizing compilation takes somewhat more time, and a lot
7101 more memory for a large function.
7103 With @option{-O}, the compiler tries to reduce code size and execution
7104 time, without performing any optimizations that take a great deal of
7105 compilation time.
7107 @option{-O} turns on the following optimization flags:
7108 @gccoptlist{
7109 -fauto-inc-dec @gol
7110 -fbranch-count-reg @gol
7111 -fcombine-stack-adjustments @gol
7112 -fcompare-elim @gol
7113 -fcprop-registers @gol
7114 -fdce @gol
7115 -fdefer-pop @gol
7116 -fdelayed-branch @gol
7117 -fdse @gol
7118 -fforward-propagate @gol
7119 -fguess-branch-probability @gol
7120 -fif-conversion2 @gol
7121 -fif-conversion @gol
7122 -finline-functions-called-once @gol
7123 -fipa-pure-const @gol
7124 -fipa-profile @gol
7125 -fipa-reference @gol
7126 -fmerge-constants @gol
7127 -fmove-loop-invariants @gol
7128 -freorder-blocks @gol
7129 -fshrink-wrap @gol
7130 -fshrink-wrap-separate @gol
7131 -fsplit-wide-types @gol
7132 -fssa-backprop @gol
7133 -fssa-phiopt @gol
7134 -ftree-bit-ccp @gol
7135 -ftree-ccp @gol
7136 -ftree-ch @gol
7137 -ftree-coalesce-vars @gol
7138 -ftree-copy-prop @gol
7139 -ftree-dce @gol
7140 -ftree-dominator-opts @gol
7141 -ftree-dse @gol
7142 -ftree-forwprop @gol
7143 -ftree-fre @gol
7144 -ftree-phiprop @gol
7145 -ftree-sink @gol
7146 -ftree-slsr @gol
7147 -ftree-sra @gol
7148 -ftree-pta @gol
7149 -ftree-ter @gol
7150 -funit-at-a-time}
7152 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
7153 where doing so does not interfere with debugging.
7155 @item -O2
7156 @opindex O2
7157 Optimize even more.  GCC performs nearly all supported optimizations
7158 that do not involve a space-speed tradeoff.
7159 As compared to @option{-O}, this option increases both compilation time
7160 and the performance of the generated code.
7162 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
7163 also turns on the following optimization flags:
7164 @gccoptlist{-fthread-jumps @gol
7165 -falign-functions  -falign-jumps @gol
7166 -falign-loops  -falign-labels @gol
7167 -fcaller-saves @gol
7168 -fcrossjumping @gol
7169 -fcse-follow-jumps  -fcse-skip-blocks @gol
7170 -fdelete-null-pointer-checks @gol
7171 -fdevirtualize -fdevirtualize-speculatively @gol
7172 -fexpensive-optimizations @gol
7173 -fgcse  -fgcse-lm  @gol
7174 -fhoist-adjacent-loads @gol
7175 -finline-small-functions @gol
7176 -findirect-inlining @gol
7177 -fipa-cp @gol
7178 -fipa-bit-cp @gol
7179 -fipa-vrp @gol
7180 -fipa-sra @gol
7181 -fipa-icf @gol
7182 -fisolate-erroneous-paths-dereference @gol
7183 -flra-remat @gol
7184 -foptimize-sibling-calls @gol
7185 -foptimize-strlen @gol
7186 -fpartial-inlining @gol
7187 -fpeephole2 @gol
7188 -freorder-blocks-algorithm=stc @gol
7189 -freorder-blocks-and-partition -freorder-functions @gol
7190 -frerun-cse-after-loop  @gol
7191 -fsched-interblock  -fsched-spec @gol
7192 -fschedule-insns  -fschedule-insns2 @gol
7193 -fstore-merging @gol
7194 -fstrict-aliasing @gol
7195 -ftree-builtin-call-dce @gol
7196 -ftree-switch-conversion -ftree-tail-merge @gol
7197 -fcode-hoisting @gol
7198 -ftree-pre @gol
7199 -ftree-vrp @gol
7200 -fipa-ra}
7202 Please note the warning under @option{-fgcse} about
7203 invoking @option{-O2} on programs that use computed gotos.
7205 @item -O3
7206 @opindex O3
7207 Optimize yet more.  @option{-O3} turns on all optimizations specified
7208 by @option{-O2} and also turns on the @option{-finline-functions},
7209 @option{-funswitch-loops}, @option{-fpredictive-commoning},
7210 @option{-fgcse-after-reload}, @option{-ftree-loop-vectorize},
7211 @option{-ftree-loop-distribute-patterns}, @option{-fsplit-paths}
7212 @option{-ftree-slp-vectorize}, @option{-fvect-cost-model},
7213 @option{-ftree-partial-pre}, @option{-fpeel-loops}
7214 and @option{-fipa-cp-clone} options.
7216 @item -O0
7217 @opindex O0
7218 Reduce compilation time and make debugging produce the expected
7219 results.  This is the default.
7221 @item -Os
7222 @opindex Os
7223 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
7224 do not typically increase code size.  It also performs further
7225 optimizations designed to reduce code size.
7227 @option{-Os} disables the following optimization flags:
7228 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
7229 -falign-labels  -freorder-blocks  -freorder-blocks-algorithm=stc @gol
7230 -freorder-blocks-and-partition  -fprefetch-loop-arrays}
7232 @item -Ofast
7233 @opindex Ofast
7234 Disregard strict standards compliance.  @option{-Ofast} enables all
7235 @option{-O3} optimizations.  It also enables optimizations that are not
7236 valid for all standard-compliant programs.
7237 It turns on @option{-ffast-math} and the Fortran-specific
7238 @option{-fno-protect-parens} and @option{-fstack-arrays}.
7240 @item -Og
7241 @opindex Og
7242 Optimize debugging experience.  @option{-Og} enables optimizations
7243 that do not interfere with debugging. It should be the optimization
7244 level of choice for the standard edit-compile-debug cycle, offering
7245 a reasonable level of optimization while maintaining fast compilation
7246 and a good debugging experience.
7247 @end table
7249 If you use multiple @option{-O} options, with or without level numbers,
7250 the last such option is the one that is effective.
7252 Options of the form @option{-f@var{flag}} specify machine-independent
7253 flags.  Most flags have both positive and negative forms; the negative
7254 form of @option{-ffoo} is @option{-fno-foo}.  In the table
7255 below, only one of the forms is listed---the one you typically 
7256 use.  You can figure out the other form by either removing @samp{no-}
7257 or adding it.
7259 The following options control specific optimizations.  They are either
7260 activated by @option{-O} options or are related to ones that are.  You
7261 can use the following flags in the rare cases when ``fine-tuning'' of
7262 optimizations to be performed is desired.
7264 @table @gcctabopt
7265 @item -fno-defer-pop
7266 @opindex fno-defer-pop
7267 Always pop the arguments to each function call as soon as that function
7268 returns.  For machines that must pop arguments after a function call,
7269 the compiler normally lets arguments accumulate on the stack for several
7270 function calls and pops them all at once.
7272 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7274 @item -fforward-propagate
7275 @opindex fforward-propagate
7276 Perform a forward propagation pass on RTL@.  The pass tries to combine two
7277 instructions and checks if the result can be simplified.  If loop unrolling
7278 is active, two passes are performed and the second is scheduled after
7279 loop unrolling.
7281 This option is enabled by default at optimization levels @option{-O},
7282 @option{-O2}, @option{-O3}, @option{-Os}.
7284 @item -ffp-contract=@var{style}
7285 @opindex ffp-contract
7286 @option{-ffp-contract=off} disables floating-point expression contraction.
7287 @option{-ffp-contract=fast} enables floating-point expression contraction
7288 such as forming of fused multiply-add operations if the target has
7289 native support for them.
7290 @option{-ffp-contract=on} enables floating-point expression contraction
7291 if allowed by the language standard.  This is currently not implemented
7292 and treated equal to @option{-ffp-contract=off}.
7294 The default is @option{-ffp-contract=fast}.
7296 @item -fomit-frame-pointer
7297 @opindex fomit-frame-pointer
7298 Don't keep the frame pointer in a register for functions that
7299 don't need one.  This avoids the instructions to save, set up and
7300 restore frame pointers; it also makes an extra register available
7301 in many functions.  @strong{It also makes debugging impossible on
7302 some machines.}
7304 On some machines, such as the VAX, this flag has no effect, because
7305 the standard calling sequence automatically handles the frame pointer
7306 and nothing is saved by pretending it doesn't exist.  The
7307 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
7308 whether a target machine supports this flag.  @xref{Registers,,Register
7309 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
7311 The default setting (when not optimizing for
7312 size) for 32-bit GNU/Linux x86 and 32-bit Darwin x86 targets is
7313 @option{-fomit-frame-pointer}.  You can configure GCC with the
7314 @option{--enable-frame-pointer} configure option to change the default.
7316 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7318 @item -foptimize-sibling-calls
7319 @opindex foptimize-sibling-calls
7320 Optimize sibling and tail recursive calls.
7322 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7324 @item -foptimize-strlen
7325 @opindex foptimize-strlen
7326 Optimize various standard C string functions (e.g. @code{strlen},
7327 @code{strchr} or @code{strcpy}) and
7328 their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
7330 Enabled at levels @option{-O2}, @option{-O3}.
7332 @item -fno-inline
7333 @opindex fno-inline
7334 Do not expand any functions inline apart from those marked with
7335 the @code{always_inline} attribute.  This is the default when not
7336 optimizing.
7338 Single functions can be exempted from inlining by marking them
7339 with the @code{noinline} attribute.
7341 @item -finline-small-functions
7342 @opindex finline-small-functions
7343 Integrate functions into their callers when their body is smaller than expected
7344 function call code (so overall size of program gets smaller).  The compiler
7345 heuristically decides which functions are simple enough to be worth integrating
7346 in this way.  This inlining applies to all functions, even those not declared
7347 inline.
7349 Enabled at level @option{-O2}.
7351 @item -findirect-inlining
7352 @opindex findirect-inlining
7353 Inline also indirect calls that are discovered to be known at compile
7354 time thanks to previous inlining.  This option has any effect only
7355 when inlining itself is turned on by the @option{-finline-functions}
7356 or @option{-finline-small-functions} options.
7358 Enabled at level @option{-O2}.
7360 @item -finline-functions
7361 @opindex finline-functions
7362 Consider all functions for inlining, even if they are not declared inline.
7363 The compiler heuristically decides which functions are worth integrating
7364 in this way.
7366 If all calls to a given function are integrated, and the function is
7367 declared @code{static}, then the function is normally not output as
7368 assembler code in its own right.
7370 Enabled at level @option{-O3}.
7372 @item -finline-functions-called-once
7373 @opindex finline-functions-called-once
7374 Consider all @code{static} functions called once for inlining into their
7375 caller even if they are not marked @code{inline}.  If a call to a given
7376 function is integrated, then the function is not output as assembler code
7377 in its own right.
7379 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
7381 @item -fearly-inlining
7382 @opindex fearly-inlining
7383 Inline functions marked by @code{always_inline} and functions whose body seems
7384 smaller than the function call overhead early before doing
7385 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
7386 makes profiling significantly cheaper and usually inlining faster on programs
7387 having large chains of nested wrapper functions.
7389 Enabled by default.
7391 @item -fipa-sra
7392 @opindex fipa-sra
7393 Perform interprocedural scalar replacement of aggregates, removal of
7394 unused parameters and replacement of parameters passed by reference
7395 by parameters passed by value.
7397 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
7399 @item -finline-limit=@var{n}
7400 @opindex finline-limit
7401 By default, GCC limits the size of functions that can be inlined.  This flag
7402 allows coarse control of this limit.  @var{n} is the size of functions that
7403 can be inlined in number of pseudo instructions.
7405 Inlining is actually controlled by a number of parameters, which may be
7406 specified individually by using @option{--param @var{name}=@var{value}}.
7407 The @option{-finline-limit=@var{n}} option sets some of these parameters
7408 as follows:
7410 @table @gcctabopt
7411 @item max-inline-insns-single
7412 is set to @var{n}/2.
7413 @item max-inline-insns-auto
7414 is set to @var{n}/2.
7415 @end table
7417 See below for a documentation of the individual
7418 parameters controlling inlining and for the defaults of these parameters.
7420 @emph{Note:} there may be no value to @option{-finline-limit} that results
7421 in default behavior.
7423 @emph{Note:} pseudo instruction represents, in this particular context, an
7424 abstract measurement of function's size.  In no way does it represent a count
7425 of assembly instructions and as such its exact meaning might change from one
7426 release to an another.
7428 @item -fno-keep-inline-dllexport
7429 @opindex fno-keep-inline-dllexport
7430 This is a more fine-grained version of @option{-fkeep-inline-functions},
7431 which applies only to functions that are declared using the @code{dllexport}
7432 attribute or declspec.  @xref{Function Attributes,,Declaring Attributes of
7433 Functions}.
7435 @item -fkeep-inline-functions
7436 @opindex fkeep-inline-functions
7437 In C, emit @code{static} functions that are declared @code{inline}
7438 into the object file, even if the function has been inlined into all
7439 of its callers.  This switch does not affect functions using the
7440 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
7441 inline functions into the object file.
7443 @item -fkeep-static-functions
7444 @opindex fkeep-static-functions
7445 Emit @code{static} functions into the object file, even if the function
7446 is never used.
7448 @item -fkeep-static-consts
7449 @opindex fkeep-static-consts
7450 Emit variables declared @code{static const} when optimization isn't turned
7451 on, even if the variables aren't referenced.
7453 GCC enables this option by default.  If you want to force the compiler to
7454 check if a variable is referenced, regardless of whether or not
7455 optimization is turned on, use the @option{-fno-keep-static-consts} option.
7457 @item -fmerge-constants
7458 @opindex fmerge-constants
7459 Attempt to merge identical constants (string constants and floating-point
7460 constants) across compilation units.
7462 This option is the default for optimized compilation if the assembler and
7463 linker support it.  Use @option{-fno-merge-constants} to inhibit this
7464 behavior.
7466 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7468 @item -fmerge-all-constants
7469 @opindex fmerge-all-constants
7470 Attempt to merge identical constants and identical variables.
7472 This option implies @option{-fmerge-constants}.  In addition to
7473 @option{-fmerge-constants} this considers e.g.@: even constant initialized
7474 arrays or initialized constant variables with integral or floating-point
7475 types.  Languages like C or C++ require each variable, including multiple
7476 instances of the same variable in recursive calls, to have distinct locations,
7477 so using this option results in non-conforming
7478 behavior.
7480 @item -fmodulo-sched
7481 @opindex fmodulo-sched
7482 Perform swing modulo scheduling immediately before the first scheduling
7483 pass.  This pass looks at innermost loops and reorders their
7484 instructions by overlapping different iterations.
7486 @item -fmodulo-sched-allow-regmoves
7487 @opindex fmodulo-sched-allow-regmoves
7488 Perform more aggressive SMS-based modulo scheduling with register moves
7489 allowed.  By setting this flag certain anti-dependences edges are
7490 deleted, which triggers the generation of reg-moves based on the
7491 life-range analysis.  This option is effective only with
7492 @option{-fmodulo-sched} enabled.
7494 @item -fno-branch-count-reg
7495 @opindex fno-branch-count-reg
7496 Avoid running a pass scanning for opportunities to use ``decrement and
7497 branch'' instructions on a count register instead of generating sequences
7498 of instructions that decrement a register, compare it against zero, and
7499 then branch based upon the result.  This option is only meaningful on
7500 architectures that support such instructions, which include x86, PowerPC,
7501 IA-64 and S/390.  Note that the @option{-fno-branch-count-reg} option
7502 doesn't remove the decrement and branch instructions from the generated
7503 instruction stream introduced by other optimization passes.
7505 Enabled by default at @option{-O1} and higher.
7507 The default is @option{-fbranch-count-reg}.
7509 @item -fno-function-cse
7510 @opindex fno-function-cse
7511 Do not put function addresses in registers; make each instruction that
7512 calls a constant function contain the function's address explicitly.
7514 This option results in less efficient code, but some strange hacks
7515 that alter the assembler output may be confused by the optimizations
7516 performed when this option is not used.
7518 The default is @option{-ffunction-cse}
7520 @item -fno-zero-initialized-in-bss
7521 @opindex fno-zero-initialized-in-bss
7522 If the target supports a BSS section, GCC by default puts variables that
7523 are initialized to zero into BSS@.  This can save space in the resulting
7524 code.
7526 This option turns off this behavior because some programs explicitly
7527 rely on variables going to the data section---e.g., so that the
7528 resulting executable can find the beginning of that section and/or make
7529 assumptions based on that.
7531 The default is @option{-fzero-initialized-in-bss}.
7533 @item -fthread-jumps
7534 @opindex fthread-jumps
7535 Perform optimizations that check to see if a jump branches to a
7536 location where another comparison subsumed by the first is found.  If
7537 so, the first branch is redirected to either the destination of the
7538 second branch or a point immediately following it, depending on whether
7539 the condition is known to be true or false.
7541 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7543 @item -fsplit-wide-types
7544 @opindex fsplit-wide-types
7545 When using a type that occupies multiple registers, such as @code{long
7546 long} on a 32-bit system, split the registers apart and allocate them
7547 independently.  This normally generates better code for those types,
7548 but may make debugging more difficult.
7550 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
7551 @option{-Os}.
7553 @item -fcse-follow-jumps
7554 @opindex fcse-follow-jumps
7555 In common subexpression elimination (CSE), scan through jump instructions
7556 when the target of the jump is not reached by any other path.  For
7557 example, when CSE encounters an @code{if} statement with an
7558 @code{else} clause, CSE follows the jump when the condition
7559 tested is false.
7561 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7563 @item -fcse-skip-blocks
7564 @opindex fcse-skip-blocks
7565 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
7566 follow jumps that conditionally skip over blocks.  When CSE
7567 encounters a simple @code{if} statement with no else clause,
7568 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
7569 body of the @code{if}.
7571 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7573 @item -frerun-cse-after-loop
7574 @opindex frerun-cse-after-loop
7575 Re-run common subexpression elimination after loop optimizations are
7576 performed.
7578 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7580 @item -fgcse
7581 @opindex fgcse
7582 Perform a global common subexpression elimination pass.
7583 This pass also performs global constant and copy propagation.
7585 @emph{Note:} When compiling a program using computed gotos, a GCC
7586 extension, you may get better run-time performance if you disable
7587 the global common subexpression elimination pass by adding
7588 @option{-fno-gcse} to the command line.
7590 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7592 @item -fgcse-lm
7593 @opindex fgcse-lm
7594 When @option{-fgcse-lm} is enabled, global common subexpression elimination
7595 attempts to move loads that are only killed by stores into themselves.  This
7596 allows a loop containing a load/store sequence to be changed to a load outside
7597 the loop, and a copy/store within the loop.
7599 Enabled by default when @option{-fgcse} is enabled.
7601 @item -fgcse-sm
7602 @opindex fgcse-sm
7603 When @option{-fgcse-sm} is enabled, a store motion pass is run after
7604 global common subexpression elimination.  This pass attempts to move
7605 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
7606 loops containing a load/store sequence can be changed to a load before
7607 the loop and a store after the loop.
7609 Not enabled at any optimization level.
7611 @item -fgcse-las
7612 @opindex fgcse-las
7613 When @option{-fgcse-las} is enabled, the global common subexpression
7614 elimination pass eliminates redundant loads that come after stores to the
7615 same memory location (both partial and full redundancies).
7617 Not enabled at any optimization level.
7619 @item -fgcse-after-reload
7620 @opindex fgcse-after-reload
7621 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
7622 pass is performed after reload.  The purpose of this pass is to clean up
7623 redundant spilling.
7625 @item -faggressive-loop-optimizations
7626 @opindex faggressive-loop-optimizations
7627 This option tells the loop optimizer to use language constraints to
7628 derive bounds for the number of iterations of a loop.  This assumes that
7629 loop code does not invoke undefined behavior by for example causing signed
7630 integer overflows or out-of-bound array accesses.  The bounds for the
7631 number of iterations of a loop are used to guide loop unrolling and peeling
7632 and loop exit test optimizations.
7633 This option is enabled by default.
7635 @item -funconstrained-commons
7636 @opindex funconstrained-commons
7637 This option tells the compiler that variables declared in common blocks
7638 (e.g. Fortran) may later be overridden with longer trailing arrays. This
7639 prevents certain optimizations that depend on knowing the array bounds.
7641 @item -fcrossjumping
7642 @opindex fcrossjumping
7643 Perform cross-jumping transformation.
7644 This transformation unifies equivalent code and saves code size.  The
7645 resulting code may or may not perform better than without cross-jumping.
7647 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7649 @item -fauto-inc-dec
7650 @opindex fauto-inc-dec
7651 Combine increments or decrements of addresses with memory accesses.
7652 This pass is always skipped on architectures that do not have
7653 instructions to support this.  Enabled by default at @option{-O} and
7654 higher on architectures that support this.
7656 @item -fdce
7657 @opindex fdce
7658 Perform dead code elimination (DCE) on RTL@.
7659 Enabled by default at @option{-O} and higher.
7661 @item -fdse
7662 @opindex fdse
7663 Perform dead store elimination (DSE) on RTL@.
7664 Enabled by default at @option{-O} and higher.
7666 @item -fif-conversion
7667 @opindex fif-conversion
7668 Attempt to transform conditional jumps into branch-less equivalents.  This
7669 includes use of conditional moves, min, max, set flags and abs instructions, and
7670 some tricks doable by standard arithmetics.  The use of conditional execution
7671 on chips where it is available is controlled by @option{-fif-conversion2}.
7673 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7675 @item -fif-conversion2
7676 @opindex fif-conversion2
7677 Use conditional execution (where available) to transform conditional jumps into
7678 branch-less equivalents.
7680 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7682 @item -fdeclone-ctor-dtor
7683 @opindex fdeclone-ctor-dtor
7684 The C++ ABI requires multiple entry points for constructors and
7685 destructors: one for a base subobject, one for a complete object, and
7686 one for a virtual destructor that calls operator delete afterwards.
7687 For a hierarchy with virtual bases, the base and complete variants are
7688 clones, which means two copies of the function.  With this option, the
7689 base and complete variants are changed to be thunks that call a common
7690 implementation.
7692 Enabled by @option{-Os}.
7694 @item -fdelete-null-pointer-checks
7695 @opindex fdelete-null-pointer-checks
7696 Assume that programs cannot safely dereference null pointers, and that
7697 no code or data element resides at address zero.
7698 This option enables simple constant
7699 folding optimizations at all optimization levels.  In addition, other
7700 optimization passes in GCC use this flag to control global dataflow
7701 analyses that eliminate useless checks for null pointers; these assume
7702 that a memory access to address zero always results in a trap, so
7703 that if a pointer is checked after it has already been dereferenced,
7704 it cannot be null.
7706 Note however that in some environments this assumption is not true.
7707 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
7708 for programs that depend on that behavior.
7710 This option is enabled by default on most targets.  On Nios II ELF, it
7711 defaults to off.  On AVR and CR16, this option is completely disabled.  
7713 Passes that use the dataflow information
7714 are enabled independently at different optimization levels.
7716 @item -fdevirtualize
7717 @opindex fdevirtualize
7718 Attempt to convert calls to virtual functions to direct calls.  This
7719 is done both within a procedure and interprocedurally as part of
7720 indirect inlining (@option{-findirect-inlining}) and interprocedural constant
7721 propagation (@option{-fipa-cp}).
7722 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7724 @item -fdevirtualize-speculatively
7725 @opindex fdevirtualize-speculatively
7726 Attempt to convert calls to virtual functions to speculative direct calls.
7727 Based on the analysis of the type inheritance graph, determine for a given call
7728 the set of likely targets. If the set is small, preferably of size 1, change
7729 the call into a conditional deciding between direct and indirect calls.  The
7730 speculative calls enable more optimizations, such as inlining.  When they seem
7731 useless after further optimization, they are converted back into original form.
7733 @item -fdevirtualize-at-ltrans
7734 @opindex fdevirtualize-at-ltrans
7735 Stream extra information needed for aggressive devirtualization when running
7736 the link-time optimizer in local transformation mode.  
7737 This option enables more devirtualization but
7738 significantly increases the size of streamed data. For this reason it is
7739 disabled by default.
7741 @item -fexpensive-optimizations
7742 @opindex fexpensive-optimizations
7743 Perform a number of minor optimizations that are relatively expensive.
7745 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7747 @item -free
7748 @opindex free
7749 Attempt to remove redundant extension instructions.  This is especially
7750 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
7751 registers after writing to their lower 32-bit half.
7753 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
7754 @option{-O3}, @option{-Os}.
7756 @item -fno-lifetime-dse
7757 @opindex fno-lifetime-dse
7758 In C++ the value of an object is only affected by changes within its
7759 lifetime: when the constructor begins, the object has an indeterminate
7760 value, and any changes during the lifetime of the object are dead when
7761 the object is destroyed.  Normally dead store elimination will take
7762 advantage of this; if your code relies on the value of the object
7763 storage persisting beyond the lifetime of the object, you can use this
7764 flag to disable this optimization.  To preserve stores before the
7765 constructor starts (e.g. because your operator new clears the object
7766 storage) but still treat the object as dead after the destructor you,
7767 can use @option{-flifetime-dse=1}.  The default behavior can be
7768 explicitly selected with @option{-flifetime-dse=2}.
7769 @option{-flifetime-dse=0} is equivalent to @option{-fno-lifetime-dse}.
7771 @item -flive-range-shrinkage
7772 @opindex flive-range-shrinkage
7773 Attempt to decrease register pressure through register live range
7774 shrinkage.  This is helpful for fast processors with small or moderate
7775 size register sets.
7777 @item -fira-algorithm=@var{algorithm}
7778 @opindex fira-algorithm
7779 Use the specified coloring algorithm for the integrated register
7780 allocator.  The @var{algorithm} argument can be @samp{priority}, which
7781 specifies Chow's priority coloring, or @samp{CB}, which specifies
7782 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
7783 for all architectures, but for those targets that do support it, it is
7784 the default because it generates better code.
7786 @item -fira-region=@var{region}
7787 @opindex fira-region
7788 Use specified regions for the integrated register allocator.  The
7789 @var{region} argument should be one of the following:
7791 @table @samp
7793 @item all
7794 Use all loops as register allocation regions.
7795 This can give the best results for machines with a small and/or
7796 irregular register set.
7798 @item mixed
7799 Use all loops except for loops with small register pressure 
7800 as the regions.  This value usually gives
7801 the best results in most cases and for most architectures,
7802 and is enabled by default when compiling with optimization for speed
7803 (@option{-O}, @option{-O2}, @dots{}).
7805 @item one
7806 Use all functions as a single region.  
7807 This typically results in the smallest code size, and is enabled by default for
7808 @option{-Os} or @option{-O0}.
7810 @end table
7812 @item -fira-hoist-pressure
7813 @opindex fira-hoist-pressure
7814 Use IRA to evaluate register pressure in the code hoisting pass for
7815 decisions to hoist expressions.  This option usually results in smaller
7816 code, but it can slow the compiler down.
7818 This option is enabled at level @option{-Os} for all targets.
7820 @item -fira-loop-pressure
7821 @opindex fira-loop-pressure
7822 Use IRA to evaluate register pressure in loops for decisions to move
7823 loop invariants.  This option usually results in generation
7824 of faster and smaller code on machines with large register files (>= 32
7825 registers), but it can slow the compiler down.
7827 This option is enabled at level @option{-O3} for some targets.
7829 @item -fno-ira-share-save-slots
7830 @opindex fno-ira-share-save-slots
7831 Disable sharing of stack slots used for saving call-used hard
7832 registers living through a call.  Each hard register gets a
7833 separate stack slot, and as a result function stack frames are
7834 larger.
7836 @item -fno-ira-share-spill-slots
7837 @opindex fno-ira-share-spill-slots
7838 Disable sharing of stack slots allocated for pseudo-registers.  Each
7839 pseudo-register that does not get a hard register gets a separate
7840 stack slot, and as a result function stack frames are larger.
7842 @item -flra-remat
7843 @opindex flra-remat
7844 Enable CFG-sensitive rematerialization in LRA.  Instead of loading
7845 values of spilled pseudos, LRA tries to rematerialize (recalculate)
7846 values if it is profitable.
7848 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7850 @item -fdelayed-branch
7851 @opindex fdelayed-branch
7852 If supported for the target machine, attempt to reorder instructions
7853 to exploit instruction slots available after delayed branch
7854 instructions.
7856 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7858 @item -fschedule-insns
7859 @opindex fschedule-insns
7860 If supported for the target machine, attempt to reorder instructions to
7861 eliminate execution stalls due to required data being unavailable.  This
7862 helps machines that have slow floating point or memory load instructions
7863 by allowing other instructions to be issued until the result of the load
7864 or floating-point instruction is required.
7866 Enabled at levels @option{-O2}, @option{-O3}.
7868 @item -fschedule-insns2
7869 @opindex fschedule-insns2
7870 Similar to @option{-fschedule-insns}, but requests an additional pass of
7871 instruction scheduling after register allocation has been done.  This is
7872 especially useful on machines with a relatively small number of
7873 registers and where memory load instructions take more than one cycle.
7875 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7877 @item -fno-sched-interblock
7878 @opindex fno-sched-interblock
7879 Don't schedule instructions across basic blocks.  This is normally
7880 enabled by default when scheduling before register allocation, i.e.@:
7881 with @option{-fschedule-insns} or at @option{-O2} or higher.
7883 @item -fno-sched-spec
7884 @opindex fno-sched-spec
7885 Don't allow speculative motion of non-load instructions.  This is normally
7886 enabled by default when scheduling before register allocation, i.e.@:
7887 with @option{-fschedule-insns} or at @option{-O2} or higher.
7889 @item -fsched-pressure
7890 @opindex fsched-pressure
7891 Enable register pressure sensitive insn scheduling before register
7892 allocation.  This only makes sense when scheduling before register
7893 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
7894 @option{-O2} or higher.  Usage of this option can improve the
7895 generated code and decrease its size by preventing register pressure
7896 increase above the number of available hard registers and subsequent
7897 spills in register allocation.
7899 @item -fsched-spec-load
7900 @opindex fsched-spec-load
7901 Allow speculative motion of some load instructions.  This only makes
7902 sense when scheduling before register allocation, i.e.@: with
7903 @option{-fschedule-insns} or at @option{-O2} or higher.
7905 @item -fsched-spec-load-dangerous
7906 @opindex fsched-spec-load-dangerous
7907 Allow speculative motion of more load instructions.  This only makes
7908 sense when scheduling before register allocation, i.e.@: with
7909 @option{-fschedule-insns} or at @option{-O2} or higher.
7911 @item -fsched-stalled-insns
7912 @itemx -fsched-stalled-insns=@var{n}
7913 @opindex fsched-stalled-insns
7914 Define how many insns (if any) can be moved prematurely from the queue
7915 of stalled insns into the ready list during the second scheduling pass.
7916 @option{-fno-sched-stalled-insns} means that no insns are moved
7917 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
7918 on how many queued insns can be moved prematurely.
7919 @option{-fsched-stalled-insns} without a value is equivalent to
7920 @option{-fsched-stalled-insns=1}.
7922 @item -fsched-stalled-insns-dep
7923 @itemx -fsched-stalled-insns-dep=@var{n}
7924 @opindex fsched-stalled-insns-dep
7925 Define how many insn groups (cycles) are examined for a dependency
7926 on a stalled insn that is a candidate for premature removal from the queue
7927 of stalled insns.  This has an effect only during the second scheduling pass,
7928 and only if @option{-fsched-stalled-insns} is used.
7929 @option{-fno-sched-stalled-insns-dep} is equivalent to
7930 @option{-fsched-stalled-insns-dep=0}.
7931 @option{-fsched-stalled-insns-dep} without a value is equivalent to
7932 @option{-fsched-stalled-insns-dep=1}.
7934 @item -fsched2-use-superblocks
7935 @opindex fsched2-use-superblocks
7936 When scheduling after register allocation, use superblock scheduling.
7937 This allows motion across basic block boundaries,
7938 resulting in faster schedules.  This option is experimental, as not all machine
7939 descriptions used by GCC model the CPU closely enough to avoid unreliable
7940 results from the algorithm.
7942 This only makes sense when scheduling after register allocation, i.e.@: with
7943 @option{-fschedule-insns2} or at @option{-O2} or higher.
7945 @item -fsched-group-heuristic
7946 @opindex fsched-group-heuristic
7947 Enable the group heuristic in the scheduler.  This heuristic favors
7948 the instruction that belongs to a schedule group.  This is enabled
7949 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7950 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7952 @item -fsched-critical-path-heuristic
7953 @opindex fsched-critical-path-heuristic
7954 Enable the critical-path heuristic in the scheduler.  This heuristic favors
7955 instructions on the critical path.  This is enabled by default when
7956 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7957 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7959 @item -fsched-spec-insn-heuristic
7960 @opindex fsched-spec-insn-heuristic
7961 Enable the speculative instruction heuristic in the scheduler.  This
7962 heuristic favors speculative instructions with greater dependency weakness.
7963 This is enabled by default when scheduling is enabled, i.e.@:
7964 with @option{-fschedule-insns} or @option{-fschedule-insns2}
7965 or at @option{-O2} or higher.
7967 @item -fsched-rank-heuristic
7968 @opindex fsched-rank-heuristic
7969 Enable the rank heuristic in the scheduler.  This heuristic favors
7970 the instruction belonging to a basic block with greater size or frequency.
7971 This is enabled by default when scheduling is enabled, i.e.@:
7972 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7973 at @option{-O2} or higher.
7975 @item -fsched-last-insn-heuristic
7976 @opindex fsched-last-insn-heuristic
7977 Enable the last-instruction heuristic in the scheduler.  This heuristic
7978 favors the instruction that is less dependent on the last instruction
7979 scheduled.  This is enabled by default when scheduling is enabled,
7980 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7981 at @option{-O2} or higher.
7983 @item -fsched-dep-count-heuristic
7984 @opindex fsched-dep-count-heuristic
7985 Enable the dependent-count heuristic in the scheduler.  This heuristic
7986 favors the instruction that has more instructions depending on it.
7987 This is enabled by default when scheduling is enabled, i.e.@:
7988 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7989 at @option{-O2} or higher.
7991 @item -freschedule-modulo-scheduled-loops
7992 @opindex freschedule-modulo-scheduled-loops
7993 Modulo scheduling is performed before traditional scheduling.  If a loop
7994 is modulo scheduled, later scheduling passes may change its schedule.  
7995 Use this option to control that behavior.
7997 @item -fselective-scheduling
7998 @opindex fselective-scheduling
7999 Schedule instructions using selective scheduling algorithm.  Selective
8000 scheduling runs instead of the first scheduler pass.
8002 @item -fselective-scheduling2
8003 @opindex fselective-scheduling2
8004 Schedule instructions using selective scheduling algorithm.  Selective
8005 scheduling runs instead of the second scheduler pass.
8007 @item -fsel-sched-pipelining
8008 @opindex fsel-sched-pipelining
8009 Enable software pipelining of innermost loops during selective scheduling.
8010 This option has no effect unless one of @option{-fselective-scheduling} or
8011 @option{-fselective-scheduling2} is turned on.
8013 @item -fsel-sched-pipelining-outer-loops
8014 @opindex fsel-sched-pipelining-outer-loops
8015 When pipelining loops during selective scheduling, also pipeline outer loops.
8016 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
8018 @item -fsemantic-interposition
8019 @opindex fsemantic-interposition
8020 Some object formats, like ELF, allow interposing of symbols by the 
8021 dynamic linker.
8022 This means that for symbols exported from the DSO, the compiler cannot perform
8023 interprocedural propagation, inlining and other optimizations in anticipation
8024 that the function or variable in question may change. While this feature is
8025 useful, for example, to rewrite memory allocation functions by a debugging
8026 implementation, it is expensive in the terms of code quality.
8027 With @option{-fno-semantic-interposition} the compiler assumes that 
8028 if interposition happens for functions the overwriting function will have 
8029 precisely the same semantics (and side effects). 
8030 Similarly if interposition happens
8031 for variables, the constructor of the variable will be the same. The flag
8032 has no effect for functions explicitly declared inline 
8033 (where it is never allowed for interposition to change semantics) 
8034 and for symbols explicitly declared weak.
8036 @item -fshrink-wrap
8037 @opindex fshrink-wrap
8038 Emit function prologues only before parts of the function that need it,
8039 rather than at the top of the function.  This flag is enabled by default at
8040 @option{-O} and higher.
8042 @item -fshrink-wrap-separate
8043 @opindex fshrink-wrap-separate
8044 Shrink-wrap separate parts of the prologue and epilogue separately, so that
8045 those parts are only executed when needed.
8046 This option is on by default, but has no effect unless @option{-fshrink-wrap}
8047 is also turned on and the target supports this.
8049 @item -fcaller-saves
8050 @opindex fcaller-saves
8051 Enable allocation of values to registers that are clobbered by
8052 function calls, by emitting extra instructions to save and restore the
8053 registers around such calls.  Such allocation is done only when it
8054 seems to result in better code.
8056 This option is always enabled by default on certain machines, usually
8057 those which have no call-preserved registers to use instead.
8059 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8061 @item -fcombine-stack-adjustments
8062 @opindex fcombine-stack-adjustments
8063 Tracks stack adjustments (pushes and pops) and stack memory references
8064 and then tries to find ways to combine them.
8066 Enabled by default at @option{-O1} and higher.
8068 @item -fipa-ra
8069 @opindex fipa-ra
8070 Use caller save registers for allocation if those registers are not used by
8071 any called function.  In that case it is not necessary to save and restore
8072 them around calls.  This is only possible if called functions are part of
8073 same compilation unit as current function and they are compiled before it.
8075 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}, however the option
8076 is disabled if generated code will be instrumented for profiling
8077 (@option{-p}, or @option{-pg}) or if callee's register usage cannot be known
8078 exactly (this happens on targets that do not expose prologues
8079 and epilogues in RTL).
8081 @item -fconserve-stack
8082 @opindex fconserve-stack
8083 Attempt to minimize stack usage.  The compiler attempts to use less
8084 stack space, even if that makes the program slower.  This option
8085 implies setting the @option{large-stack-frame} parameter to 100
8086 and the @option{large-stack-frame-growth} parameter to 400.
8088 @item -ftree-reassoc
8089 @opindex ftree-reassoc
8090 Perform reassociation on trees.  This flag is enabled by default
8091 at @option{-O} and higher.
8093 @item -fcode-hoisting
8094 @opindex fcode-hoisting
8095 Perform code hoisting.  Code hoisting tries to move the
8096 evaluation of expressions executed on all paths to the function exit
8097 as early as possible.  This is especially useful as a code size
8098 optimization, but it often helps for code speed as well.
8099 This flag is enabled by default at @option{-O2} and higher.
8101 @item -ftree-pre
8102 @opindex ftree-pre
8103 Perform partial redundancy elimination (PRE) on trees.  This flag is
8104 enabled by default at @option{-O2} and @option{-O3}.
8106 @item -ftree-partial-pre
8107 @opindex ftree-partial-pre
8108 Make partial redundancy elimination (PRE) more aggressive.  This flag is
8109 enabled by default at @option{-O3}.
8111 @item -ftree-forwprop
8112 @opindex ftree-forwprop
8113 Perform forward propagation on trees.  This flag is enabled by default
8114 at @option{-O} and higher.
8116 @item -ftree-fre
8117 @opindex ftree-fre
8118 Perform full redundancy elimination (FRE) on trees.  The difference
8119 between FRE and PRE is that FRE only considers expressions
8120 that are computed on all paths leading to the redundant computation.
8121 This analysis is faster than PRE, though it exposes fewer redundancies.
8122 This flag is enabled by default at @option{-O} and higher.
8124 @item -ftree-phiprop
8125 @opindex ftree-phiprop
8126 Perform hoisting of loads from conditional pointers on trees.  This
8127 pass is enabled by default at @option{-O} and higher.
8129 @item -fhoist-adjacent-loads
8130 @opindex fhoist-adjacent-loads
8131 Speculatively hoist loads from both branches of an if-then-else if the
8132 loads are from adjacent locations in the same structure and the target
8133 architecture has a conditional move instruction.  This flag is enabled
8134 by default at @option{-O2} and higher.
8136 @item -ftree-copy-prop
8137 @opindex ftree-copy-prop
8138 Perform copy propagation on trees.  This pass eliminates unnecessary
8139 copy operations.  This flag is enabled by default at @option{-O} and
8140 higher.
8142 @item -fipa-pure-const
8143 @opindex fipa-pure-const
8144 Discover which functions are pure or constant.
8145 Enabled by default at @option{-O} and higher.
8147 @item -fipa-reference
8148 @opindex fipa-reference
8149 Discover which static variables do not escape the
8150 compilation unit.
8151 Enabled by default at @option{-O} and higher.
8153 @item -fipa-pta
8154 @opindex fipa-pta
8155 Perform interprocedural pointer analysis and interprocedural modification
8156 and reference analysis.  This option can cause excessive memory and
8157 compile-time usage on large compilation units.  It is not enabled by
8158 default at any optimization level.
8160 @item -fipa-profile
8161 @opindex fipa-profile
8162 Perform interprocedural profile propagation.  The functions called only from
8163 cold functions are marked as cold. Also functions executed once (such as
8164 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
8165 functions and loop less parts of functions executed once are then optimized for
8166 size.
8167 Enabled by default at @option{-O} and higher.
8169 @item -fipa-cp
8170 @opindex fipa-cp
8171 Perform interprocedural constant propagation.
8172 This optimization analyzes the program to determine when values passed
8173 to functions are constants and then optimizes accordingly.
8174 This optimization can substantially increase performance
8175 if the application has constants passed to functions.
8176 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
8178 @item -fipa-cp-clone
8179 @opindex fipa-cp-clone
8180 Perform function cloning to make interprocedural constant propagation stronger.
8181 When enabled, interprocedural constant propagation performs function cloning
8182 when externally visible function can be called with constant arguments.
8183 Because this optimization can create multiple copies of functions,
8184 it may significantly increase code size
8185 (see @option{--param ipcp-unit-growth=@var{value}}).
8186 This flag is enabled by default at @option{-O3}.
8188 @item -fipa-bit-cp
8189 @opindex -fipa-bit-cp
8190 When enabled, perform interprocedural bitwise constant
8191 propagation. This flag is enabled by default at @option{-O2}. It
8192 requires that @option{-fipa-cp} is enabled.
8194 @item -fipa-vrp
8195 @opindex -fipa-vrp
8196 When enabled, perform interprocedural propagation of value
8197 ranges. This flag is enabled by default at @option{-O2}. It requires
8198 that @option{-fipa-cp} is enabled.
8200 @item -fipa-icf
8201 @opindex fipa-icf
8202 Perform Identical Code Folding for functions and read-only variables.
8203 The optimization reduces code size and may disturb unwind stacks by replacing
8204 a function by equivalent one with a different name. The optimization works
8205 more effectively with link-time optimization enabled.
8207 Nevertheless the behavior is similar to Gold Linker ICF optimization, GCC ICF
8208 works on different levels and thus the optimizations are not same - there are
8209 equivalences that are found only by GCC and equivalences found only by Gold.
8211 This flag is enabled by default at @option{-O2} and @option{-Os}.
8213 @item -fisolate-erroneous-paths-dereference
8214 @opindex fisolate-erroneous-paths-dereference
8215 Detect paths that trigger erroneous or undefined behavior due to
8216 dereferencing a null pointer.  Isolate those paths from the main control
8217 flow and turn the statement with erroneous or undefined behavior into a trap.
8218 This flag is enabled by default at @option{-O2} and higher and depends on
8219 @option{-fdelete-null-pointer-checks} also being enabled.
8221 @item -fisolate-erroneous-paths-attribute
8222 @opindex fisolate-erroneous-paths-attribute
8223 Detect paths that trigger erroneous or undefined behavior due a null value
8224 being used in a way forbidden by a @code{returns_nonnull} or @code{nonnull}
8225 attribute.  Isolate those paths from the main control flow and turn the
8226 statement with erroneous or undefined behavior into a trap.  This is not
8227 currently enabled, but may be enabled by @option{-O2} in the future.
8229 @item -ftree-sink
8230 @opindex ftree-sink
8231 Perform forward store motion on trees.  This flag is
8232 enabled by default at @option{-O} and higher.
8234 @item -ftree-bit-ccp
8235 @opindex ftree-bit-ccp
8236 Perform sparse conditional bit constant propagation on trees and propagate
8237 pointer alignment information.
8238 This pass only operates on local scalar variables and is enabled by default
8239 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
8241 @item -ftree-ccp
8242 @opindex ftree-ccp
8243 Perform sparse conditional constant propagation (CCP) on trees.  This
8244 pass only operates on local scalar variables and is enabled by default
8245 at @option{-O} and higher.
8247 @item -fssa-backprop
8248 @opindex fssa-backprop
8249 Propagate information about uses of a value up the definition chain
8250 in order to simplify the definitions.  For example, this pass strips
8251 sign operations if the sign of a value never matters.  The flag is
8252 enabled by default at @option{-O} and higher.
8254 @item -fssa-phiopt
8255 @opindex fssa-phiopt
8256 Perform pattern matching on SSA PHI nodes to optimize conditional
8257 code.  This pass is enabled by default at @option{-O} and higher.
8259 @item -ftree-switch-conversion
8260 @opindex ftree-switch-conversion
8261 Perform conversion of simple initializations in a switch to
8262 initializations from a scalar array.  This flag is enabled by default
8263 at @option{-O2} and higher.
8265 @item -ftree-tail-merge
8266 @opindex ftree-tail-merge
8267 Look for identical code sequences.  When found, replace one with a jump to the
8268 other.  This optimization is known as tail merging or cross jumping.  This flag
8269 is enabled by default at @option{-O2} and higher.  The compilation time
8270 in this pass can
8271 be limited using @option{max-tail-merge-comparisons} parameter and
8272 @option{max-tail-merge-iterations} parameter.
8274 @item -ftree-dce
8275 @opindex ftree-dce
8276 Perform dead code elimination (DCE) on trees.  This flag is enabled by
8277 default at @option{-O} and higher.
8279 @item -ftree-builtin-call-dce
8280 @opindex ftree-builtin-call-dce
8281 Perform conditional dead code elimination (DCE) for calls to built-in functions
8282 that may set @code{errno} but are otherwise side-effect free.  This flag is
8283 enabled by default at @option{-O2} and higher if @option{-Os} is not also
8284 specified.
8286 @item -ftree-dominator-opts
8287 @opindex ftree-dominator-opts
8288 Perform a variety of simple scalar cleanups (constant/copy
8289 propagation, redundancy elimination, range propagation and expression
8290 simplification) based on a dominator tree traversal.  This also
8291 performs jump threading (to reduce jumps to jumps). This flag is
8292 enabled by default at @option{-O} and higher.
8294 @item -ftree-dse
8295 @opindex ftree-dse
8296 Perform dead store elimination (DSE) on trees.  A dead store is a store into
8297 a memory location that is later overwritten by another store without
8298 any intervening loads.  In this case the earlier store can be deleted.  This
8299 flag is enabled by default at @option{-O} and higher.
8301 @item -ftree-ch
8302 @opindex ftree-ch
8303 Perform loop header copying on trees.  This is beneficial since it increases
8304 effectiveness of code motion optimizations.  It also saves one jump.  This flag
8305 is enabled by default at @option{-O} and higher.  It is not enabled
8306 for @option{-Os}, since it usually increases code size.
8308 @item -ftree-loop-optimize
8309 @opindex ftree-loop-optimize
8310 Perform loop optimizations on trees.  This flag is enabled by default
8311 at @option{-O} and higher.
8313 @item -ftree-loop-linear
8314 @itemx -floop-interchange
8315 @itemx -floop-strip-mine
8316 @itemx -floop-block
8317 @itemx -floop-unroll-and-jam
8318 @opindex ftree-loop-linear
8319 @opindex floop-interchange
8320 @opindex floop-strip-mine
8321 @opindex floop-block
8322 @opindex floop-unroll-and-jam
8323 Perform loop nest optimizations.  Same as
8324 @option{-floop-nest-optimize}.  To use this code transformation, GCC has
8325 to be configured with @option{--with-isl} to enable the Graphite loop
8326 transformation infrastructure.
8328 @item -fgraphite-identity
8329 @opindex fgraphite-identity
8330 Enable the identity transformation for graphite.  For every SCoP we generate
8331 the polyhedral representation and transform it back to gimple.  Using
8332 @option{-fgraphite-identity} we can check the costs or benefits of the
8333 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
8334 are also performed by the code generator isl, like index splitting and
8335 dead code elimination in loops.
8337 @item -floop-nest-optimize
8338 @opindex floop-nest-optimize
8339 Enable the isl based loop nest optimizer.  This is a generic loop nest
8340 optimizer based on the Pluto optimization algorithms.  It calculates a loop
8341 structure optimized for data-locality and parallelism.  This option
8342 is experimental.
8344 @item -floop-parallelize-all
8345 @opindex floop-parallelize-all
8346 Use the Graphite data dependence analysis to identify loops that can
8347 be parallelized.  Parallelize all the loops that can be analyzed to
8348 not contain loop carried dependences without checking that it is
8349 profitable to parallelize the loops.
8351 @item -ftree-coalesce-vars
8352 @opindex ftree-coalesce-vars
8353 While transforming the program out of the SSA representation, attempt to
8354 reduce copying by coalescing versions of different user-defined
8355 variables, instead of just compiler temporaries.  This may severely
8356 limit the ability to debug an optimized program compiled with
8357 @option{-fno-var-tracking-assignments}.  In the negated form, this flag
8358 prevents SSA coalescing of user variables.  This option is enabled by
8359 default if optimization is enabled, and it does very little otherwise.
8361 @item -ftree-loop-if-convert
8362 @opindex ftree-loop-if-convert
8363 Attempt to transform conditional jumps in the innermost loops to
8364 branch-less equivalents.  The intent is to remove control-flow from
8365 the innermost loops in order to improve the ability of the
8366 vectorization pass to handle these loops.  This is enabled by default
8367 if vectorization is enabled.
8369 @item -ftree-loop-distribution
8370 @opindex ftree-loop-distribution
8371 Perform loop distribution.  This flag can improve cache performance on
8372 big loop bodies and allow further loop optimizations, like
8373 parallelization or vectorization, to take place.  For example, the loop
8374 @smallexample
8375 DO I = 1, N
8376   A(I) = B(I) + C
8377   D(I) = E(I) * F
8378 ENDDO
8379 @end smallexample
8380 is transformed to
8381 @smallexample
8382 DO I = 1, N
8383    A(I) = B(I) + C
8384 ENDDO
8385 DO I = 1, N
8386    D(I) = E(I) * F
8387 ENDDO
8388 @end smallexample
8390 @item -ftree-loop-distribute-patterns
8391 @opindex ftree-loop-distribute-patterns
8392 Perform loop distribution of patterns that can be code generated with
8393 calls to a library.  This flag is enabled by default at @option{-O3}.
8395 This pass distributes the initialization loops and generates a call to
8396 memset zero.  For example, the loop
8397 @smallexample
8398 DO I = 1, N
8399   A(I) = 0
8400   B(I) = A(I) + I
8401 ENDDO
8402 @end smallexample
8403 is transformed to
8404 @smallexample
8405 DO I = 1, N
8406    A(I) = 0
8407 ENDDO
8408 DO I = 1, N
8409    B(I) = A(I) + I
8410 ENDDO
8411 @end smallexample
8412 and the initialization loop is transformed into a call to memset zero.
8414 @item -ftree-loop-im
8415 @opindex ftree-loop-im
8416 Perform loop invariant motion on trees.  This pass moves only invariants that
8417 are hard to handle at RTL level (function calls, operations that expand to
8418 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
8419 operands of conditions that are invariant out of the loop, so that we can use
8420 just trivial invariantness analysis in loop unswitching.  The pass also includes
8421 store motion.
8423 @item -ftree-loop-ivcanon
8424 @opindex ftree-loop-ivcanon
8425 Create a canonical counter for number of iterations in loops for which
8426 determining number of iterations requires complicated analysis.  Later
8427 optimizations then may determine the number easily.  Useful especially
8428 in connection with unrolling.
8430 @item -fivopts
8431 @opindex fivopts
8432 Perform induction variable optimizations (strength reduction, induction
8433 variable merging and induction variable elimination) on trees.
8435 @item -ftree-parallelize-loops=n
8436 @opindex ftree-parallelize-loops
8437 Parallelize loops, i.e., split their iteration space to run in n threads.
8438 This is only possible for loops whose iterations are independent
8439 and can be arbitrarily reordered.  The optimization is only
8440 profitable on multiprocessor machines, for loops that are CPU-intensive,
8441 rather than constrained e.g.@: by memory bandwidth.  This option
8442 implies @option{-pthread}, and thus is only supported on targets
8443 that have support for @option{-pthread}.
8445 @item -ftree-pta
8446 @opindex ftree-pta
8447 Perform function-local points-to analysis on trees.  This flag is
8448 enabled by default at @option{-O} and higher.
8450 @item -ftree-sra
8451 @opindex ftree-sra
8452 Perform scalar replacement of aggregates.  This pass replaces structure
8453 references with scalars to prevent committing structures to memory too
8454 early.  This flag is enabled by default at @option{-O} and higher.
8456 @item -fstore-merging
8457 @opindex fstore-merging
8458 Perform merging of narrow stores to consecutive memory addresses.  This pass
8459 merges contiguous stores of immediate values narrower than a word into fewer
8460 wider stores to reduce the number of instructions.  This is enabled by default
8461 at @option{-O2} and higher as well as @option{-Os}.
8463 @item -ftree-ter
8464 @opindex ftree-ter
8465 Perform temporary expression replacement during the SSA->normal phase.  Single
8466 use/single def temporaries are replaced at their use location with their
8467 defining expression.  This results in non-GIMPLE code, but gives the expanders
8468 much more complex trees to work on resulting in better RTL generation.  This is
8469 enabled by default at @option{-O} and higher.
8471 @item -ftree-slsr
8472 @opindex ftree-slsr
8473 Perform straight-line strength reduction on trees.  This recognizes related
8474 expressions involving multiplications and replaces them by less expensive
8475 calculations when possible.  This is enabled by default at @option{-O} and
8476 higher.
8478 @item -ftree-vectorize
8479 @opindex ftree-vectorize
8480 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
8481 and @option{-ftree-slp-vectorize} if not explicitly specified.
8483 @item -ftree-loop-vectorize
8484 @opindex ftree-loop-vectorize
8485 Perform loop vectorization on trees. This flag is enabled by default at
8486 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8488 @item -ftree-slp-vectorize
8489 @opindex ftree-slp-vectorize
8490 Perform basic block vectorization on trees. This flag is enabled by default at
8491 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8493 @item -fvect-cost-model=@var{model}
8494 @opindex fvect-cost-model
8495 Alter the cost model used for vectorization.  The @var{model} argument
8496 should be one of @samp{unlimited}, @samp{dynamic} or @samp{cheap}.
8497 With the @samp{unlimited} model the vectorized code-path is assumed
8498 to be profitable while with the @samp{dynamic} model a runtime check
8499 guards the vectorized code-path to enable it only for iteration
8500 counts that will likely execute faster than when executing the original
8501 scalar loop.  The @samp{cheap} model disables vectorization of
8502 loops where doing so would be cost prohibitive for example due to
8503 required runtime checks for data dependence or alignment but otherwise
8504 is equal to the @samp{dynamic} model.
8505 The default cost model depends on other optimization flags and is
8506 either @samp{dynamic} or @samp{cheap}.
8508 @item -fsimd-cost-model=@var{model}
8509 @opindex fsimd-cost-model
8510 Alter the cost model used for vectorization of loops marked with the OpenMP
8511 or Cilk Plus simd directive.  The @var{model} argument should be one of
8512 @samp{unlimited}, @samp{dynamic}, @samp{cheap}.  All values of @var{model}
8513 have the same meaning as described in @option{-fvect-cost-model} and by
8514 default a cost model defined with @option{-fvect-cost-model} is used.
8516 @item -ftree-vrp
8517 @opindex ftree-vrp
8518 Perform Value Range Propagation on trees.  This is similar to the
8519 constant propagation pass, but instead of values, ranges of values are
8520 propagated.  This allows the optimizers to remove unnecessary range
8521 checks like array bound checks and null pointer checks.  This is
8522 enabled by default at @option{-O2} and higher.  Null pointer check
8523 elimination is only done if @option{-fdelete-null-pointer-checks} is
8524 enabled.
8526 @item -fsplit-paths
8527 @opindex fsplit-paths
8528 Split paths leading to loop backedges.  This can improve dead code
8529 elimination and common subexpression elimination.  This is enabled by
8530 default at @option{-O2} and above.
8532 @item -fsplit-ivs-in-unroller
8533 @opindex fsplit-ivs-in-unroller
8534 Enables expression of values of induction variables in later iterations
8535 of the unrolled loop using the value in the first iteration.  This breaks
8536 long dependency chains, thus improving efficiency of the scheduling passes.
8538 A combination of @option{-fweb} and CSE is often sufficient to obtain the
8539 same effect.  However, that is not reliable in cases where the loop body
8540 is more complicated than a single basic block.  It also does not work at all
8541 on some architectures due to restrictions in the CSE pass.
8543 This optimization is enabled by default.
8545 @item -fvariable-expansion-in-unroller
8546 @opindex fvariable-expansion-in-unroller
8547 With this option, the compiler creates multiple copies of some
8548 local variables when unrolling a loop, which can result in superior code.
8550 @item -fpartial-inlining
8551 @opindex fpartial-inlining
8552 Inline parts of functions.  This option has any effect only
8553 when inlining itself is turned on by the @option{-finline-functions}
8554 or @option{-finline-small-functions} options.
8556 Enabled at level @option{-O2}.
8558 @item -fpredictive-commoning
8559 @opindex fpredictive-commoning
8560 Perform predictive commoning optimization, i.e., reusing computations
8561 (especially memory loads and stores) performed in previous
8562 iterations of loops.
8564 This option is enabled at level @option{-O3}.
8566 @item -fprefetch-loop-arrays
8567 @opindex fprefetch-loop-arrays
8568 If supported by the target machine, generate instructions to prefetch
8569 memory to improve the performance of loops that access large arrays.
8571 This option may generate better or worse code; results are highly
8572 dependent on the structure of loops within the source code.
8574 Disabled at level @option{-Os}.
8576 @item -fno-printf-return-value
8577 @opindex fno-printf-return-value
8578 Do not substitute constants for known return value of formatted output
8579 functions such as @code{sprintf}, @code{snprintf}, @code{vsprintf}, and
8580 @code{vsnprintf} (but not @code{printf} of @code{fprintf}).  This
8581 transformation allows GCC to optimize or even eliminate branches based
8582 on the known return value of these functions called with arguments that
8583 are either constant, or whose values are known to be in a range that
8584 makes determining the exact return value possible.  For example, when
8585 @option{-fprintf-return-value} is in effect, both the branch and the
8586 body of the @code{if} statement (but not the call to @code{snprint})
8587 can be optimized away when @code{i} is a 32-bit or smaller integer
8588 because the return value is guaranteed to be at most 8.
8590 @smallexample
8591 char buf[9];
8592 if (snprintf (buf, "%08x", i) >= sizeof buf)
8593   @dots{}
8594 @end smallexample
8596 The @option{-fprintf-return-value} option relies on other optimizations
8597 and yields best results with @option{-O2}.  It works in tandem with the
8598 @option{-Wformat-overflow} and @option{-Wformat-truncation} options.
8599 The @option{-fprintf-return-value} option is enabled by default.
8601 @item -fno-peephole
8602 @itemx -fno-peephole2
8603 @opindex fno-peephole
8604 @opindex fno-peephole2
8605 Disable any machine-specific peephole optimizations.  The difference
8606 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
8607 are implemented in the compiler; some targets use one, some use the
8608 other, a few use both.
8610 @option{-fpeephole} is enabled by default.
8611 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8613 @item -fno-guess-branch-probability
8614 @opindex fno-guess-branch-probability
8615 Do not guess branch probabilities using heuristics.
8617 GCC uses heuristics to guess branch probabilities if they are
8618 not provided by profiling feedback (@option{-fprofile-arcs}).  These
8619 heuristics are based on the control flow graph.  If some branch probabilities
8620 are specified by @code{__builtin_expect}, then the heuristics are
8621 used to guess branch probabilities for the rest of the control flow graph,
8622 taking the @code{__builtin_expect} info into account.  The interactions
8623 between the heuristics and @code{__builtin_expect} can be complex, and in
8624 some cases, it may be useful to disable the heuristics so that the effects
8625 of @code{__builtin_expect} are easier to understand.
8627 The default is @option{-fguess-branch-probability} at levels
8628 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8630 @item -freorder-blocks
8631 @opindex freorder-blocks
8632 Reorder basic blocks in the compiled function in order to reduce number of
8633 taken branches and improve code locality.
8635 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8637 @item -freorder-blocks-algorithm=@var{algorithm}
8638 @opindex freorder-blocks-algorithm
8639 Use the specified algorithm for basic block reordering.  The
8640 @var{algorithm} argument can be @samp{simple}, which does not increase
8641 code size (except sometimes due to secondary effects like alignment),
8642 or @samp{stc}, the ``software trace cache'' algorithm, which tries to
8643 put all often executed code together, minimizing the number of branches
8644 executed by making extra copies of code.
8646 The default is @samp{simple} at levels @option{-O}, @option{-Os}, and
8647 @samp{stc} at levels @option{-O2}, @option{-O3}.
8649 @item -freorder-blocks-and-partition
8650 @opindex freorder-blocks-and-partition
8651 In addition to reordering basic blocks in the compiled function, in order
8652 to reduce number of taken branches, partitions hot and cold basic blocks
8653 into separate sections of the assembly and @file{.o} files, to improve
8654 paging and cache locality performance.
8656 This optimization is automatically turned off in the presence of
8657 exception handling, for linkonce sections, for functions with a user-defined
8658 section attribute and on any architecture that does not support named
8659 sections.  When @option{-fsplit-stack} is used this option is not
8660 enabled by default (to avoid linker errors), but may be enabled
8661 explicitly (if using a working linker).
8663 Enabled for x86 at levels @option{-O2}, @option{-O3}.
8665 @item -freorder-functions
8666 @opindex freorder-functions
8667 Reorder functions in the object file in order to
8668 improve code locality.  This is implemented by using special
8669 subsections @code{.text.hot} for most frequently executed functions and
8670 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
8671 the linker so object file format must support named sections and linker must
8672 place them in a reasonable way.
8674 Also profile feedback must be available to make this option effective.  See
8675 @option{-fprofile-arcs} for details.
8677 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8679 @item -fstrict-aliasing
8680 @opindex fstrict-aliasing
8681 Allow the compiler to assume the strictest aliasing rules applicable to
8682 the language being compiled.  For C (and C++), this activates
8683 optimizations based on the type of expressions.  In particular, an
8684 object of one type is assumed never to reside at the same address as an
8685 object of a different type, unless the types are almost the same.  For
8686 example, an @code{unsigned int} can alias an @code{int}, but not a
8687 @code{void*} or a @code{double}.  A character type may alias any other
8688 type.
8690 @anchor{Type-punning}Pay special attention to code like this:
8691 @smallexample
8692 union a_union @{
8693   int i;
8694   double d;
8697 int f() @{
8698   union a_union t;
8699   t.d = 3.0;
8700   return t.i;
8702 @end smallexample
8703 The practice of reading from a different union member than the one most
8704 recently written to (called ``type-punning'') is common.  Even with
8705 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
8706 is accessed through the union type.  So, the code above works as
8707 expected.  @xref{Structures unions enumerations and bit-fields
8708 implementation}.  However, this code might not:
8709 @smallexample
8710 int f() @{
8711   union a_union t;
8712   int* ip;
8713   t.d = 3.0;
8714   ip = &t.i;
8715   return *ip;
8717 @end smallexample
8719 Similarly, access by taking the address, casting the resulting pointer
8720 and dereferencing the result has undefined behavior, even if the cast
8721 uses a union type, e.g.:
8722 @smallexample
8723 int f() @{
8724   double d = 3.0;
8725   return ((union a_union *) &d)->i;
8727 @end smallexample
8729 The @option{-fstrict-aliasing} option is enabled at levels
8730 @option{-O2}, @option{-O3}, @option{-Os}.
8732 @item -falign-functions
8733 @itemx -falign-functions=@var{n}
8734 @opindex falign-functions
8735 Align the start of functions to the next power-of-two greater than
8736 @var{n}, skipping up to @var{n} bytes.  For instance,
8737 @option{-falign-functions=32} aligns functions to the next 32-byte
8738 boundary, but @option{-falign-functions=24} aligns to the next
8739 32-byte boundary only if this can be done by skipping 23 bytes or less.
8741 @option{-fno-align-functions} and @option{-falign-functions=1} are
8742 equivalent and mean that functions are not aligned.
8744 Some assemblers only support this flag when @var{n} is a power of two;
8745 in that case, it is rounded up.
8747 If @var{n} is not specified or is zero, use a machine-dependent default.
8749 Enabled at levels @option{-O2}, @option{-O3}.
8751 @item -flimit-function-alignment
8752 If this option is enabled, the compiler tries to avoid unnecessarily
8753 overaligning functions. It attempts to instruct the assembler to align
8754 by the amount specified by @option{-falign-functions}, but not to
8755 skip more bytes than the size of the function.
8757 @item -falign-labels
8758 @itemx -falign-labels=@var{n}
8759 @opindex falign-labels
8760 Align all branch targets to a power-of-two boundary, skipping up to
8761 @var{n} bytes like @option{-falign-functions}.  This option can easily
8762 make code slower, because it must insert dummy operations for when the
8763 branch target is reached in the usual flow of the code.
8765 @option{-fno-align-labels} and @option{-falign-labels=1} are
8766 equivalent and mean that labels are not aligned.
8768 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
8769 are greater than this value, then their values are used instead.
8771 If @var{n} is not specified or is zero, use a machine-dependent default
8772 which is very likely to be @samp{1}, meaning no alignment.
8774 Enabled at levels @option{-O2}, @option{-O3}.
8776 @item -falign-loops
8777 @itemx -falign-loops=@var{n}
8778 @opindex falign-loops
8779 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
8780 like @option{-falign-functions}.  If the loops are
8781 executed many times, this makes up for any execution of the dummy
8782 operations.
8784 @option{-fno-align-loops} and @option{-falign-loops=1} are
8785 equivalent and mean that loops are not aligned.
8787 If @var{n} is not specified or is zero, use a machine-dependent default.
8789 Enabled at levels @option{-O2}, @option{-O3}.
8791 @item -falign-jumps
8792 @itemx -falign-jumps=@var{n}
8793 @opindex falign-jumps
8794 Align branch targets to a power-of-two boundary, for branch targets
8795 where the targets can only be reached by jumping, skipping up to @var{n}
8796 bytes like @option{-falign-functions}.  In this case, no dummy operations
8797 need be executed.
8799 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
8800 equivalent and mean that loops are not aligned.
8802 If @var{n} is not specified or is zero, use a machine-dependent default.
8804 Enabled at levels @option{-O2}, @option{-O3}.
8806 @item -funit-at-a-time
8807 @opindex funit-at-a-time
8808 This option is left for compatibility reasons. @option{-funit-at-a-time}
8809 has no effect, while @option{-fno-unit-at-a-time} implies
8810 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
8812 Enabled by default.
8814 @item -fno-toplevel-reorder
8815 @opindex fno-toplevel-reorder
8816 Do not reorder top-level functions, variables, and @code{asm}
8817 statements.  Output them in the same order that they appear in the
8818 input file.  When this option is used, unreferenced static variables
8819 are not removed.  This option is intended to support existing code
8820 that relies on a particular ordering.  For new code, it is better to
8821 use attributes when possible.
8823 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
8824 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
8825 targets.
8827 @item -fweb
8828 @opindex fweb
8829 Constructs webs as commonly used for register allocation purposes and assign
8830 each web individual pseudo register.  This allows the register allocation pass
8831 to operate on pseudos directly, but also strengthens several other optimization
8832 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
8833 however, make debugging impossible, since variables no longer stay in a
8834 ``home register''.
8836 Enabled by default with @option{-funroll-loops}.
8838 @item -fwhole-program
8839 @opindex fwhole-program
8840 Assume that the current compilation unit represents the whole program being
8841 compiled.  All public functions and variables with the exception of @code{main}
8842 and those merged by attribute @code{externally_visible} become static functions
8843 and in effect are optimized more aggressively by interprocedural optimizers.
8845 This option should not be used in combination with @option{-flto}.
8846 Instead relying on a linker plugin should provide safer and more precise
8847 information.
8849 @item -flto[=@var{n}]
8850 @opindex flto
8851 This option runs the standard link-time optimizer.  When invoked
8852 with source code, it generates GIMPLE (one of GCC's internal
8853 representations) and writes it to special ELF sections in the object
8854 file.  When the object files are linked together, all the function
8855 bodies are read from these ELF sections and instantiated as if they
8856 had been part of the same translation unit.
8858 To use the link-time optimizer, @option{-flto} and optimization
8859 options should be specified at compile time and during the final link.
8860 It is recommended that you compile all the files participating in the
8861 same link with the same options and also specify those options at
8862 link time.  
8863 For example:
8865 @smallexample
8866 gcc -c -O2 -flto foo.c
8867 gcc -c -O2 -flto bar.c
8868 gcc -o myprog -flto -O2 foo.o bar.o
8869 @end smallexample
8871 The first two invocations to GCC save a bytecode representation
8872 of GIMPLE into special ELF sections inside @file{foo.o} and
8873 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
8874 @file{foo.o} and @file{bar.o}, merges the two files into a single
8875 internal image, and compiles the result as usual.  Since both
8876 @file{foo.o} and @file{bar.o} are merged into a single image, this
8877 causes all the interprocedural analyses and optimizations in GCC to
8878 work across the two files as if they were a single one.  This means,
8879 for example, that the inliner is able to inline functions in
8880 @file{bar.o} into functions in @file{foo.o} and vice-versa.
8882 Another (simpler) way to enable link-time optimization is:
8884 @smallexample
8885 gcc -o myprog -flto -O2 foo.c bar.c
8886 @end smallexample
8888 The above generates bytecode for @file{foo.c} and @file{bar.c},
8889 merges them together into a single GIMPLE representation and optimizes
8890 them as usual to produce @file{myprog}.
8892 The only important thing to keep in mind is that to enable link-time
8893 optimizations you need to use the GCC driver to perform the link step.
8894 GCC then automatically performs link-time optimization if any of the
8895 objects involved were compiled with the @option{-flto} command-line option.  
8896 You generally
8897 should specify the optimization options to be used for link-time
8898 optimization though GCC tries to be clever at guessing an
8899 optimization level to use from the options used at compile time
8900 if you fail to specify one at link time.  You can always override
8901 the automatic decision to do link-time optimization
8902 by passing @option{-fno-lto} to the link command.
8904 To make whole program optimization effective, it is necessary to make
8905 certain whole program assumptions.  The compiler needs to know
8906 what functions and variables can be accessed by libraries and runtime
8907 outside of the link-time optimized unit.  When supported by the linker,
8908 the linker plugin (see @option{-fuse-linker-plugin}) passes information
8909 to the compiler about used and externally visible symbols.  When
8910 the linker plugin is not available, @option{-fwhole-program} should be
8911 used to allow the compiler to make these assumptions, which leads
8912 to more aggressive optimization decisions.
8914 When @option{-fuse-linker-plugin} is not enabled, when a file is
8915 compiled with @option{-flto}, the generated object file is larger than
8916 a regular object file because it contains GIMPLE bytecodes and the usual
8917 final code (see @option{-ffat-lto-objects}.  This means that
8918 object files with LTO information can be linked as normal object
8919 files; if @option{-fno-lto} is passed to the linker, no
8920 interprocedural optimizations are applied.  Note that when
8921 @option{-fno-fat-lto-objects} is enabled the compile stage is faster
8922 but you cannot perform a regular, non-LTO link on them.
8924 Additionally, the optimization flags used to compile individual files
8925 are not necessarily related to those used at link time.  For instance,
8927 @smallexample
8928 gcc -c -O0 -ffat-lto-objects -flto foo.c
8929 gcc -c -O0 -ffat-lto-objects -flto bar.c
8930 gcc -o myprog -O3 foo.o bar.o
8931 @end smallexample
8933 This produces individual object files with unoptimized assembler
8934 code, but the resulting binary @file{myprog} is optimized at
8935 @option{-O3}.  If, instead, the final binary is generated with
8936 @option{-fno-lto}, then @file{myprog} is not optimized.
8938 When producing the final binary, GCC only
8939 applies link-time optimizations to those files that contain bytecode.
8940 Therefore, you can mix and match object files and libraries with
8941 GIMPLE bytecodes and final object code.  GCC automatically selects
8942 which files to optimize in LTO mode and which files to link without
8943 further processing.
8945 There are some code generation flags preserved by GCC when
8946 generating bytecodes, as they need to be used during the final link
8947 stage.  Generally options specified at link time override those
8948 specified at compile time.
8950 If you do not specify an optimization level option @option{-O} at
8951 link time, then GCC uses the highest optimization level 
8952 used when compiling the object files.
8954 Currently, the following options and their settings are taken from
8955 the first object file that explicitly specifies them: 
8956 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
8957 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
8958 and all the @option{-m} target flags.
8960 Certain ABI-changing flags are required to match in all compilation units,
8961 and trying to override this at link time with a conflicting value
8962 is ignored.  This includes options such as @option{-freg-struct-return}
8963 and @option{-fpcc-struct-return}. 
8965 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
8966 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
8967 are passed through to the link stage and merged conservatively for
8968 conflicting translation units.  Specifically
8969 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
8970 precedence; and for example @option{-ffp-contract=off} takes precedence
8971 over @option{-ffp-contract=fast}.  You can override them at link time.
8973 If LTO encounters objects with C linkage declared with incompatible
8974 types in separate translation units to be linked together (undefined
8975 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
8976 issued.  The behavior is still undefined at run time.  Similar
8977 diagnostics may be raised for other languages.
8979 Another feature of LTO is that it is possible to apply interprocedural
8980 optimizations on files written in different languages:
8982 @smallexample
8983 gcc -c -flto foo.c
8984 g++ -c -flto bar.cc
8985 gfortran -c -flto baz.f90
8986 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
8987 @end smallexample
8989 Notice that the final link is done with @command{g++} to get the C++
8990 runtime libraries and @option{-lgfortran} is added to get the Fortran
8991 runtime libraries.  In general, when mixing languages in LTO mode, you
8992 should use the same link command options as when mixing languages in a
8993 regular (non-LTO) compilation.
8995 If object files containing GIMPLE bytecode are stored in a library archive, say
8996 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
8997 are using a linker with plugin support.  To create static libraries suitable
8998 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
8999 and @command{ranlib}; 
9000 to show the symbols of object files with GIMPLE bytecode, use
9001 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
9002 and @command{nm} have been compiled with plugin support.  At link time, use the the
9003 flag @option{-fuse-linker-plugin} to ensure that the library participates in
9004 the LTO optimization process:
9006 @smallexample
9007 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
9008 @end smallexample
9010 With the linker plugin enabled, the linker extracts the needed
9011 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
9012 to make them part of the aggregated GIMPLE image to be optimized.
9014 If you are not using a linker with plugin support and/or do not
9015 enable the linker plugin, then the objects inside @file{libfoo.a}
9016 are extracted and linked as usual, but they do not participate
9017 in the LTO optimization process.  In order to make a static library suitable
9018 for both LTO optimization and usual linkage, compile its object files with
9019 @option{-flto} @option{-ffat-lto-objects}.
9021 Link-time optimizations do not require the presence of the whole program to
9022 operate.  If the program does not require any symbols to be exported, it is
9023 possible to combine @option{-flto} and @option{-fwhole-program} to allow
9024 the interprocedural optimizers to use more aggressive assumptions which may
9025 lead to improved optimization opportunities.
9026 Use of @option{-fwhole-program} is not needed when linker plugin is
9027 active (see @option{-fuse-linker-plugin}).
9029 The current implementation of LTO makes no
9030 attempt to generate bytecode that is portable between different
9031 types of hosts.  The bytecode files are versioned and there is a
9032 strict version check, so bytecode files generated in one version of
9033 GCC do not work with an older or newer version of GCC.
9035 Link-time optimization does not work well with generation of debugging
9036 information.  Combining @option{-flto} with
9037 @option{-g} is currently experimental and expected to produce unexpected
9038 results.
9040 If you specify the optional @var{n}, the optimization and code
9041 generation done at link time is executed in parallel using @var{n}
9042 parallel jobs by utilizing an installed @command{make} program.  The
9043 environment variable @env{MAKE} may be used to override the program
9044 used.  The default value for @var{n} is 1.
9046 You can also specify @option{-flto=jobserver} to use GNU make's
9047 job server mode to determine the number of parallel jobs. This
9048 is useful when the Makefile calling GCC is already executing in parallel.
9049 You must prepend a @samp{+} to the command recipe in the parent Makefile
9050 for this to work.  This option likely only works if @env{MAKE} is
9051 GNU make.
9053 @item -flto-partition=@var{alg}
9054 @opindex flto-partition
9055 Specify the partitioning algorithm used by the link-time optimizer.
9056 The value is either @samp{1to1} to specify a partitioning mirroring
9057 the original source files or @samp{balanced} to specify partitioning
9058 into equally sized chunks (whenever possible) or @samp{max} to create
9059 new partition for every symbol where possible.  Specifying @samp{none}
9060 as an algorithm disables partitioning and streaming completely. 
9061 The default value is @samp{balanced}. While @samp{1to1} can be used
9062 as an workaround for various code ordering issues, the @samp{max}
9063 partitioning is intended for internal testing only.
9064 The value @samp{one} specifies that exactly one partition should be
9065 used while the value @samp{none} bypasses partitioning and executes
9066 the link-time optimization step directly from the WPA phase.
9068 @item -flto-odr-type-merging
9069 @opindex flto-odr-type-merging
9070 Enable streaming of mangled types names of C++ types and their unification
9071 at link time.  This increases size of LTO object files, but enables
9072 diagnostics about One Definition Rule violations.
9074 @item -flto-compression-level=@var{n}
9075 @opindex flto-compression-level
9076 This option specifies the level of compression used for intermediate
9077 language written to LTO object files, and is only meaningful in
9078 conjunction with LTO mode (@option{-flto}).  Valid
9079 values are 0 (no compression) to 9 (maximum compression).  Values
9080 outside this range are clamped to either 0 or 9.  If the option is not
9081 given, a default balanced compression setting is used.
9083 @item -fuse-linker-plugin
9084 @opindex fuse-linker-plugin
9085 Enables the use of a linker plugin during link-time optimization.  This
9086 option relies on plugin support in the linker, which is available in gold
9087 or in GNU ld 2.21 or newer.
9089 This option enables the extraction of object files with GIMPLE bytecode out
9090 of library archives. This improves the quality of optimization by exposing
9091 more code to the link-time optimizer.  This information specifies what
9092 symbols can be accessed externally (by non-LTO object or during dynamic
9093 linking).  Resulting code quality improvements on binaries (and shared
9094 libraries that use hidden visibility) are similar to @option{-fwhole-program}.
9095 See @option{-flto} for a description of the effect of this flag and how to
9096 use it.
9098 This option is enabled by default when LTO support in GCC is enabled
9099 and GCC was configured for use with
9100 a linker supporting plugins (GNU ld 2.21 or newer or gold).
9102 @item -ffat-lto-objects
9103 @opindex ffat-lto-objects
9104 Fat LTO objects are object files that contain both the intermediate language
9105 and the object code. This makes them usable for both LTO linking and normal
9106 linking. This option is effective only when compiling with @option{-flto}
9107 and is ignored at link time.
9109 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
9110 requires the complete toolchain to be aware of LTO. It requires a linker with
9111 linker plugin support for basic functionality.  Additionally,
9112 @command{nm}, @command{ar} and @command{ranlib}
9113 need to support linker plugins to allow a full-featured build environment
9114 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
9115 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
9116 to these tools. With non fat LTO makefiles need to be modified to use them.
9118 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
9119 support.
9121 @item -fcompare-elim
9122 @opindex fcompare-elim
9123 After register allocation and post-register allocation instruction splitting,
9124 identify arithmetic instructions that compute processor flags similar to a
9125 comparison operation based on that arithmetic.  If possible, eliminate the
9126 explicit comparison operation.
9128 This pass only applies to certain targets that cannot explicitly represent
9129 the comparison operation before register allocation is complete.
9131 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9133 @item -fcprop-registers
9134 @opindex fcprop-registers
9135 After register allocation and post-register allocation instruction splitting,
9136 perform a copy-propagation pass to try to reduce scheduling dependencies
9137 and occasionally eliminate the copy.
9139 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9141 @item -fprofile-correction
9142 @opindex fprofile-correction
9143 Profiles collected using an instrumented binary for multi-threaded programs may
9144 be inconsistent due to missed counter updates. When this option is specified,
9145 GCC uses heuristics to correct or smooth out such inconsistencies. By
9146 default, GCC emits an error message when an inconsistent profile is detected.
9148 @item -fprofile-use
9149 @itemx -fprofile-use=@var{path}
9150 @opindex fprofile-use
9151 Enable profile feedback-directed optimizations, 
9152 and the following optimizations
9153 which are generally profitable only with profile feedback available:
9154 @option{-fbranch-probabilities}, @option{-fvpt},
9155 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9156 @option{-ftree-vectorize}, and @option{ftree-loop-distribute-patterns}.
9158 Before you can use this option, you must first generate profiling information.
9159 @xref{Instrumentation Options}, for information about the
9160 @option{-fprofile-generate} option.
9162 By default, GCC emits an error message if the feedback profiles do not
9163 match the source code.  This error can be turned into a warning by using
9164 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
9165 code.
9167 If @var{path} is specified, GCC looks at the @var{path} to find
9168 the profile feedback data files. See @option{-fprofile-dir}.
9170 @item -fauto-profile
9171 @itemx -fauto-profile=@var{path}
9172 @opindex fauto-profile
9173 Enable sampling-based feedback-directed optimizations, 
9174 and the following optimizations
9175 which are generally profitable only with profile feedback available:
9176 @option{-fbranch-probabilities}, @option{-fvpt},
9177 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9178 @option{-ftree-vectorize},
9179 @option{-finline-functions}, @option{-fipa-cp}, @option{-fipa-cp-clone},
9180 @option{-fpredictive-commoning}, @option{-funswitch-loops},
9181 @option{-fgcse-after-reload}, and @option{-ftree-loop-distribute-patterns}.
9183 @var{path} is the name of a file containing AutoFDO profile information.
9184 If omitted, it defaults to @file{fbdata.afdo} in the current directory.
9186 Producing an AutoFDO profile data file requires running your program
9187 with the @command{perf} utility on a supported GNU/Linux target system.
9188 For more information, see @uref{https://perf.wiki.kernel.org/}.
9190 E.g.
9191 @smallexample
9192 perf record -e br_inst_retired:near_taken -b -o perf.data \
9193     -- your_program
9194 @end smallexample
9196 Then use the @command{create_gcov} tool to convert the raw profile data
9197 to a format that can be used by GCC.@  You must also supply the 
9198 unstripped binary for your program to this tool.  
9199 See @uref{https://github.com/google/autofdo}.
9201 E.g.
9202 @smallexample
9203 create_gcov --binary=your_program.unstripped --profile=perf.data \
9204     --gcov=profile.afdo
9205 @end smallexample
9206 @end table
9208 The following options control compiler behavior regarding floating-point 
9209 arithmetic.  These options trade off between speed and
9210 correctness.  All must be specifically enabled.
9212 @table @gcctabopt
9213 @item -ffloat-store
9214 @opindex ffloat-store
9215 Do not store floating-point variables in registers, and inhibit other
9216 options that might change whether a floating-point value is taken from a
9217 register or memory.
9219 @cindex floating-point precision
9220 This option prevents undesirable excess precision on machines such as
9221 the 68000 where the floating registers (of the 68881) keep more
9222 precision than a @code{double} is supposed to have.  Similarly for the
9223 x86 architecture.  For most programs, the excess precision does only
9224 good, but a few programs rely on the precise definition of IEEE floating
9225 point.  Use @option{-ffloat-store} for such programs, after modifying
9226 them to store all pertinent intermediate computations into variables.
9228 @item -fexcess-precision=@var{style}
9229 @opindex fexcess-precision
9230 This option allows further control over excess precision on machines
9231 where floating-point operations occur in a format with more precision or
9232 range than the IEEE standard and interchange floating-point types.  By
9233 default, @option{-fexcess-precision=fast} is in effect; this means that
9234 operations may be carried out in a wider precision than the types specified
9235 in the source if that would result in faster code, and it is unpredictable
9236 when rounding to the types specified in the source code takes place.
9237 When compiling C, if @option{-fexcess-precision=standard} is specified then
9238 excess precision follows the rules specified in ISO C99; in particular,
9239 both casts and assignments cause values to be rounded to their
9240 semantic types (whereas @option{-ffloat-store} only affects
9241 assignments).  This option is enabled by default for C if a strict
9242 conformance option such as @option{-std=c99} is used.
9243 @option{-ffast-math} enables @option{-fexcess-precision=fast} by default
9244 regardless of whether a strict conformance option is used.
9246 @opindex mfpmath
9247 @option{-fexcess-precision=standard} is not implemented for languages
9248 other than C.  On the x86, it has no effect if @option{-mfpmath=sse}
9249 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
9250 semantics apply without excess precision, and in the latter, rounding
9251 is unpredictable.
9253 @item -ffast-math
9254 @opindex ffast-math
9255 Sets the options @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
9256 @option{-ffinite-math-only}, @option{-fno-rounding-math},
9257 @option{-fno-signaling-nans}, @option{-fcx-limited-range} and
9258 @option{-fexcess-precision=fast}.
9260 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
9262 This option is not turned on by any @option{-O} option besides
9263 @option{-Ofast} since it can result in incorrect output for programs
9264 that depend on an exact implementation of IEEE or ISO rules/specifications
9265 for math functions. It may, however, yield faster code for programs
9266 that do not require the guarantees of these specifications.
9268 @item -fno-math-errno
9269 @opindex fno-math-errno
9270 Do not set @code{errno} after calling math functions that are executed
9271 with a single instruction, e.g., @code{sqrt}.  A program that relies on
9272 IEEE exceptions for math error handling may want to use this flag
9273 for speed while maintaining IEEE arithmetic compatibility.
9275 This option is not turned on by any @option{-O} option since
9276 it can result in incorrect output for programs that depend on
9277 an exact implementation of IEEE or ISO rules/specifications for
9278 math functions. It may, however, yield faster code for programs
9279 that do not require the guarantees of these specifications.
9281 The default is @option{-fmath-errno}.
9283 On Darwin systems, the math library never sets @code{errno}.  There is
9284 therefore no reason for the compiler to consider the possibility that
9285 it might, and @option{-fno-math-errno} is the default.
9287 @item -funsafe-math-optimizations
9288 @opindex funsafe-math-optimizations
9290 Allow optimizations for floating-point arithmetic that (a) assume
9291 that arguments and results are valid and (b) may violate IEEE or
9292 ANSI standards.  When used at link time, it may include libraries
9293 or startup files that change the default FPU control word or other
9294 similar optimizations.
9296 This option is not turned on by any @option{-O} option since
9297 it can result in incorrect output for programs that depend on
9298 an exact implementation of IEEE or ISO rules/specifications for
9299 math functions. It may, however, yield faster code for programs
9300 that do not require the guarantees of these specifications.
9301 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
9302 @option{-fassociative-math} and @option{-freciprocal-math}.
9304 The default is @option{-fno-unsafe-math-optimizations}.
9306 @item -fassociative-math
9307 @opindex fassociative-math
9309 Allow re-association of operands in series of floating-point operations.
9310 This violates the ISO C and C++ language standard by possibly changing
9311 computation result.  NOTE: re-ordering may change the sign of zero as
9312 well as ignore NaNs and inhibit or create underflow or overflow (and
9313 thus cannot be used on code that relies on rounding behavior like
9314 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
9315 and thus may not be used when ordered comparisons are required.
9316 This option requires that both @option{-fno-signed-zeros} and
9317 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
9318 much sense with @option{-frounding-math}. For Fortran the option
9319 is automatically enabled when both @option{-fno-signed-zeros} and
9320 @option{-fno-trapping-math} are in effect.
9322 The default is @option{-fno-associative-math}.
9324 @item -freciprocal-math
9325 @opindex freciprocal-math
9327 Allow the reciprocal of a value to be used instead of dividing by
9328 the value if this enables optimizations.  For example @code{x / y}
9329 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
9330 is subject to common subexpression elimination.  Note that this loses
9331 precision and increases the number of flops operating on the value.
9333 The default is @option{-fno-reciprocal-math}.
9335 @item -ffinite-math-only
9336 @opindex ffinite-math-only
9337 Allow optimizations for floating-point arithmetic that assume
9338 that arguments and results are not NaNs or +-Infs.
9340 This option is not turned on by any @option{-O} option since
9341 it can result in incorrect output for programs that depend on
9342 an exact implementation of IEEE or ISO rules/specifications for
9343 math functions. It may, however, yield faster code for programs
9344 that do not require the guarantees of these specifications.
9346 The default is @option{-fno-finite-math-only}.
9348 @item -fno-signed-zeros
9349 @opindex fno-signed-zeros
9350 Allow optimizations for floating-point arithmetic that ignore the
9351 signedness of zero.  IEEE arithmetic specifies the behavior of
9352 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
9353 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
9354 This option implies that the sign of a zero result isn't significant.
9356 The default is @option{-fsigned-zeros}.
9358 @item -fno-trapping-math
9359 @opindex fno-trapping-math
9360 Compile code assuming that floating-point operations cannot generate
9361 user-visible traps.  These traps include division by zero, overflow,
9362 underflow, inexact result and invalid operation.  This option requires
9363 that @option{-fno-signaling-nans} be in effect.  Setting this option may
9364 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
9366 This option should never be turned on by any @option{-O} option since
9367 it can result in incorrect output for programs that depend on
9368 an exact implementation of IEEE or ISO rules/specifications for
9369 math functions.
9371 The default is @option{-ftrapping-math}.
9373 @item -frounding-math
9374 @opindex frounding-math
9375 Disable transformations and optimizations that assume default floating-point
9376 rounding behavior.  This is round-to-zero for all floating point
9377 to integer conversions, and round-to-nearest for all other arithmetic
9378 truncations.  This option should be specified for programs that change
9379 the FP rounding mode dynamically, or that may be executed with a
9380 non-default rounding mode.  This option disables constant folding of
9381 floating-point expressions at compile time (which may be affected by
9382 rounding mode) and arithmetic transformations that are unsafe in the
9383 presence of sign-dependent rounding modes.
9385 The default is @option{-fno-rounding-math}.
9387 This option is experimental and does not currently guarantee to
9388 disable all GCC optimizations that are affected by rounding mode.
9389 Future versions of GCC may provide finer control of this setting
9390 using C99's @code{FENV_ACCESS} pragma.  This command-line option
9391 will be used to specify the default state for @code{FENV_ACCESS}.
9393 @item -fsignaling-nans
9394 @opindex fsignaling-nans
9395 Compile code assuming that IEEE signaling NaNs may generate user-visible
9396 traps during floating-point operations.  Setting this option disables
9397 optimizations that may change the number of exceptions visible with
9398 signaling NaNs.  This option implies @option{-ftrapping-math}.
9400 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
9401 be defined.
9403 The default is @option{-fno-signaling-nans}.
9405 This option is experimental and does not currently guarantee to
9406 disable all GCC optimizations that affect signaling NaN behavior.
9408 @item -fno-fp-int-builtin-inexact
9409 @opindex fno-fp-int-builtin-inexact
9410 Do not allow the built-in functions @code{ceil}, @code{floor},
9411 @code{round} and @code{trunc}, and their @code{float} and @code{long
9412 double} variants, to generate code that raises the ``inexact''
9413 floating-point exception for noninteger arguments.  ISO C99 and C11
9414 allow these functions to raise the ``inexact'' exception, but ISO/IEC
9415 TS 18661-1:2014, the C bindings to IEEE 754-2008, does not allow these
9416 functions to do so.
9418 The default is @option{-ffp-int-builtin-inexact}, allowing the
9419 exception to be raised.  This option does nothing unless
9420 @option{-ftrapping-math} is in effect.
9422 Even if @option{-fno-fp-int-builtin-inexact} is used, if the functions
9423 generate a call to a library function then the ``inexact'' exception
9424 may be raised if the library implementation does not follow TS 18661.
9426 @item -fsingle-precision-constant
9427 @opindex fsingle-precision-constant
9428 Treat floating-point constants as single precision instead of
9429 implicitly converting them to double-precision constants.
9431 @item -fcx-limited-range
9432 @opindex fcx-limited-range
9433 When enabled, this option states that a range reduction step is not
9434 needed when performing complex division.  Also, there is no checking
9435 whether the result of a complex multiplication or division is @code{NaN
9436 + I*NaN}, with an attempt to rescue the situation in that case.  The
9437 default is @option{-fno-cx-limited-range}, but is enabled by
9438 @option{-ffast-math}.
9440 This option controls the default setting of the ISO C99
9441 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
9442 all languages.
9444 @item -fcx-fortran-rules
9445 @opindex fcx-fortran-rules
9446 Complex multiplication and division follow Fortran rules.  Range
9447 reduction is done as part of complex division, but there is no checking
9448 whether the result of a complex multiplication or division is @code{NaN
9449 + I*NaN}, with an attempt to rescue the situation in that case.
9451 The default is @option{-fno-cx-fortran-rules}.
9453 @end table
9455 The following options control optimizations that may improve
9456 performance, but are not enabled by any @option{-O} options.  This
9457 section includes experimental options that may produce broken code.
9459 @table @gcctabopt
9460 @item -fbranch-probabilities
9461 @opindex fbranch-probabilities
9462 After running a program compiled with @option{-fprofile-arcs}
9463 (@pxref{Instrumentation Options}),
9464 you can compile it a second time using
9465 @option{-fbranch-probabilities}, to improve optimizations based on
9466 the number of times each branch was taken.  When a program
9467 compiled with @option{-fprofile-arcs} exits, it saves arc execution
9468 counts to a file called @file{@var{sourcename}.gcda} for each source
9469 file.  The information in this data file is very dependent on the
9470 structure of the generated code, so you must use the same source code
9471 and the same optimization options for both compilations.
9473 With @option{-fbranch-probabilities}, GCC puts a
9474 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
9475 These can be used to improve optimization.  Currently, they are only
9476 used in one place: in @file{reorg.c}, instead of guessing which path a
9477 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
9478 exactly determine which path is taken more often.
9480 @item -fprofile-values
9481 @opindex fprofile-values
9482 If combined with @option{-fprofile-arcs}, it adds code so that some
9483 data about values of expressions in the program is gathered.
9485 With @option{-fbranch-probabilities}, it reads back the data gathered
9486 from profiling values of expressions for usage in optimizations.
9488 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
9490 @item -fprofile-reorder-functions
9491 @opindex fprofile-reorder-functions
9492 Function reordering based on profile instrumentation collects
9493 first time of execution of a function and orders these functions
9494 in ascending order.
9496 Enabled with @option{-fprofile-use}.
9498 @item -fvpt
9499 @opindex fvpt
9500 If combined with @option{-fprofile-arcs}, this option instructs the compiler
9501 to add code to gather information about values of expressions.
9503 With @option{-fbranch-probabilities}, it reads back the data gathered
9504 and actually performs the optimizations based on them.
9505 Currently the optimizations include specialization of division operations
9506 using the knowledge about the value of the denominator.
9508 @item -frename-registers
9509 @opindex frename-registers
9510 Attempt to avoid false dependencies in scheduled code by making use
9511 of registers left over after register allocation.  This optimization
9512 most benefits processors with lots of registers.  Depending on the
9513 debug information format adopted by the target, however, it can
9514 make debugging impossible, since variables no longer stay in
9515 a ``home register''.
9517 Enabled by default with @option{-funroll-loops}.
9519 @item -fschedule-fusion
9520 @opindex fschedule-fusion
9521 Performs a target dependent pass over the instruction stream to schedule
9522 instructions of same type together because target machine can execute them
9523 more efficiently if they are adjacent to each other in the instruction flow.
9525 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9527 @item -ftracer
9528 @opindex ftracer
9529 Perform tail duplication to enlarge superblock size.  This transformation
9530 simplifies the control flow of the function allowing other optimizations to do
9531 a better job.
9533 Enabled with @option{-fprofile-use}.
9535 @item -funroll-loops
9536 @opindex funroll-loops
9537 Unroll loops whose number of iterations can be determined at compile time or
9538 upon entry to the loop.  @option{-funroll-loops} implies
9539 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
9540 It also turns on complete loop peeling (i.e.@: complete removal of loops with
9541 a small constant number of iterations).  This option makes code larger, and may
9542 or may not make it run faster.
9544 Enabled with @option{-fprofile-use}.
9546 @item -funroll-all-loops
9547 @opindex funroll-all-loops
9548 Unroll all loops, even if their number of iterations is uncertain when
9549 the loop is entered.  This usually makes programs run more slowly.
9550 @option{-funroll-all-loops} implies the same options as
9551 @option{-funroll-loops}.
9553 @item -fpeel-loops
9554 @opindex fpeel-loops
9555 Peels loops for which there is enough information that they do not
9556 roll much (from profile feedback or static analysis).  It also turns on
9557 complete loop peeling (i.e.@: complete removal of loops with small constant
9558 number of iterations).
9560 Enabled with @option{-O3} and/or @option{-fprofile-use}.
9562 @item -fmove-loop-invariants
9563 @opindex fmove-loop-invariants
9564 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
9565 at level @option{-O1}
9567 @item -fsplit-loops
9568 @opindex fsplit-loops
9569 Split a loop into two if it contains a condition that's always true
9570 for one side of the iteration space and false for the other.
9572 @item -funswitch-loops
9573 @opindex funswitch-loops
9574 Move branches with loop invariant conditions out of the loop, with duplicates
9575 of the loop on both branches (modified according to result of the condition).
9577 @item -ffunction-sections
9578 @itemx -fdata-sections
9579 @opindex ffunction-sections
9580 @opindex fdata-sections
9581 Place each function or data item into its own section in the output
9582 file if the target supports arbitrary sections.  The name of the
9583 function or the name of the data item determines the section's name
9584 in the output file.
9586 Use these options on systems where the linker can perform optimizations
9587 to improve locality of reference in the instruction space.  Most systems
9588 using the ELF object format and SPARC processors running Solaris 2 have
9589 linkers with such optimizations.  AIX may have these optimizations in
9590 the future.
9592 Only use these options when there are significant benefits from doing
9593 so.  When you specify these options, the assembler and linker
9594 create larger object and executable files and are also slower.
9595 You cannot use @command{gprof} on all systems if you
9596 specify this option, and you may have problems with debugging if
9597 you specify both this option and @option{-g}.
9599 @item -fbranch-target-load-optimize
9600 @opindex fbranch-target-load-optimize
9601 Perform branch target register load optimization before prologue / epilogue
9602 threading.
9603 The use of target registers can typically be exposed only during reload,
9604 thus hoisting loads out of loops and doing inter-block scheduling needs
9605 a separate optimization pass.
9607 @item -fbranch-target-load-optimize2
9608 @opindex fbranch-target-load-optimize2
9609 Perform branch target register load optimization after prologue / epilogue
9610 threading.
9612 @item -fbtr-bb-exclusive
9613 @opindex fbtr-bb-exclusive
9614 When performing branch target register load optimization, don't reuse
9615 branch target registers within any basic block.
9617 @item -fstdarg-opt
9618 @opindex fstdarg-opt
9619 Optimize the prologue of variadic argument functions with respect to usage of
9620 those arguments.
9622 @item -fsection-anchors
9623 @opindex fsection-anchors
9624 Try to reduce the number of symbolic address calculations by using
9625 shared ``anchor'' symbols to address nearby objects.  This transformation
9626 can help to reduce the number of GOT entries and GOT accesses on some
9627 targets.
9629 For example, the implementation of the following function @code{foo}:
9631 @smallexample
9632 static int a, b, c;
9633 int foo (void) @{ return a + b + c; @}
9634 @end smallexample
9636 @noindent
9637 usually calculates the addresses of all three variables, but if you
9638 compile it with @option{-fsection-anchors}, it accesses the variables
9639 from a common anchor point instead.  The effect is similar to the
9640 following pseudocode (which isn't valid C):
9642 @smallexample
9643 int foo (void)
9645   register int *xr = &x;
9646   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
9648 @end smallexample
9650 Not all targets support this option.
9652 @item --param @var{name}=@var{value}
9653 @opindex param
9654 In some places, GCC uses various constants to control the amount of
9655 optimization that is done.  For example, GCC does not inline functions
9656 that contain more than a certain number of instructions.  You can
9657 control some of these constants on the command line using the
9658 @option{--param} option.
9660 The names of specific parameters, and the meaning of the values, are
9661 tied to the internals of the compiler, and are subject to change
9662 without notice in future releases.
9664 In each case, the @var{value} is an integer.  The allowable choices for
9665 @var{name} are:
9667 @table @gcctabopt
9668 @item predictable-branch-outcome
9669 When branch is predicted to be taken with probability lower than this threshold
9670 (in percent), then it is considered well predictable. The default is 10.
9672 @item max-rtl-if-conversion-insns
9673 RTL if-conversion tries to remove conditional branches around a block and
9674 replace them with conditionally executed instructions.  This parameter
9675 gives the maximum number of instructions in a block which should be
9676 considered for if-conversion.  The default is 10, though the compiler will
9677 also use other heuristics to decide whether if-conversion is likely to be
9678 profitable.
9680 @item max-rtl-if-conversion-predictable-cost
9681 @item max-rtl-if-conversion-unpredictable-cost
9682 RTL if-conversion will try to remove conditional branches around a block
9683 and replace them with conditionally executed instructions.  These parameters
9684 give the maximum permissible cost for the sequence that would be generated
9685 by if-conversion depending on whether the branch is statically determined
9686 to be predictable or not.  The units for this parameter are the same as
9687 those for the GCC internal seq_cost metric.  The compiler will try to
9688 provide a reasonable default for this parameter using the BRANCH_COST
9689 target macro.
9691 @item max-crossjump-edges
9692 The maximum number of incoming edges to consider for cross-jumping.
9693 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
9694 the number of edges incoming to each block.  Increasing values mean
9695 more aggressive optimization, making the compilation time increase with
9696 probably small improvement in executable size.
9698 @item min-crossjump-insns
9699 The minimum number of instructions that must be matched at the end
9700 of two blocks before cross-jumping is performed on them.  This
9701 value is ignored in the case where all instructions in the block being
9702 cross-jumped from are matched.  The default value is 5.
9704 @item max-grow-copy-bb-insns
9705 The maximum code size expansion factor when copying basic blocks
9706 instead of jumping.  The expansion is relative to a jump instruction.
9707 The default value is 8.
9709 @item max-goto-duplication-insns
9710 The maximum number of instructions to duplicate to a block that jumps
9711 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
9712 passes, GCC factors computed gotos early in the compilation process,
9713 and unfactors them as late as possible.  Only computed jumps at the
9714 end of a basic blocks with no more than max-goto-duplication-insns are
9715 unfactored.  The default value is 8.
9717 @item max-delay-slot-insn-search
9718 The maximum number of instructions to consider when looking for an
9719 instruction to fill a delay slot.  If more than this arbitrary number of
9720 instructions are searched, the time savings from filling the delay slot
9721 are minimal, so stop searching.  Increasing values mean more
9722 aggressive optimization, making the compilation time increase with probably
9723 small improvement in execution time.
9725 @item max-delay-slot-live-search
9726 When trying to fill delay slots, the maximum number of instructions to
9727 consider when searching for a block with valid live register
9728 information.  Increasing this arbitrarily chosen value means more
9729 aggressive optimization, increasing the compilation time.  This parameter
9730 should be removed when the delay slot code is rewritten to maintain the
9731 control-flow graph.
9733 @item max-gcse-memory
9734 The approximate maximum amount of memory that can be allocated in
9735 order to perform the global common subexpression elimination
9736 optimization.  If more memory than specified is required, the
9737 optimization is not done.
9739 @item max-gcse-insertion-ratio
9740 If the ratio of expression insertions to deletions is larger than this value
9741 for any expression, then RTL PRE inserts or removes the expression and thus
9742 leaves partially redundant computations in the instruction stream.  The default value is 20.
9744 @item max-pending-list-length
9745 The maximum number of pending dependencies scheduling allows
9746 before flushing the current state and starting over.  Large functions
9747 with few branches or calls can create excessively large lists which
9748 needlessly consume memory and resources.
9750 @item max-modulo-backtrack-attempts
9751 The maximum number of backtrack attempts the scheduler should make
9752 when modulo scheduling a loop.  Larger values can exponentially increase
9753 compilation time.
9755 @item max-inline-insns-single
9756 Several parameters control the tree inliner used in GCC@.
9757 This number sets the maximum number of instructions (counted in GCC's
9758 internal representation) in a single function that the tree inliner
9759 considers for inlining.  This only affects functions declared
9760 inline and methods implemented in a class declaration (C++).
9761 The default value is 400.
9763 @item max-inline-insns-auto
9764 When you use @option{-finline-functions} (included in @option{-O3}),
9765 a lot of functions that would otherwise not be considered for inlining
9766 by the compiler are investigated.  To those functions, a different
9767 (more restrictive) limit compared to functions declared inline can
9768 be applied.
9769 The default value is 40.
9771 @item inline-min-speedup
9772 When estimated performance improvement of caller + callee runtime exceeds this
9773 threshold (in percent), the function can be inlined regardless of the limit on
9774 @option{--param max-inline-insns-single} and @option{--param
9775 max-inline-insns-auto}.
9777 @item large-function-insns
9778 The limit specifying really large functions.  For functions larger than this
9779 limit after inlining, inlining is constrained by
9780 @option{--param large-function-growth}.  This parameter is useful primarily
9781 to avoid extreme compilation time caused by non-linear algorithms used by the
9782 back end.
9783 The default value is 2700.
9785 @item large-function-growth
9786 Specifies maximal growth of large function caused by inlining in percents.
9787 The default value is 100 which limits large function growth to 2.0 times
9788 the original size.
9790 @item large-unit-insns
9791 The limit specifying large translation unit.  Growth caused by inlining of
9792 units larger than this limit is limited by @option{--param inline-unit-growth}.
9793 For small units this might be too tight.
9794 For example, consider a unit consisting of function A
9795 that is inline and B that just calls A three times.  If B is small relative to
9796 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
9797 large units consisting of small inlineable functions, however, the overall unit
9798 growth limit is needed to avoid exponential explosion of code size.  Thus for
9799 smaller units, the size is increased to @option{--param large-unit-insns}
9800 before applying @option{--param inline-unit-growth}.  The default is 10000.
9802 @item inline-unit-growth
9803 Specifies maximal overall growth of the compilation unit caused by inlining.
9804 The default value is 20 which limits unit growth to 1.2 times the original
9805 size. Cold functions (either marked cold via an attribute or by profile
9806 feedback) are not accounted into the unit size.
9808 @item ipcp-unit-growth
9809 Specifies maximal overall growth of the compilation unit caused by
9810 interprocedural constant propagation.  The default value is 10 which limits
9811 unit growth to 1.1 times the original size.
9813 @item large-stack-frame
9814 The limit specifying large stack frames.  While inlining the algorithm is trying
9815 to not grow past this limit too much.  The default value is 256 bytes.
9817 @item large-stack-frame-growth
9818 Specifies maximal growth of large stack frames caused by inlining in percents.
9819 The default value is 1000 which limits large stack frame growth to 11 times
9820 the original size.
9822 @item max-inline-insns-recursive
9823 @itemx max-inline-insns-recursive-auto
9824 Specifies the maximum number of instructions an out-of-line copy of a
9825 self-recursive inline
9826 function can grow into by performing recursive inlining.
9828 @option{--param max-inline-insns-recursive} applies to functions
9829 declared inline.
9830 For functions not declared inline, recursive inlining
9831 happens only when @option{-finline-functions} (included in @option{-O3}) is
9832 enabled; @option{--param max-inline-insns-recursive-auto} applies instead.  The
9833 default value is 450.
9835 @item max-inline-recursive-depth
9836 @itemx max-inline-recursive-depth-auto
9837 Specifies the maximum recursion depth used for recursive inlining.
9839 @option{--param max-inline-recursive-depth} applies to functions
9840 declared inline.  For functions not declared inline, recursive inlining
9841 happens only when @option{-finline-functions} (included in @option{-O3}) is
9842 enabled; @option{--param max-inline-recursive-depth-auto} applies instead.  The
9843 default value is 8.
9845 @item min-inline-recursive-probability
9846 Recursive inlining is profitable only for function having deep recursion
9847 in average and can hurt for function having little recursion depth by
9848 increasing the prologue size or complexity of function body to other
9849 optimizers.
9851 When profile feedback is available (see @option{-fprofile-generate}) the actual
9852 recursion depth can be guessed from the probability that function recurses
9853 via a given call expression.  This parameter limits inlining only to call
9854 expressions whose probability exceeds the given threshold (in percents).
9855 The default value is 10.
9857 @item early-inlining-insns
9858 Specify growth that the early inliner can make.  In effect it increases
9859 the amount of inlining for code having a large abstraction penalty.
9860 The default value is 14.
9862 @item max-early-inliner-iterations
9863 Limit of iterations of the early inliner.  This basically bounds
9864 the number of nested indirect calls the early inliner can resolve.
9865 Deeper chains are still handled by late inlining.
9867 @item comdat-sharing-probability
9868 Probability (in percent) that C++ inline function with comdat visibility
9869 are shared across multiple compilation units.  The default value is 20.
9871 @item profile-func-internal-id
9872 A parameter to control whether to use function internal id in profile
9873 database lookup. If the value is 0, the compiler uses an id that
9874 is based on function assembler name and filename, which makes old profile
9875 data more tolerant to source changes such as function reordering etc.
9876 The default value is 0.
9878 @item min-vect-loop-bound
9879 The minimum number of iterations under which loops are not vectorized
9880 when @option{-ftree-vectorize} is used.  The number of iterations after
9881 vectorization needs to be greater than the value specified by this option
9882 to allow vectorization.  The default value is 0.
9884 @item gcse-cost-distance-ratio
9885 Scaling factor in calculation of maximum distance an expression
9886 can be moved by GCSE optimizations.  This is currently supported only in the
9887 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
9888 is with simple expressions, i.e., the expressions that have cost
9889 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
9890 hoisting of simple expressions.  The default value is 10.
9892 @item gcse-unrestricted-cost
9893 Cost, roughly measured as the cost of a single typical machine
9894 instruction, at which GCSE optimizations do not constrain
9895 the distance an expression can travel.  This is currently
9896 supported only in the code hoisting pass.  The lesser the cost,
9897 the more aggressive code hoisting is.  Specifying 0 
9898 allows all expressions to travel unrestricted distances.
9899 The default value is 3.
9901 @item max-hoist-depth
9902 The depth of search in the dominator tree for expressions to hoist.
9903 This is used to avoid quadratic behavior in hoisting algorithm.
9904 The value of 0 does not limit on the search, but may slow down compilation
9905 of huge functions.  The default value is 30.
9907 @item max-tail-merge-comparisons
9908 The maximum amount of similar bbs to compare a bb with.  This is used to
9909 avoid quadratic behavior in tree tail merging.  The default value is 10.
9911 @item max-tail-merge-iterations
9912 The maximum amount of iterations of the pass over the function.  This is used to
9913 limit compilation time in tree tail merging.  The default value is 2.
9915 @item store-merging-allow-unaligned
9916 Allow the store merging pass to introduce unaligned stores if it is legal to
9917 do so.  The default value is 1.
9919 @item max-stores-to-merge
9920 The maximum number of stores to attempt to merge into wider stores in the store
9921 merging pass.  The minimum value is 2 and the default is 64.
9923 @item max-unrolled-insns
9924 The maximum number of instructions that a loop may have to be unrolled.
9925 If a loop is unrolled, this parameter also determines how many times
9926 the loop code is unrolled.
9928 @item max-average-unrolled-insns
9929 The maximum number of instructions biased by probabilities of their execution
9930 that a loop may have to be unrolled.  If a loop is unrolled,
9931 this parameter also determines how many times the loop code is unrolled.
9933 @item max-unroll-times
9934 The maximum number of unrollings of a single loop.
9936 @item max-peeled-insns
9937 The maximum number of instructions that a loop may have to be peeled.
9938 If a loop is peeled, this parameter also determines how many times
9939 the loop code is peeled.
9941 @item max-peel-times
9942 The maximum number of peelings of a single loop.
9944 @item max-peel-branches
9945 The maximum number of branches on the hot path through the peeled sequence.
9947 @item max-completely-peeled-insns
9948 The maximum number of insns of a completely peeled loop.
9950 @item max-completely-peel-times
9951 The maximum number of iterations of a loop to be suitable for complete peeling.
9953 @item max-completely-peel-loop-nest-depth
9954 The maximum depth of a loop nest suitable for complete peeling.
9956 @item max-unswitch-insns
9957 The maximum number of insns of an unswitched loop.
9959 @item max-unswitch-level
9960 The maximum number of branches unswitched in a single loop.
9962 @item max-loop-headers-insns
9963 The maximum number of insns in loop header duplicated by the copy loop headers
9964 pass.
9966 @item lim-expensive
9967 The minimum cost of an expensive expression in the loop invariant motion.
9969 @item iv-consider-all-candidates-bound
9970 Bound on number of candidates for induction variables, below which
9971 all candidates are considered for each use in induction variable
9972 optimizations.  If there are more candidates than this,
9973 only the most relevant ones are considered to avoid quadratic time complexity.
9975 @item iv-max-considered-uses
9976 The induction variable optimizations give up on loops that contain more
9977 induction variable uses.
9979 @item iv-always-prune-cand-set-bound
9980 If the number of candidates in the set is smaller than this value,
9981 always try to remove unnecessary ivs from the set
9982 when adding a new one.
9984 @item avg-loop-niter
9985 Average number of iterations of a loop.
9987 @item dse-max-object-size
9988 Maximum size (in bytes) of objects tracked bytewise by dead store elimination.
9989 Larger values may result in larger compilation times.
9991 @item scev-max-expr-size
9992 Bound on size of expressions used in the scalar evolutions analyzer.
9993 Large expressions slow the analyzer.
9995 @item scev-max-expr-complexity
9996 Bound on the complexity of the expressions in the scalar evolutions analyzer.
9997 Complex expressions slow the analyzer.
9999 @item max-tree-if-conversion-phi-args
10000 Maximum number of arguments in a PHI supported by TREE if conversion
10001 unless the loop is marked with simd pragma.
10003 @item vect-max-version-for-alignment-checks
10004 The maximum number of run-time checks that can be performed when
10005 doing loop versioning for alignment in the vectorizer.
10007 @item vect-max-version-for-alias-checks
10008 The maximum number of run-time checks that can be performed when
10009 doing loop versioning for alias in the vectorizer.
10011 @item vect-max-peeling-for-alignment
10012 The maximum number of loop peels to enhance access alignment
10013 for vectorizer. Value -1 means no limit.
10015 @item max-iterations-to-track
10016 The maximum number of iterations of a loop the brute-force algorithm
10017 for analysis of the number of iterations of the loop tries to evaluate.
10019 @item hot-bb-count-ws-permille
10020 A basic block profile count is considered hot if it contributes to 
10021 the given permillage (i.e. 0...1000) of the entire profiled execution.
10023 @item hot-bb-frequency-fraction
10024 Select fraction of the entry block frequency of executions of basic block in
10025 function given basic block needs to have to be considered hot.
10027 @item max-predicted-iterations
10028 The maximum number of loop iterations we predict statically.  This is useful
10029 in cases where a function contains a single loop with known bound and
10030 another loop with unknown bound.
10031 The known number of iterations is predicted correctly, while
10032 the unknown number of iterations average to roughly 10.  This means that the
10033 loop without bounds appears artificially cold relative to the other one.
10035 @item builtin-expect-probability
10036 Control the probability of the expression having the specified value. This
10037 parameter takes a percentage (i.e. 0 ... 100) as input.
10038 The default probability of 90 is obtained empirically.
10040 @item align-threshold
10042 Select fraction of the maximal frequency of executions of a basic block in
10043 a function to align the basic block.
10045 @item align-loop-iterations
10047 A loop expected to iterate at least the selected number of iterations is
10048 aligned.
10050 @item tracer-dynamic-coverage
10051 @itemx tracer-dynamic-coverage-feedback
10053 This value is used to limit superblock formation once the given percentage of
10054 executed instructions is covered.  This limits unnecessary code size
10055 expansion.
10057 The @option{tracer-dynamic-coverage-feedback} parameter
10058 is used only when profile
10059 feedback is available.  The real profiles (as opposed to statically estimated
10060 ones) are much less balanced allowing the threshold to be larger value.
10062 @item tracer-max-code-growth
10063 Stop tail duplication once code growth has reached given percentage.  This is
10064 a rather artificial limit, as most of the duplicates are eliminated later in
10065 cross jumping, so it may be set to much higher values than is the desired code
10066 growth.
10068 @item tracer-min-branch-ratio
10070 Stop reverse growth when the reverse probability of best edge is less than this
10071 threshold (in percent).
10073 @item tracer-min-branch-probability
10074 @itemx tracer-min-branch-probability-feedback
10076 Stop forward growth if the best edge has probability lower than this
10077 threshold.
10079 Similarly to @option{tracer-dynamic-coverage} two parameters are
10080 provided.  @option{tracer-min-branch-probability-feedback} is used for
10081 compilation with profile feedback and @option{tracer-min-branch-probability}
10082 compilation without.  The value for compilation with profile feedback
10083 needs to be more conservative (higher) in order to make tracer
10084 effective.
10086 @item max-cse-path-length
10088 The maximum number of basic blocks on path that CSE considers.
10089 The default is 10.
10091 @item max-cse-insns
10092 The maximum number of instructions CSE processes before flushing.
10093 The default is 1000.
10095 @item ggc-min-expand
10097 GCC uses a garbage collector to manage its own memory allocation.  This
10098 parameter specifies the minimum percentage by which the garbage
10099 collector's heap should be allowed to expand between collections.
10100 Tuning this may improve compilation speed; it has no effect on code
10101 generation.
10103 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
10104 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
10105 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
10106 GCC is not able to calculate RAM on a particular platform, the lower
10107 bound of 30% is used.  Setting this parameter and
10108 @option{ggc-min-heapsize} to zero causes a full collection to occur at
10109 every opportunity.  This is extremely slow, but can be useful for
10110 debugging.
10112 @item ggc-min-heapsize
10114 Minimum size of the garbage collector's heap before it begins bothering
10115 to collect garbage.  The first collection occurs after the heap expands
10116 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
10117 tuning this may improve compilation speed, and has no effect on code
10118 generation.
10120 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
10121 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
10122 with a lower bound of 4096 (four megabytes) and an upper bound of
10123 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
10124 particular platform, the lower bound is used.  Setting this parameter
10125 very large effectively disables garbage collection.  Setting this
10126 parameter and @option{ggc-min-expand} to zero causes a full collection
10127 to occur at every opportunity.
10129 @item max-reload-search-insns
10130 The maximum number of instruction reload should look backward for equivalent
10131 register.  Increasing values mean more aggressive optimization, making the
10132 compilation time increase with probably slightly better performance.
10133 The default value is 100.
10135 @item max-cselib-memory-locations
10136 The maximum number of memory locations cselib should take into account.
10137 Increasing values mean more aggressive optimization, making the compilation time
10138 increase with probably slightly better performance.  The default value is 500.
10140 @item max-sched-ready-insns
10141 The maximum number of instructions ready to be issued the scheduler should
10142 consider at any given time during the first scheduling pass.  Increasing
10143 values mean more thorough searches, making the compilation time increase
10144 with probably little benefit.  The default value is 100.
10146 @item max-sched-region-blocks
10147 The maximum number of blocks in a region to be considered for
10148 interblock scheduling.  The default value is 10.
10150 @item max-pipeline-region-blocks
10151 The maximum number of blocks in a region to be considered for
10152 pipelining in the selective scheduler.  The default value is 15.
10154 @item max-sched-region-insns
10155 The maximum number of insns in a region to be considered for
10156 interblock scheduling.  The default value is 100.
10158 @item max-pipeline-region-insns
10159 The maximum number of insns in a region to be considered for
10160 pipelining in the selective scheduler.  The default value is 200.
10162 @item min-spec-prob
10163 The minimum probability (in percents) of reaching a source block
10164 for interblock speculative scheduling.  The default value is 40.
10166 @item max-sched-extend-regions-iters
10167 The maximum number of iterations through CFG to extend regions.
10168 A value of 0 (the default) disables region extensions.
10170 @item max-sched-insn-conflict-delay
10171 The maximum conflict delay for an insn to be considered for speculative motion.
10172 The default value is 3.
10174 @item sched-spec-prob-cutoff
10175 The minimal probability of speculation success (in percents), so that
10176 speculative insns are scheduled.
10177 The default value is 40.
10179 @item sched-state-edge-prob-cutoff
10180 The minimum probability an edge must have for the scheduler to save its
10181 state across it.
10182 The default value is 10.
10184 @item sched-mem-true-dep-cost
10185 Minimal distance (in CPU cycles) between store and load targeting same
10186 memory locations.  The default value is 1.
10188 @item selsched-max-lookahead
10189 The maximum size of the lookahead window of selective scheduling.  It is a
10190 depth of search for available instructions.
10191 The default value is 50.
10193 @item selsched-max-sched-times
10194 The maximum number of times that an instruction is scheduled during
10195 selective scheduling.  This is the limit on the number of iterations
10196 through which the instruction may be pipelined.  The default value is 2.
10198 @item selsched-insns-to-rename
10199 The maximum number of best instructions in the ready list that are considered
10200 for renaming in the selective scheduler.  The default value is 2.
10202 @item sms-min-sc
10203 The minimum value of stage count that swing modulo scheduler
10204 generates.  The default value is 2.
10206 @item max-last-value-rtl
10207 The maximum size measured as number of RTLs that can be recorded in an expression
10208 in combiner for a pseudo register as last known value of that register.  The default
10209 is 10000.
10211 @item max-combine-insns
10212 The maximum number of instructions the RTL combiner tries to combine.
10213 The default value is 2 at @option{-Og} and 4 otherwise.
10215 @item integer-share-limit
10216 Small integer constants can use a shared data structure, reducing the
10217 compiler's memory usage and increasing its speed.  This sets the maximum
10218 value of a shared integer constant.  The default value is 256.
10220 @item ssp-buffer-size
10221 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
10222 protection when @option{-fstack-protection} is used.
10224 @item min-size-for-stack-sharing
10225 The minimum size of variables taking part in stack slot sharing when not
10226 optimizing. The default value is 32.
10228 @item max-jump-thread-duplication-stmts
10229 Maximum number of statements allowed in a block that needs to be
10230 duplicated when threading jumps.
10232 @item max-fields-for-field-sensitive
10233 Maximum number of fields in a structure treated in
10234 a field sensitive manner during pointer analysis.  The default is zero
10235 for @option{-O0} and @option{-O1},
10236 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
10238 @item prefetch-latency
10239 Estimate on average number of instructions that are executed before
10240 prefetch finishes.  The distance prefetched ahead is proportional
10241 to this constant.  Increasing this number may also lead to less
10242 streams being prefetched (see @option{simultaneous-prefetches}).
10244 @item simultaneous-prefetches
10245 Maximum number of prefetches that can run at the same time.
10247 @item l1-cache-line-size
10248 The size of cache line in L1 cache, in bytes.
10250 @item l1-cache-size
10251 The size of L1 cache, in kilobytes.
10253 @item l2-cache-size
10254 The size of L2 cache, in kilobytes.
10256 @item min-insn-to-prefetch-ratio
10257 The minimum ratio between the number of instructions and the
10258 number of prefetches to enable prefetching in a loop.
10260 @item prefetch-min-insn-to-mem-ratio
10261 The minimum ratio between the number of instructions and the
10262 number of memory references to enable prefetching in a loop.
10264 @item use-canonical-types
10265 Whether the compiler should use the ``canonical'' type system.  By
10266 default, this should always be 1, which uses a more efficient internal
10267 mechanism for comparing types in C++ and Objective-C++.  However, if
10268 bugs in the canonical type system are causing compilation failures,
10269 set this value to 0 to disable canonical types.
10271 @item switch-conversion-max-branch-ratio
10272 Switch initialization conversion refuses to create arrays that are
10273 bigger than @option{switch-conversion-max-branch-ratio} times the number of
10274 branches in the switch.
10276 @item max-partial-antic-length
10277 Maximum length of the partial antic set computed during the tree
10278 partial redundancy elimination optimization (@option{-ftree-pre}) when
10279 optimizing at @option{-O3} and above.  For some sorts of source code
10280 the enhanced partial redundancy elimination optimization can run away,
10281 consuming all of the memory available on the host machine.  This
10282 parameter sets a limit on the length of the sets that are computed,
10283 which prevents the runaway behavior.  Setting a value of 0 for
10284 this parameter allows an unlimited set length.
10286 @item sccvn-max-scc-size
10287 Maximum size of a strongly connected component (SCC) during SCCVN
10288 processing.  If this limit is hit, SCCVN processing for the whole
10289 function is not done and optimizations depending on it are
10290 disabled.  The default maximum SCC size is 10000.
10292 @item sccvn-max-alias-queries-per-access
10293 Maximum number of alias-oracle queries we perform when looking for
10294 redundancies for loads and stores.  If this limit is hit the search
10295 is aborted and the load or store is not considered redundant.  The
10296 number of queries is algorithmically limited to the number of
10297 stores on all paths from the load to the function entry.
10298 The default maximum number of queries is 1000.
10300 @item ira-max-loops-num
10301 IRA uses regional register allocation by default.  If a function
10302 contains more loops than the number given by this parameter, only at most
10303 the given number of the most frequently-executed loops form regions
10304 for regional register allocation.  The default value of the
10305 parameter is 100.
10307 @item ira-max-conflict-table-size 
10308 Although IRA uses a sophisticated algorithm to compress the conflict
10309 table, the table can still require excessive amounts of memory for
10310 huge functions.  If the conflict table for a function could be more
10311 than the size in MB given by this parameter, the register allocator
10312 instead uses a faster, simpler, and lower-quality
10313 algorithm that does not require building a pseudo-register conflict table.  
10314 The default value of the parameter is 2000.
10316 @item ira-loop-reserved-regs
10317 IRA can be used to evaluate more accurate register pressure in loops
10318 for decisions to move loop invariants (see @option{-O3}).  The number
10319 of available registers reserved for some other purposes is given
10320 by this parameter.  The default value of the parameter is 2, which is
10321 the minimal number of registers needed by typical instructions.
10322 This value is the best found from numerous experiments.
10324 @item lra-inheritance-ebb-probability-cutoff
10325 LRA tries to reuse values reloaded in registers in subsequent insns.
10326 This optimization is called inheritance.  EBB is used as a region to
10327 do this optimization.  The parameter defines a minimal fall-through
10328 edge probability in percentage used to add BB to inheritance EBB in
10329 LRA.  The default value of the parameter is 40.  The value was chosen
10330 from numerous runs of SPEC2000 on x86-64.
10332 @item loop-invariant-max-bbs-in-loop
10333 Loop invariant motion can be very expensive, both in compilation time and
10334 in amount of needed compile-time memory, with very large loops.  Loops
10335 with more basic blocks than this parameter won't have loop invariant
10336 motion optimization performed on them.  The default value of the
10337 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
10339 @item loop-max-datarefs-for-datadeps
10340 Building data dependencies is expensive for very large loops.  This
10341 parameter limits the number of data references in loops that are
10342 considered for data dependence analysis.  These large loops are no
10343 handled by the optimizations using loop data dependencies.
10344 The default value is 1000.
10346 @item max-vartrack-size
10347 Sets a maximum number of hash table slots to use during variable
10348 tracking dataflow analysis of any function.  If this limit is exceeded
10349 with variable tracking at assignments enabled, analysis for that
10350 function is retried without it, after removing all debug insns from
10351 the function.  If the limit is exceeded even without debug insns, var
10352 tracking analysis is completely disabled for the function.  Setting
10353 the parameter to zero makes it unlimited.
10355 @item max-vartrack-expr-depth
10356 Sets a maximum number of recursion levels when attempting to map
10357 variable names or debug temporaries to value expressions.  This trades
10358 compilation time for more complete debug information.  If this is set too
10359 low, value expressions that are available and could be represented in
10360 debug information may end up not being used; setting this higher may
10361 enable the compiler to find more complex debug expressions, but compile
10362 time and memory use may grow.  The default is 12.
10364 @item min-nondebug-insn-uid
10365 Use uids starting at this parameter for nondebug insns.  The range below
10366 the parameter is reserved exclusively for debug insns created by
10367 @option{-fvar-tracking-assignments}, but debug insns may get
10368 (non-overlapping) uids above it if the reserved range is exhausted.
10370 @item ipa-sra-ptr-growth-factor
10371 IPA-SRA replaces a pointer to an aggregate with one or more new
10372 parameters only when their cumulative size is less or equal to
10373 @option{ipa-sra-ptr-growth-factor} times the size of the original
10374 pointer parameter.
10376 @item sra-max-scalarization-size-Ospeed
10377 @item sra-max-scalarization-size-Osize
10378 The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to
10379 replace scalar parts of aggregates with uses of independent scalar
10380 variables.  These parameters control the maximum size, in storage units,
10381 of aggregate which is considered for replacement when compiling for
10382 speed
10383 (@option{sra-max-scalarization-size-Ospeed}) or size
10384 (@option{sra-max-scalarization-size-Osize}) respectively.
10386 @item tm-max-aggregate-size
10387 When making copies of thread-local variables in a transaction, this
10388 parameter specifies the size in bytes after which variables are
10389 saved with the logging functions as opposed to save/restore code
10390 sequence pairs.  This option only applies when using
10391 @option{-fgnu-tm}.
10393 @item graphite-max-nb-scop-params
10394 To avoid exponential effects in the Graphite loop transforms, the
10395 number of parameters in a Static Control Part (SCoP) is bounded.  The
10396 default value is 10 parameters.  A variable whose value is unknown at
10397 compilation time and defined outside a SCoP is a parameter of the SCoP.
10399 @item graphite-max-bbs-per-function
10400 To avoid exponential effects in the detection of SCoPs, the size of
10401 the functions analyzed by Graphite is bounded.  The default value is
10402 100 basic blocks.
10404 @item loop-block-tile-size
10405 Loop blocking or strip mining transforms, enabled with
10406 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
10407 loop in the loop nest by a given number of iterations.  The strip
10408 length can be changed using the @option{loop-block-tile-size}
10409 parameter.  The default value is 51 iterations.
10411 @item loop-unroll-jam-size
10412 Specify the unroll factor for the @option{-floop-unroll-and-jam} option.  The 
10413 default value is 4.
10415 @item loop-unroll-jam-depth
10416 Specify the dimension to be unrolled (counting from the most inner loop)
10417 for the  @option{-floop-unroll-and-jam}.  The default value is 2.
10419 @item ipa-cp-value-list-size
10420 IPA-CP attempts to track all possible values and types passed to a function's
10421 parameter in order to propagate them and perform devirtualization.
10422 @option{ipa-cp-value-list-size} is the maximum number of values and types it
10423 stores per one formal parameter of a function.
10425 @item ipa-cp-eval-threshold
10426 IPA-CP calculates its own score of cloning profitability heuristics
10427 and performs those cloning opportunities with scores that exceed
10428 @option{ipa-cp-eval-threshold}.
10430 @item ipa-cp-recursion-penalty
10431 Percentage penalty the recursive functions will receive when they
10432 are evaluated for cloning.
10434 @item ipa-cp-single-call-penalty
10435 Percentage penalty functions containing a single call to another
10436 function will receive when they are evaluated for cloning.
10439 @item ipa-max-agg-items
10440 IPA-CP is also capable to propagate a number of scalar values passed
10441 in an aggregate. @option{ipa-max-agg-items} controls the maximum
10442 number of such values per one parameter.
10444 @item ipa-cp-loop-hint-bonus
10445 When IPA-CP determines that a cloning candidate would make the number
10446 of iterations of a loop known, it adds a bonus of
10447 @option{ipa-cp-loop-hint-bonus} to the profitability score of
10448 the candidate.
10450 @item ipa-cp-array-index-hint-bonus
10451 When IPA-CP determines that a cloning candidate would make the index of
10452 an array access known, it adds a bonus of
10453 @option{ipa-cp-array-index-hint-bonus} to the profitability
10454 score of the candidate.
10456 @item ipa-max-aa-steps
10457 During its analysis of function bodies, IPA-CP employs alias analysis
10458 in order to track values pointed to by function parameters.  In order
10459 not spend too much time analyzing huge functions, it gives up and
10460 consider all memory clobbered after examining
10461 @option{ipa-max-aa-steps} statements modifying memory.
10463 @item lto-partitions
10464 Specify desired number of partitions produced during WHOPR compilation.
10465 The number of partitions should exceed the number of CPUs used for compilation.
10466 The default value is 32.
10468 @item lto-min-partition
10469 Size of minimal partition for WHOPR (in estimated instructions).
10470 This prevents expenses of splitting very small programs into too many
10471 partitions.
10473 @item lto-max-partition
10474 Size of max partition for WHOPR (in estimated instructions).
10475 to provide an upper bound for individual size of partition.
10476 Meant to be used only with balanced partitioning.
10478 @item cxx-max-namespaces-for-diagnostic-help
10479 The maximum number of namespaces to consult for suggestions when C++
10480 name lookup fails for an identifier.  The default is 1000.
10482 @item sink-frequency-threshold
10483 The maximum relative execution frequency (in percents) of the target block
10484 relative to a statement's original block to allow statement sinking of a
10485 statement.  Larger numbers result in more aggressive statement sinking.
10486 The default value is 75.  A small positive adjustment is applied for
10487 statements with memory operands as those are even more profitable so sink.
10489 @item max-stores-to-sink
10490 The maximum number of conditional store pairs that can be sunk.  Set to 0
10491 if either vectorization (@option{-ftree-vectorize}) or if-conversion
10492 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
10494 @item allow-store-data-races
10495 Allow optimizers to introduce new data races on stores.
10496 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10497 at optimization level @option{-Ofast}.
10499 @item case-values-threshold
10500 The smallest number of different values for which it is best to use a
10501 jump-table instead of a tree of conditional branches.  If the value is
10502 0, use the default for the machine.  The default is 0.
10504 @item tree-reassoc-width
10505 Set the maximum number of instructions executed in parallel in
10506 reassociated tree. This parameter overrides target dependent
10507 heuristics used by default if has non zero value.
10509 @item sched-pressure-algorithm
10510 Choose between the two available implementations of
10511 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
10512 and is the more likely to prevent instructions from being reordered.
10513 Algorithm 2 was designed to be a compromise between the relatively
10514 conservative approach taken by algorithm 1 and the rather aggressive
10515 approach taken by the default scheduler.  It relies more heavily on
10516 having a regular register file and accurate register pressure classes.
10517 See @file{haifa-sched.c} in the GCC sources for more details.
10519 The default choice depends on the target.
10521 @item max-slsr-cand-scan
10522 Set the maximum number of existing candidates that are considered when
10523 seeking a basis for a new straight-line strength reduction candidate.
10525 @item asan-globals
10526 Enable buffer overflow detection for global objects.  This kind
10527 of protection is enabled by default if you are using
10528 @option{-fsanitize=address} option.
10529 To disable global objects protection use @option{--param asan-globals=0}.
10531 @item asan-stack
10532 Enable buffer overflow detection for stack objects.  This kind of
10533 protection is enabled by default when using @option{-fsanitize=address}.
10534 To disable stack protection use @option{--param asan-stack=0} option.
10536 @item asan-instrument-reads
10537 Enable buffer overflow detection for memory reads.  This kind of
10538 protection is enabled by default when using @option{-fsanitize=address}.
10539 To disable memory reads protection use
10540 @option{--param asan-instrument-reads=0}.
10542 @item asan-instrument-writes
10543 Enable buffer overflow detection for memory writes.  This kind of
10544 protection is enabled by default when using @option{-fsanitize=address}.
10545 To disable memory writes protection use
10546 @option{--param asan-instrument-writes=0} option.
10548 @item asan-memintrin
10549 Enable detection for built-in functions.  This kind of protection
10550 is enabled by default when using @option{-fsanitize=address}.
10551 To disable built-in functions protection use
10552 @option{--param asan-memintrin=0}.
10554 @item asan-use-after-return
10555 Enable detection of use-after-return.  This kind of protection
10556 is enabled by default when using the @option{-fsanitize=address} option.
10557 To disable it use @option{--param asan-use-after-return=0}.
10559 Note: By default the check is disabled at run time.  To enable it,
10560 add @code{detect_stack_use_after_return=1} to the environment variable
10561 @env{ASAN_OPTIONS}.
10563 @item asan-instrumentation-with-call-threshold
10564 If number of memory accesses in function being instrumented
10565 is greater or equal to this number, use callbacks instead of inline checks.
10566 E.g. to disable inline code use
10567 @option{--param asan-instrumentation-with-call-threshold=0}.
10569 @item use-after-scope-direct-emission-threshold
10570 If the size of a local variable in bytes is smaller or equal to this
10571 number, directly poison (or unpoison) shadow memory instead of using
10572 run-time callbacks.  The default value is 256.
10574 @item chkp-max-ctor-size
10575 Static constructors generated by Pointer Bounds Checker may become very
10576 large and significantly increase compile time at optimization level
10577 @option{-O1} and higher.  This parameter is a maximum number of statements
10578 in a single generated constructor.  Default value is 5000.
10580 @item max-fsm-thread-path-insns
10581 Maximum number of instructions to copy when duplicating blocks on a
10582 finite state automaton jump thread path.  The default is 100.
10584 @item max-fsm-thread-length
10585 Maximum number of basic blocks on a finite state automaton jump thread
10586 path.  The default is 10.
10588 @item max-fsm-thread-paths
10589 Maximum number of new jump thread paths to create for a finite state
10590 automaton.  The default is 50.
10592 @item parloops-chunk-size
10593 Chunk size of omp schedule for loops parallelized by parloops.  The default
10594 is 0.
10596 @item parloops-schedule
10597 Schedule type of omp schedule for loops parallelized by parloops (static,
10598 dynamic, guided, auto, runtime).  The default is static.
10600 @item max-ssa-name-query-depth
10601 Maximum depth of recursion when querying properties of SSA names in things
10602 like fold routines.  One level of recursion corresponds to following a
10603 use-def chain.
10605 @item hsa-gen-debug-stores
10606 Enable emission of special debug stores within HSA kernels which are
10607 then read and reported by libgomp plugin.  Generation of these stores
10608 is disabled by default, use @option{--param hsa-gen-debug-stores=1} to
10609 enable it.
10611 @item max-speculative-devirt-maydefs
10612 The maximum number of may-defs we analyze when looking for a must-def
10613 specifying the dynamic type of an object that invokes a virtual call
10614 we may be able to devirtualize speculatively.
10616 @item max-vrp-switch-assertions
10617 The maximum number of assertions to add along the default edge of a switch
10618 statement during VRP.  The default is 10.
10619 @end table
10620 @end table
10622 @node Instrumentation Options
10623 @section Program Instrumentation Options
10624 @cindex instrumentation options
10625 @cindex program instrumentation options
10626 @cindex run-time error checking options
10627 @cindex profiling options
10628 @cindex options, program instrumentation
10629 @cindex options, run-time error checking
10630 @cindex options, profiling
10632 GCC supports a number of command-line options that control adding
10633 run-time instrumentation to the code it normally generates.  
10634 For example, one purpose of instrumentation is collect profiling
10635 statistics for use in finding program hot spots, code coverage
10636 analysis, or profile-guided optimizations.
10637 Another class of program instrumentation is adding run-time checking 
10638 to detect programming errors like invalid pointer
10639 dereferences or out-of-bounds array accesses, as well as deliberately
10640 hostile attacks such as stack smashing or C++ vtable hijacking.
10641 There is also a general hook which can be used to implement other
10642 forms of tracing or function-level instrumentation for debug or
10643 program analysis purposes.
10645 @table @gcctabopt
10646 @cindex @command{prof}
10647 @item -p
10648 @opindex p
10649 Generate extra code to write profile information suitable for the
10650 analysis program @command{prof}.  You must use this option when compiling
10651 the source files you want data about, and you must also use it when
10652 linking.
10654 @cindex @command{gprof}
10655 @item -pg
10656 @opindex pg
10657 Generate extra code to write profile information suitable for the
10658 analysis program @command{gprof}.  You must use this option when compiling
10659 the source files you want data about, and you must also use it when
10660 linking.
10662 @item -fprofile-arcs
10663 @opindex fprofile-arcs
10664 Add code so that program flow @dfn{arcs} are instrumented.  During
10665 execution the program records how many times each branch and call is
10666 executed and how many times it is taken or returns.  On targets that support
10667 constructors with priority support, profiling properly handles constructors,
10668 destructors and C++ constructors (and destructors) of classes which are used
10669 as a type of a global variable.
10671 When the compiled
10672 program exits it saves this data to a file called
10673 @file{@var{auxname}.gcda} for each source file.  The data may be used for
10674 profile-directed optimizations (@option{-fbranch-probabilities}), or for
10675 test coverage analysis (@option{-ftest-coverage}).  Each object file's
10676 @var{auxname} is generated from the name of the output file, if
10677 explicitly specified and it is not the final executable, otherwise it is
10678 the basename of the source file.  In both cases any suffix is removed
10679 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
10680 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
10681 @xref{Cross-profiling}.
10683 @cindex @command{gcov}
10684 @item --coverage
10685 @opindex coverage
10687 This option is used to compile and link code instrumented for coverage
10688 analysis.  The option is a synonym for @option{-fprofile-arcs}
10689 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
10690 linking).  See the documentation for those options for more details.
10692 @itemize
10694 @item
10695 Compile the source files with @option{-fprofile-arcs} plus optimization
10696 and code generation options.  For test coverage analysis, use the
10697 additional @option{-ftest-coverage} option.  You do not need to profile
10698 every source file in a program.
10700 @item
10701 Compile the source files additionally with @option{-fprofile-abs-path}
10702 to create absolute path names in the @file{.gcno} files.  This allows
10703 @command{gcov} to find the correct sources in projects where compilations
10704 occur with different working directories.
10706 @item
10707 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
10708 (the latter implies the former).
10710 @item
10711 Run the program on a representative workload to generate the arc profile
10712 information.  This may be repeated any number of times.  You can run
10713 concurrent instances of your program, and provided that the file system
10714 supports locking, the data files will be correctly updated.  Also
10715 @code{fork} calls are detected and correctly handled (double counting
10716 will not happen).
10718 @item
10719 For profile-directed optimizations, compile the source files again with
10720 the same optimization and code generation options plus
10721 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
10722 Control Optimization}).
10724 @item
10725 For test coverage analysis, use @command{gcov} to produce human readable
10726 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
10727 @command{gcov} documentation for further information.
10729 @end itemize
10731 With @option{-fprofile-arcs}, for each function of your program GCC
10732 creates a program flow graph, then finds a spanning tree for the graph.
10733 Only arcs that are not on the spanning tree have to be instrumented: the
10734 compiler adds code to count the number of times that these arcs are
10735 executed.  When an arc is the only exit or only entrance to a block, the
10736 instrumentation code can be added to the block; otherwise, a new basic
10737 block must be created to hold the instrumentation code.
10739 @need 2000
10740 @item -ftest-coverage
10741 @opindex ftest-coverage
10742 Produce a notes file that the @command{gcov} code-coverage utility
10743 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
10744 show program coverage.  Each source file's note file is called
10745 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
10746 above for a description of @var{auxname} and instructions on how to
10747 generate test coverage data.  Coverage data matches the source files
10748 more closely if you do not optimize.
10750 @item -fprofile-abs-path
10751 @opindex fprofile-abs-path
10752 Automatically convert relative source file names to absolute path names
10753 in the @file{.gcno} files.  This allows @command{gcov} to find the correct
10754 sources in projects where compilations occur with different working
10755 directories.
10757 @item -fprofile-dir=@var{path}
10758 @opindex fprofile-dir
10760 Set the directory to search for the profile data files in to @var{path}.
10761 This option affects only the profile data generated by
10762 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
10763 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
10764 and its related options.  Both absolute and relative paths can be used.
10765 By default, GCC uses the current directory as @var{path}, thus the
10766 profile data file appears in the same directory as the object file.
10768 @item -fprofile-generate
10769 @itemx -fprofile-generate=@var{path}
10770 @opindex fprofile-generate
10772 Enable options usually used for instrumenting application to produce
10773 profile useful for later recompilation with profile feedback based
10774 optimization.  You must use @option{-fprofile-generate} both when
10775 compiling and when linking your program.
10777 The following options are enabled: @option{-fprofile-arcs}, @option{-fprofile-values}, @option{-fvpt}.
10779 If @var{path} is specified, GCC looks at the @var{path} to find
10780 the profile feedback data files. See @option{-fprofile-dir}.
10782 To optimize the program based on the collected profile information, use
10783 @option{-fprofile-use}.  @xref{Optimize Options}, for more information.
10785 @item -fprofile-update=@var{method}
10786 @opindex fprofile-update
10788 Alter the update method for an application instrumented for profile
10789 feedback based optimization.  The @var{method} argument should be one of
10790 @samp{single}, @samp{atomic} or @samp{prefer-atomic}.
10791 The first one is useful for single-threaded applications,
10792 while the second one prevents profile corruption by emitting thread-safe code.
10794 @strong{Warning:} When an application does not properly join all threads
10795 (or creates an detached thread), a profile file can be still corrupted.
10797 Using @samp{prefer-atomic} would be transformed either to @samp{atomic},
10798 when supported by a target, or to @samp{single} otherwise.  The GCC driver
10799 automatically selects @samp{prefer-atomic} when @option{-pthread}
10800 is present in the command line.
10802 @item -fsanitize=address
10803 @opindex fsanitize=address
10804 Enable AddressSanitizer, a fast memory error detector.
10805 Memory access instructions are instrumented to detect
10806 out-of-bounds and use-after-free bugs.
10807 The option enables @option{-fsanitize-address-use-after-scope}.
10808 See @uref{https://github.com/google/sanitizers/wiki/AddressSanitizer} for
10809 more details.  The run-time behavior can be influenced using the
10810 @env{ASAN_OPTIONS} environment variable.  When set to @code{help=1},
10811 the available options are shown at startup of the instrumented program.  See
10812 @url{https://github.com/google/sanitizers/wiki/AddressSanitizerFlags#run-time-flags}
10813 for a list of supported options.
10814 The option cannot be combined with @option{-fsanitize=thread}
10815 and/or @option{-fcheck-pointer-bounds}.
10817 @item -fsanitize=kernel-address
10818 @opindex fsanitize=kernel-address
10819 Enable AddressSanitizer for Linux kernel.
10820 See @uref{https://github.com/google/kasan/wiki} for more details.
10821 The option cannot be combined with @option{-fcheck-pointer-bounds}.
10823 @item -fsanitize=thread
10824 @opindex fsanitize=thread
10825 Enable ThreadSanitizer, a fast data race detector.
10826 Memory access instructions are instrumented to detect
10827 data race bugs.  See @uref{https://github.com/google/sanitizers/wiki#threadsanitizer} for more
10828 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
10829 environment variable; see
10830 @url{https://github.com/google/sanitizers/wiki/ThreadSanitizerFlags} for a list of
10831 supported options.
10832 The option cannot be combined with @option{-fsanitize=address},
10833 @option{-fsanitize=leak} and/or @option{-fcheck-pointer-bounds}.
10835 Note that sanitized atomic builtins cannot throw exceptions when
10836 operating on invalid memory addresses with non-call exceptions
10837 (@option{-fnon-call-exceptions}).
10839 @item -fsanitize=leak
10840 @opindex fsanitize=leak
10841 Enable LeakSanitizer, a memory leak detector.
10842 This option only matters for linking of executables and
10843 the executable is linked against a library that overrides @code{malloc}
10844 and other allocator functions.  See
10845 @uref{https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer} for more
10846 details.  The run-time behavior can be influenced using the
10847 @env{LSAN_OPTIONS} environment variable.
10848 The option cannot be combined with @option{-fsanitize=thread}.
10850 @item -fsanitize=undefined
10851 @opindex fsanitize=undefined
10852 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
10853 Various computations are instrumented to detect undefined behavior
10854 at runtime.  Current suboptions are:
10856 @table @gcctabopt
10858 @item -fsanitize=shift
10859 @opindex fsanitize=shift
10860 This option enables checking that the result of a shift operation is
10861 not undefined.  Note that what exactly is considered undefined differs
10862 slightly between C and C++, as well as between ISO C90 and C99, etc.
10863 This option has two suboptions, @option{-fsanitize=shift-base} and
10864 @option{-fsanitize=shift-exponent}.
10866 @item -fsanitize=shift-exponent
10867 @opindex fsanitize=shift-exponent
10868 This option enables checking that the second argument of a shift operation
10869 is not negative and is smaller than the precision of the promoted first
10870 argument.
10872 @item -fsanitize=shift-base
10873 @opindex fsanitize=shift-base
10874 If the second argument of a shift operation is within range, check that the
10875 result of a shift operation is not undefined.  Note that what exactly is
10876 considered undefined differs slightly between C and C++, as well as between
10877 ISO C90 and C99, etc.
10879 @item -fsanitize=integer-divide-by-zero
10880 @opindex fsanitize=integer-divide-by-zero
10881 Detect integer division by zero as well as @code{INT_MIN / -1} division.
10883 @item -fsanitize=unreachable
10884 @opindex fsanitize=unreachable
10885 With this option, the compiler turns the @code{__builtin_unreachable}
10886 call into a diagnostics message call instead.  When reaching the
10887 @code{__builtin_unreachable} call, the behavior is undefined.
10889 @item -fsanitize=vla-bound
10890 @opindex fsanitize=vla-bound
10891 This option instructs the compiler to check that the size of a variable
10892 length array is positive.
10894 @item -fsanitize=null
10895 @opindex fsanitize=null
10896 This option enables pointer checking.  Particularly, the application
10897 built with this option turned on will issue an error message when it
10898 tries to dereference a NULL pointer, or if a reference (possibly an
10899 rvalue reference) is bound to a NULL pointer, or if a method is invoked
10900 on an object pointed by a NULL pointer.
10902 @item -fsanitize=return
10903 @opindex fsanitize=return
10904 This option enables return statement checking.  Programs
10905 built with this option turned on will issue an error message
10906 when the end of a non-void function is reached without actually
10907 returning a value.  This option works in C++ only.
10909 @item -fsanitize=signed-integer-overflow
10910 @opindex fsanitize=signed-integer-overflow
10911 This option enables signed integer overflow checking.  We check that
10912 the result of @code{+}, @code{*}, and both unary and binary @code{-}
10913 does not overflow in the signed arithmetics.  Note, integer promotion
10914 rules must be taken into account.  That is, the following is not an
10915 overflow:
10916 @smallexample
10917 signed char a = SCHAR_MAX;
10918 a++;
10919 @end smallexample
10921 @item -fsanitize=bounds
10922 @opindex fsanitize=bounds
10923 This option enables instrumentation of array bounds.  Various out of bounds
10924 accesses are detected.  Flexible array members, flexible array member-like
10925 arrays, and initializers of variables with static storage are not instrumented.
10926 The option cannot be combined with @option{-fcheck-pointer-bounds}.
10928 @item -fsanitize=bounds-strict
10929 @opindex fsanitize=bounds-strict
10930 This option enables strict instrumentation of array bounds.  Most out of bounds
10931 accesses are detected, including flexible array members and flexible array
10932 member-like arrays.  Initializers of variables with static storage are not
10933 instrumented.  The option cannot be combined
10934 with @option{-fcheck-pointer-bounds}.
10936 @item -fsanitize=alignment
10937 @opindex fsanitize=alignment
10939 This option enables checking of alignment of pointers when they are
10940 dereferenced, or when a reference is bound to insufficiently aligned target,
10941 or when a method or constructor is invoked on insufficiently aligned object.
10943 @item -fsanitize=object-size
10944 @opindex fsanitize=object-size
10945 This option enables instrumentation of memory references using the
10946 @code{__builtin_object_size} function.  Various out of bounds pointer
10947 accesses are detected.
10949 @item -fsanitize=float-divide-by-zero
10950 @opindex fsanitize=float-divide-by-zero
10951 Detect floating-point division by zero.  Unlike other similar options,
10952 @option{-fsanitize=float-divide-by-zero} is not enabled by
10953 @option{-fsanitize=undefined}, since floating-point division by zero can
10954 be a legitimate way of obtaining infinities and NaNs.
10956 @item -fsanitize=float-cast-overflow
10957 @opindex fsanitize=float-cast-overflow
10958 This option enables floating-point type to integer conversion checking.
10959 We check that the result of the conversion does not overflow.
10960 Unlike other similar options, @option{-fsanitize=float-cast-overflow} is
10961 not enabled by @option{-fsanitize=undefined}.
10962 This option does not work well with @code{FE_INVALID} exceptions enabled.
10964 @item -fsanitize=nonnull-attribute
10965 @opindex fsanitize=nonnull-attribute
10967 This option enables instrumentation of calls, checking whether null values
10968 are not passed to arguments marked as requiring a non-null value by the
10969 @code{nonnull} function attribute.
10971 @item -fsanitize=returns-nonnull-attribute
10972 @opindex fsanitize=returns-nonnull-attribute
10974 This option enables instrumentation of return statements in functions
10975 marked with @code{returns_nonnull} function attribute, to detect returning
10976 of null values from such functions.
10978 @item -fsanitize=bool
10979 @opindex fsanitize=bool
10981 This option enables instrumentation of loads from bool.  If a value other
10982 than 0/1 is loaded, a run-time error is issued.
10984 @item -fsanitize=enum
10985 @opindex fsanitize=enum
10987 This option enables instrumentation of loads from an enum type.  If
10988 a value outside the range of values for the enum type is loaded,
10989 a run-time error is issued.
10991 @item -fsanitize=vptr
10992 @opindex fsanitize=vptr
10994 This option enables instrumentation of C++ member function calls, member
10995 accesses and some conversions between pointers to base and derived classes,
10996 to verify the referenced object has the correct dynamic type.
10998 @end table
11000 While @option{-ftrapv} causes traps for signed overflows to be emitted,
11001 @option{-fsanitize=undefined} gives a diagnostic message.
11002 This currently works only for the C family of languages.
11004 @item -fno-sanitize=all
11005 @opindex fno-sanitize=all
11007 This option disables all previously enabled sanitizers.
11008 @option{-fsanitize=all} is not allowed, as some sanitizers cannot be used
11009 together.
11011 @item -fasan-shadow-offset=@var{number}
11012 @opindex fasan-shadow-offset
11013 This option forces GCC to use custom shadow offset in AddressSanitizer checks.
11014 It is useful for experimenting with different shadow memory layouts in
11015 Kernel AddressSanitizer.
11017 @item -fsanitize-sections=@var{s1},@var{s2},...
11018 @opindex fsanitize-sections
11019 Sanitize global variables in selected user-defined sections.  @var{si} may
11020 contain wildcards.
11022 @item -fsanitize-recover@r{[}=@var{opts}@r{]}
11023 @opindex fsanitize-recover
11024 @opindex fno-sanitize-recover
11025 @option{-fsanitize-recover=} controls error recovery mode for sanitizers
11026 mentioned in comma-separated list of @var{opts}.  Enabling this option
11027 for a sanitizer component causes it to attempt to continue
11028 running the program as if no error happened.  This means multiple
11029 runtime errors can be reported in a single program run, and the exit
11030 code of the program may indicate success even when errors
11031 have been reported.  The @option{-fno-sanitize-recover=} option
11032 can be used to alter
11033 this behavior: only the first detected error is reported
11034 and program then exits with a non-zero exit code.
11036 Currently this feature only works for @option{-fsanitize=undefined} (and its suboptions
11037 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return}),
11038 @option{-fsanitize=float-cast-overflow}, @option{-fsanitize=float-divide-by-zero},
11039 @option{-fsanitize=bounds-strict},
11040 @option{-fsanitize=kernel-address} and @option{-fsanitize=address}.
11041 For these sanitizers error recovery is turned on by default,
11042 except @option{-fsanitize=address}, for which this feature is experimental.
11043 @option{-fsanitize-recover=all} and @option{-fno-sanitize-recover=all} is also
11044 accepted, the former enables recovery for all sanitizers that support it,
11045 the latter disables recovery for all sanitizers that support it.
11047 Even if a recovery mode is turned on the compiler side, it needs to be also
11048 enabled on the runtime library side, otherwise the failures are still fatal.
11049 The runtime library defaults to @code{halt_on_error=0} for
11050 ThreadSanitizer and UndefinedBehaviorSanitizer, while default value for
11051 AddressSanitizer is @code{halt_on_error=1}. This can be overridden through
11052 setting the @code{halt_on_error} flag in the corresponding environment variable.
11054 Syntax without an explicit @var{opts} parameter is deprecated.  It is
11055 equivalent to specifying an @var{opts} list of:
11057 @smallexample
11058 undefined,float-cast-overflow,float-divide-by-zero,bounds-strict
11059 @end smallexample
11061 @item -fsanitize-address-use-after-scope
11062 @opindex fsanitize-address-use-after-scope
11063 Enable sanitization of local variables to detect use-after-scope bugs.
11064 The option sets @option{-fstack-reuse} to @samp{none}.
11066 @item -fsanitize-undefined-trap-on-error
11067 @opindex fsanitize-undefined-trap-on-error
11068 The @option{-fsanitize-undefined-trap-on-error} option instructs the compiler to
11069 report undefined behavior using @code{__builtin_trap} rather than
11070 a @code{libubsan} library routine.  The advantage of this is that the
11071 @code{libubsan} library is not needed and is not linked in, so this
11072 is usable even in freestanding environments.
11074 @item -fsanitize-coverage=trace-pc
11075 @opindex fsanitize-coverage=trace-pc
11076 Enable coverage-guided fuzzing code instrumentation.
11077 Inserts a call to @code{__sanitizer_cov_trace_pc} into every basic block.
11079 @item -fbounds-check
11080 @opindex fbounds-check
11081 For front ends that support it, generate additional code to check that
11082 indices used to access arrays are within the declared range.  This is
11083 currently only supported by the Fortran front end, where this option
11084 defaults to false.
11086 @item -fcheck-pointer-bounds
11087 @opindex fcheck-pointer-bounds
11088 @opindex fno-check-pointer-bounds
11089 @cindex Pointer Bounds Checker options
11090 Enable Pointer Bounds Checker instrumentation.  Each memory reference
11091 is instrumented with checks of the pointer used for memory access against
11092 bounds associated with that pointer.  
11094 Currently there
11095 is only an implementation for Intel MPX available, thus x86 GNU/Linux target
11096 and @option{-mmpx} are required to enable this feature.  
11097 MPX-based instrumentation requires
11098 a runtime library to enable MPX in hardware and handle bounds
11099 violation signals.  By default when @option{-fcheck-pointer-bounds}
11100 and @option{-mmpx} options are used to link a program, the GCC driver
11101 links against the @file{libmpx} and @file{libmpxwrappers} libraries.
11102 Bounds checking on calls to dynamic libraries requires a linker
11103 with @option{-z bndplt} support; if GCC was configured with a linker
11104 without support for this option (including the Gold linker and older
11105 versions of ld), a warning is given if you link with @option{-mmpx}
11106 without also specifying @option{-static}, since the overall effectiveness
11107 of the bounds checking protection is reduced.
11108 See also @option{-static-libmpxwrappers}.
11110 MPX-based instrumentation
11111 may be used for debugging and also may be included in production code
11112 to increase program security.  Depending on usage, you may
11113 have different requirements for the runtime library.  The current version
11114 of the MPX runtime library is more oriented for use as a debugging
11115 tool.  MPX runtime library usage implies @option{-lpthread}.  See
11116 also @option{-static-libmpx}.  The runtime library  behavior can be
11117 influenced using various @env{CHKP_RT_*} environment variables.  See
11118 @uref{https://gcc.gnu.org/wiki/Intel%20MPX%20support%20in%20the%20GCC%20compiler}
11119 for more details.
11121 Generated instrumentation may be controlled by various
11122 @option{-fchkp-*} options and by the @code{bnd_variable_size}
11123 structure field attribute (@pxref{Type Attributes}) and
11124 @code{bnd_legacy}, and @code{bnd_instrument} function attributes
11125 (@pxref{Function Attributes}).  GCC also provides a number of built-in
11126 functions for controlling the Pointer Bounds Checker.  @xref{Pointer
11127 Bounds Checker builtins}, for more information.
11129 @item -fchkp-check-incomplete-type
11130 @opindex fchkp-check-incomplete-type
11131 @opindex fno-chkp-check-incomplete-type
11132 Generate pointer bounds checks for variables with incomplete type.
11133 Enabled by default.
11135 @item -fchkp-narrow-bounds
11136 @opindex fchkp-narrow-bounds
11137 @opindex fno-chkp-narrow-bounds
11138 Controls bounds used by Pointer Bounds Checker for pointers to object
11139 fields.  If narrowing is enabled then field bounds are used.  Otherwise
11140 object bounds are used.  See also @option{-fchkp-narrow-to-innermost-array}
11141 and @option{-fchkp-first-field-has-own-bounds}.  Enabled by default.
11143 @item -fchkp-first-field-has-own-bounds
11144 @opindex fchkp-first-field-has-own-bounds
11145 @opindex fno-chkp-first-field-has-own-bounds
11146 Forces Pointer Bounds Checker to use narrowed bounds for the address of the
11147 first field in the structure.  By default a pointer to the first field has
11148 the same bounds as a pointer to the whole structure.
11150 @item -fchkp-flexible-struct-trailing-arrays
11151 @opindex fchkp-flexible-struct-trailing-arrays
11152 @opindex fno-chkp-flexible-struct-trailing-arrays
11153 Forces Pointer Bounds Checker to treat all trailing arrays in structures as
11154 possibly flexible.  By default only array fields with zero length or that are
11155 marked with attribute bnd_variable_size are treated as flexible.
11157 @item -fchkp-narrow-to-innermost-array
11158 @opindex fchkp-narrow-to-innermost-array
11159 @opindex fno-chkp-narrow-to-innermost-array
11160 Forces Pointer Bounds Checker to use bounds of the innermost arrays in
11161 case of nested static array access.  By default this option is disabled and
11162 bounds of the outermost array are used.
11164 @item -fchkp-optimize
11165 @opindex fchkp-optimize
11166 @opindex fno-chkp-optimize
11167 Enables Pointer Bounds Checker optimizations.  Enabled by default at
11168 optimization levels @option{-O}, @option{-O2}, @option{-O3}.
11170 @item -fchkp-use-fast-string-functions
11171 @opindex fchkp-use-fast-string-functions
11172 @opindex fno-chkp-use-fast-string-functions
11173 Enables use of @code{*_nobnd} versions of string functions (not copying bounds)
11174 by Pointer Bounds Checker.  Disabled by default.
11176 @item -fchkp-use-nochk-string-functions
11177 @opindex fchkp-use-nochk-string-functions
11178 @opindex fno-chkp-use-nochk-string-functions
11179 Enables use of @code{*_nochk} versions of string functions (not checking bounds)
11180 by Pointer Bounds Checker.  Disabled by default.
11182 @item -fchkp-use-static-bounds
11183 @opindex fchkp-use-static-bounds
11184 @opindex fno-chkp-use-static-bounds
11185 Allow Pointer Bounds Checker to generate static bounds holding
11186 bounds of static variables.  Enabled by default.
11188 @item -fchkp-use-static-const-bounds
11189 @opindex fchkp-use-static-const-bounds
11190 @opindex fno-chkp-use-static-const-bounds
11191 Use statically-initialized bounds for constant bounds instead of
11192 generating them each time they are required.  By default enabled when
11193 @option{-fchkp-use-static-bounds} is enabled.
11195 @item -fchkp-treat-zero-dynamic-size-as-infinite
11196 @opindex fchkp-treat-zero-dynamic-size-as-infinite
11197 @opindex fno-chkp-treat-zero-dynamic-size-as-infinite
11198 With this option, objects with incomplete type whose
11199 dynamically-obtained size is zero are treated as having infinite size
11200 instead by Pointer Bounds
11201 Checker.  This option may be helpful if a program is linked with a library
11202 missing size information for some symbols.  Disabled by default.
11204 @item -fchkp-check-read
11205 @opindex fchkp-check-read
11206 @opindex fno-chkp-check-read
11207 Instructs Pointer Bounds Checker to generate checks for all read
11208 accesses to memory.  Enabled by default.
11210 @item -fchkp-check-write
11211 @opindex fchkp-check-write
11212 @opindex fno-chkp-check-write
11213 Instructs Pointer Bounds Checker to generate checks for all write
11214 accesses to memory.  Enabled by default.
11216 @item -fchkp-store-bounds
11217 @opindex fchkp-store-bounds
11218 @opindex fno-chkp-store-bounds
11219 Instructs Pointer Bounds Checker to generate bounds stores for
11220 pointer writes.  Enabled by default.
11222 @item -fchkp-instrument-calls
11223 @opindex fchkp-instrument-calls
11224 @opindex fno-chkp-instrument-calls
11225 Instructs Pointer Bounds Checker to pass pointer bounds to calls.
11226 Enabled by default.
11228 @item -fchkp-instrument-marked-only
11229 @opindex fchkp-instrument-marked-only
11230 @opindex fno-chkp-instrument-marked-only
11231 Instructs Pointer Bounds Checker to instrument only functions
11232 marked with the @code{bnd_instrument} attribute
11233 (@pxref{Function Attributes}).  Disabled by default.
11235 @item -fchkp-use-wrappers
11236 @opindex fchkp-use-wrappers
11237 @opindex fno-chkp-use-wrappers
11238 Allows Pointer Bounds Checker to replace calls to built-in functions
11239 with calls to wrapper functions.  When @option{-fchkp-use-wrappers}
11240 is used to link a program, the GCC driver automatically links
11241 against @file{libmpxwrappers}.  See also @option{-static-libmpxwrappers}.
11242 Enabled by default.
11244 @item -fstack-protector
11245 @opindex fstack-protector
11246 Emit extra code to check for buffer overflows, such as stack smashing
11247 attacks.  This is done by adding a guard variable to functions with
11248 vulnerable objects.  This includes functions that call @code{alloca}, and
11249 functions with buffers larger than 8 bytes.  The guards are initialized
11250 when a function is entered and then checked when the function exits.
11251 If a guard check fails, an error message is printed and the program exits.
11253 @item -fstack-protector-all
11254 @opindex fstack-protector-all
11255 Like @option{-fstack-protector} except that all functions are protected.
11257 @item -fstack-protector-strong
11258 @opindex fstack-protector-strong
11259 Like @option{-fstack-protector} but includes additional functions to
11260 be protected --- those that have local array definitions, or have
11261 references to local frame addresses.
11263 @item -fstack-protector-explicit
11264 @opindex fstack-protector-explicit
11265 Like @option{-fstack-protector} but only protects those functions which
11266 have the @code{stack_protect} attribute.
11268 @item -fstack-check
11269 @opindex fstack-check
11270 Generate code to verify that you do not go beyond the boundary of the
11271 stack.  You should specify this flag if you are running in an
11272 environment with multiple threads, but you only rarely need to specify it in
11273 a single-threaded environment since stack overflow is automatically
11274 detected on nearly all systems if there is only one stack.
11276 Note that this switch does not actually cause checking to be done; the
11277 operating system or the language runtime must do that.  The switch causes
11278 generation of code to ensure that they see the stack being extended.
11280 You can additionally specify a string parameter: @samp{no} means no
11281 checking, @samp{generic} means force the use of old-style checking,
11282 @samp{specific} means use the best checking method and is equivalent
11283 to bare @option{-fstack-check}.
11285 Old-style checking is a generic mechanism that requires no specific
11286 target support in the compiler but comes with the following drawbacks:
11288 @enumerate
11289 @item
11290 Modified allocation strategy for large objects: they are always
11291 allocated dynamically if their size exceeds a fixed threshold.
11293 @item
11294 Fixed limit on the size of the static frame of functions: when it is
11295 topped by a particular function, stack checking is not reliable and
11296 a warning is issued by the compiler.
11298 @item
11299 Inefficiency: because of both the modified allocation strategy and the
11300 generic implementation, code performance is hampered.
11301 @end enumerate
11303 Note that old-style stack checking is also the fallback method for
11304 @samp{specific} if no target support has been added in the compiler.
11306 @item -fstack-limit-register=@var{reg}
11307 @itemx -fstack-limit-symbol=@var{sym}
11308 @itemx -fno-stack-limit
11309 @opindex fstack-limit-register
11310 @opindex fstack-limit-symbol
11311 @opindex fno-stack-limit
11312 Generate code to ensure that the stack does not grow beyond a certain value,
11313 either the value of a register or the address of a symbol.  If a larger
11314 stack is required, a signal is raised at run time.  For most targets,
11315 the signal is raised before the stack overruns the boundary, so
11316 it is possible to catch the signal without taking special precautions.
11318 For instance, if the stack starts at absolute address @samp{0x80000000}
11319 and grows downwards, you can use the flags
11320 @option{-fstack-limit-symbol=__stack_limit} and
11321 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11322 of 128KB@.  Note that this may only work with the GNU linker.
11324 You can locally override stack limit checking by using the
11325 @code{no_stack_limit} function attribute (@pxref{Function Attributes}).
11327 @item -fsplit-stack
11328 @opindex fsplit-stack
11329 Generate code to automatically split the stack before it overflows.
11330 The resulting program has a discontiguous stack which can only
11331 overflow if the program is unable to allocate any more memory.  This
11332 is most useful when running threaded programs, as it is no longer
11333 necessary to calculate a good stack size to use for each thread.  This
11334 is currently only implemented for the x86 targets running
11335 GNU/Linux.
11337 When code compiled with @option{-fsplit-stack} calls code compiled
11338 without @option{-fsplit-stack}, there may not be much stack space
11339 available for the latter code to run.  If compiling all code,
11340 including library code, with @option{-fsplit-stack} is not an option,
11341 then the linker can fix up these calls so that the code compiled
11342 without @option{-fsplit-stack} always has a large stack.  Support for
11343 this is implemented in the gold linker in GNU binutils release 2.21
11344 and later.
11346 @item -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]}
11347 @opindex fvtable-verify
11348 This option is only available when compiling C++ code.
11349 It turns on (or off, if using @option{-fvtable-verify=none}) the security
11350 feature that verifies at run time, for every virtual call, that
11351 the vtable pointer through which the call is made is valid for the type of
11352 the object, and has not been corrupted or overwritten.  If an invalid vtable
11353 pointer is detected at run time, an error is reported and execution of the
11354 program is immediately halted.
11356 This option causes run-time data structures to be built at program startup,
11357 which are used for verifying the vtable pointers.  
11358 The options @samp{std} and @samp{preinit}
11359 control the timing of when these data structures are built.  In both cases the
11360 data structures are built before execution reaches @code{main}.  Using
11361 @option{-fvtable-verify=std} causes the data structures to be built after
11362 shared libraries have been loaded and initialized.
11363 @option{-fvtable-verify=preinit} causes them to be built before shared
11364 libraries have been loaded and initialized.
11366 If this option appears multiple times in the command line with different
11367 values specified, @samp{none} takes highest priority over both @samp{std} and
11368 @samp{preinit}; @samp{preinit} takes priority over @samp{std}.
11370 @item -fvtv-debug
11371 @opindex fvtv-debug
11372 When used in conjunction with @option{-fvtable-verify=std} or 
11373 @option{-fvtable-verify=preinit}, causes debug versions of the 
11374 runtime functions for the vtable verification feature to be called.  
11375 This flag also causes the compiler to log information about which 
11376 vtable pointers it finds for each class.
11377 This information is written to a file named @file{vtv_set_ptr_data.log} 
11378 in the directory named by the environment variable @env{VTV_LOGS_DIR} 
11379 if that is defined or the current working directory otherwise.
11381 Note:  This feature @emph{appends} data to the log file. If you want a fresh log
11382 file, be sure to delete any existing one.
11384 @item -fvtv-counts
11385 @opindex fvtv-counts
11386 This is a debugging flag.  When used in conjunction with
11387 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
11388 causes the compiler to keep track of the total number of virtual calls
11389 it encounters and the number of verifications it inserts.  It also
11390 counts the number of calls to certain run-time library functions
11391 that it inserts and logs this information for each compilation unit.
11392 The compiler writes this information to a file named
11393 @file{vtv_count_data.log} in the directory named by the environment
11394 variable @env{VTV_LOGS_DIR} if that is defined or the current working
11395 directory otherwise.  It also counts the size of the vtable pointer sets
11396 for each class, and writes this information to @file{vtv_class_set_sizes.log}
11397 in the same directory.
11399 Note:  This feature @emph{appends} data to the log files.  To get fresh log
11400 files, be sure to delete any existing ones.
11402 @item -finstrument-functions
11403 @opindex finstrument-functions
11404 Generate instrumentation calls for entry and exit to functions.  Just
11405 after function entry and just before function exit, the following
11406 profiling functions are called with the address of the current
11407 function and its call site.  (On some platforms,
11408 @code{__builtin_return_address} does not work beyond the current
11409 function, so the call site information may not be available to the
11410 profiling functions otherwise.)
11412 @smallexample
11413 void __cyg_profile_func_enter (void *this_fn,
11414                                void *call_site);
11415 void __cyg_profile_func_exit  (void *this_fn,
11416                                void *call_site);
11417 @end smallexample
11419 The first argument is the address of the start of the current function,
11420 which may be looked up exactly in the symbol table.
11422 This instrumentation is also done for functions expanded inline in other
11423 functions.  The profiling calls indicate where, conceptually, the
11424 inline function is entered and exited.  This means that addressable
11425 versions of such functions must be available.  If all your uses of a
11426 function are expanded inline, this may mean an additional expansion of
11427 code size.  If you use @code{extern inline} in your C code, an
11428 addressable version of such functions must be provided.  (This is
11429 normally the case anyway, but if you get lucky and the optimizer always
11430 expands the functions inline, you might have gotten away without
11431 providing static copies.)
11433 A function may be given the attribute @code{no_instrument_function}, in
11434 which case this instrumentation is not done.  This can be used, for
11435 example, for the profiling functions listed above, high-priority
11436 interrupt routines, and any functions from which the profiling functions
11437 cannot safely be called (perhaps signal handlers, if the profiling
11438 routines generate output or allocate memory).
11440 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
11441 @opindex finstrument-functions-exclude-file-list
11443 Set the list of functions that are excluded from instrumentation (see
11444 the description of @option{-finstrument-functions}).  If the file that
11445 contains a function definition matches with one of @var{file}, then
11446 that function is not instrumented.  The match is done on substrings:
11447 if the @var{file} parameter is a substring of the file name, it is
11448 considered to be a match.
11450 For example:
11452 @smallexample
11453 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
11454 @end smallexample
11456 @noindent
11457 excludes any inline function defined in files whose pathnames
11458 contain @file{/bits/stl} or @file{include/sys}.
11460 If, for some reason, you want to include letter @samp{,} in one of
11461 @var{sym}, write @samp{\,}. For example,
11462 @option{-finstrument-functions-exclude-file-list='\,\,tmp'}
11463 (note the single quote surrounding the option).
11465 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
11466 @opindex finstrument-functions-exclude-function-list
11468 This is similar to @option{-finstrument-functions-exclude-file-list},
11469 but this option sets the list of function names to be excluded from
11470 instrumentation.  The function name to be matched is its user-visible
11471 name, such as @code{vector<int> blah(const vector<int> &)}, not the
11472 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
11473 match is done on substrings: if the @var{sym} parameter is a substring
11474 of the function name, it is considered to be a match.  For C99 and C++
11475 extended identifiers, the function name must be given in UTF-8, not
11476 using universal character names.
11478 @end table
11481 @node Preprocessor Options
11482 @section Options Controlling the Preprocessor
11483 @cindex preprocessor options
11484 @cindex options, preprocessor
11486 These options control the C preprocessor, which is run on each C source
11487 file before actual compilation.
11489 If you use the @option{-E} option, nothing is done except preprocessing.
11490 Some of these options make sense only together with @option{-E} because
11491 they cause the preprocessor output to be unsuitable for actual
11492 compilation.
11494 In addition to the options listed here, there are a number of options 
11495 to control search paths for include files documented in 
11496 @ref{Directory Options}.  
11497 Options to control preprocessor diagnostics are listed in 
11498 @ref{Warning Options}.
11500 @table @gcctabopt
11501 @include cppopts.texi
11503 @item -Wp,@var{option}
11504 @opindex Wp
11505 You can use @option{-Wp,@var{option}} to bypass the compiler driver
11506 and pass @var{option} directly through to the preprocessor.  If
11507 @var{option} contains commas, it is split into multiple options at the
11508 commas.  However, many options are modified, translated or interpreted
11509 by the compiler driver before being passed to the preprocessor, and
11510 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
11511 interface is undocumented and subject to change, so whenever possible
11512 you should avoid using @option{-Wp} and let the driver handle the
11513 options instead.
11515 @item -Xpreprocessor @var{option}
11516 @opindex Xpreprocessor
11517 Pass @var{option} as an option to the preprocessor.  You can use this to
11518 supply system-specific preprocessor options that GCC does not 
11519 recognize.
11521 If you want to pass an option that takes an argument, you must use
11522 @option{-Xpreprocessor} twice, once for the option and once for the argument.
11524 @item -no-integrated-cpp
11525 @opindex no-integrated-cpp
11526 Perform preprocessing as a separate pass before compilation.
11527 By default, GCC performs preprocessing as an integrated part of
11528 input tokenization and parsing.
11529 If this option is provided, the appropriate language front end
11530 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
11531 and Objective-C, respectively) is instead invoked twice,
11532 once for preprocessing only and once for actual compilation
11533 of the preprocessed input.
11534 This option may be useful in conjunction with the @option{-B} or
11535 @option{-wrapper} options to specify an alternate preprocessor or
11536 perform additional processing of the program source between
11537 normal preprocessing and compilation.
11539 @end table
11541 @node Assembler Options
11542 @section Passing Options to the Assembler
11544 @c prevent bad page break with this line
11545 You can pass options to the assembler.
11547 @table @gcctabopt
11548 @item -Wa,@var{option}
11549 @opindex Wa
11550 Pass @var{option} as an option to the assembler.  If @var{option}
11551 contains commas, it is split into multiple options at the commas.
11553 @item -Xassembler @var{option}
11554 @opindex Xassembler
11555 Pass @var{option} as an option to the assembler.  You can use this to
11556 supply system-specific assembler options that GCC does not
11557 recognize.
11559 If you want to pass an option that takes an argument, you must use
11560 @option{-Xassembler} twice, once for the option and once for the argument.
11562 @end table
11564 @node Link Options
11565 @section Options for Linking
11566 @cindex link options
11567 @cindex options, linking
11569 These options come into play when the compiler links object files into
11570 an executable output file.  They are meaningless if the compiler is
11571 not doing a link step.
11573 @table @gcctabopt
11574 @cindex file names
11575 @item @var{object-file-name}
11576 A file name that does not end in a special recognized suffix is
11577 considered to name an object file or library.  (Object files are
11578 distinguished from libraries by the linker according to the file
11579 contents.)  If linking is done, these object files are used as input
11580 to the linker.
11582 @item -c
11583 @itemx -S
11584 @itemx -E
11585 @opindex c
11586 @opindex S
11587 @opindex E
11588 If any of these options is used, then the linker is not run, and
11589 object file names should not be used as arguments.  @xref{Overall
11590 Options}.
11592 @item -fuse-ld=bfd
11593 @opindex fuse-ld=bfd
11594 Use the @command{bfd} linker instead of the default linker.
11596 @item -fuse-ld=gold
11597 @opindex fuse-ld=gold
11598 Use the @command{gold} linker instead of the default linker.
11600 @cindex Libraries
11601 @item -l@var{library}
11602 @itemx -l @var{library}
11603 @opindex l
11604 Search the library named @var{library} when linking.  (The second
11605 alternative with the library as a separate argument is only for
11606 POSIX compliance and is not recommended.)
11608 It makes a difference where in the command you write this option; the
11609 linker searches and processes libraries and object files in the order they
11610 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
11611 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
11612 to functions in @samp{z}, those functions may not be loaded.
11614 The linker searches a standard list of directories for the library,
11615 which is actually a file named @file{lib@var{library}.a}.  The linker
11616 then uses this file as if it had been specified precisely by name.
11618 The directories searched include several standard system directories
11619 plus any that you specify with @option{-L}.
11621 Normally the files found this way are library files---archive files
11622 whose members are object files.  The linker handles an archive file by
11623 scanning through it for members which define symbols that have so far
11624 been referenced but not defined.  But if the file that is found is an
11625 ordinary object file, it is linked in the usual fashion.  The only
11626 difference between using an @option{-l} option and specifying a file name
11627 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
11628 and searches several directories.
11630 @item -lobjc
11631 @opindex lobjc
11632 You need this special case of the @option{-l} option in order to
11633 link an Objective-C or Objective-C++ program.
11635 @item -nostartfiles
11636 @opindex nostartfiles
11637 Do not use the standard system startup files when linking.
11638 The standard system libraries are used normally, unless @option{-nostdlib}
11639 or @option{-nodefaultlibs} is used.
11641 @item -nodefaultlibs
11642 @opindex nodefaultlibs
11643 Do not use the standard system libraries when linking.
11644 Only the libraries you specify are passed to the linker, and options
11645 specifying linkage of the system libraries, such as @option{-static-libgcc}
11646 or @option{-shared-libgcc}, are ignored.  
11647 The standard startup files are used normally, unless @option{-nostartfiles}
11648 is used.  
11650 The compiler may generate calls to @code{memcmp},
11651 @code{memset}, @code{memcpy} and @code{memmove}.
11652 These entries are usually resolved by entries in
11653 libc.  These entry points should be supplied through some other
11654 mechanism when this option is specified.
11656 @item -nostdlib
11657 @opindex nostdlib
11658 Do not use the standard system startup files or libraries when linking.
11659 No startup files and only the libraries you specify are passed to
11660 the linker, and options specifying linkage of the system libraries, such as
11661 @option{-static-libgcc} or @option{-shared-libgcc}, are ignored.
11663 The compiler may generate calls to @code{memcmp}, @code{memset},
11664 @code{memcpy} and @code{memmove}.
11665 These entries are usually resolved by entries in
11666 libc.  These entry points should be supplied through some other
11667 mechanism when this option is specified.
11669 @cindex @option{-lgcc}, use with @option{-nostdlib}
11670 @cindex @option{-nostdlib} and unresolved references
11671 @cindex unresolved references and @option{-nostdlib}
11672 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
11673 @cindex @option{-nodefaultlibs} and unresolved references
11674 @cindex unresolved references and @option{-nodefaultlibs}
11675 One of the standard libraries bypassed by @option{-nostdlib} and
11676 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
11677 which GCC uses to overcome shortcomings of particular machines, or special
11678 needs for some languages.
11679 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
11680 Collection (GCC) Internals},
11681 for more discussion of @file{libgcc.a}.)
11682 In most cases, you need @file{libgcc.a} even when you want to avoid
11683 other standard libraries.  In other words, when you specify @option{-nostdlib}
11684 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
11685 This ensures that you have no unresolved references to internal GCC
11686 library subroutines.
11687 (An example of such an internal subroutine is @code{__main}, used to ensure C++
11688 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
11689 GNU Compiler Collection (GCC) Internals}.)
11691 @item -pie
11692 @opindex pie
11693 Produce a position independent executable on targets that support it.
11694 For predictable results, you must also specify the same set of options
11695 used for compilation (@option{-fpie}, @option{-fPIE},
11696 or model suboptions) when you specify this linker option.
11698 @item -no-pie
11699 @opindex no-pie
11700 Don't produce a position independent executable.
11702 @item -pthread
11703 @opindex pthread
11704 Link with the POSIX threads library.  This option is supported on 
11705 GNU/Linux targets, most other Unix derivatives, and also on 
11706 x86 Cygwin and MinGW targets.  On some targets this option also sets 
11707 flags for the preprocessor, so it should be used consistently for both
11708 compilation and linking.
11710 @item -rdynamic
11711 @opindex rdynamic
11712 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
11713 that support it. This instructs the linker to add all symbols, not
11714 only used ones, to the dynamic symbol table. This option is needed
11715 for some uses of @code{dlopen} or to allow obtaining backtraces
11716 from within a program.
11718 @item -s
11719 @opindex s
11720 Remove all symbol table and relocation information from the executable.
11722 @item -static
11723 @opindex static
11724 On systems that support dynamic linking, this prevents linking with the shared
11725 libraries.  On other systems, this option has no effect.
11727 @item -shared
11728 @opindex shared
11729 Produce a shared object which can then be linked with other objects to
11730 form an executable.  Not all systems support this option.  For predictable
11731 results, you must also specify the same set of options used for compilation
11732 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
11733 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
11734 needs to build supplementary stub code for constructors to work.  On
11735 multi-libbed systems, @samp{gcc -shared} must select the correct support
11736 libraries to link against.  Failing to supply the correct flags may lead
11737 to subtle defects.  Supplying them in cases where they are not necessary
11738 is innocuous.}
11740 @item -shared-libgcc
11741 @itemx -static-libgcc
11742 @opindex shared-libgcc
11743 @opindex static-libgcc
11744 On systems that provide @file{libgcc} as a shared library, these options
11745 force the use of either the shared or static version, respectively.
11746 If no shared version of @file{libgcc} was built when the compiler was
11747 configured, these options have no effect.
11749 There are several situations in which an application should use the
11750 shared @file{libgcc} instead of the static version.  The most common
11751 of these is when the application wishes to throw and catch exceptions
11752 across different shared libraries.  In that case, each of the libraries
11753 as well as the application itself should use the shared @file{libgcc}.
11755 Therefore, the G++ and driver automatically adds @option{-shared-libgcc}
11756  whenever you build a shared library or a main executable, because C++
11757  programs typically use exceptions, so this is the right thing to do.
11759 If, instead, you use the GCC driver to create shared libraries, you may
11760 find that they are not always linked with the shared @file{libgcc}.
11761 If GCC finds, at its configuration time, that you have a non-GNU linker
11762 or a GNU linker that does not support option @option{--eh-frame-hdr},
11763 it links the shared version of @file{libgcc} into shared libraries
11764 by default.  Otherwise, it takes advantage of the linker and optimizes
11765 away the linking with the shared version of @file{libgcc}, linking with
11766 the static version of libgcc by default.  This allows exceptions to
11767 propagate through such shared libraries, without incurring relocation
11768 costs at library load time.
11770 However, if a library or main executable is supposed to throw or catch
11771 exceptions, you must link it using the G++ driver, as appropriate
11772 for the languages used in the program, or using the option
11773 @option{-shared-libgcc}, such that it is linked with the shared
11774 @file{libgcc}.
11776 @item -static-libasan
11777 @opindex static-libasan
11778 When the @option{-fsanitize=address} option is used to link a program,
11779 the GCC driver automatically links against @option{libasan}.  If
11780 @file{libasan} is available as a shared library, and the @option{-static}
11781 option is not used, then this links against the shared version of
11782 @file{libasan}.  The @option{-static-libasan} option directs the GCC
11783 driver to link @file{libasan} statically, without necessarily linking
11784 other libraries statically.
11786 @item -static-libtsan
11787 @opindex static-libtsan
11788 When the @option{-fsanitize=thread} option is used to link a program,
11789 the GCC driver automatically links against @option{libtsan}.  If
11790 @file{libtsan} is available as a shared library, and the @option{-static}
11791 option is not used, then this links against the shared version of
11792 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
11793 driver to link @file{libtsan} statically, without necessarily linking
11794 other libraries statically.
11796 @item -static-liblsan
11797 @opindex static-liblsan
11798 When the @option{-fsanitize=leak} option is used to link a program,
11799 the GCC driver automatically links against @option{liblsan}.  If
11800 @file{liblsan} is available as a shared library, and the @option{-static}
11801 option is not used, then this links against the shared version of
11802 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
11803 driver to link @file{liblsan} statically, without necessarily linking
11804 other libraries statically.
11806 @item -static-libubsan
11807 @opindex static-libubsan
11808 When the @option{-fsanitize=undefined} option is used to link a program,
11809 the GCC driver automatically links against @option{libubsan}.  If
11810 @file{libubsan} is available as a shared library, and the @option{-static}
11811 option is not used, then this links against the shared version of
11812 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
11813 driver to link @file{libubsan} statically, without necessarily linking
11814 other libraries statically.
11816 @item -static-libmpx
11817 @opindex static-libmpx
11818 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are
11819 used to link a program, the GCC driver automatically links against
11820 @file{libmpx}.  If @file{libmpx} is available as a shared library,
11821 and the @option{-static} option is not used, then this links against
11822 the shared version of @file{libmpx}.  The @option{-static-libmpx}
11823 option directs the GCC driver to link @file{libmpx} statically,
11824 without necessarily linking other libraries statically.
11826 @item -static-libmpxwrappers
11827 @opindex static-libmpxwrappers
11828 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are used
11829 to link a program without also using @option{-fno-chkp-use-wrappers}, the
11830 GCC driver automatically links against @file{libmpxwrappers}.  If
11831 @file{libmpxwrappers} is available as a shared library, and the
11832 @option{-static} option is not used, then this links against the shared
11833 version of @file{libmpxwrappers}.  The @option{-static-libmpxwrappers}
11834 option directs the GCC driver to link @file{libmpxwrappers} statically,
11835 without necessarily linking other libraries statically.
11837 @item -static-libstdc++
11838 @opindex static-libstdc++
11839 When the @command{g++} program is used to link a C++ program, it
11840 normally automatically links against @option{libstdc++}.  If
11841 @file{libstdc++} is available as a shared library, and the
11842 @option{-static} option is not used, then this links against the
11843 shared version of @file{libstdc++}.  That is normally fine.  However, it
11844 is sometimes useful to freeze the version of @file{libstdc++} used by
11845 the program without going all the way to a fully static link.  The
11846 @option{-static-libstdc++} option directs the @command{g++} driver to
11847 link @file{libstdc++} statically, without necessarily linking other
11848 libraries statically.
11850 @item -symbolic
11851 @opindex symbolic
11852 Bind references to global symbols when building a shared object.  Warn
11853 about any unresolved references (unless overridden by the link editor
11854 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
11855 this option.
11857 @item -T @var{script}
11858 @opindex T
11859 @cindex linker script
11860 Use @var{script} as the linker script.  This option is supported by most
11861 systems using the GNU linker.  On some targets, such as bare-board
11862 targets without an operating system, the @option{-T} option may be required
11863 when linking to avoid references to undefined symbols.
11865 @item -Xlinker @var{option}
11866 @opindex Xlinker
11867 Pass @var{option} as an option to the linker.  You can use this to
11868 supply system-specific linker options that GCC does not recognize.
11870 If you want to pass an option that takes a separate argument, you must use
11871 @option{-Xlinker} twice, once for the option and once for the argument.
11872 For example, to pass @option{-assert definitions}, you must write
11873 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
11874 @option{-Xlinker "-assert definitions"}, because this passes the entire
11875 string as a single argument, which is not what the linker expects.
11877 When using the GNU linker, it is usually more convenient to pass
11878 arguments to linker options using the @option{@var{option}=@var{value}}
11879 syntax than as separate arguments.  For example, you can specify
11880 @option{-Xlinker -Map=output.map} rather than
11881 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
11882 this syntax for command-line options.
11884 @item -Wl,@var{option}
11885 @opindex Wl
11886 Pass @var{option} as an option to the linker.  If @var{option} contains
11887 commas, it is split into multiple options at the commas.  You can use this
11888 syntax to pass an argument to the option.
11889 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
11890 linker.  When using the GNU linker, you can also get the same effect with
11891 @option{-Wl,-Map=output.map}.
11893 @item -u @var{symbol}
11894 @opindex u
11895 Pretend the symbol @var{symbol} is undefined, to force linking of
11896 library modules to define it.  You can use @option{-u} multiple times with
11897 different symbols to force loading of additional library modules.
11899 @item -z @var{keyword}
11900 @opindex z
11901 @option{-z} is passed directly on to the linker along with the keyword
11902 @var{keyword}. See the section in the documentation of your linker for
11903 permitted values and their meanings.
11904 @end table
11906 @node Directory Options
11907 @section Options for Directory Search
11908 @cindex directory options
11909 @cindex options, directory search
11910 @cindex search path
11912 These options specify directories to search for header files, for
11913 libraries and for parts of the compiler:
11915 @table @gcctabopt
11916 @include cppdiropts.texi
11918 @item -iplugindir=@var{dir}
11919 @opindex iplugindir=
11920 Set the directory to search for plugins that are passed
11921 by @option{-fplugin=@var{name}} instead of
11922 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
11923 to be used by the user, but only passed by the driver.
11925 @item -L@var{dir}
11926 @opindex L
11927 Add directory @var{dir} to the list of directories to be searched
11928 for @option{-l}.
11930 @item -B@var{prefix}
11931 @opindex B
11932 This option specifies where to find the executables, libraries,
11933 include files, and data files of the compiler itself.
11935 The compiler driver program runs one or more of the subprograms
11936 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
11937 @var{prefix} as a prefix for each program it tries to run, both with and
11938 without @samp{@var{machine}/@var{version}/} for the corresponding target
11939 machine and compiler version.
11941 For each subprogram to be run, the compiler driver first tries the
11942 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
11943 is not specified, the driver tries two standard prefixes, 
11944 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
11945 those results in a file name that is found, the unmodified program
11946 name is searched for using the directories specified in your
11947 @env{PATH} environment variable.
11949 The compiler checks to see if the path provided by @option{-B}
11950 refers to a directory, and if necessary it adds a directory
11951 separator character at the end of the path.
11953 @option{-B} prefixes that effectively specify directory names also apply
11954 to libraries in the linker, because the compiler translates these
11955 options into @option{-L} options for the linker.  They also apply to
11956 include files in the preprocessor, because the compiler translates these
11957 options into @option{-isystem} options for the preprocessor.  In this case,
11958 the compiler appends @samp{include} to the prefix.
11960 The runtime support file @file{libgcc.a} can also be searched for using
11961 the @option{-B} prefix, if needed.  If it is not found there, the two
11962 standard prefixes above are tried, and that is all.  The file is left
11963 out of the link if it is not found by those means.
11965 Another way to specify a prefix much like the @option{-B} prefix is to use
11966 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
11967 Variables}.
11969 As a special kludge, if the path provided by @option{-B} is
11970 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
11971 9, then it is replaced by @file{[dir/]include}.  This is to help
11972 with boot-strapping the compiler.
11974 @item -no-canonical-prefixes
11975 @opindex no-canonical-prefixes
11976 Do not expand any symbolic links, resolve references to @samp{/../}
11977 or @samp{/./}, or make the path absolute when generating a relative
11978 prefix.
11980 @item --sysroot=@var{dir}
11981 @opindex sysroot
11982 Use @var{dir} as the logical root directory for headers and libraries.
11983 For example, if the compiler normally searches for headers in
11984 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
11985 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
11987 If you use both this option and the @option{-isysroot} option, then
11988 the @option{--sysroot} option applies to libraries, but the
11989 @option{-isysroot} option applies to header files.
11991 The GNU linker (beginning with version 2.16) has the necessary support
11992 for this option.  If your linker does not support this option, the
11993 header file aspect of @option{--sysroot} still works, but the
11994 library aspect does not.
11996 @item --no-sysroot-suffix
11997 @opindex no-sysroot-suffix
11998 For some targets, a suffix is added to the root directory specified
11999 with @option{--sysroot}, depending on the other options used, so that
12000 headers may for example be found in
12001 @file{@var{dir}/@var{suffix}/usr/include} instead of
12002 @file{@var{dir}/usr/include}.  This option disables the addition of
12003 such a suffix.
12005 @end table
12007 @node Code Gen Options
12008 @section Options for Code Generation Conventions
12009 @cindex code generation conventions
12010 @cindex options, code generation
12011 @cindex run-time options
12013 These machine-independent options control the interface conventions
12014 used in code generation.
12016 Most of them have both positive and negative forms; the negative form
12017 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
12018 one of the forms is listed---the one that is not the default.  You
12019 can figure out the other form by either removing @samp{no-} or adding
12022 @table @gcctabopt
12023 @item -fstack-reuse=@var{reuse-level}
12024 @opindex fstack_reuse
12025 This option controls stack space reuse for user declared local/auto variables
12026 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
12027 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
12028 local variables and temporaries, @samp{named_vars} enables the reuse only for
12029 user defined local variables with names, and @samp{none} disables stack reuse
12030 completely. The default value is @samp{all}. The option is needed when the
12031 program extends the lifetime of a scoped local variable or a compiler generated
12032 temporary beyond the end point defined by the language.  When a lifetime of
12033 a variable ends, and if the variable lives in memory, the optimizing compiler
12034 has the freedom to reuse its stack space with other temporaries or scoped
12035 local variables whose live range does not overlap with it. Legacy code extending
12036 local lifetime is likely to break with the stack reuse optimization.
12038 For example,
12040 @smallexample
12041    int *p;
12042    @{
12043      int local1;
12045      p = &local1;
12046      local1 = 10;
12047      ....
12048    @}
12049    @{
12050       int local2;
12051       local2 = 20;
12052       ...
12053    @}
12055    if (*p == 10)  // out of scope use of local1
12056      @{
12058      @}
12059 @end smallexample
12061 Another example:
12062 @smallexample
12064    struct A
12065    @{
12066        A(int k) : i(k), j(k) @{ @}
12067        int i;
12068        int j;
12069    @};
12071    A *ap;
12073    void foo(const A& ar)
12074    @{
12075       ap = &ar;
12076    @}
12078    void bar()
12079    @{
12080       foo(A(10)); // temp object's lifetime ends when foo returns
12082       @{
12083         A a(20);
12084         ....
12085       @}
12086       ap->i+= 10;  // ap references out of scope temp whose space
12087                    // is reused with a. What is the value of ap->i?
12088    @}
12090 @end smallexample
12092 The lifetime of a compiler generated temporary is well defined by the C++
12093 standard. When a lifetime of a temporary ends, and if the temporary lives
12094 in memory, the optimizing compiler has the freedom to reuse its stack
12095 space with other temporaries or scoped local variables whose live range
12096 does not overlap with it. However some of the legacy code relies on
12097 the behavior of older compilers in which temporaries' stack space is
12098 not reused, the aggressive stack reuse can lead to runtime errors. This
12099 option is used to control the temporary stack reuse optimization.
12101 @item -ftrapv
12102 @opindex ftrapv
12103 This option generates traps for signed overflow on addition, subtraction,
12104 multiplication operations.
12105 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12106 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12107 @option{-fwrapv} being effective.  Note that only active options override, so
12108 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12109 results in @option{-ftrapv} being effective.
12111 @item -fwrapv
12112 @opindex fwrapv
12113 This option instructs the compiler to assume that signed arithmetic
12114 overflow of addition, subtraction and multiplication wraps around
12115 using twos-complement representation.  This flag enables some optimizations
12116 and disables others.
12117 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12118 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12119 @option{-fwrapv} being effective.  Note that only active options override, so
12120 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12121 results in @option{-ftrapv} being effective.
12123 @item -fexceptions
12124 @opindex fexceptions
12125 Enable exception handling.  Generates extra code needed to propagate
12126 exceptions.  For some targets, this implies GCC generates frame
12127 unwind information for all functions, which can produce significant data
12128 size overhead, although it does not affect execution.  If you do not
12129 specify this option, GCC enables it by default for languages like
12130 C++ that normally require exception handling, and disables it for
12131 languages like C that do not normally require it.  However, you may need
12132 to enable this option when compiling C code that needs to interoperate
12133 properly with exception handlers written in C++.  You may also wish to
12134 disable this option if you are compiling older C++ programs that don't
12135 use exception handling.
12137 @item -fnon-call-exceptions
12138 @opindex fnon-call-exceptions
12139 Generate code that allows trapping instructions to throw exceptions.
12140 Note that this requires platform-specific runtime support that does
12141 not exist everywhere.  Moreover, it only allows @emph{trapping}
12142 instructions to throw exceptions, i.e.@: memory references or floating-point
12143 instructions.  It does not allow exceptions to be thrown from
12144 arbitrary signal handlers such as @code{SIGALRM}.
12146 @item -fdelete-dead-exceptions
12147 @opindex fdelete-dead-exceptions
12148 Consider that instructions that may throw exceptions but don't otherwise
12149 contribute to the execution of the program can be optimized away.
12150 This option is enabled by default for the Ada front end, as permitted by
12151 the Ada language specification.
12152 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
12154 @item -funwind-tables
12155 @opindex funwind-tables
12156 Similar to @option{-fexceptions}, except that it just generates any needed
12157 static data, but does not affect the generated code in any other way.
12158 You normally do not need to enable this option; instead, a language processor
12159 that needs this handling enables it on your behalf.
12161 @item -fasynchronous-unwind-tables
12162 @opindex fasynchronous-unwind-tables
12163 Generate unwind table in DWARF format, if supported by target machine.  The
12164 table is exact at each instruction boundary, so it can be used for stack
12165 unwinding from asynchronous events (such as debugger or garbage collector).
12167 @item -fno-gnu-unique
12168 @opindex fno-gnu-unique
12169 On systems with recent GNU assembler and C library, the C++ compiler
12170 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
12171 of template static data members and static local variables in inline
12172 functions are unique even in the presence of @code{RTLD_LOCAL}; this
12173 is necessary to avoid problems with a library used by two different
12174 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
12175 therefore disagreeing with the other one about the binding of the
12176 symbol.  But this causes @code{dlclose} to be ignored for affected
12177 DSOs; if your program relies on reinitialization of a DSO via
12178 @code{dlclose} and @code{dlopen}, you can use
12179 @option{-fno-gnu-unique}.
12181 @item -fpcc-struct-return
12182 @opindex fpcc-struct-return
12183 Return ``short'' @code{struct} and @code{union} values in memory like
12184 longer ones, rather than in registers.  This convention is less
12185 efficient, but it has the advantage of allowing intercallability between
12186 GCC-compiled files and files compiled with other compilers, particularly
12187 the Portable C Compiler (pcc).
12189 The precise convention for returning structures in memory depends
12190 on the target configuration macros.
12192 Short structures and unions are those whose size and alignment match
12193 that of some integer type.
12195 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12196 switch is not binary compatible with code compiled with the
12197 @option{-freg-struct-return} switch.
12198 Use it to conform to a non-default application binary interface.
12200 @item -freg-struct-return
12201 @opindex freg-struct-return
12202 Return @code{struct} and @code{union} values in registers when possible.
12203 This is more efficient for small structures than
12204 @option{-fpcc-struct-return}.
12206 If you specify neither @option{-fpcc-struct-return} nor
12207 @option{-freg-struct-return}, GCC defaults to whichever convention is
12208 standard for the target.  If there is no standard convention, GCC
12209 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12210 the principal compiler.  In those cases, we can choose the standard, and
12211 we chose the more efficient register return alternative.
12213 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12214 switch is not binary compatible with code compiled with the
12215 @option{-fpcc-struct-return} switch.
12216 Use it to conform to a non-default application binary interface.
12218 @item -fshort-enums
12219 @opindex fshort-enums
12220 Allocate to an @code{enum} type only as many bytes as it needs for the
12221 declared range of possible values.  Specifically, the @code{enum} type
12222 is equivalent to the smallest integer type that has enough room.
12224 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12225 code that is not binary compatible with code generated without that switch.
12226 Use it to conform to a non-default application binary interface.
12228 @item -fshort-wchar
12229 @opindex fshort-wchar
12230 Override the underlying type for @code{wchar_t} to be @code{short
12231 unsigned int} instead of the default for the target.  This option is
12232 useful for building programs to run under WINE@.
12234 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12235 code that is not binary compatible with code generated without that switch.
12236 Use it to conform to a non-default application binary interface.
12238 @item -fno-common
12239 @opindex fno-common
12240 @cindex tentative definitions
12241 In C code, this option controls the placement of global variables 
12242 defined without an initializer, known as @dfn{tentative definitions} 
12243 in the C standard.  Tentative definitions are distinct from declarations 
12244 of a variable with the @code{extern} keyword, which do not allocate storage.
12246 Unix C compilers have traditionally allocated storage for
12247 uninitialized global variables in a common block.  This allows the
12248 linker to resolve all tentative definitions of the same variable
12249 in different compilation units to the same object, or to a non-tentative
12250 definition.  
12251 This is the behavior specified by @option{-fcommon}, and is the default for 
12252 GCC on most targets.  
12253 On the other hand, this behavior is not required by ISO
12254 C, and on some targets may carry a speed or code size penalty on
12255 variable references.
12257 The @option{-fno-common} option specifies that the compiler should instead
12258 place uninitialized global variables in the data section of the object file.
12259 This inhibits the merging of tentative definitions by the linker so
12260 you get a multiple-definition error if the same 
12261 variable is defined in more than one compilation unit.
12262 Compiling with @option{-fno-common} is useful on targets for which
12263 it provides better performance, or if you wish to verify that the
12264 program will work on other systems that always treat uninitialized
12265 variable definitions this way.
12267 @item -fno-ident
12268 @opindex fno-ident
12269 Ignore the @code{#ident} directive.
12271 @item -finhibit-size-directive
12272 @opindex finhibit-size-directive
12273 Don't output a @code{.size} assembler directive, or anything else that
12274 would cause trouble if the function is split in the middle, and the
12275 two halves are placed at locations far apart in memory.  This option is
12276 used when compiling @file{crtstuff.c}; you should not need to use it
12277 for anything else.
12279 @item -fverbose-asm
12280 @opindex fverbose-asm
12281 Put extra commentary information in the generated assembly code to
12282 make it more readable.  This option is generally only of use to those
12283 who actually need to read the generated assembly code (perhaps while
12284 debugging the compiler itself).
12286 @option{-fno-verbose-asm}, the default, causes the
12287 extra information to be omitted and is useful when comparing two assembler
12288 files.
12290 The added comments include:
12292 @itemize @bullet
12294 @item
12295 information on the compiler version and command-line options,
12297 @item
12298 the source code lines associated with the assembly instructions,
12299 in the form FILENAME:LINENUMBER:CONTENT OF LINE,
12301 @item
12302 hints on which high-level expressions correspond to
12303 the various assembly instruction operands.
12305 @end itemize
12307 For example, given this C source file:
12309 @smallexample
12310 int test (int n)
12312   int i;
12313   int total = 0;
12315   for (i = 0; i < n; i++)
12316     total += i * i;
12318   return total;
12320 @end smallexample
12322 compiling to (x86_64) assembly via @option{-S} and emitting the result
12323 direct to stdout via @option{-o} @option{-}
12325 @smallexample
12326 gcc -S test.c -fverbose-asm -Os -o -
12327 @end smallexample
12329 gives output similar to this:
12331 @smallexample
12332         .file   "test.c"
12333 # GNU C11 (GCC) version 7.0.0 20160809 (experimental) (x86_64-pc-linux-gnu)
12334   [...snip...]
12335 # options passed:
12336   [...snip...]
12338         .text
12339         .globl  test
12340         .type   test, @@function
12341 test:
12342 .LFB0:
12343         .cfi_startproc
12344 # test.c:4:   int total = 0;
12345         xorl    %eax, %eax      # <retval>
12346 # test.c:6:   for (i = 0; i < n; i++)
12347         xorl    %edx, %edx      # i
12348 .L2:
12349 # test.c:6:   for (i = 0; i < n; i++)
12350         cmpl    %edi, %edx      # n, i
12351         jge     .L5     #,
12352 # test.c:7:     total += i * i;
12353         movl    %edx, %ecx      # i, tmp92
12354         imull   %edx, %ecx      # i, tmp92
12355 # test.c:6:   for (i = 0; i < n; i++)
12356         incl    %edx    # i
12357 # test.c:7:     total += i * i;
12358         addl    %ecx, %eax      # tmp92, <retval>
12359         jmp     .L2     #
12360 .L5:
12361 # test.c:10: @}
12362         ret
12363         .cfi_endproc
12364 .LFE0:
12365         .size   test, .-test
12366         .ident  "GCC: (GNU) 7.0.0 20160809 (experimental)"
12367         .section        .note.GNU-stack,"",@@progbits
12368 @end smallexample
12370 The comments are intended for humans rather than machines and hence the
12371 precise format of the comments is subject to change.
12373 @item -frecord-gcc-switches
12374 @opindex frecord-gcc-switches
12375 This switch causes the command line used to invoke the
12376 compiler to be recorded into the object file that is being created.
12377 This switch is only implemented on some targets and the exact format
12378 of the recording is target and binary file format dependent, but it
12379 usually takes the form of a section containing ASCII text.  This
12380 switch is related to the @option{-fverbose-asm} switch, but that
12381 switch only records information in the assembler output file as
12382 comments, so it never reaches the object file.
12383 See also @option{-grecord-gcc-switches} for another
12384 way of storing compiler options into the object file.
12386 @item -fpic
12387 @opindex fpic
12388 @cindex global offset table
12389 @cindex PIC
12390 Generate position-independent code (PIC) suitable for use in a shared
12391 library, if supported for the target machine.  Such code accesses all
12392 constant addresses through a global offset table (GOT)@.  The dynamic
12393 loader resolves the GOT entries when the program starts (the dynamic
12394 loader is not part of GCC; it is part of the operating system).  If
12395 the GOT size for the linked executable exceeds a machine-specific
12396 maximum size, you get an error message from the linker indicating that
12397 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
12398 instead.  (These maximums are 8k on the SPARC, 28k on AArch64 and 32k
12399 on the m68k and RS/6000.  The x86 has no such limit.)
12401 Position-independent code requires special support, and therefore works
12402 only on certain machines.  For the x86, GCC supports PIC for System V
12403 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
12404 position-independent.
12406 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12407 are defined to 1.
12409 @item -fPIC
12410 @opindex fPIC
12411 If supported for the target machine, emit position-independent code,
12412 suitable for dynamic linking and avoiding any limit on the size of the
12413 global offset table.  This option makes a difference on AArch64, m68k,
12414 PowerPC and SPARC@.
12416 Position-independent code requires special support, and therefore works
12417 only on certain machines.
12419 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12420 are defined to 2.
12422 @item -fpie
12423 @itemx -fPIE
12424 @opindex fpie
12425 @opindex fPIE
12426 These options are similar to @option{-fpic} and @option{-fPIC}, but
12427 generated position independent code can be only linked into executables.
12428 Usually these options are used when @option{-pie} GCC option is
12429 used during linking.
12431 @option{-fpie} and @option{-fPIE} both define the macros
12432 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
12433 for @option{-fpie} and 2 for @option{-fPIE}.
12435 @item -fno-plt
12436 @opindex fno-plt
12437 Do not use the PLT for external function calls in position-independent code.
12438 Instead, load the callee address at call sites from the GOT and branch to it.
12439 This leads to more efficient code by eliminating PLT stubs and exposing
12440 GOT loads to optimizations.  On architectures such as 32-bit x86 where
12441 PLT stubs expect the GOT pointer in a specific register, this gives more
12442 register allocation freedom to the compiler.
12443 Lazy binding requires use of the PLT; 
12444 with @option{-fno-plt} all external symbols are resolved at load time.
12446 Alternatively, the function attribute @code{noplt} can be used to avoid calls
12447 through the PLT for specific external functions.
12449 In position-dependent code, a few targets also convert calls to
12450 functions that are marked to not use the PLT to use the GOT instead.
12452 @item -fno-jump-tables
12453 @opindex fno-jump-tables
12454 Do not use jump tables for switch statements even where it would be
12455 more efficient than other code generation strategies.  This option is
12456 of use in conjunction with @option{-fpic} or @option{-fPIC} for
12457 building code that forms part of a dynamic linker and cannot
12458 reference the address of a jump table.  On some targets, jump tables
12459 do not require a GOT and this option is not needed.
12461 @item -ffixed-@var{reg}
12462 @opindex ffixed
12463 Treat the register named @var{reg} as a fixed register; generated code
12464 should never refer to it (except perhaps as a stack pointer, frame
12465 pointer or in some other fixed role).
12467 @var{reg} must be the name of a register.  The register names accepted
12468 are machine-specific and are defined in the @code{REGISTER_NAMES}
12469 macro in the machine description macro file.
12471 This flag does not have a negative form, because it specifies a
12472 three-way choice.
12474 @item -fcall-used-@var{reg}
12475 @opindex fcall-used
12476 Treat the register named @var{reg} as an allocable register that is
12477 clobbered by function calls.  It may be allocated for temporaries or
12478 variables that do not live across a call.  Functions compiled this way
12479 do not save and restore the register @var{reg}.
12481 It is an error to use this flag with the frame pointer or stack pointer.
12482 Use of this flag for other registers that have fixed pervasive roles in
12483 the machine's execution model produces disastrous results.
12485 This flag does not have a negative form, because it specifies a
12486 three-way choice.
12488 @item -fcall-saved-@var{reg}
12489 @opindex fcall-saved
12490 Treat the register named @var{reg} as an allocable register saved by
12491 functions.  It may be allocated even for temporaries or variables that
12492 live across a call.  Functions compiled this way save and restore
12493 the register @var{reg} if they use it.
12495 It is an error to use this flag with the frame pointer or stack pointer.
12496 Use of this flag for other registers that have fixed pervasive roles in
12497 the machine's execution model produces disastrous results.
12499 A different sort of disaster results from the use of this flag for
12500 a register in which function values may be returned.
12502 This flag does not have a negative form, because it specifies a
12503 three-way choice.
12505 @item -fpack-struct[=@var{n}]
12506 @opindex fpack-struct
12507 Without a value specified, pack all structure members together without
12508 holes.  When a value is specified (which must be a small power of two), pack
12509 structure members according to this value, representing the maximum
12510 alignment (that is, objects with default alignment requirements larger than
12511 this are output potentially unaligned at the next fitting location.
12513 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
12514 code that is not binary compatible with code generated without that switch.
12515 Additionally, it makes the code suboptimal.
12516 Use it to conform to a non-default application binary interface.
12518 @item -fleading-underscore
12519 @opindex fleading-underscore
12520 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
12521 change the way C symbols are represented in the object file.  One use
12522 is to help link with legacy assembly code.
12524 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
12525 generate code that is not binary compatible with code generated without that
12526 switch.  Use it to conform to a non-default application binary interface.
12527 Not all targets provide complete support for this switch.
12529 @item -ftls-model=@var{model}
12530 @opindex ftls-model
12531 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
12532 The @var{model} argument should be one of @samp{global-dynamic},
12533 @samp{local-dynamic}, @samp{initial-exec} or @samp{local-exec}.
12534 Note that the choice is subject to optimization: the compiler may use
12535 a more efficient model for symbols not visible outside of the translation
12536 unit, or if @option{-fpic} is not given on the command line.
12538 The default without @option{-fpic} is @samp{initial-exec}; with
12539 @option{-fpic} the default is @samp{global-dynamic}.
12541 @item -ftrampolines
12542 @opindex ftrampolines
12543 For targets that normally need trampolines for nested functions, always
12544 generate them instead of using descriptors.  Otherwise, for targets that
12545 do not need them, like for example HP-PA or IA-64, do nothing.
12547 A trampoline is a small piece of code that is created at run time on the
12548 stack when the address of a nested function is taken, and is used to call
12549 the nested function indirectly.  Therefore, it requires the stack to be
12550 made executable in order for the program to work properly.
12552 @option{-fno-trampolines} is enabled by default on a language by language
12553 basis to let the compiler avoid generating them, if it computes that this
12554 is safe, and replace them with descriptors.  Descriptors are made up of data
12555 only, but the generated code must be prepared to deal with them.  As of this
12556 writing, @option{-fno-trampolines} is enabled by default only for Ada.
12558 Moreover, code compiled with @option{-ftrampolines} and code compiled with
12559 @option{-fno-trampolines} are not binary compatible if nested functions are
12560 present.  This option must therefore be used on a program-wide basis and be
12561 manipulated with extreme care.
12563 @item -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]}
12564 @opindex fvisibility
12565 Set the default ELF image symbol visibility to the specified option---all
12566 symbols are marked with this unless overridden within the code.
12567 Using this feature can very substantially improve linking and
12568 load times of shared object libraries, produce more optimized
12569 code, provide near-perfect API export and prevent symbol clashes.
12570 It is @strong{strongly} recommended that you use this in any shared objects
12571 you distribute.
12573 Despite the nomenclature, @samp{default} always means public; i.e.,
12574 available to be linked against from outside the shared object.
12575 @samp{protected} and @samp{internal} are pretty useless in real-world
12576 usage so the only other commonly used option is @samp{hidden}.
12577 The default if @option{-fvisibility} isn't specified is
12578 @samp{default}, i.e., make every symbol public.
12580 A good explanation of the benefits offered by ensuring ELF
12581 symbols have the correct visibility is given by ``How To Write
12582 Shared Libraries'' by Ulrich Drepper (which can be found at
12583 @w{@uref{https://www.akkadia.org/drepper/}})---however a superior
12584 solution made possible by this option to marking things hidden when
12585 the default is public is to make the default hidden and mark things
12586 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
12587 and @code{__attribute__ ((visibility("default")))} instead of
12588 @code{__declspec(dllexport)} you get almost identical semantics with
12589 identical syntax.  This is a great boon to those working with
12590 cross-platform projects.
12592 For those adding visibility support to existing code, you may find
12593 @code{#pragma GCC visibility} of use.  This works by you enclosing
12594 the declarations you wish to set visibility for with (for example)
12595 @code{#pragma GCC visibility push(hidden)} and
12596 @code{#pragma GCC visibility pop}.
12597 Bear in mind that symbol visibility should be viewed @strong{as
12598 part of the API interface contract} and thus all new code should
12599 always specify visibility when it is not the default; i.e., declarations
12600 only for use within the local DSO should @strong{always} be marked explicitly
12601 as hidden as so to avoid PLT indirection overheads---making this
12602 abundantly clear also aids readability and self-documentation of the code.
12603 Note that due to ISO C++ specification requirements, @code{operator new} and
12604 @code{operator delete} must always be of default visibility.
12606 Be aware that headers from outside your project, in particular system
12607 headers and headers from any other library you use, may not be
12608 expecting to be compiled with visibility other than the default.  You
12609 may need to explicitly say @code{#pragma GCC visibility push(default)}
12610 before including any such headers.
12612 @code{extern} declarations are not affected by @option{-fvisibility}, so
12613 a lot of code can be recompiled with @option{-fvisibility=hidden} with
12614 no modifications.  However, this means that calls to @code{extern}
12615 functions with no explicit visibility use the PLT, so it is more
12616 effective to use @code{__attribute ((visibility))} and/or
12617 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
12618 declarations should be treated as hidden.
12620 Note that @option{-fvisibility} does affect C++ vague linkage
12621 entities. This means that, for instance, an exception class that is
12622 be thrown between DSOs must be explicitly marked with default
12623 visibility so that the @samp{type_info} nodes are unified between
12624 the DSOs.
12626 An overview of these techniques, their benefits and how to use them
12627 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
12629 @item -fstrict-volatile-bitfields
12630 @opindex fstrict-volatile-bitfields
12631 This option should be used if accesses to volatile bit-fields (or other
12632 structure fields, although the compiler usually honors those types
12633 anyway) should use a single access of the width of the
12634 field's type, aligned to a natural alignment if possible.  For
12635 example, targets with memory-mapped peripheral registers might require
12636 all such accesses to be 16 bits wide; with this flag you can
12637 declare all peripheral bit-fields as @code{unsigned short} (assuming short
12638 is 16 bits on these targets) to force GCC to use 16-bit accesses
12639 instead of, perhaps, a more efficient 32-bit access.
12641 If this option is disabled, the compiler uses the most efficient
12642 instruction.  In the previous example, that might be a 32-bit load
12643 instruction, even though that accesses bytes that do not contain
12644 any portion of the bit-field, or memory-mapped registers unrelated to
12645 the one being updated.
12647 In some cases, such as when the @code{packed} attribute is applied to a 
12648 structure field, it may not be possible to access the field with a single
12649 read or write that is correctly aligned for the target machine.  In this
12650 case GCC falls back to generating multiple accesses rather than code that 
12651 will fault or truncate the result at run time.
12653 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
12654 not allowed to touch non bit-field members.  It is therefore recommended
12655 to define all bits of the field's type as bit-field members.
12657 The default value of this option is determined by the application binary
12658 interface for the target processor.
12660 @item -fsync-libcalls
12661 @opindex fsync-libcalls
12662 This option controls whether any out-of-line instance of the @code{__sync}
12663 family of functions may be used to implement the C++11 @code{__atomic}
12664 family of functions.
12666 The default value of this option is enabled, thus the only useful form
12667 of the option is @option{-fno-sync-libcalls}.  This option is used in
12668 the implementation of the @file{libatomic} runtime library.
12670 @end table
12672 @node Developer Options
12673 @section GCC Developer Options
12674 @cindex developer options
12675 @cindex debugging GCC
12676 @cindex debug dump options
12677 @cindex dump options
12678 @cindex compilation statistics
12680 This section describes command-line options that are primarily of
12681 interest to GCC developers, including options to support compiler
12682 testing and investigation of compiler bugs and compile-time
12683 performance problems.  This includes options that produce debug dumps
12684 at various points in the compilation; that print statistics such as
12685 memory use and execution time; and that print information about GCC's
12686 configuration, such as where it searches for libraries.  You should
12687 rarely need to use any of these options for ordinary compilation and
12688 linking tasks.
12690 @table @gcctabopt
12692 @item -d@var{letters}
12693 @itemx -fdump-rtl-@var{pass}
12694 @itemx -fdump-rtl-@var{pass}=@var{filename}
12695 @opindex d
12696 @opindex fdump-rtl-@var{pass}
12697 Says to make debugging dumps during compilation at times specified by
12698 @var{letters}.  This is used for debugging the RTL-based passes of the
12699 compiler.  The file names for most of the dumps are made by appending
12700 a pass number and a word to the @var{dumpname}, and the files are
12701 created in the directory of the output file.  In case of
12702 @option{=@var{filename}} option, the dump is output on the given file
12703 instead of the pass numbered dump files.  Note that the pass number is
12704 assigned as passes are registered into the pass manager.  Most passes
12705 are registered in the order that they will execute and for these passes
12706 the number corresponds to the pass execution order.  However, passes
12707 registered by plugins, passes specific to compilation targets, or
12708 passes that are otherwise registered after all the other passes are
12709 numbered higher than a pass named "final", even if they are executed
12710 earlier.  @var{dumpname} is generated from the name of the output
12711 file if explicitly specified and not an executable, otherwise it is
12712 the basename of the source file.  
12714 Some @option{-d@var{letters}} switches have different meaning when
12715 @option{-E} is used for preprocessing.  @xref{Preprocessor Options},
12716 for information about preprocessor-specific dump options.
12718 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
12719 @option{-d} option @var{letters}.  Here are the possible
12720 letters for use in @var{pass} and @var{letters}, and their meanings:
12722 @table @gcctabopt
12724 @item -fdump-rtl-alignments
12725 @opindex fdump-rtl-alignments
12726 Dump after branch alignments have been computed.
12728 @item -fdump-rtl-asmcons
12729 @opindex fdump-rtl-asmcons
12730 Dump after fixing rtl statements that have unsatisfied in/out constraints.
12732 @item -fdump-rtl-auto_inc_dec
12733 @opindex fdump-rtl-auto_inc_dec
12734 Dump after auto-inc-dec discovery.  This pass is only run on
12735 architectures that have auto inc or auto dec instructions.
12737 @item -fdump-rtl-barriers
12738 @opindex fdump-rtl-barriers
12739 Dump after cleaning up the barrier instructions.
12741 @item -fdump-rtl-bbpart
12742 @opindex fdump-rtl-bbpart
12743 Dump after partitioning hot and cold basic blocks.
12745 @item -fdump-rtl-bbro
12746 @opindex fdump-rtl-bbro
12747 Dump after block reordering.
12749 @item -fdump-rtl-btl1
12750 @itemx -fdump-rtl-btl2
12751 @opindex fdump-rtl-btl2
12752 @opindex fdump-rtl-btl2
12753 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
12754 after the two branch
12755 target load optimization passes.
12757 @item -fdump-rtl-bypass
12758 @opindex fdump-rtl-bypass
12759 Dump after jump bypassing and control flow optimizations.
12761 @item -fdump-rtl-combine
12762 @opindex fdump-rtl-combine
12763 Dump after the RTL instruction combination pass.
12765 @item -fdump-rtl-compgotos
12766 @opindex fdump-rtl-compgotos
12767 Dump after duplicating the computed gotos.
12769 @item -fdump-rtl-ce1
12770 @itemx -fdump-rtl-ce2
12771 @itemx -fdump-rtl-ce3
12772 @opindex fdump-rtl-ce1
12773 @opindex fdump-rtl-ce2
12774 @opindex fdump-rtl-ce3
12775 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
12776 @option{-fdump-rtl-ce3} enable dumping after the three
12777 if conversion passes.
12779 @item -fdump-rtl-cprop_hardreg
12780 @opindex fdump-rtl-cprop_hardreg
12781 Dump after hard register copy propagation.
12783 @item -fdump-rtl-csa
12784 @opindex fdump-rtl-csa
12785 Dump after combining stack adjustments.
12787 @item -fdump-rtl-cse1
12788 @itemx -fdump-rtl-cse2
12789 @opindex fdump-rtl-cse1
12790 @opindex fdump-rtl-cse2
12791 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
12792 the two common subexpression elimination passes.
12794 @item -fdump-rtl-dce
12795 @opindex fdump-rtl-dce
12796 Dump after the standalone dead code elimination passes.
12798 @item -fdump-rtl-dbr
12799 @opindex fdump-rtl-dbr
12800 Dump after delayed branch scheduling.
12802 @item -fdump-rtl-dce1
12803 @itemx -fdump-rtl-dce2
12804 @opindex fdump-rtl-dce1
12805 @opindex fdump-rtl-dce2
12806 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
12807 the two dead store elimination passes.
12809 @item -fdump-rtl-eh
12810 @opindex fdump-rtl-eh
12811 Dump after finalization of EH handling code.
12813 @item -fdump-rtl-eh_ranges
12814 @opindex fdump-rtl-eh_ranges
12815 Dump after conversion of EH handling range regions.
12817 @item -fdump-rtl-expand
12818 @opindex fdump-rtl-expand
12819 Dump after RTL generation.
12821 @item -fdump-rtl-fwprop1
12822 @itemx -fdump-rtl-fwprop2
12823 @opindex fdump-rtl-fwprop1
12824 @opindex fdump-rtl-fwprop2
12825 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
12826 dumping after the two forward propagation passes.
12828 @item -fdump-rtl-gcse1
12829 @itemx -fdump-rtl-gcse2
12830 @opindex fdump-rtl-gcse1
12831 @opindex fdump-rtl-gcse2
12832 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
12833 after global common subexpression elimination.
12835 @item -fdump-rtl-init-regs
12836 @opindex fdump-rtl-init-regs
12837 Dump after the initialization of the registers.
12839 @item -fdump-rtl-initvals
12840 @opindex fdump-rtl-initvals
12841 Dump after the computation of the initial value sets.
12843 @item -fdump-rtl-into_cfglayout
12844 @opindex fdump-rtl-into_cfglayout
12845 Dump after converting to cfglayout mode.
12847 @item -fdump-rtl-ira
12848 @opindex fdump-rtl-ira
12849 Dump after iterated register allocation.
12851 @item -fdump-rtl-jump
12852 @opindex fdump-rtl-jump
12853 Dump after the second jump optimization.
12855 @item -fdump-rtl-loop2
12856 @opindex fdump-rtl-loop2
12857 @option{-fdump-rtl-loop2} enables dumping after the rtl
12858 loop optimization passes.
12860 @item -fdump-rtl-mach
12861 @opindex fdump-rtl-mach
12862 Dump after performing the machine dependent reorganization pass, if that
12863 pass exists.
12865 @item -fdump-rtl-mode_sw
12866 @opindex fdump-rtl-mode_sw
12867 Dump after removing redundant mode switches.
12869 @item -fdump-rtl-rnreg
12870 @opindex fdump-rtl-rnreg
12871 Dump after register renumbering.
12873 @item -fdump-rtl-outof_cfglayout
12874 @opindex fdump-rtl-outof_cfglayout
12875 Dump after converting from cfglayout mode.
12877 @item -fdump-rtl-peephole2
12878 @opindex fdump-rtl-peephole2
12879 Dump after the peephole pass.
12881 @item -fdump-rtl-postreload
12882 @opindex fdump-rtl-postreload
12883 Dump after post-reload optimizations.
12885 @item -fdump-rtl-pro_and_epilogue
12886 @opindex fdump-rtl-pro_and_epilogue
12887 Dump after generating the function prologues and epilogues.
12889 @item -fdump-rtl-sched1
12890 @itemx -fdump-rtl-sched2
12891 @opindex fdump-rtl-sched1
12892 @opindex fdump-rtl-sched2
12893 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
12894 after the basic block scheduling passes.
12896 @item -fdump-rtl-ree
12897 @opindex fdump-rtl-ree
12898 Dump after sign/zero extension elimination.
12900 @item -fdump-rtl-seqabstr
12901 @opindex fdump-rtl-seqabstr
12902 Dump after common sequence discovery.
12904 @item -fdump-rtl-shorten
12905 @opindex fdump-rtl-shorten
12906 Dump after shortening branches.
12908 @item -fdump-rtl-sibling
12909 @opindex fdump-rtl-sibling
12910 Dump after sibling call optimizations.
12912 @item -fdump-rtl-split1
12913 @itemx -fdump-rtl-split2
12914 @itemx -fdump-rtl-split3
12915 @itemx -fdump-rtl-split4
12916 @itemx -fdump-rtl-split5
12917 @opindex fdump-rtl-split1
12918 @opindex fdump-rtl-split2
12919 @opindex fdump-rtl-split3
12920 @opindex fdump-rtl-split4
12921 @opindex fdump-rtl-split5
12922 These options enable dumping after five rounds of
12923 instruction splitting.
12925 @item -fdump-rtl-sms
12926 @opindex fdump-rtl-sms
12927 Dump after modulo scheduling.  This pass is only run on some
12928 architectures.
12930 @item -fdump-rtl-stack
12931 @opindex fdump-rtl-stack
12932 Dump after conversion from GCC's ``flat register file'' registers to the
12933 x87's stack-like registers.  This pass is only run on x86 variants.
12935 @item -fdump-rtl-subreg1
12936 @itemx -fdump-rtl-subreg2
12937 @opindex fdump-rtl-subreg1
12938 @opindex fdump-rtl-subreg2
12939 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
12940 the two subreg expansion passes.
12942 @item -fdump-rtl-unshare
12943 @opindex fdump-rtl-unshare
12944 Dump after all rtl has been unshared.
12946 @item -fdump-rtl-vartrack
12947 @opindex fdump-rtl-vartrack
12948 Dump after variable tracking.
12950 @item -fdump-rtl-vregs
12951 @opindex fdump-rtl-vregs
12952 Dump after converting virtual registers to hard registers.
12954 @item -fdump-rtl-web
12955 @opindex fdump-rtl-web
12956 Dump after live range splitting.
12958 @item -fdump-rtl-regclass
12959 @itemx -fdump-rtl-subregs_of_mode_init
12960 @itemx -fdump-rtl-subregs_of_mode_finish
12961 @itemx -fdump-rtl-dfinit
12962 @itemx -fdump-rtl-dfinish
12963 @opindex fdump-rtl-regclass
12964 @opindex fdump-rtl-subregs_of_mode_init
12965 @opindex fdump-rtl-subregs_of_mode_finish
12966 @opindex fdump-rtl-dfinit
12967 @opindex fdump-rtl-dfinish
12968 These dumps are defined but always produce empty files.
12970 @item -da
12971 @itemx -fdump-rtl-all
12972 @opindex da
12973 @opindex fdump-rtl-all
12974 Produce all the dumps listed above.
12976 @item -dA
12977 @opindex dA
12978 Annotate the assembler output with miscellaneous debugging information.
12980 @item -dD
12981 @opindex dD
12982 Dump all macro definitions, at the end of preprocessing, in addition to
12983 normal output.
12985 @item -dH
12986 @opindex dH
12987 Produce a core dump whenever an error occurs.
12989 @item -dp
12990 @opindex dp
12991 Annotate the assembler output with a comment indicating which
12992 pattern and alternative is used.  The length of each instruction is
12993 also printed.
12995 @item -dP
12996 @opindex dP
12997 Dump the RTL in the assembler output as a comment before each instruction.
12998 Also turns on @option{-dp} annotation.
13000 @item -dx
13001 @opindex dx
13002 Just generate RTL for a function instead of compiling it.  Usually used
13003 with @option{-fdump-rtl-expand}.
13004 @end table
13006 @item -fdump-noaddr
13007 @opindex fdump-noaddr
13008 When doing debugging dumps, suppress address output.  This makes it more
13009 feasible to use diff on debugging dumps for compiler invocations with
13010 different compiler binaries and/or different
13011 text / bss / data / heap / stack / dso start locations.
13013 @item -freport-bug
13014 @opindex freport-bug
13015 Collect and dump debug information into a temporary file if an
13016 internal compiler error (ICE) occurs.
13018 @item -fdump-unnumbered
13019 @opindex fdump-unnumbered
13020 When doing debugging dumps, suppress instruction numbers and address output.
13021 This makes it more feasible to use diff on debugging dumps for compiler
13022 invocations with different options, in particular with and without
13023 @option{-g}.
13025 @item -fdump-unnumbered-links
13026 @opindex fdump-unnumbered-links
13027 When doing debugging dumps (see @option{-d} option above), suppress
13028 instruction numbers for the links to the previous and next instructions
13029 in a sequence.
13031 @item -fdump-ipa-@var{switch}
13032 @opindex fdump-ipa
13033 Control the dumping at various stages of inter-procedural analysis
13034 language tree to a file.  The file name is generated by appending a
13035 switch specific suffix to the source file name, and the file is created
13036 in the same directory as the output file.  The following dumps are
13037 possible:
13039 @table @samp
13040 @item all
13041 Enables all inter-procedural analysis dumps.
13043 @item cgraph
13044 Dumps information about call-graph optimization, unused function removal,
13045 and inlining decisions.
13047 @item inline
13048 Dump after function inlining.
13050 @end table
13052 @item -fdump-lang-all
13053 @itemx -fdump-lang-@var{switch}
13054 @itemx -fdump-lang-@var{switch}-@var{options}
13055 @itemx -fdump-lang-@var{switch}-@var{options}=@var{filename}
13056 @opindex fdump-lang-all
13057 @opindex fdump-lang
13058 Control the dumping of language-specific information.  The @var{options}
13059 and @var{filename} portions behave as described in the
13060 @option{-fdump-tree} option.  The following @var{switch} values are
13061 accepted:
13063 @table @samp
13064 @item all
13066 Enable all language-specific dumps.
13068 @item class
13069 Dump class hierarchy information.  Virtual table information is emitted
13070 unless '@option{slim}' is specified.  This option is applicable to C++ only.
13072 @item raw
13073 Dump the raw internal tree data.  This option is applicable to C++ only.
13075 @end table
13077 @item -fdump-passes
13078 @opindex fdump-passes
13079 Print on @file{stderr} the list of optimization passes that are turned
13080 on and off by the current command-line options.
13082 @item -fdump-statistics-@var{option}
13083 @opindex fdump-statistics
13084 Enable and control dumping of pass statistics in a separate file.  The
13085 file name is generated by appending a suffix ending in
13086 @samp{.statistics} to the source file name, and the file is created in
13087 the same directory as the output file.  If the @samp{-@var{option}}
13088 form is used, @samp{-stats} causes counters to be summed over the
13089 whole compilation unit while @samp{-details} dumps every event as
13090 the passes generate them.  The default with no option is to sum
13091 counters for each function compiled.
13093 @item -fdump-tree-all
13094 @itemx -fdump-tree-@var{switch}
13095 @itemx -fdump-tree-@var{switch}-@var{options}
13096 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
13097 @opindex fdump-tree-all
13098 @opindex fdump-tree
13099 Control the dumping at various stages of processing the intermediate
13100 language tree to a file.  The file name is generated by appending a
13101 switch-specific suffix to the source file name, and the file is
13102 created in the same directory as the output file. In case of
13103 @option{=@var{filename}} option, the dump is output on the given file
13104 instead of the auto named dump files.  If the @samp{-@var{options}}
13105 form is used, @var{options} is a list of @samp{-} separated options
13106 which control the details of the dump.  Not all options are applicable
13107 to all dumps; those that are not meaningful are ignored.  The
13108 following options are available
13110 @table @samp
13111 @item address
13112 Print the address of each node.  Usually this is not meaningful as it
13113 changes according to the environment and source file.  Its primary use
13114 is for tying up a dump file with a debug environment.
13115 @item asmname
13116 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
13117 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
13118 use working backward from mangled names in the assembly file.
13119 @item slim
13120 When dumping front-end intermediate representations, inhibit dumping
13121 of members of a scope or body of a function merely because that scope
13122 has been reached.  Only dump such items when they are directly reachable
13123 by some other path.
13125 When dumping pretty-printed trees, this option inhibits dumping the
13126 bodies of control structures.
13128 When dumping RTL, print the RTL in slim (condensed) form instead of
13129 the default LISP-like representation.
13130 @item raw
13131 Print a raw representation of the tree.  By default, trees are
13132 pretty-printed into a C-like representation.
13133 @item details
13134 Enable more detailed dumps (not honored by every dump option). Also
13135 include information from the optimization passes.
13136 @item stats
13137 Enable dumping various statistics about the pass (not honored by every dump
13138 option).
13139 @item blocks
13140 Enable showing basic block boundaries (disabled in raw dumps).
13141 @item graph
13142 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
13143 dump a representation of the control flow graph suitable for viewing with
13144 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
13145 the file is pretty-printed as a subgraph, so that GraphViz can render them
13146 all in a single plot.
13148 This option currently only works for RTL dumps, and the RTL is always
13149 dumped in slim form.
13150 @item vops
13151 Enable showing virtual operands for every statement.
13152 @item lineno
13153 Enable showing line numbers for statements.
13154 @item uid
13155 Enable showing the unique ID (@code{DECL_UID}) for each variable.
13156 @item verbose
13157 Enable showing the tree dump for each statement.
13158 @item eh
13159 Enable showing the EH region number holding each statement.
13160 @item scev
13161 Enable showing scalar evolution analysis details.
13162 @item optimized
13163 Enable showing optimization information (only available in certain
13164 passes).
13165 @item missed
13166 Enable showing missed optimization information (only available in certain
13167 passes).
13168 @item note
13169 Enable other detailed optimization information (only available in
13170 certain passes).
13171 @item =@var{filename}
13172 Instead of an auto named dump file, output into the given file
13173 name. The file names @file{stdout} and @file{stderr} are treated
13174 specially and are considered already open standard streams. For
13175 example,
13177 @smallexample
13178 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
13179      -fdump-tree-pre=/dev/stderr file.c
13180 @end smallexample
13182 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
13183 output on to @file{stderr}. If two conflicting dump filenames are
13184 given for the same pass, then the latter option overrides the earlier
13185 one.
13187 @item all
13188 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
13189 and @option{lineno}.
13191 @item optall
13192 Turn on all optimization options, i.e., @option{optimized},
13193 @option{missed}, and @option{note}.
13194 @end table
13196 To determine what tree dumps are available or find the dump for a pass
13197 of interest follow the steps below.
13199 @enumerate
13200 @item
13201 Invoke GCC with @option{-fdump-passes} and in the @file{stderr} output
13202 look for a code that corresponds to the pass you are interested in.
13203 For example, the codes @code{tree-evrp}, @code{tree-vrp1}, and
13204 @code{tree-vrp2} correspond to the three Value Range Propagation passes.
13205 The number at the end distinguishes distinct invocations of the same pass.
13206 @item
13207 To enable the creation of the dump file, append the pass code to
13208 the @option{-fdump-} option prefix and invoke GCC with it.  For example,
13209 to enable the dump from the Early Value Range Propagation pass, invoke
13210 GCC with the @option{-fdump-tree-evrp} option.  Optionally, you may
13211 specify the name of the dump file.  If you don't specify one, GCC
13212 creates as described below.
13213 @item
13214 Find the pass dump in a file whose name is composed of three components
13215 separated by a period: the name of the source file GCC was invoked to
13216 compile, a numeric suffix indicating the pass number followed by the
13217 letter @samp{t} for tree passes (and the letter @samp{r} for RTL passes),
13218 and finally the pass code.  For example, the Early VRP pass dump might
13219 be in a file named @file{myfile.c.038t.evrp} in the current working
13220 directory.  Note that the numeric codes are not stable and may change
13221 from one version of GCC to another.
13222 @end enumerate
13224 @item -fopt-info
13225 @itemx -fopt-info-@var{options}
13226 @itemx -fopt-info-@var{options}=@var{filename}
13227 @opindex fopt-info
13228 Controls optimization dumps from various optimization passes. If the
13229 @samp{-@var{options}} form is used, @var{options} is a list of
13230 @samp{-} separated option keywords to select the dump details and
13231 optimizations.  
13233 The @var{options} can be divided into two groups: options describing the
13234 verbosity of the dump, and options describing which optimizations
13235 should be included. The options from both the groups can be freely
13236 mixed as they are non-overlapping. However, in case of any conflicts,
13237 the later options override the earlier options on the command
13238 line. 
13240 The following options control the dump verbosity:
13242 @table @samp
13243 @item optimized
13244 Print information when an optimization is successfully applied. It is
13245 up to a pass to decide which information is relevant. For example, the
13246 vectorizer passes print the source location of loops which are
13247 successfully vectorized.
13248 @item missed
13249 Print information about missed optimizations. Individual passes
13250 control which information to include in the output. 
13251 @item note
13252 Print verbose information about optimizations, such as certain
13253 transformations, more detailed messages about decisions etc.
13254 @item all
13255 Print detailed optimization information. This includes
13256 @samp{optimized}, @samp{missed}, and @samp{note}.
13257 @end table
13259 One or more of the following option keywords can be used to describe a
13260 group of optimizations:
13262 @table @samp
13263 @item ipa
13264 Enable dumps from all interprocedural optimizations.
13265 @item loop
13266 Enable dumps from all loop optimizations.
13267 @item inline
13268 Enable dumps from all inlining optimizations.
13269 @item omp
13270 Enable dumps from all OMP (Offloading and Multi Processing) optimizations.
13271 @item vec
13272 Enable dumps from all vectorization optimizations.
13273 @item optall
13274 Enable dumps from all optimizations. This is a superset of
13275 the optimization groups listed above.
13276 @end table
13278 If @var{options} is
13279 omitted, it defaults to @samp{optimized-optall}, which means to dump all
13280 info about successful optimizations from all the passes.  
13282 If the @var{filename} is provided, then the dumps from all the
13283 applicable optimizations are concatenated into the @var{filename}.
13284 Otherwise the dump is output onto @file{stderr}. Though multiple
13285 @option{-fopt-info} options are accepted, only one of them can include
13286 a @var{filename}. If other filenames are provided then all but the
13287 first such option are ignored.
13289 Note that the output @var{filename} is overwritten
13290 in case of multiple translation units. If a combined output from
13291 multiple translation units is desired, @file{stderr} should be used
13292 instead.
13294 In the following example, the optimization info is output to
13295 @file{stderr}:
13297 @smallexample
13298 gcc -O3 -fopt-info
13299 @end smallexample
13301 This example:
13302 @smallexample
13303 gcc -O3 -fopt-info-missed=missed.all
13304 @end smallexample
13306 @noindent
13307 outputs missed optimization report from all the passes into
13308 @file{missed.all}, and this one:
13310 @smallexample
13311 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
13312 @end smallexample
13314 @noindent
13315 prints information about missed optimization opportunities from
13316 vectorization passes on @file{stderr}.  
13317 Note that @option{-fopt-info-vec-missed} is equivalent to 
13318 @option{-fopt-info-missed-vec}.  The order of the optimization group
13319 names and message types listed after @option{-fopt-info} does not matter.
13321 As another example,
13322 @smallexample
13323 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
13324 @end smallexample
13326 @noindent
13327 outputs information about missed optimizations as well as
13328 optimized locations from all the inlining passes into
13329 @file{inline.txt}.
13331 Finally, consider:
13333 @smallexample
13334 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
13335 @end smallexample
13337 @noindent
13338 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
13339 in conflict since only one output file is allowed. In this case, only
13340 the first option takes effect and the subsequent options are
13341 ignored. Thus only @file{vec.miss} is produced which contains
13342 dumps from the vectorizer about missed opportunities.
13344 @item -fsched-verbose=@var{n}
13345 @opindex fsched-verbose
13346 On targets that use instruction scheduling, this option controls the
13347 amount of debugging output the scheduler prints to the dump files.
13349 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
13350 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
13351 For @var{n} greater than one, it also output basic block probabilities,
13352 detailed ready list information and unit/insn info.  For @var{n} greater
13353 than two, it includes RTL at abort point, control-flow and regions info.
13354 And for @var{n} over four, @option{-fsched-verbose} also includes
13355 dependence info.
13359 @item -fenable-@var{kind}-@var{pass}
13360 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
13361 @opindex fdisable-
13362 @opindex fenable-
13364 This is a set of options that are used to explicitly disable/enable
13365 optimization passes.  These options are intended for use for debugging GCC.
13366 Compiler users should use regular options for enabling/disabling
13367 passes instead.
13369 @table @gcctabopt
13371 @item -fdisable-ipa-@var{pass}
13372 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
13373 statically invoked in the compiler multiple times, the pass name should be
13374 appended with a sequential number starting from 1.
13376 @item -fdisable-rtl-@var{pass}
13377 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
13378 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
13379 statically invoked in the compiler multiple times, the pass name should be
13380 appended with a sequential number starting from 1.  @var{range-list} is a 
13381 comma-separated list of function ranges or assembler names.  Each range is a number
13382 pair separated by a colon.  The range is inclusive in both ends.  If the range
13383 is trivial, the number pair can be simplified as a single number.  If the
13384 function's call graph node's @var{uid} falls within one of the specified ranges,
13385 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
13386 function header of a dump file, and the pass names can be dumped by using
13387 option @option{-fdump-passes}.
13389 @item -fdisable-tree-@var{pass}
13390 @itemx -fdisable-tree-@var{pass}=@var{range-list}
13391 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
13392 option arguments.
13394 @item -fenable-ipa-@var{pass}
13395 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
13396 statically invoked in the compiler multiple times, the pass name should be
13397 appended with a sequential number starting from 1.
13399 @item -fenable-rtl-@var{pass}
13400 @itemx -fenable-rtl-@var{pass}=@var{range-list}
13401 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
13402 description and examples.
13404 @item -fenable-tree-@var{pass}
13405 @itemx -fenable-tree-@var{pass}=@var{range-list}
13406 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
13407 of option arguments.
13409 @end table
13411 Here are some examples showing uses of these options.
13413 @smallexample
13415 # disable ccp1 for all functions
13416    -fdisable-tree-ccp1
13417 # disable complete unroll for function whose cgraph node uid is 1
13418    -fenable-tree-cunroll=1
13419 # disable gcse2 for functions at the following ranges [1,1],
13420 # [300,400], and [400,1000]
13421 # disable gcse2 for functions foo and foo2
13422    -fdisable-rtl-gcse2=foo,foo2
13423 # disable early inlining
13424    -fdisable-tree-einline
13425 # disable ipa inlining
13426    -fdisable-ipa-inline
13427 # enable tree full unroll
13428    -fenable-tree-unroll
13430 @end smallexample
13432 @item -fchecking
13433 @itemx -fchecking=@var{n}
13434 @opindex fchecking
13435 @opindex fno-checking
13436 Enable internal consistency checking.  The default depends on
13437 the compiler configuration.  @option{-fchecking=2} enables further
13438 internal consistency checking that might affect code generation.
13440 @item -frandom-seed=@var{string}
13441 @opindex frandom-seed
13442 This option provides a seed that GCC uses in place of
13443 random numbers in generating certain symbol names
13444 that have to be different in every compiled file.  It is also used to
13445 place unique stamps in coverage data files and the object files that
13446 produce them.  You can use the @option{-frandom-seed} option to produce
13447 reproducibly identical object files.
13449 The @var{string} can either be a number (decimal, octal or hex) or an
13450 arbitrary string (in which case it's converted to a number by
13451 computing CRC32).
13453 The @var{string} should be different for every file you compile.
13455 @item -save-temps
13456 @itemx -save-temps=cwd
13457 @opindex save-temps
13458 Store the usual ``temporary'' intermediate files permanently; place them
13459 in the current directory and name them based on the source file.  Thus,
13460 compiling @file{foo.c} with @option{-c -save-temps} produces files
13461 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
13462 preprocessed @file{foo.i} output file even though the compiler now
13463 normally uses an integrated preprocessor.
13465 When used in combination with the @option{-x} command-line option,
13466 @option{-save-temps} is sensible enough to avoid over writing an
13467 input source file with the same extension as an intermediate file.
13468 The corresponding intermediate file may be obtained by renaming the
13469 source file before using @option{-save-temps}.
13471 If you invoke GCC in parallel, compiling several different source
13472 files that share a common base name in different subdirectories or the
13473 same source file compiled for multiple output destinations, it is
13474 likely that the different parallel compilers will interfere with each
13475 other, and overwrite the temporary files.  For instance:
13477 @smallexample
13478 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
13479 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
13480 @end smallexample
13482 may result in @file{foo.i} and @file{foo.o} being written to
13483 simultaneously by both compilers.
13485 @item -save-temps=obj
13486 @opindex save-temps=obj
13487 Store the usual ``temporary'' intermediate files permanently.  If the
13488 @option{-o} option is used, the temporary files are based on the
13489 object file.  If the @option{-o} option is not used, the
13490 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
13492 For example:
13494 @smallexample
13495 gcc -save-temps=obj -c foo.c
13496 gcc -save-temps=obj -c bar.c -o dir/xbar.o
13497 gcc -save-temps=obj foobar.c -o dir2/yfoobar
13498 @end smallexample
13500 @noindent
13501 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
13502 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
13503 @file{dir2/yfoobar.o}.
13505 @item -time@r{[}=@var{file}@r{]}
13506 @opindex time
13507 Report the CPU time taken by each subprocess in the compilation
13508 sequence.  For C source files, this is the compiler proper and assembler
13509 (plus the linker if linking is done).
13511 Without the specification of an output file, the output looks like this:
13513 @smallexample
13514 # cc1 0.12 0.01
13515 # as 0.00 0.01
13516 @end smallexample
13518 The first number on each line is the ``user time'', that is time spent
13519 executing the program itself.  The second number is ``system time'',
13520 time spent executing operating system routines on behalf of the program.
13521 Both numbers are in seconds.
13523 With the specification of an output file, the output is appended to the
13524 named file, and it looks like this:
13526 @smallexample
13527 0.12 0.01 cc1 @var{options}
13528 0.00 0.01 as @var{options}
13529 @end smallexample
13531 The ``user time'' and the ``system time'' are moved before the program
13532 name, and the options passed to the program are displayed, so that one
13533 can later tell what file was being compiled, and with which options.
13535 @item -fdump-final-insns@r{[}=@var{file}@r{]}
13536 @opindex fdump-final-insns
13537 Dump the final internal representation (RTL) to @var{file}.  If the
13538 optional argument is omitted (or if @var{file} is @code{.}), the name
13539 of the dump file is determined by appending @code{.gkd} to the
13540 compilation output file name.
13542 @item -fcompare-debug@r{[}=@var{opts}@r{]}
13543 @opindex fcompare-debug
13544 @opindex fno-compare-debug
13545 If no error occurs during compilation, run the compiler a second time,
13546 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
13547 passed to the second compilation.  Dump the final internal
13548 representation in both compilations, and print an error if they differ.
13550 If the equal sign is omitted, the default @option{-gtoggle} is used.
13552 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
13553 and nonzero, implicitly enables @option{-fcompare-debug}.  If
13554 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
13555 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
13556 is used.
13558 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
13559 is equivalent to @option{-fno-compare-debug}, which disables the dumping
13560 of the final representation and the second compilation, preventing even
13561 @env{GCC_COMPARE_DEBUG} from taking effect.
13563 To verify full coverage during @option{-fcompare-debug} testing, set
13564 @env{GCC_COMPARE_DEBUG} to say @option{-fcompare-debug-not-overridden},
13565 which GCC rejects as an invalid option in any actual compilation
13566 (rather than preprocessing, assembly or linking).  To get just a
13567 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
13568 not overridden} will do.
13570 @item -fcompare-debug-second
13571 @opindex fcompare-debug-second
13572 This option is implicitly passed to the compiler for the second
13573 compilation requested by @option{-fcompare-debug}, along with options to
13574 silence warnings, and omitting other options that would cause
13575 side-effect compiler outputs to files or to the standard output.  Dump
13576 files and preserved temporary files are renamed so as to contain the
13577 @code{.gk} additional extension during the second compilation, to avoid
13578 overwriting those generated by the first.
13580 When this option is passed to the compiler driver, it causes the
13581 @emph{first} compilation to be skipped, which makes it useful for little
13582 other than debugging the compiler proper.
13584 @item -gtoggle
13585 @opindex gtoggle
13586 Turn off generation of debug info, if leaving out this option
13587 generates it, or turn it on at level 2 otherwise.  The position of this
13588 argument in the command line does not matter; it takes effect after all
13589 other options are processed, and it does so only once, no matter how
13590 many times it is given.  This is mainly intended to be used with
13591 @option{-fcompare-debug}.
13593 @item -fvar-tracking-assignments-toggle
13594 @opindex fvar-tracking-assignments-toggle
13595 @opindex fno-var-tracking-assignments-toggle
13596 Toggle @option{-fvar-tracking-assignments}, in the same way that
13597 @option{-gtoggle} toggles @option{-g}.
13599 @item -Q
13600 @opindex Q
13601 Makes the compiler print out each function name as it is compiled, and
13602 print some statistics about each pass when it finishes.
13604 @item -ftime-report
13605 @opindex ftime-report
13606 Makes the compiler print some statistics about the time consumed by each
13607 pass when it finishes.
13609 @item -ftime-report-details
13610 @opindex ftime-report-details
13611 Record the time consumed by infrastructure parts separately for each pass.
13613 @item -fira-verbose=@var{n}
13614 @opindex fira-verbose
13615 Control the verbosity of the dump file for the integrated register allocator.
13616 The default value is 5.  If the value @var{n} is greater or equal to 10,
13617 the dump output is sent to stderr using the same format as @var{n} minus 10.
13619 @item -flto-report
13620 @opindex flto-report
13621 Prints a report with internal details on the workings of the link-time
13622 optimizer.  The contents of this report vary from version to version.
13623 It is meant to be useful to GCC developers when processing object
13624 files in LTO mode (via @option{-flto}).
13626 Disabled by default.
13628 @item -flto-report-wpa
13629 @opindex flto-report-wpa
13630 Like @option{-flto-report}, but only print for the WPA phase of Link
13631 Time Optimization.
13633 @item -fmem-report
13634 @opindex fmem-report
13635 Makes the compiler print some statistics about permanent memory
13636 allocation when it finishes.
13638 @item -fmem-report-wpa
13639 @opindex fmem-report-wpa
13640 Makes the compiler print some statistics about permanent memory
13641 allocation for the WPA phase only.
13643 @item -fpre-ipa-mem-report
13644 @opindex fpre-ipa-mem-report
13645 @item -fpost-ipa-mem-report
13646 @opindex fpost-ipa-mem-report
13647 Makes the compiler print some statistics about permanent memory
13648 allocation before or after interprocedural optimization.
13650 @item -fprofile-report
13651 @opindex fprofile-report
13652 Makes the compiler print some statistics about consistency of the
13653 (estimated) profile and effect of individual passes.
13655 @item -fstack-usage
13656 @opindex fstack-usage
13657 Makes the compiler output stack usage information for the program, on a
13658 per-function basis.  The filename for the dump is made by appending
13659 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
13660 the output file, if explicitly specified and it is not an executable,
13661 otherwise it is the basename of the source file.  An entry is made up
13662 of three fields:
13664 @itemize
13665 @item
13666 The name of the function.
13667 @item
13668 A number of bytes.
13669 @item
13670 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
13671 @end itemize
13673 The qualifier @code{static} means that the function manipulates the stack
13674 statically: a fixed number of bytes are allocated for the frame on function
13675 entry and released on function exit; no stack adjustments are otherwise made
13676 in the function.  The second field is this fixed number of bytes.
13678 The qualifier @code{dynamic} means that the function manipulates the stack
13679 dynamically: in addition to the static allocation described above, stack
13680 adjustments are made in the body of the function, for example to push/pop
13681 arguments around function calls.  If the qualifier @code{bounded} is also
13682 present, the amount of these adjustments is bounded at compile time and
13683 the second field is an upper bound of the total amount of stack used by
13684 the function.  If it is not present, the amount of these adjustments is
13685 not bounded at compile time and the second field only represents the
13686 bounded part.
13688 @item -fstats
13689 @opindex fstats
13690 Emit statistics about front-end processing at the end of the compilation.
13691 This option is supported only by the C++ front end, and
13692 the information is generally only useful to the G++ development team.
13694 @item -fdbg-cnt-list
13695 @opindex fdbg-cnt-list
13696 Print the name and the counter upper bound for all debug counters.
13699 @item -fdbg-cnt=@var{counter-value-list}
13700 @opindex fdbg-cnt
13701 Set the internal debug counter upper bound.  @var{counter-value-list}
13702 is a comma-separated list of @var{name}:@var{value} pairs
13703 which sets the upper bound of each debug counter @var{name} to @var{value}.
13704 All debug counters have the initial upper bound of @code{UINT_MAX};
13705 thus @code{dbg_cnt} returns true always unless the upper bound
13706 is set by this option.
13707 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
13708 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
13710 @item -print-file-name=@var{library}
13711 @opindex print-file-name
13712 Print the full absolute name of the library file @var{library} that
13713 would be used when linking---and don't do anything else.  With this
13714 option, GCC does not compile or link anything; it just prints the
13715 file name.
13717 @item -print-multi-directory
13718 @opindex print-multi-directory
13719 Print the directory name corresponding to the multilib selected by any
13720 other switches present in the command line.  This directory is supposed
13721 to exist in @env{GCC_EXEC_PREFIX}.
13723 @item -print-multi-lib
13724 @opindex print-multi-lib
13725 Print the mapping from multilib directory names to compiler switches
13726 that enable them.  The directory name is separated from the switches by
13727 @samp{;}, and each switch starts with an @samp{@@} instead of the
13728 @samp{-}, without spaces between multiple switches.  This is supposed to
13729 ease shell processing.
13731 @item -print-multi-os-directory
13732 @opindex print-multi-os-directory
13733 Print the path to OS libraries for the selected
13734 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
13735 present in the @file{lib} subdirectory and no multilibs are used, this is
13736 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
13737 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
13738 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
13739 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
13741 @item -print-multiarch
13742 @opindex print-multiarch
13743 Print the path to OS libraries for the selected multiarch,
13744 relative to some @file{lib} subdirectory.
13746 @item -print-prog-name=@var{program}
13747 @opindex print-prog-name
13748 Like @option{-print-file-name}, but searches for a program such as @command{cpp}.
13750 @item -print-libgcc-file-name
13751 @opindex print-libgcc-file-name
13752 Same as @option{-print-file-name=libgcc.a}.
13754 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
13755 but you do want to link with @file{libgcc.a}.  You can do:
13757 @smallexample
13758 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
13759 @end smallexample
13761 @item -print-search-dirs
13762 @opindex print-search-dirs
13763 Print the name of the configured installation directory and a list of
13764 program and library directories @command{gcc} searches---and don't do anything else.
13766 This is useful when @command{gcc} prints the error message
13767 @samp{installation problem, cannot exec cpp0: No such file or directory}.
13768 To resolve this you either need to put @file{cpp0} and the other compiler
13769 components where @command{gcc} expects to find them, or you can set the environment
13770 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
13771 Don't forget the trailing @samp{/}.
13772 @xref{Environment Variables}.
13774 @item -print-sysroot
13775 @opindex print-sysroot
13776 Print the target sysroot directory that is used during
13777 compilation.  This is the target sysroot specified either at configure
13778 time or using the @option{--sysroot} option, possibly with an extra
13779 suffix that depends on compilation options.  If no target sysroot is
13780 specified, the option prints nothing.
13782 @item -print-sysroot-headers-suffix
13783 @opindex print-sysroot-headers-suffix
13784 Print the suffix added to the target sysroot when searching for
13785 headers, or give an error if the compiler is not configured with such
13786 a suffix---and don't do anything else.
13788 @item -dumpmachine
13789 @opindex dumpmachine
13790 Print the compiler's target machine (for example,
13791 @samp{i686-pc-linux-gnu})---and don't do anything else.
13793 @item -dumpversion
13794 @opindex dumpversion
13795 Print the compiler version (for example, @code{3.0}, @code{6.3.0} or @code{7})---and don't do
13796 anything else.  This is the compiler version used in filesystem paths,
13797 specs, can be depending on how the compiler has been configured just
13798 a single number (major version), two numbers separated by dot (major and
13799 minor version) or three numbers separated by dots (major, minor and patchlevel
13800 version).
13802 @item -dumpfullversion
13803 @opindex dumpfullversion
13804 Print the full compiler version, always 3 numbers separated by dots,
13805 major, minor and patchlevel version.
13807 @item -dumpspecs
13808 @opindex dumpspecs
13809 Print the compiler's built-in specs---and don't do anything else.  (This
13810 is used when GCC itself is being built.)  @xref{Spec Files}.
13811 @end table
13813 @node Submodel Options
13814 @section Machine-Dependent Options
13815 @cindex submodel options
13816 @cindex specifying hardware config
13817 @cindex hardware models and configurations, specifying
13818 @cindex target-dependent options
13819 @cindex machine-dependent options
13821 Each target machine supported by GCC can have its own options---for
13822 example, to allow you to compile for a particular processor variant or
13823 ABI, or to control optimizations specific to that machine.  By
13824 convention, the names of machine-specific options start with
13825 @samp{-m}.
13827 Some configurations of the compiler also support additional target-specific
13828 options, usually for compatibility with other compilers on the same
13829 platform.
13831 @c This list is ordered alphanumerically by subsection name.
13832 @c It should be the same order and spelling as these options are listed
13833 @c in Machine Dependent Options
13835 @menu
13836 * AArch64 Options::
13837 * Adapteva Epiphany Options::
13838 * ARC Options::
13839 * ARM Options::
13840 * AVR Options::
13841 * Blackfin Options::
13842 * C6X Options::
13843 * CRIS Options::
13844 * CR16 Options::
13845 * Darwin Options::
13846 * DEC Alpha Options::
13847 * FR30 Options::
13848 * FT32 Options::
13849 * FRV Options::
13850 * GNU/Linux Options::
13851 * H8/300 Options::
13852 * HPPA Options::
13853 * IA-64 Options::
13854 * LM32 Options::
13855 * M32C Options::
13856 * M32R/D Options::
13857 * M680x0 Options::
13858 * MCore Options::
13859 * MeP Options::
13860 * MicroBlaze Options::
13861 * MIPS Options::
13862 * MMIX Options::
13863 * MN10300 Options::
13864 * Moxie Options::
13865 * MSP430 Options::
13866 * NDS32 Options::
13867 * Nios II Options::
13868 * Nvidia PTX Options::
13869 * PDP-11 Options::
13870 * picoChip Options::
13871 * PowerPC Options::
13872 * RISC-V Options::
13873 * RL78 Options::
13874 * RS/6000 and PowerPC Options::
13875 * RX Options::
13876 * S/390 and zSeries Options::
13877 * Score Options::
13878 * SH Options::
13879 * Solaris 2 Options::
13880 * SPARC Options::
13881 * SPU Options::
13882 * System V Options::
13883 * TILE-Gx Options::
13884 * TILEPro Options::
13885 * V850 Options::
13886 * VAX Options::
13887 * Visium Options::
13888 * VMS Options::
13889 * VxWorks Options::
13890 * x86 Options::
13891 * x86 Windows Options::
13892 * Xstormy16 Options::
13893 * Xtensa Options::
13894 * zSeries Options::
13895 @end menu
13897 @node AArch64 Options
13898 @subsection AArch64 Options
13899 @cindex AArch64 Options
13901 These options are defined for AArch64 implementations:
13903 @table @gcctabopt
13905 @item -mabi=@var{name}
13906 @opindex mabi
13907 Generate code for the specified data model.  Permissible values
13908 are @samp{ilp32} for SysV-like data model where int, long int and pointers
13909 are 32 bits, and @samp{lp64} for SysV-like data model where int is 32 bits,
13910 but long int and pointers are 64 bits.
13912 The default depends on the specific target configuration.  Note that
13913 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
13914 entire program with the same ABI, and link with a compatible set of libraries.
13916 @item -mbig-endian
13917 @opindex mbig-endian
13918 Generate big-endian code.  This is the default when GCC is configured for an
13919 @samp{aarch64_be-*-*} target.
13921 @item -mgeneral-regs-only
13922 @opindex mgeneral-regs-only
13923 Generate code which uses only the general-purpose registers.  This will prevent
13924 the compiler from using floating-point and Advanced SIMD registers but will not
13925 impose any restrictions on the assembler.
13927 @item -mlittle-endian
13928 @opindex mlittle-endian
13929 Generate little-endian code.  This is the default when GCC is configured for an
13930 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
13932 @item -mcmodel=tiny
13933 @opindex mcmodel=tiny
13934 Generate code for the tiny code model.  The program and its statically defined
13935 symbols must be within 1MB of each other.  Programs can be statically or
13936 dynamically linked.
13938 @item -mcmodel=small
13939 @opindex mcmodel=small
13940 Generate code for the small code model.  The program and its statically defined
13941 symbols must be within 4GB of each other.  Programs can be statically or
13942 dynamically linked.  This is the default code model.
13944 @item -mcmodel=large
13945 @opindex mcmodel=large
13946 Generate code for the large code model.  This makes no assumptions about
13947 addresses and sizes of sections.  Programs can be statically linked only.
13949 @item -mstrict-align
13950 @opindex mstrict-align
13951 Avoid generating memory accesses that may not be aligned on a natural object
13952 boundary as described in the architecture specification.
13954 @item -momit-leaf-frame-pointer
13955 @itemx -mno-omit-leaf-frame-pointer
13956 @opindex momit-leaf-frame-pointer
13957 @opindex mno-omit-leaf-frame-pointer
13958 Omit or keep the frame pointer in leaf functions.  The former behavior is the
13959 default.
13961 @item -mtls-dialect=desc
13962 @opindex mtls-dialect=desc
13963 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
13964 of TLS variables.  This is the default.
13966 @item -mtls-dialect=traditional
13967 @opindex mtls-dialect=traditional
13968 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
13969 of TLS variables.
13971 @item -mtls-size=@var{size}
13972 @opindex mtls-size
13973 Specify bit size of immediate TLS offsets.  Valid values are 12, 24, 32, 48.
13974 This option requires binutils 2.26 or newer.
13976 @item -mfix-cortex-a53-835769
13977 @itemx -mno-fix-cortex-a53-835769
13978 @opindex mfix-cortex-a53-835769
13979 @opindex mno-fix-cortex-a53-835769
13980 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
13981 This involves inserting a NOP instruction between memory instructions and
13982 64-bit integer multiply-accumulate instructions.
13984 @item -mfix-cortex-a53-843419
13985 @itemx -mno-fix-cortex-a53-843419
13986 @opindex mfix-cortex-a53-843419
13987 @opindex mno-fix-cortex-a53-843419
13988 Enable or disable the workaround for the ARM Cortex-A53 erratum number 843419.
13989 This erratum workaround is made at link time and this will only pass the
13990 corresponding flag to the linker.
13992 @item -mlow-precision-recip-sqrt
13993 @item -mno-low-precision-recip-sqrt
13994 @opindex mlow-precision-recip-sqrt
13995 @opindex mno-low-precision-recip-sqrt
13996 Enable or disable the reciprocal square root approximation.
13997 This option only has an effect if @option{-ffast-math} or
13998 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
13999 precision of reciprocal square root results to about 16 bits for
14000 single precision and to 32 bits for double precision.
14002 @item -mlow-precision-sqrt
14003 @item -mno-low-precision-sqrt
14004 @opindex -mlow-precision-sqrt
14005 @opindex -mno-low-precision-sqrt
14006 Enable or disable the square root approximation.
14007 This option only has an effect if @option{-ffast-math} or
14008 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14009 precision of square root results to about 16 bits for
14010 single precision and to 32 bits for double precision.
14011 If enabled, it implies @option{-mlow-precision-recip-sqrt}.
14013 @item -mlow-precision-div
14014 @item -mno-low-precision-div
14015 @opindex -mlow-precision-div
14016 @opindex -mno-low-precision-div
14017 Enable or disable the division approximation.
14018 This option only has an effect if @option{-ffast-math} or
14019 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14020 precision of division results to about 16 bits for
14021 single precision and to 32 bits for double precision.
14023 @item -march=@var{name}
14024 @opindex march
14025 Specify the name of the target architecture and, optionally, one or
14026 more feature modifiers.  This option has the form
14027 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}.
14029 The permissible values for @var{arch} are @samp{armv8-a},
14030 @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a} or @var{native}.
14032 The value @samp{armv8.3-a} implies @samp{armv8.2-a} and enables compiler
14033 support for the ARMv8.3-A architecture extensions.
14035 The value @samp{armv8.2-a} implies @samp{armv8.1-a} and enables compiler
14036 support for the ARMv8.2-A architecture extensions.
14038 The value @samp{armv8.1-a} implies @samp{armv8-a} and enables compiler
14039 support for the ARMv8.1-A architecture extension.  In particular, it
14040 enables the @samp{+crc} and @samp{+lse} features.
14042 The value @samp{native} is available on native AArch64 GNU/Linux and
14043 causes the compiler to pick the architecture of the host system.  This
14044 option has no effect if the compiler is unable to recognize the
14045 architecture of the host system,
14047 The permissible values for @var{feature} are listed in the sub-section
14048 on @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14049 Feature Modifiers}.  Where conflicting feature modifiers are
14050 specified, the right-most feature is used.
14052 GCC uses @var{name} to determine what kind of instructions it can emit
14053 when generating assembly code.  If @option{-march} is specified
14054 without either of @option{-mtune} or @option{-mcpu} also being
14055 specified, the code is tuned to perform well across a range of target
14056 processors implementing the target architecture.
14058 @item -mtune=@var{name}
14059 @opindex mtune
14060 Specify the name of the target processor for which GCC should tune the
14061 performance of the code.  Permissible values for this option are:
14062 @samp{generic}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a57},
14063 @samp{cortex-a72}, @samp{cortex-a73}, @samp{exynos-m1},
14064 @samp{xgene1}, @samp{vulcan}, @samp{thunderx},
14065 @samp{thunderxt88}, @samp{thunderxt88p1}, @samp{thunderxt81},
14066 @samp{thunderxt83}, @samp{thunderx2t99}, @samp{cortex-a57.cortex-a53},
14067 @samp{cortex-a72.cortex-a53}, @samp{cortex-a73.cortex-a35},
14068 @samp{cortex-a73.cortex-a53}, @samp{native}.
14070 The values @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
14071 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53}
14072 specify that GCC should tune for a big.LITTLE system.
14074 Additionally on native AArch64 GNU/Linux systems the value
14075 @samp{native} tunes performance to the host system.  This option has no effect
14076 if the compiler is unable to recognize the processor of the host system.
14078 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
14079 are specified, the code is tuned to perform well across a range
14080 of target processors.
14082 This option cannot be suffixed by feature modifiers.
14084 @item -mcpu=@var{name}
14085 @opindex mcpu
14086 Specify the name of the target processor, optionally suffixed by one
14087 or more feature modifiers.  This option has the form
14088 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where
14089 the permissible values for @var{cpu} are the same as those available
14090 for @option{-mtune}.  The permissible values for @var{feature} are
14091 documented in the sub-section on
14092 @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14093 Feature Modifiers}.  Where conflicting feature modifiers are
14094 specified, the right-most feature is used.
14096 GCC uses @var{name} to determine what kind of instructions it can emit when
14097 generating assembly code (as if by @option{-march}) and to determine
14098 the target processor for which to tune for performance (as if
14099 by @option{-mtune}).  Where this option is used in conjunction
14100 with @option{-march} or @option{-mtune}, those options take precedence
14101 over the appropriate part of this option.
14103 @item -moverride=@var{string}
14104 @opindex moverride
14105 Override tuning decisions made by the back-end in response to a
14106 @option{-mtune=} switch.  The syntax, semantics, and accepted values
14107 for @var{string} in this option are not guaranteed to be consistent
14108 across releases.
14110 This option is only intended to be useful when developing GCC.
14112 @item -mpc-relative-literal-loads
14113 @opindex mpc-relative-literal-loads
14114 Enable PC-relative literal loads.  With this option literal pools are
14115 accessed using a single instruction and emitted after each function.  This
14116 limits the maximum size of functions to 1MB.  This is enabled by default for
14117 @option{-mcmodel=tiny}.
14119 @item -msign-return-address=@var{scope}
14120 @opindex msign-return-address
14121 Select the function scope on which return address signing will be applied.
14122 Permissible values are @samp{none}, which disables return address signing,
14123 @samp{non-leaf}, which enables pointer signing for functions which are not leaf
14124 functions, and @samp{all}, which enables pointer signing for all functions.  The
14125 default value is @samp{none}.
14127 @end table
14129 @subsubsection @option{-march} and @option{-mcpu} Feature Modifiers
14130 @anchor{aarch64-feature-modifiers}
14131 @cindex @option{-march} feature modifiers
14132 @cindex @option{-mcpu} feature modifiers
14133 Feature modifiers used with @option{-march} and @option{-mcpu} can be any of
14134 the following and their inverses @option{no@var{feature}}:
14136 @table @samp
14137 @item crc
14138 Enable CRC extension.  This is on by default for
14139 @option{-march=armv8.1-a}.
14140 @item crypto
14141 Enable Crypto extension.  This also enables Advanced SIMD and floating-point
14142 instructions.
14143 @item fp
14144 Enable floating-point instructions.  This is on by default for all possible
14145 values for options @option{-march} and @option{-mcpu}.
14146 @item simd
14147 Enable Advanced SIMD instructions.  This also enables floating-point
14148 instructions.  This is on by default for all possible values for options
14149 @option{-march} and @option{-mcpu}.
14150 @item lse
14151 Enable Large System Extension instructions.  This is on by default for
14152 @option{-march=armv8.1-a}.
14153 @item fp16
14154 Enable FP16 extension.  This also enables floating-point instructions.
14156 @end table
14158 Feature @option{crypto} implies @option{simd}, which implies @option{fp}.
14159 Conversely, @option{nofp} implies @option{nosimd}, which implies
14160 @option{nocrypto}.
14162 @node Adapteva Epiphany Options
14163 @subsection Adapteva Epiphany Options
14165 These @samp{-m} options are defined for Adapteva Epiphany:
14167 @table @gcctabopt
14168 @item -mhalf-reg-file
14169 @opindex mhalf-reg-file
14170 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
14171 That allows code to run on hardware variants that lack these registers.
14173 @item -mprefer-short-insn-regs
14174 @opindex mprefer-short-insn-regs
14175 Preferentially allocate registers that allow short instruction generation.
14176 This can result in increased instruction count, so this may either reduce or
14177 increase overall code size.
14179 @item -mbranch-cost=@var{num}
14180 @opindex mbranch-cost
14181 Set the cost of branches to roughly @var{num} ``simple'' instructions.
14182 This cost is only a heuristic and is not guaranteed to produce
14183 consistent results across releases.
14185 @item -mcmove
14186 @opindex mcmove
14187 Enable the generation of conditional moves.
14189 @item -mnops=@var{num}
14190 @opindex mnops
14191 Emit @var{num} NOPs before every other generated instruction.
14193 @item -mno-soft-cmpsf
14194 @opindex mno-soft-cmpsf
14195 For single-precision floating-point comparisons, emit an @code{fsub} instruction
14196 and test the flags.  This is faster than a software comparison, but can
14197 get incorrect results in the presence of NaNs, or when two different small
14198 numbers are compared such that their difference is calculated as zero.
14199 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
14200 software comparisons.
14202 @item -mstack-offset=@var{num}
14203 @opindex mstack-offset
14204 Set the offset between the top of the stack and the stack pointer.
14205 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
14206 can be used by leaf functions without stack allocation.
14207 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
14208 Note also that this option changes the ABI; compiling a program with a
14209 different stack offset than the libraries have been compiled with
14210 generally does not work.
14211 This option can be useful if you want to evaluate if a different stack
14212 offset would give you better code, but to actually use a different stack
14213 offset to build working programs, it is recommended to configure the
14214 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
14216 @item -mno-round-nearest
14217 @opindex mno-round-nearest
14218 Make the scheduler assume that the rounding mode has been set to
14219 truncating.  The default is @option{-mround-nearest}.
14221 @item -mlong-calls
14222 @opindex mlong-calls
14223 If not otherwise specified by an attribute, assume all calls might be beyond
14224 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
14225 function address into a register before performing a (otherwise direct) call.
14226 This is the default.
14228 @item -mshort-calls
14229 @opindex short-calls
14230 If not otherwise specified by an attribute, assume all direct calls are
14231 in the range of the @code{b} / @code{bl} instructions, so use these instructions
14232 for direct calls.  The default is @option{-mlong-calls}.
14234 @item -msmall16
14235 @opindex msmall16
14236 Assume addresses can be loaded as 16-bit unsigned values.  This does not
14237 apply to function addresses for which @option{-mlong-calls} semantics
14238 are in effect.
14240 @item -mfp-mode=@var{mode}
14241 @opindex mfp-mode
14242 Set the prevailing mode of the floating-point unit.
14243 This determines the floating-point mode that is provided and expected
14244 at function call and return time.  Making this mode match the mode you
14245 predominantly need at function start can make your programs smaller and
14246 faster by avoiding unnecessary mode switches.
14248 @var{mode} can be set to one the following values:
14250 @table @samp
14251 @item caller
14252 Any mode at function entry is valid, and retained or restored when
14253 the function returns, and when it calls other functions.
14254 This mode is useful for compiling libraries or other compilation units
14255 you might want to incorporate into different programs with different
14256 prevailing FPU modes, and the convenience of being able to use a single
14257 object file outweighs the size and speed overhead for any extra
14258 mode switching that might be needed, compared with what would be needed
14259 with a more specific choice of prevailing FPU mode.
14261 @item truncate
14262 This is the mode used for floating-point calculations with
14263 truncating (i.e.@: round towards zero) rounding mode.  That includes
14264 conversion from floating point to integer.
14266 @item round-nearest
14267 This is the mode used for floating-point calculations with
14268 round-to-nearest-or-even rounding mode.
14270 @item int
14271 This is the mode used to perform integer calculations in the FPU, e.g.@:
14272 integer multiply, or integer multiply-and-accumulate.
14273 @end table
14275 The default is @option{-mfp-mode=caller}
14277 @item -mnosplit-lohi
14278 @itemx -mno-postinc
14279 @itemx -mno-postmodify
14280 @opindex mnosplit-lohi
14281 @opindex mno-postinc
14282 @opindex mno-postmodify
14283 Code generation tweaks that disable, respectively, splitting of 32-bit
14284 loads, generation of post-increment addresses, and generation of
14285 post-modify addresses.  The defaults are @option{msplit-lohi},
14286 @option{-mpost-inc}, and @option{-mpost-modify}.
14288 @item -mnovect-double
14289 @opindex mno-vect-double
14290 Change the preferred SIMD mode to SImode.  The default is
14291 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
14293 @item -max-vect-align=@var{num}
14294 @opindex max-vect-align
14295 The maximum alignment for SIMD vector mode types.
14296 @var{num} may be 4 or 8.  The default is 8.
14297 Note that this is an ABI change, even though many library function
14298 interfaces are unaffected if they don't use SIMD vector modes
14299 in places that affect size and/or alignment of relevant types.
14301 @item -msplit-vecmove-early
14302 @opindex msplit-vecmove-early
14303 Split vector moves into single word moves before reload.  In theory this
14304 can give better register allocation, but so far the reverse seems to be
14305 generally the case.
14307 @item -m1reg-@var{reg}
14308 @opindex m1reg-
14309 Specify a register to hold the constant @minus{}1, which makes loading small negative
14310 constants and certain bitmasks faster.
14311 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
14312 which specify use of that register as a fixed register,
14313 and @samp{none}, which means that no register is used for this
14314 purpose.  The default is @option{-m1reg-none}.
14316 @end table
14318 @node ARC Options
14319 @subsection ARC Options
14320 @cindex ARC options
14322 The following options control the architecture variant for which code
14323 is being compiled:
14325 @c architecture variants
14326 @table @gcctabopt
14328 @item -mbarrel-shifter
14329 @opindex mbarrel-shifter
14330 Generate instructions supported by barrel shifter.  This is the default
14331 unless @option{-mcpu=ARC601} or @samp{-mcpu=ARCEM} is in effect.
14333 @item -mcpu=@var{cpu}
14334 @opindex mcpu
14335 Set architecture type, register usage, and instruction scheduling
14336 parameters for @var{cpu}.  There are also shortcut alias options
14337 available for backward compatibility and convenience.  Supported
14338 values for @var{cpu} are
14340 @table @samp
14341 @opindex mA6
14342 @opindex mARC600
14343 @item arc600
14344 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
14346 @item arc601
14347 @opindex mARC601
14348 Compile for ARC601.  Alias: @option{-mARC601}.
14350 @item arc700
14351 @opindex mA7
14352 @opindex mARC700
14353 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
14354 This is the default when configured with @option{--with-cpu=arc700}@.
14356 @item arcem
14357 Compile for ARC EM.
14359 @item archs
14360 Compile for ARC HS.
14362 @item em
14363 Compile for ARC EM CPU with no hardware extensions.
14365 @item em4
14366 Compile for ARC EM4 CPU.
14368 @item em4_dmips
14369 Compile for ARC EM4 DMIPS CPU.
14371 @item em4_fpus
14372 Compile for ARC EM4 DMIPS CPU with the single-precision floating-point
14373 extension.
14375 @item em4_fpuda
14376 Compile for ARC EM4 DMIPS CPU with single-precision floating-point and
14377 double assist instructions.
14379 @item hs
14380 Compile for ARC HS CPU with no hardware extensions except the atomic
14381 instructions.
14383 @item hs34
14384 Compile for ARC HS34 CPU.
14386 @item hs38
14387 Compile for ARC HS38 CPU.
14389 @item hs38_linux
14390 Compile for ARC HS38 CPU with all hardware extensions on.
14392 @item arc600_norm
14393 Compile for ARC 600 CPU with @code{norm} instructions enabled.
14395 @item arc600_mul32x16
14396 Compile for ARC 600 CPU with @code{norm} and 32x16-bit multiply 
14397 instructions enabled.
14399 @item arc600_mul64
14400 Compile for ARC 600 CPU with @code{norm} and @code{mul64}-family 
14401 instructions enabled.
14403 @item arc601_norm
14404 Compile for ARC 601 CPU with @code{norm} instructions enabled.
14406 @item arc601_mul32x16
14407 Compile for ARC 601 CPU with @code{norm} and 32x16-bit multiply
14408 instructions enabled.
14410 @item arc601_mul64
14411 Compile for ARC 601 CPU with @code{norm} and @code{mul64}-family
14412 instructions enabled.
14414 @item nps400
14415 Compile for ARC 700 on NPS400 chip.
14417 @end table
14419 @item -mdpfp
14420 @opindex mdpfp
14421 @itemx -mdpfp-compact
14422 @opindex mdpfp-compact
14423 Generate double-precision FPX instructions, tuned for the compact
14424 implementation.
14426 @item -mdpfp-fast
14427 @opindex mdpfp-fast
14428 Generate double-precision FPX instructions, tuned for the fast
14429 implementation.
14431 @item -mno-dpfp-lrsr
14432 @opindex mno-dpfp-lrsr
14433 Disable @code{lr} and @code{sr} instructions from using FPX extension
14434 aux registers.
14436 @item -mea
14437 @opindex mea
14438 Generate extended arithmetic instructions.  Currently only
14439 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
14440 supported.  This is always enabled for @option{-mcpu=ARC700}.
14442 @item -mno-mpy
14443 @opindex mno-mpy
14444 Do not generate @code{mpy}-family instructions for ARC700.  This option is
14445 deprecated.
14447 @item -mmul32x16
14448 @opindex mmul32x16
14449 Generate 32x16-bit multiply and multiply-accumulate instructions.
14451 @item -mmul64
14452 @opindex mmul64
14453 Generate @code{mul64} and @code{mulu64} instructions.  
14454 Only valid for @option{-mcpu=ARC600}.
14456 @item -mnorm
14457 @opindex mnorm
14458 Generate @code{norm} instructions.  This is the default if @option{-mcpu=ARC700}
14459 is in effect.
14461 @item -mspfp
14462 @opindex mspfp
14463 @itemx -mspfp-compact
14464 @opindex mspfp-compact
14465 Generate single-precision FPX instructions, tuned for the compact
14466 implementation.
14468 @item -mspfp-fast
14469 @opindex mspfp-fast
14470 Generate single-precision FPX instructions, tuned for the fast
14471 implementation.
14473 @item -msimd
14474 @opindex msimd
14475 Enable generation of ARC SIMD instructions via target-specific
14476 builtins.  Only valid for @option{-mcpu=ARC700}.
14478 @item -msoft-float
14479 @opindex msoft-float
14480 This option ignored; it is provided for compatibility purposes only.
14481 Software floating-point code is emitted by default, and this default
14482 can overridden by FPX options; @option{-mspfp}, @option{-mspfp-compact}, or
14483 @option{-mspfp-fast} for single precision, and @option{-mdpfp},
14484 @option{-mdpfp-compact}, or @option{-mdpfp-fast} for double precision.
14486 @item -mswap
14487 @opindex mswap
14488 Generate @code{swap} instructions.
14490 @item -matomic
14491 @opindex matomic
14492 This enables use of the locked load/store conditional extension to implement
14493 atomic memory built-in functions.  Not available for ARC 6xx or ARC
14494 EM cores.
14496 @item -mdiv-rem
14497 @opindex mdiv-rem
14498 Enable @code{div} and @code{rem} instructions for ARCv2 cores.
14500 @item -mcode-density
14501 @opindex mcode-density
14502 Enable code density instructions for ARC EM.  
14503 This option is on by default for ARC HS.
14505 @item -mll64
14506 @opindex mll64
14507 Enable double load/store operations for ARC HS cores.
14509 @item -mtp-regno=@var{regno}
14510 @opindex mtp-regno
14511 Specify thread pointer register number.
14513 @item -mmpy-option=@var{multo}
14514 @opindex mmpy-option
14515 Compile ARCv2 code with a multiplier design option.  You can specify 
14516 the option using either a string or numeric value for @var{multo}.  
14517 @samp{wlh1} is the default value.  The recognized values are:
14519 @table @samp
14520 @item 0
14521 @itemx none
14522 No multiplier available.
14524 @item 1
14525 @itemx w
14526 16x16 multiplier, fully pipelined.
14527 The following instructions are enabled: @code{mpyw} and @code{mpyuw}.
14529 @item 2
14530 @itemx wlh1
14531 32x32 multiplier, fully
14532 pipelined (1 stage).  The following instructions are additionally
14533 enabled: @code{mpy}, @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14535 @item 3
14536 @itemx wlh2
14537 32x32 multiplier, fully pipelined
14538 (2 stages).  The following instructions are additionally enabled: @code{mpy},
14539 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14541 @item 4
14542 @itemx wlh3
14543 Two 16x16 multipliers, blocking,
14544 sequential.  The following instructions are additionally enabled: @code{mpy},
14545 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14547 @item 5
14548 @itemx wlh4
14549 One 16x16 multiplier, blocking,
14550 sequential.  The following instructions are additionally enabled: @code{mpy},
14551 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14553 @item 6
14554 @itemx wlh5
14555 One 32x4 multiplier, blocking,
14556 sequential.  The following instructions are additionally enabled: @code{mpy},
14557 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14559 @item 7
14560 @itemx plus_dmpy
14561 ARC HS SIMD support.
14563 @item 8
14564 @itemx plus_macd
14565 ARC HS SIMD support.
14567 @item 9
14568 @itemx plus_qmacw
14569 ARC HS SIMD support.
14571 @end table
14573 This option is only available for ARCv2 cores@.
14575 @item -mfpu=@var{fpu}
14576 @opindex mfpu
14577 Enables support for specific floating-point hardware extensions for ARCv2
14578 cores.  Supported values for @var{fpu} are:
14580 @table @samp
14582 @item fpus
14583 Enables support for single-precision floating-point hardware
14584 extensions@.
14586 @item fpud
14587 Enables support for double-precision floating-point hardware
14588 extensions.  The single-precision floating-point extension is also
14589 enabled.  Not available for ARC EM@.
14591 @item fpuda
14592 Enables support for double-precision floating-point hardware
14593 extensions using double-precision assist instructions.  The single-precision
14594 floating-point extension is also enabled.  This option is
14595 only available for ARC EM@.
14597 @item fpuda_div
14598 Enables support for double-precision floating-point hardware
14599 extensions using double-precision assist instructions.
14600 The single-precision floating-point, square-root, and divide 
14601 extensions are also enabled.  This option is
14602 only available for ARC EM@.
14604 @item fpuda_fma
14605 Enables support for double-precision floating-point hardware
14606 extensions using double-precision assist instructions.
14607 The single-precision floating-point and fused multiply and add 
14608 hardware extensions are also enabled.  This option is
14609 only available for ARC EM@.
14611 @item fpuda_all
14612 Enables support for double-precision floating-point hardware
14613 extensions using double-precision assist instructions.
14614 All single-precision floating-point hardware extensions are also
14615 enabled.  This option is only available for ARC EM@.
14617 @item fpus_div
14618 Enables support for single-precision floating-point, square-root and divide 
14619 hardware extensions@.
14621 @item fpud_div
14622 Enables support for double-precision floating-point, square-root and divide 
14623 hardware extensions.  This option
14624 includes option @samp{fpus_div}. Not available for ARC EM@.
14626 @item fpus_fma
14627 Enables support for single-precision floating-point and 
14628 fused multiply and add hardware extensions@.
14630 @item fpud_fma
14631 Enables support for double-precision floating-point and 
14632 fused multiply and add hardware extensions.  This option
14633 includes option @samp{fpus_fma}.  Not available for ARC EM@.
14635 @item fpus_all
14636 Enables support for all single-precision floating-point hardware
14637 extensions@.
14639 @item fpud_all
14640 Enables support for all single- and double-precision floating-point
14641 hardware extensions.  Not available for ARC EM@.
14643 @end table
14645 @item -mirq-ctrl-saved=@var{register-range}, @var{blink}, @var{lp_count}
14646 @opindex mirq-ctrl-saved
14647 Specifies general-purposes registers that the processor automatically
14648 saves/restores on interrupt entry and exit.  @var{register-range} is
14649 specified as two registers separated by a dash.  The register range
14650 always starts with @code{r0}, the upper limit is @code{fp} register.
14651 @var{blink} and @var{lp_count} are optional.  This option is only
14652 valid for ARC EM and ARC HS cores.
14654 @item -mrgf-banked-regs=@var{number}
14655 @opindex mrgf-banked-regs
14656 Specifies the number of registers replicated in second register bank
14657 on entry to fast interrupt.  Fast interrupts are interrupts with the
14658 highest priority level P0.  These interrupts save only PC and STATUS32
14659 registers to avoid memory transactions during interrupt entry and exit
14660 sequences.  Use this option when you are using fast interrupts in an
14661 ARC V2 family processor.  Permitted values are 4, 8, 16, and 32.
14663 @end table
14665 The following options are passed through to the assembler, and also
14666 define preprocessor macro symbols.
14668 @c Flags used by the assembler, but for which we define preprocessor
14669 @c macro symbols as well.
14670 @table @gcctabopt
14671 @item -mdsp-packa
14672 @opindex mdsp-packa
14673 Passed down to the assembler to enable the DSP Pack A extensions.
14674 Also sets the preprocessor symbol @code{__Xdsp_packa}.  This option is
14675 deprecated.
14677 @item -mdvbf
14678 @opindex mdvbf
14679 Passed down to the assembler to enable the dual Viterbi butterfly
14680 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.  This
14681 option is deprecated.
14683 @c ARC700 4.10 extension instruction
14684 @item -mlock
14685 @opindex mlock
14686 Passed down to the assembler to enable the locked load/store
14687 conditional extension.  Also sets the preprocessor symbol
14688 @code{__Xlock}.
14690 @item -mmac-d16
14691 @opindex mmac-d16
14692 Passed down to the assembler.  Also sets the preprocessor symbol
14693 @code{__Xxmac_d16}.  This option is deprecated.
14695 @item -mmac-24
14696 @opindex mmac-24
14697 Passed down to the assembler.  Also sets the preprocessor symbol
14698 @code{__Xxmac_24}.  This option is deprecated.
14700 @c ARC700 4.10 extension instruction
14701 @item -mrtsc
14702 @opindex mrtsc
14703 Passed down to the assembler to enable the 64-bit time-stamp counter
14704 extension instruction.  Also sets the preprocessor symbol
14705 @code{__Xrtsc}.  This option is deprecated.
14707 @c ARC700 4.10 extension instruction
14708 @item -mswape
14709 @opindex mswape
14710 Passed down to the assembler to enable the swap byte ordering
14711 extension instruction.  Also sets the preprocessor symbol
14712 @code{__Xswape}.
14714 @item -mtelephony
14715 @opindex mtelephony
14716 Passed down to the assembler to enable dual- and single-operand
14717 instructions for telephony.  Also sets the preprocessor symbol
14718 @code{__Xtelephony}.  This option is deprecated.
14720 @item -mxy
14721 @opindex mxy
14722 Passed down to the assembler to enable the XY memory extension.  Also
14723 sets the preprocessor symbol @code{__Xxy}.
14725 @end table
14727 The following options control how the assembly code is annotated:
14729 @c Assembly annotation options
14730 @table @gcctabopt
14731 @item -misize
14732 @opindex misize
14733 Annotate assembler instructions with estimated addresses.
14735 @item -mannotate-align
14736 @opindex mannotate-align
14737 Explain what alignment considerations lead to the decision to make an
14738 instruction short or long.
14740 @end table
14742 The following options are passed through to the linker:
14744 @c options passed through to the linker
14745 @table @gcctabopt
14746 @item -marclinux
14747 @opindex marclinux
14748 Passed through to the linker, to specify use of the @code{arclinux} emulation.
14749 This option is enabled by default in tool chains built for
14750 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
14751 when profiling is not requested.
14753 @item -marclinux_prof
14754 @opindex marclinux_prof
14755 Passed through to the linker, to specify use of the
14756 @code{arclinux_prof} emulation.  This option is enabled by default in
14757 tool chains built for @w{@code{arc-linux-uclibc}} and
14758 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
14760 @end table
14762 The following options control the semantics of generated code:
14764 @c semantically relevant code generation options
14765 @table @gcctabopt
14766 @item -mlong-calls
14767 @opindex mlong-calls
14768 Generate calls as register indirect calls, thus providing access
14769 to the full 32-bit address range.
14771 @item -mmedium-calls
14772 @opindex mmedium-calls
14773 Don't use less than 25-bit addressing range for calls, which is the
14774 offset available for an unconditional branch-and-link
14775 instruction.  Conditional execution of function calls is suppressed, to
14776 allow use of the 25-bit range, rather than the 21-bit range with
14777 conditional branch-and-link.  This is the default for tool chains built
14778 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
14780 @item -mno-sdata
14781 @opindex mno-sdata
14782 Do not generate sdata references.  This is the default for tool chains
14783 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
14784 targets.
14786 @item -mvolatile-cache
14787 @opindex mvolatile-cache
14788 Use ordinarily cached memory accesses for volatile references.  This is the
14789 default.
14791 @item -mno-volatile-cache
14792 @opindex mno-volatile-cache
14793 Enable cache bypass for volatile references.
14795 @end table
14797 The following options fine tune code generation:
14798 @c code generation tuning options
14799 @table @gcctabopt
14800 @item -malign-call
14801 @opindex malign-call
14802 Do alignment optimizations for call instructions.
14804 @item -mauto-modify-reg
14805 @opindex mauto-modify-reg
14806 Enable the use of pre/post modify with register displacement.
14808 @item -mbbit-peephole
14809 @opindex mbbit-peephole
14810 Enable bbit peephole2.
14812 @item -mno-brcc
14813 @opindex mno-brcc
14814 This option disables a target-specific pass in @file{arc_reorg} to
14815 generate compare-and-branch (@code{br@var{cc}}) instructions.  
14816 It has no effect on
14817 generation of these instructions driven by the combiner pass.
14819 @item -mcase-vector-pcrel
14820 @opindex mcase-vector-pcrel
14821 Use PC-relative switch case tables to enable case table shortening.
14822 This is the default for @option{-Os}.
14824 @item -mcompact-casesi
14825 @opindex mcompact-casesi
14826 Enable compact @code{casesi} pattern.  This is the default for @option{-Os},
14827 and only available for ARCv1 cores.
14829 @item -mno-cond-exec
14830 @opindex mno-cond-exec
14831 Disable the ARCompact-specific pass to generate conditional 
14832 execution instructions.
14834 Due to delay slot scheduling and interactions between operand numbers,
14835 literal sizes, instruction lengths, and the support for conditional execution,
14836 the target-independent pass to generate conditional execution is often lacking,
14837 so the ARC port has kept a special pass around that tries to find more
14838 conditional execution generation opportunities after register allocation,
14839 branch shortening, and delay slot scheduling have been done.  This pass
14840 generally, but not always, improves performance and code size, at the cost of
14841 extra compilation time, which is why there is an option to switch it off.
14842 If you have a problem with call instructions exceeding their allowable
14843 offset range because they are conditionalized, you should consider using
14844 @option{-mmedium-calls} instead.
14846 @item -mearly-cbranchsi
14847 @opindex mearly-cbranchsi
14848 Enable pre-reload use of the @code{cbranchsi} pattern.
14850 @item -mexpand-adddi
14851 @opindex mexpand-adddi
14852 Expand @code{adddi3} and @code{subdi3} at RTL generation time into
14853 @code{add.f}, @code{adc} etc.
14855 @item -mindexed-loads
14856 @opindex mindexed-loads
14857 Enable the use of indexed loads.  This can be problematic because some
14858 optimizers then assume that indexed stores exist, which is not
14859 the case.
14861 @opindex mlra
14862 Enable Local Register Allocation.  This is still experimental for ARC,
14863 so by default the compiler uses standard reload
14864 (i.e. @option{-mno-lra}).
14866 @item -mlra-priority-none
14867 @opindex mlra-priority-none
14868 Don't indicate any priority for target registers.
14870 @item -mlra-priority-compact
14871 @opindex mlra-priority-compact
14872 Indicate target register priority for r0..r3 / r12..r15.
14874 @item -mlra-priority-noncompact
14875 @opindex mlra-priority-noncompact
14876 Reduce target register priority for r0..r3 / r12..r15.
14878 @item -mno-millicode
14879 @opindex mno-millicode
14880 When optimizing for size (using @option{-Os}), prologues and epilogues
14881 that have to save or restore a large number of registers are often
14882 shortened by using call to a special function in libgcc; this is
14883 referred to as a @emph{millicode} call.  As these calls can pose
14884 performance issues, and/or cause linking issues when linking in a
14885 nonstandard way, this option is provided to turn off millicode call
14886 generation.
14888 @item -mmixed-code
14889 @opindex mmixed-code
14890 Tweak register allocation to help 16-bit instruction generation.
14891 This generally has the effect of decreasing the average instruction size
14892 while increasing the instruction count.
14894 @item -mq-class
14895 @opindex mq-class
14896 Enable @samp{q} instruction alternatives.
14897 This is the default for @option{-Os}.
14899 @item -mRcq
14900 @opindex mRcq
14901 Enable @samp{Rcq} constraint handling.  
14902 Most short code generation depends on this.
14903 This is the default.
14905 @item -mRcw
14906 @opindex mRcw
14907 Enable @samp{Rcw} constraint handling.  
14908 Most ccfsm condexec mostly depends on this.
14909 This is the default.
14911 @item -msize-level=@var{level}
14912 @opindex msize-level
14913 Fine-tune size optimization with regards to instruction lengths and alignment.
14914 The recognized values for @var{level} are:
14915 @table @samp
14916 @item 0
14917 No size optimization.  This level is deprecated and treated like @samp{1}.
14919 @item 1
14920 Short instructions are used opportunistically.
14922 @item 2
14923 In addition, alignment of loops and of code after barriers are dropped.
14925 @item 3
14926 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
14928 @end table
14930 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
14931 the behavior when this is not set is equivalent to level @samp{1}.
14933 @item -mtune=@var{cpu}
14934 @opindex mtune
14935 Set instruction scheduling parameters for @var{cpu}, overriding any implied
14936 by @option{-mcpu=}.
14938 Supported values for @var{cpu} are
14940 @table @samp
14941 @item ARC600
14942 Tune for ARC600 CPU.
14944 @item ARC601
14945 Tune for ARC601 CPU.
14947 @item ARC700
14948 Tune for ARC700 CPU with standard multiplier block.
14950 @item ARC700-xmac
14951 Tune for ARC700 CPU with XMAC block.
14953 @item ARC725D
14954 Tune for ARC725D CPU.
14956 @item ARC750D
14957 Tune for ARC750D CPU.
14959 @end table
14961 @item -mmultcost=@var{num}
14962 @opindex mmultcost
14963 Cost to assume for a multiply instruction, with @samp{4} being equal to a
14964 normal instruction.
14966 @item -munalign-prob-threshold=@var{probability}
14967 @opindex munalign-prob-threshold
14968 Set probability threshold for unaligning branches.
14969 When tuning for @samp{ARC700} and optimizing for speed, branches without
14970 filled delay slot are preferably emitted unaligned and long, unless
14971 profiling indicates that the probability for the branch to be taken
14972 is below @var{probability}.  @xref{Cross-profiling}.
14973 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
14975 @end table
14977 The following options are maintained for backward compatibility, but
14978 are now deprecated and will be removed in a future release:
14980 @c Deprecated options
14981 @table @gcctabopt
14983 @item -margonaut
14984 @opindex margonaut
14985 Obsolete FPX.
14987 @item -mbig-endian
14988 @opindex mbig-endian
14989 @itemx -EB
14990 @opindex EB
14991 Compile code for big-endian targets.  Use of these options is now
14992 deprecated.  Big-endian code is supported by configuring GCC to build
14993 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets,
14994 for which big endian is the default.
14996 @item -mlittle-endian
14997 @opindex mlittle-endian
14998 @itemx -EL
14999 @opindex EL
15000 Compile code for little-endian targets.  Use of these options is now
15001 deprecated.  Little-endian code is supported by configuring GCC to build 
15002 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets,
15003 for which little endian is the default.
15005 @item -mbarrel_shifter
15006 @opindex mbarrel_shifter
15007 Replaced by @option{-mbarrel-shifter}.
15009 @item -mdpfp_compact
15010 @opindex mdpfp_compact
15011 Replaced by @option{-mdpfp-compact}.
15013 @item -mdpfp_fast
15014 @opindex mdpfp_fast
15015 Replaced by @option{-mdpfp-fast}.
15017 @item -mdsp_packa
15018 @opindex mdsp_packa
15019 Replaced by @option{-mdsp-packa}.
15021 @item -mEA
15022 @opindex mEA
15023 Replaced by @option{-mea}.
15025 @item -mmac_24
15026 @opindex mmac_24
15027 Replaced by @option{-mmac-24}.
15029 @item -mmac_d16
15030 @opindex mmac_d16
15031 Replaced by @option{-mmac-d16}.
15033 @item -mspfp_compact
15034 @opindex mspfp_compact
15035 Replaced by @option{-mspfp-compact}.
15037 @item -mspfp_fast
15038 @opindex mspfp_fast
15039 Replaced by @option{-mspfp-fast}.
15041 @item -mtune=@var{cpu}
15042 @opindex mtune
15043 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
15044 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
15045 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively.
15047 @item -multcost=@var{num}
15048 @opindex multcost
15049 Replaced by @option{-mmultcost}.
15051 @end table
15053 @node ARM Options
15054 @subsection ARM Options
15055 @cindex ARM options
15057 These @samp{-m} options are defined for the ARM port:
15059 @table @gcctabopt
15060 @item -mabi=@var{name}
15061 @opindex mabi
15062 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
15063 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
15065 @item -mapcs-frame
15066 @opindex mapcs-frame
15067 Generate a stack frame that is compliant with the ARM Procedure Call
15068 Standard for all functions, even if this is not strictly necessary for
15069 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
15070 with this option causes the stack frames not to be generated for
15071 leaf functions.  The default is @option{-mno-apcs-frame}.
15072 This option is deprecated.
15074 @item -mapcs
15075 @opindex mapcs
15076 This is a synonym for @option{-mapcs-frame} and is deprecated.
15078 @ignore
15079 @c not currently implemented
15080 @item -mapcs-stack-check
15081 @opindex mapcs-stack-check
15082 Generate code to check the amount of stack space available upon entry to
15083 every function (that actually uses some stack space).  If there is
15084 insufficient space available then either the function
15085 @code{__rt_stkovf_split_small} or @code{__rt_stkovf_split_big} is
15086 called, depending upon the amount of stack space required.  The runtime
15087 system is required to provide these functions.  The default is
15088 @option{-mno-apcs-stack-check}, since this produces smaller code.
15090 @c not currently implemented
15091 @item -mapcs-reentrant
15092 @opindex mapcs-reentrant
15093 Generate reentrant, position-independent code.  The default is
15094 @option{-mno-apcs-reentrant}.
15095 @end ignore
15097 @item -mthumb-interwork
15098 @opindex mthumb-interwork
15099 Generate code that supports calling between the ARM and Thumb
15100 instruction sets.  Without this option, on pre-v5 architectures, the
15101 two instruction sets cannot be reliably used inside one program.  The
15102 default is @option{-mno-thumb-interwork}, since slightly larger code
15103 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
15104 configurations this option is meaningless.
15106 @item -mno-sched-prolog
15107 @opindex mno-sched-prolog
15108 Prevent the reordering of instructions in the function prologue, or the
15109 merging of those instruction with the instructions in the function's
15110 body.  This means that all functions start with a recognizable set
15111 of instructions (or in fact one of a choice from a small set of
15112 different function prologues), and this information can be used to
15113 locate the start of functions inside an executable piece of code.  The
15114 default is @option{-msched-prolog}.
15116 @item -mfloat-abi=@var{name}
15117 @opindex mfloat-abi
15118 Specifies which floating-point ABI to use.  Permissible values
15119 are: @samp{soft}, @samp{softfp} and @samp{hard}.
15121 Specifying @samp{soft} causes GCC to generate output containing
15122 library calls for floating-point operations.
15123 @samp{softfp} allows the generation of code using hardware floating-point
15124 instructions, but still uses the soft-float calling conventions.
15125 @samp{hard} allows generation of floating-point instructions
15126 and uses FPU-specific calling conventions.
15128 The default depends on the specific target configuration.  Note that
15129 the hard-float and soft-float ABIs are not link-compatible; you must
15130 compile your entire program with the same ABI, and link with a
15131 compatible set of libraries.
15133 @item -mlittle-endian
15134 @opindex mlittle-endian
15135 Generate code for a processor running in little-endian mode.  This is
15136 the default for all standard configurations.
15138 @item -mbig-endian
15139 @opindex mbig-endian
15140 Generate code for a processor running in big-endian mode; the default is
15141 to compile code for a little-endian processor.
15143 @item -march=@var{name}
15144 @opindex march
15145 This specifies the name of the target ARM architecture.  GCC uses this
15146 name to determine what kind of instructions it can emit when generating
15147 assembly code.  This option can be used in conjunction with or instead
15148 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
15149 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
15150 @samp{armv5}, @samp{armv5e}, @samp{armv5t}, @samp{armv5te},
15151 @samp{armv6}, @samp{armv6-m}, @samp{armv6j}, @samp{armv6k},
15152 @samp{armv6kz}, @samp{armv6s-m},
15153 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk},
15154 @samp{armv7}, @samp{armv7-a}, @samp{armv7-m}, @samp{armv7-r}, @samp{armv7e-m},
15155 @samp{armv7ve}, @samp{armv8-a}, @samp{armv8-a+crc}, @samp{armv8.1-a},
15156 @samp{armv8.1-a+crc}, @samp{armv8-m.base}, @samp{armv8-m.main},
15157 @samp{armv8-m.main+dsp}, @samp{iwmmxt}, @samp{iwmmxt2}.
15159 Architecture revisions older than @samp{armv4t} are deprecated.
15161 @option{-march=armv6s-m} is the @samp{armv6-m} architecture with support for
15162 the (now mandatory) SVC instruction.
15164 @option{-march=armv6zk} is an alias for @samp{armv6kz}, existing for backwards
15165 compatibility.
15167 @option{-march=armv7ve} is the @samp{armv7-a} architecture with virtualization
15168 extensions.
15170 @option{-march=armv8-a+crc} enables code generation for the ARMv8-A
15171 architecture together with the optional CRC32 extensions.
15173 @option{-march=armv8.1-a} enables compiler support for the ARMv8.1-A
15174 architecture.  This also enables the features provided by
15175 @option{-march=armv8-a+crc}.
15177 @option{-march=armv8.2-a} enables compiler support for the ARMv8.2-A
15178 architecture.  This also enables the features provided by
15179 @option{-march=armv8.1-a}.
15181 @option{-march=armv8.2-a+fp16} enables compiler support for the
15182 ARMv8.2-A architecture with the optional FP16 instructions extension.
15183 This also enables the features provided by @option{-march=armv8.1-a}
15184 and implies @option{-mfp16-format=ieee}.
15186 @option{-march=native} causes the compiler to auto-detect the architecture
15187 of the build computer.  At present, this feature is only supported on
15188 GNU/Linux, and not all architectures are recognized.  If the auto-detect
15189 is unsuccessful the option has no effect.
15191 @item -mtune=@var{name}
15192 @opindex mtune
15193 This option specifies the name of the target ARM processor for
15194 which GCC should tune the performance of the code.
15195 For some ARM implementations better performance can be obtained by using
15196 this option.
15197 Permissible names are: @samp{arm2}, @samp{arm250},
15198 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
15199 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
15200 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
15201 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
15202 @samp{arm720},
15203 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
15204 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
15205 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
15206 @samp{strongarm1110},
15207 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
15208 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
15209 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
15210 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
15211 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
15212 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
15213 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
15214 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8},
15215 @samp{cortex-a9}, @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a17},
15216 @samp{cortex-a32}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a57},
15217 @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-r4},
15218 @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-r8},
15219 @samp{cortex-m33},
15220 @samp{cortex-m23},
15221 @samp{cortex-m7},
15222 @samp{cortex-m4},
15223 @samp{cortex-m3},
15224 @samp{cortex-m1},
15225 @samp{cortex-m0},
15226 @samp{cortex-m0plus},
15227 @samp{cortex-m1.small-multiply},
15228 @samp{cortex-m0.small-multiply},
15229 @samp{cortex-m0plus.small-multiply},
15230 @samp{exynos-m1},
15231 @samp{falkor},
15232 @samp{qdf24xx},
15233 @samp{marvell-pj4},
15234 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
15235 @samp{fa526}, @samp{fa626},
15236 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te},
15237 @samp{xgene1}.
15239 Additionally, this option can specify that GCC should tune the performance
15240 of the code for a big.LITTLE system.  Permissible names are:
15241 @samp{cortex-a15.cortex-a7}, @samp{cortex-a17.cortex-a7},
15242 @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
15243 @samp{cortex-a72.cortex-a35}, @samp{cortex-a73.cortex-a53}.
15245 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
15246 performance for a blend of processors within architecture @var{arch}.
15247 The aim is to generate code that run well on the current most popular
15248 processors, balancing between optimizations that benefit some CPUs in the
15249 range, and avoiding performance pitfalls of other CPUs.  The effects of
15250 this option may change in future GCC versions as CPU models come and go.
15252 @option{-mtune=native} causes the compiler to auto-detect the CPU
15253 of the build computer.  At present, this feature is only supported on
15254 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
15255 unsuccessful the option has no effect.
15257 @item -mcpu=@var{name}
15258 @opindex mcpu
15259 This specifies the name of the target ARM processor.  GCC uses this name
15260 to derive the name of the target ARM architecture (as if specified
15261 by @option{-march}) and the ARM processor type for which to tune for
15262 performance (as if specified by @option{-mtune}).  Where this option
15263 is used in conjunction with @option{-march} or @option{-mtune},
15264 those options take precedence over the appropriate part of this option.
15266 Permissible names for this option are the same as those for
15267 @option{-mtune}.
15269 @option{-mcpu=generic-@var{arch}} is also permissible, and is
15270 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
15271 See @option{-mtune} for more information.
15273 @option{-mcpu=native} causes the compiler to auto-detect the CPU
15274 of the build computer.  At present, this feature is only supported on
15275 GNU/Linux, and not all architectures are recognized.  If the auto-detect
15276 is unsuccessful the option has no effect.
15278 @item -mfpu=@var{name}
15279 @opindex mfpu
15280 This specifies what floating-point hardware (or hardware emulation) is
15281 available on the target.  Permissible names are: @samp{vfpv2}, @samp{vfpv3},
15282 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
15283 @samp{vfpv3xd-fp16}, @samp{neon-vfpv3}, @samp{neon-fp16}, @samp{vfpv4},
15284 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
15285 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
15286 @samp{fp-armv8}, @samp{neon-fp-armv8} and @samp{crypto-neon-fp-armv8}.
15287 Note that @samp{neon} is an alias for @samp{neon-vfpv3} and @samp{vfp}
15288 is an alias for @samp{vfpv2}.
15290 If @option{-msoft-float} is specified this specifies the format of
15291 floating-point values.
15293 If the selected floating-point hardware includes the NEON extension
15294 (e.g. @option{-mfpu}=@samp{neon}), note that floating-point
15295 operations are not generated by GCC's auto-vectorization pass unless
15296 @option{-funsafe-math-optimizations} is also specified.  This is
15297 because NEON hardware does not fully implement the IEEE 754 standard for
15298 floating-point arithmetic (in particular denormal values are treated as
15299 zero), so the use of NEON instructions may lead to a loss of precision.
15301 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}).
15303 @item -mfp16-format=@var{name}
15304 @opindex mfp16-format
15305 Specify the format of the @code{__fp16} half-precision floating-point type.
15306 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
15307 the default is @samp{none}, in which case the @code{__fp16} type is not
15308 defined.  @xref{Half-Precision}, for more information.
15310 @item -mstructure-size-boundary=@var{n}
15311 @opindex mstructure-size-boundary
15312 The sizes of all structures and unions are rounded up to a multiple
15313 of the number of bits set by this option.  Permissible values are 8, 32
15314 and 64.  The default value varies for different toolchains.  For the COFF
15315 targeted toolchain the default value is 8.  A value of 64 is only allowed
15316 if the underlying ABI supports it.
15318 Specifying a larger number can produce faster, more efficient code, but
15319 can also increase the size of the program.  Different values are potentially
15320 incompatible.  Code compiled with one value cannot necessarily expect to
15321 work with code or libraries compiled with another value, if they exchange
15322 information using structures or unions.
15324 @item -mabort-on-noreturn
15325 @opindex mabort-on-noreturn
15326 Generate a call to the function @code{abort} at the end of a
15327 @code{noreturn} function.  It is executed if the function tries to
15328 return.
15330 @item -mlong-calls
15331 @itemx -mno-long-calls
15332 @opindex mlong-calls
15333 @opindex mno-long-calls
15334 Tells the compiler to perform function calls by first loading the
15335 address of the function into a register and then performing a subroutine
15336 call on this register.  This switch is needed if the target function
15337 lies outside of the 64-megabyte addressing range of the offset-based
15338 version of subroutine call instruction.
15340 Even if this switch is enabled, not all function calls are turned
15341 into long calls.  The heuristic is that static functions, functions
15342 that have the @code{short_call} attribute, functions that are inside
15343 the scope of a @code{#pragma no_long_calls} directive, and functions whose
15344 definitions have already been compiled within the current compilation
15345 unit are not turned into long calls.  The exceptions to this rule are
15346 that weak function definitions, functions with the @code{long_call}
15347 attribute or the @code{section} attribute, and functions that are within
15348 the scope of a @code{#pragma long_calls} directive are always
15349 turned into long calls.
15351 This feature is not enabled by default.  Specifying
15352 @option{-mno-long-calls} restores the default behavior, as does
15353 placing the function calls within the scope of a @code{#pragma
15354 long_calls_off} directive.  Note these switches have no effect on how
15355 the compiler generates code to handle function calls via function
15356 pointers.
15358 @item -msingle-pic-base
15359 @opindex msingle-pic-base
15360 Treat the register used for PIC addressing as read-only, rather than
15361 loading it in the prologue for each function.  The runtime system is
15362 responsible for initializing this register with an appropriate value
15363 before execution begins.
15365 @item -mpic-register=@var{reg}
15366 @opindex mpic-register
15367 Specify the register to be used for PIC addressing.
15368 For standard PIC base case, the default is any suitable register
15369 determined by compiler.  For single PIC base case, the default is
15370 @samp{R9} if target is EABI based or stack-checking is enabled,
15371 otherwise the default is @samp{R10}.
15373 @item -mpic-data-is-text-relative
15374 @opindex mpic-data-is-text-relative
15375 Assume that the displacement between the text and data segments is fixed
15376 at static link time.  This permits using PC-relative addressing
15377 operations to access data known to be in the data segment.  For
15378 non-VxWorks RTP targets, this option is enabled by default.  When
15379 disabled on such targets, it will enable @option{-msingle-pic-base} by
15380 default.
15382 @item -mpoke-function-name
15383 @opindex mpoke-function-name
15384 Write the name of each function into the text section, directly
15385 preceding the function prologue.  The generated code is similar to this:
15387 @smallexample
15388      t0
15389          .ascii "arm_poke_function_name", 0
15390          .align
15391      t1
15392          .word 0xff000000 + (t1 - t0)
15393      arm_poke_function_name
15394          mov     ip, sp
15395          stmfd   sp!, @{fp, ip, lr, pc@}
15396          sub     fp, ip, #4
15397 @end smallexample
15399 When performing a stack backtrace, code can inspect the value of
15400 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
15401 location @code{pc - 12} and the top 8 bits are set, then we know that
15402 there is a function name embedded immediately preceding this location
15403 and has length @code{((pc[-3]) & 0xff000000)}.
15405 @item -mthumb
15406 @itemx -marm
15407 @opindex marm
15408 @opindex mthumb
15410 Select between generating code that executes in ARM and Thumb
15411 states.  The default for most configurations is to generate code
15412 that executes in ARM state, but the default can be changed by
15413 configuring GCC with the @option{--with-mode=}@var{state}
15414 configure option.
15416 You can also override the ARM and Thumb mode for each function
15417 by using the @code{target("thumb")} and @code{target("arm")} function attributes
15418 (@pxref{ARM Function Attributes}) or pragmas (@pxref{Function Specific Option Pragmas}).
15420 @item -mtpcs-frame
15421 @opindex mtpcs-frame
15422 Generate a stack frame that is compliant with the Thumb Procedure Call
15423 Standard for all non-leaf functions.  (A leaf function is one that does
15424 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
15426 @item -mtpcs-leaf-frame
15427 @opindex mtpcs-leaf-frame
15428 Generate a stack frame that is compliant with the Thumb Procedure Call
15429 Standard for all leaf functions.  (A leaf function is one that does
15430 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
15432 @item -mcallee-super-interworking
15433 @opindex mcallee-super-interworking
15434 Gives all externally visible functions in the file being compiled an ARM
15435 instruction set header which switches to Thumb mode before executing the
15436 rest of the function.  This allows these functions to be called from
15437 non-interworking code.  This option is not valid in AAPCS configurations
15438 because interworking is enabled by default.
15440 @item -mcaller-super-interworking
15441 @opindex mcaller-super-interworking
15442 Allows calls via function pointers (including virtual functions) to
15443 execute correctly regardless of whether the target code has been
15444 compiled for interworking or not.  There is a small overhead in the cost
15445 of executing a function pointer if this option is enabled.  This option
15446 is not valid in AAPCS configurations because interworking is enabled
15447 by default.
15449 @item -mtp=@var{name}
15450 @opindex mtp
15451 Specify the access model for the thread local storage pointer.  The valid
15452 models are @samp{soft}, which generates calls to @code{__aeabi_read_tp},
15453 @samp{cp15}, which fetches the thread pointer from @code{cp15} directly
15454 (supported in the arm6k architecture), and @samp{auto}, which uses the
15455 best available method for the selected processor.  The default setting is
15456 @samp{auto}.
15458 @item -mtls-dialect=@var{dialect}
15459 @opindex mtls-dialect
15460 Specify the dialect to use for accessing thread local storage.  Two
15461 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
15462 @samp{gnu} dialect selects the original GNU scheme for supporting
15463 local and global dynamic TLS models.  The @samp{gnu2} dialect
15464 selects the GNU descriptor scheme, which provides better performance
15465 for shared libraries.  The GNU descriptor scheme is compatible with
15466 the original scheme, but does require new assembler, linker and
15467 library support.  Initial and local exec TLS models are unaffected by
15468 this option and always use the original scheme.
15470 @item -mword-relocations
15471 @opindex mword-relocations
15472 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
15473 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
15474 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
15475 is specified.
15477 @item -mfix-cortex-m3-ldrd
15478 @opindex mfix-cortex-m3-ldrd
15479 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
15480 with overlapping destination and base registers are used.  This option avoids
15481 generating these instructions.  This option is enabled by default when
15482 @option{-mcpu=cortex-m3} is specified.
15484 @item -munaligned-access
15485 @itemx -mno-unaligned-access
15486 @opindex munaligned-access
15487 @opindex mno-unaligned-access
15488 Enables (or disables) reading and writing of 16- and 32- bit values
15489 from addresses that are not 16- or 32- bit aligned.  By default
15490 unaligned access is disabled for all pre-ARMv6, all ARMv6-M and for
15491 ARMv8-M Baseline architectures, and enabled for all other
15492 architectures.  If unaligned access is not enabled then words in packed
15493 data structures are accessed a byte at a time.
15495 The ARM attribute @code{Tag_CPU_unaligned_access} is set in the
15496 generated object file to either true or false, depending upon the
15497 setting of this option.  If unaligned access is enabled then the
15498 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} is also
15499 defined.
15501 @item -mneon-for-64bits
15502 @opindex mneon-for-64bits
15503 Enables using Neon to handle scalar 64-bits operations. This is
15504 disabled by default since the cost of moving data from core registers
15505 to Neon is high.
15507 @item -mslow-flash-data
15508 @opindex mslow-flash-data
15509 Assume loading data from flash is slower than fetching instruction.
15510 Therefore literal load is minimized for better performance.
15511 This option is only supported when compiling for ARMv7 M-profile and
15512 off by default.
15514 @item -masm-syntax-unified
15515 @opindex masm-syntax-unified
15516 Assume inline assembler is using unified asm syntax.  The default is
15517 currently off which implies divided syntax.  This option has no impact
15518 on Thumb2. However, this may change in future releases of GCC.
15519 Divided syntax should be considered deprecated.
15521 @item -mrestrict-it
15522 @opindex mrestrict-it
15523 Restricts generation of IT blocks to conform to the rules of ARMv8.
15524 IT blocks can only contain a single 16-bit instruction from a select
15525 set of instructions. This option is on by default for ARMv8 Thumb mode.
15527 @item -mprint-tune-info
15528 @opindex mprint-tune-info
15529 Print CPU tuning information as comment in assembler file.  This is
15530 an option used only for regression testing of the compiler and not
15531 intended for ordinary use in compiling code.  This option is disabled
15532 by default.
15534 @item -mpure-code
15535 @opindex mpure-code
15536 Do not allow constant data to be placed in code sections.
15537 Additionally, when compiling for ELF object format give all text sections the
15538 ELF processor-specific section attribute @code{SHF_ARM_PURECODE}.  This option
15539 is only available when generating non-pic code for M-profile targets with the
15540 MOVT instruction.
15542 @item -mcmse
15543 @opindex mcmse
15544 Generate secure code as per the "ARMv8-M Security Extensions: Requirements on
15545 Development Tools Engineering Specification", which can be found on
15546 @url{http://infocenter.arm.com/help/topic/com.arm.doc.ecm0359818/ECM0359818_armv8m_security_extensions_reqs_on_dev_tools_1_0.pdf}.
15547 @end table
15549 @node AVR Options
15550 @subsection AVR Options
15551 @cindex AVR Options
15553 These options are defined for AVR implementations:
15555 @table @gcctabopt
15556 @item -mmcu=@var{mcu}
15557 @opindex mmcu
15558 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
15560 The default for this option is@tie{}@samp{avr2}.
15562 GCC supports the following AVR devices and ISAs:
15564 @include avr-mmcu.texi
15566 @item -mabsdata
15567 @opindex mabsdata
15569 Assume that all data in static storage can be accessed by LDS / STS
15570 instructions.  This option has only an effect on reduced Tiny devices like
15571 ATtiny40.  See also the @code{absdata}
15572 @ref{AVR Variable Attributes,variable attribute}.
15574 @item -maccumulate-args
15575 @opindex maccumulate-args
15576 Accumulate outgoing function arguments and acquire/release the needed
15577 stack space for outgoing function arguments once in function
15578 prologue/epilogue.  Without this option, outgoing arguments are pushed
15579 before calling a function and popped afterwards.
15581 Popping the arguments after the function call can be expensive on
15582 AVR so that accumulating the stack space might lead to smaller
15583 executables because arguments need not be removed from the
15584 stack after such a function call.
15586 This option can lead to reduced code size for functions that perform
15587 several calls to functions that get their arguments on the stack like
15588 calls to printf-like functions.
15590 @item -mbranch-cost=@var{cost}
15591 @opindex mbranch-cost
15592 Set the branch costs for conditional branch instructions to
15593 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
15594 integers. The default branch cost is 0.
15596 @item -mcall-prologues
15597 @opindex mcall-prologues
15598 Functions prologues/epilogues are expanded as calls to appropriate
15599 subroutines.  Code size is smaller.
15601 @item -mint8
15602 @opindex mint8
15603 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
15604 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
15605 and @code{long long} is 4 bytes.  Please note that this option does not
15606 conform to the C standards, but it results in smaller code
15607 size.
15609 @item -mn-flash=@var{num}
15610 @opindex mn-flash
15611 Assume that the flash memory has a size of 
15612 @var{num} times 64@tie{}KiB.
15614 @item -mno-interrupts
15615 @opindex mno-interrupts
15616 Generated code is not compatible with hardware interrupts.
15617 Code size is smaller.
15619 @item -mrelax
15620 @opindex mrelax
15621 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
15622 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
15623 Setting @option{-mrelax} just adds the @option{--mlink-relax} option to
15624 the assembler's command line and the @option{--relax} option to the
15625 linker's command line.
15627 Jump relaxing is performed by the linker because jump offsets are not
15628 known before code is located. Therefore, the assembler code generated by the
15629 compiler is the same, but the instructions in the executable may
15630 differ from instructions in the assembler code.
15632 Relaxing must be turned on if linker stubs are needed, see the
15633 section on @code{EIND} and linker stubs below.
15635 @item -mrmw
15636 @opindex mrmw
15637 Assume that the device supports the Read-Modify-Write
15638 instructions @code{XCH}, @code{LAC}, @code{LAS} and @code{LAT}.
15640 @item -msp8
15641 @opindex msp8
15642 Treat the stack pointer register as an 8-bit register,
15643 i.e.@: assume the high byte of the stack pointer is zero.
15644 In general, you don't need to set this option by hand.
15646 This option is used internally by the compiler to select and
15647 build multilibs for architectures @code{avr2} and @code{avr25}.
15648 These architectures mix devices with and without @code{SPH}.
15649 For any setting other than @option{-mmcu=avr2} or @option{-mmcu=avr25}
15650 the compiler driver adds or removes this option from the compiler
15651 proper's command line, because the compiler then knows if the device
15652 or architecture has an 8-bit stack pointer and thus no @code{SPH}
15653 register or not.
15655 @item -mstrict-X
15656 @opindex mstrict-X
15657 Use address register @code{X} in a way proposed by the hardware.  This means
15658 that @code{X} is only used in indirect, post-increment or
15659 pre-decrement addressing.
15661 Without this option, the @code{X} register may be used in the same way
15662 as @code{Y} or @code{Z} which then is emulated by additional
15663 instructions.  
15664 For example, loading a value with @code{X+const} addressing with a
15665 small non-negative @code{const < 64} to a register @var{Rn} is
15666 performed as
15668 @example
15669 adiw r26, const   ; X += const
15670 ld   @var{Rn}, X        ; @var{Rn} = *X
15671 sbiw r26, const   ; X -= const
15672 @end example
15674 @item -mtiny-stack
15675 @opindex mtiny-stack
15676 Only change the lower 8@tie{}bits of the stack pointer.
15678 @item -mfract-convert-truncate
15679 @opindex mfract-convert-truncate
15680 Allow to use truncation instead of rounding towards zero for fractional fixed-point types.
15682 @item -nodevicelib
15683 @opindex nodevicelib
15684 Don't link against AVR-LibC's device specific library @code{lib<mcu>.a}.
15686 @item -Waddr-space-convert
15687 @opindex Waddr-space-convert
15688 Warn about conversions between address spaces in the case where the
15689 resulting address space is not contained in the incoming address space.
15691 @item -Wmisspelled-isr
15692 @opindex Wmisspelled-isr
15693 Warn if the ISR is misspelled, i.e. without __vector prefix.
15694 Enabled by default.
15695 @end table
15697 @subsubsection @code{EIND} and Devices with More Than 128 Ki Bytes of Flash
15698 @cindex @code{EIND}
15699 Pointers in the implementation are 16@tie{}bits wide.
15700 The address of a function or label is represented as word address so
15701 that indirect jumps and calls can target any code address in the
15702 range of 64@tie{}Ki words.
15704 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
15705 bytes of program memory space, there is a special function register called
15706 @code{EIND} that serves as most significant part of the target address
15707 when @code{EICALL} or @code{EIJMP} instructions are used.
15709 Indirect jumps and calls on these devices are handled as follows by
15710 the compiler and are subject to some limitations:
15712 @itemize @bullet
15714 @item
15715 The compiler never sets @code{EIND}.
15717 @item
15718 The compiler uses @code{EIND} implicitly in @code{EICALL}/@code{EIJMP}
15719 instructions or might read @code{EIND} directly in order to emulate an
15720 indirect call/jump by means of a @code{RET} instruction.
15722 @item
15723 The compiler assumes that @code{EIND} never changes during the startup
15724 code or during the application. In particular, @code{EIND} is not
15725 saved/restored in function or interrupt service routine
15726 prologue/epilogue.
15728 @item
15729 For indirect calls to functions and computed goto, the linker
15730 generates @emph{stubs}. Stubs are jump pads sometimes also called
15731 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
15732 The stub contains a direct jump to the desired address.
15734 @item
15735 Linker relaxation must be turned on so that the linker generates
15736 the stubs correctly in all situations. See the compiler option
15737 @option{-mrelax} and the linker option @option{--relax}.
15738 There are corner cases where the linker is supposed to generate stubs
15739 but aborts without relaxation and without a helpful error message.
15741 @item
15742 The default linker script is arranged for code with @code{EIND = 0}.
15743 If code is supposed to work for a setup with @code{EIND != 0}, a custom
15744 linker script has to be used in order to place the sections whose
15745 name start with @code{.trampolines} into the segment where @code{EIND}
15746 points to.
15748 @item
15749 The startup code from libgcc never sets @code{EIND}.
15750 Notice that startup code is a blend of code from libgcc and AVR-LibC.
15751 For the impact of AVR-LibC on @code{EIND}, see the
15752 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
15754 @item
15755 It is legitimate for user-specific startup code to set up @code{EIND}
15756 early, for example by means of initialization code located in
15757 section @code{.init3}. Such code runs prior to general startup code
15758 that initializes RAM and calls constructors, but after the bit
15759 of startup code from AVR-LibC that sets @code{EIND} to the segment
15760 where the vector table is located.
15761 @example
15762 #include <avr/io.h>
15764 static void
15765 __attribute__((section(".init3"),naked,used,no_instrument_function))
15766 init3_set_eind (void)
15768   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
15769                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
15771 @end example
15773 @noindent
15774 The @code{__trampolines_start} symbol is defined in the linker script.
15776 @item
15777 Stubs are generated automatically by the linker if
15778 the following two conditions are met:
15779 @itemize @minus
15781 @item The address of a label is taken by means of the @code{gs} modifier
15782 (short for @emph{generate stubs}) like so:
15783 @example
15784 LDI r24, lo8(gs(@var{func}))
15785 LDI r25, hi8(gs(@var{func}))
15786 @end example
15787 @item The final location of that label is in a code segment
15788 @emph{outside} the segment where the stubs are located.
15789 @end itemize
15791 @item
15792 The compiler emits such @code{gs} modifiers for code labels in the
15793 following situations:
15794 @itemize @minus
15795 @item Taking address of a function or code label.
15796 @item Computed goto.
15797 @item If prologue-save function is used, see @option{-mcall-prologues}
15798 command-line option.
15799 @item Switch/case dispatch tables. If you do not want such dispatch
15800 tables you can specify the @option{-fno-jump-tables} command-line option.
15801 @item C and C++ constructors/destructors called during startup/shutdown.
15802 @item If the tools hit a @code{gs()} modifier explained above.
15803 @end itemize
15805 @item
15806 Jumping to non-symbolic addresses like so is @emph{not} supported:
15808 @example
15809 int main (void)
15811     /* Call function at word address 0x2 */
15812     return ((int(*)(void)) 0x2)();
15814 @end example
15816 Instead, a stub has to be set up, i.e.@: the function has to be called
15817 through a symbol (@code{func_4} in the example):
15819 @example
15820 int main (void)
15822     extern int func_4 (void);
15824     /* Call function at byte address 0x4 */
15825     return func_4();
15827 @end example
15829 and the application be linked with @option{-Wl,--defsym,func_4=0x4}.
15830 Alternatively, @code{func_4} can be defined in the linker script.
15831 @end itemize
15833 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
15834 @cindex @code{RAMPD}
15835 @cindex @code{RAMPX}
15836 @cindex @code{RAMPY}
15837 @cindex @code{RAMPZ}
15838 Some AVR devices support memories larger than the 64@tie{}KiB range
15839 that can be accessed with 16-bit pointers.  To access memory locations
15840 outside this 64@tie{}KiB range, the content of a @code{RAMP}
15841 register is used as high part of the address:
15842 The @code{X}, @code{Y}, @code{Z} address register is concatenated
15843 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
15844 register, respectively, to get a wide address. Similarly,
15845 @code{RAMPD} is used together with direct addressing.
15847 @itemize
15848 @item
15849 The startup code initializes the @code{RAMP} special function
15850 registers with zero.
15852 @item
15853 If a @ref{AVR Named Address Spaces,named address space} other than
15854 generic or @code{__flash} is used, then @code{RAMPZ} is set
15855 as needed before the operation.
15857 @item
15858 If the device supports RAM larger than 64@tie{}KiB and the compiler
15859 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
15860 is reset to zero after the operation.
15862 @item
15863 If the device comes with a specific @code{RAMP} register, the ISR
15864 prologue/epilogue saves/restores that SFR and initializes it with
15865 zero in case the ISR code might (implicitly) use it.
15867 @item
15868 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
15869 If you use inline assembler to read from locations outside the
15870 16-bit address range and change one of the @code{RAMP} registers,
15871 you must reset it to zero after the access.
15873 @end itemize
15875 @subsubsection AVR Built-in Macros
15877 GCC defines several built-in macros so that the user code can test
15878 for the presence or absence of features.  Almost any of the following
15879 built-in macros are deduced from device capabilities and thus
15880 triggered by the @option{-mmcu=} command-line option.
15882 For even more AVR-specific built-in macros see
15883 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
15885 @table @code
15887 @item __AVR_ARCH__
15888 Build-in macro that resolves to a decimal number that identifies the
15889 architecture and depends on the @option{-mmcu=@var{mcu}} option.
15890 Possible values are:
15892 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
15893 @code{4}, @code{5}, @code{51}, @code{6}
15895 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3}, @code{avr31},
15896 @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51}, @code{avr6},
15898 respectively and
15900 @code{100}, @code{102}, @code{104},
15901 @code{105}, @code{106}, @code{107}
15903 for @var{mcu}=@code{avrtiny}, @code{avrxmega2}, @code{avrxmega4},
15904 @code{avrxmega5}, @code{avrxmega6}, @code{avrxmega7}, respectively.
15905 If @var{mcu} specifies a device, this built-in macro is set
15906 accordingly. For example, with @option{-mmcu=atmega8} the macro is
15907 defined to @code{4}.
15909 @item __AVR_@var{Device}__
15910 Setting @option{-mmcu=@var{device}} defines this built-in macro which reflects
15911 the device's name. For example, @option{-mmcu=atmega8} defines the
15912 built-in macro @code{__AVR_ATmega8__}, @option{-mmcu=attiny261a} defines
15913 @code{__AVR_ATtiny261A__}, etc.
15915 The built-in macros' names follow
15916 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
15917 the device name as from the AVR user manual. The difference between
15918 @var{Device} in the built-in macro and @var{device} in
15919 @option{-mmcu=@var{device}} is that the latter is always lowercase.
15921 If @var{device} is not a device but only a core architecture like
15922 @samp{avr51}, this macro is not defined.
15924 @item __AVR_DEVICE_NAME__
15925 Setting @option{-mmcu=@var{device}} defines this built-in macro to
15926 the device's name. For example, with @option{-mmcu=atmega8} the macro
15927 is defined to @code{atmega8}.
15929 If @var{device} is not a device but only a core architecture like
15930 @samp{avr51}, this macro is not defined.
15932 @item __AVR_XMEGA__
15933 The device / architecture belongs to the XMEGA family of devices.
15935 @item __AVR_HAVE_ELPM__
15936 The device has the @code{ELPM} instruction.
15938 @item __AVR_HAVE_ELPMX__
15939 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
15940 R@var{n},Z+} instructions.
15942 @item __AVR_HAVE_MOVW__
15943 The device has the @code{MOVW} instruction to perform 16-bit
15944 register-register moves.
15946 @item __AVR_HAVE_LPMX__
15947 The device has the @code{LPM R@var{n},Z} and
15948 @code{LPM R@var{n},Z+} instructions.
15950 @item __AVR_HAVE_MUL__
15951 The device has a hardware multiplier. 
15953 @item __AVR_HAVE_JMP_CALL__
15954 The device has the @code{JMP} and @code{CALL} instructions.
15955 This is the case for devices with at least 16@tie{}KiB of program
15956 memory.
15958 @item __AVR_HAVE_EIJMP_EICALL__
15959 @itemx __AVR_3_BYTE_PC__
15960 The device has the @code{EIJMP} and @code{EICALL} instructions.
15961 This is the case for devices with more than 128@tie{}KiB of program memory.
15962 This also means that the program counter
15963 (PC) is 3@tie{}bytes wide.
15965 @item __AVR_2_BYTE_PC__
15966 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
15967 with up to 128@tie{}KiB of program memory.
15969 @item __AVR_HAVE_8BIT_SP__
15970 @itemx __AVR_HAVE_16BIT_SP__
15971 The stack pointer (SP) register is treated as 8-bit respectively
15972 16-bit register by the compiler.
15973 The definition of these macros is affected by @option{-mtiny-stack}.
15975 @item __AVR_HAVE_SPH__
15976 @itemx __AVR_SP8__
15977 The device has the SPH (high part of stack pointer) special function
15978 register or has an 8-bit stack pointer, respectively.
15979 The definition of these macros is affected by @option{-mmcu=} and
15980 in the cases of @option{-mmcu=avr2} and @option{-mmcu=avr25} also
15981 by @option{-msp8}.
15983 @item __AVR_HAVE_RAMPD__
15984 @itemx __AVR_HAVE_RAMPX__
15985 @itemx __AVR_HAVE_RAMPY__
15986 @itemx __AVR_HAVE_RAMPZ__
15987 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
15988 @code{RAMPZ} special function register, respectively.
15990 @item __NO_INTERRUPTS__
15991 This macro reflects the @option{-mno-interrupts} command-line option.
15993 @item __AVR_ERRATA_SKIP__
15994 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
15995 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
15996 instructions because of a hardware erratum.  Skip instructions are
15997 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
15998 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
15999 set.
16001 @item __AVR_ISA_RMW__
16002 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
16004 @item __AVR_SFR_OFFSET__=@var{offset}
16005 Instructions that can address I/O special function registers directly
16006 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
16007 address as if addressed by an instruction to access RAM like @code{LD}
16008 or @code{STS}. This offset depends on the device architecture and has
16009 to be subtracted from the RAM address in order to get the
16010 respective I/O@tie{}address.
16012 @item __WITH_AVRLIBC__
16013 The compiler is configured to be used together with AVR-Libc.
16014 See the @option{--with-avrlibc} configure option.
16016 @end table
16018 @node Blackfin Options
16019 @subsection Blackfin Options
16020 @cindex Blackfin Options
16022 @table @gcctabopt
16023 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
16024 @opindex mcpu=
16025 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
16026 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
16027 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
16028 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
16029 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
16030 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
16031 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
16032 @samp{bf561}, @samp{bf592}.
16034 The optional @var{sirevision} specifies the silicon revision of the target
16035 Blackfin processor.  Any workarounds available for the targeted silicon revision
16036 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
16037 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
16038 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
16039 hexadecimal digits representing the major and minor numbers in the silicon
16040 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
16041 is not defined.  If @var{sirevision} is @samp{any}, the
16042 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
16043 If this optional @var{sirevision} is not used, GCC assumes the latest known
16044 silicon revision of the targeted Blackfin processor.
16046 GCC defines a preprocessor macro for the specified @var{cpu}.
16047 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
16048 provided by libgloss to be linked in if @option{-msim} is not given.
16050 Without this option, @samp{bf532} is used as the processor by default.
16052 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
16053 only the preprocessor macro is defined.
16055 @item -msim
16056 @opindex msim
16057 Specifies that the program will be run on the simulator.  This causes
16058 the simulator BSP provided by libgloss to be linked in.  This option
16059 has effect only for @samp{bfin-elf} toolchain.
16060 Certain other options, such as @option{-mid-shared-library} and
16061 @option{-mfdpic}, imply @option{-msim}.
16063 @item -momit-leaf-frame-pointer
16064 @opindex momit-leaf-frame-pointer
16065 Don't keep the frame pointer in a register for leaf functions.  This
16066 avoids the instructions to save, set up and restore frame pointers and
16067 makes an extra register available in leaf functions.  The option
16068 @option{-fomit-frame-pointer} removes the frame pointer for all functions,
16069 which might make debugging harder.
16071 @item -mspecld-anomaly
16072 @opindex mspecld-anomaly
16073 When enabled, the compiler ensures that the generated code does not
16074 contain speculative loads after jump instructions. If this option is used,
16075 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
16077 @item -mno-specld-anomaly
16078 @opindex mno-specld-anomaly
16079 Don't generate extra code to prevent speculative loads from occurring.
16081 @item -mcsync-anomaly
16082 @opindex mcsync-anomaly
16083 When enabled, the compiler ensures that the generated code does not
16084 contain CSYNC or SSYNC instructions too soon after conditional branches.
16085 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
16087 @item -mno-csync-anomaly
16088 @opindex mno-csync-anomaly
16089 Don't generate extra code to prevent CSYNC or SSYNC instructions from
16090 occurring too soon after a conditional branch.
16092 @item -mlow-64k
16093 @opindex mlow-64k
16094 When enabled, the compiler is free to take advantage of the knowledge that
16095 the entire program fits into the low 64k of memory.
16097 @item -mno-low-64k
16098 @opindex mno-low-64k
16099 Assume that the program is arbitrarily large.  This is the default.
16101 @item -mstack-check-l1
16102 @opindex mstack-check-l1
16103 Do stack checking using information placed into L1 scratchpad memory by the
16104 uClinux kernel.
16106 @item -mid-shared-library
16107 @opindex mid-shared-library
16108 Generate code that supports shared libraries via the library ID method.
16109 This allows for execute in place and shared libraries in an environment
16110 without virtual memory management.  This option implies @option{-fPIC}.
16111 With a @samp{bfin-elf} target, this option implies @option{-msim}.
16113 @item -mno-id-shared-library
16114 @opindex mno-id-shared-library
16115 Generate code that doesn't assume ID-based shared libraries are being used.
16116 This is the default.
16118 @item -mleaf-id-shared-library
16119 @opindex mleaf-id-shared-library
16120 Generate code that supports shared libraries via the library ID method,
16121 but assumes that this library or executable won't link against any other
16122 ID shared libraries.  That allows the compiler to use faster code for jumps
16123 and calls.
16125 @item -mno-leaf-id-shared-library
16126 @opindex mno-leaf-id-shared-library
16127 Do not assume that the code being compiled won't link against any ID shared
16128 libraries.  Slower code is generated for jump and call insns.
16130 @item -mshared-library-id=n
16131 @opindex mshared-library-id
16132 Specifies the identification number of the ID-based shared library being
16133 compiled.  Specifying a value of 0 generates more compact code; specifying
16134 other values forces the allocation of that number to the current
16135 library but is no more space- or time-efficient than omitting this option.
16137 @item -msep-data
16138 @opindex msep-data
16139 Generate code that allows the data segment to be located in a different
16140 area of memory from the text segment.  This allows for execute in place in
16141 an environment without virtual memory management by eliminating relocations
16142 against the text section.
16144 @item -mno-sep-data
16145 @opindex mno-sep-data
16146 Generate code that assumes that the data segment follows the text segment.
16147 This is the default.
16149 @item -mlong-calls
16150 @itemx -mno-long-calls
16151 @opindex mlong-calls
16152 @opindex mno-long-calls
16153 Tells the compiler to perform function calls by first loading the
16154 address of the function into a register and then performing a subroutine
16155 call on this register.  This switch is needed if the target function
16156 lies outside of the 24-bit addressing range of the offset-based
16157 version of subroutine call instruction.
16159 This feature is not enabled by default.  Specifying
16160 @option{-mno-long-calls} restores the default behavior.  Note these
16161 switches have no effect on how the compiler generates code to handle
16162 function calls via function pointers.
16164 @item -mfast-fp
16165 @opindex mfast-fp
16166 Link with the fast floating-point library. This library relaxes some of
16167 the IEEE floating-point standard's rules for checking inputs against
16168 Not-a-Number (NAN), in the interest of performance.
16170 @item -minline-plt
16171 @opindex minline-plt
16172 Enable inlining of PLT entries in function calls to functions that are
16173 not known to bind locally.  It has no effect without @option{-mfdpic}.
16175 @item -mmulticore
16176 @opindex mmulticore
16177 Build a standalone application for multicore Blackfin processors. 
16178 This option causes proper start files and link scripts supporting 
16179 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
16180 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
16182 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
16183 selects the one-application-per-core programming model.  Without
16184 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
16185 programming model is used. In this model, the main function of Core B
16186 should be named as @code{coreb_main}.
16188 If this option is not used, the single-core application programming
16189 model is used.
16191 @item -mcorea
16192 @opindex mcorea
16193 Build a standalone application for Core A of BF561 when using
16194 the one-application-per-core programming model. Proper start files
16195 and link scripts are used to support Core A, and the macro
16196 @code{__BFIN_COREA} is defined.
16197 This option can only be used in conjunction with @option{-mmulticore}.
16199 @item -mcoreb
16200 @opindex mcoreb
16201 Build a standalone application for Core B of BF561 when using
16202 the one-application-per-core programming model. Proper start files
16203 and link scripts are used to support Core B, and the macro
16204 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
16205 should be used instead of @code{main}. 
16206 This option can only be used in conjunction with @option{-mmulticore}.
16208 @item -msdram
16209 @opindex msdram
16210 Build a standalone application for SDRAM. Proper start files and
16211 link scripts are used to put the application into SDRAM, and the macro
16212 @code{__BFIN_SDRAM} is defined.
16213 The loader should initialize SDRAM before loading the application.
16215 @item -micplb
16216 @opindex micplb
16217 Assume that ICPLBs are enabled at run time.  This has an effect on certain
16218 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
16219 are enabled; for standalone applications the default is off.
16220 @end table
16222 @node C6X Options
16223 @subsection C6X Options
16224 @cindex C6X Options
16226 @table @gcctabopt
16227 @item -march=@var{name}
16228 @opindex march
16229 This specifies the name of the target architecture.  GCC uses this
16230 name to determine what kind of instructions it can emit when generating
16231 assembly code.  Permissible names are: @samp{c62x},
16232 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
16234 @item -mbig-endian
16235 @opindex mbig-endian
16236 Generate code for a big-endian target.
16238 @item -mlittle-endian
16239 @opindex mlittle-endian
16240 Generate code for a little-endian target.  This is the default.
16242 @item -msim
16243 @opindex msim
16244 Choose startup files and linker script suitable for the simulator.
16246 @item -msdata=default
16247 @opindex msdata=default
16248 Put small global and static data in the @code{.neardata} section,
16249 which is pointed to by register @code{B14}.  Put small uninitialized
16250 global and static data in the @code{.bss} section, which is adjacent
16251 to the @code{.neardata} section.  Put small read-only data into the
16252 @code{.rodata} section.  The corresponding sections used for large
16253 pieces of data are @code{.fardata}, @code{.far} and @code{.const}.
16255 @item -msdata=all
16256 @opindex msdata=all
16257 Put all data, not just small objects, into the sections reserved for
16258 small data, and use addressing relative to the @code{B14} register to
16259 access them.
16261 @item -msdata=none
16262 @opindex msdata=none
16263 Make no use of the sections reserved for small data, and use absolute
16264 addresses to access all data.  Put all initialized global and static
16265 data in the @code{.fardata} section, and all uninitialized data in the
16266 @code{.far} section.  Put all constant data into the @code{.const}
16267 section.
16268 @end table
16270 @node CRIS Options
16271 @subsection CRIS Options
16272 @cindex CRIS Options
16274 These options are defined specifically for the CRIS ports.
16276 @table @gcctabopt
16277 @item -march=@var{architecture-type}
16278 @itemx -mcpu=@var{architecture-type}
16279 @opindex march
16280 @opindex mcpu
16281 Generate code for the specified architecture.  The choices for
16282 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
16283 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
16284 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
16285 @samp{v10}.
16287 @item -mtune=@var{architecture-type}
16288 @opindex mtune
16289 Tune to @var{architecture-type} everything applicable about the generated
16290 code, except for the ABI and the set of available instructions.  The
16291 choices for @var{architecture-type} are the same as for
16292 @option{-march=@var{architecture-type}}.
16294 @item -mmax-stack-frame=@var{n}
16295 @opindex mmax-stack-frame
16296 Warn when the stack frame of a function exceeds @var{n} bytes.
16298 @item -metrax4
16299 @itemx -metrax100
16300 @opindex metrax4
16301 @opindex metrax100
16302 The options @option{-metrax4} and @option{-metrax100} are synonyms for
16303 @option{-march=v3} and @option{-march=v8} respectively.
16305 @item -mmul-bug-workaround
16306 @itemx -mno-mul-bug-workaround
16307 @opindex mmul-bug-workaround
16308 @opindex mno-mul-bug-workaround
16309 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
16310 models where it applies.  This option is active by default.
16312 @item -mpdebug
16313 @opindex mpdebug
16314 Enable CRIS-specific verbose debug-related information in the assembly
16315 code.  This option also has the effect of turning off the @samp{#NO_APP}
16316 formatted-code indicator to the assembler at the beginning of the
16317 assembly file.
16319 @item -mcc-init
16320 @opindex mcc-init
16321 Do not use condition-code results from previous instruction; always emit
16322 compare and test instructions before use of condition codes.
16324 @item -mno-side-effects
16325 @opindex mno-side-effects
16326 Do not emit instructions with side effects in addressing modes other than
16327 post-increment.
16329 @item -mstack-align
16330 @itemx -mno-stack-align
16331 @itemx -mdata-align
16332 @itemx -mno-data-align
16333 @itemx -mconst-align
16334 @itemx -mno-const-align
16335 @opindex mstack-align
16336 @opindex mno-stack-align
16337 @opindex mdata-align
16338 @opindex mno-data-align
16339 @opindex mconst-align
16340 @opindex mno-const-align
16341 These options (@samp{no-} options) arrange (eliminate arrangements) for the
16342 stack frame, individual data and constants to be aligned for the maximum
16343 single data access size for the chosen CPU model.  The default is to
16344 arrange for 32-bit alignment.  ABI details such as structure layout are
16345 not affected by these options.
16347 @item -m32-bit
16348 @itemx -m16-bit
16349 @itemx -m8-bit
16350 @opindex m32-bit
16351 @opindex m16-bit
16352 @opindex m8-bit
16353 Similar to the stack- data- and const-align options above, these options
16354 arrange for stack frame, writable data and constants to all be 32-bit,
16355 16-bit or 8-bit aligned.  The default is 32-bit alignment.
16357 @item -mno-prologue-epilogue
16358 @itemx -mprologue-epilogue
16359 @opindex mno-prologue-epilogue
16360 @opindex mprologue-epilogue
16361 With @option{-mno-prologue-epilogue}, the normal function prologue and
16362 epilogue which set up the stack frame are omitted and no return
16363 instructions or return sequences are generated in the code.  Use this
16364 option only together with visual inspection of the compiled code: no
16365 warnings or errors are generated when call-saved registers must be saved,
16366 or storage for local variables needs to be allocated.
16368 @item -mno-gotplt
16369 @itemx -mgotplt
16370 @opindex mno-gotplt
16371 @opindex mgotplt
16372 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
16373 instruction sequences that load addresses for functions from the PLT part
16374 of the GOT rather than (traditional on other architectures) calls to the
16375 PLT@.  The default is @option{-mgotplt}.
16377 @item -melf
16378 @opindex melf
16379 Legacy no-op option only recognized with the cris-axis-elf and
16380 cris-axis-linux-gnu targets.
16382 @item -mlinux
16383 @opindex mlinux
16384 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
16386 @item -sim
16387 @opindex sim
16388 This option, recognized for the cris-axis-elf, arranges
16389 to link with input-output functions from a simulator library.  Code,
16390 initialized data and zero-initialized data are allocated consecutively.
16392 @item -sim2
16393 @opindex sim2
16394 Like @option{-sim}, but pass linker options to locate initialized data at
16395 0x40000000 and zero-initialized data at 0x80000000.
16396 @end table
16398 @node CR16 Options
16399 @subsection CR16 Options
16400 @cindex CR16 Options
16402 These options are defined specifically for the CR16 ports.
16404 @table @gcctabopt
16406 @item -mmac
16407 @opindex mmac
16408 Enable the use of multiply-accumulate instructions. Disabled by default.
16410 @item -mcr16cplus
16411 @itemx -mcr16c
16412 @opindex mcr16cplus
16413 @opindex mcr16c
16414 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
16415 is default.
16417 @item -msim
16418 @opindex msim
16419 Links the library libsim.a which is in compatible with simulator. Applicable
16420 to ELF compiler only.
16422 @item -mint32
16423 @opindex mint32
16424 Choose integer type as 32-bit wide.
16426 @item -mbit-ops
16427 @opindex mbit-ops
16428 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
16430 @item -mdata-model=@var{model}
16431 @opindex mdata-model
16432 Choose a data model. The choices for @var{model} are @samp{near},
16433 @samp{far} or @samp{medium}. @samp{medium} is default.
16434 However, @samp{far} is not valid with @option{-mcr16c}, as the
16435 CR16C architecture does not support the far data model.
16436 @end table
16438 @node Darwin Options
16439 @subsection Darwin Options
16440 @cindex Darwin options
16442 These options are defined for all architectures running the Darwin operating
16443 system.
16445 FSF GCC on Darwin does not create ``fat'' object files; it creates
16446 an object file for the single architecture that GCC was built to
16447 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
16448 @option{-arch} options are used; it does so by running the compiler or
16449 linker multiple times and joining the results together with
16450 @file{lipo}.
16452 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
16453 @samp{i686}) is determined by the flags that specify the ISA
16454 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
16455 @option{-force_cpusubtype_ALL} option can be used to override this.
16457 The Darwin tools vary in their behavior when presented with an ISA
16458 mismatch.  The assembler, @file{as}, only permits instructions to
16459 be used that are valid for the subtype of the file it is generating,
16460 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
16461 The linker for shared libraries, @file{/usr/bin/libtool}, fails
16462 and prints an error if asked to create a shared library with a less
16463 restrictive subtype than its input files (for instance, trying to put
16464 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
16465 for executables, @command{ld}, quietly gives the executable the most
16466 restrictive subtype of any of its input files.
16468 @table @gcctabopt
16469 @item -F@var{dir}
16470 @opindex F
16471 Add the framework directory @var{dir} to the head of the list of
16472 directories to be searched for header files.  These directories are
16473 interleaved with those specified by @option{-I} options and are
16474 scanned in a left-to-right order.
16476 A framework directory is a directory with frameworks in it.  A
16477 framework is a directory with a @file{Headers} and/or
16478 @file{PrivateHeaders} directory contained directly in it that ends
16479 in @file{.framework}.  The name of a framework is the name of this
16480 directory excluding the @file{.framework}.  Headers associated with
16481 the framework are found in one of those two directories, with
16482 @file{Headers} being searched first.  A subframework is a framework
16483 directory that is in a framework's @file{Frameworks} directory.
16484 Includes of subframework headers can only appear in a header of a
16485 framework that contains the subframework, or in a sibling subframework
16486 header.  Two subframeworks are siblings if they occur in the same
16487 framework.  A subframework should not have the same name as a
16488 framework; a warning is issued if this is violated.  Currently a
16489 subframework cannot have subframeworks; in the future, the mechanism
16490 may be extended to support this.  The standard frameworks can be found
16491 in @file{/System/Library/Frameworks} and
16492 @file{/Library/Frameworks}.  An example include looks like
16493 @code{#include <Framework/header.h>}, where @file{Framework} denotes
16494 the name of the framework and @file{header.h} is found in the
16495 @file{PrivateHeaders} or @file{Headers} directory.
16497 @item -iframework@var{dir}
16498 @opindex iframework
16499 Like @option{-F} except the directory is a treated as a system
16500 directory.  The main difference between this @option{-iframework} and
16501 @option{-F} is that with @option{-iframework} the compiler does not
16502 warn about constructs contained within header files found via
16503 @var{dir}.  This option is valid only for the C family of languages.
16505 @item -gused
16506 @opindex gused
16507 Emit debugging information for symbols that are used.  For stabs
16508 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
16509 This is by default ON@.
16511 @item -gfull
16512 @opindex gfull
16513 Emit debugging information for all symbols and types.
16515 @item -mmacosx-version-min=@var{version}
16516 The earliest version of MacOS X that this executable will run on
16517 is @var{version}.  Typical values of @var{version} include @code{10.1},
16518 @code{10.2}, and @code{10.3.9}.
16520 If the compiler was built to use the system's headers by default,
16521 then the default for this option is the system version on which the
16522 compiler is running, otherwise the default is to make choices that
16523 are compatible with as many systems and code bases as possible.
16525 @item -mkernel
16526 @opindex mkernel
16527 Enable kernel development mode.  The @option{-mkernel} option sets
16528 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
16529 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
16530 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
16531 applicable.  This mode also sets @option{-mno-altivec},
16532 @option{-msoft-float}, @option{-fno-builtin} and
16533 @option{-mlong-branch} for PowerPC targets.
16535 @item -mone-byte-bool
16536 @opindex mone-byte-bool
16537 Override the defaults for @code{bool} so that @code{sizeof(bool)==1}.
16538 By default @code{sizeof(bool)} is @code{4} when compiling for
16539 Darwin/PowerPC and @code{1} when compiling for Darwin/x86, so this
16540 option has no effect on x86.
16542 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
16543 to generate code that is not binary compatible with code generated
16544 without that switch.  Using this switch may require recompiling all
16545 other modules in a program, including system libraries.  Use this
16546 switch to conform to a non-default data model.
16548 @item -mfix-and-continue
16549 @itemx -ffix-and-continue
16550 @itemx -findirect-data
16551 @opindex mfix-and-continue
16552 @opindex ffix-and-continue
16553 @opindex findirect-data
16554 Generate code suitable for fast turnaround development, such as to
16555 allow GDB to dynamically load @file{.o} files into already-running
16556 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
16557 are provided for backwards compatibility.
16559 @item -all_load
16560 @opindex all_load
16561 Loads all members of static archive libraries.
16562 See man ld(1) for more information.
16564 @item -arch_errors_fatal
16565 @opindex arch_errors_fatal
16566 Cause the errors having to do with files that have the wrong architecture
16567 to be fatal.
16569 @item -bind_at_load
16570 @opindex bind_at_load
16571 Causes the output file to be marked such that the dynamic linker will
16572 bind all undefined references when the file is loaded or launched.
16574 @item -bundle
16575 @opindex bundle
16576 Produce a Mach-o bundle format file.
16577 See man ld(1) for more information.
16579 @item -bundle_loader @var{executable}
16580 @opindex bundle_loader
16581 This option specifies the @var{executable} that will load the build
16582 output file being linked.  See man ld(1) for more information.
16584 @item -dynamiclib
16585 @opindex dynamiclib
16586 When passed this option, GCC produces a dynamic library instead of
16587 an executable when linking, using the Darwin @file{libtool} command.
16589 @item -force_cpusubtype_ALL
16590 @opindex force_cpusubtype_ALL
16591 This causes GCC's output file to have the @samp{ALL} subtype, instead of
16592 one controlled by the @option{-mcpu} or @option{-march} option.
16594 @item -allowable_client  @var{client_name}
16595 @itemx -client_name
16596 @itemx -compatibility_version
16597 @itemx -current_version
16598 @itemx -dead_strip
16599 @itemx -dependency-file
16600 @itemx -dylib_file
16601 @itemx -dylinker_install_name
16602 @itemx -dynamic
16603 @itemx -exported_symbols_list
16604 @itemx -filelist
16605 @need 800
16606 @itemx -flat_namespace
16607 @itemx -force_flat_namespace
16608 @itemx -headerpad_max_install_names
16609 @itemx -image_base
16610 @itemx -init
16611 @itemx -install_name
16612 @itemx -keep_private_externs
16613 @itemx -multi_module
16614 @itemx -multiply_defined
16615 @itemx -multiply_defined_unused
16616 @need 800
16617 @itemx -noall_load
16618 @itemx -no_dead_strip_inits_and_terms
16619 @itemx -nofixprebinding
16620 @itemx -nomultidefs
16621 @itemx -noprebind
16622 @itemx -noseglinkedit
16623 @itemx -pagezero_size
16624 @itemx -prebind
16625 @itemx -prebind_all_twolevel_modules
16626 @itemx -private_bundle
16627 @need 800
16628 @itemx -read_only_relocs
16629 @itemx -sectalign
16630 @itemx -sectobjectsymbols
16631 @itemx -whyload
16632 @itemx -seg1addr
16633 @itemx -sectcreate
16634 @itemx -sectobjectsymbols
16635 @itemx -sectorder
16636 @itemx -segaddr
16637 @itemx -segs_read_only_addr
16638 @need 800
16639 @itemx -segs_read_write_addr
16640 @itemx -seg_addr_table
16641 @itemx -seg_addr_table_filename
16642 @itemx -seglinkedit
16643 @itemx -segprot
16644 @itemx -segs_read_only_addr
16645 @itemx -segs_read_write_addr
16646 @itemx -single_module
16647 @itemx -static
16648 @itemx -sub_library
16649 @need 800
16650 @itemx -sub_umbrella
16651 @itemx -twolevel_namespace
16652 @itemx -umbrella
16653 @itemx -undefined
16654 @itemx -unexported_symbols_list
16655 @itemx -weak_reference_mismatches
16656 @itemx -whatsloaded
16657 @opindex allowable_client
16658 @opindex client_name
16659 @opindex compatibility_version
16660 @opindex current_version
16661 @opindex dead_strip
16662 @opindex dependency-file
16663 @opindex dylib_file
16664 @opindex dylinker_install_name
16665 @opindex dynamic
16666 @opindex exported_symbols_list
16667 @opindex filelist
16668 @opindex flat_namespace
16669 @opindex force_flat_namespace
16670 @opindex headerpad_max_install_names
16671 @opindex image_base
16672 @opindex init
16673 @opindex install_name
16674 @opindex keep_private_externs
16675 @opindex multi_module
16676 @opindex multiply_defined
16677 @opindex multiply_defined_unused
16678 @opindex noall_load
16679 @opindex no_dead_strip_inits_and_terms
16680 @opindex nofixprebinding
16681 @opindex nomultidefs
16682 @opindex noprebind
16683 @opindex noseglinkedit
16684 @opindex pagezero_size
16685 @opindex prebind
16686 @opindex prebind_all_twolevel_modules
16687 @opindex private_bundle
16688 @opindex read_only_relocs
16689 @opindex sectalign
16690 @opindex sectobjectsymbols
16691 @opindex whyload
16692 @opindex seg1addr
16693 @opindex sectcreate
16694 @opindex sectobjectsymbols
16695 @opindex sectorder
16696 @opindex segaddr
16697 @opindex segs_read_only_addr
16698 @opindex segs_read_write_addr
16699 @opindex seg_addr_table
16700 @opindex seg_addr_table_filename
16701 @opindex seglinkedit
16702 @opindex segprot
16703 @opindex segs_read_only_addr
16704 @opindex segs_read_write_addr
16705 @opindex single_module
16706 @opindex static
16707 @opindex sub_library
16708 @opindex sub_umbrella
16709 @opindex twolevel_namespace
16710 @opindex umbrella
16711 @opindex undefined
16712 @opindex unexported_symbols_list
16713 @opindex weak_reference_mismatches
16714 @opindex whatsloaded
16715 These options are passed to the Darwin linker.  The Darwin linker man page
16716 describes them in detail.
16717 @end table
16719 @node DEC Alpha Options
16720 @subsection DEC Alpha Options
16722 These @samp{-m} options are defined for the DEC Alpha implementations:
16724 @table @gcctabopt
16725 @item -mno-soft-float
16726 @itemx -msoft-float
16727 @opindex mno-soft-float
16728 @opindex msoft-float
16729 Use (do not use) the hardware floating-point instructions for
16730 floating-point operations.  When @option{-msoft-float} is specified,
16731 functions in @file{libgcc.a} are used to perform floating-point
16732 operations.  Unless they are replaced by routines that emulate the
16733 floating-point operations, or compiled in such a way as to call such
16734 emulations routines, these routines issue floating-point
16735 operations.   If you are compiling for an Alpha without floating-point
16736 operations, you must ensure that the library is built so as not to call
16737 them.
16739 Note that Alpha implementations without floating-point operations are
16740 required to have floating-point registers.
16742 @item -mfp-reg
16743 @itemx -mno-fp-regs
16744 @opindex mfp-reg
16745 @opindex mno-fp-regs
16746 Generate code that uses (does not use) the floating-point register set.
16747 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
16748 register set is not used, floating-point operands are passed in integer
16749 registers as if they were integers and floating-point results are passed
16750 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
16751 so any function with a floating-point argument or return value called by code
16752 compiled with @option{-mno-fp-regs} must also be compiled with that
16753 option.
16755 A typical use of this option is building a kernel that does not use,
16756 and hence need not save and restore, any floating-point registers.
16758 @item -mieee
16759 @opindex mieee
16760 The Alpha architecture implements floating-point hardware optimized for
16761 maximum performance.  It is mostly compliant with the IEEE floating-point
16762 standard.  However, for full compliance, software assistance is
16763 required.  This option generates code fully IEEE-compliant code
16764 @emph{except} that the @var{inexact-flag} is not maintained (see below).
16765 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
16766 defined during compilation.  The resulting code is less efficient but is
16767 able to correctly support denormalized numbers and exceptional IEEE
16768 values such as not-a-number and plus/minus infinity.  Other Alpha
16769 compilers call this option @option{-ieee_with_no_inexact}.
16771 @item -mieee-with-inexact
16772 @opindex mieee-with-inexact
16773 This is like @option{-mieee} except the generated code also maintains
16774 the IEEE @var{inexact-flag}.  Turning on this option causes the
16775 generated code to implement fully-compliant IEEE math.  In addition to
16776 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
16777 macro.  On some Alpha implementations the resulting code may execute
16778 significantly slower than the code generated by default.  Since there is
16779 very little code that depends on the @var{inexact-flag}, you should
16780 normally not specify this option.  Other Alpha compilers call this
16781 option @option{-ieee_with_inexact}.
16783 @item -mfp-trap-mode=@var{trap-mode}
16784 @opindex mfp-trap-mode
16785 This option controls what floating-point related traps are enabled.
16786 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
16787 The trap mode can be set to one of four values:
16789 @table @samp
16790 @item n
16791 This is the default (normal) setting.  The only traps that are enabled
16792 are the ones that cannot be disabled in software (e.g., division by zero
16793 trap).
16795 @item u
16796 In addition to the traps enabled by @samp{n}, underflow traps are enabled
16797 as well.
16799 @item su
16800 Like @samp{u}, but the instructions are marked to be safe for software
16801 completion (see Alpha architecture manual for details).
16803 @item sui
16804 Like @samp{su}, but inexact traps are enabled as well.
16805 @end table
16807 @item -mfp-rounding-mode=@var{rounding-mode}
16808 @opindex mfp-rounding-mode
16809 Selects the IEEE rounding mode.  Other Alpha compilers call this option
16810 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
16813 @table @samp
16814 @item n
16815 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
16816 the nearest machine number or towards the even machine number in case
16817 of a tie.
16819 @item m
16820 Round towards minus infinity.
16822 @item c
16823 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
16825 @item d
16826 Dynamic rounding mode.  A field in the floating-point control register
16827 (@var{fpcr}, see Alpha architecture reference manual) controls the
16828 rounding mode in effect.  The C library initializes this register for
16829 rounding towards plus infinity.  Thus, unless your program modifies the
16830 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
16831 @end table
16833 @item -mtrap-precision=@var{trap-precision}
16834 @opindex mtrap-precision
16835 In the Alpha architecture, floating-point traps are imprecise.  This
16836 means without software assistance it is impossible to recover from a
16837 floating trap and program execution normally needs to be terminated.
16838 GCC can generate code that can assist operating system trap handlers
16839 in determining the exact location that caused a floating-point trap.
16840 Depending on the requirements of an application, different levels of
16841 precisions can be selected:
16843 @table @samp
16844 @item p
16845 Program precision.  This option is the default and means a trap handler
16846 can only identify which program caused a floating-point exception.
16848 @item f
16849 Function precision.  The trap handler can determine the function that
16850 caused a floating-point exception.
16852 @item i
16853 Instruction precision.  The trap handler can determine the exact
16854 instruction that caused a floating-point exception.
16855 @end table
16857 Other Alpha compilers provide the equivalent options called
16858 @option{-scope_safe} and @option{-resumption_safe}.
16860 @item -mieee-conformant
16861 @opindex mieee-conformant
16862 This option marks the generated code as IEEE conformant.  You must not
16863 use this option unless you also specify @option{-mtrap-precision=i} and either
16864 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
16865 is to emit the line @samp{.eflag 48} in the function prologue of the
16866 generated assembly file.
16868 @item -mbuild-constants
16869 @opindex mbuild-constants
16870 Normally GCC examines a 32- or 64-bit integer constant to
16871 see if it can construct it from smaller constants in two or three
16872 instructions.  If it cannot, it outputs the constant as a literal and
16873 generates code to load it from the data segment at run time.
16875 Use this option to require GCC to construct @emph{all} integer constants
16876 using code, even if it takes more instructions (the maximum is six).
16878 You typically use this option to build a shared library dynamic
16879 loader.  Itself a shared library, it must relocate itself in memory
16880 before it can find the variables and constants in its own data segment.
16882 @item -mbwx
16883 @itemx -mno-bwx
16884 @itemx -mcix
16885 @itemx -mno-cix
16886 @itemx -mfix
16887 @itemx -mno-fix
16888 @itemx -mmax
16889 @itemx -mno-max
16890 @opindex mbwx
16891 @opindex mno-bwx
16892 @opindex mcix
16893 @opindex mno-cix
16894 @opindex mfix
16895 @opindex mno-fix
16896 @opindex mmax
16897 @opindex mno-max
16898 Indicate whether GCC should generate code to use the optional BWX,
16899 CIX, FIX and MAX instruction sets.  The default is to use the instruction
16900 sets supported by the CPU type specified via @option{-mcpu=} option or that
16901 of the CPU on which GCC was built if none is specified.
16903 @item -mfloat-vax
16904 @itemx -mfloat-ieee
16905 @opindex mfloat-vax
16906 @opindex mfloat-ieee
16907 Generate code that uses (does not use) VAX F and G floating-point
16908 arithmetic instead of IEEE single and double precision.
16910 @item -mexplicit-relocs
16911 @itemx -mno-explicit-relocs
16912 @opindex mexplicit-relocs
16913 @opindex mno-explicit-relocs
16914 Older Alpha assemblers provided no way to generate symbol relocations
16915 except via assembler macros.  Use of these macros does not allow
16916 optimal instruction scheduling.  GNU binutils as of version 2.12
16917 supports a new syntax that allows the compiler to explicitly mark
16918 which relocations should apply to which instructions.  This option
16919 is mostly useful for debugging, as GCC detects the capabilities of
16920 the assembler when it is built and sets the default accordingly.
16922 @item -msmall-data
16923 @itemx -mlarge-data
16924 @opindex msmall-data
16925 @opindex mlarge-data
16926 When @option{-mexplicit-relocs} is in effect, static data is
16927 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
16928 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
16929 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
16930 16-bit relocations off of the @code{$gp} register.  This limits the
16931 size of the small data area to 64KB, but allows the variables to be
16932 directly accessed via a single instruction.
16934 The default is @option{-mlarge-data}.  With this option the data area
16935 is limited to just below 2GB@.  Programs that require more than 2GB of
16936 data must use @code{malloc} or @code{mmap} to allocate the data in the
16937 heap instead of in the program's data segment.
16939 When generating code for shared libraries, @option{-fpic} implies
16940 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
16942 @item -msmall-text
16943 @itemx -mlarge-text
16944 @opindex msmall-text
16945 @opindex mlarge-text
16946 When @option{-msmall-text} is used, the compiler assumes that the
16947 code of the entire program (or shared library) fits in 4MB, and is
16948 thus reachable with a branch instruction.  When @option{-msmall-data}
16949 is used, the compiler can assume that all local symbols share the
16950 same @code{$gp} value, and thus reduce the number of instructions
16951 required for a function call from 4 to 1.
16953 The default is @option{-mlarge-text}.
16955 @item -mcpu=@var{cpu_type}
16956 @opindex mcpu
16957 Set the instruction set and instruction scheduling parameters for
16958 machine type @var{cpu_type}.  You can specify either the @samp{EV}
16959 style name or the corresponding chip number.  GCC supports scheduling
16960 parameters for the EV4, EV5 and EV6 family of processors and
16961 chooses the default values for the instruction set from the processor
16962 you specify.  If you do not specify a processor type, GCC defaults
16963 to the processor on which the compiler was built.
16965 Supported values for @var{cpu_type} are
16967 @table @samp
16968 @item ev4
16969 @itemx ev45
16970 @itemx 21064
16971 Schedules as an EV4 and has no instruction set extensions.
16973 @item ev5
16974 @itemx 21164
16975 Schedules as an EV5 and has no instruction set extensions.
16977 @item ev56
16978 @itemx 21164a
16979 Schedules as an EV5 and supports the BWX extension.
16981 @item pca56
16982 @itemx 21164pc
16983 @itemx 21164PC
16984 Schedules as an EV5 and supports the BWX and MAX extensions.
16986 @item ev6
16987 @itemx 21264
16988 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
16990 @item ev67
16991 @itemx 21264a
16992 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
16993 @end table
16995 Native toolchains also support the value @samp{native},
16996 which selects the best architecture option for the host processor.
16997 @option{-mcpu=native} has no effect if GCC does not recognize
16998 the processor.
17000 @item -mtune=@var{cpu_type}
17001 @opindex mtune
17002 Set only the instruction scheduling parameters for machine type
17003 @var{cpu_type}.  The instruction set is not changed.
17005 Native toolchains also support the value @samp{native},
17006 which selects the best architecture option for the host processor.
17007 @option{-mtune=native} has no effect if GCC does not recognize
17008 the processor.
17010 @item -mmemory-latency=@var{time}
17011 @opindex mmemory-latency
17012 Sets the latency the scheduler should assume for typical memory
17013 references as seen by the application.  This number is highly
17014 dependent on the memory access patterns used by the application
17015 and the size of the external cache on the machine.
17017 Valid options for @var{time} are
17019 @table @samp
17020 @item @var{number}
17021 A decimal number representing clock cycles.
17023 @item L1
17024 @itemx L2
17025 @itemx L3
17026 @itemx main
17027 The compiler contains estimates of the number of clock cycles for
17028 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
17029 (also called Dcache, Scache, and Bcache), as well as to main memory.
17030 Note that L3 is only valid for EV5.
17032 @end table
17033 @end table
17035 @node FR30 Options
17036 @subsection FR30 Options
17037 @cindex FR30 Options
17039 These options are defined specifically for the FR30 port.
17041 @table @gcctabopt
17043 @item -msmall-model
17044 @opindex msmall-model
17045 Use the small address space model.  This can produce smaller code, but
17046 it does assume that all symbolic values and addresses fit into a
17047 20-bit range.
17049 @item -mno-lsim
17050 @opindex mno-lsim
17051 Assume that runtime support has been provided and so there is no need
17052 to include the simulator library (@file{libsim.a}) on the linker
17053 command line.
17055 @end table
17057 @node FT32 Options
17058 @subsection FT32 Options
17059 @cindex FT32 Options
17061 These options are defined specifically for the FT32 port.
17063 @table @gcctabopt
17065 @item -msim
17066 @opindex msim
17067 Specifies that the program will be run on the simulator.  This causes
17068 an alternate runtime startup and library to be linked.
17069 You must not use this option when generating programs that will run on
17070 real hardware; you must provide your own runtime library for whatever
17071 I/O functions are needed.
17073 @item -mlra
17074 @opindex mlra
17075 Enable Local Register Allocation.  This is still experimental for FT32,
17076 so by default the compiler uses standard reload.
17078 @item -mnodiv
17079 @opindex mnodiv
17080 Do not use div and mod instructions.
17082 @end table
17084 @node FRV Options
17085 @subsection FRV Options
17086 @cindex FRV Options
17088 @table @gcctabopt
17089 @item -mgpr-32
17090 @opindex mgpr-32
17092 Only use the first 32 general-purpose registers.
17094 @item -mgpr-64
17095 @opindex mgpr-64
17097 Use all 64 general-purpose registers.
17099 @item -mfpr-32
17100 @opindex mfpr-32
17102 Use only the first 32 floating-point registers.
17104 @item -mfpr-64
17105 @opindex mfpr-64
17107 Use all 64 floating-point registers.
17109 @item -mhard-float
17110 @opindex mhard-float
17112 Use hardware instructions for floating-point operations.
17114 @item -msoft-float
17115 @opindex msoft-float
17117 Use library routines for floating-point operations.
17119 @item -malloc-cc
17120 @opindex malloc-cc
17122 Dynamically allocate condition code registers.
17124 @item -mfixed-cc
17125 @opindex mfixed-cc
17127 Do not try to dynamically allocate condition code registers, only
17128 use @code{icc0} and @code{fcc0}.
17130 @item -mdword
17131 @opindex mdword
17133 Change ABI to use double word insns.
17135 @item -mno-dword
17136 @opindex mno-dword
17138 Do not use double word instructions.
17140 @item -mdouble
17141 @opindex mdouble
17143 Use floating-point double instructions.
17145 @item -mno-double
17146 @opindex mno-double
17148 Do not use floating-point double instructions.
17150 @item -mmedia
17151 @opindex mmedia
17153 Use media instructions.
17155 @item -mno-media
17156 @opindex mno-media
17158 Do not use media instructions.
17160 @item -mmuladd
17161 @opindex mmuladd
17163 Use multiply and add/subtract instructions.
17165 @item -mno-muladd
17166 @opindex mno-muladd
17168 Do not use multiply and add/subtract instructions.
17170 @item -mfdpic
17171 @opindex mfdpic
17173 Select the FDPIC ABI, which uses function descriptors to represent
17174 pointers to functions.  Without any PIC/PIE-related options, it
17175 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
17176 assumes GOT entries and small data are within a 12-bit range from the
17177 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
17178 are computed with 32 bits.
17179 With a @samp{bfin-elf} target, this option implies @option{-msim}.
17181 @item -minline-plt
17182 @opindex minline-plt
17184 Enable inlining of PLT entries in function calls to functions that are
17185 not known to bind locally.  It has no effect without @option{-mfdpic}.
17186 It's enabled by default if optimizing for speed and compiling for
17187 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
17188 optimization option such as @option{-O3} or above is present in the
17189 command line.
17191 @item -mTLS
17192 @opindex mTLS
17194 Assume a large TLS segment when generating thread-local code.
17196 @item -mtls
17197 @opindex mtls
17199 Do not assume a large TLS segment when generating thread-local code.
17201 @item -mgprel-ro
17202 @opindex mgprel-ro
17204 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
17205 that is known to be in read-only sections.  It's enabled by default,
17206 except for @option{-fpic} or @option{-fpie}: even though it may help
17207 make the global offset table smaller, it trades 1 instruction for 4.
17208 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
17209 one of which may be shared by multiple symbols, and it avoids the need
17210 for a GOT entry for the referenced symbol, so it's more likely to be a
17211 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
17213 @item -multilib-library-pic
17214 @opindex multilib-library-pic
17216 Link with the (library, not FD) pic libraries.  It's implied by
17217 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
17218 @option{-fpic} without @option{-mfdpic}.  You should never have to use
17219 it explicitly.
17221 @item -mlinked-fp
17222 @opindex mlinked-fp
17224 Follow the EABI requirement of always creating a frame pointer whenever
17225 a stack frame is allocated.  This option is enabled by default and can
17226 be disabled with @option{-mno-linked-fp}.
17228 @item -mlong-calls
17229 @opindex mlong-calls
17231 Use indirect addressing to call functions outside the current
17232 compilation unit.  This allows the functions to be placed anywhere
17233 within the 32-bit address space.
17235 @item -malign-labels
17236 @opindex malign-labels
17238 Try to align labels to an 8-byte boundary by inserting NOPs into the
17239 previous packet.  This option only has an effect when VLIW packing
17240 is enabled.  It doesn't create new packets; it merely adds NOPs to
17241 existing ones.
17243 @item -mlibrary-pic
17244 @opindex mlibrary-pic
17246 Generate position-independent EABI code.
17248 @item -macc-4
17249 @opindex macc-4
17251 Use only the first four media accumulator registers.
17253 @item -macc-8
17254 @opindex macc-8
17256 Use all eight media accumulator registers.
17258 @item -mpack
17259 @opindex mpack
17261 Pack VLIW instructions.
17263 @item -mno-pack
17264 @opindex mno-pack
17266 Do not pack VLIW instructions.
17268 @item -mno-eflags
17269 @opindex mno-eflags
17271 Do not mark ABI switches in e_flags.
17273 @item -mcond-move
17274 @opindex mcond-move
17276 Enable the use of conditional-move instructions (default).
17278 This switch is mainly for debugging the compiler and will likely be removed
17279 in a future version.
17281 @item -mno-cond-move
17282 @opindex mno-cond-move
17284 Disable the use of conditional-move instructions.
17286 This switch is mainly for debugging the compiler and will likely be removed
17287 in a future version.
17289 @item -mscc
17290 @opindex mscc
17292 Enable the use of conditional set instructions (default).
17294 This switch is mainly for debugging the compiler and will likely be removed
17295 in a future version.
17297 @item -mno-scc
17298 @opindex mno-scc
17300 Disable the use of conditional set instructions.
17302 This switch is mainly for debugging the compiler and will likely be removed
17303 in a future version.
17305 @item -mcond-exec
17306 @opindex mcond-exec
17308 Enable the use of conditional execution (default).
17310 This switch is mainly for debugging the compiler and will likely be removed
17311 in a future version.
17313 @item -mno-cond-exec
17314 @opindex mno-cond-exec
17316 Disable the use of conditional execution.
17318 This switch is mainly for debugging the compiler and will likely be removed
17319 in a future version.
17321 @item -mvliw-branch
17322 @opindex mvliw-branch
17324 Run a pass to pack branches into VLIW instructions (default).
17326 This switch is mainly for debugging the compiler and will likely be removed
17327 in a future version.
17329 @item -mno-vliw-branch
17330 @opindex mno-vliw-branch
17332 Do not run a pass to pack branches into VLIW instructions.
17334 This switch is mainly for debugging the compiler and will likely be removed
17335 in a future version.
17337 @item -mmulti-cond-exec
17338 @opindex mmulti-cond-exec
17340 Enable optimization of @code{&&} and @code{||} in conditional execution
17341 (default).
17343 This switch is mainly for debugging the compiler and will likely be removed
17344 in a future version.
17346 @item -mno-multi-cond-exec
17347 @opindex mno-multi-cond-exec
17349 Disable optimization of @code{&&} and @code{||} in conditional execution.
17351 This switch is mainly for debugging the compiler and will likely be removed
17352 in a future version.
17354 @item -mnested-cond-exec
17355 @opindex mnested-cond-exec
17357 Enable nested conditional execution optimizations (default).
17359 This switch is mainly for debugging the compiler and will likely be removed
17360 in a future version.
17362 @item -mno-nested-cond-exec
17363 @opindex mno-nested-cond-exec
17365 Disable nested conditional execution optimizations.
17367 This switch is mainly for debugging the compiler and will likely be removed
17368 in a future version.
17370 @item -moptimize-membar
17371 @opindex moptimize-membar
17373 This switch removes redundant @code{membar} instructions from the
17374 compiler-generated code.  It is enabled by default.
17376 @item -mno-optimize-membar
17377 @opindex mno-optimize-membar
17379 This switch disables the automatic removal of redundant @code{membar}
17380 instructions from the generated code.
17382 @item -mtomcat-stats
17383 @opindex mtomcat-stats
17385 Cause gas to print out tomcat statistics.
17387 @item -mcpu=@var{cpu}
17388 @opindex mcpu
17390 Select the processor type for which to generate code.  Possible values are
17391 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
17392 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
17394 @end table
17396 @node GNU/Linux Options
17397 @subsection GNU/Linux Options
17399 These @samp{-m} options are defined for GNU/Linux targets:
17401 @table @gcctabopt
17402 @item -mglibc
17403 @opindex mglibc
17404 Use the GNU C library.  This is the default except
17405 on @samp{*-*-linux-*uclibc*}, @samp{*-*-linux-*musl*} and
17406 @samp{*-*-linux-*android*} targets.
17408 @item -muclibc
17409 @opindex muclibc
17410 Use uClibc C library.  This is the default on
17411 @samp{*-*-linux-*uclibc*} targets.
17413 @item -mmusl
17414 @opindex mmusl
17415 Use the musl C library.  This is the default on
17416 @samp{*-*-linux-*musl*} targets.
17418 @item -mbionic
17419 @opindex mbionic
17420 Use Bionic C library.  This is the default on
17421 @samp{*-*-linux-*android*} targets.
17423 @item -mandroid
17424 @opindex mandroid
17425 Compile code compatible with Android platform.  This is the default on
17426 @samp{*-*-linux-*android*} targets.
17428 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
17429 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
17430 this option makes the GCC driver pass Android-specific options to the linker.
17431 Finally, this option causes the preprocessor macro @code{__ANDROID__}
17432 to be defined.
17434 @item -tno-android-cc
17435 @opindex tno-android-cc
17436 Disable compilation effects of @option{-mandroid}, i.e., do not enable
17437 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
17438 @option{-fno-rtti} by default.
17440 @item -tno-android-ld
17441 @opindex tno-android-ld
17442 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
17443 linking options to the linker.
17445 @end table
17447 @node H8/300 Options
17448 @subsection H8/300 Options
17450 These @samp{-m} options are defined for the H8/300 implementations:
17452 @table @gcctabopt
17453 @item -mrelax
17454 @opindex mrelax
17455 Shorten some address references at link time, when possible; uses the
17456 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
17457 ld, Using ld}, for a fuller description.
17459 @item -mh
17460 @opindex mh
17461 Generate code for the H8/300H@.
17463 @item -ms
17464 @opindex ms
17465 Generate code for the H8S@.
17467 @item -mn
17468 @opindex mn
17469 Generate code for the H8S and H8/300H in the normal mode.  This switch
17470 must be used either with @option{-mh} or @option{-ms}.
17472 @item -ms2600
17473 @opindex ms2600
17474 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
17476 @item -mexr
17477 @opindex mexr
17478 Extended registers are stored on stack before execution of function
17479 with monitor attribute. Default option is @option{-mexr}.
17480 This option is valid only for H8S targets.
17482 @item -mno-exr
17483 @opindex mno-exr
17484 Extended registers are not stored on stack before execution of function 
17485 with monitor attribute. Default option is @option{-mno-exr}. 
17486 This option is valid only for H8S targets.
17488 @item -mint32
17489 @opindex mint32
17490 Make @code{int} data 32 bits by default.
17492 @item -malign-300
17493 @opindex malign-300
17494 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
17495 The default for the H8/300H and H8S is to align longs and floats on
17496 4-byte boundaries.
17497 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
17498 This option has no effect on the H8/300.
17499 @end table
17501 @node HPPA Options
17502 @subsection HPPA Options
17503 @cindex HPPA Options
17505 These @samp{-m} options are defined for the HPPA family of computers:
17507 @table @gcctabopt
17508 @item -march=@var{architecture-type}
17509 @opindex march
17510 Generate code for the specified architecture.  The choices for
17511 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
17512 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
17513 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
17514 architecture option for your machine.  Code compiled for lower numbered
17515 architectures runs on higher numbered architectures, but not the
17516 other way around.
17518 @item -mpa-risc-1-0
17519 @itemx -mpa-risc-1-1
17520 @itemx -mpa-risc-2-0
17521 @opindex mpa-risc-1-0
17522 @opindex mpa-risc-1-1
17523 @opindex mpa-risc-2-0
17524 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
17526 @item -mcaller-copies
17527 @opindex mcaller-copies
17528 The caller copies function arguments passed by hidden reference.  This
17529 option should be used with care as it is not compatible with the default
17530 32-bit runtime.  However, only aggregates larger than eight bytes are
17531 passed by hidden reference and the option provides better compatibility
17532 with OpenMP.
17534 @item -mjump-in-delay
17535 @opindex mjump-in-delay
17536 This option is ignored and provided for compatibility purposes only.
17538 @item -mdisable-fpregs
17539 @opindex mdisable-fpregs
17540 Prevent floating-point registers from being used in any manner.  This is
17541 necessary for compiling kernels that perform lazy context switching of
17542 floating-point registers.  If you use this option and attempt to perform
17543 floating-point operations, the compiler aborts.
17545 @item -mdisable-indexing
17546 @opindex mdisable-indexing
17547 Prevent the compiler from using indexing address modes.  This avoids some
17548 rather obscure problems when compiling MIG generated code under MACH@.
17550 @item -mno-space-regs
17551 @opindex mno-space-regs
17552 Generate code that assumes the target has no space registers.  This allows
17553 GCC to generate faster indirect calls and use unscaled index address modes.
17555 Such code is suitable for level 0 PA systems and kernels.
17557 @item -mfast-indirect-calls
17558 @opindex mfast-indirect-calls
17559 Generate code that assumes calls never cross space boundaries.  This
17560 allows GCC to emit code that performs faster indirect calls.
17562 This option does not work in the presence of shared libraries or nested
17563 functions.
17565 @item -mfixed-range=@var{register-range}
17566 @opindex mfixed-range
17567 Generate code treating the given register range as fixed registers.
17568 A fixed register is one that the register allocator cannot use.  This is
17569 useful when compiling kernel code.  A register range is specified as
17570 two registers separated by a dash.  Multiple register ranges can be
17571 specified separated by a comma.
17573 @item -mlong-load-store
17574 @opindex mlong-load-store
17575 Generate 3-instruction load and store sequences as sometimes required by
17576 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
17577 the HP compilers.
17579 @item -mportable-runtime
17580 @opindex mportable-runtime
17581 Use the portable calling conventions proposed by HP for ELF systems.
17583 @item -mgas
17584 @opindex mgas
17585 Enable the use of assembler directives only GAS understands.
17587 @item -mschedule=@var{cpu-type}
17588 @opindex mschedule
17589 Schedule code according to the constraints for the machine type
17590 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
17591 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
17592 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
17593 proper scheduling option for your machine.  The default scheduling is
17594 @samp{8000}.
17596 @item -mlinker-opt
17597 @opindex mlinker-opt
17598 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
17599 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
17600 linkers in which they give bogus error messages when linking some programs.
17602 @item -msoft-float
17603 @opindex msoft-float
17604 Generate output containing library calls for floating point.
17605 @strong{Warning:} the requisite libraries are not available for all HPPA
17606 targets.  Normally the facilities of the machine's usual C compiler are
17607 used, but this cannot be done directly in cross-compilation.  You must make
17608 your own arrangements to provide suitable library functions for
17609 cross-compilation.
17611 @option{-msoft-float} changes the calling convention in the output file;
17612 therefore, it is only useful if you compile @emph{all} of a program with
17613 this option.  In particular, you need to compile @file{libgcc.a}, the
17614 library that comes with GCC, with @option{-msoft-float} in order for
17615 this to work.
17617 @item -msio
17618 @opindex msio
17619 Generate the predefine, @code{_SIO}, for server IO@.  The default is
17620 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
17621 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
17622 options are available under HP-UX and HI-UX@.
17624 @item -mgnu-ld
17625 @opindex mgnu-ld
17626 Use options specific to GNU @command{ld}.
17627 This passes @option{-shared} to @command{ld} when
17628 building a shared library.  It is the default when GCC is configured,
17629 explicitly or implicitly, with the GNU linker.  This option does not
17630 affect which @command{ld} is called; it only changes what parameters
17631 are passed to that @command{ld}.
17632 The @command{ld} that is called is determined by the
17633 @option{--with-ld} configure option, GCC's program search path, and
17634 finally by the user's @env{PATH}.  The linker used by GCC can be printed
17635 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
17636 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
17638 @item -mhp-ld
17639 @opindex mhp-ld
17640 Use options specific to HP @command{ld}.
17641 This passes @option{-b} to @command{ld} when building
17642 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
17643 links.  It is the default when GCC is configured, explicitly or
17644 implicitly, with the HP linker.  This option does not affect
17645 which @command{ld} is called; it only changes what parameters are passed to that
17646 @command{ld}.
17647 The @command{ld} that is called is determined by the @option{--with-ld}
17648 configure option, GCC's program search path, and finally by the user's
17649 @env{PATH}.  The linker used by GCC can be printed using @samp{which
17650 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
17651 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
17653 @item -mlong-calls
17654 @opindex mno-long-calls
17655 Generate code that uses long call sequences.  This ensures that a call
17656 is always able to reach linker generated stubs.  The default is to generate
17657 long calls only when the distance from the call site to the beginning
17658 of the function or translation unit, as the case may be, exceeds a
17659 predefined limit set by the branch type being used.  The limits for
17660 normal calls are 7,600,000 and 240,000 bytes, respectively for the
17661 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
17662 240,000 bytes.
17664 Distances are measured from the beginning of functions when using the
17665 @option{-ffunction-sections} option, or when using the @option{-mgas}
17666 and @option{-mno-portable-runtime} options together under HP-UX with
17667 the SOM linker.
17669 It is normally not desirable to use this option as it degrades
17670 performance.  However, it may be useful in large applications,
17671 particularly when partial linking is used to build the application.
17673 The types of long calls used depends on the capabilities of the
17674 assembler and linker, and the type of code being generated.  The
17675 impact on systems that support long absolute calls, and long pic
17676 symbol-difference or pc-relative calls should be relatively small.
17677 However, an indirect call is used on 32-bit ELF systems in pic code
17678 and it is quite long.
17680 @item -munix=@var{unix-std}
17681 @opindex march
17682 Generate compiler predefines and select a startfile for the specified
17683 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
17684 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
17685 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
17686 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
17687 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
17688 and later.
17690 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
17691 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
17692 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
17693 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
17694 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
17695 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
17697 It is @emph{important} to note that this option changes the interfaces
17698 for various library routines.  It also affects the operational behavior
17699 of the C library.  Thus, @emph{extreme} care is needed in using this
17700 option.
17702 Library code that is intended to operate with more than one UNIX
17703 standard must test, set and restore the variable @code{__xpg4_extended_mask}
17704 as appropriate.  Most GNU software doesn't provide this capability.
17706 @item -nolibdld
17707 @opindex nolibdld
17708 Suppress the generation of link options to search libdld.sl when the
17709 @option{-static} option is specified on HP-UX 10 and later.
17711 @item -static
17712 @opindex static
17713 The HP-UX implementation of setlocale in libc has a dependency on
17714 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
17715 when the @option{-static} option is specified, special link options
17716 are needed to resolve this dependency.
17718 On HP-UX 10 and later, the GCC driver adds the necessary options to
17719 link with libdld.sl when the @option{-static} option is specified.
17720 This causes the resulting binary to be dynamic.  On the 64-bit port,
17721 the linkers generate dynamic binaries by default in any case.  The
17722 @option{-nolibdld} option can be used to prevent the GCC driver from
17723 adding these link options.
17725 @item -threads
17726 @opindex threads
17727 Add support for multithreading with the @dfn{dce thread} library
17728 under HP-UX@.  This option sets flags for both the preprocessor and
17729 linker.
17730 @end table
17732 @node IA-64 Options
17733 @subsection IA-64 Options
17734 @cindex IA-64 Options
17736 These are the @samp{-m} options defined for the Intel IA-64 architecture.
17738 @table @gcctabopt
17739 @item -mbig-endian
17740 @opindex mbig-endian
17741 Generate code for a big-endian target.  This is the default for HP-UX@.
17743 @item -mlittle-endian
17744 @opindex mlittle-endian
17745 Generate code for a little-endian target.  This is the default for AIX5
17746 and GNU/Linux.
17748 @item -mgnu-as
17749 @itemx -mno-gnu-as
17750 @opindex mgnu-as
17751 @opindex mno-gnu-as
17752 Generate (or don't) code for the GNU assembler.  This is the default.
17753 @c Also, this is the default if the configure option @option{--with-gnu-as}
17754 @c is used.
17756 @item -mgnu-ld
17757 @itemx -mno-gnu-ld
17758 @opindex mgnu-ld
17759 @opindex mno-gnu-ld
17760 Generate (or don't) code for the GNU linker.  This is the default.
17761 @c Also, this is the default if the configure option @option{--with-gnu-ld}
17762 @c is used.
17764 @item -mno-pic
17765 @opindex mno-pic
17766 Generate code that does not use a global pointer register.  The result
17767 is not position independent code, and violates the IA-64 ABI@.
17769 @item -mvolatile-asm-stop
17770 @itemx -mno-volatile-asm-stop
17771 @opindex mvolatile-asm-stop
17772 @opindex mno-volatile-asm-stop
17773 Generate (or don't) a stop bit immediately before and after volatile asm
17774 statements.
17776 @item -mregister-names
17777 @itemx -mno-register-names
17778 @opindex mregister-names
17779 @opindex mno-register-names
17780 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
17781 the stacked registers.  This may make assembler output more readable.
17783 @item -mno-sdata
17784 @itemx -msdata
17785 @opindex mno-sdata
17786 @opindex msdata
17787 Disable (or enable) optimizations that use the small data section.  This may
17788 be useful for working around optimizer bugs.
17790 @item -mconstant-gp
17791 @opindex mconstant-gp
17792 Generate code that uses a single constant global pointer value.  This is
17793 useful when compiling kernel code.
17795 @item -mauto-pic
17796 @opindex mauto-pic
17797 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
17798 This is useful when compiling firmware code.
17800 @item -minline-float-divide-min-latency
17801 @opindex minline-float-divide-min-latency
17802 Generate code for inline divides of floating-point values
17803 using the minimum latency algorithm.
17805 @item -minline-float-divide-max-throughput
17806 @opindex minline-float-divide-max-throughput
17807 Generate code for inline divides of floating-point values
17808 using the maximum throughput algorithm.
17810 @item -mno-inline-float-divide
17811 @opindex mno-inline-float-divide
17812 Do not generate inline code for divides of floating-point values.
17814 @item -minline-int-divide-min-latency
17815 @opindex minline-int-divide-min-latency
17816 Generate code for inline divides of integer values
17817 using the minimum latency algorithm.
17819 @item -minline-int-divide-max-throughput
17820 @opindex minline-int-divide-max-throughput
17821 Generate code for inline divides of integer values
17822 using the maximum throughput algorithm.
17824 @item -mno-inline-int-divide
17825 @opindex mno-inline-int-divide
17826 Do not generate inline code for divides of integer values.
17828 @item -minline-sqrt-min-latency
17829 @opindex minline-sqrt-min-latency
17830 Generate code for inline square roots
17831 using the minimum latency algorithm.
17833 @item -minline-sqrt-max-throughput
17834 @opindex minline-sqrt-max-throughput
17835 Generate code for inline square roots
17836 using the maximum throughput algorithm.
17838 @item -mno-inline-sqrt
17839 @opindex mno-inline-sqrt
17840 Do not generate inline code for @code{sqrt}.
17842 @item -mfused-madd
17843 @itemx -mno-fused-madd
17844 @opindex mfused-madd
17845 @opindex mno-fused-madd
17846 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
17847 instructions.  The default is to use these instructions.
17849 @item -mno-dwarf2-asm
17850 @itemx -mdwarf2-asm
17851 @opindex mno-dwarf2-asm
17852 @opindex mdwarf2-asm
17853 Don't (or do) generate assembler code for the DWARF line number debugging
17854 info.  This may be useful when not using the GNU assembler.
17856 @item -mearly-stop-bits
17857 @itemx -mno-early-stop-bits
17858 @opindex mearly-stop-bits
17859 @opindex mno-early-stop-bits
17860 Allow stop bits to be placed earlier than immediately preceding the
17861 instruction that triggered the stop bit.  This can improve instruction
17862 scheduling, but does not always do so.
17864 @item -mfixed-range=@var{register-range}
17865 @opindex mfixed-range
17866 Generate code treating the given register range as fixed registers.
17867 A fixed register is one that the register allocator cannot use.  This is
17868 useful when compiling kernel code.  A register range is specified as
17869 two registers separated by a dash.  Multiple register ranges can be
17870 specified separated by a comma.
17872 @item -mtls-size=@var{tls-size}
17873 @opindex mtls-size
17874 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
17877 @item -mtune=@var{cpu-type}
17878 @opindex mtune
17879 Tune the instruction scheduling for a particular CPU, Valid values are
17880 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
17881 and @samp{mckinley}.
17883 @item -milp32
17884 @itemx -mlp64
17885 @opindex milp32
17886 @opindex mlp64
17887 Generate code for a 32-bit or 64-bit environment.
17888 The 32-bit environment sets int, long and pointer to 32 bits.
17889 The 64-bit environment sets int to 32 bits and long and pointer
17890 to 64 bits.  These are HP-UX specific flags.
17892 @item -mno-sched-br-data-spec
17893 @itemx -msched-br-data-spec
17894 @opindex mno-sched-br-data-spec
17895 @opindex msched-br-data-spec
17896 (Dis/En)able data speculative scheduling before reload.
17897 This results in generation of @code{ld.a} instructions and
17898 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
17899 The default setting is disabled.
17901 @item -msched-ar-data-spec
17902 @itemx -mno-sched-ar-data-spec
17903 @opindex msched-ar-data-spec
17904 @opindex mno-sched-ar-data-spec
17905 (En/Dis)able data speculative scheduling after reload.
17906 This results in generation of @code{ld.a} instructions and
17907 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
17908 The default setting is enabled.
17910 @item -mno-sched-control-spec
17911 @itemx -msched-control-spec
17912 @opindex mno-sched-control-spec
17913 @opindex msched-control-spec
17914 (Dis/En)able control speculative scheduling.  This feature is
17915 available only during region scheduling (i.e.@: before reload).
17916 This results in generation of the @code{ld.s} instructions and
17917 the corresponding check instructions @code{chk.s}.
17918 The default setting is disabled.
17920 @item -msched-br-in-data-spec
17921 @itemx -mno-sched-br-in-data-spec
17922 @opindex msched-br-in-data-spec
17923 @opindex mno-sched-br-in-data-spec
17924 (En/Dis)able speculative scheduling of the instructions that
17925 are dependent on the data speculative loads before reload.
17926 This is effective only with @option{-msched-br-data-spec} enabled.
17927 The default setting is enabled.
17929 @item -msched-ar-in-data-spec
17930 @itemx -mno-sched-ar-in-data-spec
17931 @opindex msched-ar-in-data-spec
17932 @opindex mno-sched-ar-in-data-spec
17933 (En/Dis)able speculative scheduling of the instructions that
17934 are dependent on the data speculative loads after reload.
17935 This is effective only with @option{-msched-ar-data-spec} enabled.
17936 The default setting is enabled.
17938 @item -msched-in-control-spec
17939 @itemx -mno-sched-in-control-spec
17940 @opindex msched-in-control-spec
17941 @opindex mno-sched-in-control-spec
17942 (En/Dis)able speculative scheduling of the instructions that
17943 are dependent on the control speculative loads.
17944 This is effective only with @option{-msched-control-spec} enabled.
17945 The default setting is enabled.
17947 @item -mno-sched-prefer-non-data-spec-insns
17948 @itemx -msched-prefer-non-data-spec-insns
17949 @opindex mno-sched-prefer-non-data-spec-insns
17950 @opindex msched-prefer-non-data-spec-insns
17951 If enabled, data-speculative instructions are chosen for schedule
17952 only if there are no other choices at the moment.  This makes
17953 the use of the data speculation much more conservative.
17954 The default setting is disabled.
17956 @item -mno-sched-prefer-non-control-spec-insns
17957 @itemx -msched-prefer-non-control-spec-insns
17958 @opindex mno-sched-prefer-non-control-spec-insns
17959 @opindex msched-prefer-non-control-spec-insns
17960 If enabled, control-speculative instructions are chosen for schedule
17961 only if there are no other choices at the moment.  This makes
17962 the use of the control speculation much more conservative.
17963 The default setting is disabled.
17965 @item -mno-sched-count-spec-in-critical-path
17966 @itemx -msched-count-spec-in-critical-path
17967 @opindex mno-sched-count-spec-in-critical-path
17968 @opindex msched-count-spec-in-critical-path
17969 If enabled, speculative dependencies are considered during
17970 computation of the instructions priorities.  This makes the use of the
17971 speculation a bit more conservative.
17972 The default setting is disabled.
17974 @item -msched-spec-ldc
17975 @opindex msched-spec-ldc
17976 Use a simple data speculation check.  This option is on by default.
17978 @item -msched-control-spec-ldc
17979 @opindex msched-spec-ldc
17980 Use a simple check for control speculation.  This option is on by default.
17982 @item -msched-stop-bits-after-every-cycle
17983 @opindex msched-stop-bits-after-every-cycle
17984 Place a stop bit after every cycle when scheduling.  This option is on
17985 by default.
17987 @item -msched-fp-mem-deps-zero-cost
17988 @opindex msched-fp-mem-deps-zero-cost
17989 Assume that floating-point stores and loads are not likely to cause a conflict
17990 when placed into the same instruction group.  This option is disabled by
17991 default.
17993 @item -msel-sched-dont-check-control-spec
17994 @opindex msel-sched-dont-check-control-spec
17995 Generate checks for control speculation in selective scheduling.
17996 This flag is disabled by default.
17998 @item -msched-max-memory-insns=@var{max-insns}
17999 @opindex msched-max-memory-insns
18000 Limit on the number of memory insns per instruction group, giving lower
18001 priority to subsequent memory insns attempting to schedule in the same
18002 instruction group. Frequently useful to prevent cache bank conflicts.
18003 The default value is 1.
18005 @item -msched-max-memory-insns-hard-limit
18006 @opindex msched-max-memory-insns-hard-limit
18007 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
18008 disallowing more than that number in an instruction group.
18009 Otherwise, the limit is ``soft'', meaning that non-memory operations
18010 are preferred when the limit is reached, but memory operations may still
18011 be scheduled.
18013 @end table
18015 @node LM32 Options
18016 @subsection LM32 Options
18017 @cindex LM32 options
18019 These @option{-m} options are defined for the LatticeMico32 architecture:
18021 @table @gcctabopt
18022 @item -mbarrel-shift-enabled
18023 @opindex mbarrel-shift-enabled
18024 Enable barrel-shift instructions.
18026 @item -mdivide-enabled
18027 @opindex mdivide-enabled
18028 Enable divide and modulus instructions.
18030 @item -mmultiply-enabled
18031 @opindex multiply-enabled
18032 Enable multiply instructions.
18034 @item -msign-extend-enabled
18035 @opindex msign-extend-enabled
18036 Enable sign extend instructions.
18038 @item -muser-enabled
18039 @opindex muser-enabled
18040 Enable user-defined instructions.
18042 @end table
18044 @node M32C Options
18045 @subsection M32C Options
18046 @cindex M32C options
18048 @table @gcctabopt
18049 @item -mcpu=@var{name}
18050 @opindex mcpu=
18051 Select the CPU for which code is generated.  @var{name} may be one of
18052 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
18053 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
18054 the M32C/80 series.
18056 @item -msim
18057 @opindex msim
18058 Specifies that the program will be run on the simulator.  This causes
18059 an alternate runtime library to be linked in which supports, for
18060 example, file I/O@.  You must not use this option when generating
18061 programs that will run on real hardware; you must provide your own
18062 runtime library for whatever I/O functions are needed.
18064 @item -memregs=@var{number}
18065 @opindex memregs=
18066 Specifies the number of memory-based pseudo-registers GCC uses
18067 during code generation.  These pseudo-registers are used like real
18068 registers, so there is a tradeoff between GCC's ability to fit the
18069 code into available registers, and the performance penalty of using
18070 memory instead of registers.  Note that all modules in a program must
18071 be compiled with the same value for this option.  Because of that, you
18072 must not use this option with GCC's default runtime libraries.
18074 @end table
18076 @node M32R/D Options
18077 @subsection M32R/D Options
18078 @cindex M32R/D options
18080 These @option{-m} options are defined for Renesas M32R/D architectures:
18082 @table @gcctabopt
18083 @item -m32r2
18084 @opindex m32r2
18085 Generate code for the M32R/2@.
18087 @item -m32rx
18088 @opindex m32rx
18089 Generate code for the M32R/X@.
18091 @item -m32r
18092 @opindex m32r
18093 Generate code for the M32R@.  This is the default.
18095 @item -mmodel=small
18096 @opindex mmodel=small
18097 Assume all objects live in the lower 16MB of memory (so that their addresses
18098 can be loaded with the @code{ld24} instruction), and assume all subroutines
18099 are reachable with the @code{bl} instruction.
18100 This is the default.
18102 The addressability of a particular object can be set with the
18103 @code{model} attribute.
18105 @item -mmodel=medium
18106 @opindex mmodel=medium
18107 Assume objects may be anywhere in the 32-bit address space (the compiler
18108 generates @code{seth/add3} instructions to load their addresses), and
18109 assume all subroutines are reachable with the @code{bl} instruction.
18111 @item -mmodel=large
18112 @opindex mmodel=large
18113 Assume objects may be anywhere in the 32-bit address space (the compiler
18114 generates @code{seth/add3} instructions to load their addresses), and
18115 assume subroutines may not be reachable with the @code{bl} instruction
18116 (the compiler generates the much slower @code{seth/add3/jl}
18117 instruction sequence).
18119 @item -msdata=none
18120 @opindex msdata=none
18121 Disable use of the small data area.  Variables are put into
18122 one of @code{.data}, @code{.bss}, or @code{.rodata} (unless the
18123 @code{section} attribute has been specified).
18124 This is the default.
18126 The small data area consists of sections @code{.sdata} and @code{.sbss}.
18127 Objects may be explicitly put in the small data area with the
18128 @code{section} attribute using one of these sections.
18130 @item -msdata=sdata
18131 @opindex msdata=sdata
18132 Put small global and static data in the small data area, but do not
18133 generate special code to reference them.
18135 @item -msdata=use
18136 @opindex msdata=use
18137 Put small global and static data in the small data area, and generate
18138 special instructions to reference them.
18140 @item -G @var{num}
18141 @opindex G
18142 @cindex smaller data references
18143 Put global and static objects less than or equal to @var{num} bytes
18144 into the small data or BSS sections instead of the normal data or BSS
18145 sections.  The default value of @var{num} is 8.
18146 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
18147 for this option to have any effect.
18149 All modules should be compiled with the same @option{-G @var{num}} value.
18150 Compiling with different values of @var{num} may or may not work; if it
18151 doesn't the linker gives an error message---incorrect code is not
18152 generated.
18154 @item -mdebug
18155 @opindex mdebug
18156 Makes the M32R-specific code in the compiler display some statistics
18157 that might help in debugging programs.
18159 @item -malign-loops
18160 @opindex malign-loops
18161 Align all loops to a 32-byte boundary.
18163 @item -mno-align-loops
18164 @opindex mno-align-loops
18165 Do not enforce a 32-byte alignment for loops.  This is the default.
18167 @item -missue-rate=@var{number}
18168 @opindex missue-rate=@var{number}
18169 Issue @var{number} instructions per cycle.  @var{number} can only be 1
18170 or 2.
18172 @item -mbranch-cost=@var{number}
18173 @opindex mbranch-cost=@var{number}
18174 @var{number} can only be 1 or 2.  If it is 1 then branches are
18175 preferred over conditional code, if it is 2, then the opposite applies.
18177 @item -mflush-trap=@var{number}
18178 @opindex mflush-trap=@var{number}
18179 Specifies the trap number to use to flush the cache.  The default is
18180 12.  Valid numbers are between 0 and 15 inclusive.
18182 @item -mno-flush-trap
18183 @opindex mno-flush-trap
18184 Specifies that the cache cannot be flushed by using a trap.
18186 @item -mflush-func=@var{name}
18187 @opindex mflush-func=@var{name}
18188 Specifies the name of the operating system function to call to flush
18189 the cache.  The default is @samp{_flush_cache}, but a function call
18190 is only used if a trap is not available.
18192 @item -mno-flush-func
18193 @opindex mno-flush-func
18194 Indicates that there is no OS function for flushing the cache.
18196 @end table
18198 @node M680x0 Options
18199 @subsection M680x0 Options
18200 @cindex M680x0 options
18202 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
18203 The default settings depend on which architecture was selected when
18204 the compiler was configured; the defaults for the most common choices
18205 are given below.
18207 @table @gcctabopt
18208 @item -march=@var{arch}
18209 @opindex march
18210 Generate code for a specific M680x0 or ColdFire instruction set
18211 architecture.  Permissible values of @var{arch} for M680x0
18212 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
18213 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
18214 architectures are selected according to Freescale's ISA classification
18215 and the permissible values are: @samp{isaa}, @samp{isaaplus},
18216 @samp{isab} and @samp{isac}.
18218 GCC defines a macro @code{__mcf@var{arch}__} whenever it is generating
18219 code for a ColdFire target.  The @var{arch} in this macro is one of the
18220 @option{-march} arguments given above.
18222 When used together, @option{-march} and @option{-mtune} select code
18223 that runs on a family of similar processors but that is optimized
18224 for a particular microarchitecture.
18226 @item -mcpu=@var{cpu}
18227 @opindex mcpu
18228 Generate code for a specific M680x0 or ColdFire processor.
18229 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
18230 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
18231 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
18232 below, which also classifies the CPUs into families:
18234 @multitable @columnfractions 0.20 0.80
18235 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
18236 @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}
18237 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
18238 @item @samp{5206e} @tab @samp{5206e}
18239 @item @samp{5208} @tab @samp{5207} @samp{5208}
18240 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
18241 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
18242 @item @samp{5216} @tab @samp{5214} @samp{5216}
18243 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
18244 @item @samp{5225} @tab @samp{5224} @samp{5225}
18245 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
18246 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
18247 @item @samp{5249} @tab @samp{5249}
18248 @item @samp{5250} @tab @samp{5250}
18249 @item @samp{5271} @tab @samp{5270} @samp{5271}
18250 @item @samp{5272} @tab @samp{5272}
18251 @item @samp{5275} @tab @samp{5274} @samp{5275}
18252 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
18253 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
18254 @item @samp{5307} @tab @samp{5307}
18255 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
18256 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
18257 @item @samp{5407} @tab @samp{5407}
18258 @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}
18259 @end multitable
18261 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
18262 @var{arch} is compatible with @var{cpu}.  Other combinations of
18263 @option{-mcpu} and @option{-march} are rejected.
18265 GCC defines the macro @code{__mcf_cpu_@var{cpu}} when ColdFire target
18266 @var{cpu} is selected.  It also defines @code{__mcf_family_@var{family}},
18267 where the value of @var{family} is given by the table above.
18269 @item -mtune=@var{tune}
18270 @opindex mtune
18271 Tune the code for a particular microarchitecture within the
18272 constraints set by @option{-march} and @option{-mcpu}.
18273 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
18274 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
18275 and @samp{cpu32}.  The ColdFire microarchitectures
18276 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
18278 You can also use @option{-mtune=68020-40} for code that needs
18279 to run relatively well on 68020, 68030 and 68040 targets.
18280 @option{-mtune=68020-60} is similar but includes 68060 targets
18281 as well.  These two options select the same tuning decisions as
18282 @option{-m68020-40} and @option{-m68020-60} respectively.
18284 GCC defines the macros @code{__mc@var{arch}} and @code{__mc@var{arch}__}
18285 when tuning for 680x0 architecture @var{arch}.  It also defines
18286 @code{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
18287 option is used.  If GCC is tuning for a range of architectures,
18288 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
18289 it defines the macros for every architecture in the range.
18291 GCC also defines the macro @code{__m@var{uarch}__} when tuning for
18292 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
18293 of the arguments given above.
18295 @item -m68000
18296 @itemx -mc68000
18297 @opindex m68000
18298 @opindex mc68000
18299 Generate output for a 68000.  This is the default
18300 when the compiler is configured for 68000-based systems.
18301 It is equivalent to @option{-march=68000}.
18303 Use this option for microcontrollers with a 68000 or EC000 core,
18304 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
18306 @item -m68010
18307 @opindex m68010
18308 Generate output for a 68010.  This is the default
18309 when the compiler is configured for 68010-based systems.
18310 It is equivalent to @option{-march=68010}.
18312 @item -m68020
18313 @itemx -mc68020
18314 @opindex m68020
18315 @opindex mc68020
18316 Generate output for a 68020.  This is the default
18317 when the compiler is configured for 68020-based systems.
18318 It is equivalent to @option{-march=68020}.
18320 @item -m68030
18321 @opindex m68030
18322 Generate output for a 68030.  This is the default when the compiler is
18323 configured for 68030-based systems.  It is equivalent to
18324 @option{-march=68030}.
18326 @item -m68040
18327 @opindex m68040
18328 Generate output for a 68040.  This is the default when the compiler is
18329 configured for 68040-based systems.  It is equivalent to
18330 @option{-march=68040}.
18332 This option inhibits the use of 68881/68882 instructions that have to be
18333 emulated by software on the 68040.  Use this option if your 68040 does not
18334 have code to emulate those instructions.
18336 @item -m68060
18337 @opindex m68060
18338 Generate output for a 68060.  This is the default when the compiler is
18339 configured for 68060-based systems.  It is equivalent to
18340 @option{-march=68060}.
18342 This option inhibits the use of 68020 and 68881/68882 instructions that
18343 have to be emulated by software on the 68060.  Use this option if your 68060
18344 does not have code to emulate those instructions.
18346 @item -mcpu32
18347 @opindex mcpu32
18348 Generate output for a CPU32.  This is the default
18349 when the compiler is configured for CPU32-based systems.
18350 It is equivalent to @option{-march=cpu32}.
18352 Use this option for microcontrollers with a
18353 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
18354 68336, 68340, 68341, 68349 and 68360.
18356 @item -m5200
18357 @opindex m5200
18358 Generate output for a 520X ColdFire CPU@.  This is the default
18359 when the compiler is configured for 520X-based systems.
18360 It is equivalent to @option{-mcpu=5206}, and is now deprecated
18361 in favor of that option.
18363 Use this option for microcontroller with a 5200 core, including
18364 the MCF5202, MCF5203, MCF5204 and MCF5206.
18366 @item -m5206e
18367 @opindex m5206e
18368 Generate output for a 5206e ColdFire CPU@.  The option is now
18369 deprecated in favor of the equivalent @option{-mcpu=5206e}.
18371 @item -m528x
18372 @opindex m528x
18373 Generate output for a member of the ColdFire 528X family.
18374 The option is now deprecated in favor of the equivalent
18375 @option{-mcpu=528x}.
18377 @item -m5307
18378 @opindex m5307
18379 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
18380 in favor of the equivalent @option{-mcpu=5307}.
18382 @item -m5407
18383 @opindex m5407
18384 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
18385 in favor of the equivalent @option{-mcpu=5407}.
18387 @item -mcfv4e
18388 @opindex mcfv4e
18389 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
18390 This includes use of hardware floating-point instructions.
18391 The option is equivalent to @option{-mcpu=547x}, and is now
18392 deprecated in favor of that option.
18394 @item -m68020-40
18395 @opindex m68020-40
18396 Generate output for a 68040, without using any of the new instructions.
18397 This results in code that can run relatively efficiently on either a
18398 68020/68881 or a 68030 or a 68040.  The generated code does use the
18399 68881 instructions that are emulated on the 68040.
18401 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
18403 @item -m68020-60
18404 @opindex m68020-60
18405 Generate output for a 68060, without using any of the new instructions.
18406 This results in code that can run relatively efficiently on either a
18407 68020/68881 or a 68030 or a 68040.  The generated code does use the
18408 68881 instructions that are emulated on the 68060.
18410 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
18412 @item -mhard-float
18413 @itemx -m68881
18414 @opindex mhard-float
18415 @opindex m68881
18416 Generate floating-point instructions.  This is the default for 68020
18417 and above, and for ColdFire devices that have an FPU@.  It defines the
18418 macro @code{__HAVE_68881__} on M680x0 targets and @code{__mcffpu__}
18419 on ColdFire targets.
18421 @item -msoft-float
18422 @opindex msoft-float
18423 Do not generate floating-point instructions; use library calls instead.
18424 This is the default for 68000, 68010, and 68832 targets.  It is also
18425 the default for ColdFire devices that have no FPU.
18427 @item -mdiv
18428 @itemx -mno-div
18429 @opindex mdiv
18430 @opindex mno-div
18431 Generate (do not generate) ColdFire hardware divide and remainder
18432 instructions.  If @option{-march} is used without @option{-mcpu},
18433 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
18434 architectures.  Otherwise, the default is taken from the target CPU
18435 (either the default CPU, or the one specified by @option{-mcpu}).  For
18436 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
18437 @option{-mcpu=5206e}.
18439 GCC defines the macro @code{__mcfhwdiv__} when this option is enabled.
18441 @item -mshort
18442 @opindex mshort
18443 Consider type @code{int} to be 16 bits wide, like @code{short int}.
18444 Additionally, parameters passed on the stack are also aligned to a
18445 16-bit boundary even on targets whose API mandates promotion to 32-bit.
18447 @item -mno-short
18448 @opindex mno-short
18449 Do not consider type @code{int} to be 16 bits wide.  This is the default.
18451 @item -mnobitfield
18452 @itemx -mno-bitfield
18453 @opindex mnobitfield
18454 @opindex mno-bitfield
18455 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
18456 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
18458 @item -mbitfield
18459 @opindex mbitfield
18460 Do use the bit-field instructions.  The @option{-m68020} option implies
18461 @option{-mbitfield}.  This is the default if you use a configuration
18462 designed for a 68020.
18464 @item -mrtd
18465 @opindex mrtd
18466 Use a different function-calling convention, in which functions
18467 that take a fixed number of arguments return with the @code{rtd}
18468 instruction, which pops their arguments while returning.  This
18469 saves one instruction in the caller since there is no need to pop
18470 the arguments there.
18472 This calling convention is incompatible with the one normally
18473 used on Unix, so you cannot use it if you need to call libraries
18474 compiled with the Unix compiler.
18476 Also, you must provide function prototypes for all functions that
18477 take variable numbers of arguments (including @code{printf});
18478 otherwise incorrect code is generated for calls to those
18479 functions.
18481 In addition, seriously incorrect code results if you call a
18482 function with too many arguments.  (Normally, extra arguments are
18483 harmlessly ignored.)
18485 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
18486 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
18488 @item -mno-rtd
18489 @opindex mno-rtd
18490 Do not use the calling conventions selected by @option{-mrtd}.
18491 This is the default.
18493 @item -malign-int
18494 @itemx -mno-align-int
18495 @opindex malign-int
18496 @opindex mno-align-int
18497 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
18498 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
18499 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
18500 Aligning variables on 32-bit boundaries produces code that runs somewhat
18501 faster on processors with 32-bit busses at the expense of more memory.
18503 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
18504 aligns structures containing the above types differently than
18505 most published application binary interface specifications for the m68k.
18507 @item -mpcrel
18508 @opindex mpcrel
18509 Use the pc-relative addressing mode of the 68000 directly, instead of
18510 using a global offset table.  At present, this option implies @option{-fpic},
18511 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
18512 not presently supported with @option{-mpcrel}, though this could be supported for
18513 68020 and higher processors.
18515 @item -mno-strict-align
18516 @itemx -mstrict-align
18517 @opindex mno-strict-align
18518 @opindex mstrict-align
18519 Do not (do) assume that unaligned memory references are handled by
18520 the system.
18522 @item -msep-data
18523 Generate code that allows the data segment to be located in a different
18524 area of memory from the text segment.  This allows for execute-in-place in
18525 an environment without virtual memory management.  This option implies
18526 @option{-fPIC}.
18528 @item -mno-sep-data
18529 Generate code that assumes that the data segment follows the text segment.
18530 This is the default.
18532 @item -mid-shared-library
18533 Generate code that supports shared libraries via the library ID method.
18534 This allows for execute-in-place and shared libraries in an environment
18535 without virtual memory management.  This option implies @option{-fPIC}.
18537 @item -mno-id-shared-library
18538 Generate code that doesn't assume ID-based shared libraries are being used.
18539 This is the default.
18541 @item -mshared-library-id=n
18542 Specifies the identification number of the ID-based shared library being
18543 compiled.  Specifying a value of 0 generates more compact code; specifying
18544 other values forces the allocation of that number to the current
18545 library, but is no more space- or time-efficient than omitting this option.
18547 @item -mxgot
18548 @itemx -mno-xgot
18549 @opindex mxgot
18550 @opindex mno-xgot
18551 When generating position-independent code for ColdFire, generate code
18552 that works if the GOT has more than 8192 entries.  This code is
18553 larger and slower than code generated without this option.  On M680x0
18554 processors, this option is not needed; @option{-fPIC} suffices.
18556 GCC normally uses a single instruction to load values from the GOT@.
18557 While this is relatively efficient, it only works if the GOT
18558 is smaller than about 64k.  Anything larger causes the linker
18559 to report an error such as:
18561 @cindex relocation truncated to fit (ColdFire)
18562 @smallexample
18563 relocation truncated to fit: R_68K_GOT16O foobar
18564 @end smallexample
18566 If this happens, you should recompile your code with @option{-mxgot}.
18567 It should then work with very large GOTs.  However, code generated with
18568 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
18569 the value of a global symbol.
18571 Note that some linkers, including newer versions of the GNU linker,
18572 can create multiple GOTs and sort GOT entries.  If you have such a linker,
18573 you should only need to use @option{-mxgot} when compiling a single
18574 object file that accesses more than 8192 GOT entries.  Very few do.
18576 These options have no effect unless GCC is generating
18577 position-independent code.
18579 @item -mlong-jump-table-offsets
18580 @opindex mlong-jump-table-offsets
18581 Use 32-bit offsets in @code{switch} tables.  The default is to use
18582 16-bit offsets.
18584 @end table
18586 @node MCore Options
18587 @subsection MCore Options
18588 @cindex MCore options
18590 These are the @samp{-m} options defined for the Motorola M*Core
18591 processors.
18593 @table @gcctabopt
18595 @item -mhardlit
18596 @itemx -mno-hardlit
18597 @opindex mhardlit
18598 @opindex mno-hardlit
18599 Inline constants into the code stream if it can be done in two
18600 instructions or less.
18602 @item -mdiv
18603 @itemx -mno-div
18604 @opindex mdiv
18605 @opindex mno-div
18606 Use the divide instruction.  (Enabled by default).
18608 @item -mrelax-immediate
18609 @itemx -mno-relax-immediate
18610 @opindex mrelax-immediate
18611 @opindex mno-relax-immediate
18612 Allow arbitrary-sized immediates in bit operations.
18614 @item -mwide-bitfields
18615 @itemx -mno-wide-bitfields
18616 @opindex mwide-bitfields
18617 @opindex mno-wide-bitfields
18618 Always treat bit-fields as @code{int}-sized.
18620 @item -m4byte-functions
18621 @itemx -mno-4byte-functions
18622 @opindex m4byte-functions
18623 @opindex mno-4byte-functions
18624 Force all functions to be aligned to a 4-byte boundary.
18626 @item -mcallgraph-data
18627 @itemx -mno-callgraph-data
18628 @opindex mcallgraph-data
18629 @opindex mno-callgraph-data
18630 Emit callgraph information.
18632 @item -mslow-bytes
18633 @itemx -mno-slow-bytes
18634 @opindex mslow-bytes
18635 @opindex mno-slow-bytes
18636 Prefer word access when reading byte quantities.
18638 @item -mlittle-endian
18639 @itemx -mbig-endian
18640 @opindex mlittle-endian
18641 @opindex mbig-endian
18642 Generate code for a little-endian target.
18644 @item -m210
18645 @itemx -m340
18646 @opindex m210
18647 @opindex m340
18648 Generate code for the 210 processor.
18650 @item -mno-lsim
18651 @opindex mno-lsim
18652 Assume that runtime support has been provided and so omit the
18653 simulator library (@file{libsim.a)} from the linker command line.
18655 @item -mstack-increment=@var{size}
18656 @opindex mstack-increment
18657 Set the maximum amount for a single stack increment operation.  Large
18658 values can increase the speed of programs that contain functions
18659 that need a large amount of stack space, but they can also trigger a
18660 segmentation fault if the stack is extended too much.  The default
18661 value is 0x1000.
18663 @end table
18665 @node MeP Options
18666 @subsection MeP Options
18667 @cindex MeP options
18669 @table @gcctabopt
18671 @item -mabsdiff
18672 @opindex mabsdiff
18673 Enables the @code{abs} instruction, which is the absolute difference
18674 between two registers.
18676 @item -mall-opts
18677 @opindex mall-opts
18678 Enables all the optional instructions---average, multiply, divide, bit
18679 operations, leading zero, absolute difference, min/max, clip, and
18680 saturation.
18683 @item -maverage
18684 @opindex maverage
18685 Enables the @code{ave} instruction, which computes the average of two
18686 registers.
18688 @item -mbased=@var{n}
18689 @opindex mbased=
18690 Variables of size @var{n} bytes or smaller are placed in the
18691 @code{.based} section by default.  Based variables use the @code{$tp}
18692 register as a base register, and there is a 128-byte limit to the
18693 @code{.based} section.
18695 @item -mbitops
18696 @opindex mbitops
18697 Enables the bit operation instructions---bit test (@code{btstm}), set
18698 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
18699 test-and-set (@code{tas}).
18701 @item -mc=@var{name}
18702 @opindex mc=
18703 Selects which section constant data is placed in.  @var{name} may
18704 be @samp{tiny}, @samp{near}, or @samp{far}.
18706 @item -mclip
18707 @opindex mclip
18708 Enables the @code{clip} instruction.  Note that @option{-mclip} is not
18709 useful unless you also provide @option{-mminmax}.
18711 @item -mconfig=@var{name}
18712 @opindex mconfig=
18713 Selects one of the built-in core configurations.  Each MeP chip has
18714 one or more modules in it; each module has a core CPU and a variety of
18715 coprocessors, optional instructions, and peripherals.  The
18716 @code{MeP-Integrator} tool, not part of GCC, provides these
18717 configurations through this option; using this option is the same as
18718 using all the corresponding command-line options.  The default
18719 configuration is @samp{default}.
18721 @item -mcop
18722 @opindex mcop
18723 Enables the coprocessor instructions.  By default, this is a 32-bit
18724 coprocessor.  Note that the coprocessor is normally enabled via the
18725 @option{-mconfig=} option.
18727 @item -mcop32
18728 @opindex mcop32
18729 Enables the 32-bit coprocessor's instructions.
18731 @item -mcop64
18732 @opindex mcop64
18733 Enables the 64-bit coprocessor's instructions.
18735 @item -mivc2
18736 @opindex mivc2
18737 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
18739 @item -mdc
18740 @opindex mdc
18741 Causes constant variables to be placed in the @code{.near} section.
18743 @item -mdiv
18744 @opindex mdiv
18745 Enables the @code{div} and @code{divu} instructions.
18747 @item -meb
18748 @opindex meb
18749 Generate big-endian code.
18751 @item -mel
18752 @opindex mel
18753 Generate little-endian code.
18755 @item -mio-volatile
18756 @opindex mio-volatile
18757 Tells the compiler that any variable marked with the @code{io}
18758 attribute is to be considered volatile.
18760 @item -ml
18761 @opindex ml
18762 Causes variables to be assigned to the @code{.far} section by default.
18764 @item -mleadz
18765 @opindex mleadz
18766 Enables the @code{leadz} (leading zero) instruction.
18768 @item -mm
18769 @opindex mm
18770 Causes variables to be assigned to the @code{.near} section by default.
18772 @item -mminmax
18773 @opindex mminmax
18774 Enables the @code{min} and @code{max} instructions.
18776 @item -mmult
18777 @opindex mmult
18778 Enables the multiplication and multiply-accumulate instructions.
18780 @item -mno-opts
18781 @opindex mno-opts
18782 Disables all the optional instructions enabled by @option{-mall-opts}.
18784 @item -mrepeat
18785 @opindex mrepeat
18786 Enables the @code{repeat} and @code{erepeat} instructions, used for
18787 low-overhead looping.
18789 @item -ms
18790 @opindex ms
18791 Causes all variables to default to the @code{.tiny} section.  Note
18792 that there is a 65536-byte limit to this section.  Accesses to these
18793 variables use the @code{%gp} base register.
18795 @item -msatur
18796 @opindex msatur
18797 Enables the saturation instructions.  Note that the compiler does not
18798 currently generate these itself, but this option is included for
18799 compatibility with other tools, like @code{as}.
18801 @item -msdram
18802 @opindex msdram
18803 Link the SDRAM-based runtime instead of the default ROM-based runtime.
18805 @item -msim
18806 @opindex msim
18807 Link the simulator run-time libraries.
18809 @item -msimnovec
18810 @opindex msimnovec
18811 Link the simulator runtime libraries, excluding built-in support
18812 for reset and exception vectors and tables.
18814 @item -mtf
18815 @opindex mtf
18816 Causes all functions to default to the @code{.far} section.  Without
18817 this option, functions default to the @code{.near} section.
18819 @item -mtiny=@var{n}
18820 @opindex mtiny=
18821 Variables that are @var{n} bytes or smaller are allocated to the
18822 @code{.tiny} section.  These variables use the @code{$gp} base
18823 register.  The default for this option is 4, but note that there's a
18824 65536-byte limit to the @code{.tiny} section.
18826 @end table
18828 @node MicroBlaze Options
18829 @subsection MicroBlaze Options
18830 @cindex MicroBlaze Options
18832 @table @gcctabopt
18834 @item -msoft-float
18835 @opindex msoft-float
18836 Use software emulation for floating point (default).
18838 @item -mhard-float
18839 @opindex mhard-float
18840 Use hardware floating-point instructions.
18842 @item -mmemcpy
18843 @opindex mmemcpy
18844 Do not optimize block moves, use @code{memcpy}.
18846 @item -mno-clearbss
18847 @opindex mno-clearbss
18848 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
18850 @item -mcpu=@var{cpu-type}
18851 @opindex mcpu=
18852 Use features of, and schedule code for, the given CPU.
18853 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
18854 where @var{X} is a major version, @var{YY} is the minor version, and
18855 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
18856 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
18858 @item -mxl-soft-mul
18859 @opindex mxl-soft-mul
18860 Use software multiply emulation (default).
18862 @item -mxl-soft-div
18863 @opindex mxl-soft-div
18864 Use software emulation for divides (default).
18866 @item -mxl-barrel-shift
18867 @opindex mxl-barrel-shift
18868 Use the hardware barrel shifter.
18870 @item -mxl-pattern-compare
18871 @opindex mxl-pattern-compare
18872 Use pattern compare instructions.
18874 @item -msmall-divides
18875 @opindex msmall-divides
18876 Use table lookup optimization for small signed integer divisions.
18878 @item -mxl-stack-check
18879 @opindex mxl-stack-check
18880 This option is deprecated.  Use @option{-fstack-check} instead.
18882 @item -mxl-gp-opt
18883 @opindex mxl-gp-opt
18884 Use GP-relative @code{.sdata}/@code{.sbss} sections.
18886 @item -mxl-multiply-high
18887 @opindex mxl-multiply-high
18888 Use multiply high instructions for high part of 32x32 multiply.
18890 @item -mxl-float-convert
18891 @opindex mxl-float-convert
18892 Use hardware floating-point conversion instructions.
18894 @item -mxl-float-sqrt
18895 @opindex mxl-float-sqrt
18896 Use hardware floating-point square root instruction.
18898 @item -mbig-endian
18899 @opindex mbig-endian
18900 Generate code for a big-endian target.
18902 @item -mlittle-endian
18903 @opindex mlittle-endian
18904 Generate code for a little-endian target.
18906 @item -mxl-reorder
18907 @opindex mxl-reorder
18908 Use reorder instructions (swap and byte reversed load/store).
18910 @item -mxl-mode-@var{app-model}
18911 Select application model @var{app-model}.  Valid models are
18912 @table @samp
18913 @item executable
18914 normal executable (default), uses startup code @file{crt0.o}.
18916 @item xmdstub
18917 for use with Xilinx Microprocessor Debugger (XMD) based
18918 software intrusive debug agent called xmdstub. This uses startup file
18919 @file{crt1.o} and sets the start address of the program to 0x800.
18921 @item bootstrap
18922 for applications that are loaded using a bootloader.
18923 This model uses startup file @file{crt2.o} which does not contain a processor
18924 reset vector handler. This is suitable for transferring control on a
18925 processor reset to the bootloader rather than the application.
18927 @item novectors
18928 for applications that do not require any of the
18929 MicroBlaze vectors. This option may be useful for applications running
18930 within a monitoring application. This model uses @file{crt3.o} as a startup file.
18931 @end table
18933 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
18934 @option{-mxl-mode-@var{app-model}}.
18936 @end table
18938 @node MIPS Options
18939 @subsection MIPS Options
18940 @cindex MIPS options
18942 @table @gcctabopt
18944 @item -EB
18945 @opindex EB
18946 Generate big-endian code.
18948 @item -EL
18949 @opindex EL
18950 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
18951 configurations.
18953 @item -march=@var{arch}
18954 @opindex march
18955 Generate code that runs on @var{arch}, which can be the name of a
18956 generic MIPS ISA, or the name of a particular processor.
18957 The ISA names are:
18958 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
18959 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5},
18960 @samp{mips32r6}, @samp{mips64}, @samp{mips64r2}, @samp{mips64r3},
18961 @samp{mips64r5} and @samp{mips64r6}.
18962 The processor names are:
18963 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
18964 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
18965 @samp{5kc}, @samp{5kf},
18966 @samp{20kc},
18967 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
18968 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
18969 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
18970 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
18971 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
18972 @samp{i6400},
18973 @samp{interaptiv},
18974 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
18975 @samp{m4k},
18976 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
18977 @samp{m5100}, @samp{m5101},
18978 @samp{octeon}, @samp{octeon+}, @samp{octeon2}, @samp{octeon3},
18979 @samp{orion},
18980 @samp{p5600},
18981 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
18982 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
18983 @samp{rm7000}, @samp{rm9000},
18984 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
18985 @samp{sb1},
18986 @samp{sr71000},
18987 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
18988 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
18989 @samp{xlr} and @samp{xlp}.
18990 The special value @samp{from-abi} selects the
18991 most compatible architecture for the selected ABI (that is,
18992 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
18994 The native Linux/GNU toolchain also supports the value @samp{native},
18995 which selects the best architecture option for the host processor.
18996 @option{-march=native} has no effect if GCC does not recognize
18997 the processor.
18999 In processor names, a final @samp{000} can be abbreviated as @samp{k}
19000 (for example, @option{-march=r2k}).  Prefixes are optional, and
19001 @samp{vr} may be written @samp{r}.
19003 Names of the form @samp{@var{n}f2_1} refer to processors with
19004 FPUs clocked at half the rate of the core, names of the form
19005 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
19006 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
19007 processors with FPUs clocked a ratio of 3:2 with respect to the core.
19008 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
19009 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
19010 accepted as synonyms for @samp{@var{n}f1_1}.
19012 GCC defines two macros based on the value of this option.  The first
19013 is @code{_MIPS_ARCH}, which gives the name of target architecture, as
19014 a string.  The second has the form @code{_MIPS_ARCH_@var{foo}},
19015 where @var{foo} is the capitalized value of @code{_MIPS_ARCH}@.
19016 For example, @option{-march=r2000} sets @code{_MIPS_ARCH}
19017 to @code{"r2000"} and defines the macro @code{_MIPS_ARCH_R2000}.
19019 Note that the @code{_MIPS_ARCH} macro uses the processor names given
19020 above.  In other words, it has the full prefix and does not
19021 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
19022 the macro names the resolved architecture (either @code{"mips1"} or
19023 @code{"mips3"}).  It names the default architecture when no
19024 @option{-march} option is given.
19026 @item -mtune=@var{arch}
19027 @opindex mtune
19028 Optimize for @var{arch}.  Among other things, this option controls
19029 the way instructions are scheduled, and the perceived cost of arithmetic
19030 operations.  The list of @var{arch} values is the same as for
19031 @option{-march}.
19033 When this option is not used, GCC optimizes for the processor
19034 specified by @option{-march}.  By using @option{-march} and
19035 @option{-mtune} together, it is possible to generate code that
19036 runs on a family of processors, but optimize the code for one
19037 particular member of that family.
19039 @option{-mtune} defines the macros @code{_MIPS_TUNE} and
19040 @code{_MIPS_TUNE_@var{foo}}, which work in the same way as the
19041 @option{-march} ones described above.
19043 @item -mips1
19044 @opindex mips1
19045 Equivalent to @option{-march=mips1}.
19047 @item -mips2
19048 @opindex mips2
19049 Equivalent to @option{-march=mips2}.
19051 @item -mips3
19052 @opindex mips3
19053 Equivalent to @option{-march=mips3}.
19055 @item -mips4
19056 @opindex mips4
19057 Equivalent to @option{-march=mips4}.
19059 @item -mips32
19060 @opindex mips32
19061 Equivalent to @option{-march=mips32}.
19063 @item -mips32r3
19064 @opindex mips32r3
19065 Equivalent to @option{-march=mips32r3}.
19067 @item -mips32r5
19068 @opindex mips32r5
19069 Equivalent to @option{-march=mips32r5}.
19071 @item -mips32r6
19072 @opindex mips32r6
19073 Equivalent to @option{-march=mips32r6}.
19075 @item -mips64
19076 @opindex mips64
19077 Equivalent to @option{-march=mips64}.
19079 @item -mips64r2
19080 @opindex mips64r2
19081 Equivalent to @option{-march=mips64r2}.
19083 @item -mips64r3
19084 @opindex mips64r3
19085 Equivalent to @option{-march=mips64r3}.
19087 @item -mips64r5
19088 @opindex mips64r5
19089 Equivalent to @option{-march=mips64r5}.
19091 @item -mips64r6
19092 @opindex mips64r6
19093 Equivalent to @option{-march=mips64r6}.
19095 @item -mips16
19096 @itemx -mno-mips16
19097 @opindex mips16
19098 @opindex mno-mips16
19099 Generate (do not generate) MIPS16 code.  If GCC is targeting a
19100 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
19102 MIPS16 code generation can also be controlled on a per-function basis
19103 by means of @code{mips16} and @code{nomips16} attributes.
19104 @xref{Function Attributes}, for more information.
19106 @item -mflip-mips16
19107 @opindex mflip-mips16
19108 Generate MIPS16 code on alternating functions.  This option is provided
19109 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
19110 not intended for ordinary use in compiling user code.
19112 @item -minterlink-compressed
19113 @item -mno-interlink-compressed
19114 @opindex minterlink-compressed
19115 @opindex mno-interlink-compressed
19116 Require (do not require) that code using the standard (uncompressed) MIPS ISA
19117 be link-compatible with MIPS16 and microMIPS code, and vice versa.
19119 For example, code using the standard ISA encoding cannot jump directly
19120 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
19121 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
19122 knows that the target of the jump is not compressed.
19124 @item -minterlink-mips16
19125 @itemx -mno-interlink-mips16
19126 @opindex minterlink-mips16
19127 @opindex mno-interlink-mips16
19128 Aliases of @option{-minterlink-compressed} and
19129 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
19130 and are retained for backwards compatibility.
19132 @item -mabi=32
19133 @itemx -mabi=o64
19134 @itemx -mabi=n32
19135 @itemx -mabi=64
19136 @itemx -mabi=eabi
19137 @opindex mabi=32
19138 @opindex mabi=o64
19139 @opindex mabi=n32
19140 @opindex mabi=64
19141 @opindex mabi=eabi
19142 Generate code for the given ABI@.
19144 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
19145 generates 64-bit code when you select a 64-bit architecture, but you
19146 can use @option{-mgp32} to get 32-bit code instead.
19148 For information about the O64 ABI, see
19149 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
19151 GCC supports a variant of the o32 ABI in which floating-point registers
19152 are 64 rather than 32 bits wide.  You can select this combination with
19153 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
19154 and @code{mfhc1} instructions and is therefore only supported for
19155 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
19157 The register assignments for arguments and return values remain the
19158 same, but each scalar value is passed in a single 64-bit register
19159 rather than a pair of 32-bit registers.  For example, scalar
19160 floating-point values are returned in @samp{$f0} only, not a
19161 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
19162 remains the same in that the even-numbered double-precision registers
19163 are saved.
19165 Two additional variants of the o32 ABI are supported to enable
19166 a transition from 32-bit to 64-bit registers.  These are FPXX
19167 (@option{-mfpxx}) and FP64A (@option{-mfp64} @option{-mno-odd-spreg}).
19168 The FPXX extension mandates that all code must execute correctly
19169 when run using 32-bit or 64-bit registers.  The code can be interlinked
19170 with either FP32 or FP64, but not both.
19171 The FP64A extension is similar to the FP64 extension but forbids the
19172 use of odd-numbered single-precision registers.  This can be used
19173 in conjunction with the @code{FRE} mode of FPUs in MIPS32R5
19174 processors and allows both FP32 and FP64A code to interlink and
19175 run in the same process without changing FPU modes.
19177 @item -mabicalls
19178 @itemx -mno-abicalls
19179 @opindex mabicalls
19180 @opindex mno-abicalls
19181 Generate (do not generate) code that is suitable for SVR4-style
19182 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
19183 systems.
19185 @item -mshared
19186 @itemx -mno-shared
19187 Generate (do not generate) code that is fully position-independent,
19188 and that can therefore be linked into shared libraries.  This option
19189 only affects @option{-mabicalls}.
19191 All @option{-mabicalls} code has traditionally been position-independent,
19192 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
19193 as an extension, the GNU toolchain allows executables to use absolute
19194 accesses for locally-binding symbols.  It can also use shorter GP
19195 initialization sequences and generate direct calls to locally-defined
19196 functions.  This mode is selected by @option{-mno-shared}.
19198 @option{-mno-shared} depends on binutils 2.16 or higher and generates
19199 objects that can only be linked by the GNU linker.  However, the option
19200 does not affect the ABI of the final executable; it only affects the ABI
19201 of relocatable objects.  Using @option{-mno-shared} generally makes
19202 executables both smaller and quicker.
19204 @option{-mshared} is the default.
19206 @item -mplt
19207 @itemx -mno-plt
19208 @opindex mplt
19209 @opindex mno-plt
19210 Assume (do not assume) that the static and dynamic linkers
19211 support PLTs and copy relocations.  This option only affects
19212 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
19213 has no effect without @option{-msym32}.
19215 You can make @option{-mplt} the default by configuring
19216 GCC with @option{--with-mips-plt}.  The default is
19217 @option{-mno-plt} otherwise.
19219 @item -mxgot
19220 @itemx -mno-xgot
19221 @opindex mxgot
19222 @opindex mno-xgot
19223 Lift (do not lift) the usual restrictions on the size of the global
19224 offset table.
19226 GCC normally uses a single instruction to load values from the GOT@.
19227 While this is relatively efficient, it only works if the GOT
19228 is smaller than about 64k.  Anything larger causes the linker
19229 to report an error such as:
19231 @cindex relocation truncated to fit (MIPS)
19232 @smallexample
19233 relocation truncated to fit: R_MIPS_GOT16 foobar
19234 @end smallexample
19236 If this happens, you should recompile your code with @option{-mxgot}.
19237 This works with very large GOTs, although the code is also
19238 less efficient, since it takes three instructions to fetch the
19239 value of a global symbol.
19241 Note that some linkers can create multiple GOTs.  If you have such a
19242 linker, you should only need to use @option{-mxgot} when a single object
19243 file accesses more than 64k's worth of GOT entries.  Very few do.
19245 These options have no effect unless GCC is generating position
19246 independent code.
19248 @item -mgp32
19249 @opindex mgp32
19250 Assume that general-purpose registers are 32 bits wide.
19252 @item -mgp64
19253 @opindex mgp64
19254 Assume that general-purpose registers are 64 bits wide.
19256 @item -mfp32
19257 @opindex mfp32
19258 Assume that floating-point registers are 32 bits wide.
19260 @item -mfp64
19261 @opindex mfp64
19262 Assume that floating-point registers are 64 bits wide.
19264 @item -mfpxx
19265 @opindex mfpxx
19266 Do not assume the width of floating-point registers.
19268 @item -mhard-float
19269 @opindex mhard-float
19270 Use floating-point coprocessor instructions.
19272 @item -msoft-float
19273 @opindex msoft-float
19274 Do not use floating-point coprocessor instructions.  Implement
19275 floating-point calculations using library calls instead.
19277 @item -mno-float
19278 @opindex mno-float
19279 Equivalent to @option{-msoft-float}, but additionally asserts that the
19280 program being compiled does not perform any floating-point operations.
19281 This option is presently supported only by some bare-metal MIPS
19282 configurations, where it may select a special set of libraries
19283 that lack all floating-point support (including, for example, the
19284 floating-point @code{printf} formats).  
19285 If code compiled with @option{-mno-float} accidentally contains
19286 floating-point operations, it is likely to suffer a link-time
19287 or run-time failure.
19289 @item -msingle-float
19290 @opindex msingle-float
19291 Assume that the floating-point coprocessor only supports single-precision
19292 operations.
19294 @item -mdouble-float
19295 @opindex mdouble-float
19296 Assume that the floating-point coprocessor supports double-precision
19297 operations.  This is the default.
19299 @item -modd-spreg
19300 @itemx -mno-odd-spreg
19301 @opindex modd-spreg
19302 @opindex mno-odd-spreg
19303 Enable the use of odd-numbered single-precision floating-point registers
19304 for the o32 ABI.  This is the default for processors that are known to
19305 support these registers.  When using the o32 FPXX ABI, @option{-mno-odd-spreg}
19306 is set by default.
19308 @item -mabs=2008
19309 @itemx -mabs=legacy
19310 @opindex mabs=2008
19311 @opindex mabs=legacy
19312 These options control the treatment of the special not-a-number (NaN)
19313 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
19314 @code{neg.@i{fmt}} machine instructions.
19316 By default or when @option{-mabs=legacy} is used the legacy
19317 treatment is selected.  In this case these instructions are considered
19318 arithmetic and avoided where correct operation is required and the
19319 input operand might be a NaN.  A longer sequence of instructions that
19320 manipulate the sign bit of floating-point datum manually is used
19321 instead unless the @option{-ffinite-math-only} option has also been
19322 specified.
19324 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
19325 this case these instructions are considered non-arithmetic and therefore
19326 operating correctly in all cases, including in particular where the
19327 input operand is a NaN.  These instructions are therefore always used
19328 for the respective operations.
19330 @item -mnan=2008
19331 @itemx -mnan=legacy
19332 @opindex mnan=2008
19333 @opindex mnan=legacy
19334 These options control the encoding of the special not-a-number (NaN)
19335 IEEE 754 floating-point data.
19337 The @option{-mnan=legacy} option selects the legacy encoding.  In this
19338 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
19339 significand field being 0, whereas signaling NaNs (sNaNs) are denoted
19340 by the first bit of their trailing significand field being 1.
19342 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
19343 this case qNaNs are denoted by the first bit of their trailing
19344 significand field being 1, whereas sNaNs are denoted by the first bit of
19345 their trailing significand field being 0.
19347 The default is @option{-mnan=legacy} unless GCC has been configured with
19348 @option{--with-nan=2008}.
19350 @item -mllsc
19351 @itemx -mno-llsc
19352 @opindex mllsc
19353 @opindex mno-llsc
19354 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
19355 implement atomic memory built-in functions.  When neither option is
19356 specified, GCC uses the instructions if the target architecture
19357 supports them.
19359 @option{-mllsc} is useful if the runtime environment can emulate the
19360 instructions and @option{-mno-llsc} can be useful when compiling for
19361 nonstandard ISAs.  You can make either option the default by
19362 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
19363 respectively.  @option{--with-llsc} is the default for some
19364 configurations; see the installation documentation for details.
19366 @item -mdsp
19367 @itemx -mno-dsp
19368 @opindex mdsp
19369 @opindex mno-dsp
19370 Use (do not use) revision 1 of the MIPS DSP ASE@.
19371 @xref{MIPS DSP Built-in Functions}.  This option defines the
19372 preprocessor macro @code{__mips_dsp}.  It also defines
19373 @code{__mips_dsp_rev} to 1.
19375 @item -mdspr2
19376 @itemx -mno-dspr2
19377 @opindex mdspr2
19378 @opindex mno-dspr2
19379 Use (do not use) revision 2 of the MIPS DSP ASE@.
19380 @xref{MIPS DSP Built-in Functions}.  This option defines the
19381 preprocessor macros @code{__mips_dsp} and @code{__mips_dspr2}.
19382 It also defines @code{__mips_dsp_rev} to 2.
19384 @item -msmartmips
19385 @itemx -mno-smartmips
19386 @opindex msmartmips
19387 @opindex mno-smartmips
19388 Use (do not use) the MIPS SmartMIPS ASE.
19390 @item -mpaired-single
19391 @itemx -mno-paired-single
19392 @opindex mpaired-single
19393 @opindex mno-paired-single
19394 Use (do not use) paired-single floating-point instructions.
19395 @xref{MIPS Paired-Single Support}.  This option requires
19396 hardware floating-point support to be enabled.
19398 @item -mdmx
19399 @itemx -mno-mdmx
19400 @opindex mdmx
19401 @opindex mno-mdmx
19402 Use (do not use) MIPS Digital Media Extension instructions.
19403 This option can only be used when generating 64-bit code and requires
19404 hardware floating-point support to be enabled.
19406 @item -mips3d
19407 @itemx -mno-mips3d
19408 @opindex mips3d
19409 @opindex mno-mips3d
19410 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
19411 The option @option{-mips3d} implies @option{-mpaired-single}.
19413 @item -mmicromips
19414 @itemx -mno-micromips
19415 @opindex mmicromips
19416 @opindex mno-mmicromips
19417 Generate (do not generate) microMIPS code.
19419 MicroMIPS code generation can also be controlled on a per-function basis
19420 by means of @code{micromips} and @code{nomicromips} attributes.
19421 @xref{Function Attributes}, for more information.
19423 @item -mmt
19424 @itemx -mno-mt
19425 @opindex mmt
19426 @opindex mno-mt
19427 Use (do not use) MT Multithreading instructions.
19429 @item -mmcu
19430 @itemx -mno-mcu
19431 @opindex mmcu
19432 @opindex mno-mcu
19433 Use (do not use) the MIPS MCU ASE instructions.
19435 @item -meva
19436 @itemx -mno-eva
19437 @opindex meva
19438 @opindex mno-eva
19439 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
19441 @item -mvirt
19442 @itemx -mno-virt
19443 @opindex mvirt
19444 @opindex mno-virt
19445 Use (do not use) the MIPS Virtualization (VZ) instructions.
19447 @item -mxpa
19448 @itemx -mno-xpa
19449 @opindex mxpa
19450 @opindex mno-xpa
19451 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
19453 @item -mlong64
19454 @opindex mlong64
19455 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
19456 an explanation of the default and the way that the pointer size is
19457 determined.
19459 @item -mlong32
19460 @opindex mlong32
19461 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
19463 The default size of @code{int}s, @code{long}s and pointers depends on
19464 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
19465 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
19466 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
19467 or the same size as integer registers, whichever is smaller.
19469 @item -msym32
19470 @itemx -mno-sym32
19471 @opindex msym32
19472 @opindex mno-sym32
19473 Assume (do not assume) that all symbols have 32-bit values, regardless
19474 of the selected ABI@.  This option is useful in combination with
19475 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
19476 to generate shorter and faster references to symbolic addresses.
19478 @item -G @var{num}
19479 @opindex G
19480 Put definitions of externally-visible data in a small data section
19481 if that data is no bigger than @var{num} bytes.  GCC can then generate
19482 more efficient accesses to the data; see @option{-mgpopt} for details.
19484 The default @option{-G} option depends on the configuration.
19486 @item -mlocal-sdata
19487 @itemx -mno-local-sdata
19488 @opindex mlocal-sdata
19489 @opindex mno-local-sdata
19490 Extend (do not extend) the @option{-G} behavior to local data too,
19491 such as to static variables in C@.  @option{-mlocal-sdata} is the
19492 default for all configurations.
19494 If the linker complains that an application is using too much small data,
19495 you might want to try rebuilding the less performance-critical parts with
19496 @option{-mno-local-sdata}.  You might also want to build large
19497 libraries with @option{-mno-local-sdata}, so that the libraries leave
19498 more room for the main program.
19500 @item -mextern-sdata
19501 @itemx -mno-extern-sdata
19502 @opindex mextern-sdata
19503 @opindex mno-extern-sdata
19504 Assume (do not assume) that externally-defined data is in
19505 a small data section if the size of that data is within the @option{-G} limit.
19506 @option{-mextern-sdata} is the default for all configurations.
19508 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
19509 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
19510 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
19511 is placed in a small data section.  If @var{Var} is defined by another
19512 module, you must either compile that module with a high-enough
19513 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
19514 definition.  If @var{Var} is common, you must link the application
19515 with a high-enough @option{-G} setting.
19517 The easiest way of satisfying these restrictions is to compile
19518 and link every module with the same @option{-G} option.  However,
19519 you may wish to build a library that supports several different
19520 small data limits.  You can do this by compiling the library with
19521 the highest supported @option{-G} setting and additionally using
19522 @option{-mno-extern-sdata} to stop the library from making assumptions
19523 about externally-defined data.
19525 @item -mgpopt
19526 @itemx -mno-gpopt
19527 @opindex mgpopt
19528 @opindex mno-gpopt
19529 Use (do not use) GP-relative accesses for symbols that are known to be
19530 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
19531 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
19532 configurations.
19534 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
19535 might not hold the value of @code{_gp}.  For example, if the code is
19536 part of a library that might be used in a boot monitor, programs that
19537 call boot monitor routines pass an unknown value in @code{$gp}.
19538 (In such situations, the boot monitor itself is usually compiled
19539 with @option{-G0}.)
19541 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
19542 @option{-mno-extern-sdata}.
19544 @item -membedded-data
19545 @itemx -mno-embedded-data
19546 @opindex membedded-data
19547 @opindex mno-embedded-data
19548 Allocate variables to the read-only data section first if possible, then
19549 next in the small data section if possible, otherwise in data.  This gives
19550 slightly slower code than the default, but reduces the amount of RAM required
19551 when executing, and thus may be preferred for some embedded systems.
19553 @item -muninit-const-in-rodata
19554 @itemx -mno-uninit-const-in-rodata
19555 @opindex muninit-const-in-rodata
19556 @opindex mno-uninit-const-in-rodata
19557 Put uninitialized @code{const} variables in the read-only data section.
19558 This option is only meaningful in conjunction with @option{-membedded-data}.
19560 @item -mcode-readable=@var{setting}
19561 @opindex mcode-readable
19562 Specify whether GCC may generate code that reads from executable sections.
19563 There are three possible settings:
19565 @table @gcctabopt
19566 @item -mcode-readable=yes
19567 Instructions may freely access executable sections.  This is the
19568 default setting.
19570 @item -mcode-readable=pcrel
19571 MIPS16 PC-relative load instructions can access executable sections,
19572 but other instructions must not do so.  This option is useful on 4KSc
19573 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
19574 It is also useful on processors that can be configured to have a dual
19575 instruction/data SRAM interface and that, like the M4K, automatically
19576 redirect PC-relative loads to the instruction RAM.
19578 @item -mcode-readable=no
19579 Instructions must not access executable sections.  This option can be
19580 useful on targets that are configured to have a dual instruction/data
19581 SRAM interface but that (unlike the M4K) do not automatically redirect
19582 PC-relative loads to the instruction RAM.
19583 @end table
19585 @item -msplit-addresses
19586 @itemx -mno-split-addresses
19587 @opindex msplit-addresses
19588 @opindex mno-split-addresses
19589 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
19590 relocation operators.  This option has been superseded by
19591 @option{-mexplicit-relocs} but is retained for backwards compatibility.
19593 @item -mexplicit-relocs
19594 @itemx -mno-explicit-relocs
19595 @opindex mexplicit-relocs
19596 @opindex mno-explicit-relocs
19597 Use (do not use) assembler relocation operators when dealing with symbolic
19598 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
19599 is to use assembler macros instead.
19601 @option{-mexplicit-relocs} is the default if GCC was configured
19602 to use an assembler that supports relocation operators.
19604 @item -mcheck-zero-division
19605 @itemx -mno-check-zero-division
19606 @opindex mcheck-zero-division
19607 @opindex mno-check-zero-division
19608 Trap (do not trap) on integer division by zero.
19610 The default is @option{-mcheck-zero-division}.
19612 @item -mdivide-traps
19613 @itemx -mdivide-breaks
19614 @opindex mdivide-traps
19615 @opindex mdivide-breaks
19616 MIPS systems check for division by zero by generating either a
19617 conditional trap or a break instruction.  Using traps results in
19618 smaller code, but is only supported on MIPS II and later.  Also, some
19619 versions of the Linux kernel have a bug that prevents trap from
19620 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
19621 allow conditional traps on architectures that support them and
19622 @option{-mdivide-breaks} to force the use of breaks.
19624 The default is usually @option{-mdivide-traps}, but this can be
19625 overridden at configure time using @option{--with-divide=breaks}.
19626 Divide-by-zero checks can be completely disabled using
19627 @option{-mno-check-zero-division}.
19629 @item -mload-store-pairs
19630 @itemx -mno-load-store-pairs
19631 @opindex mload-store-pairs
19632 @opindex mno-load-store-pairs
19633 Enable (disable) an optimization that pairs consecutive load or store
19634 instructions to enable load/store bonding.  This option is enabled by
19635 default but only takes effect when the selected architecture is known
19636 to support bonding.
19638 @item -mmemcpy
19639 @itemx -mno-memcpy
19640 @opindex mmemcpy
19641 @opindex mno-memcpy
19642 Force (do not force) the use of @code{memcpy} for non-trivial block
19643 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
19644 most constant-sized copies.
19646 @item -mlong-calls
19647 @itemx -mno-long-calls
19648 @opindex mlong-calls
19649 @opindex mno-long-calls
19650 Disable (do not disable) use of the @code{jal} instruction.  Calling
19651 functions using @code{jal} is more efficient but requires the caller
19652 and callee to be in the same 256 megabyte segment.
19654 This option has no effect on abicalls code.  The default is
19655 @option{-mno-long-calls}.
19657 @item -mmad
19658 @itemx -mno-mad
19659 @opindex mmad
19660 @opindex mno-mad
19661 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
19662 instructions, as provided by the R4650 ISA@.
19664 @item -mimadd
19665 @itemx -mno-imadd
19666 @opindex mimadd
19667 @opindex mno-imadd
19668 Enable (disable) use of the @code{madd} and @code{msub} integer
19669 instructions.  The default is @option{-mimadd} on architectures
19670 that support @code{madd} and @code{msub} except for the 74k 
19671 architecture where it was found to generate slower code.
19673 @item -mfused-madd
19674 @itemx -mno-fused-madd
19675 @opindex mfused-madd
19676 @opindex mno-fused-madd
19677 Enable (disable) use of the floating-point multiply-accumulate
19678 instructions, when they are available.  The default is
19679 @option{-mfused-madd}.
19681 On the R8000 CPU when multiply-accumulate instructions are used,
19682 the intermediate product is calculated to infinite precision
19683 and is not subject to the FCSR Flush to Zero bit.  This may be
19684 undesirable in some circumstances.  On other processors the result
19685 is numerically identical to the equivalent computation using
19686 separate multiply, add, subtract and negate instructions.
19688 @item -nocpp
19689 @opindex nocpp
19690 Tell the MIPS assembler to not run its preprocessor over user
19691 assembler files (with a @samp{.s} suffix) when assembling them.
19693 @item -mfix-24k
19694 @item -mno-fix-24k
19695 @opindex mfix-24k
19696 @opindex mno-fix-24k
19697 Work around the 24K E48 (lost data on stores during refill) errata.
19698 The workarounds are implemented by the assembler rather than by GCC@.
19700 @item -mfix-r4000
19701 @itemx -mno-fix-r4000
19702 @opindex mfix-r4000
19703 @opindex mno-fix-r4000
19704 Work around certain R4000 CPU errata:
19705 @itemize @minus
19706 @item
19707 A double-word or a variable shift may give an incorrect result if executed
19708 immediately after starting an integer division.
19709 @item
19710 A double-word or a variable shift may give an incorrect result if executed
19711 while an integer multiplication is in progress.
19712 @item
19713 An integer division may give an incorrect result if started in a delay slot
19714 of a taken branch or a jump.
19715 @end itemize
19717 @item -mfix-r4400
19718 @itemx -mno-fix-r4400
19719 @opindex mfix-r4400
19720 @opindex mno-fix-r4400
19721 Work around certain R4400 CPU errata:
19722 @itemize @minus
19723 @item
19724 A double-word or a variable shift may give an incorrect result if executed
19725 immediately after starting an integer division.
19726 @end itemize
19728 @item -mfix-r10000
19729 @itemx -mno-fix-r10000
19730 @opindex mfix-r10000
19731 @opindex mno-fix-r10000
19732 Work around certain R10000 errata:
19733 @itemize @minus
19734 @item
19735 @code{ll}/@code{sc} sequences may not behave atomically on revisions
19736 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
19737 @end itemize
19739 This option can only be used if the target architecture supports
19740 branch-likely instructions.  @option{-mfix-r10000} is the default when
19741 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
19742 otherwise.
19744 @item -mfix-rm7000
19745 @itemx -mno-fix-rm7000
19746 @opindex mfix-rm7000
19747 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
19748 workarounds are implemented by the assembler rather than by GCC@.
19750 @item -mfix-vr4120
19751 @itemx -mno-fix-vr4120
19752 @opindex mfix-vr4120
19753 Work around certain VR4120 errata:
19754 @itemize @minus
19755 @item
19756 @code{dmultu} does not always produce the correct result.
19757 @item
19758 @code{div} and @code{ddiv} do not always produce the correct result if one
19759 of the operands is negative.
19760 @end itemize
19761 The workarounds for the division errata rely on special functions in
19762 @file{libgcc.a}.  At present, these functions are only provided by
19763 the @code{mips64vr*-elf} configurations.
19765 Other VR4120 errata require a NOP to be inserted between certain pairs of
19766 instructions.  These errata are handled by the assembler, not by GCC itself.
19768 @item -mfix-vr4130
19769 @opindex mfix-vr4130
19770 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
19771 workarounds are implemented by the assembler rather than by GCC,
19772 although GCC avoids using @code{mflo} and @code{mfhi} if the
19773 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
19774 instructions are available instead.
19776 @item -mfix-sb1
19777 @itemx -mno-fix-sb1
19778 @opindex mfix-sb1
19779 Work around certain SB-1 CPU core errata.
19780 (This flag currently works around the SB-1 revision 2
19781 ``F1'' and ``F2'' floating-point errata.)
19783 @item -mr10k-cache-barrier=@var{setting}
19784 @opindex mr10k-cache-barrier
19785 Specify whether GCC should insert cache barriers to avoid the
19786 side-effects of speculation on R10K processors.
19788 In common with many processors, the R10K tries to predict the outcome
19789 of a conditional branch and speculatively executes instructions from
19790 the ``taken'' branch.  It later aborts these instructions if the
19791 predicted outcome is wrong.  However, on the R10K, even aborted
19792 instructions can have side effects.
19794 This problem only affects kernel stores and, depending on the system,
19795 kernel loads.  As an example, a speculatively-executed store may load
19796 the target memory into cache and mark the cache line as dirty, even if
19797 the store itself is later aborted.  If a DMA operation writes to the
19798 same area of memory before the ``dirty'' line is flushed, the cached
19799 data overwrites the DMA-ed data.  See the R10K processor manual
19800 for a full description, including other potential problems.
19802 One workaround is to insert cache barrier instructions before every memory
19803 access that might be speculatively executed and that might have side
19804 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
19805 controls GCC's implementation of this workaround.  It assumes that
19806 aborted accesses to any byte in the following regions does not have
19807 side effects:
19809 @enumerate
19810 @item
19811 the memory occupied by the current function's stack frame;
19813 @item
19814 the memory occupied by an incoming stack argument;
19816 @item
19817 the memory occupied by an object with a link-time-constant address.
19818 @end enumerate
19820 It is the kernel's responsibility to ensure that speculative
19821 accesses to these regions are indeed safe.
19823 If the input program contains a function declaration such as:
19825 @smallexample
19826 void foo (void);
19827 @end smallexample
19829 then the implementation of @code{foo} must allow @code{j foo} and
19830 @code{jal foo} to be executed speculatively.  GCC honors this
19831 restriction for functions it compiles itself.  It expects non-GCC
19832 functions (such as hand-written assembly code) to do the same.
19834 The option has three forms:
19836 @table @gcctabopt
19837 @item -mr10k-cache-barrier=load-store
19838 Insert a cache barrier before a load or store that might be
19839 speculatively executed and that might have side effects even
19840 if aborted.
19842 @item -mr10k-cache-barrier=store
19843 Insert a cache barrier before a store that might be speculatively
19844 executed and that might have side effects even if aborted.
19846 @item -mr10k-cache-barrier=none
19847 Disable the insertion of cache barriers.  This is the default setting.
19848 @end table
19850 @item -mflush-func=@var{func}
19851 @itemx -mno-flush-func
19852 @opindex mflush-func
19853 Specifies the function to call to flush the I and D caches, or to not
19854 call any such function.  If called, the function must take the same
19855 arguments as the common @code{_flush_func}, that is, the address of the
19856 memory range for which the cache is being flushed, the size of the
19857 memory range, and the number 3 (to flush both caches).  The default
19858 depends on the target GCC was configured for, but commonly is either
19859 @code{_flush_func} or @code{__cpu_flush}.
19861 @item mbranch-cost=@var{num}
19862 @opindex mbranch-cost
19863 Set the cost of branches to roughly @var{num} ``simple'' instructions.
19864 This cost is only a heuristic and is not guaranteed to produce
19865 consistent results across releases.  A zero cost redundantly selects
19866 the default, which is based on the @option{-mtune} setting.
19868 @item -mbranch-likely
19869 @itemx -mno-branch-likely
19870 @opindex mbranch-likely
19871 @opindex mno-branch-likely
19872 Enable or disable use of Branch Likely instructions, regardless of the
19873 default for the selected architecture.  By default, Branch Likely
19874 instructions may be generated if they are supported by the selected
19875 architecture.  An exception is for the MIPS32 and MIPS64 architectures
19876 and processors that implement those architectures; for those, Branch
19877 Likely instructions are not be generated by default because the MIPS32
19878 and MIPS64 architectures specifically deprecate their use.
19880 @item -mcompact-branches=never
19881 @itemx -mcompact-branches=optimal
19882 @itemx -mcompact-branches=always
19883 @opindex mcompact-branches=never
19884 @opindex mcompact-branches=optimal
19885 @opindex mcompact-branches=always
19886 These options control which form of branches will be generated.  The
19887 default is @option{-mcompact-branches=optimal}.
19889 The @option{-mcompact-branches=never} option ensures that compact branch
19890 instructions will never be generated.
19892 The @option{-mcompact-branches=always} option ensures that a compact
19893 branch instruction will be generated if available.  If a compact branch
19894 instruction is not available, a delay slot form of the branch will be
19895 used instead.
19897 This option is supported from MIPS Release 6 onwards.
19899 The @option{-mcompact-branches=optimal} option will cause a delay slot
19900 branch to be used if one is available in the current ISA and the delay
19901 slot is successfully filled.  If the delay slot is not filled, a compact
19902 branch will be chosen if one is available.
19904 @item -mfp-exceptions
19905 @itemx -mno-fp-exceptions
19906 @opindex mfp-exceptions
19907 Specifies whether FP exceptions are enabled.  This affects how
19908 FP instructions are scheduled for some processors.
19909 The default is that FP exceptions are
19910 enabled.
19912 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
19913 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
19914 FP pipe.
19916 @item -mvr4130-align
19917 @itemx -mno-vr4130-align
19918 @opindex mvr4130-align
19919 The VR4130 pipeline is two-way superscalar, but can only issue two
19920 instructions together if the first one is 8-byte aligned.  When this
19921 option is enabled, GCC aligns pairs of instructions that it
19922 thinks should execute in parallel.
19924 This option only has an effect when optimizing for the VR4130.
19925 It normally makes code faster, but at the expense of making it bigger.
19926 It is enabled by default at optimization level @option{-O3}.
19928 @item -msynci
19929 @itemx -mno-synci
19930 @opindex msynci
19931 Enable (disable) generation of @code{synci} instructions on
19932 architectures that support it.  The @code{synci} instructions (if
19933 enabled) are generated when @code{__builtin___clear_cache} is
19934 compiled.
19936 This option defaults to @option{-mno-synci}, but the default can be
19937 overridden by configuring GCC with @option{--with-synci}.
19939 When compiling code for single processor systems, it is generally safe
19940 to use @code{synci}.  However, on many multi-core (SMP) systems, it
19941 does not invalidate the instruction caches on all cores and may lead
19942 to undefined behavior.
19944 @item -mrelax-pic-calls
19945 @itemx -mno-relax-pic-calls
19946 @opindex mrelax-pic-calls
19947 Try to turn PIC calls that are normally dispatched via register
19948 @code{$25} into direct calls.  This is only possible if the linker can
19949 resolve the destination at link time and if the destination is within
19950 range for a direct call.
19952 @option{-mrelax-pic-calls} is the default if GCC was configured to use
19953 an assembler and a linker that support the @code{.reloc} assembly
19954 directive and @option{-mexplicit-relocs} is in effect.  With
19955 @option{-mno-explicit-relocs}, this optimization can be performed by the
19956 assembler and the linker alone without help from the compiler.
19958 @item -mmcount-ra-address
19959 @itemx -mno-mcount-ra-address
19960 @opindex mmcount-ra-address
19961 @opindex mno-mcount-ra-address
19962 Emit (do not emit) code that allows @code{_mcount} to modify the
19963 calling function's return address.  When enabled, this option extends
19964 the usual @code{_mcount} interface with a new @var{ra-address}
19965 parameter, which has type @code{intptr_t *} and is passed in register
19966 @code{$12}.  @code{_mcount} can then modify the return address by
19967 doing both of the following:
19968 @itemize
19969 @item
19970 Returning the new address in register @code{$31}.
19971 @item
19972 Storing the new address in @code{*@var{ra-address}},
19973 if @var{ra-address} is nonnull.
19974 @end itemize
19976 The default is @option{-mno-mcount-ra-address}.
19978 @item -mframe-header-opt
19979 @itemx -mno-frame-header-opt
19980 @opindex mframe-header-opt
19981 Enable (disable) frame header optimization in the o32 ABI.  When using the
19982 o32 ABI, calling functions will allocate 16 bytes on the stack for the called
19983 function to write out register arguments.  When enabled, this optimization
19984 will suppress the allocation of the frame header if it can be determined that
19985 it is unused.
19987 This optimization is off by default at all optimization levels.
19989 @item -mlxc1-sxc1
19990 @itemx -mno-lxc1-sxc1
19991 @opindex mlxc1-sxc1
19992 When applicable, enable (disable) the generation of @code{lwxc1},
19993 @code{swxc1}, @code{ldxc1}, @code{sdxc1} instructions.  Enabled by default.
19995 @item -mmadd4
19996 @itemx -mno-madd4
19997 @opindex mmadd4
19998 When applicable, enable (disable) the generation of 4-operand @code{madd.s},
19999 @code{madd.d} and related instructions.  Enabled by default.
20001 @end table
20003 @node MMIX Options
20004 @subsection MMIX Options
20005 @cindex MMIX Options
20007 These options are defined for the MMIX:
20009 @table @gcctabopt
20010 @item -mlibfuncs
20011 @itemx -mno-libfuncs
20012 @opindex mlibfuncs
20013 @opindex mno-libfuncs
20014 Specify that intrinsic library functions are being compiled, passing all
20015 values in registers, no matter the size.
20017 @item -mepsilon
20018 @itemx -mno-epsilon
20019 @opindex mepsilon
20020 @opindex mno-epsilon
20021 Generate floating-point comparison instructions that compare with respect
20022 to the @code{rE} epsilon register.
20024 @item -mabi=mmixware
20025 @itemx -mabi=gnu
20026 @opindex mabi=mmixware
20027 @opindex mabi=gnu
20028 Generate code that passes function parameters and return values that (in
20029 the called function) are seen as registers @code{$0} and up, as opposed to
20030 the GNU ABI which uses global registers @code{$231} and up.
20032 @item -mzero-extend
20033 @itemx -mno-zero-extend
20034 @opindex mzero-extend
20035 @opindex mno-zero-extend
20036 When reading data from memory in sizes shorter than 64 bits, use (do not
20037 use) zero-extending load instructions by default, rather than
20038 sign-extending ones.
20040 @item -mknuthdiv
20041 @itemx -mno-knuthdiv
20042 @opindex mknuthdiv
20043 @opindex mno-knuthdiv
20044 Make the result of a division yielding a remainder have the same sign as
20045 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
20046 remainder follows the sign of the dividend.  Both methods are
20047 arithmetically valid, the latter being almost exclusively used.
20049 @item -mtoplevel-symbols
20050 @itemx -mno-toplevel-symbols
20051 @opindex mtoplevel-symbols
20052 @opindex mno-toplevel-symbols
20053 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
20054 code can be used with the @code{PREFIX} assembly directive.
20056 @item -melf
20057 @opindex melf
20058 Generate an executable in the ELF format, rather than the default
20059 @samp{mmo} format used by the @command{mmix} simulator.
20061 @item -mbranch-predict
20062 @itemx -mno-branch-predict
20063 @opindex mbranch-predict
20064 @opindex mno-branch-predict
20065 Use (do not use) the probable-branch instructions, when static branch
20066 prediction indicates a probable branch.
20068 @item -mbase-addresses
20069 @itemx -mno-base-addresses
20070 @opindex mbase-addresses
20071 @opindex mno-base-addresses
20072 Generate (do not generate) code that uses @emph{base addresses}.  Using a
20073 base address automatically generates a request (handled by the assembler
20074 and the linker) for a constant to be set up in a global register.  The
20075 register is used for one or more base address requests within the range 0
20076 to 255 from the value held in the register.  The generally leads to short
20077 and fast code, but the number of different data items that can be
20078 addressed is limited.  This means that a program that uses lots of static
20079 data may require @option{-mno-base-addresses}.
20081 @item -msingle-exit
20082 @itemx -mno-single-exit
20083 @opindex msingle-exit
20084 @opindex mno-single-exit
20085 Force (do not force) generated code to have a single exit point in each
20086 function.
20087 @end table
20089 @node MN10300 Options
20090 @subsection MN10300 Options
20091 @cindex MN10300 options
20093 These @option{-m} options are defined for Matsushita MN10300 architectures:
20095 @table @gcctabopt
20096 @item -mmult-bug
20097 @opindex mmult-bug
20098 Generate code to avoid bugs in the multiply instructions for the MN10300
20099 processors.  This is the default.
20101 @item -mno-mult-bug
20102 @opindex mno-mult-bug
20103 Do not generate code to avoid bugs in the multiply instructions for the
20104 MN10300 processors.
20106 @item -mam33
20107 @opindex mam33
20108 Generate code using features specific to the AM33 processor.
20110 @item -mno-am33
20111 @opindex mno-am33
20112 Do not generate code using features specific to the AM33 processor.  This
20113 is the default.
20115 @item -mam33-2
20116 @opindex mam33-2
20117 Generate code using features specific to the AM33/2.0 processor.
20119 @item -mam34
20120 @opindex mam34
20121 Generate code using features specific to the AM34 processor.
20123 @item -mtune=@var{cpu-type}
20124 @opindex mtune
20125 Use the timing characteristics of the indicated CPU type when
20126 scheduling instructions.  This does not change the targeted processor
20127 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
20128 @samp{am33-2} or @samp{am34}.
20130 @item -mreturn-pointer-on-d0
20131 @opindex mreturn-pointer-on-d0
20132 When generating a function that returns a pointer, return the pointer
20133 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
20134 only in @code{a0}, and attempts to call such functions without a prototype
20135 result in errors.  Note that this option is on by default; use
20136 @option{-mno-return-pointer-on-d0} to disable it.
20138 @item -mno-crt0
20139 @opindex mno-crt0
20140 Do not link in the C run-time initialization object file.
20142 @item -mrelax
20143 @opindex mrelax
20144 Indicate to the linker that it should perform a relaxation optimization pass
20145 to shorten branches, calls and absolute memory addresses.  This option only
20146 has an effect when used on the command line for the final link step.
20148 This option makes symbolic debugging impossible.
20150 @item -mliw
20151 @opindex mliw
20152 Allow the compiler to generate @emph{Long Instruction Word}
20153 instructions if the target is the @samp{AM33} or later.  This is the
20154 default.  This option defines the preprocessor macro @code{__LIW__}.
20156 @item -mnoliw
20157 @opindex mnoliw
20158 Do not allow the compiler to generate @emph{Long Instruction Word}
20159 instructions.  This option defines the preprocessor macro
20160 @code{__NO_LIW__}.
20162 @item -msetlb
20163 @opindex msetlb
20164 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
20165 instructions if the target is the @samp{AM33} or later.  This is the
20166 default.  This option defines the preprocessor macro @code{__SETLB__}.
20168 @item -mnosetlb
20169 @opindex mnosetlb
20170 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
20171 instructions.  This option defines the preprocessor macro
20172 @code{__NO_SETLB__}.
20174 @end table
20176 @node Moxie Options
20177 @subsection Moxie Options
20178 @cindex Moxie Options
20180 @table @gcctabopt
20182 @item -meb
20183 @opindex meb
20184 Generate big-endian code.  This is the default for @samp{moxie-*-*}
20185 configurations.
20187 @item -mel
20188 @opindex mel
20189 Generate little-endian code.
20191 @item -mmul.x
20192 @opindex mmul.x
20193 Generate mul.x and umul.x instructions.  This is the default for
20194 @samp{moxiebox-*-*} configurations.
20196 @item -mno-crt0
20197 @opindex mno-crt0
20198 Do not link in the C run-time initialization object file.
20200 @end table
20202 @node MSP430 Options
20203 @subsection MSP430 Options
20204 @cindex MSP430 Options
20206 These options are defined for the MSP430:
20208 @table @gcctabopt
20210 @item -masm-hex
20211 @opindex masm-hex
20212 Force assembly output to always use hex constants.  Normally such
20213 constants are signed decimals, but this option is available for
20214 testsuite and/or aesthetic purposes.
20216 @item -mmcu=
20217 @opindex mmcu=
20218 Select the MCU to target.  This is used to create a C preprocessor
20219 symbol based upon the MCU name, converted to upper case and pre- and
20220 post-fixed with @samp{__}.  This in turn is used by the
20221 @file{msp430.h} header file to select an MCU-specific supplementary
20222 header file.
20224 The option also sets the ISA to use.  If the MCU name is one that is
20225 known to only support the 430 ISA then that is selected, otherwise the
20226 430X ISA is selected.  A generic MCU name of @samp{msp430} can also be
20227 used to select the 430 ISA.  Similarly the generic @samp{msp430x} MCU
20228 name selects the 430X ISA.
20230 In addition an MCU-specific linker script is added to the linker
20231 command line.  The script's name is the name of the MCU with
20232 @file{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the @command{gcc}
20233 command line defines the C preprocessor symbol @code{__XXX__} and
20234 cause the linker to search for a script called @file{xxx.ld}.
20236 This option is also passed on to the assembler.
20238 @item -mwarn-mcu
20239 @itemx -mno-warn-mcu
20240 @opindex mwarn-mcu
20241 @opindex mno-warn-mcu
20242 This option enables or disables warnings about conflicts between the
20243 MCU name specified by the @option{-mmcu} option and the ISA set by the
20244 @option{-mcpu} option and/or the hardware multiply support set by the
20245 @option{-mhwmult} option.  It also toggles warnings about unrecognized
20246 MCU names.  This option is on by default.
20248 @item -mcpu=
20249 @opindex mcpu=
20250 Specifies the ISA to use.  Accepted values are @samp{msp430},
20251 @samp{msp430x} and @samp{msp430xv2}.  This option is deprecated.  The
20252 @option{-mmcu=} option should be used to select the ISA.
20254 @item -msim
20255 @opindex msim
20256 Link to the simulator runtime libraries and linker script.  Overrides
20257 any scripts that would be selected by the @option{-mmcu=} option.
20259 @item -mlarge
20260 @opindex mlarge
20261 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
20263 @item -msmall
20264 @opindex msmall
20265 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
20267 @item -mrelax
20268 @opindex mrelax
20269 This option is passed to the assembler and linker, and allows the
20270 linker to perform certain optimizations that cannot be done until
20271 the final link.
20273 @item mhwmult=
20274 @opindex mhwmult=
20275 Describes the type of hardware multiply supported by the target.
20276 Accepted values are @samp{none} for no hardware multiply, @samp{16bit}
20277 for the original 16-bit-only multiply supported by early MCUs.
20278 @samp{32bit} for the 16/32-bit multiply supported by later MCUs and
20279 @samp{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
20280 A value of @samp{auto} can also be given.  This tells GCC to deduce
20281 the hardware multiply support based upon the MCU name provided by the
20282 @option{-mmcu} option.  If no @option{-mmcu} option is specified or if
20283 the MCU name is not recognized then no hardware multiply support is
20284 assumed.  @code{auto} is the default setting.
20286 Hardware multiplies are normally performed by calling a library
20287 routine.  This saves space in the generated code.  When compiling at
20288 @option{-O3} or higher however the hardware multiplier is invoked
20289 inline.  This makes for bigger, but faster code.
20291 The hardware multiply routines disable interrupts whilst running and
20292 restore the previous interrupt state when they finish.  This makes
20293 them safe to use inside interrupt handlers as well as in normal code.
20295 @item -minrt
20296 @opindex minrt
20297 Enable the use of a minimum runtime environment - no static
20298 initializers or constructors.  This is intended for memory-constrained
20299 devices.  The compiler includes special symbols in some objects
20300 that tell the linker and runtime which code fragments are required.
20302 @item -mcode-region=
20303 @itemx -mdata-region=
20304 @opindex mcode-region
20305 @opindex mdata-region
20306 These options tell the compiler where to place functions and data that
20307 do not have one of the @code{lower}, @code{upper}, @code{either} or
20308 @code{section} attributes.  Possible values are @code{lower},
20309 @code{upper}, @code{either} or @code{any}.  The first three behave
20310 like the corresponding attribute.  The fourth possible value -
20311 @code{any} - is the default.  It leaves placement entirely up to the
20312 linker script and how it assigns the standard sections
20313 (@code{.text}, @code{.data}, etc) to the memory regions.
20315 @item -msilicon-errata=
20316 @opindex msilicon-errata
20317 This option passes on a request to assembler to enable the fixes for
20318 the named silicon errata.
20320 @item -msilicon-errata-warn=
20321 @opindex msilicon-errata-warn
20322 This option passes on a request to the assembler to enable warning
20323 messages when a silicon errata might need to be applied.
20325 @end table
20327 @node NDS32 Options
20328 @subsection NDS32 Options
20329 @cindex NDS32 Options
20331 These options are defined for NDS32 implementations:
20333 @table @gcctabopt
20335 @item -mbig-endian
20336 @opindex mbig-endian
20337 Generate code in big-endian mode.
20339 @item -mlittle-endian
20340 @opindex mlittle-endian
20341 Generate code in little-endian mode.
20343 @item -mreduced-regs
20344 @opindex mreduced-regs
20345 Use reduced-set registers for register allocation.
20347 @item -mfull-regs
20348 @opindex mfull-regs
20349 Use full-set registers for register allocation.
20351 @item -mcmov
20352 @opindex mcmov
20353 Generate conditional move instructions.
20355 @item -mno-cmov
20356 @opindex mno-cmov
20357 Do not generate conditional move instructions.
20359 @item -mperf-ext
20360 @opindex mperf-ext
20361 Generate performance extension instructions.
20363 @item -mno-perf-ext
20364 @opindex mno-perf-ext
20365 Do not generate performance extension instructions.
20367 @item -mv3push
20368 @opindex mv3push
20369 Generate v3 push25/pop25 instructions.
20371 @item -mno-v3push
20372 @opindex mno-v3push
20373 Do not generate v3 push25/pop25 instructions.
20375 @item -m16-bit
20376 @opindex m16-bit
20377 Generate 16-bit instructions.
20379 @item -mno-16-bit
20380 @opindex mno-16-bit
20381 Do not generate 16-bit instructions.
20383 @item -misr-vector-size=@var{num}
20384 @opindex misr-vector-size
20385 Specify the size of each interrupt vector, which must be 4 or 16.
20387 @item -mcache-block-size=@var{num}
20388 @opindex mcache-block-size
20389 Specify the size of each cache block,
20390 which must be a power of 2 between 4 and 512.
20392 @item -march=@var{arch}
20393 @opindex march
20394 Specify the name of the target architecture.
20396 @item -mcmodel=@var{code-model}
20397 @opindex mcmodel
20398 Set the code model to one of
20399 @table @asis
20400 @item @samp{small}
20401 All the data and read-only data segments must be within 512KB addressing space.
20402 The text segment must be within 16MB addressing space.
20403 @item @samp{medium}
20404 The data segment must be within 512KB while the read-only data segment can be
20405 within 4GB addressing space.  The text segment should be still within 16MB
20406 addressing space.
20407 @item @samp{large}
20408 All the text and data segments can be within 4GB addressing space.
20409 @end table
20411 @item -mctor-dtor
20412 @opindex mctor-dtor
20413 Enable constructor/destructor feature.
20415 @item -mrelax
20416 @opindex mrelax
20417 Guide linker to relax instructions.
20419 @end table
20421 @node Nios II Options
20422 @subsection Nios II Options
20423 @cindex Nios II options
20424 @cindex Altera Nios II options
20426 These are the options defined for the Altera Nios II processor.
20428 @table @gcctabopt
20430 @item -G @var{num}
20431 @opindex G
20432 @cindex smaller data references
20433 Put global and static objects less than or equal to @var{num} bytes
20434 into the small data or BSS sections instead of the normal data or BSS
20435 sections.  The default value of @var{num} is 8.
20437 @item -mgpopt=@var{option}
20438 @item -mgpopt
20439 @itemx -mno-gpopt
20440 @opindex mgpopt
20441 @opindex mno-gpopt
20442 Generate (do not generate) GP-relative accesses.  The following 
20443 @var{option} names are recognized:
20445 @table @samp
20447 @item none
20448 Do not generate GP-relative accesses.
20450 @item local
20451 Generate GP-relative accesses for small data objects that are not 
20452 external, weak, or uninitialized common symbols.  
20453 Also use GP-relative addressing for objects that
20454 have been explicitly placed in a small data section via a @code{section}
20455 attribute.
20457 @item global
20458 As for @samp{local}, but also generate GP-relative accesses for
20459 small data objects that are external, weak, or common.  If you use this option,
20460 you must ensure that all parts of your program (including libraries) are
20461 compiled with the same @option{-G} setting.
20463 @item data
20464 Generate GP-relative accesses for all data objects in the program.  If you
20465 use this option, the entire data and BSS segments
20466 of your program must fit in 64K of memory and you must use an appropriate
20467 linker script to allocate them within the addressable range of the
20468 global pointer.
20470 @item all
20471 Generate GP-relative addresses for function pointers as well as data
20472 pointers.  If you use this option, the entire text, data, and BSS segments
20473 of your program must fit in 64K of memory and you must use an appropriate
20474 linker script to allocate them within the addressable range of the
20475 global pointer.
20477 @end table
20479 @option{-mgpopt} is equivalent to @option{-mgpopt=local}, and
20480 @option{-mno-gpopt} is equivalent to @option{-mgpopt=none}.
20482 The default is @option{-mgpopt} except when @option{-fpic} or
20483 @option{-fPIC} is specified to generate position-independent code.
20484 Note that the Nios II ABI does not permit GP-relative accesses from
20485 shared libraries.
20487 You may need to specify @option{-mno-gpopt} explicitly when building
20488 programs that include large amounts of small data, including large
20489 GOT data sections.  In this case, the 16-bit offset for GP-relative
20490 addressing may not be large enough to allow access to the entire 
20491 small data section.
20493 @item -mel
20494 @itemx -meb
20495 @opindex mel
20496 @opindex meb
20497 Generate little-endian (default) or big-endian (experimental) code,
20498 respectively.
20500 @item -march=@var{arch}
20501 @opindex march
20502 This specifies the name of the target Nios II architecture.  GCC uses this
20503 name to determine what kind of instructions it can emit when generating
20504 assembly code.  Permissible names are: @samp{r1}, @samp{r2}.
20506 The preprocessor macro @code{__nios2_arch__} is available to programs,
20507 with value 1 or 2, indicating the targeted ISA level.
20509 @item -mbypass-cache
20510 @itemx -mno-bypass-cache
20511 @opindex mno-bypass-cache
20512 @opindex mbypass-cache
20513 Force all load and store instructions to always bypass cache by 
20514 using I/O variants of the instructions. The default is not to
20515 bypass the cache.
20517 @item -mno-cache-volatile 
20518 @itemx -mcache-volatile       
20519 @opindex mcache-volatile 
20520 @opindex mno-cache-volatile
20521 Volatile memory access bypass the cache using the I/O variants of 
20522 the load and store instructions. The default is not to bypass the cache.
20524 @item -mno-fast-sw-div
20525 @itemx -mfast-sw-div
20526 @opindex mno-fast-sw-div
20527 @opindex mfast-sw-div
20528 Do not use table-based fast divide for small numbers. The default 
20529 is to use the fast divide at @option{-O3} and above.
20531 @item -mno-hw-mul
20532 @itemx -mhw-mul
20533 @itemx -mno-hw-mulx
20534 @itemx -mhw-mulx
20535 @itemx -mno-hw-div
20536 @itemx -mhw-div
20537 @opindex mno-hw-mul
20538 @opindex mhw-mul
20539 @opindex mno-hw-mulx
20540 @opindex mhw-mulx
20541 @opindex mno-hw-div
20542 @opindex mhw-div
20543 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
20544 instructions by the compiler. The default is to emit @code{mul}
20545 and not emit @code{div} and @code{mulx}.
20547 @item -mbmx
20548 @itemx -mno-bmx
20549 @itemx -mcdx
20550 @itemx -mno-cdx
20551 Enable or disable generation of Nios II R2 BMX (bit manipulation) and
20552 CDX (code density) instructions.  Enabling these instructions also
20553 requires @option{-march=r2}.  Since these instructions are optional
20554 extensions to the R2 architecture, the default is not to emit them.
20556 @item -mcustom-@var{insn}=@var{N}
20557 @itemx -mno-custom-@var{insn}
20558 @opindex mcustom-@var{insn}
20559 @opindex mno-custom-@var{insn}
20560 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
20561 custom instruction with encoding @var{N} when generating code that uses 
20562 @var{insn}.  For example, @option{-mcustom-fadds=253} generates custom
20563 instruction 253 for single-precision floating-point add operations instead
20564 of the default behavior of using a library call.
20566 The following values of @var{insn} are supported.  Except as otherwise
20567 noted, floating-point operations are expected to be implemented with
20568 normal IEEE 754 semantics and correspond directly to the C operators or the
20569 equivalent GCC built-in functions (@pxref{Other Builtins}).
20571 Single-precision floating point:
20572 @table @asis
20574 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
20575 Binary arithmetic operations.
20577 @item @samp{fnegs}
20578 Unary negation.
20580 @item @samp{fabss}
20581 Unary absolute value.
20583 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
20584 Comparison operations.
20586 @item @samp{fmins}, @samp{fmaxs}
20587 Floating-point minimum and maximum.  These instructions are only
20588 generated if @option{-ffinite-math-only} is specified.
20590 @item @samp{fsqrts}
20591 Unary square root operation.
20593 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
20594 Floating-point trigonometric and exponential functions.  These instructions
20595 are only generated if @option{-funsafe-math-optimizations} is also specified.
20597 @end table
20599 Double-precision floating point:
20600 @table @asis
20602 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
20603 Binary arithmetic operations.
20605 @item @samp{fnegd}
20606 Unary negation.
20608 @item @samp{fabsd}
20609 Unary absolute value.
20611 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
20612 Comparison operations.
20614 @item @samp{fmind}, @samp{fmaxd}
20615 Double-precision minimum and maximum.  These instructions are only
20616 generated if @option{-ffinite-math-only} is specified.
20618 @item @samp{fsqrtd}
20619 Unary square root operation.
20621 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
20622 Double-precision trigonometric and exponential functions.  These instructions
20623 are only generated if @option{-funsafe-math-optimizations} is also specified.
20625 @end table
20627 Conversions:
20628 @table @asis
20629 @item @samp{fextsd}
20630 Conversion from single precision to double precision.
20632 @item @samp{ftruncds}
20633 Conversion from double precision to single precision.
20635 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
20636 Conversion from floating point to signed or unsigned integer types, with
20637 truncation towards zero.
20639 @item @samp{round}
20640 Conversion from single-precision floating point to signed integer,
20641 rounding to the nearest integer and ties away from zero.
20642 This corresponds to the @code{__builtin_lroundf} function when
20643 @option{-fno-math-errno} is used.
20645 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
20646 Conversion from signed or unsigned integer types to floating-point types.
20648 @end table
20650 In addition, all of the following transfer instructions for internal
20651 registers X and Y must be provided to use any of the double-precision
20652 floating-point instructions.  Custom instructions taking two
20653 double-precision source operands expect the first operand in the
20654 64-bit register X.  The other operand (or only operand of a unary
20655 operation) is given to the custom arithmetic instruction with the
20656 least significant half in source register @var{src1} and the most
20657 significant half in @var{src2}.  A custom instruction that returns a
20658 double-precision result returns the most significant 32 bits in the
20659 destination register and the other half in 32-bit register Y.  
20660 GCC automatically generates the necessary code sequences to write
20661 register X and/or read register Y when double-precision floating-point
20662 instructions are used.
20664 @table @asis
20666 @item @samp{fwrx}
20667 Write @var{src1} into the least significant half of X and @var{src2} into
20668 the most significant half of X.
20670 @item @samp{fwry}
20671 Write @var{src1} into Y.
20673 @item @samp{frdxhi}, @samp{frdxlo}
20674 Read the most or least (respectively) significant half of X and store it in
20675 @var{dest}.
20677 @item @samp{frdy}
20678 Read the value of Y and store it into @var{dest}.
20679 @end table
20681 Note that you can gain more local control over generation of Nios II custom
20682 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
20683 and @code{target("no-custom-@var{insn}")} function attributes
20684 (@pxref{Function Attributes})
20685 or pragmas (@pxref{Function Specific Option Pragmas}).
20687 @item -mcustom-fpu-cfg=@var{name}
20688 @opindex mcustom-fpu-cfg
20690 This option enables a predefined, named set of custom instruction encodings
20691 (see @option{-mcustom-@var{insn}} above).  
20692 Currently, the following sets are defined:
20694 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
20695 @gccoptlist{-mcustom-fmuls=252 @gol
20696 -mcustom-fadds=253 @gol
20697 -mcustom-fsubs=254 @gol
20698 -fsingle-precision-constant}
20700 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
20701 @gccoptlist{-mcustom-fmuls=252 @gol
20702 -mcustom-fadds=253 @gol
20703 -mcustom-fsubs=254 @gol
20704 -mcustom-fdivs=255 @gol
20705 -fsingle-precision-constant}
20707 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
20708 @gccoptlist{-mcustom-floatus=243 @gol
20709 -mcustom-fixsi=244 @gol
20710 -mcustom-floatis=245 @gol
20711 -mcustom-fcmpgts=246 @gol
20712 -mcustom-fcmples=249 @gol
20713 -mcustom-fcmpeqs=250 @gol
20714 -mcustom-fcmpnes=251 @gol
20715 -mcustom-fmuls=252 @gol
20716 -mcustom-fadds=253 @gol
20717 -mcustom-fsubs=254 @gol
20718 -mcustom-fdivs=255 @gol
20719 -fsingle-precision-constant}
20721 Custom instruction assignments given by individual
20722 @option{-mcustom-@var{insn}=} options override those given by
20723 @option{-mcustom-fpu-cfg=}, regardless of the
20724 order of the options on the command line.
20726 Note that you can gain more local control over selection of a FPU
20727 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
20728 function attribute (@pxref{Function Attributes})
20729 or pragma (@pxref{Function Specific Option Pragmas}).
20731 @end table
20733 These additional @samp{-m} options are available for the Altera Nios II
20734 ELF (bare-metal) target:
20736 @table @gcctabopt
20738 @item -mhal
20739 @opindex mhal
20740 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
20741 startup and termination code, and is typically used in conjunction with
20742 @option{-msys-crt0=} to specify the location of the alternate startup code
20743 provided by the HAL BSP.
20745 @item -msmallc
20746 @opindex msmallc
20747 Link with a limited version of the C library, @option{-lsmallc}, rather than
20748 Newlib.
20750 @item -msys-crt0=@var{startfile}
20751 @opindex msys-crt0
20752 @var{startfile} is the file name of the startfile (crt0) to use 
20753 when linking.  This option is only useful in conjunction with @option{-mhal}.
20755 @item -msys-lib=@var{systemlib}
20756 @opindex msys-lib
20757 @var{systemlib} is the library name of the library that provides
20758 low-level system calls required by the C library,
20759 e.g. @code{read} and @code{write}.
20760 This option is typically used to link with a library provided by a HAL BSP.
20762 @end table
20764 @node Nvidia PTX Options
20765 @subsection Nvidia PTX Options
20766 @cindex Nvidia PTX options
20767 @cindex nvptx options
20769 These options are defined for Nvidia PTX:
20771 @table @gcctabopt
20773 @item -m32
20774 @itemx -m64
20775 @opindex m32
20776 @opindex m64
20777 Generate code for 32-bit or 64-bit ABI.
20779 @item -mmainkernel
20780 @opindex mmainkernel
20781 Link in code for a __main kernel.  This is for stand-alone instead of
20782 offloading execution.
20784 @item -moptimize
20785 @opindex moptimize
20786 Apply partitioned execution optimizations.  This is the default when any
20787 level of optimization is selected.
20789 @item -msoft-stack
20790 @opindex msoft-stack
20791 Generate code that does not use @code{.local} memory
20792 directly for stack storage. Instead, a per-warp stack pointer is
20793 maintained explicitly. This enables variable-length stack allocation (with
20794 variable-length arrays or @code{alloca}), and when global memory is used for
20795 underlying storage, makes it possible to access automatic variables from other
20796 threads, or with atomic instructions. This code generation variant is used
20797 for OpenMP offloading, but the option is exposed on its own for the purpose
20798 of testing the compiler; to generate code suitable for linking into programs
20799 using OpenMP offloading, use option @option{-mgomp}.
20801 @item -muniform-simt
20802 @opindex muniform-simt
20803 Switch to code generation variant that allows to execute all threads in each
20804 warp, while maintaining memory state and side effects as if only one thread
20805 in each warp was active outside of OpenMP SIMD regions.  All atomic operations
20806 and calls to runtime (malloc, free, vprintf) are conditionally executed (iff
20807 current lane index equals the master lane index), and the register being
20808 assigned is copied via a shuffle instruction from the master lane.  Outside of
20809 SIMD regions lane 0 is the master; inside, each thread sees itself as the
20810 master.  Shared memory array @code{int __nvptx_uni[]} stores all-zeros or
20811 all-ones bitmasks for each warp, indicating current mode (0 outside of SIMD
20812 regions).  Each thread can bitwise-and the bitmask at position @code{tid.y}
20813 with current lane index to compute the master lane index.
20815 @item -mgomp
20816 @opindex mgomp
20817 Generate code for use in OpenMP offloading: enables @option{-msoft-stack} and
20818 @option{-muniform-simt} options, and selects corresponding multilib variant.
20820 @end table
20822 @node PDP-11 Options
20823 @subsection PDP-11 Options
20824 @cindex PDP-11 Options
20826 These options are defined for the PDP-11:
20828 @table @gcctabopt
20829 @item -mfpu
20830 @opindex mfpu
20831 Use hardware FPP floating point.  This is the default.  (FIS floating
20832 point on the PDP-11/40 is not supported.)
20834 @item -msoft-float
20835 @opindex msoft-float
20836 Do not use hardware floating point.
20838 @item -mac0
20839 @opindex mac0
20840 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
20842 @item -mno-ac0
20843 @opindex mno-ac0
20844 Return floating-point results in memory.  This is the default.
20846 @item -m40
20847 @opindex m40
20848 Generate code for a PDP-11/40.
20850 @item -m45
20851 @opindex m45
20852 Generate code for a PDP-11/45.  This is the default.
20854 @item -m10
20855 @opindex m10
20856 Generate code for a PDP-11/10.
20858 @item -mbcopy-builtin
20859 @opindex mbcopy-builtin
20860 Use inline @code{movmemhi} patterns for copying memory.  This is the
20861 default.
20863 @item -mbcopy
20864 @opindex mbcopy
20865 Do not use inline @code{movmemhi} patterns for copying memory.
20867 @item -mint16
20868 @itemx -mno-int32
20869 @opindex mint16
20870 @opindex mno-int32
20871 Use 16-bit @code{int}.  This is the default.
20873 @item -mint32
20874 @itemx -mno-int16
20875 @opindex mint32
20876 @opindex mno-int16
20877 Use 32-bit @code{int}.
20879 @item -mfloat64
20880 @itemx -mno-float32
20881 @opindex mfloat64
20882 @opindex mno-float32
20883 Use 64-bit @code{float}.  This is the default.
20885 @item -mfloat32
20886 @itemx -mno-float64
20887 @opindex mfloat32
20888 @opindex mno-float64
20889 Use 32-bit @code{float}.
20891 @item -mabshi
20892 @opindex mabshi
20893 Use @code{abshi2} pattern.  This is the default.
20895 @item -mno-abshi
20896 @opindex mno-abshi
20897 Do not use @code{abshi2} pattern.
20899 @item -mbranch-expensive
20900 @opindex mbranch-expensive
20901 Pretend that branches are expensive.  This is for experimenting with
20902 code generation only.
20904 @item -mbranch-cheap
20905 @opindex mbranch-cheap
20906 Do not pretend that branches are expensive.  This is the default.
20908 @item -munix-asm
20909 @opindex munix-asm
20910 Use Unix assembler syntax.  This is the default when configured for
20911 @samp{pdp11-*-bsd}.
20913 @item -mdec-asm
20914 @opindex mdec-asm
20915 Use DEC assembler syntax.  This is the default when configured for any
20916 PDP-11 target other than @samp{pdp11-*-bsd}.
20917 @end table
20919 @node picoChip Options
20920 @subsection picoChip Options
20921 @cindex picoChip options
20923 These @samp{-m} options are defined for picoChip implementations:
20925 @table @gcctabopt
20927 @item -mae=@var{ae_type}
20928 @opindex mcpu
20929 Set the instruction set, register set, and instruction scheduling
20930 parameters for array element type @var{ae_type}.  Supported values
20931 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
20933 @option{-mae=ANY} selects a completely generic AE type.  Code
20934 generated with this option runs on any of the other AE types.  The
20935 code is not as efficient as it would be if compiled for a specific
20936 AE type, and some types of operation (e.g., multiplication) do not
20937 work properly on all types of AE.
20939 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
20940 for compiled code, and is the default.
20942 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
20943 option may suffer from poor performance of byte (char) manipulation,
20944 since the DSP AE does not provide hardware support for byte load/stores.
20946 @item -msymbol-as-address
20947 Enable the compiler to directly use a symbol name as an address in a
20948 load/store instruction, without first loading it into a
20949 register.  Typically, the use of this option generates larger
20950 programs, which run faster than when the option isn't used.  However, the
20951 results vary from program to program, so it is left as a user option,
20952 rather than being permanently enabled.
20954 @item -mno-inefficient-warnings
20955 Disables warnings about the generation of inefficient code.  These
20956 warnings can be generated, for example, when compiling code that
20957 performs byte-level memory operations on the MAC AE type.  The MAC AE has
20958 no hardware support for byte-level memory operations, so all byte
20959 load/stores must be synthesized from word load/store operations.  This is
20960 inefficient and a warning is generated to indicate
20961 that you should rewrite the code to avoid byte operations, or to target
20962 an AE type that has the necessary hardware support.  This option disables
20963 these warnings.
20965 @end table
20967 @node PowerPC Options
20968 @subsection PowerPC Options
20969 @cindex PowerPC options
20971 These are listed under @xref{RS/6000 and PowerPC Options}.
20973 @node RISC-V Options
20974 @subsection RISC-V Options
20975 @cindex RISC-V Options
20977 These command-line options are defined for RISC-V targets:
20979 @table @gcctabopt
20980 @item -mbranch-cost=@var{n}
20981 @opindex mbranch-cost
20982 Set the cost of branches to roughly @var{n} instructions.
20984 @item -mmemcpy
20985 @itemx -mno-memcpy
20986 @opindex mmemcpy
20987 Don't optimize block moves.
20989 @item -mplt
20990 @itemx -mno-plt
20991 @opindex plt
20992 When generating PIC code, allow the use of PLTs. Ignored for non-PIC.
20994 @item -mabi=@var{ABI-string}
20995 @opindex mabi
20996 Specify integer and floating-point calling convention.  This defaults to the
20997 natural calling convention: e.g.@ LP64 for RV64I, ILP32 for RV32I, LP64D for
20998 RV64G.
21000 @item -mfdiv
21001 @itemx -mno-fdiv
21002 @opindex mfdiv
21003 Use hardware floating-point divide and square root instructions.  This requires
21004 the F or D extensions for floating-point registers.
21006 @item -mdiv
21007 @itemx -mno-div
21008 @opindex mdiv
21009 Use hardware instructions for integer division.  This requires the M extension.
21011 @item -march=@var{ISA-string}
21012 @opindex march
21013 Generate code for given RISC-V ISA (e.g.@ @samp{rv64im}).  ISA strings must be
21014 lower-case.  Examples include @samp{rv64i}, @samp{rv32g}, and @samp{rv32imaf}.
21016 @item -mtune=@var{processor-string}
21017 @opindex mtune
21018 Optimize the output for the given processor, specified by microarchitecture
21019 name.
21021 @item -msmall-data-limit=@var{n}
21022 @opindex msmall-data-limit
21023 Put global and static data smaller than @var{n} bytes into a special section
21024 (on some targets).
21026 @item -msave-restore
21027 @itemx -mno-save-restore
21028 @opindex msave-restore
21029 Use smaller but slower prologue and epilogue code.
21031 @item -mstrict-align
21032 @itemx -mno-strict-align
21033 @opindex mstrict-align
21034 Do not generate unaligned memory accesses.
21036 @item -mcmodel=@var{code-model}
21037 @opindex mcmodel
21038 Specify the code model.
21040 @end table
21042 @node RL78 Options
21043 @subsection RL78 Options
21044 @cindex RL78 Options
21046 @table @gcctabopt
21048 @item -msim
21049 @opindex msim
21050 Links in additional target libraries to support operation within a
21051 simulator.
21053 @item -mmul=none
21054 @itemx -mmul=g10
21055 @itemx -mmul=g13
21056 @itemx -mmul=g14
21057 @itemx -mmul=rl78
21058 @opindex mmul
21059 Specifies the type of hardware multiplication and division support to
21060 be used.  The simplest is @code{none}, which uses software for both
21061 multiplication and division.  This is the default.  The @code{g13}
21062 value is for the hardware multiply/divide peripheral found on the
21063 RL78/G13 (S2 core) targets.  The @code{g14} value selects the use of
21064 the multiplication and division instructions supported by the RL78/G14
21065 (S3 core) parts.  The value @code{rl78} is an alias for @code{g14} and
21066 the value @code{mg10} is an alias for @code{none}.
21068 In addition a C preprocessor macro is defined, based upon the setting
21069 of this option.  Possible values are: @code{__RL78_MUL_NONE__},
21070 @code{__RL78_MUL_G13__} or @code{__RL78_MUL_G14__}.
21072 @item -mcpu=g10
21073 @itemx -mcpu=g13
21074 @itemx -mcpu=g14
21075 @itemx -mcpu=rl78
21076 @opindex mcpu
21077 Specifies the RL78 core to target.  The default is the G14 core, also
21078 known as an S3 core or just RL78.  The G13 or S2 core does not have
21079 multiply or divide instructions, instead it uses a hardware peripheral
21080 for these operations.  The G10 or S1 core does not have register
21081 banks, so it uses a different calling convention.
21083 If this option is set it also selects the type of hardware multiply
21084 support to use, unless this is overridden by an explicit
21085 @option{-mmul=none} option on the command line.  Thus specifying
21086 @option{-mcpu=g13} enables the use of the G13 hardware multiply
21087 peripheral and specifying @option{-mcpu=g10} disables the use of
21088 hardware multiplications altogether.
21090 Note, although the RL78/G14 core is the default target, specifying
21091 @option{-mcpu=g14} or @option{-mcpu=rl78} on the command line does
21092 change the behavior of the toolchain since it also enables G14
21093 hardware multiply support.  If these options are not specified on the
21094 command line then software multiplication routines will be used even
21095 though the code targets the RL78 core.  This is for backwards
21096 compatibility with older toolchains which did not have hardware
21097 multiply and divide support.
21099 In addition a C preprocessor macro is defined, based upon the setting
21100 of this option.  Possible values are: @code{__RL78_G10__},
21101 @code{__RL78_G13__} or @code{__RL78_G14__}.
21103 @item -mg10
21104 @itemx -mg13
21105 @itemx -mg14
21106 @itemx -mrl78
21107 @opindex mg10
21108 @opindex mg13
21109 @opindex mg14
21110 @opindex mrl78
21111 These are aliases for the corresponding @option{-mcpu=} option.  They
21112 are provided for backwards compatibility.
21114 @item -mallregs
21115 @opindex mallregs
21116 Allow the compiler to use all of the available registers.  By default
21117 registers @code{r24..r31} are reserved for use in interrupt handlers.
21118 With this option enabled these registers can be used in ordinary
21119 functions as well.
21121 @item -m64bit-doubles
21122 @itemx -m32bit-doubles
21123 @opindex m64bit-doubles
21124 @opindex m32bit-doubles
21125 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
21126 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
21127 @option{-m32bit-doubles}.
21129 @item -msave-mduc-in-interrupts
21130 @item -mno-save-mduc-in-interrupts
21131 @opindex msave-mduc-in-interrupts
21132 @opindex mno-save-mduc-in-interrupts
21133 Specifies that interrupt handler functions should preserve the
21134 MDUC registers.  This is only necessary if normal code might use
21135 the MDUC registers, for example because it performs multiplication
21136 and division operations.  The default is to ignore the MDUC registers
21137 as this makes the interrupt handlers faster.  The target option -mg13
21138 needs to be passed for this to work as this feature is only available
21139 on the G13 target (S2 core).  The MDUC registers will only be saved
21140 if the interrupt handler performs a multiplication or division
21141 operation or it calls another function.
21143 @end table
21145 @node RS/6000 and PowerPC Options
21146 @subsection IBM RS/6000 and PowerPC Options
21147 @cindex RS/6000 and PowerPC Options
21148 @cindex IBM RS/6000 and PowerPC Options
21150 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
21151 @table @gcctabopt
21152 @item -mpowerpc-gpopt
21153 @itemx -mno-powerpc-gpopt
21154 @itemx -mpowerpc-gfxopt
21155 @itemx -mno-powerpc-gfxopt
21156 @need 800
21157 @itemx -mpowerpc64
21158 @itemx -mno-powerpc64
21159 @itemx -mmfcrf
21160 @itemx -mno-mfcrf
21161 @itemx -mpopcntb
21162 @itemx -mno-popcntb
21163 @itemx -mpopcntd
21164 @itemx -mno-popcntd
21165 @itemx -mfprnd
21166 @itemx -mno-fprnd
21167 @need 800
21168 @itemx -mcmpb
21169 @itemx -mno-cmpb
21170 @itemx -mmfpgpr
21171 @itemx -mno-mfpgpr
21172 @itemx -mhard-dfp
21173 @itemx -mno-hard-dfp
21174 @opindex mpowerpc-gpopt
21175 @opindex mno-powerpc-gpopt
21176 @opindex mpowerpc-gfxopt
21177 @opindex mno-powerpc-gfxopt
21178 @opindex mpowerpc64
21179 @opindex mno-powerpc64
21180 @opindex mmfcrf
21181 @opindex mno-mfcrf
21182 @opindex mpopcntb
21183 @opindex mno-popcntb
21184 @opindex mpopcntd
21185 @opindex mno-popcntd
21186 @opindex mfprnd
21187 @opindex mno-fprnd
21188 @opindex mcmpb
21189 @opindex mno-cmpb
21190 @opindex mmfpgpr
21191 @opindex mno-mfpgpr
21192 @opindex mhard-dfp
21193 @opindex mno-hard-dfp
21194 You use these options to specify which instructions are available on the
21195 processor you are using.  The default value of these options is
21196 determined when configuring GCC@.  Specifying the
21197 @option{-mcpu=@var{cpu_type}} overrides the specification of these
21198 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
21199 rather than the options listed above.
21201 Specifying @option{-mpowerpc-gpopt} allows
21202 GCC to use the optional PowerPC architecture instructions in the
21203 General Purpose group, including floating-point square root.  Specifying
21204 @option{-mpowerpc-gfxopt} allows GCC to
21205 use the optional PowerPC architecture instructions in the Graphics
21206 group, including floating-point select.
21208 The @option{-mmfcrf} option allows GCC to generate the move from
21209 condition register field instruction implemented on the POWER4
21210 processor and other processors that support the PowerPC V2.01
21211 architecture.
21212 The @option{-mpopcntb} option allows GCC to generate the popcount and
21213 double-precision FP reciprocal estimate instruction implemented on the
21214 POWER5 processor and other processors that support the PowerPC V2.02
21215 architecture.
21216 The @option{-mpopcntd} option allows GCC to generate the popcount
21217 instruction implemented on the POWER7 processor and other processors
21218 that support the PowerPC V2.06 architecture.
21219 The @option{-mfprnd} option allows GCC to generate the FP round to
21220 integer instructions implemented on the POWER5+ processor and other
21221 processors that support the PowerPC V2.03 architecture.
21222 The @option{-mcmpb} option allows GCC to generate the compare bytes
21223 instruction implemented on the POWER6 processor and other processors
21224 that support the PowerPC V2.05 architecture.
21225 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
21226 general-purpose register instructions implemented on the POWER6X
21227 processor and other processors that support the extended PowerPC V2.05
21228 architecture.
21229 The @option{-mhard-dfp} option allows GCC to generate the decimal
21230 floating-point instructions implemented on some POWER processors.
21232 The @option{-mpowerpc64} option allows GCC to generate the additional
21233 64-bit instructions that are found in the full PowerPC64 architecture
21234 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
21235 @option{-mno-powerpc64}.
21237 @item -mcpu=@var{cpu_type}
21238 @opindex mcpu
21239 Set architecture type, register usage, and
21240 instruction scheduling parameters for machine type @var{cpu_type}.
21241 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
21242 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
21243 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
21244 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
21245 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
21246 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
21247 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
21248 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
21249 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
21250 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8},
21251 @samp{power9}, @samp{powerpc}, @samp{powerpc64}, @samp{powerpc64le},
21252 and @samp{rs64}.
21254 @option{-mcpu=powerpc}, @option{-mcpu=powerpc64}, and
21255 @option{-mcpu=powerpc64le} specify pure 32-bit PowerPC (either
21256 endian), 64-bit big endian PowerPC and 64-bit little endian PowerPC
21257 architecture machine types, with an appropriate, generic processor
21258 model assumed for scheduling purposes.
21260 The other options specify a specific processor.  Code generated under
21261 those options runs best on that processor, and may not run at all on
21262 others.
21264 The @option{-mcpu} options automatically enable or disable the
21265 following options:
21267 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
21268 -mpopcntb -mpopcntd  -mpowerpc64 @gol
21269 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
21270 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
21271 -mcrypto -mdirect-move -mhtm -mpower8-fusion -mpower8-vector @gol
21272 -mquad-memory -mquad-memory-atomic -mfloat128 -mfloat128-hardware}
21274 The particular options set for any particular CPU varies between
21275 compiler versions, depending on what setting seems to produce optimal
21276 code for that CPU; it doesn't necessarily reflect the actual hardware's
21277 capabilities.  If you wish to set an individual option to a particular
21278 value, you may specify it after the @option{-mcpu} option, like
21279 @option{-mcpu=970 -mno-altivec}.
21281 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
21282 not enabled or disabled by the @option{-mcpu} option at present because
21283 AIX does not have full support for these options.  You may still
21284 enable or disable them individually if you're sure it'll work in your
21285 environment.
21287 @item -mtune=@var{cpu_type}
21288 @opindex mtune
21289 Set the instruction scheduling parameters for machine type
21290 @var{cpu_type}, but do not set the architecture type or register usage,
21291 as @option{-mcpu=@var{cpu_type}} does.  The same
21292 values for @var{cpu_type} are used for @option{-mtune} as for
21293 @option{-mcpu}.  If both are specified, the code generated uses the
21294 architecture and registers set by @option{-mcpu}, but the
21295 scheduling parameters set by @option{-mtune}.
21297 @item -mcmodel=small
21298 @opindex mcmodel=small
21299 Generate PowerPC64 code for the small model: The TOC is limited to
21300 64k.
21302 @item -mcmodel=medium
21303 @opindex mcmodel=medium
21304 Generate PowerPC64 code for the medium model: The TOC and other static
21305 data may be up to a total of 4G in size.  This is the default for 64-bit
21306 Linux.
21308 @item -mcmodel=large
21309 @opindex mcmodel=large
21310 Generate PowerPC64 code for the large model: The TOC may be up to 4G
21311 in size.  Other data and code is only limited by the 64-bit address
21312 space.
21314 @item -maltivec
21315 @itemx -mno-altivec
21316 @opindex maltivec
21317 @opindex mno-altivec
21318 Generate code that uses (does not use) AltiVec instructions, and also
21319 enable the use of built-in functions that allow more direct access to
21320 the AltiVec instruction set.  You may also need to set
21321 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
21322 enhancements.
21324 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
21325 @option{-maltivec=be}, the element order for AltiVec intrinsics such
21326 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} 
21327 match array element order corresponding to the endianness of the
21328 target.  That is, element zero identifies the leftmost element in a
21329 vector register when targeting a big-endian platform, and identifies
21330 the rightmost element in a vector register when targeting a
21331 little-endian platform.
21333 @item -maltivec=be
21334 @opindex maltivec=be
21335 Generate AltiVec instructions using big-endian element order,
21336 regardless of whether the target is big- or little-endian.  This is
21337 the default when targeting a big-endian platform.
21339 The element order is used to interpret element numbers in AltiVec
21340 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
21341 @code{vec_insert}.  By default, these match array element order
21342 corresponding to the endianness for the target.
21344 @item -maltivec=le
21345 @opindex maltivec=le
21346 Generate AltiVec instructions using little-endian element order,
21347 regardless of whether the target is big- or little-endian.  This is
21348 the default when targeting a little-endian platform.  This option is
21349 currently ignored when targeting a big-endian platform.
21351 The element order is used to interpret element numbers in AltiVec
21352 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
21353 @code{vec_insert}.  By default, these match array element order
21354 corresponding to the endianness for the target.
21356 @item -mvrsave
21357 @itemx -mno-vrsave
21358 @opindex mvrsave
21359 @opindex mno-vrsave
21360 Generate VRSAVE instructions when generating AltiVec code.
21362 @item -msecure-plt
21363 @opindex msecure-plt
21364 Generate code that allows @command{ld} and @command{ld.so}
21365 to build executables and shared
21366 libraries with non-executable @code{.plt} and @code{.got} sections.
21367 This is a PowerPC
21368 32-bit SYSV ABI option.
21370 @item -mbss-plt
21371 @opindex mbss-plt
21372 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
21373 fills in, and
21374 requires @code{.plt} and @code{.got}
21375 sections that are both writable and executable.
21376 This is a PowerPC 32-bit SYSV ABI option.
21378 @item -misel
21379 @itemx -mno-isel
21380 @opindex misel
21381 @opindex mno-isel
21382 This switch enables or disables the generation of ISEL instructions.
21384 @item -misel=@var{yes/no}
21385 This switch has been deprecated.  Use @option{-misel} and
21386 @option{-mno-isel} instead.
21388 @item -mlra
21389 @opindex mlra
21390 Enable Local Register Allocation. By default the port uses LRA.
21391 (i.e. @option{-mno-lra}).
21393 @item -mspe
21394 @itemx -mno-spe
21395 @opindex mspe
21396 @opindex mno-spe
21397 This switch enables or disables the generation of SPE simd
21398 instructions.
21400 @item -mpaired
21401 @itemx -mno-paired
21402 @opindex mpaired
21403 @opindex mno-paired
21404 This switch enables or disables the generation of PAIRED simd
21405 instructions.
21407 @item -mspe=@var{yes/no}
21408 This option has been deprecated.  Use @option{-mspe} and
21409 @option{-mno-spe} instead.
21411 @item -mvsx
21412 @itemx -mno-vsx
21413 @opindex mvsx
21414 @opindex mno-vsx
21415 Generate code that uses (does not use) vector/scalar (VSX)
21416 instructions, and also enable the use of built-in functions that allow
21417 more direct access to the VSX instruction set.
21419 @item -mcrypto
21420 @itemx -mno-crypto
21421 @opindex mcrypto
21422 @opindex mno-crypto
21423 Enable the use (disable) of the built-in functions that allow direct
21424 access to the cryptographic instructions that were added in version
21425 2.07 of the PowerPC ISA.
21427 @item -mdirect-move
21428 @itemx -mno-direct-move
21429 @opindex mdirect-move
21430 @opindex mno-direct-move
21431 Generate code that uses (does not use) the instructions to move data
21432 between the general purpose registers and the vector/scalar (VSX)
21433 registers that were added in version 2.07 of the PowerPC ISA.
21435 @item -mhtm
21436 @itemx -mno-htm
21437 @opindex mhtm
21438 @opindex mno-htm
21439 Enable (disable) the use of the built-in functions that allow direct
21440 access to the Hardware Transactional Memory (HTM) instructions that
21441 were added in version 2.07 of the PowerPC ISA.
21443 @item -mpower8-fusion
21444 @itemx -mno-power8-fusion
21445 @opindex mpower8-fusion
21446 @opindex mno-power8-fusion
21447 Generate code that keeps (does not keeps) some integer operations
21448 adjacent so that the instructions can be fused together on power8 and
21449 later processors.
21451 @item -mpower8-vector
21452 @itemx -mno-power8-vector
21453 @opindex mpower8-vector
21454 @opindex mno-power8-vector
21455 Generate code that uses (does not use) the vector and scalar
21456 instructions that were added in version 2.07 of the PowerPC ISA.  Also
21457 enable the use of built-in functions that allow more direct access to
21458 the vector instructions.
21460 @item -mquad-memory
21461 @itemx -mno-quad-memory
21462 @opindex mquad-memory
21463 @opindex mno-quad-memory
21464 Generate code that uses (does not use) the non-atomic quad word memory
21465 instructions.  The @option{-mquad-memory} option requires use of
21466 64-bit mode.
21468 @item -mquad-memory-atomic
21469 @itemx -mno-quad-memory-atomic
21470 @opindex mquad-memory-atomic
21471 @opindex mno-quad-memory-atomic
21472 Generate code that uses (does not use) the atomic quad word memory
21473 instructions.  The @option{-mquad-memory-atomic} option requires use of
21474 64-bit mode.
21476 @item -mupper-regs-di
21477 @itemx -mno-upper-regs-di
21478 @opindex mupper-regs-di
21479 @opindex mno-upper-regs-di
21480 Generate code that uses (does not use) the scalar instructions that
21481 target all 64 registers in the vector/scalar floating point register
21482 set that were added in version 2.06 of the PowerPC ISA when processing
21483 integers.  @option{-mupper-regs-di} is turned on by default if you use
21484 any of the @option{-mcpu=power7}, @option{-mcpu=power8},
21485 @option{-mcpu=power9}, or @option{-mvsx} options.
21487 @item -mupper-regs-df
21488 @itemx -mno-upper-regs-df
21489 @opindex mupper-regs-df
21490 @opindex mno-upper-regs-df
21491 Generate code that uses (does not use) the scalar double precision
21492 instructions that target all 64 registers in the vector/scalar
21493 floating point register set that were added in version 2.06 of the
21494 PowerPC ISA.  @option{-mupper-regs-df} is turned on by default if you
21495 use any of the @option{-mcpu=power7}, @option{-mcpu=power8},
21496 @option{-mcpu=power9}, or @option{-mvsx} options.
21498 @item -mupper-regs-sf
21499 @itemx -mno-upper-regs-sf
21500 @opindex mupper-regs-sf
21501 @opindex mno-upper-regs-sf
21502 Generate code that uses (does not use) the scalar single precision
21503 instructions that target all 64 registers in the vector/scalar
21504 floating point register set that were added in version 2.07 of the
21505 PowerPC ISA.  @option{-mupper-regs-sf} is turned on by default if you
21506 use either of the @option{-mcpu=power8}, @option{-mpower8-vector}, or
21507 @option{-mcpu=power9} options.
21509 @item -mupper-regs
21510 @itemx -mno-upper-regs
21511 @opindex mupper-regs
21512 @opindex mno-upper-regs
21513 Generate code that uses (does not use) the scalar
21514 instructions that target all 64 registers in the vector/scalar
21515 floating point register set, depending on the model of the machine.
21517 If the @option{-mno-upper-regs} option is used, it turns off both
21518 @option{-mupper-regs-sf} and @option{-mupper-regs-df} options.
21520 @item -mfloat128
21521 @itemx -mno-float128
21522 @opindex mfloat128
21523 @opindex mno-float128
21524 Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point
21525 and use either software emulation for IEEE 128-bit floating point or
21526 hardware instructions.
21528 The VSX instruction set (@option{-mvsx}, @option{-mcpu=power7}, or
21529 @option{-mcpu=power8}) must be enabled to use the @option{-mfloat128}
21530 option.  The @option{-mfloat128} option only works on PowerPC 64-bit
21531 Linux systems.
21533 If you use the ISA 3.0 instruction set (@option{-mcpu=power9}), the
21534 @option{-mfloat128} option will also enable the generation of ISA 3.0
21535 IEEE 128-bit floating point instructions.  Otherwise, IEEE 128-bit
21536 floating point will be done with software emulation.
21538 @item -mfloat128-hardware
21539 @itemx -mno-float128-hardware
21540 @opindex mfloat128-hardware
21541 @opindex mno-float128-hardware
21542 Enable/disable using ISA 3.0 hardware instructions to support the
21543 @var{__float128} data type.
21545 If you use @option{-mfloat128-hardware}, it will enable the option
21546 @option{-mfloat128} as well.
21548 If you select ISA 3.0 instructions with @option{-mcpu=power9}, but do
21549 not use either @option{-mfloat128} or @option{-mfloat128-hardware},
21550 the IEEE 128-bit floating point support will not be enabled.
21552 @item -mfloat-gprs=@var{yes/single/double/no}
21553 @itemx -mfloat-gprs
21554 @opindex mfloat-gprs
21555 This switch enables or disables the generation of floating-point
21556 operations on the general-purpose registers for architectures that
21557 support it.
21559 The argument @samp{yes} or @samp{single} enables the use of
21560 single-precision floating-point operations.
21562 The argument @samp{double} enables the use of single and
21563 double-precision floating-point operations.
21565 The argument @samp{no} disables floating-point operations on the
21566 general-purpose registers.
21568 This option is currently only available on the MPC854x.
21570 @item -m32
21571 @itemx -m64
21572 @opindex m32
21573 @opindex m64
21574 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
21575 targets (including GNU/Linux).  The 32-bit environment sets int, long
21576 and pointer to 32 bits and generates code that runs on any PowerPC
21577 variant.  The 64-bit environment sets int to 32 bits and long and
21578 pointer to 64 bits, and generates code for PowerPC64, as for
21579 @option{-mpowerpc64}.
21581 @item -mfull-toc
21582 @itemx -mno-fp-in-toc
21583 @itemx -mno-sum-in-toc
21584 @itemx -mminimal-toc
21585 @opindex mfull-toc
21586 @opindex mno-fp-in-toc
21587 @opindex mno-sum-in-toc
21588 @opindex mminimal-toc
21589 Modify generation of the TOC (Table Of Contents), which is created for
21590 every executable file.  The @option{-mfull-toc} option is selected by
21591 default.  In that case, GCC allocates at least one TOC entry for
21592 each unique non-automatic variable reference in your program.  GCC
21593 also places floating-point constants in the TOC@.  However, only
21594 16,384 entries are available in the TOC@.
21596 If you receive a linker error message that saying you have overflowed
21597 the available TOC space, you can reduce the amount of TOC space used
21598 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
21599 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
21600 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
21601 generate code to calculate the sum of an address and a constant at
21602 run time instead of putting that sum into the TOC@.  You may specify one
21603 or both of these options.  Each causes GCC to produce very slightly
21604 slower and larger code at the expense of conserving TOC space.
21606 If you still run out of space in the TOC even when you specify both of
21607 these options, specify @option{-mminimal-toc} instead.  This option causes
21608 GCC to make only one TOC entry for every file.  When you specify this
21609 option, GCC produces code that is slower and larger but which
21610 uses extremely little TOC space.  You may wish to use this option
21611 only on files that contain less frequently-executed code.
21613 @item -maix64
21614 @itemx -maix32
21615 @opindex maix64
21616 @opindex maix32
21617 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
21618 @code{long} type, and the infrastructure needed to support them.
21619 Specifying @option{-maix64} implies @option{-mpowerpc64},
21620 while @option{-maix32} disables the 64-bit ABI and
21621 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
21623 @item -mxl-compat
21624 @itemx -mno-xl-compat
21625 @opindex mxl-compat
21626 @opindex mno-xl-compat
21627 Produce code that conforms more closely to IBM XL compiler semantics
21628 when using AIX-compatible ABI@.  Pass floating-point arguments to
21629 prototyped functions beyond the register save area (RSA) on the stack
21630 in addition to argument FPRs.  Do not assume that most significant
21631 double in 128-bit long double value is properly rounded when comparing
21632 values and converting to double.  Use XL symbol names for long double
21633 support routines.
21635 The AIX calling convention was extended but not initially documented to
21636 handle an obscure K&R C case of calling a function that takes the
21637 address of its arguments with fewer arguments than declared.  IBM XL
21638 compilers access floating-point arguments that do not fit in the
21639 RSA from the stack when a subroutine is compiled without
21640 optimization.  Because always storing floating-point arguments on the
21641 stack is inefficient and rarely needed, this option is not enabled by
21642 default and only is necessary when calling subroutines compiled by IBM
21643 XL compilers without optimization.
21645 @item -mpe
21646 @opindex mpe
21647 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
21648 application written to use message passing with special startup code to
21649 enable the application to run.  The system must have PE installed in the
21650 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
21651 must be overridden with the @option{-specs=} option to specify the
21652 appropriate directory location.  The Parallel Environment does not
21653 support threads, so the @option{-mpe} option and the @option{-pthread}
21654 option are incompatible.
21656 @item -malign-natural
21657 @itemx -malign-power
21658 @opindex malign-natural
21659 @opindex malign-power
21660 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
21661 @option{-malign-natural} overrides the ABI-defined alignment of larger
21662 types, such as floating-point doubles, on their natural size-based boundary.
21663 The option @option{-malign-power} instructs GCC to follow the ABI-specified
21664 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
21666 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
21667 is not supported.
21669 @item -msoft-float
21670 @itemx -mhard-float
21671 @opindex msoft-float
21672 @opindex mhard-float
21673 Generate code that does not use (uses) the floating-point register set.
21674 Software floating-point emulation is provided if you use the
21675 @option{-msoft-float} option, and pass the option to GCC when linking.
21677 @item -msingle-float
21678 @itemx -mdouble-float
21679 @opindex msingle-float
21680 @opindex mdouble-float
21681 Generate code for single- or double-precision floating-point operations.
21682 @option{-mdouble-float} implies @option{-msingle-float}.
21684 @item -msimple-fpu
21685 @opindex msimple-fpu
21686 Do not generate @code{sqrt} and @code{div} instructions for hardware
21687 floating-point unit.
21689 @item -mfpu=@var{name}
21690 @opindex mfpu
21691 Specify type of floating-point unit.  Valid values for @var{name} are
21692 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
21693 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
21694 @samp{sp_full} (equivalent to @option{-msingle-float}),
21695 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
21697 @item -mxilinx-fpu
21698 @opindex mxilinx-fpu
21699 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
21701 @item -mmultiple
21702 @itemx -mno-multiple
21703 @opindex mmultiple
21704 @opindex mno-multiple
21705 Generate code that uses (does not use) the load multiple word
21706 instructions and the store multiple word instructions.  These
21707 instructions are generated by default on POWER systems, and not
21708 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
21709 PowerPC systems, since those instructions do not work when the
21710 processor is in little-endian mode.  The exceptions are PPC740 and
21711 PPC750 which permit these instructions in little-endian mode.
21713 @item -mstring
21714 @itemx -mno-string
21715 @opindex mstring
21716 @opindex mno-string
21717 Generate code that uses (does not use) the load string instructions
21718 and the store string word instructions to save multiple registers and
21719 do small block moves.  These instructions are generated by default on
21720 POWER systems, and not generated on PowerPC systems.  Do not use
21721 @option{-mstring} on little-endian PowerPC systems, since those
21722 instructions do not work when the processor is in little-endian mode.
21723 The exceptions are PPC740 and PPC750 which permit these instructions
21724 in little-endian mode.
21726 @item -mupdate
21727 @itemx -mno-update
21728 @opindex mupdate
21729 @opindex mno-update
21730 Generate code that uses (does not use) the load or store instructions
21731 that update the base register to the address of the calculated memory
21732 location.  These instructions are generated by default.  If you use
21733 @option{-mno-update}, there is a small window between the time that the
21734 stack pointer is updated and the address of the previous frame is
21735 stored, which means code that walks the stack frame across interrupts or
21736 signals may get corrupted data.
21738 @item -mavoid-indexed-addresses
21739 @itemx -mno-avoid-indexed-addresses
21740 @opindex mavoid-indexed-addresses
21741 @opindex mno-avoid-indexed-addresses
21742 Generate code that tries to avoid (not avoid) the use of indexed load
21743 or store instructions. These instructions can incur a performance
21744 penalty on Power6 processors in certain situations, such as when
21745 stepping through large arrays that cross a 16M boundary.  This option
21746 is enabled by default when targeting Power6 and disabled otherwise.
21748 @item -mfused-madd
21749 @itemx -mno-fused-madd
21750 @opindex mfused-madd
21751 @opindex mno-fused-madd
21752 Generate code that uses (does not use) the floating-point multiply and
21753 accumulate instructions.  These instructions are generated by default
21754 if hardware floating point is used.  The machine-dependent
21755 @option{-mfused-madd} option is now mapped to the machine-independent
21756 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
21757 mapped to @option{-ffp-contract=off}.
21759 @item -mmulhw
21760 @itemx -mno-mulhw
21761 @opindex mmulhw
21762 @opindex mno-mulhw
21763 Generate code that uses (does not use) the half-word multiply and
21764 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
21765 These instructions are generated by default when targeting those
21766 processors.
21768 @item -mdlmzb
21769 @itemx -mno-dlmzb
21770 @opindex mdlmzb
21771 @opindex mno-dlmzb
21772 Generate code that uses (does not use) the string-search @samp{dlmzb}
21773 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
21774 generated by default when targeting those processors.
21776 @item -mno-bit-align
21777 @itemx -mbit-align
21778 @opindex mno-bit-align
21779 @opindex mbit-align
21780 On System V.4 and embedded PowerPC systems do not (do) force structures
21781 and unions that contain bit-fields to be aligned to the base type of the
21782 bit-field.
21784 For example, by default a structure containing nothing but 8
21785 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
21786 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
21787 the structure is aligned to a 1-byte boundary and is 1 byte in
21788 size.
21790 @item -mno-strict-align
21791 @itemx -mstrict-align
21792 @opindex mno-strict-align
21793 @opindex mstrict-align
21794 On System V.4 and embedded PowerPC systems do not (do) assume that
21795 unaligned memory references are handled by the system.
21797 @item -mrelocatable
21798 @itemx -mno-relocatable
21799 @opindex mrelocatable
21800 @opindex mno-relocatable
21801 Generate code that allows (does not allow) a static executable to be
21802 relocated to a different address at run time.  A simple embedded
21803 PowerPC system loader should relocate the entire contents of
21804 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
21805 a table of 32-bit addresses generated by this option.  For this to
21806 work, all objects linked together must be compiled with
21807 @option{-mrelocatable} or @option{-mrelocatable-lib}.
21808 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
21810 @item -mrelocatable-lib
21811 @itemx -mno-relocatable-lib
21812 @opindex mrelocatable-lib
21813 @opindex mno-relocatable-lib
21814 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
21815 @code{.fixup} section to allow static executables to be relocated at
21816 run time, but @option{-mrelocatable-lib} does not use the smaller stack
21817 alignment of @option{-mrelocatable}.  Objects compiled with
21818 @option{-mrelocatable-lib} may be linked with objects compiled with
21819 any combination of the @option{-mrelocatable} options.
21821 @item -mno-toc
21822 @itemx -mtoc
21823 @opindex mno-toc
21824 @opindex mtoc
21825 On System V.4 and embedded PowerPC systems do not (do) assume that
21826 register 2 contains a pointer to a global area pointing to the addresses
21827 used in the program.
21829 @item -mlittle
21830 @itemx -mlittle-endian
21831 @opindex mlittle
21832 @opindex mlittle-endian
21833 On System V.4 and embedded PowerPC systems compile code for the
21834 processor in little-endian mode.  The @option{-mlittle-endian} option is
21835 the same as @option{-mlittle}.
21837 @item -mbig
21838 @itemx -mbig-endian
21839 @opindex mbig
21840 @opindex mbig-endian
21841 On System V.4 and embedded PowerPC systems compile code for the
21842 processor in big-endian mode.  The @option{-mbig-endian} option is
21843 the same as @option{-mbig}.
21845 @item -mdynamic-no-pic
21846 @opindex mdynamic-no-pic
21847 On Darwin and Mac OS X systems, compile code so that it is not
21848 relocatable, but that its external references are relocatable.  The
21849 resulting code is suitable for applications, but not shared
21850 libraries.
21852 @item -msingle-pic-base
21853 @opindex msingle-pic-base
21854 Treat the register used for PIC addressing as read-only, rather than
21855 loading it in the prologue for each function.  The runtime system is
21856 responsible for initializing this register with an appropriate value
21857 before execution begins.
21859 @item -mprioritize-restricted-insns=@var{priority}
21860 @opindex mprioritize-restricted-insns
21861 This option controls the priority that is assigned to
21862 dispatch-slot restricted instructions during the second scheduling
21863 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
21864 or @samp{2} to assign no, highest, or second-highest (respectively) 
21865 priority to dispatch-slot restricted
21866 instructions.
21868 @item -msched-costly-dep=@var{dependence_type}
21869 @opindex msched-costly-dep
21870 This option controls which dependences are considered costly
21871 by the target during instruction scheduling.  The argument
21872 @var{dependence_type} takes one of the following values:
21874 @table @asis
21875 @item @samp{no}
21876 No dependence is costly.
21878 @item @samp{all}
21879 All dependences are costly.
21881 @item @samp{true_store_to_load}
21882 A true dependence from store to load is costly.
21884 @item @samp{store_to_load}
21885 Any dependence from store to load is costly.
21887 @item @var{number}
21888 Any dependence for which the latency is greater than or equal to 
21889 @var{number} is costly.
21890 @end table
21892 @item -minsert-sched-nops=@var{scheme}
21893 @opindex minsert-sched-nops
21894 This option controls which NOP insertion scheme is used during
21895 the second scheduling pass.  The argument @var{scheme} takes one of the
21896 following values:
21898 @table @asis
21899 @item @samp{no}
21900 Don't insert NOPs.
21902 @item @samp{pad}
21903 Pad with NOPs any dispatch group that has vacant issue slots,
21904 according to the scheduler's grouping.
21906 @item @samp{regroup_exact}
21907 Insert NOPs to force costly dependent insns into
21908 separate groups.  Insert exactly as many NOPs as needed to force an insn
21909 to a new group, according to the estimated processor grouping.
21911 @item @var{number}
21912 Insert NOPs to force costly dependent insns into
21913 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
21914 @end table
21916 @item -mcall-sysv
21917 @opindex mcall-sysv
21918 On System V.4 and embedded PowerPC systems compile code using calling
21919 conventions that adhere to the March 1995 draft of the System V
21920 Application Binary Interface, PowerPC processor supplement.  This is the
21921 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
21923 @item -mcall-sysv-eabi
21924 @itemx -mcall-eabi
21925 @opindex mcall-sysv-eabi
21926 @opindex mcall-eabi
21927 Specify both @option{-mcall-sysv} and @option{-meabi} options.
21929 @item -mcall-sysv-noeabi
21930 @opindex mcall-sysv-noeabi
21931 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
21933 @item -mcall-aixdesc
21934 @opindex m
21935 On System V.4 and embedded PowerPC systems compile code for the AIX
21936 operating system.
21938 @item -mcall-linux
21939 @opindex mcall-linux
21940 On System V.4 and embedded PowerPC systems compile code for the
21941 Linux-based GNU system.
21943 @item -mcall-freebsd
21944 @opindex mcall-freebsd
21945 On System V.4 and embedded PowerPC systems compile code for the
21946 FreeBSD operating system.
21948 @item -mcall-netbsd
21949 @opindex mcall-netbsd
21950 On System V.4 and embedded PowerPC systems compile code for the
21951 NetBSD operating system.
21953 @item -mcall-openbsd
21954 @opindex mcall-netbsd
21955 On System V.4 and embedded PowerPC systems compile code for the
21956 OpenBSD operating system.
21958 @item -maix-struct-return
21959 @opindex maix-struct-return
21960 Return all structures in memory (as specified by the AIX ABI)@.
21962 @item -msvr4-struct-return
21963 @opindex msvr4-struct-return
21964 Return structures smaller than 8 bytes in registers (as specified by the
21965 SVR4 ABI)@.
21967 @item -mabi=@var{abi-type}
21968 @opindex mabi
21969 Extend the current ABI with a particular extension, or remove such extension.
21970 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
21971 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
21972 @samp{elfv1}, @samp{elfv2}@.
21974 @item -mabi=spe
21975 @opindex mabi=spe
21976 Extend the current ABI with SPE ABI extensions.  This does not change
21977 the default ABI, instead it adds the SPE ABI extensions to the current
21978 ABI@.
21980 @item -mabi=no-spe
21981 @opindex mabi=no-spe
21982 Disable Book-E SPE ABI extensions for the current ABI@.
21984 @item -mabi=ibmlongdouble
21985 @opindex mabi=ibmlongdouble
21986 Change the current ABI to use IBM extended-precision long double.
21987 This is a PowerPC 32-bit SYSV ABI option.
21989 @item -mabi=ieeelongdouble
21990 @opindex mabi=ieeelongdouble
21991 Change the current ABI to use IEEE extended-precision long double.
21992 This is a PowerPC 32-bit Linux ABI option.
21994 @item -mabi=elfv1
21995 @opindex mabi=elfv1
21996 Change the current ABI to use the ELFv1 ABI.
21997 This is the default ABI for big-endian PowerPC 64-bit Linux.
21998 Overriding the default ABI requires special system support and is
21999 likely to fail in spectacular ways.
22001 @item -mabi=elfv2
22002 @opindex mabi=elfv2
22003 Change the current ABI to use the ELFv2 ABI.
22004 This is the default ABI for little-endian PowerPC 64-bit Linux.
22005 Overriding the default ABI requires special system support and is
22006 likely to fail in spectacular ways.
22008 @item -mgnu-attribute
22009 @itemx -mno-gnu-attribute
22010 @opindex mgnu-attribute
22011 @opindex mno-gnu-attribute
22012 Emit .gnu_attribute assembly directives to set tag/value pairs in a
22013 .gnu.attributes section that specify ABI variations in function
22014 parameters or return values.
22016 @item -mprototype
22017 @itemx -mno-prototype
22018 @opindex mprototype
22019 @opindex mno-prototype
22020 On System V.4 and embedded PowerPC systems assume that all calls to
22021 variable argument functions are properly prototyped.  Otherwise, the
22022 compiler must insert an instruction before every non-prototyped call to
22023 set or clear bit 6 of the condition code register (@code{CR}) to
22024 indicate whether floating-point values are passed in the floating-point
22025 registers in case the function takes variable arguments.  With
22026 @option{-mprototype}, only calls to prototyped variable argument functions
22027 set or clear the bit.
22029 @item -msim
22030 @opindex msim
22031 On embedded PowerPC systems, assume that the startup module is called
22032 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
22033 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
22034 configurations.
22036 @item -mmvme
22037 @opindex mmvme
22038 On embedded PowerPC systems, assume that the startup module is called
22039 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
22040 @file{libc.a}.
22042 @item -mads
22043 @opindex mads
22044 On embedded PowerPC systems, assume that the startup module is called
22045 @file{crt0.o} and the standard C libraries are @file{libads.a} and
22046 @file{libc.a}.
22048 @item -myellowknife
22049 @opindex myellowknife
22050 On embedded PowerPC systems, assume that the startup module is called
22051 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
22052 @file{libc.a}.
22054 @item -mvxworks
22055 @opindex mvxworks
22056 On System V.4 and embedded PowerPC systems, specify that you are
22057 compiling for a VxWorks system.
22059 @item -memb
22060 @opindex memb
22061 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
22062 header to indicate that @samp{eabi} extended relocations are used.
22064 @item -meabi
22065 @itemx -mno-eabi
22066 @opindex meabi
22067 @opindex mno-eabi
22068 On System V.4 and embedded PowerPC systems do (do not) adhere to the
22069 Embedded Applications Binary Interface (EABI), which is a set of
22070 modifications to the System V.4 specifications.  Selecting @option{-meabi}
22071 means that the stack is aligned to an 8-byte boundary, a function
22072 @code{__eabi} is called from @code{main} to set up the EABI
22073 environment, and the @option{-msdata} option can use both @code{r2} and
22074 @code{r13} to point to two separate small data areas.  Selecting
22075 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
22076 no EABI initialization function is called from @code{main}, and the
22077 @option{-msdata} option only uses @code{r13} to point to a single
22078 small data area.  The @option{-meabi} option is on by default if you
22079 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
22081 @item -msdata=eabi
22082 @opindex msdata=eabi
22083 On System V.4 and embedded PowerPC systems, put small initialized
22084 @code{const} global and static data in the @code{.sdata2} section, which
22085 is pointed to by register @code{r2}.  Put small initialized
22086 non-@code{const} global and static data in the @code{.sdata} section,
22087 which is pointed to by register @code{r13}.  Put small uninitialized
22088 global and static data in the @code{.sbss} section, which is adjacent to
22089 the @code{.sdata} section.  The @option{-msdata=eabi} option is
22090 incompatible with the @option{-mrelocatable} option.  The
22091 @option{-msdata=eabi} option also sets the @option{-memb} option.
22093 @item -msdata=sysv
22094 @opindex msdata=sysv
22095 On System V.4 and embedded PowerPC systems, put small global and static
22096 data in the @code{.sdata} section, which is pointed to by register
22097 @code{r13}.  Put small uninitialized global and static data in the
22098 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
22099 The @option{-msdata=sysv} option is incompatible with the
22100 @option{-mrelocatable} option.
22102 @item -msdata=default
22103 @itemx -msdata
22104 @opindex msdata=default
22105 @opindex msdata
22106 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
22107 compile code the same as @option{-msdata=eabi}, otherwise compile code the
22108 same as @option{-msdata=sysv}.
22110 @item -msdata=data
22111 @opindex msdata=data
22112 On System V.4 and embedded PowerPC systems, put small global
22113 data in the @code{.sdata} section.  Put small uninitialized global
22114 data in the @code{.sbss} section.  Do not use register @code{r13}
22115 to address small data however.  This is the default behavior unless
22116 other @option{-msdata} options are used.
22118 @item -msdata=none
22119 @itemx -mno-sdata
22120 @opindex msdata=none
22121 @opindex mno-sdata
22122 On embedded PowerPC systems, put all initialized global and static data
22123 in the @code{.data} section, and all uninitialized data in the
22124 @code{.bss} section.
22126 @item -mblock-move-inline-limit=@var{num}
22127 @opindex mblock-move-inline-limit
22128 Inline all block moves (such as calls to @code{memcpy} or structure
22129 copies) less than or equal to @var{num} bytes.  The minimum value for
22130 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
22131 targets.  The default value is target-specific.
22133 @item -G @var{num}
22134 @opindex G
22135 @cindex smaller data references (PowerPC)
22136 @cindex .sdata/.sdata2 references (PowerPC)
22137 On embedded PowerPC systems, put global and static items less than or
22138 equal to @var{num} bytes into the small data or BSS sections instead of
22139 the normal data or BSS section.  By default, @var{num} is 8.  The
22140 @option{-G @var{num}} switch is also passed to the linker.
22141 All modules should be compiled with the same @option{-G @var{num}} value.
22143 @item -mregnames
22144 @itemx -mno-regnames
22145 @opindex mregnames
22146 @opindex mno-regnames
22147 On System V.4 and embedded PowerPC systems do (do not) emit register
22148 names in the assembly language output using symbolic forms.
22150 @item -mlongcall
22151 @itemx -mno-longcall
22152 @opindex mlongcall
22153 @opindex mno-longcall
22154 By default assume that all calls are far away so that a longer and more
22155 expensive calling sequence is required.  This is required for calls
22156 farther than 32 megabytes (33,554,432 bytes) from the current location.
22157 A short call is generated if the compiler knows
22158 the call cannot be that far away.  This setting can be overridden by
22159 the @code{shortcall} function attribute, or by @code{#pragma
22160 longcall(0)}.
22162 Some linkers are capable of detecting out-of-range calls and generating
22163 glue code on the fly.  On these systems, long calls are unnecessary and
22164 generate slower code.  As of this writing, the AIX linker can do this,
22165 as can the GNU linker for PowerPC/64.  It is planned to add this feature
22166 to the GNU linker for 32-bit PowerPC systems as well.
22168 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
22169 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
22170 addresses represent the callee and the branch island.  The
22171 Darwin/PPC linker prefers the first address and generates a @code{bl
22172 callee} if the PPC @code{bl} instruction reaches the callee directly;
22173 otherwise, the linker generates @code{bl L42} to call the branch
22174 island.  The branch island is appended to the body of the
22175 calling function; it computes the full 32-bit address of the callee
22176 and jumps to it.
22178 On Mach-O (Darwin) systems, this option directs the compiler emit to
22179 the glue for every direct call, and the Darwin linker decides whether
22180 to use or discard it.
22182 In the future, GCC may ignore all longcall specifications
22183 when the linker is known to generate glue.
22185 @item -mtls-markers
22186 @itemx -mno-tls-markers
22187 @opindex mtls-markers
22188 @opindex mno-tls-markers
22189 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
22190 specifying the function argument.  The relocation allows the linker to
22191 reliably associate function call with argument setup instructions for
22192 TLS optimization, which in turn allows GCC to better schedule the
22193 sequence.
22195 @item -mrecip
22196 @itemx -mno-recip
22197 @opindex mrecip
22198 This option enables use of the reciprocal estimate and
22199 reciprocal square root estimate instructions with additional
22200 Newton-Raphson steps to increase precision instead of doing a divide or
22201 square root and divide for floating-point arguments.  You should use
22202 the @option{-ffast-math} option when using @option{-mrecip} (or at
22203 least @option{-funsafe-math-optimizations},
22204 @option{-ffinite-math-only}, @option{-freciprocal-math} and
22205 @option{-fno-trapping-math}).  Note that while the throughput of the
22206 sequence is generally higher than the throughput of the non-reciprocal
22207 instruction, the precision of the sequence can be decreased by up to 2
22208 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
22209 roots.
22211 @item -mrecip=@var{opt}
22212 @opindex mrecip=opt
22213 This option controls which reciprocal estimate instructions
22214 may be used.  @var{opt} is a comma-separated list of options, which may
22215 be preceded by a @code{!} to invert the option:
22217 @table @samp
22219 @item all
22220 Enable all estimate instructions.
22222 @item default 
22223 Enable the default instructions, equivalent to @option{-mrecip}.
22225 @item none 
22226 Disable all estimate instructions, equivalent to @option{-mno-recip}.
22228 @item div 
22229 Enable the reciprocal approximation instructions for both 
22230 single and double precision.
22232 @item divf 
22233 Enable the single-precision reciprocal approximation instructions.
22235 @item divd 
22236 Enable the double-precision reciprocal approximation instructions.
22238 @item rsqrt 
22239 Enable the reciprocal square root approximation instructions for both
22240 single and double precision.
22242 @item rsqrtf 
22243 Enable the single-precision reciprocal square root approximation instructions.
22245 @item rsqrtd 
22246 Enable the double-precision reciprocal square root approximation instructions.
22248 @end table
22250 So, for example, @option{-mrecip=all,!rsqrtd} enables
22251 all of the reciprocal estimate instructions, except for the
22252 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
22253 which handle the double-precision reciprocal square root calculations.
22255 @item -mrecip-precision
22256 @itemx -mno-recip-precision
22257 @opindex mrecip-precision
22258 Assume (do not assume) that the reciprocal estimate instructions
22259 provide higher-precision estimates than is mandated by the PowerPC
22260 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
22261 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
22262 The double-precision square root estimate instructions are not generated by
22263 default on low-precision machines, since they do not provide an
22264 estimate that converges after three steps.
22266 @item -mveclibabi=@var{type}
22267 @opindex mveclibabi
22268 Specifies the ABI type to use for vectorizing intrinsics using an
22269 external library.  The only type supported at present is @samp{mass},
22270 which specifies to use IBM's Mathematical Acceleration Subsystem
22271 (MASS) libraries for vectorizing intrinsics using external libraries.
22272 GCC currently emits calls to @code{acosd2}, @code{acosf4},
22273 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
22274 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
22275 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
22276 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
22277 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
22278 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
22279 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
22280 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
22281 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
22282 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
22283 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
22284 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
22285 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
22286 for power7.  Both @option{-ftree-vectorize} and
22287 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
22288 libraries must be specified at link time.
22290 @item -mfriz
22291 @itemx -mno-friz
22292 @opindex mfriz
22293 Generate (do not generate) the @code{friz} instruction when the
22294 @option{-funsafe-math-optimizations} option is used to optimize
22295 rounding of floating-point values to 64-bit integer and back to floating
22296 point.  The @code{friz} instruction does not return the same value if
22297 the floating-point number is too large to fit in an integer.
22299 @item -mpointers-to-nested-functions
22300 @itemx -mno-pointers-to-nested-functions
22301 @opindex mpointers-to-nested-functions
22302 Generate (do not generate) code to load up the static chain register
22303 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
22304 systems where a function pointer points to a 3-word descriptor giving
22305 the function address, TOC value to be loaded in register @code{r2}, and
22306 static chain value to be loaded in register @code{r11}.  The
22307 @option{-mpointers-to-nested-functions} is on by default.  You cannot
22308 call through pointers to nested functions or pointers
22309 to functions compiled in other languages that use the static chain if
22310 you use @option{-mno-pointers-to-nested-functions}.
22312 @item -msave-toc-indirect
22313 @itemx -mno-save-toc-indirect
22314 @opindex msave-toc-indirect
22315 Generate (do not generate) code to save the TOC value in the reserved
22316 stack location in the function prologue if the function calls through
22317 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
22318 saved in the prologue, it is saved just before the call through the
22319 pointer.  The @option{-mno-save-toc-indirect} option is the default.
22321 @item -mcompat-align-parm
22322 @itemx -mno-compat-align-parm
22323 @opindex mcompat-align-parm
22324 Generate (do not generate) code to pass structure parameters with a
22325 maximum alignment of 64 bits, for compatibility with older versions
22326 of GCC.
22328 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
22329 structure parameter on a 128-bit boundary when that structure contained
22330 a member requiring 128-bit alignment.  This is corrected in more
22331 recent versions of GCC.  This option may be used to generate code
22332 that is compatible with functions compiled with older versions of
22333 GCC.
22335 The @option{-mno-compat-align-parm} option is the default.
22337 @item -mstack-protector-guard=@var{guard}
22338 @itemx -mstack-protector-guard-reg=@var{reg}
22339 @itemx -mstack-protector-guard-offset=@var{offset}
22340 @opindex mstack-protector-guard
22341 @opindex mstack-protector-guard-reg
22342 @opindex mstack-protector-guard-offset
22343 Generate stack protection code using canary at @var{guard}.  Supported
22344 locations are @samp{global} for global canary or @samp{tls} for per-thread
22345 canary in the TLS block (the default with GNU libc version 2.4 or later).
22347 With the latter choice the options
22348 @option{-mstack-protector-guard-reg=@var{reg}} and
22349 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
22350 which register to use as base register for reading the canary, and from what
22351 offset from that base register. The default for those is as specified in the
22352 relevant ABI.
22353 @end table
22355 @node RX Options
22356 @subsection RX Options
22357 @cindex RX Options
22359 These command-line options are defined for RX targets:
22361 @table @gcctabopt
22362 @item -m64bit-doubles
22363 @itemx -m32bit-doubles
22364 @opindex m64bit-doubles
22365 @opindex m32bit-doubles
22366 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
22367 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
22368 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
22369 works on 32-bit values, which is why the default is
22370 @option{-m32bit-doubles}.
22372 @item -fpu
22373 @itemx -nofpu
22374 @opindex fpu
22375 @opindex nofpu
22376 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
22377 floating-point hardware.  The default is enabled for the RX600
22378 series and disabled for the RX200 series.
22380 Floating-point instructions are only generated for 32-bit floating-point 
22381 values, however, so the FPU hardware is not used for doubles if the
22382 @option{-m64bit-doubles} option is used.
22384 @emph{Note} If the @option{-fpu} option is enabled then
22385 @option{-funsafe-math-optimizations} is also enabled automatically.
22386 This is because the RX FPU instructions are themselves unsafe.
22388 @item -mcpu=@var{name}
22389 @opindex mcpu
22390 Selects the type of RX CPU to be targeted.  Currently three types are
22391 supported, the generic @samp{RX600} and @samp{RX200} series hardware and
22392 the specific @samp{RX610} CPU.  The default is @samp{RX600}.
22394 The only difference between @samp{RX600} and @samp{RX610} is that the
22395 @samp{RX610} does not support the @code{MVTIPL} instruction.
22397 The @samp{RX200} series does not have a hardware floating-point unit
22398 and so @option{-nofpu} is enabled by default when this type is
22399 selected.
22401 @item -mbig-endian-data
22402 @itemx -mlittle-endian-data
22403 @opindex mbig-endian-data
22404 @opindex mlittle-endian-data
22405 Store data (but not code) in the big-endian format.  The default is
22406 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
22407 format.
22409 @item -msmall-data-limit=@var{N}
22410 @opindex msmall-data-limit
22411 Specifies the maximum size in bytes of global and static variables
22412 which can be placed into the small data area.  Using the small data
22413 area can lead to smaller and faster code, but the size of area is
22414 limited and it is up to the programmer to ensure that the area does
22415 not overflow.  Also when the small data area is used one of the RX's
22416 registers (usually @code{r13}) is reserved for use pointing to this
22417 area, so it is no longer available for use by the compiler.  This
22418 could result in slower and/or larger code if variables are pushed onto
22419 the stack instead of being held in this register.
22421 Note, common variables (variables that have not been initialized) and
22422 constants are not placed into the small data area as they are assigned
22423 to other sections in the output executable.
22425 The default value is zero, which disables this feature.  Note, this
22426 feature is not enabled by default with higher optimization levels
22427 (@option{-O2} etc) because of the potentially detrimental effects of
22428 reserving a register.  It is up to the programmer to experiment and
22429 discover whether this feature is of benefit to their program.  See the
22430 description of the @option{-mpid} option for a description of how the
22431 actual register to hold the small data area pointer is chosen.
22433 @item -msim
22434 @itemx -mno-sim
22435 @opindex msim
22436 @opindex mno-sim
22437 Use the simulator runtime.  The default is to use the libgloss
22438 board-specific runtime.
22440 @item -mas100-syntax
22441 @itemx -mno-as100-syntax
22442 @opindex mas100-syntax
22443 @opindex mno-as100-syntax
22444 When generating assembler output use a syntax that is compatible with
22445 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
22446 assembler, but it has some restrictions so it is not generated by default.
22448 @item -mmax-constant-size=@var{N}
22449 @opindex mmax-constant-size
22450 Specifies the maximum size, in bytes, of a constant that can be used as
22451 an operand in a RX instruction.  Although the RX instruction set does
22452 allow constants of up to 4 bytes in length to be used in instructions,
22453 a longer value equates to a longer instruction.  Thus in some
22454 circumstances it can be beneficial to restrict the size of constants
22455 that are used in instructions.  Constants that are too big are instead
22456 placed into a constant pool and referenced via register indirection.
22458 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
22459 or 4 means that constants of any size are allowed.
22461 @item -mrelax
22462 @opindex mrelax
22463 Enable linker relaxation.  Linker relaxation is a process whereby the
22464 linker attempts to reduce the size of a program by finding shorter
22465 versions of various instructions.  Disabled by default.
22467 @item -mint-register=@var{N}
22468 @opindex mint-register
22469 Specify the number of registers to reserve for fast interrupt handler
22470 functions.  The value @var{N} can be between 0 and 4.  A value of 1
22471 means that register @code{r13} is reserved for the exclusive use
22472 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
22473 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
22474 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
22475 A value of 0, the default, does not reserve any registers.
22477 @item -msave-acc-in-interrupts
22478 @opindex msave-acc-in-interrupts
22479 Specifies that interrupt handler functions should preserve the
22480 accumulator register.  This is only necessary if normal code might use
22481 the accumulator register, for example because it performs 64-bit
22482 multiplications.  The default is to ignore the accumulator as this
22483 makes the interrupt handlers faster.
22485 @item -mpid
22486 @itemx -mno-pid
22487 @opindex mpid
22488 @opindex mno-pid
22489 Enables the generation of position independent data.  When enabled any
22490 access to constant data is done via an offset from a base address
22491 held in a register.  This allows the location of constant data to be
22492 determined at run time without requiring the executable to be
22493 relocated, which is a benefit to embedded applications with tight
22494 memory constraints.  Data that can be modified is not affected by this
22495 option.
22497 Note, using this feature reserves a register, usually @code{r13}, for
22498 the constant data base address.  This can result in slower and/or
22499 larger code, especially in complicated functions.
22501 The actual register chosen to hold the constant data base address
22502 depends upon whether the @option{-msmall-data-limit} and/or the
22503 @option{-mint-register} command-line options are enabled.  Starting
22504 with register @code{r13} and proceeding downwards, registers are
22505 allocated first to satisfy the requirements of @option{-mint-register},
22506 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
22507 is possible for the small data area register to be @code{r8} if both
22508 @option{-mint-register=4} and @option{-mpid} are specified on the
22509 command line.
22511 By default this feature is not enabled.  The default can be restored
22512 via the @option{-mno-pid} command-line option.
22514 @item -mno-warn-multiple-fast-interrupts
22515 @itemx -mwarn-multiple-fast-interrupts
22516 @opindex mno-warn-multiple-fast-interrupts
22517 @opindex mwarn-multiple-fast-interrupts
22518 Prevents GCC from issuing a warning message if it finds more than one
22519 fast interrupt handler when it is compiling a file.  The default is to
22520 issue a warning for each extra fast interrupt handler found, as the RX
22521 only supports one such interrupt.
22523 @item -mallow-string-insns
22524 @itemx -mno-allow-string-insns
22525 @opindex mallow-string-insns
22526 @opindex mno-allow-string-insns
22527 Enables or disables the use of the string manipulation instructions
22528 @code{SMOVF}, @code{SCMPU}, @code{SMOVB}, @code{SMOVU}, @code{SUNTIL}
22529 @code{SWHILE} and also the @code{RMPA} instruction.  These
22530 instructions may prefetch data, which is not safe to do if accessing
22531 an I/O register.  (See section 12.2.7 of the RX62N Group User's Manual
22532 for more information).
22534 The default is to allow these instructions, but it is not possible for
22535 GCC to reliably detect all circumstances where a string instruction
22536 might be used to access an I/O register, so their use cannot be
22537 disabled automatically.  Instead it is reliant upon the programmer to
22538 use the @option{-mno-allow-string-insns} option if their program
22539 accesses I/O space.
22541 When the instructions are enabled GCC defines the C preprocessor
22542 symbol @code{__RX_ALLOW_STRING_INSNS__}, otherwise it defines the
22543 symbol @code{__RX_DISALLOW_STRING_INSNS__}.
22545 @item -mjsr
22546 @itemx -mno-jsr
22547 @opindex mjsr
22548 @opindex mno-jsr
22549 Use only (or not only) @code{JSR} instructions to access functions.
22550 This option can be used when code size exceeds the range of @code{BSR}
22551 instructions.  Note that @option{-mno-jsr} does not mean to not use
22552 @code{JSR} but instead means that any type of branch may be used.
22553 @end table
22555 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
22556 has special significance to the RX port when used with the
22557 @code{interrupt} function attribute.  This attribute indicates a
22558 function intended to process fast interrupts.  GCC ensures
22559 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
22560 and/or @code{r13} and only provided that the normal use of the
22561 corresponding registers have been restricted via the
22562 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
22563 options.
22565 @node S/390 and zSeries Options
22566 @subsection S/390 and zSeries Options
22567 @cindex S/390 and zSeries Options
22569 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
22571 @table @gcctabopt
22572 @item -mhard-float
22573 @itemx -msoft-float
22574 @opindex mhard-float
22575 @opindex msoft-float
22576 Use (do not use) the hardware floating-point instructions and registers
22577 for floating-point operations.  When @option{-msoft-float} is specified,
22578 functions in @file{libgcc.a} are used to perform floating-point
22579 operations.  When @option{-mhard-float} is specified, the compiler
22580 generates IEEE floating-point instructions.  This is the default.
22582 @item -mhard-dfp
22583 @itemx -mno-hard-dfp
22584 @opindex mhard-dfp
22585 @opindex mno-hard-dfp
22586 Use (do not use) the hardware decimal-floating-point instructions for
22587 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
22588 specified, functions in @file{libgcc.a} are used to perform
22589 decimal-floating-point operations.  When @option{-mhard-dfp} is
22590 specified, the compiler generates decimal-floating-point hardware
22591 instructions.  This is the default for @option{-march=z9-ec} or higher.
22593 @item -mlong-double-64
22594 @itemx -mlong-double-128
22595 @opindex mlong-double-64
22596 @opindex mlong-double-128
22597 These switches control the size of @code{long double} type. A size
22598 of 64 bits makes the @code{long double} type equivalent to the @code{double}
22599 type. This is the default.
22601 @item -mbackchain
22602 @itemx -mno-backchain
22603 @opindex mbackchain
22604 @opindex mno-backchain
22605 Store (do not store) the address of the caller's frame as backchain pointer
22606 into the callee's stack frame.
22607 A backchain may be needed to allow debugging using tools that do not understand
22608 DWARF call frame information.
22609 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
22610 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
22611 the backchain is placed into the topmost word of the 96/160 byte register
22612 save area.
22614 In general, code compiled with @option{-mbackchain} is call-compatible with
22615 code compiled with @option{-mmo-backchain}; however, use of the backchain
22616 for debugging purposes usually requires that the whole binary is built with
22617 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
22618 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
22619 to build a linux kernel use @option{-msoft-float}.
22621 The default is to not maintain the backchain.
22623 @item -mpacked-stack
22624 @itemx -mno-packed-stack
22625 @opindex mpacked-stack
22626 @opindex mno-packed-stack
22627 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
22628 specified, the compiler uses the all fields of the 96/160 byte register save
22629 area only for their default purpose; unused fields still take up stack space.
22630 When @option{-mpacked-stack} is specified, register save slots are densely
22631 packed at the top of the register save area; unused space is reused for other
22632 purposes, allowing for more efficient use of the available stack space.
22633 However, when @option{-mbackchain} is also in effect, the topmost word of
22634 the save area is always used to store the backchain, and the return address
22635 register is always saved two words below the backchain.
22637 As long as the stack frame backchain is not used, code generated with
22638 @option{-mpacked-stack} is call-compatible with code generated with
22639 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
22640 S/390 or zSeries generated code that uses the stack frame backchain at run
22641 time, not just for debugging purposes.  Such code is not call-compatible
22642 with code compiled with @option{-mpacked-stack}.  Also, note that the
22643 combination of @option{-mbackchain},
22644 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
22645 to build a linux kernel use @option{-msoft-float}.
22647 The default is to not use the packed stack layout.
22649 @item -msmall-exec
22650 @itemx -mno-small-exec
22651 @opindex msmall-exec
22652 @opindex mno-small-exec
22653 Generate (or do not generate) code using the @code{bras} instruction
22654 to do subroutine calls.
22655 This only works reliably if the total executable size does not
22656 exceed 64k.  The default is to use the @code{basr} instruction instead,
22657 which does not have this limitation.
22659 @item -m64
22660 @itemx -m31
22661 @opindex m64
22662 @opindex m31
22663 When @option{-m31} is specified, generate code compliant to the
22664 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
22665 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
22666 particular to generate 64-bit instructions.  For the @samp{s390}
22667 targets, the default is @option{-m31}, while the @samp{s390x}
22668 targets default to @option{-m64}.
22670 @item -mzarch
22671 @itemx -mesa
22672 @opindex mzarch
22673 @opindex mesa
22674 When @option{-mzarch} is specified, generate code using the
22675 instructions available on z/Architecture.
22676 When @option{-mesa} is specified, generate code using the
22677 instructions available on ESA/390.  Note that @option{-mesa} is
22678 not possible with @option{-m64}.
22679 When generating code compliant to the GNU/Linux for S/390 ABI,
22680 the default is @option{-mesa}.  When generating code compliant
22681 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
22683 @item -mhtm
22684 @itemx -mno-htm
22685 @opindex mhtm
22686 @opindex mno-htm
22687 The @option{-mhtm} option enables a set of builtins making use of
22688 instructions available with the transactional execution facility
22689 introduced with the IBM zEnterprise EC12 machine generation
22690 @ref{S/390 System z Built-in Functions}.
22691 @option{-mhtm} is enabled by default when using @option{-march=zEC12}.
22693 @item -mvx
22694 @itemx -mno-vx
22695 @opindex mvx
22696 @opindex mno-vx
22697 When @option{-mvx} is specified, generate code using the instructions
22698 available with the vector extension facility introduced with the IBM
22699 z13 machine generation.
22700 This option changes the ABI for some vector type values with regard to
22701 alignment and calling conventions.  In case vector type values are
22702 being used in an ABI-relevant context a GAS @samp{.gnu_attribute}
22703 command will be added to mark the resulting binary with the ABI used.
22704 @option{-mvx} is enabled by default when using @option{-march=z13}.
22706 @item -mzvector
22707 @itemx -mno-zvector
22708 @opindex mzvector
22709 @opindex mno-zvector
22710 The @option{-mzvector} option enables vector language extensions and
22711 builtins using instructions available with the vector extension
22712 facility introduced with the IBM z13 machine generation.
22713 This option adds support for @samp{vector} to be used as a keyword to
22714 define vector type variables and arguments.  @samp{vector} is only
22715 available when GNU extensions are enabled.  It will not be expanded
22716 when requesting strict standard compliance e.g. with @option{-std=c99}.
22717 In addition to the GCC low-level builtins @option{-mzvector} enables
22718 a set of builtins added for compatibility with AltiVec-style
22719 implementations like Power and Cell.  In order to make use of these
22720 builtins the header file @file{vecintrin.h} needs to be included.
22721 @option{-mzvector} is disabled by default.
22723 @item -mmvcle
22724 @itemx -mno-mvcle
22725 @opindex mmvcle
22726 @opindex mno-mvcle
22727 Generate (or do not generate) code using the @code{mvcle} instruction
22728 to perform block moves.  When @option{-mno-mvcle} is specified,
22729 use a @code{mvc} loop instead.  This is the default unless optimizing for
22730 size.
22732 @item -mdebug
22733 @itemx -mno-debug
22734 @opindex mdebug
22735 @opindex mno-debug
22736 Print (or do not print) additional debug information when compiling.
22737 The default is to not print debug information.
22739 @item -march=@var{cpu-type}
22740 @opindex march
22741 Generate code that runs on @var{cpu-type}, which is the name of a
22742 system representing a certain processor type.  Possible values for
22743 @var{cpu-type} are @samp{z900}/@samp{arch5}, @samp{z990}/@samp{arch6},
22744 @samp{z9-109}, @samp{z9-ec}/@samp{arch7}, @samp{z10}/@samp{arch8},
22745 @samp{z196}/@samp{arch9}, @samp{zEC12}, @samp{z13}/@samp{arch11}, and
22746 @samp{native}.
22748 The default is @option{-march=z900}.  @samp{g5}/@samp{arch3} and
22749 @samp{g6} are deprecated and will be removed with future releases.
22751 Specifying @samp{native} as cpu type can be used to select the best
22752 architecture option for the host processor.
22753 @option{-march=native} has no effect if GCC does not recognize the
22754 processor.
22756 @item -mtune=@var{cpu-type}
22757 @opindex mtune
22758 Tune to @var{cpu-type} everything applicable about the generated code,
22759 except for the ABI and the set of available instructions.
22760 The list of @var{cpu-type} values is the same as for @option{-march}.
22761 The default is the value used for @option{-march}.
22763 @item -mtpf-trace
22764 @itemx -mno-tpf-trace
22765 @opindex mtpf-trace
22766 @opindex mno-tpf-trace
22767 Generate code that adds (does not add) in TPF OS specific branches to trace
22768 routines in the operating system.  This option is off by default, even
22769 when compiling for the TPF OS@.
22771 @item -mfused-madd
22772 @itemx -mno-fused-madd
22773 @opindex mfused-madd
22774 @opindex mno-fused-madd
22775 Generate code that uses (does not use) the floating-point multiply and
22776 accumulate instructions.  These instructions are generated by default if
22777 hardware floating point is used.
22779 @item -mwarn-framesize=@var{framesize}
22780 @opindex mwarn-framesize
22781 Emit a warning if the current function exceeds the given frame size.  Because
22782 this is a compile-time check it doesn't need to be a real problem when the program
22783 runs.  It is intended to identify functions that most probably cause
22784 a stack overflow.  It is useful to be used in an environment with limited stack
22785 size e.g.@: the linux kernel.
22787 @item -mwarn-dynamicstack
22788 @opindex mwarn-dynamicstack
22789 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
22790 arrays.  This is generally a bad idea with a limited stack size.
22792 @item -mstack-guard=@var{stack-guard}
22793 @itemx -mstack-size=@var{stack-size}
22794 @opindex mstack-guard
22795 @opindex mstack-size
22796 If these options are provided the S/390 back end emits additional instructions in
22797 the function prologue that trigger a trap if the stack size is @var{stack-guard}
22798 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
22799 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
22800 the frame size of the compiled function is chosen.
22801 These options are intended to be used to help debugging stack overflow problems.
22802 The additionally emitted code causes only little overhead and hence can also be
22803 used in production-like systems without greater performance degradation.  The given
22804 values have to be exact powers of 2 and @var{stack-size} has to be greater than
22805 @var{stack-guard} without exceeding 64k.
22806 In order to be efficient the extra code makes the assumption that the stack starts
22807 at an address aligned to the value given by @var{stack-size}.
22808 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
22810 @item -mhotpatch=@var{pre-halfwords},@var{post-halfwords}
22811 @opindex mhotpatch
22812 If the hotpatch option is enabled, a ``hot-patching'' function
22813 prologue is generated for all functions in the compilation unit.
22814 The funtion label is prepended with the given number of two-byte
22815 NOP instructions (@var{pre-halfwords}, maximum 1000000).  After
22816 the label, 2 * @var{post-halfwords} bytes are appended, using the
22817 largest NOP like instructions the architecture allows (maximum
22818 1000000).
22820 If both arguments are zero, hotpatching is disabled.
22822 This option can be overridden for individual functions with the
22823 @code{hotpatch} attribute.
22824 @end table
22826 @node Score Options
22827 @subsection Score Options
22828 @cindex Score Options
22830 These options are defined for Score implementations:
22832 @table @gcctabopt
22833 @item -meb
22834 @opindex meb
22835 Compile code for big-endian mode.  This is the default.
22837 @item -mel
22838 @opindex mel
22839 Compile code for little-endian mode.
22841 @item -mnhwloop
22842 @opindex mnhwloop
22843 Disable generation of @code{bcnz} instructions.
22845 @item -muls
22846 @opindex muls
22847 Enable generation of unaligned load and store instructions.
22849 @item -mmac
22850 @opindex mmac
22851 Enable the use of multiply-accumulate instructions. Disabled by default.
22853 @item -mscore5
22854 @opindex mscore5
22855 Specify the SCORE5 as the target architecture.
22857 @item -mscore5u
22858 @opindex mscore5u
22859 Specify the SCORE5U of the target architecture.
22861 @item -mscore7
22862 @opindex mscore7
22863 Specify the SCORE7 as the target architecture. This is the default.
22865 @item -mscore7d
22866 @opindex mscore7d
22867 Specify the SCORE7D as the target architecture.
22868 @end table
22870 @node SH Options
22871 @subsection SH Options
22873 These @samp{-m} options are defined for the SH implementations:
22875 @table @gcctabopt
22876 @item -m1
22877 @opindex m1
22878 Generate code for the SH1.
22880 @item -m2
22881 @opindex m2
22882 Generate code for the SH2.
22884 @item -m2e
22885 Generate code for the SH2e.
22887 @item -m2a-nofpu
22888 @opindex m2a-nofpu
22889 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
22890 that the floating-point unit is not used.
22892 @item -m2a-single-only
22893 @opindex m2a-single-only
22894 Generate code for the SH2a-FPU, in such a way that no double-precision
22895 floating-point operations are used.
22897 @item -m2a-single
22898 @opindex m2a-single
22899 Generate code for the SH2a-FPU assuming the floating-point unit is in
22900 single-precision mode by default.
22902 @item -m2a
22903 @opindex m2a
22904 Generate code for the SH2a-FPU assuming the floating-point unit is in
22905 double-precision mode by default.
22907 @item -m3
22908 @opindex m3
22909 Generate code for the SH3.
22911 @item -m3e
22912 @opindex m3e
22913 Generate code for the SH3e.
22915 @item -m4-nofpu
22916 @opindex m4-nofpu
22917 Generate code for the SH4 without a floating-point unit.
22919 @item -m4-single-only
22920 @opindex m4-single-only
22921 Generate code for the SH4 with a floating-point unit that only
22922 supports single-precision arithmetic.
22924 @item -m4-single
22925 @opindex m4-single
22926 Generate code for the SH4 assuming the floating-point unit is in
22927 single-precision mode by default.
22929 @item -m4
22930 @opindex m4
22931 Generate code for the SH4.
22933 @item -m4-100
22934 @opindex m4-100
22935 Generate code for SH4-100.
22937 @item -m4-100-nofpu
22938 @opindex m4-100-nofpu
22939 Generate code for SH4-100 in such a way that the
22940 floating-point unit is not used.
22942 @item -m4-100-single
22943 @opindex m4-100-single
22944 Generate code for SH4-100 assuming the floating-point unit is in
22945 single-precision mode by default.
22947 @item -m4-100-single-only
22948 @opindex m4-100-single-only
22949 Generate code for SH4-100 in such a way that no double-precision
22950 floating-point operations are used.
22952 @item -m4-200
22953 @opindex m4-200
22954 Generate code for SH4-200.
22956 @item -m4-200-nofpu
22957 @opindex m4-200-nofpu
22958 Generate code for SH4-200 without in such a way that the
22959 floating-point unit is not used.
22961 @item -m4-200-single
22962 @opindex m4-200-single
22963 Generate code for SH4-200 assuming the floating-point unit is in
22964 single-precision mode by default.
22966 @item -m4-200-single-only
22967 @opindex m4-200-single-only
22968 Generate code for SH4-200 in such a way that no double-precision
22969 floating-point operations are used.
22971 @item -m4-300
22972 @opindex m4-300
22973 Generate code for SH4-300.
22975 @item -m4-300-nofpu
22976 @opindex m4-300-nofpu
22977 Generate code for SH4-300 without in such a way that the
22978 floating-point unit is not used.
22980 @item -m4-300-single
22981 @opindex m4-300-single
22982 Generate code for SH4-300 in such a way that no double-precision
22983 floating-point operations are used.
22985 @item -m4-300-single-only
22986 @opindex m4-300-single-only
22987 Generate code for SH4-300 in such a way that no double-precision
22988 floating-point operations are used.
22990 @item -m4-340
22991 @opindex m4-340
22992 Generate code for SH4-340 (no MMU, no FPU).
22994 @item -m4-500
22995 @opindex m4-500
22996 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
22997 assembler.
22999 @item -m4a-nofpu
23000 @opindex m4a-nofpu
23001 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
23002 floating-point unit is not used.
23004 @item -m4a-single-only
23005 @opindex m4a-single-only
23006 Generate code for the SH4a, in such a way that no double-precision
23007 floating-point operations are used.
23009 @item -m4a-single
23010 @opindex m4a-single
23011 Generate code for the SH4a assuming the floating-point unit is in
23012 single-precision mode by default.
23014 @item -m4a
23015 @opindex m4a
23016 Generate code for the SH4a.
23018 @item -m4al
23019 @opindex m4al
23020 Same as @option{-m4a-nofpu}, except that it implicitly passes
23021 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
23022 instructions at the moment.
23024 @item -mb
23025 @opindex mb
23026 Compile code for the processor in big-endian mode.
23028 @item -ml
23029 @opindex ml
23030 Compile code for the processor in little-endian mode.
23032 @item -mdalign
23033 @opindex mdalign
23034 Align doubles at 64-bit boundaries.  Note that this changes the calling
23035 conventions, and thus some functions from the standard C library do
23036 not work unless you recompile it first with @option{-mdalign}.
23038 @item -mrelax
23039 @opindex mrelax
23040 Shorten some address references at link time, when possible; uses the
23041 linker option @option{-relax}.
23043 @item -mbigtable
23044 @opindex mbigtable
23045 Use 32-bit offsets in @code{switch} tables.  The default is to use
23046 16-bit offsets.
23048 @item -mbitops
23049 @opindex mbitops
23050 Enable the use of bit manipulation instructions on SH2A.
23052 @item -mfmovd
23053 @opindex mfmovd
23054 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
23055 alignment constraints.
23057 @item -mrenesas
23058 @opindex mrenesas
23059 Comply with the calling conventions defined by Renesas.
23061 @item -mno-renesas
23062 @opindex mno-renesas
23063 Comply with the calling conventions defined for GCC before the Renesas
23064 conventions were available.  This option is the default for all
23065 targets of the SH toolchain.
23067 @item -mnomacsave
23068 @opindex mnomacsave
23069 Mark the @code{MAC} register as call-clobbered, even if
23070 @option{-mrenesas} is given.
23072 @item -mieee
23073 @itemx -mno-ieee
23074 @opindex mieee
23075 @opindex mno-ieee
23076 Control the IEEE compliance of floating-point comparisons, which affects the
23077 handling of cases where the result of a comparison is unordered.  By default
23078 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
23079 enabled @option{-mno-ieee} is implicitly set, which results in faster
23080 floating-point greater-equal and less-equal comparisons.  The implicit settings
23081 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
23083 @item -minline-ic_invalidate
23084 @opindex minline-ic_invalidate
23085 Inline code to invalidate instruction cache entries after setting up
23086 nested function trampolines.
23087 This option has no effect if @option{-musermode} is in effect and the selected
23088 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
23089 instruction.
23090 If the selected code generation option does not allow the use of the @code{icbi}
23091 instruction, and @option{-musermode} is not in effect, the inlined code
23092 manipulates the instruction cache address array directly with an associative
23093 write.  This not only requires privileged mode at run time, but it also
23094 fails if the cache line had been mapped via the TLB and has become unmapped.
23096 @item -misize
23097 @opindex misize
23098 Dump instruction size and location in the assembly code.
23100 @item -mpadstruct
23101 @opindex mpadstruct
23102 This option is deprecated.  It pads structures to multiple of 4 bytes,
23103 which is incompatible with the SH ABI@.
23105 @item -matomic-model=@var{model}
23106 @opindex matomic-model=@var{model}
23107 Sets the model of atomic operations and additional parameters as a comma
23108 separated list.  For details on the atomic built-in functions see
23109 @ref{__atomic Builtins}.  The following models and parameters are supported:
23111 @table @samp
23113 @item none
23114 Disable compiler generated atomic sequences and emit library calls for atomic
23115 operations.  This is the default if the target is not @code{sh*-*-linux*}.
23117 @item soft-gusa
23118 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
23119 built-in functions.  The generated atomic sequences require additional support
23120 from the interrupt/exception handling code of the system and are only suitable
23121 for SH3* and SH4* single-core systems.  This option is enabled by default when
23122 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
23123 this option also partially utilizes the hardware atomic instructions
23124 @code{movli.l} and @code{movco.l} to create more efficient code, unless
23125 @samp{strict} is specified.  
23127 @item soft-tcb
23128 Generate software atomic sequences that use a variable in the thread control
23129 block.  This is a variation of the gUSA sequences which can also be used on
23130 SH1* and SH2* targets.  The generated atomic sequences require additional
23131 support from the interrupt/exception handling code of the system and are only
23132 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
23133 parameter has to be specified as well.
23135 @item soft-imask
23136 Generate software atomic sequences that temporarily disable interrupts by
23137 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
23138 in privileged mode and is only suitable for single-core systems.  Additional
23139 support from the interrupt/exception handling code of the system is not
23140 required.  This model is enabled by default when the target is
23141 @code{sh*-*-linux*} and SH1* or SH2*.
23143 @item hard-llcs
23144 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
23145 instructions only.  This is only available on SH4A and is suitable for
23146 multi-core systems.  Since the hardware instructions support only 32 bit atomic
23147 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
23148 Code compiled with this option is also compatible with other software
23149 atomic model interrupt/exception handling systems if executed on an SH4A
23150 system.  Additional support from the interrupt/exception handling code of the
23151 system is not required for this model.
23153 @item gbr-offset=
23154 This parameter specifies the offset in bytes of the variable in the thread
23155 control block structure that should be used by the generated atomic sequences
23156 when the @samp{soft-tcb} model has been selected.  For other models this
23157 parameter is ignored.  The specified value must be an integer multiple of four
23158 and in the range 0-1020.
23160 @item strict
23161 This parameter prevents mixed usage of multiple atomic models, even if they
23162 are compatible, and makes the compiler generate atomic sequences of the
23163 specified model only.
23165 @end table
23167 @item -mtas
23168 @opindex mtas
23169 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
23170 Notice that depending on the particular hardware and software configuration
23171 this can degrade overall performance due to the operand cache line flushes
23172 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
23173 processors the @code{tas.b} instruction must be used with caution since it
23174 can result in data corruption for certain cache configurations.
23176 @item -mprefergot
23177 @opindex mprefergot
23178 When generating position-independent code, emit function calls using
23179 the Global Offset Table instead of the Procedure Linkage Table.
23181 @item -musermode
23182 @itemx -mno-usermode
23183 @opindex musermode
23184 @opindex mno-usermode
23185 Don't allow (allow) the compiler generating privileged mode code.  Specifying
23186 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
23187 inlined code would not work in user mode.  @option{-musermode} is the default
23188 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
23189 @option{-musermode} has no effect, since there is no user mode.
23191 @item -multcost=@var{number}
23192 @opindex multcost=@var{number}
23193 Set the cost to assume for a multiply insn.
23195 @item -mdiv=@var{strategy}
23196 @opindex mdiv=@var{strategy}
23197 Set the division strategy to be used for integer division operations.
23198 @var{strategy} can be one of: 
23200 @table @samp
23202 @item call-div1
23203 Calls a library function that uses the single-step division instruction
23204 @code{div1} to perform the operation.  Division by zero calculates an
23205 unspecified result and does not trap.  This is the default except for SH4,
23206 SH2A and SHcompact.
23208 @item call-fp
23209 Calls a library function that performs the operation in double precision
23210 floating point.  Division by zero causes a floating-point exception.  This is
23211 the default for SHcompact with FPU.  Specifying this for targets that do not
23212 have a double precision FPU defaults to @code{call-div1}.
23214 @item call-table
23215 Calls a library function that uses a lookup table for small divisors and
23216 the @code{div1} instruction with case distinction for larger divisors.  Division
23217 by zero calculates an unspecified result and does not trap.  This is the default
23218 for SH4.  Specifying this for targets that do not have dynamic shift
23219 instructions defaults to @code{call-div1}.
23221 @end table
23223 When a division strategy has not been specified the default strategy is
23224 selected based on the current target.  For SH2A the default strategy is to
23225 use the @code{divs} and @code{divu} instructions instead of library function
23226 calls.
23228 @item -maccumulate-outgoing-args
23229 @opindex maccumulate-outgoing-args
23230 Reserve space once for outgoing arguments in the function prologue rather
23231 than around each call.  Generally beneficial for performance and size.  Also
23232 needed for unwinding to avoid changing the stack frame around conditional code.
23234 @item -mdivsi3_libfunc=@var{name}
23235 @opindex mdivsi3_libfunc=@var{name}
23236 Set the name of the library function used for 32-bit signed division to
23237 @var{name}.
23238 This only affects the name used in the @samp{call} division strategies, and
23239 the compiler still expects the same sets of input/output/clobbered registers as
23240 if this option were not present.
23242 @item -mfixed-range=@var{register-range}
23243 @opindex mfixed-range
23244 Generate code treating the given register range as fixed registers.
23245 A fixed register is one that the register allocator can not use.  This is
23246 useful when compiling kernel code.  A register range is specified as
23247 two registers separated by a dash.  Multiple register ranges can be
23248 specified separated by a comma.
23250 @item -mbranch-cost=@var{num}
23251 @opindex mbranch-cost=@var{num}
23252 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
23253 make the compiler try to generate more branch-free code if possible.  
23254 If not specified the value is selected depending on the processor type that
23255 is being compiled for.
23257 @item -mzdcbranch
23258 @itemx -mno-zdcbranch
23259 @opindex mzdcbranch
23260 @opindex mno-zdcbranch
23261 Assume (do not assume) that zero displacement conditional branch instructions
23262 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
23263 compiler prefers zero displacement branch code sequences.  This is
23264 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
23265 disabled by specifying @option{-mno-zdcbranch}.
23267 @item -mcbranch-force-delay-slot
23268 @opindex mcbranch-force-delay-slot
23269 Force the usage of delay slots for conditional branches, which stuffs the delay
23270 slot with a @code{nop} if a suitable instruction cannot be found.  By default
23271 this option is disabled.  It can be enabled to work around hardware bugs as
23272 found in the original SH7055.
23274 @item -mfused-madd
23275 @itemx -mno-fused-madd
23276 @opindex mfused-madd
23277 @opindex mno-fused-madd
23278 Generate code that uses (does not use) the floating-point multiply and
23279 accumulate instructions.  These instructions are generated by default
23280 if hardware floating point is used.  The machine-dependent
23281 @option{-mfused-madd} option is now mapped to the machine-independent
23282 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
23283 mapped to @option{-ffp-contract=off}.
23285 @item -mfsca
23286 @itemx -mno-fsca
23287 @opindex mfsca
23288 @opindex mno-fsca
23289 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
23290 and cosine approximations.  The option @option{-mfsca} must be used in
23291 combination with @option{-funsafe-math-optimizations}.  It is enabled by default
23292 when generating code for SH4A.  Using @option{-mno-fsca} disables sine and cosine
23293 approximations even if @option{-funsafe-math-optimizations} is in effect.
23295 @item -mfsrra
23296 @itemx -mno-fsrra
23297 @opindex mfsrra
23298 @opindex mno-fsrra
23299 Allow or disallow the compiler to emit the @code{fsrra} instruction for
23300 reciprocal square root approximations.  The option @option{-mfsrra} must be used
23301 in combination with @option{-funsafe-math-optimizations} and
23302 @option{-ffinite-math-only}.  It is enabled by default when generating code for
23303 SH4A.  Using @option{-mno-fsrra} disables reciprocal square root approximations
23304 even if @option{-funsafe-math-optimizations} and @option{-ffinite-math-only} are
23305 in effect.
23307 @item -mpretend-cmove
23308 @opindex mpretend-cmove
23309 Prefer zero-displacement conditional branches for conditional move instruction
23310 patterns.  This can result in faster code on the SH4 processor.
23312 @item -mfdpic
23313 @opindex fdpic
23314 Generate code using the FDPIC ABI.
23316 @end table
23318 @node Solaris 2 Options
23319 @subsection Solaris 2 Options
23320 @cindex Solaris 2 options
23322 These @samp{-m} options are supported on Solaris 2:
23324 @table @gcctabopt
23325 @item -mclear-hwcap
23326 @opindex mclear-hwcap
23327 @option{-mclear-hwcap} tells the compiler to remove the hardware
23328 capabilities generated by the Solaris assembler.  This is only necessary
23329 when object files use ISA extensions not supported by the current
23330 machine, but check at runtime whether or not to use them.
23332 @item -mimpure-text
23333 @opindex mimpure-text
23334 @option{-mimpure-text}, used in addition to @option{-shared}, tells
23335 the compiler to not pass @option{-z text} to the linker when linking a
23336 shared object.  Using this option, you can link position-dependent
23337 code into a shared object.
23339 @option{-mimpure-text} suppresses the ``relocations remain against
23340 allocatable but non-writable sections'' linker error message.
23341 However, the necessary relocations trigger copy-on-write, and the
23342 shared object is not actually shared across processes.  Instead of
23343 using @option{-mimpure-text}, you should compile all source code with
23344 @option{-fpic} or @option{-fPIC}.
23346 @end table
23348 These switches are supported in addition to the above on Solaris 2:
23350 @table @gcctabopt
23351 @item -pthreads
23352 @opindex pthreads
23353 This is a synonym for @option{-pthread}.
23354 @end table
23356 @node SPARC Options
23357 @subsection SPARC Options
23358 @cindex SPARC options
23360 These @samp{-m} options are supported on the SPARC:
23362 @table @gcctabopt
23363 @item -mno-app-regs
23364 @itemx -mapp-regs
23365 @opindex mno-app-regs
23366 @opindex mapp-regs
23367 Specify @option{-mapp-regs} to generate output using the global registers
23368 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
23369 global register 1, each global register 2 through 4 is then treated as an
23370 allocable register that is clobbered by function calls.  This is the default.
23372 To be fully SVR4 ABI-compliant at the cost of some performance loss,
23373 specify @option{-mno-app-regs}.  You should compile libraries and system
23374 software with this option.
23376 @item -mflat
23377 @itemx -mno-flat
23378 @opindex mflat
23379 @opindex mno-flat
23380 With @option{-mflat}, the compiler does not generate save/restore instructions
23381 and uses a ``flat'' or single register window model.  This model is compatible
23382 with the regular register window model.  The local registers and the input
23383 registers (0--5) are still treated as ``call-saved'' registers and are
23384 saved on the stack as needed.
23386 With @option{-mno-flat} (the default), the compiler generates save/restore
23387 instructions (except for leaf functions).  This is the normal operating mode.
23389 @item -mfpu
23390 @itemx -mhard-float
23391 @opindex mfpu
23392 @opindex mhard-float
23393 Generate output containing floating-point instructions.  This is the
23394 default.
23396 @item -mno-fpu
23397 @itemx -msoft-float
23398 @opindex mno-fpu
23399 @opindex msoft-float
23400 Generate output containing library calls for floating point.
23401 @strong{Warning:} the requisite libraries are not available for all SPARC
23402 targets.  Normally the facilities of the machine's usual C compiler are
23403 used, but this cannot be done directly in cross-compilation.  You must make
23404 your own arrangements to provide suitable library functions for
23405 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
23406 @samp{sparclite-*-*} do provide software floating-point support.
23408 @option{-msoft-float} changes the calling convention in the output file;
23409 therefore, it is only useful if you compile @emph{all} of a program with
23410 this option.  In particular, you need to compile @file{libgcc.a}, the
23411 library that comes with GCC, with @option{-msoft-float} in order for
23412 this to work.
23414 @item -mhard-quad-float
23415 @opindex mhard-quad-float
23416 Generate output containing quad-word (long double) floating-point
23417 instructions.
23419 @item -msoft-quad-float
23420 @opindex msoft-quad-float
23421 Generate output containing library calls for quad-word (long double)
23422 floating-point instructions.  The functions called are those specified
23423 in the SPARC ABI@.  This is the default.
23425 As of this writing, there are no SPARC implementations that have hardware
23426 support for the quad-word floating-point instructions.  They all invoke
23427 a trap handler for one of these instructions, and then the trap handler
23428 emulates the effect of the instruction.  Because of the trap handler overhead,
23429 this is much slower than calling the ABI library routines.  Thus the
23430 @option{-msoft-quad-float} option is the default.
23432 @item -mno-unaligned-doubles
23433 @itemx -munaligned-doubles
23434 @opindex mno-unaligned-doubles
23435 @opindex munaligned-doubles
23436 Assume that doubles have 8-byte alignment.  This is the default.
23438 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
23439 alignment only if they are contained in another type, or if they have an
23440 absolute address.  Otherwise, it assumes they have 4-byte alignment.
23441 Specifying this option avoids some rare compatibility problems with code
23442 generated by other compilers.  It is not the default because it results
23443 in a performance loss, especially for floating-point code.
23445 @item -muser-mode
23446 @itemx -mno-user-mode
23447 @opindex muser-mode
23448 @opindex mno-user-mode
23449 Do not generate code that can only run in supervisor mode.  This is relevant
23450 only for the @code{casa} instruction emitted for the LEON3 processor.  This
23451 is the default.
23453 @item -mfaster-structs
23454 @itemx -mno-faster-structs
23455 @opindex mfaster-structs
23456 @opindex mno-faster-structs
23457 With @option{-mfaster-structs}, the compiler assumes that structures
23458 should have 8-byte alignment.  This enables the use of pairs of
23459 @code{ldd} and @code{std} instructions for copies in structure
23460 assignment, in place of twice as many @code{ld} and @code{st} pairs.
23461 However, the use of this changed alignment directly violates the SPARC
23462 ABI@.  Thus, it's intended only for use on targets where the developer
23463 acknowledges that their resulting code is not directly in line with
23464 the rules of the ABI@.
23466 @item -mstd-struct-return
23467 @itemx -mno-std-struct-return
23468 @opindex mstd-struct-return
23469 @opindex mno-std-struct-return
23470 With @option{-mstd-struct-return}, the compiler generates checking code
23471 in functions returning structures or unions to detect size mismatches
23472 between the two sides of function calls, as per the 32-bit ABI@.
23474 The default is @option{-mno-std-struct-return}.  This option has no effect
23475 in 64-bit mode.
23477 @item -mlra
23478 @itemx -mno-lra
23479 @opindex mlra
23480 @opindex mno-lra
23481 Enable Local Register Allocation.  This is the default for SPARC since GCC 7
23482 so @option{-mno-lra} needs to be passed to get old Reload.
23484 @item -mcpu=@var{cpu_type}
23485 @opindex mcpu
23486 Set the instruction set, register set, and instruction scheduling parameters
23487 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
23488 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
23489 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
23490 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
23491 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
23492 @samp{niagara3}, @samp{niagara4} and @samp{niagara7}.
23494 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
23495 which selects the best architecture option for the host processor.
23496 @option{-mcpu=native} has no effect if GCC does not recognize
23497 the processor.
23499 Default instruction scheduling parameters are used for values that select
23500 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
23501 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
23503 Here is a list of each supported architecture and their supported
23504 implementations.
23506 @table @asis
23507 @item v7
23508 cypress, leon3v7
23510 @item v8
23511 supersparc, hypersparc, leon, leon3
23513 @item sparclite
23514 f930, f934, sparclite86x
23516 @item sparclet
23517 tsc701
23519 @item v9
23520 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4, niagara7
23521 @end table
23523 By default (unless configured otherwise), GCC generates code for the V7
23524 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
23525 additionally optimizes it for the Cypress CY7C602 chip, as used in the
23526 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
23527 SPARCStation 1, 2, IPX etc.
23529 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
23530 architecture.  The only difference from V7 code is that the compiler emits
23531 the integer multiply and integer divide instructions which exist in SPARC-V8
23532 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
23533 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
23534 2000 series.
23536 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
23537 the SPARC architecture.  This adds the integer multiply, integer divide step
23538 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
23539 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
23540 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
23541 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
23542 MB86934 chip, which is the more recent SPARClite with FPU@.
23544 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
23545 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
23546 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
23547 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
23548 optimizes it for the TEMIC SPARClet chip.
23550 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
23551 architecture.  This adds 64-bit integer and floating-point move instructions,
23552 3 additional floating-point condition code registers and conditional move
23553 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
23554 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
23555 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
23556 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
23557 @option{-mcpu=niagara}, the compiler additionally optimizes it for
23558 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
23559 additionally optimizes it for Sun UltraSPARC T2 chips. With
23560 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
23561 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
23562 additionally optimizes it for Sun UltraSPARC T4 chips.  With
23563 @option{-mcpu=niagara7}, the compiler additionally optimizes it for
23564 Oracle SPARC M7 chips.
23566 @item -mtune=@var{cpu_type}
23567 @opindex mtune
23568 Set the instruction scheduling parameters for machine type
23569 @var{cpu_type}, but do not set the instruction set or register set that the
23570 option @option{-mcpu=@var{cpu_type}} does.
23572 The same values for @option{-mcpu=@var{cpu_type}} can be used for
23573 @option{-mtune=@var{cpu_type}}, but the only useful values are those
23574 that select a particular CPU implementation.  Those are
23575 @samp{cypress}, @samp{supersparc}, @samp{hypersparc}, @samp{leon},
23576 @samp{leon3}, @samp{leon3v7}, @samp{f930}, @samp{f934},
23577 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
23578 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3},
23579 @samp{niagara4} and @samp{niagara7}.  With native Solaris and
23580 GNU/Linux toolchains, @samp{native} can also be used.
23582 @item -mv8plus
23583 @itemx -mno-v8plus
23584 @opindex mv8plus
23585 @opindex mno-v8plus
23586 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
23587 difference from the V8 ABI is that the global and out registers are
23588 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
23589 mode for all SPARC-V9 processors.
23591 @item -mvis
23592 @itemx -mno-vis
23593 @opindex mvis
23594 @opindex mno-vis
23595 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
23596 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
23598 @item -mvis2
23599 @itemx -mno-vis2
23600 @opindex mvis2
23601 @opindex mno-vis2
23602 With @option{-mvis2}, GCC generates code that takes advantage of
23603 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
23604 default is @option{-mvis2} when targeting a cpu that supports such
23605 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
23606 also sets @option{-mvis}.
23608 @item -mvis3
23609 @itemx -mno-vis3
23610 @opindex mvis3
23611 @opindex mno-vis3
23612 With @option{-mvis3}, GCC generates code that takes advantage of
23613 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
23614 default is @option{-mvis3} when targeting a cpu that supports such
23615 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
23616 also sets @option{-mvis2} and @option{-mvis}.
23618 @item -mvis4
23619 @itemx -mno-vis4
23620 @opindex mvis4
23621 @opindex mno-vis4
23622 With @option{-mvis4}, GCC generates code that takes advantage of
23623 version 4.0 of the UltraSPARC Visual Instruction Set extensions.  The
23624 default is @option{-mvis4} when targeting a cpu that supports such
23625 instructions, such as niagara-7 and later.  Setting @option{-mvis4}
23626 also sets @option{-mvis3}, @option{-mvis2} and @option{-mvis}.
23628 @item -mcbcond
23629 @itemx -mno-cbcond
23630 @opindex mcbcond
23631 @opindex mno-cbcond
23632 With @option{-mcbcond}, GCC generates code that takes advantage of the UltraSPARC
23633 Compare-and-Branch-on-Condition instructions.  The default is @option{-mcbcond}
23634 when targeting a CPU that supports such instructions, such as Niagara-4 and
23635 later.
23637 @item -mfmaf
23638 @itemx -mno-fmaf
23639 @opindex mfmaf
23640 @opindex mno-fmaf
23641 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
23642 Fused Multiply-Add Floating-point instructions.  The default is @option{-mfmaf}
23643 when targeting a CPU that supports such instructions, such as Niagara-3 and
23644 later.
23646 @item -mpopc
23647 @itemx -mno-popc
23648 @opindex mpopc
23649 @opindex mno-popc
23650 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
23651 Population Count instruction.  The default is @option{-mpopc}
23652 when targeting a CPU that supports such an instruction, such as Niagara-2 and
23653 later.
23655 @item -msubxc
23656 @itemx -mno-subxc
23657 @opindex msubxc
23658 @opindex mno-subxc
23659 With @option{-msubxc}, GCC generates code that takes advantage of the UltraSPARC
23660 Subtract-Extended-with-Carry instruction.  The default is @option{-msubxc}
23661 when targeting a CPU that supports such an instruction, such as Niagara-7 and
23662 later.
23664 @item -mfix-at697f
23665 @opindex mfix-at697f
23666 Enable the documented workaround for the single erratum of the Atmel AT697F
23667 processor (which corresponds to erratum #13 of the AT697E processor).
23669 @item -mfix-ut699
23670 @opindex mfix-ut699
23671 Enable the documented workarounds for the floating-point errata and the data
23672 cache nullify errata of the UT699 processor.
23673 @end table
23675 These @samp{-m} options are supported in addition to the above
23676 on SPARC-V9 processors in 64-bit environments:
23678 @table @gcctabopt
23679 @item -m32
23680 @itemx -m64
23681 @opindex m32
23682 @opindex m64
23683 Generate code for a 32-bit or 64-bit environment.
23684 The 32-bit environment sets int, long and pointer to 32 bits.
23685 The 64-bit environment sets int to 32 bits and long and pointer
23686 to 64 bits.
23688 @item -mcmodel=@var{which}
23689 @opindex mcmodel
23690 Set the code model to one of
23692 @table @samp
23693 @item medlow
23694 The Medium/Low code model: 64-bit addresses, programs
23695 must be linked in the low 32 bits of memory.  Programs can be statically
23696 or dynamically linked.
23698 @item medmid
23699 The Medium/Middle code model: 64-bit addresses, programs
23700 must be linked in the low 44 bits of memory, the text and data segments must
23701 be less than 2GB in size and the data segment must be located within 2GB of
23702 the text segment.
23704 @item medany
23705 The Medium/Anywhere code model: 64-bit addresses, programs
23706 may be linked anywhere in memory, the text and data segments must be less
23707 than 2GB in size and the data segment must be located within 2GB of the
23708 text segment.
23710 @item embmedany
23711 The Medium/Anywhere code model for embedded systems:
23712 64-bit addresses, the text and data segments must be less than 2GB in
23713 size, both starting anywhere in memory (determined at link time).  The
23714 global register %g4 points to the base of the data segment.  Programs
23715 are statically linked and PIC is not supported.
23716 @end table
23718 @item -mmemory-model=@var{mem-model}
23719 @opindex mmemory-model
23720 Set the memory model in force on the processor to one of
23722 @table @samp
23723 @item default
23724 The default memory model for the processor and operating system.
23726 @item rmo
23727 Relaxed Memory Order
23729 @item pso
23730 Partial Store Order
23732 @item tso
23733 Total Store Order
23735 @item sc
23736 Sequential Consistency
23737 @end table
23739 These memory models are formally defined in Appendix D of the SPARC-V9
23740 architecture manual, as set in the processor's @code{PSTATE.MM} field.
23742 @item -mstack-bias
23743 @itemx -mno-stack-bias
23744 @opindex mstack-bias
23745 @opindex mno-stack-bias
23746 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
23747 frame pointer if present, are offset by @minus{}2047 which must be added back
23748 when making stack frame references.  This is the default in 64-bit mode.
23749 Otherwise, assume no such offset is present.
23750 @end table
23752 @node SPU Options
23753 @subsection SPU Options
23754 @cindex SPU options
23756 These @samp{-m} options are supported on the SPU:
23758 @table @gcctabopt
23759 @item -mwarn-reloc
23760 @itemx -merror-reloc
23761 @opindex mwarn-reloc
23762 @opindex merror-reloc
23764 The loader for SPU does not handle dynamic relocations.  By default, GCC
23765 gives an error when it generates code that requires a dynamic
23766 relocation.  @option{-mno-error-reloc} disables the error,
23767 @option{-mwarn-reloc} generates a warning instead.
23769 @item -msafe-dma
23770 @itemx -munsafe-dma
23771 @opindex msafe-dma
23772 @opindex munsafe-dma
23774 Instructions that initiate or test completion of DMA must not be
23775 reordered with respect to loads and stores of the memory that is being
23776 accessed.
23777 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
23778 memory accesses, but that can lead to inefficient code in places where the
23779 memory is known to not change.  Rather than mark the memory as volatile,
23780 you can use @option{-msafe-dma} to tell the compiler to treat
23781 the DMA instructions as potentially affecting all memory.  
23783 @item -mbranch-hints
23784 @opindex mbranch-hints
23786 By default, GCC generates a branch hint instruction to avoid
23787 pipeline stalls for always-taken or probably-taken branches.  A hint
23788 is not generated closer than 8 instructions away from its branch.
23789 There is little reason to disable them, except for debugging purposes,
23790 or to make an object a little bit smaller.
23792 @item -msmall-mem
23793 @itemx -mlarge-mem
23794 @opindex msmall-mem
23795 @opindex mlarge-mem
23797 By default, GCC generates code assuming that addresses are never larger
23798 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
23799 a full 32-bit address.
23801 @item -mstdmain
23802 @opindex mstdmain
23804 By default, GCC links against startup code that assumes the SPU-style
23805 main function interface (which has an unconventional parameter list).
23806 With @option{-mstdmain}, GCC links your program against startup
23807 code that assumes a C99-style interface to @code{main}, including a
23808 local copy of @code{argv} strings.
23810 @item -mfixed-range=@var{register-range}
23811 @opindex mfixed-range
23812 Generate code treating the given register range as fixed registers.
23813 A fixed register is one that the register allocator cannot use.  This is
23814 useful when compiling kernel code.  A register range is specified as
23815 two registers separated by a dash.  Multiple register ranges can be
23816 specified separated by a comma.
23818 @item -mea32
23819 @itemx -mea64
23820 @opindex mea32
23821 @opindex mea64
23822 Compile code assuming that pointers to the PPU address space accessed
23823 via the @code{__ea} named address space qualifier are either 32 or 64
23824 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
23825 all object code in an executable must be compiled with the same setting.
23827 @item -maddress-space-conversion
23828 @itemx -mno-address-space-conversion
23829 @opindex maddress-space-conversion
23830 @opindex mno-address-space-conversion
23831 Allow/disallow treating the @code{__ea} address space as superset
23832 of the generic address space.  This enables explicit type casts
23833 between @code{__ea} and generic pointer as well as implicit
23834 conversions of generic pointers to @code{__ea} pointers.  The
23835 default is to allow address space pointer conversions.
23837 @item -mcache-size=@var{cache-size}
23838 @opindex mcache-size
23839 This option controls the version of libgcc that the compiler links to an
23840 executable and selects a software-managed cache for accessing variables
23841 in the @code{__ea} address space with a particular cache size.  Possible
23842 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
23843 and @samp{128}.  The default cache size is 64KB.
23845 @item -matomic-updates
23846 @itemx -mno-atomic-updates
23847 @opindex matomic-updates
23848 @opindex mno-atomic-updates
23849 This option controls the version of libgcc that the compiler links to an
23850 executable and selects whether atomic updates to the software-managed
23851 cache of PPU-side variables are used.  If you use atomic updates, changes
23852 to a PPU variable from SPU code using the @code{__ea} named address space
23853 qualifier do not interfere with changes to other PPU variables residing
23854 in the same cache line from PPU code.  If you do not use atomic updates,
23855 such interference may occur; however, writing back cache lines is
23856 more efficient.  The default behavior is to use atomic updates.
23858 @item -mdual-nops
23859 @itemx -mdual-nops=@var{n}
23860 @opindex mdual-nops
23861 By default, GCC inserts NOPs to increase dual issue when it expects
23862 it to increase performance.  @var{n} can be a value from 0 to 10.  A
23863 smaller @var{n} inserts fewer NOPs.  10 is the default, 0 is the
23864 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
23866 @item -mhint-max-nops=@var{n}
23867 @opindex mhint-max-nops
23868 Maximum number of NOPs to insert for a branch hint.  A branch hint must
23869 be at least 8 instructions away from the branch it is affecting.  GCC
23870 inserts up to @var{n} NOPs to enforce this, otherwise it does not
23871 generate the branch hint.
23873 @item -mhint-max-distance=@var{n}
23874 @opindex mhint-max-distance
23875 The encoding of the branch hint instruction limits the hint to be within
23876 256 instructions of the branch it is affecting.  By default, GCC makes
23877 sure it is within 125.
23879 @item -msafe-hints
23880 @opindex msafe-hints
23881 Work around a hardware bug that causes the SPU to stall indefinitely.
23882 By default, GCC inserts the @code{hbrp} instruction to make sure
23883 this stall won't happen.
23885 @end table
23887 @node System V Options
23888 @subsection Options for System V
23890 These additional options are available on System V Release 4 for
23891 compatibility with other compilers on those systems:
23893 @table @gcctabopt
23894 @item -G
23895 @opindex G
23896 Create a shared object.
23897 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
23899 @item -Qy
23900 @opindex Qy
23901 Identify the versions of each tool used by the compiler, in a
23902 @code{.ident} assembler directive in the output.
23904 @item -Qn
23905 @opindex Qn
23906 Refrain from adding @code{.ident} directives to the output file (this is
23907 the default).
23909 @item -YP,@var{dirs}
23910 @opindex YP
23911 Search the directories @var{dirs}, and no others, for libraries
23912 specified with @option{-l}.
23914 @item -Ym,@var{dir}
23915 @opindex Ym
23916 Look in the directory @var{dir} to find the M4 preprocessor.
23917 The assembler uses this option.
23918 @c This is supposed to go with a -Yd for predefined M4 macro files, but
23919 @c the generic assembler that comes with Solaris takes just -Ym.
23920 @end table
23922 @node TILE-Gx Options
23923 @subsection TILE-Gx Options
23924 @cindex TILE-Gx options
23926 These @samp{-m} options are supported on the TILE-Gx:
23928 @table @gcctabopt
23929 @item -mcmodel=small
23930 @opindex mcmodel=small
23931 Generate code for the small model.  The distance for direct calls is
23932 limited to 500M in either direction.  PC-relative addresses are 32
23933 bits.  Absolute addresses support the full address range.
23935 @item -mcmodel=large
23936 @opindex mcmodel=large
23937 Generate code for the large model.  There is no limitation on call
23938 distance, pc-relative addresses, or absolute addresses.
23940 @item -mcpu=@var{name}
23941 @opindex mcpu
23942 Selects the type of CPU to be targeted.  Currently the only supported
23943 type is @samp{tilegx}.
23945 @item -m32
23946 @itemx -m64
23947 @opindex m32
23948 @opindex m64
23949 Generate code for a 32-bit or 64-bit environment.  The 32-bit
23950 environment sets int, long, and pointer to 32 bits.  The 64-bit
23951 environment sets int to 32 bits and long and pointer to 64 bits.
23953 @item -mbig-endian
23954 @itemx -mlittle-endian
23955 @opindex mbig-endian
23956 @opindex mlittle-endian
23957 Generate code in big/little endian mode, respectively.
23958 @end table
23960 @node TILEPro Options
23961 @subsection TILEPro Options
23962 @cindex TILEPro options
23964 These @samp{-m} options are supported on the TILEPro:
23966 @table @gcctabopt
23967 @item -mcpu=@var{name}
23968 @opindex mcpu
23969 Selects the type of CPU to be targeted.  Currently the only supported
23970 type is @samp{tilepro}.
23972 @item -m32
23973 @opindex m32
23974 Generate code for a 32-bit environment, which sets int, long, and
23975 pointer to 32 bits.  This is the only supported behavior so the flag
23976 is essentially ignored.
23977 @end table
23979 @node V850 Options
23980 @subsection V850 Options
23981 @cindex V850 Options
23983 These @samp{-m} options are defined for V850 implementations:
23985 @table @gcctabopt
23986 @item -mlong-calls
23987 @itemx -mno-long-calls
23988 @opindex mlong-calls
23989 @opindex mno-long-calls
23990 Treat all calls as being far away (near).  If calls are assumed to be
23991 far away, the compiler always loads the function's address into a
23992 register, and calls indirect through the pointer.
23994 @item -mno-ep
23995 @itemx -mep
23996 @opindex mno-ep
23997 @opindex mep
23998 Do not optimize (do optimize) basic blocks that use the same index
23999 pointer 4 or more times to copy pointer into the @code{ep} register, and
24000 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
24001 option is on by default if you optimize.
24003 @item -mno-prolog-function
24004 @itemx -mprolog-function
24005 @opindex mno-prolog-function
24006 @opindex mprolog-function
24007 Do not use (do use) external functions to save and restore registers
24008 at the prologue and epilogue of a function.  The external functions
24009 are slower, but use less code space if more than one function saves
24010 the same number of registers.  The @option{-mprolog-function} option
24011 is on by default if you optimize.
24013 @item -mspace
24014 @opindex mspace
24015 Try to make the code as small as possible.  At present, this just turns
24016 on the @option{-mep} and @option{-mprolog-function} options.
24018 @item -mtda=@var{n}
24019 @opindex mtda
24020 Put static or global variables whose size is @var{n} bytes or less into
24021 the tiny data area that register @code{ep} points to.  The tiny data
24022 area can hold up to 256 bytes in total (128 bytes for byte references).
24024 @item -msda=@var{n}
24025 @opindex msda
24026 Put static or global variables whose size is @var{n} bytes or less into
24027 the small data area that register @code{gp} points to.  The small data
24028 area can hold up to 64 kilobytes.
24030 @item -mzda=@var{n}
24031 @opindex mzda
24032 Put static or global variables whose size is @var{n} bytes or less into
24033 the first 32 kilobytes of memory.
24035 @item -mv850
24036 @opindex mv850
24037 Specify that the target processor is the V850.
24039 @item -mv850e3v5
24040 @opindex mv850e3v5
24041 Specify that the target processor is the V850E3V5.  The preprocessor
24042 constant @code{__v850e3v5__} is defined if this option is used.
24044 @item -mv850e2v4
24045 @opindex mv850e2v4
24046 Specify that the target processor is the V850E3V5.  This is an alias for
24047 the @option{-mv850e3v5} option.
24049 @item -mv850e2v3
24050 @opindex mv850e2v3
24051 Specify that the target processor is the V850E2V3.  The preprocessor
24052 constant @code{__v850e2v3__} is defined if this option is used.
24054 @item -mv850e2
24055 @opindex mv850e2
24056 Specify that the target processor is the V850E2.  The preprocessor
24057 constant @code{__v850e2__} is defined if this option is used.
24059 @item -mv850e1
24060 @opindex mv850e1
24061 Specify that the target processor is the V850E1.  The preprocessor
24062 constants @code{__v850e1__} and @code{__v850e__} are defined if
24063 this option is used.
24065 @item -mv850es
24066 @opindex mv850es
24067 Specify that the target processor is the V850ES.  This is an alias for
24068 the @option{-mv850e1} option.
24070 @item -mv850e
24071 @opindex mv850e
24072 Specify that the target processor is the V850E@.  The preprocessor
24073 constant @code{__v850e__} is defined if this option is used.
24075 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
24076 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
24077 are defined then a default target processor is chosen and the
24078 relevant @samp{__v850*__} preprocessor constant is defined.
24080 The preprocessor constants @code{__v850} and @code{__v851__} are always
24081 defined, regardless of which processor variant is the target.
24083 @item -mdisable-callt
24084 @itemx -mno-disable-callt
24085 @opindex mdisable-callt
24086 @opindex mno-disable-callt
24087 This option suppresses generation of the @code{CALLT} instruction for the
24088 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
24089 architecture.
24091 This option is enabled by default when the RH850 ABI is
24092 in use (see @option{-mrh850-abi}), and disabled by default when the
24093 GCC ABI is in use.  If @code{CALLT} instructions are being generated
24094 then the C preprocessor symbol @code{__V850_CALLT__} is defined.
24096 @item -mrelax
24097 @itemx -mno-relax
24098 @opindex mrelax
24099 @opindex mno-relax
24100 Pass on (or do not pass on) the @option{-mrelax} command-line option
24101 to the assembler.
24103 @item -mlong-jumps
24104 @itemx -mno-long-jumps
24105 @opindex mlong-jumps
24106 @opindex mno-long-jumps
24107 Disable (or re-enable) the generation of PC-relative jump instructions.
24109 @item -msoft-float
24110 @itemx -mhard-float
24111 @opindex msoft-float
24112 @opindex mhard-float
24113 Disable (or re-enable) the generation of hardware floating point
24114 instructions.  This option is only significant when the target
24115 architecture is @samp{V850E2V3} or higher.  If hardware floating point
24116 instructions are being generated then the C preprocessor symbol
24117 @code{__FPU_OK__} is defined, otherwise the symbol
24118 @code{__NO_FPU__} is defined.
24120 @item -mloop
24121 @opindex mloop
24122 Enables the use of the e3v5 LOOP instruction.  The use of this
24123 instruction is not enabled by default when the e3v5 architecture is
24124 selected because its use is still experimental.
24126 @item -mrh850-abi
24127 @itemx -mghs
24128 @opindex mrh850-abi
24129 @opindex mghs
24130 Enables support for the RH850 version of the V850 ABI.  This is the
24131 default.  With this version of the ABI the following rules apply:
24133 @itemize
24134 @item
24135 Integer sized structures and unions are returned via a memory pointer
24136 rather than a register.
24138 @item
24139 Large structures and unions (more than 8 bytes in size) are passed by
24140 value.
24142 @item
24143 Functions are aligned to 16-bit boundaries.
24145 @item
24146 The @option{-m8byte-align} command-line option is supported.
24148 @item
24149 The @option{-mdisable-callt} command-line option is enabled by
24150 default.  The @option{-mno-disable-callt} command-line option is not
24151 supported.
24152 @end itemize
24154 When this version of the ABI is enabled the C preprocessor symbol
24155 @code{__V850_RH850_ABI__} is defined.
24157 @item -mgcc-abi
24158 @opindex mgcc-abi
24159 Enables support for the old GCC version of the V850 ABI.  With this
24160 version of the ABI the following rules apply:
24162 @itemize
24163 @item
24164 Integer sized structures and unions are returned in register @code{r10}.
24166 @item
24167 Large structures and unions (more than 8 bytes in size) are passed by
24168 reference.
24170 @item
24171 Functions are aligned to 32-bit boundaries, unless optimizing for
24172 size.
24174 @item
24175 The @option{-m8byte-align} command-line option is not supported.
24177 @item
24178 The @option{-mdisable-callt} command-line option is supported but not
24179 enabled by default.
24180 @end itemize
24182 When this version of the ABI is enabled the C preprocessor symbol
24183 @code{__V850_GCC_ABI__} is defined.
24185 @item -m8byte-align
24186 @itemx -mno-8byte-align
24187 @opindex m8byte-align
24188 @opindex mno-8byte-align
24189 Enables support for @code{double} and @code{long long} types to be
24190 aligned on 8-byte boundaries.  The default is to restrict the
24191 alignment of all objects to at most 4-bytes.  When
24192 @option{-m8byte-align} is in effect the C preprocessor symbol
24193 @code{__V850_8BYTE_ALIGN__} is defined.
24195 @item -mbig-switch
24196 @opindex mbig-switch
24197 Generate code suitable for big switch tables.  Use this option only if
24198 the assembler/linker complain about out of range branches within a switch
24199 table.
24201 @item -mapp-regs
24202 @opindex mapp-regs
24203 This option causes r2 and r5 to be used in the code generated by
24204 the compiler.  This setting is the default.
24206 @item -mno-app-regs
24207 @opindex mno-app-regs
24208 This option causes r2 and r5 to be treated as fixed registers.
24210 @end table
24212 @node VAX Options
24213 @subsection VAX Options
24214 @cindex VAX options
24216 These @samp{-m} options are defined for the VAX:
24218 @table @gcctabopt
24219 @item -munix
24220 @opindex munix
24221 Do not output certain jump instructions (@code{aobleq} and so on)
24222 that the Unix assembler for the VAX cannot handle across long
24223 ranges.
24225 @item -mgnu
24226 @opindex mgnu
24227 Do output those jump instructions, on the assumption that the
24228 GNU assembler is being used.
24230 @item -mg
24231 @opindex mg
24232 Output code for G-format floating-point numbers instead of D-format.
24233 @end table
24235 @node Visium Options
24236 @subsection Visium Options
24237 @cindex Visium options
24239 @table @gcctabopt
24241 @item -mdebug
24242 @opindex mdebug
24243 A program which performs file I/O and is destined to run on an MCM target
24244 should be linked with this option.  It causes the libraries libc.a and
24245 libdebug.a to be linked.  The program should be run on the target under
24246 the control of the GDB remote debugging stub.
24248 @item -msim
24249 @opindex msim
24250 A program which performs file I/O and is destined to run on the simulator
24251 should be linked with option.  This causes libraries libc.a and libsim.a to
24252 be linked.
24254 @item -mfpu
24255 @itemx -mhard-float
24256 @opindex mfpu
24257 @opindex mhard-float
24258 Generate code containing floating-point instructions.  This is the
24259 default.
24261 @item -mno-fpu
24262 @itemx -msoft-float
24263 @opindex mno-fpu
24264 @opindex msoft-float
24265 Generate code containing library calls for floating-point.
24267 @option{-msoft-float} changes the calling convention in the output file;
24268 therefore, it is only useful if you compile @emph{all} of a program with
24269 this option.  In particular, you need to compile @file{libgcc.a}, the
24270 library that comes with GCC, with @option{-msoft-float} in order for
24271 this to work.
24273 @item -mcpu=@var{cpu_type}
24274 @opindex mcpu
24275 Set the instruction set, register set, and instruction scheduling parameters
24276 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
24277 @samp{mcm}, @samp{gr5} and @samp{gr6}.
24279 @samp{mcm} is a synonym of @samp{gr5} present for backward compatibility.
24281 By default (unless configured otherwise), GCC generates code for the GR5
24282 variant of the Visium architecture.  
24284 With @option{-mcpu=gr6}, GCC generates code for the GR6 variant of the Visium
24285 architecture.  The only difference from GR5 code is that the compiler will
24286 generate block move instructions.
24288 @item -mtune=@var{cpu_type}
24289 @opindex mtune
24290 Set the instruction scheduling parameters for machine type @var{cpu_type},
24291 but do not set the instruction set or register set that the option
24292 @option{-mcpu=@var{cpu_type}} would.
24294 @item -msv-mode
24295 @opindex msv-mode
24296 Generate code for the supervisor mode, where there are no restrictions on
24297 the access to general registers.  This is the default.
24299 @item -muser-mode
24300 @opindex muser-mode
24301 Generate code for the user mode, where the access to some general registers
24302 is forbidden: on the GR5, registers r24 to r31 cannot be accessed in this
24303 mode; on the GR6, only registers r29 to r31 are affected.
24304 @end table
24306 @node VMS Options
24307 @subsection VMS Options
24309 These @samp{-m} options are defined for the VMS implementations:
24311 @table @gcctabopt
24312 @item -mvms-return-codes
24313 @opindex mvms-return-codes
24314 Return VMS condition codes from @code{main}. The default is to return POSIX-style
24315 condition (e.g.@ error) codes.
24317 @item -mdebug-main=@var{prefix}
24318 @opindex mdebug-main=@var{prefix}
24319 Flag the first routine whose name starts with @var{prefix} as the main
24320 routine for the debugger.
24322 @item -mmalloc64
24323 @opindex mmalloc64
24324 Default to 64-bit memory allocation routines.
24326 @item -mpointer-size=@var{size}
24327 @opindex mpointer-size=@var{size}
24328 Set the default size of pointers. Possible options for @var{size} are
24329 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
24330 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
24331 The later option disables @code{pragma pointer_size}.
24332 @end table
24334 @node VxWorks Options
24335 @subsection VxWorks Options
24336 @cindex VxWorks Options
24338 The options in this section are defined for all VxWorks targets.
24339 Options specific to the target hardware are listed with the other
24340 options for that target.
24342 @table @gcctabopt
24343 @item -mrtp
24344 @opindex mrtp
24345 GCC can generate code for both VxWorks kernels and real time processes
24346 (RTPs).  This option switches from the former to the latter.  It also
24347 defines the preprocessor macro @code{__RTP__}.
24349 @item -non-static
24350 @opindex non-static
24351 Link an RTP executable against shared libraries rather than static
24352 libraries.  The options @option{-static} and @option{-shared} can
24353 also be used for RTPs (@pxref{Link Options}); @option{-static}
24354 is the default.
24356 @item -Bstatic
24357 @itemx -Bdynamic
24358 @opindex Bstatic
24359 @opindex Bdynamic
24360 These options are passed down to the linker.  They are defined for
24361 compatibility with Diab.
24363 @item -Xbind-lazy
24364 @opindex Xbind-lazy
24365 Enable lazy binding of function calls.  This option is equivalent to
24366 @option{-Wl,-z,now} and is defined for compatibility with Diab.
24368 @item -Xbind-now
24369 @opindex Xbind-now
24370 Disable lazy binding of function calls.  This option is the default and
24371 is defined for compatibility with Diab.
24372 @end table
24374 @node x86 Options
24375 @subsection x86 Options
24376 @cindex x86 Options
24378 These @samp{-m} options are defined for the x86 family of computers.
24380 @table @gcctabopt
24382 @item -march=@var{cpu-type}
24383 @opindex march
24384 Generate instructions for the machine type @var{cpu-type}.  In contrast to
24385 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
24386 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
24387 to generate code that may not run at all on processors other than the one
24388 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
24389 @option{-mtune=@var{cpu-type}}.
24391 The choices for @var{cpu-type} are:
24393 @table @samp
24394 @item native
24395 This selects the CPU to generate code for at compilation time by determining
24396 the processor type of the compiling machine.  Using @option{-march=native}
24397 enables all instruction subsets supported by the local machine (hence
24398 the result might not run on different machines).  Using @option{-mtune=native}
24399 produces code optimized for the local machine under the constraints
24400 of the selected instruction set.  
24402 @item i386
24403 Original Intel i386 CPU@.
24405 @item i486
24406 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
24408 @item i586
24409 @itemx pentium
24410 Intel Pentium CPU with no MMX support.
24412 @item lakemont
24413 Intel Lakemont MCU, based on Intel Pentium CPU.
24415 @item pentium-mmx
24416 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
24418 @item pentiumpro
24419 Intel Pentium Pro CPU@.
24421 @item i686
24422 When used with @option{-march}, the Pentium Pro
24423 instruction set is used, so the code runs on all i686 family chips.
24424 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
24426 @item pentium2
24427 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
24428 support.
24430 @item pentium3
24431 @itemx pentium3m
24432 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
24433 set support.
24435 @item pentium-m
24436 Intel Pentium M; low-power version of Intel Pentium III CPU
24437 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
24439 @item pentium4
24440 @itemx pentium4m
24441 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
24443 @item prescott
24444 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
24445 set support.
24447 @item nocona
24448 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
24449 SSE2 and SSE3 instruction set support.
24451 @item core2
24452 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
24453 instruction set support.
24455 @item nehalem
24456 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
24457 SSE4.1, SSE4.2 and POPCNT instruction set support.
24459 @item westmere
24460 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
24461 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
24463 @item sandybridge
24464 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
24465 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
24467 @item ivybridge
24468 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
24469 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
24470 instruction set support.
24472 @item haswell
24473 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
24474 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24475 BMI, BMI2 and F16C instruction set support.
24477 @item broadwell
24478 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
24479 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24480 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
24482 @item skylake
24483 Intel Skylake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
24484 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24485 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC and
24486 XSAVES instruction set support.
24488 @item bonnell
24489 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
24490 instruction set support.
24492 @item silvermont
24493 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
24494 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
24496 @item knl
24497 Intel Knight's Landing CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
24498 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24499 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER and
24500 AVX512CD instruction set support.
24502 @item skylake-avx512
24503 Intel Skylake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
24504 SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24505 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F,
24506 AVX512VL, AVX512BW, AVX512DQ and AVX512CD instruction set support.
24508 @item k6
24509 AMD K6 CPU with MMX instruction set support.
24511 @item k6-2
24512 @itemx k6-3
24513 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
24515 @item athlon
24516 @itemx athlon-tbird
24517 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
24518 support.
24520 @item athlon-4
24521 @itemx athlon-xp
24522 @itemx athlon-mp
24523 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
24524 instruction set support.
24526 @item k8
24527 @itemx opteron
24528 @itemx athlon64
24529 @itemx athlon-fx
24530 Processors based on the AMD K8 core with x86-64 instruction set support,
24531 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
24532 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
24533 instruction set extensions.)
24535 @item k8-sse3
24536 @itemx opteron-sse3
24537 @itemx athlon64-sse3
24538 Improved versions of AMD K8 cores with SSE3 instruction set support.
24540 @item amdfam10
24541 @itemx barcelona
24542 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
24543 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
24544 instruction set extensions.)
24546 @item bdver1
24547 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
24548 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
24549 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
24550 @item bdver2
24551 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
24552 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
24553 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
24554 extensions.)
24555 @item bdver3
24556 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
24557 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
24558 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
24559 64-bit instruction set extensions.
24560 @item bdver4
24561 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
24562 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
24563 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
24564 SSE4.2, ABM and 64-bit instruction set extensions.
24566 @item znver1
24567 AMD Family 17h core based CPUs with x86-64 instruction set support.  (This
24568 supersets BMI, BMI2, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX,
24569 SHA, CLZERO, AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3,
24570 SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, and 64-bit
24571 instruction set extensions.
24573 @item btver1
24574 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
24575 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
24576 instruction set extensions.)
24578 @item btver2
24579 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
24580 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
24581 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
24583 @item winchip-c6
24584 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
24585 set support.
24587 @item winchip2
24588 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
24589 instruction set support.
24591 @item c3
24592 VIA C3 CPU with MMX and 3DNow!@: instruction set support.
24593 (No scheduling is implemented for this chip.)
24595 @item c3-2
24596 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
24597 (No scheduling is implemented for this chip.)
24599 @item c7
24600 VIA C7 (Esther) CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
24601 (No scheduling is implemented for this chip.)
24603 @item samuel-2
24604 VIA Eden Samuel 2 CPU with MMX and 3DNow!@: instruction set support.
24605 (No scheduling is implemented for this chip.)
24607 @item nehemiah
24608 VIA Eden Nehemiah CPU with MMX and SSE instruction set support.
24609 (No scheduling is implemented for this chip.)
24611 @item esther
24612 VIA Eden Esther CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
24613 (No scheduling is implemented for this chip.)
24615 @item eden-x2
24616 VIA Eden X2 CPU with x86-64, MMX, SSE, SSE2 and SSE3 instruction set support.
24617 (No scheduling is implemented for this chip.)
24619 @item eden-x4
24620 VIA Eden X4 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2,
24621 AVX and AVX2 instruction set support.
24622 (No scheduling is implemented for this chip.)
24624 @item nano
24625 Generic VIA Nano CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
24626 instruction set support.
24627 (No scheduling is implemented for this chip.)
24629 @item nano-1000
24630 VIA Nano 1xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
24631 instruction set support.
24632 (No scheduling is implemented for this chip.)
24634 @item nano-2000
24635 VIA Nano 2xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
24636 instruction set support.
24637 (No scheduling is implemented for this chip.)
24639 @item nano-3000
24640 VIA Nano 3xxx CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
24641 instruction set support.
24642 (No scheduling is implemented for this chip.)
24644 @item nano-x2
24645 VIA Nano Dual Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
24646 instruction set support.
24647 (No scheduling is implemented for this chip.)
24649 @item nano-x4
24650 VIA Nano Quad Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
24651 instruction set support.
24652 (No scheduling is implemented for this chip.)
24654 @item geode
24655 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
24656 @end table
24658 @item -mtune=@var{cpu-type}
24659 @opindex mtune
24660 Tune to @var{cpu-type} everything applicable about the generated code, except
24661 for the ABI and the set of available instructions.  
24662 While picking a specific @var{cpu-type} schedules things appropriately
24663 for that particular chip, the compiler does not generate any code that
24664 cannot run on the default machine type unless you use a
24665 @option{-march=@var{cpu-type}} option.
24666 For example, if GCC is configured for i686-pc-linux-gnu
24667 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
24668 but still runs on i686 machines.
24670 The choices for @var{cpu-type} are the same as for @option{-march}.
24671 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
24673 @table @samp
24674 @item generic
24675 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
24676 If you know the CPU on which your code will run, then you should use
24677 the corresponding @option{-mtune} or @option{-march} option instead of
24678 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
24679 of your application will have, then you should use this option.
24681 As new processors are deployed in the marketplace, the behavior of this
24682 option will change.  Therefore, if you upgrade to a newer version of
24683 GCC, code generation controlled by this option will change to reflect
24684 the processors
24685 that are most common at the time that version of GCC is released.
24687 There is no @option{-march=generic} option because @option{-march}
24688 indicates the instruction set the compiler can use, and there is no
24689 generic instruction set applicable to all processors.  In contrast,
24690 @option{-mtune} indicates the processor (or, in this case, collection of
24691 processors) for which the code is optimized.
24693 @item intel
24694 Produce code optimized for the most current Intel processors, which are
24695 Haswell and Silvermont for this version of GCC.  If you know the CPU
24696 on which your code will run, then you should use the corresponding
24697 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
24698 But, if you want your application performs better on both Haswell and
24699 Silvermont, then you should use this option.
24701 As new Intel processors are deployed in the marketplace, the behavior of
24702 this option will change.  Therefore, if you upgrade to a newer version of
24703 GCC, code generation controlled by this option will change to reflect
24704 the most current Intel processors at the time that version of GCC is
24705 released.
24707 There is no @option{-march=intel} option because @option{-march} indicates
24708 the instruction set the compiler can use, and there is no common
24709 instruction set applicable to all processors.  In contrast,
24710 @option{-mtune} indicates the processor (or, in this case, collection of
24711 processors) for which the code is optimized.
24712 @end table
24714 @item -mcpu=@var{cpu-type}
24715 @opindex mcpu
24716 A deprecated synonym for @option{-mtune}.
24718 @item -mfpmath=@var{unit}
24719 @opindex mfpmath
24720 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
24721 for @var{unit} are:
24723 @table @samp
24724 @item 387
24725 Use the standard 387 floating-point coprocessor present on the majority of chips and
24726 emulated otherwise.  Code compiled with this option runs almost everywhere.
24727 The temporary results are computed in 80-bit precision instead of the precision
24728 specified by the type, resulting in slightly different results compared to most
24729 of other chips.  See @option{-ffloat-store} for more detailed description.
24731 This is the default choice for non-Darwin x86-32 targets.
24733 @item sse
24734 Use scalar floating-point instructions present in the SSE instruction set.
24735 This instruction set is supported by Pentium III and newer chips,
24736 and in the AMD line
24737 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
24738 instruction set supports only single-precision arithmetic, thus the double and
24739 extended-precision arithmetic are still done using 387.  A later version, present
24740 only in Pentium 4 and AMD x86-64 chips, supports double-precision
24741 arithmetic too.
24743 For the x86-32 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
24744 or @option{-msse2} switches to enable SSE extensions and make this option
24745 effective.  For the x86-64 compiler, these extensions are enabled by default.
24747 The resulting code should be considerably faster in the majority of cases and avoid
24748 the numerical instability problems of 387 code, but may break some existing
24749 code that expects temporaries to be 80 bits.
24751 This is the default choice for the x86-64 compiler, Darwin x86-32 targets,
24752 and the default choice for x86-32 targets with the SSE2 instruction set
24753 when @option{-ffast-math} is enabled.
24755 @item sse,387
24756 @itemx sse+387
24757 @itemx both
24758 Attempt to utilize both instruction sets at once.  This effectively doubles the
24759 amount of available registers, and on chips with separate execution units for
24760 387 and SSE the execution resources too.  Use this option with care, as it is
24761 still experimental, because the GCC register allocator does not model separate
24762 functional units well, resulting in unstable performance.
24763 @end table
24765 @item -masm=@var{dialect}
24766 @opindex masm=@var{dialect}
24767 Output assembly instructions using selected @var{dialect}.  Also affects
24768 which dialect is used for basic @code{asm} (@pxref{Basic Asm}) and
24769 extended @code{asm} (@pxref{Extended Asm}). Supported choices (in dialect
24770 order) are @samp{att} or @samp{intel}. The default is @samp{att}. Darwin does
24771 not support @samp{intel}.
24773 @item -mieee-fp
24774 @itemx -mno-ieee-fp
24775 @opindex mieee-fp
24776 @opindex mno-ieee-fp
24777 Control whether or not the compiler uses IEEE floating-point
24778 comparisons.  These correctly handle the case where the result of a
24779 comparison is unordered.
24781 @item -m80387
24782 @item -mhard-float
24783 @opindex 80387
24784 @opindex mhard-float
24785 Generate output containing 80387 instructions for floating point.
24787 @item -mno-80387
24788 @item -msoft-float
24789 @opindex no-80387
24790 @opindex msoft-float
24791 Generate output containing library calls for floating point.
24793 @strong{Warning:} the requisite libraries are not part of GCC@.
24794 Normally the facilities of the machine's usual C compiler are used, but
24795 this cannot be done directly in cross-compilation.  You must make your
24796 own arrangements to provide suitable library functions for
24797 cross-compilation.
24799 On machines where a function returns floating-point results in the 80387
24800 register stack, some floating-point opcodes may be emitted even if
24801 @option{-msoft-float} is used.
24803 @item -mno-fp-ret-in-387
24804 @opindex mno-fp-ret-in-387
24805 Do not use the FPU registers for return values of functions.
24807 The usual calling convention has functions return values of types
24808 @code{float} and @code{double} in an FPU register, even if there
24809 is no FPU@.  The idea is that the operating system should emulate
24810 an FPU@.
24812 The option @option{-mno-fp-ret-in-387} causes such values to be returned
24813 in ordinary CPU registers instead.
24815 @item -mno-fancy-math-387
24816 @opindex mno-fancy-math-387
24817 Some 387 emulators do not support the @code{sin}, @code{cos} and
24818 @code{sqrt} instructions for the 387.  Specify this option to avoid
24819 generating those instructions.  This option is the default on
24820 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
24821 indicates that the target CPU always has an FPU and so the
24822 instruction does not need emulation.  These
24823 instructions are not generated unless you also use the
24824 @option{-funsafe-math-optimizations} switch.
24826 @item -malign-double
24827 @itemx -mno-align-double
24828 @opindex malign-double
24829 @opindex mno-align-double
24830 Control whether GCC aligns @code{double}, @code{long double}, and
24831 @code{long long} variables on a two-word boundary or a one-word
24832 boundary.  Aligning @code{double} variables on a two-word boundary
24833 produces code that runs somewhat faster on a Pentium at the
24834 expense of more memory.
24836 On x86-64, @option{-malign-double} is enabled by default.
24838 @strong{Warning:} if you use the @option{-malign-double} switch,
24839 structures containing the above types are aligned differently than
24840 the published application binary interface specifications for the x86-32
24841 and are not binary compatible with structures in code compiled
24842 without that switch.
24844 @item -m96bit-long-double
24845 @itemx -m128bit-long-double
24846 @opindex m96bit-long-double
24847 @opindex m128bit-long-double
24848 These switches control the size of @code{long double} type.  The x86-32
24849 application binary interface specifies the size to be 96 bits,
24850 so @option{-m96bit-long-double} is the default in 32-bit mode.
24852 Modern architectures (Pentium and newer) prefer @code{long double}
24853 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
24854 conforming to the ABI, this is not possible.  So specifying
24855 @option{-m128bit-long-double} aligns @code{long double}
24856 to a 16-byte boundary by padding the @code{long double} with an additional
24857 32-bit zero.
24859 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
24860 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
24862 Notice that neither of these options enable any extra precision over the x87
24863 standard of 80 bits for a @code{long double}.
24865 @strong{Warning:} if you override the default value for your target ABI, this
24866 changes the size of 
24867 structures and arrays containing @code{long double} variables,
24868 as well as modifying the function calling convention for functions taking
24869 @code{long double}.  Hence they are not binary-compatible
24870 with code compiled without that switch.
24872 @item -mlong-double-64
24873 @itemx -mlong-double-80
24874 @itemx -mlong-double-128
24875 @opindex mlong-double-64
24876 @opindex mlong-double-80
24877 @opindex mlong-double-128
24878 These switches control the size of @code{long double} type. A size
24879 of 64 bits makes the @code{long double} type equivalent to the @code{double}
24880 type. This is the default for 32-bit Bionic C library.  A size
24881 of 128 bits makes the @code{long double} type equivalent to the
24882 @code{__float128} type. This is the default for 64-bit Bionic C library.
24884 @strong{Warning:} if you override the default value for your target ABI, this
24885 changes the size of
24886 structures and arrays containing @code{long double} variables,
24887 as well as modifying the function calling convention for functions taking
24888 @code{long double}.  Hence they are not binary-compatible
24889 with code compiled without that switch.
24891 @item -malign-data=@var{type}
24892 @opindex malign-data
24893 Control how GCC aligns variables.  Supported values for @var{type} are
24894 @samp{compat} uses increased alignment value compatible uses GCC 4.8
24895 and earlier, @samp{abi} uses alignment value as specified by the
24896 psABI, and @samp{cacheline} uses increased alignment value to match
24897 the cache line size.  @samp{compat} is the default.
24899 @item -mlarge-data-threshold=@var{threshold}
24900 @opindex mlarge-data-threshold
24901 When @option{-mcmodel=medium} is specified, data objects larger than
24902 @var{threshold} are placed in the large data section.  This value must be the
24903 same across all objects linked into the binary, and defaults to 65535.
24905 @item -mrtd
24906 @opindex mrtd
24907 Use a different function-calling convention, in which functions that
24908 take a fixed number of arguments return with the @code{ret @var{num}}
24909 instruction, which pops their arguments while returning.  This saves one
24910 instruction in the caller since there is no need to pop the arguments
24911 there.
24913 You can specify that an individual function is called with this calling
24914 sequence with the function attribute @code{stdcall}.  You can also
24915 override the @option{-mrtd} option by using the function attribute
24916 @code{cdecl}.  @xref{Function Attributes}.
24918 @strong{Warning:} this calling convention is incompatible with the one
24919 normally used on Unix, so you cannot use it if you need to call
24920 libraries compiled with the Unix compiler.
24922 Also, you must provide function prototypes for all functions that
24923 take variable numbers of arguments (including @code{printf});
24924 otherwise incorrect code is generated for calls to those
24925 functions.
24927 In addition, seriously incorrect code results if you call a
24928 function with too many arguments.  (Normally, extra arguments are
24929 harmlessly ignored.)
24931 @item -mregparm=@var{num}
24932 @opindex mregparm
24933 Control how many registers are used to pass integer arguments.  By
24934 default, no registers are used to pass arguments, and at most 3
24935 registers can be used.  You can control this behavior for a specific
24936 function by using the function attribute @code{regparm}.
24937 @xref{Function Attributes}.
24939 @strong{Warning:} if you use this switch, and
24940 @var{num} is nonzero, then you must build all modules with the same
24941 value, including any libraries.  This includes the system libraries and
24942 startup modules.
24944 @item -msseregparm
24945 @opindex msseregparm
24946 Use SSE register passing conventions for float and double arguments
24947 and return values.  You can control this behavior for a specific
24948 function by using the function attribute @code{sseregparm}.
24949 @xref{Function Attributes}.
24951 @strong{Warning:} if you use this switch then you must build all
24952 modules with the same value, including any libraries.  This includes
24953 the system libraries and startup modules.
24955 @item -mvect8-ret-in-mem
24956 @opindex mvect8-ret-in-mem
24957 Return 8-byte vectors in memory instead of MMX registers.  This is the
24958 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
24959 Studio compilers until version 12.  Later compiler versions (starting
24960 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
24961 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
24962 you need to remain compatible with existing code produced by those
24963 previous compiler versions or older versions of GCC@.
24965 @item -mpc32
24966 @itemx -mpc64
24967 @itemx -mpc80
24968 @opindex mpc32
24969 @opindex mpc64
24970 @opindex mpc80
24972 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
24973 is specified, the significands of results of floating-point operations are
24974 rounded to 24 bits (single precision); @option{-mpc64} rounds the
24975 significands of results of floating-point operations to 53 bits (double
24976 precision) and @option{-mpc80} rounds the significands of results of
24977 floating-point operations to 64 bits (extended double precision), which is
24978 the default.  When this option is used, floating-point operations in higher
24979 precisions are not available to the programmer without setting the FPU
24980 control word explicitly.
24982 Setting the rounding of floating-point operations to less than the default
24983 80 bits can speed some programs by 2% or more.  Note that some mathematical
24984 libraries assume that extended-precision (80-bit) floating-point operations
24985 are enabled by default; routines in such libraries could suffer significant
24986 loss of accuracy, typically through so-called ``catastrophic cancellation'',
24987 when this option is used to set the precision to less than extended precision.
24989 @item -mstackrealign
24990 @opindex mstackrealign
24991 Realign the stack at entry.  On the x86, the @option{-mstackrealign}
24992 option generates an alternate prologue and epilogue that realigns the
24993 run-time stack if necessary.  This supports mixing legacy codes that keep
24994 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
24995 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
24996 applicable to individual functions.
24998 @item -mpreferred-stack-boundary=@var{num}
24999 @opindex mpreferred-stack-boundary
25000 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
25001 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
25002 the default is 4 (16 bytes or 128 bits).
25004 @strong{Warning:} When generating code for the x86-64 architecture with
25005 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
25006 used to keep the stack boundary aligned to 8 byte boundary.  Since
25007 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
25008 intended to be used in controlled environment where stack space is
25009 important limitation.  This option leads to wrong code when functions
25010 compiled with 16 byte stack alignment (such as functions from a standard
25011 library) are called with misaligned stack.  In this case, SSE
25012 instructions may lead to misaligned memory access traps.  In addition,
25013 variable arguments are handled incorrectly for 16 byte aligned
25014 objects (including x87 long double and __int128), leading to wrong
25015 results.  You must build all modules with
25016 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
25017 includes the system libraries and startup modules.
25019 @item -mincoming-stack-boundary=@var{num}
25020 @opindex mincoming-stack-boundary
25021 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
25022 boundary.  If @option{-mincoming-stack-boundary} is not specified,
25023 the one specified by @option{-mpreferred-stack-boundary} is used.
25025 On Pentium and Pentium Pro, @code{double} and @code{long double} values
25026 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
25027 suffer significant run time performance penalties.  On Pentium III, the
25028 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
25029 properly if it is not 16-byte aligned.
25031 To ensure proper alignment of this values on the stack, the stack boundary
25032 must be as aligned as that required by any value stored on the stack.
25033 Further, every function must be generated such that it keeps the stack
25034 aligned.  Thus calling a function compiled with a higher preferred
25035 stack boundary from a function compiled with a lower preferred stack
25036 boundary most likely misaligns the stack.  It is recommended that
25037 libraries that use callbacks always use the default setting.
25039 This extra alignment does consume extra stack space, and generally
25040 increases code size.  Code that is sensitive to stack space usage, such
25041 as embedded systems and operating system kernels, may want to reduce the
25042 preferred alignment to @option{-mpreferred-stack-boundary=2}.
25044 @need 200
25045 @item -mmmx
25046 @opindex mmmx
25047 @need 200
25048 @itemx -msse
25049 @opindex msse
25050 @need 200
25051 @itemx -msse2
25052 @opindex msse2
25053 @need 200
25054 @itemx -msse3
25055 @opindex msse3
25056 @need 200
25057 @itemx -mssse3
25058 @opindex mssse3
25059 @need 200
25060 @itemx -msse4
25061 @opindex msse4
25062 @need 200
25063 @itemx -msse4a
25064 @opindex msse4a
25065 @need 200
25066 @itemx -msse4.1
25067 @opindex msse4.1
25068 @need 200
25069 @itemx -msse4.2
25070 @opindex msse4.2
25071 @need 200
25072 @itemx -mavx
25073 @opindex mavx
25074 @need 200
25075 @itemx -mavx2
25076 @opindex mavx2
25077 @need 200
25078 @itemx -mavx512f
25079 @opindex mavx512f
25080 @need 200
25081 @itemx -mavx512pf
25082 @opindex mavx512pf
25083 @need 200
25084 @itemx -mavx512er
25085 @opindex mavx512er
25086 @need 200
25087 @itemx -mavx512cd
25088 @opindex mavx512cd
25089 @need 200
25090 @itemx -mavx512vl
25091 @opindex mavx512vl
25092 @need 200
25093 @itemx -mavx512bw
25094 @opindex mavx512bw
25095 @need 200
25096 @itemx -mavx512dq
25097 @opindex mavx512dq
25098 @need 200
25099 @itemx -mavx512ifma
25100 @opindex mavx512ifma
25101 @need 200
25102 @itemx -mavx512vbmi
25103 @opindex mavx512vbmi
25104 @need 200
25105 @itemx -msha
25106 @opindex msha
25107 @need 200
25108 @itemx -maes
25109 @opindex maes
25110 @need 200
25111 @itemx -mpclmul
25112 @opindex mpclmul
25113 @need 200
25114 @itemx -mclfushopt
25115 @opindex mclfushopt
25116 @need 200
25117 @itemx -mfsgsbase
25118 @opindex mfsgsbase
25119 @need 200
25120 @itemx -mrdrnd
25121 @opindex mrdrnd
25122 @need 200
25123 @itemx -mf16c
25124 @opindex mf16c
25125 @need 200
25126 @itemx -mfma
25127 @opindex mfma
25128 @need 200
25129 @itemx -mfma4
25130 @opindex mfma4
25131 @need 200
25132 @itemx -mprefetchwt1
25133 @opindex mprefetchwt1
25134 @need 200
25135 @itemx -mxop
25136 @opindex mxop
25137 @need 200
25138 @itemx -mlwp
25139 @opindex mlwp
25140 @need 200
25141 @itemx -m3dnow
25142 @opindex m3dnow
25143 @need 200
25144 @itemx -m3dnowa
25145 @opindex m3dnowa
25146 @need 200
25147 @itemx -mpopcnt
25148 @opindex mpopcnt
25149 @need 200
25150 @itemx -mabm
25151 @opindex mabm
25152 @need 200
25153 @itemx -mbmi
25154 @opindex mbmi
25155 @need 200
25156 @itemx -mbmi2
25157 @need 200
25158 @itemx -mlzcnt
25159 @opindex mlzcnt
25160 @need 200
25161 @itemx -mfxsr
25162 @opindex mfxsr
25163 @need 200
25164 @itemx -mxsave
25165 @opindex mxsave
25166 @need 200
25167 @itemx -mxsaveopt
25168 @opindex mxsaveopt
25169 @need 200
25170 @itemx -mxsavec
25171 @opindex mxsavec
25172 @need 200
25173 @itemx -mxsaves
25174 @opindex mxsaves
25175 @need 200
25176 @itemx -mrtm
25177 @opindex mrtm
25178 @need 200
25179 @itemx -mtbm
25180 @opindex mtbm
25181 @need 200
25182 @itemx -mmpx
25183 @opindex mmpx
25184 @need 200
25185 @itemx -mmwaitx
25186 @opindex mmwaitx
25187 @need 200
25188 @itemx -mclzero
25189 @opindex mclzero
25190 @itemx -mpku
25191 @opindex mpku
25192 These switches enable the use of instructions in the MMX, SSE,
25193 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
25194 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
25195 AVX512VL, AVX512BW, AVX512DQ, AVX512IFMA AVX512VBMI, BMI, BMI2, FXSR,
25196 XSAVE, XSAVEOPT, LZCNT, RTM, MPX, MWAITX, PKU, 3DNow!@: or enhanced 3DNow!@:
25197 extended instruction sets.  Each has a corresponding @option{-mno-} option
25198 to disable use of these instructions.
25200 These extensions are also available as built-in functions: see
25201 @ref{x86 Built-in Functions}, for details of the functions enabled and
25202 disabled by these switches.
25204 To generate SSE/SSE2 instructions automatically from floating-point
25205 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
25207 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
25208 generates new AVX instructions or AVX equivalence for all SSEx instructions
25209 when needed.
25211 These options enable GCC to use these extended instructions in
25212 generated code, even without @option{-mfpmath=sse}.  Applications that
25213 perform run-time CPU detection must compile separate files for each
25214 supported architecture, using the appropriate flags.  In particular,
25215 the file containing the CPU detection code should be compiled without
25216 these options.
25218 @item -mdump-tune-features
25219 @opindex mdump-tune-features
25220 This option instructs GCC to dump the names of the x86 performance 
25221 tuning features and default settings. The names can be used in 
25222 @option{-mtune-ctrl=@var{feature-list}}.
25224 @item -mtune-ctrl=@var{feature-list}
25225 @opindex mtune-ctrl=@var{feature-list}
25226 This option is used to do fine grain control of x86 code generation features.
25227 @var{feature-list} is a comma separated list of @var{feature} names. See also
25228 @option{-mdump-tune-features}. When specified, the @var{feature} is turned
25229 on if it is not preceded with @samp{^}, otherwise, it is turned off. 
25230 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
25231 developers. Using it may lead to code paths not covered by testing and can
25232 potentially result in compiler ICEs or runtime errors.
25234 @item -mno-default
25235 @opindex mno-default
25236 This option instructs GCC to turn off all tunable features. See also 
25237 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
25239 @item -mcld
25240 @opindex mcld
25241 This option instructs GCC to emit a @code{cld} instruction in the prologue
25242 of functions that use string instructions.  String instructions depend on
25243 the DF flag to select between autoincrement or autodecrement mode.  While the
25244 ABI specifies the DF flag to be cleared on function entry, some operating
25245 systems violate this specification by not clearing the DF flag in their
25246 exception dispatchers.  The exception handler can be invoked with the DF flag
25247 set, which leads to wrong direction mode when string instructions are used.
25248 This option can be enabled by default on 32-bit x86 targets by configuring
25249 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
25250 instructions can be suppressed with the @option{-mno-cld} compiler option
25251 in this case.
25253 @item -mvzeroupper
25254 @opindex mvzeroupper
25255 This option instructs GCC to emit a @code{vzeroupper} instruction
25256 before a transfer of control flow out of the function to minimize
25257 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
25258 intrinsics.
25260 @item -mprefer-avx128
25261 @opindex mprefer-avx128
25262 This option instructs GCC to use 128-bit AVX instructions instead of
25263 256-bit AVX instructions in the auto-vectorizer.
25265 @item -mcx16
25266 @opindex mcx16
25267 This option enables GCC to generate @code{CMPXCHG16B} instructions in 64-bit
25268 code to implement compare-and-exchange operations on 16-byte aligned 128-bit
25269 objects.  This is useful for atomic updates of data structures exceeding one
25270 machine word in size.  The compiler uses this instruction to implement
25271 @ref{__sync Builtins}.  However, for @ref{__atomic Builtins} operating on
25272 128-bit integers, a library call is always used.
25274 @item -msahf
25275 @opindex msahf
25276 This option enables generation of @code{SAHF} instructions in 64-bit code.
25277 Early Intel Pentium 4 CPUs with Intel 64 support,
25278 prior to the introduction of Pentium 4 G1 step in December 2005,
25279 lacked the @code{LAHF} and @code{SAHF} instructions
25280 which are supported by AMD64.
25281 These are load and store instructions, respectively, for certain status flags.
25282 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
25283 @code{drem}, and @code{remainder} built-in functions;
25284 see @ref{Other Builtins} for details.
25286 @item -mmovbe
25287 @opindex mmovbe
25288 This option enables use of the @code{movbe} instruction to implement
25289 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
25291 @item -mcrc32
25292 @opindex mcrc32
25293 This option enables built-in functions @code{__builtin_ia32_crc32qi},
25294 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
25295 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
25297 @item -mrecip
25298 @opindex mrecip
25299 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
25300 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
25301 with an additional Newton-Raphson step
25302 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
25303 (and their vectorized
25304 variants) for single-precision floating-point arguments.  These instructions
25305 are generated only when @option{-funsafe-math-optimizations} is enabled
25306 together with @option{-ffinite-math-only} and @option{-fno-trapping-math}.
25307 Note that while the throughput of the sequence is higher than the throughput
25308 of the non-reciprocal instruction, the precision of the sequence can be
25309 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
25311 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
25312 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
25313 combination), and doesn't need @option{-mrecip}.
25315 Also note that GCC emits the above sequence with additional Newton-Raphson step
25316 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
25317 already with @option{-ffast-math} (or the above option combination), and
25318 doesn't need @option{-mrecip}.
25320 @item -mrecip=@var{opt}
25321 @opindex mrecip=opt
25322 This option controls which reciprocal estimate instructions
25323 may be used.  @var{opt} is a comma-separated list of options, which may
25324 be preceded by a @samp{!} to invert the option:
25326 @table @samp
25327 @item all
25328 Enable all estimate instructions.
25330 @item default
25331 Enable the default instructions, equivalent to @option{-mrecip}.
25333 @item none
25334 Disable all estimate instructions, equivalent to @option{-mno-recip}.
25336 @item div
25337 Enable the approximation for scalar division.
25339 @item vec-div
25340 Enable the approximation for vectorized division.
25342 @item sqrt
25343 Enable the approximation for scalar square root.
25345 @item vec-sqrt
25346 Enable the approximation for vectorized square root.
25347 @end table
25349 So, for example, @option{-mrecip=all,!sqrt} enables
25350 all of the reciprocal approximations, except for square root.
25352 @item -mveclibabi=@var{type}
25353 @opindex mveclibabi
25354 Specifies the ABI type to use for vectorizing intrinsics using an
25355 external library.  Supported values for @var{type} are @samp{svml} 
25356 for the Intel short
25357 vector math library and @samp{acml} for the AMD math core library.
25358 To use this option, both @option{-ftree-vectorize} and
25359 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
25360 ABI-compatible library must be specified at link time.
25362 GCC currently emits calls to @code{vmldExp2},
25363 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
25364 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
25365 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
25366 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
25367 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
25368 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
25369 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
25370 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
25371 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
25372 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
25373 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
25374 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
25375 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
25376 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
25377 when @option{-mveclibabi=acml} is used.  
25379 @item -mabi=@var{name}
25380 @opindex mabi
25381 Generate code for the specified calling convention.  Permissible values
25382 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
25383 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
25384 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
25385 You can control this behavior for specific functions by
25386 using the function attributes @code{ms_abi} and @code{sysv_abi}.
25387 @xref{Function Attributes}.
25389 @item -mcall-ms2sysv-xlogues
25390 @opindex mcall-ms2sysv-xlogues
25391 @opindex mno-call-ms2sysv-xlogues
25392 Due to differences in 64-bit ABIs, any Microsoft ABI function that calls a
25393 System V ABI function must consider RSI, RDI and XMM6-15 as clobbered.  By
25394 default, the code for saving and restoring these registers is emitted inline,
25395 resulting in fairly lengthy prologues and epilogues.  Using
25396 @option{-mcall-ms2sysv-xlogues} emits prologues and epilogues that
25397 use stubs in the static portion of libgcc to perform these saves and restores,
25398 thus reducing function size at the cost of a few extra instructions.
25400 @item -mtls-dialect=@var{type}
25401 @opindex mtls-dialect
25402 Generate code to access thread-local storage using the @samp{gnu} or
25403 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
25404 @samp{gnu2} is more efficient, but it may add compile- and run-time
25405 requirements that cannot be satisfied on all systems.
25407 @item -mpush-args
25408 @itemx -mno-push-args
25409 @opindex mpush-args
25410 @opindex mno-push-args
25411 Use PUSH operations to store outgoing parameters.  This method is shorter
25412 and usually equally fast as method using SUB/MOV operations and is enabled
25413 by default.  In some cases disabling it may improve performance because of
25414 improved scheduling and reduced dependencies.
25416 @item -maccumulate-outgoing-args
25417 @opindex maccumulate-outgoing-args
25418 If enabled, the maximum amount of space required for outgoing arguments is
25419 computed in the function prologue.  This is faster on most modern CPUs
25420 because of reduced dependencies, improved scheduling and reduced stack usage
25421 when the preferred stack boundary is not equal to 2.  The drawback is a notable
25422 increase in code size.  This switch implies @option{-mno-push-args}.
25424 @item -mthreads
25425 @opindex mthreads
25426 Support thread-safe exception handling on MinGW.  Programs that rely
25427 on thread-safe exception handling must compile and link all code with the
25428 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
25429 @option{-D_MT}; when linking, it links in a special thread helper library
25430 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
25432 @item -mms-bitfields
25433 @itemx -mno-ms-bitfields
25434 @opindex mms-bitfields
25435 @opindex mno-ms-bitfields
25437 Enable/disable bit-field layout compatible with the native Microsoft
25438 Windows compiler.  
25440 If @code{packed} is used on a structure, or if bit-fields are used,
25441 it may be that the Microsoft ABI lays out the structure differently
25442 than the way GCC normally does.  Particularly when moving packed
25443 data between functions compiled with GCC and the native Microsoft compiler
25444 (either via function call or as data in a file), it may be necessary to access
25445 either format.
25447 This option is enabled by default for Microsoft Windows
25448 targets.  This behavior can also be controlled locally by use of variable
25449 or type attributes.  For more information, see @ref{x86 Variable Attributes}
25450 and @ref{x86 Type Attributes}.
25452 The Microsoft structure layout algorithm is fairly simple with the exception
25453 of the bit-field packing.  
25454 The padding and alignment of members of structures and whether a bit-field 
25455 can straddle a storage-unit boundary are determine by these rules:
25457 @enumerate
25458 @item Structure members are stored sequentially in the order in which they are
25459 declared: the first member has the lowest memory address and the last member
25460 the highest.
25462 @item Every data object has an alignment requirement.  The alignment requirement
25463 for all data except structures, unions, and arrays is either the size of the
25464 object or the current packing size (specified with either the
25465 @code{aligned} attribute or the @code{pack} pragma),
25466 whichever is less.  For structures, unions, and arrays,
25467 the alignment requirement is the largest alignment requirement of its members.
25468 Every object is allocated an offset so that:
25470 @smallexample
25471 offset % alignment_requirement == 0
25472 @end smallexample
25474 @item Adjacent bit-fields are packed into the same 1-, 2-, or 4-byte allocation
25475 unit if the integral types are the same size and if the next bit-field fits
25476 into the current allocation unit without crossing the boundary imposed by the
25477 common alignment requirements of the bit-fields.
25478 @end enumerate
25480 MSVC interprets zero-length bit-fields in the following ways:
25482 @enumerate
25483 @item If a zero-length bit-field is inserted between two bit-fields that
25484 are normally coalesced, the bit-fields are not coalesced.
25486 For example:
25488 @smallexample
25489 struct
25490  @{
25491    unsigned long bf_1 : 12;
25492    unsigned long : 0;
25493    unsigned long bf_2 : 12;
25494  @} t1;
25495 @end smallexample
25497 @noindent
25498 The size of @code{t1} is 8 bytes with the zero-length bit-field.  If the
25499 zero-length bit-field were removed, @code{t1}'s size would be 4 bytes.
25501 @item If a zero-length bit-field is inserted after a bit-field, @code{foo}, and the
25502 alignment of the zero-length bit-field is greater than the member that follows it,
25503 @code{bar}, @code{bar} is aligned as the type of the zero-length bit-field.
25505 For example:
25507 @smallexample
25508 struct
25509  @{
25510    char foo : 4;
25511    short : 0;
25512    char bar;
25513  @} t2;
25515 struct
25516  @{
25517    char foo : 4;
25518    short : 0;
25519    double bar;
25520  @} t3;
25521 @end smallexample
25523 @noindent
25524 For @code{t2}, @code{bar} is placed at offset 2, rather than offset 1.
25525 Accordingly, the size of @code{t2} is 4.  For @code{t3}, the zero-length
25526 bit-field does not affect the alignment of @code{bar} or, as a result, the size
25527 of the structure.
25529 Taking this into account, it is important to note the following:
25531 @enumerate
25532 @item If a zero-length bit-field follows a normal bit-field, the type of the
25533 zero-length bit-field may affect the alignment of the structure as whole. For
25534 example, @code{t2} has a size of 4 bytes, since the zero-length bit-field follows a
25535 normal bit-field, and is of type short.
25537 @item Even if a zero-length bit-field is not followed by a normal bit-field, it may
25538 still affect the alignment of the structure:
25540 @smallexample
25541 struct
25542  @{
25543    char foo : 6;
25544    long : 0;
25545  @} t4;
25546 @end smallexample
25548 @noindent
25549 Here, @code{t4} takes up 4 bytes.
25550 @end enumerate
25552 @item Zero-length bit-fields following non-bit-field members are ignored:
25554 @smallexample
25555 struct
25556  @{
25557    char foo;
25558    long : 0;
25559    char bar;
25560  @} t5;
25561 @end smallexample
25563 @noindent
25564 Here, @code{t5} takes up 2 bytes.
25565 @end enumerate
25568 @item -mno-align-stringops
25569 @opindex mno-align-stringops
25570 Do not align the destination of inlined string operations.  This switch reduces
25571 code size and improves performance in case the destination is already aligned,
25572 but GCC doesn't know about it.
25574 @item -minline-all-stringops
25575 @opindex minline-all-stringops
25576 By default GCC inlines string operations only when the destination is 
25577 known to be aligned to least a 4-byte boundary.  
25578 This enables more inlining and increases code
25579 size, but may improve performance of code that depends on fast
25580 @code{memcpy}, @code{strlen},
25581 and @code{memset} for short lengths.
25583 @item -minline-stringops-dynamically
25584 @opindex minline-stringops-dynamically
25585 For string operations of unknown size, use run-time checks with
25586 inline code for small blocks and a library call for large blocks.
25588 @item -mstringop-strategy=@var{alg}
25589 @opindex mstringop-strategy=@var{alg}
25590 Override the internal decision heuristic for the particular algorithm to use
25591 for inlining string operations.  The allowed values for @var{alg} are:
25593 @table @samp
25594 @item rep_byte
25595 @itemx rep_4byte
25596 @itemx rep_8byte
25597 Expand using i386 @code{rep} prefix of the specified size.
25599 @item byte_loop
25600 @itemx loop
25601 @itemx unrolled_loop
25602 Expand into an inline loop.
25604 @item libcall
25605 Always use a library call.
25606 @end table
25608 @item -mmemcpy-strategy=@var{strategy}
25609 @opindex mmemcpy-strategy=@var{strategy}
25610 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
25611 should be inlined and what inline algorithm to use when the expected size
25612 of the copy operation is known. @var{strategy} 
25613 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
25614 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
25615 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
25616 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
25617 in the list must be specified in increasing order.  The minimal byte size for 
25618 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
25619 preceding range.
25621 @item -mmemset-strategy=@var{strategy}
25622 @opindex mmemset-strategy=@var{strategy}
25623 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
25624 @code{__builtin_memset} expansion.
25626 @item -momit-leaf-frame-pointer
25627 @opindex momit-leaf-frame-pointer
25628 Don't keep the frame pointer in a register for leaf functions.  This
25629 avoids the instructions to save, set up, and restore frame pointers and
25630 makes an extra register available in leaf functions.  The option
25631 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
25632 which might make debugging harder.
25634 @item -mtls-direct-seg-refs
25635 @itemx -mno-tls-direct-seg-refs
25636 @opindex mtls-direct-seg-refs
25637 Controls whether TLS variables may be accessed with offsets from the
25638 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
25639 or whether the thread base pointer must be added.  Whether or not this
25640 is valid depends on the operating system, and whether it maps the
25641 segment to cover the entire TLS area.
25643 For systems that use the GNU C Library, the default is on.
25645 @item -msse2avx
25646 @itemx -mno-sse2avx
25647 @opindex msse2avx
25648 Specify that the assembler should encode SSE instructions with VEX
25649 prefix.  The option @option{-mavx} turns this on by default.
25651 @item -mfentry
25652 @itemx -mno-fentry
25653 @opindex mfentry
25654 If profiling is active (@option{-pg}), put the profiling
25655 counter call before the prologue.
25656 Note: On x86 architectures the attribute @code{ms_hook_prologue}
25657 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
25659 @item -mrecord-mcount
25660 @itemx -mno-record-mcount
25661 @opindex mrecord-mcount
25662 If profiling is active (@option{-pg}), generate a __mcount_loc section
25663 that contains pointers to each profiling call. This is useful for
25664 automatically patching and out calls.
25666 @item -mnop-mcount
25667 @itemx -mno-nop-mcount
25668 @opindex mnop-mcount
25669 If profiling is active (@option{-pg}), generate the calls to
25670 the profiling functions as NOPs. This is useful when they
25671 should be patched in later dynamically. This is likely only
25672 useful together with @option{-mrecord-mcount}.
25674 @item -mskip-rax-setup
25675 @itemx -mno-skip-rax-setup
25676 @opindex mskip-rax-setup
25677 When generating code for the x86-64 architecture with SSE extensions
25678 disabled, @option{-mskip-rax-setup} can be used to skip setting up RAX
25679 register when there are no variable arguments passed in vector registers.
25681 @strong{Warning:} Since RAX register is used to avoid unnecessarily
25682 saving vector registers on stack when passing variable arguments, the
25683 impacts of this option are callees may waste some stack space,
25684 misbehave or jump to a random location.  GCC 4.4 or newer don't have
25685 those issues, regardless the RAX register value.
25687 @item -m8bit-idiv
25688 @itemx -mno-8bit-idiv
25689 @opindex m8bit-idiv
25690 On some processors, like Intel Atom, 8-bit unsigned integer divide is
25691 much faster than 32-bit/64-bit integer divide.  This option generates a
25692 run-time check.  If both dividend and divisor are within range of 0
25693 to 255, 8-bit unsigned integer divide is used instead of
25694 32-bit/64-bit integer divide.
25696 @item -mavx256-split-unaligned-load
25697 @itemx -mavx256-split-unaligned-store
25698 @opindex mavx256-split-unaligned-load
25699 @opindex mavx256-split-unaligned-store
25700 Split 32-byte AVX unaligned load and store.
25702 @item -mstack-protector-guard=@var{guard}
25703 @opindex mstack-protector-guard=@var{guard}
25704 Generate stack protection code using canary at @var{guard}.  Supported
25705 locations are @samp{global} for global canary or @samp{tls} for per-thread
25706 canary in the TLS block (the default).  This option has effect only when
25707 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
25709 @item -mmitigate-rop
25710 @opindex mmitigate-rop
25711 Try to avoid generating code sequences that contain unintended return
25712 opcodes, to mitigate against certain forms of attack. At the moment,
25713 this option is limited in what it can do and should not be relied
25714 on to provide serious protection.
25716 @item -mgeneral-regs-only
25717 @opindex mgeneral-regs-only
25718 Generate code that uses only the general-purpose registers.  This
25719 prevents the compiler from using floating-point, vector, mask and bound
25720 registers.
25722 @end table
25724 These @samp{-m} switches are supported in addition to the above
25725 on x86-64 processors in 64-bit environments.
25727 @table @gcctabopt
25728 @item -m32
25729 @itemx -m64
25730 @itemx -mx32
25731 @itemx -m16
25732 @itemx -miamcu
25733 @opindex m32
25734 @opindex m64
25735 @opindex mx32
25736 @opindex m16
25737 @opindex miamcu
25738 Generate code for a 16-bit, 32-bit or 64-bit environment.
25739 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
25740 to 32 bits, and
25741 generates code that runs on any i386 system.
25743 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
25744 types to 64 bits, and generates code for the x86-64 architecture.
25745 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
25746 and @option{-mdynamic-no-pic} options.
25748 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
25749 to 32 bits, and
25750 generates code for the x86-64 architecture.
25752 The @option{-m16} option is the same as @option{-m32}, except for that
25753 it outputs the @code{.code16gcc} assembly directive at the beginning of
25754 the assembly output so that the binary can run in 16-bit mode.
25756 The @option{-miamcu} option generates code which conforms to Intel MCU
25757 psABI.  It requires the @option{-m32} option to be turned on.
25759 @item -mno-red-zone
25760 @opindex mno-red-zone
25761 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
25762 by the x86-64 ABI; it is a 128-byte area beyond the location of the
25763 stack pointer that is not modified by signal or interrupt handlers
25764 and therefore can be used for temporary data without adjusting the stack
25765 pointer.  The flag @option{-mno-red-zone} disables this red zone.
25767 @item -mcmodel=small
25768 @opindex mcmodel=small
25769 Generate code for the small code model: the program and its symbols must
25770 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
25771 Programs can be statically or dynamically linked.  This is the default
25772 code model.
25774 @item -mcmodel=kernel
25775 @opindex mcmodel=kernel
25776 Generate code for the kernel code model.  The kernel runs in the
25777 negative 2 GB of the address space.
25778 This model has to be used for Linux kernel code.
25780 @item -mcmodel=medium
25781 @opindex mcmodel=medium
25782 Generate code for the medium model: the program is linked in the lower 2
25783 GB of the address space.  Small symbols are also placed there.  Symbols
25784 with sizes larger than @option{-mlarge-data-threshold} are put into
25785 large data or BSS sections and can be located above 2GB.  Programs can
25786 be statically or dynamically linked.
25788 @item -mcmodel=large
25789 @opindex mcmodel=large
25790 Generate code for the large model.  This model makes no assumptions
25791 about addresses and sizes of sections.
25793 @item -maddress-mode=long
25794 @opindex maddress-mode=long
25795 Generate code for long address mode.  This is only supported for 64-bit
25796 and x32 environments.  It is the default address mode for 64-bit
25797 environments.
25799 @item -maddress-mode=short
25800 @opindex maddress-mode=short
25801 Generate code for short address mode.  This is only supported for 32-bit
25802 and x32 environments.  It is the default address mode for 32-bit and
25803 x32 environments.
25804 @end table
25806 @node x86 Windows Options
25807 @subsection x86 Windows Options
25808 @cindex x86 Windows Options
25809 @cindex Windows Options for x86
25811 These additional options are available for Microsoft Windows targets:
25813 @table @gcctabopt
25814 @item -mconsole
25815 @opindex mconsole
25816 This option
25817 specifies that a console application is to be generated, by
25818 instructing the linker to set the PE header subsystem type
25819 required for console applications.
25820 This option is available for Cygwin and MinGW targets and is
25821 enabled by default on those targets.
25823 @item -mdll
25824 @opindex mdll
25825 This option is available for Cygwin and MinGW targets.  It
25826 specifies that a DLL---a dynamic link library---is to be
25827 generated, enabling the selection of the required runtime
25828 startup object and entry point.
25830 @item -mnop-fun-dllimport
25831 @opindex mnop-fun-dllimport
25832 This option is available for Cygwin and MinGW targets.  It
25833 specifies that the @code{dllimport} attribute should be ignored.
25835 @item -mthread
25836 @opindex mthread
25837 This option is available for MinGW targets. It specifies
25838 that MinGW-specific thread support is to be used.
25840 @item -municode
25841 @opindex municode
25842 This option is available for MinGW-w64 targets.  It causes
25843 the @code{UNICODE} preprocessor macro to be predefined, and
25844 chooses Unicode-capable runtime startup code.
25846 @item -mwin32
25847 @opindex mwin32
25848 This option is available for Cygwin and MinGW targets.  It
25849 specifies that the typical Microsoft Windows predefined macros are to
25850 be set in the pre-processor, but does not influence the choice
25851 of runtime library/startup code.
25853 @item -mwindows
25854 @opindex mwindows
25855 This option is available for Cygwin and MinGW targets.  It
25856 specifies that a GUI application is to be generated by
25857 instructing the linker to set the PE header subsystem type
25858 appropriately.
25860 @item -fno-set-stack-executable
25861 @opindex fno-set-stack-executable
25862 This option is available for MinGW targets. It specifies that
25863 the executable flag for the stack used by nested functions isn't
25864 set. This is necessary for binaries running in kernel mode of
25865 Microsoft Windows, as there the User32 API, which is used to set executable
25866 privileges, isn't available.
25868 @item -fwritable-relocated-rdata
25869 @opindex fno-writable-relocated-rdata
25870 This option is available for MinGW and Cygwin targets.  It specifies
25871 that relocated-data in read-only section is put into the @code{.data}
25872 section.  This is a necessary for older runtimes not supporting
25873 modification of @code{.rdata} sections for pseudo-relocation.
25875 @item -mpe-aligned-commons
25876 @opindex mpe-aligned-commons
25877 This option is available for Cygwin and MinGW targets.  It
25878 specifies that the GNU extension to the PE file format that
25879 permits the correct alignment of COMMON variables should be
25880 used when generating code.  It is enabled by default if
25881 GCC detects that the target assembler found during configuration
25882 supports the feature.
25883 @end table
25885 See also under @ref{x86 Options} for standard options.
25887 @node Xstormy16 Options
25888 @subsection Xstormy16 Options
25889 @cindex Xstormy16 Options
25891 These options are defined for Xstormy16:
25893 @table @gcctabopt
25894 @item -msim
25895 @opindex msim
25896 Choose startup files and linker script suitable for the simulator.
25897 @end table
25899 @node Xtensa Options
25900 @subsection Xtensa Options
25901 @cindex Xtensa Options
25903 These options are supported for Xtensa targets:
25905 @table @gcctabopt
25906 @item -mconst16
25907 @itemx -mno-const16
25908 @opindex mconst16
25909 @opindex mno-const16
25910 Enable or disable use of @code{CONST16} instructions for loading
25911 constant values.  The @code{CONST16} instruction is currently not a
25912 standard option from Tensilica.  When enabled, @code{CONST16}
25913 instructions are always used in place of the standard @code{L32R}
25914 instructions.  The use of @code{CONST16} is enabled by default only if
25915 the @code{L32R} instruction is not available.
25917 @item -mfused-madd
25918 @itemx -mno-fused-madd
25919 @opindex mfused-madd
25920 @opindex mno-fused-madd
25921 Enable or disable use of fused multiply/add and multiply/subtract
25922 instructions in the floating-point option.  This has no effect if the
25923 floating-point option is not also enabled.  Disabling fused multiply/add
25924 and multiply/subtract instructions forces the compiler to use separate
25925 instructions for the multiply and add/subtract operations.  This may be
25926 desirable in some cases where strict IEEE 754-compliant results are
25927 required: the fused multiply add/subtract instructions do not round the
25928 intermediate result, thereby producing results with @emph{more} bits of
25929 precision than specified by the IEEE standard.  Disabling fused multiply
25930 add/subtract instructions also ensures that the program output is not
25931 sensitive to the compiler's ability to combine multiply and add/subtract
25932 operations.
25934 @item -mserialize-volatile
25935 @itemx -mno-serialize-volatile
25936 @opindex mserialize-volatile
25937 @opindex mno-serialize-volatile
25938 When this option is enabled, GCC inserts @code{MEMW} instructions before
25939 @code{volatile} memory references to guarantee sequential consistency.
25940 The default is @option{-mserialize-volatile}.  Use
25941 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
25943 @item -mforce-no-pic
25944 @opindex mforce-no-pic
25945 For targets, like GNU/Linux, where all user-mode Xtensa code must be
25946 position-independent code (PIC), this option disables PIC for compiling
25947 kernel code.
25949 @item -mtext-section-literals
25950 @itemx -mno-text-section-literals
25951 @opindex mtext-section-literals
25952 @opindex mno-text-section-literals
25953 These options control the treatment of literal pools.  The default is
25954 @option{-mno-text-section-literals}, which places literals in a separate
25955 section in the output file.  This allows the literal pool to be placed
25956 in a data RAM/ROM, and it also allows the linker to combine literal
25957 pools from separate object files to remove redundant literals and
25958 improve code size.  With @option{-mtext-section-literals}, the literals
25959 are interspersed in the text section in order to keep them as close as
25960 possible to their references.  This may be necessary for large assembly
25961 files.  Literals for each function are placed right before that function.
25963 @item -mauto-litpools
25964 @itemx -mno-auto-litpools
25965 @opindex mauto-litpools
25966 @opindex mno-auto-litpools
25967 These options control the treatment of literal pools.  The default is
25968 @option{-mno-auto-litpools}, which places literals in a separate
25969 section in the output file unless @option{-mtext-section-literals} is
25970 used.  With @option{-mauto-litpools} the literals are interspersed in
25971 the text section by the assembler.  Compiler does not produce explicit
25972 @code{.literal} directives and loads literals into registers with
25973 @code{MOVI} instructions instead of @code{L32R} to let the assembler
25974 do relaxation and place literals as necessary.  This option allows
25975 assembler to create several literal pools per function and assemble
25976 very big functions, which may not be possible with
25977 @option{-mtext-section-literals}.
25979 @item -mtarget-align
25980 @itemx -mno-target-align
25981 @opindex mtarget-align
25982 @opindex mno-target-align
25983 When this option is enabled, GCC instructs the assembler to
25984 automatically align instructions to reduce branch penalties at the
25985 expense of some code density.  The assembler attempts to widen density
25986 instructions to align branch targets and the instructions following call
25987 instructions.  If there are not enough preceding safe density
25988 instructions to align a target, no widening is performed.  The
25989 default is @option{-mtarget-align}.  These options do not affect the
25990 treatment of auto-aligned instructions like @code{LOOP}, which the
25991 assembler always aligns, either by widening density instructions or
25992 by inserting NOP instructions.
25994 @item -mlongcalls
25995 @itemx -mno-longcalls
25996 @opindex mlongcalls
25997 @opindex mno-longcalls
25998 When this option is enabled, GCC instructs the assembler to translate
25999 direct calls to indirect calls unless it can determine that the target
26000 of a direct call is in the range allowed by the call instruction.  This
26001 translation typically occurs for calls to functions in other source
26002 files.  Specifically, the assembler translates a direct @code{CALL}
26003 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
26004 The default is @option{-mno-longcalls}.  This option should be used in
26005 programs where the call target can potentially be out of range.  This
26006 option is implemented in the assembler, not the compiler, so the
26007 assembly code generated by GCC still shows direct call
26008 instructions---look at the disassembled object code to see the actual
26009 instructions.  Note that the assembler uses an indirect call for
26010 every cross-file call, not just those that really are out of range.
26011 @end table
26013 @node zSeries Options
26014 @subsection zSeries Options
26015 @cindex zSeries options
26017 These are listed under @xref{S/390 and zSeries Options}.
26020 @c man end
26022 @node Spec Files
26023 @section Specifying Subprocesses and the Switches to Pass to Them
26024 @cindex Spec Files
26026 @command{gcc} is a driver program.  It performs its job by invoking a
26027 sequence of other programs to do the work of compiling, assembling and
26028 linking.  GCC interprets its command-line parameters and uses these to
26029 deduce which programs it should invoke, and which command-line options
26030 it ought to place on their command lines.  This behavior is controlled
26031 by @dfn{spec strings}.  In most cases there is one spec string for each
26032 program that GCC can invoke, but a few programs have multiple spec
26033 strings to control their behavior.  The spec strings built into GCC can
26034 be overridden by using the @option{-specs=} command-line switch to specify
26035 a spec file.
26037 @dfn{Spec files} are plain-text files that are used to construct spec
26038 strings.  They consist of a sequence of directives separated by blank
26039 lines.  The type of directive is determined by the first non-whitespace
26040 character on the line, which can be one of the following:
26042 @table @code
26043 @item %@var{command}
26044 Issues a @var{command} to the spec file processor.  The commands that can
26045 appear here are:
26047 @table @code
26048 @item %include <@var{file}>
26049 @cindex @code{%include}
26050 Search for @var{file} and insert its text at the current point in the
26051 specs file.
26053 @item %include_noerr <@var{file}>
26054 @cindex @code{%include_noerr}
26055 Just like @samp{%include}, but do not generate an error message if the include
26056 file cannot be found.
26058 @item %rename @var{old_name} @var{new_name}
26059 @cindex @code{%rename}
26060 Rename the spec string @var{old_name} to @var{new_name}.
26062 @end table
26064 @item *[@var{spec_name}]:
26065 This tells the compiler to create, override or delete the named spec
26066 string.  All lines after this directive up to the next directive or
26067 blank line are considered to be the text for the spec string.  If this
26068 results in an empty string then the spec is deleted.  (Or, if the
26069 spec did not exist, then nothing happens.)  Otherwise, if the spec
26070 does not currently exist a new spec is created.  If the spec does
26071 exist then its contents are overridden by the text of this
26072 directive, unless the first character of that text is the @samp{+}
26073 character, in which case the text is appended to the spec.
26075 @item [@var{suffix}]:
26076 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
26077 and up to the next directive or blank line are considered to make up the
26078 spec string for the indicated suffix.  When the compiler encounters an
26079 input file with the named suffix, it processes the spec string in
26080 order to work out how to compile that file.  For example:
26082 @smallexample
26083 .ZZ:
26084 z-compile -input %i
26085 @end smallexample
26087 This says that any input file whose name ends in @samp{.ZZ} should be
26088 passed to the program @samp{z-compile}, which should be invoked with the
26089 command-line switch @option{-input} and with the result of performing the
26090 @samp{%i} substitution.  (See below.)
26092 As an alternative to providing a spec string, the text following a
26093 suffix directive can be one of the following:
26095 @table @code
26096 @item @@@var{language}
26097 This says that the suffix is an alias for a known @var{language}.  This is
26098 similar to using the @option{-x} command-line switch to GCC to specify a
26099 language explicitly.  For example:
26101 @smallexample
26102 .ZZ:
26103 @@c++
26104 @end smallexample
26106 Says that .ZZ files are, in fact, C++ source files.
26108 @item #@var{name}
26109 This causes an error messages saying:
26111 @smallexample
26112 @var{name} compiler not installed on this system.
26113 @end smallexample
26114 @end table
26116 GCC already has an extensive list of suffixes built into it.
26117 This directive adds an entry to the end of the list of suffixes, but
26118 since the list is searched from the end backwards, it is effectively
26119 possible to override earlier entries using this technique.
26121 @end table
26123 GCC has the following spec strings built into it.  Spec files can
26124 override these strings or create their own.  Note that individual
26125 targets can also add their own spec strings to this list.
26127 @smallexample
26128 asm          Options to pass to the assembler
26129 asm_final    Options to pass to the assembler post-processor
26130 cpp          Options to pass to the C preprocessor
26131 cc1          Options to pass to the C compiler
26132 cc1plus      Options to pass to the C++ compiler
26133 endfile      Object files to include at the end of the link
26134 link         Options to pass to the linker
26135 lib          Libraries to include on the command line to the linker
26136 libgcc       Decides which GCC support library to pass to the linker
26137 linker       Sets the name of the linker
26138 predefines   Defines to be passed to the C preprocessor
26139 signed_char  Defines to pass to CPP to say whether @code{char} is signed
26140              by default
26141 startfile    Object files to include at the start of the link
26142 @end smallexample
26144 Here is a small example of a spec file:
26146 @smallexample
26147 %rename lib                 old_lib
26149 *lib:
26150 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
26151 @end smallexample
26153 This example renames the spec called @samp{lib} to @samp{old_lib} and
26154 then overrides the previous definition of @samp{lib} with a new one.
26155 The new definition adds in some extra command-line options before
26156 including the text of the old definition.
26158 @dfn{Spec strings} are a list of command-line options to be passed to their
26159 corresponding program.  In addition, the spec strings can contain
26160 @samp{%}-prefixed sequences to substitute variable text or to
26161 conditionally insert text into the command line.  Using these constructs
26162 it is possible to generate quite complex command lines.
26164 Here is a table of all defined @samp{%}-sequences for spec
26165 strings.  Note that spaces are not generated automatically around the
26166 results of expanding these sequences.  Therefore you can concatenate them
26167 together or combine them with constant text in a single argument.
26169 @table @code
26170 @item %%
26171 Substitute one @samp{%} into the program name or argument.
26173 @item %i
26174 Substitute the name of the input file being processed.
26176 @item %b
26177 Substitute the basename of the input file being processed.
26178 This is the substring up to (and not including) the last period
26179 and not including the directory.
26181 @item %B
26182 This is the same as @samp{%b}, but include the file suffix (text after
26183 the last period).
26185 @item %d
26186 Marks the argument containing or following the @samp{%d} as a
26187 temporary file name, so that that file is deleted if GCC exits
26188 successfully.  Unlike @samp{%g}, this contributes no text to the
26189 argument.
26191 @item %g@var{suffix}
26192 Substitute a file name that has suffix @var{suffix} and is chosen
26193 once per compilation, and mark the argument in the same way as
26194 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
26195 name is now chosen in a way that is hard to predict even when previously
26196 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
26197 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
26198 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
26199 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
26200 was simply substituted with a file name chosen once per compilation,
26201 without regard to any appended suffix (which was therefore treated
26202 just like ordinary text), making such attacks more likely to succeed.
26204 @item %u@var{suffix}
26205 Like @samp{%g}, but generates a new temporary file name
26206 each time it appears instead of once per compilation.
26208 @item %U@var{suffix}
26209 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
26210 new one if there is no such last file name.  In the absence of any
26211 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
26212 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
26213 involves the generation of two distinct file names, one
26214 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
26215 simply substituted with a file name chosen for the previous @samp{%u},
26216 without regard to any appended suffix.
26218 @item %j@var{suffix}
26219 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
26220 writable, and if @option{-save-temps} is not used; 
26221 otherwise, substitute the name
26222 of a temporary file, just like @samp{%u}.  This temporary file is not
26223 meant for communication between processes, but rather as a junk
26224 disposal mechanism.
26226 @item %|@var{suffix}
26227 @itemx %m@var{suffix}
26228 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
26229 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
26230 all.  These are the two most common ways to instruct a program that it
26231 should read from standard input or write to standard output.  If you
26232 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
26233 construct: see for example @file{f/lang-specs.h}.
26235 @item %.@var{SUFFIX}
26236 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
26237 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
26238 terminated by the next space or %.
26240 @item %w
26241 Marks the argument containing or following the @samp{%w} as the
26242 designated output file of this compilation.  This puts the argument
26243 into the sequence of arguments that @samp{%o} substitutes.
26245 @item %o
26246 Substitutes the names of all the output files, with spaces
26247 automatically placed around them.  You should write spaces
26248 around the @samp{%o} as well or the results are undefined.
26249 @samp{%o} is for use in the specs for running the linker.
26250 Input files whose names have no recognized suffix are not compiled
26251 at all, but they are included among the output files, so they are
26252 linked.
26254 @item %O
26255 Substitutes the suffix for object files.  Note that this is
26256 handled specially when it immediately follows @samp{%g, %u, or %U},
26257 because of the need for those to form complete file names.  The
26258 handling is such that @samp{%O} is treated exactly as if it had already
26259 been substituted, except that @samp{%g, %u, and %U} do not currently
26260 support additional @var{suffix} characters following @samp{%O} as they do
26261 following, for example, @samp{.o}.
26263 @item %p
26264 Substitutes the standard macro predefinitions for the
26265 current target machine.  Use this when running @command{cpp}.
26267 @item %P
26268 Like @samp{%p}, but puts @samp{__} before and after the name of each
26269 predefined macro, except for macros that start with @samp{__} or with
26270 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
26273 @item %I
26274 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
26275 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
26276 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
26277 and @option{-imultilib} as necessary.
26279 @item %s
26280 Current argument is the name of a library or startup file of some sort.
26281 Search for that file in a standard list of directories and substitute
26282 the full name found.  The current working directory is included in the
26283 list of directories scanned.
26285 @item %T
26286 Current argument is the name of a linker script.  Search for that file
26287 in the current list of directories to scan for libraries. If the file
26288 is located insert a @option{--script} option into the command line
26289 followed by the full path name found.  If the file is not found then
26290 generate an error message.  Note: the current working directory is not
26291 searched.
26293 @item %e@var{str}
26294 Print @var{str} as an error message.  @var{str} is terminated by a newline.
26295 Use this when inconsistent options are detected.
26297 @item %(@var{name})
26298 Substitute the contents of spec string @var{name} at this point.
26300 @item %x@{@var{option}@}
26301 Accumulate an option for @samp{%X}.
26303 @item %X
26304 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
26305 spec string.
26307 @item %Y
26308 Output the accumulated assembler options specified by @option{-Wa}.
26310 @item %Z
26311 Output the accumulated preprocessor options specified by @option{-Wp}.
26313 @item %a
26314 Process the @code{asm} spec.  This is used to compute the
26315 switches to be passed to the assembler.
26317 @item %A
26318 Process the @code{asm_final} spec.  This is a spec string for
26319 passing switches to an assembler post-processor, if such a program is
26320 needed.
26322 @item %l
26323 Process the @code{link} spec.  This is the spec for computing the
26324 command line passed to the linker.  Typically it makes use of the
26325 @samp{%L %G %S %D and %E} sequences.
26327 @item %D
26328 Dump out a @option{-L} option for each directory that GCC believes might
26329 contain startup files.  If the target supports multilibs then the
26330 current multilib directory is prepended to each of these paths.
26332 @item %L
26333 Process the @code{lib} spec.  This is a spec string for deciding which
26334 libraries are included on the command line to the linker.
26336 @item %G
26337 Process the @code{libgcc} spec.  This is a spec string for deciding
26338 which GCC support library is included on the command line to the linker.
26340 @item %S
26341 Process the @code{startfile} spec.  This is a spec for deciding which
26342 object files are the first ones passed to the linker.  Typically
26343 this might be a file named @file{crt0.o}.
26345 @item %E
26346 Process the @code{endfile} spec.  This is a spec string that specifies
26347 the last object files that are passed to the linker.
26349 @item %C
26350 Process the @code{cpp} spec.  This is used to construct the arguments
26351 to be passed to the C preprocessor.
26353 @item %1
26354 Process the @code{cc1} spec.  This is used to construct the options to be
26355 passed to the actual C compiler (@command{cc1}).
26357 @item %2
26358 Process the @code{cc1plus} spec.  This is used to construct the options to be
26359 passed to the actual C++ compiler (@command{cc1plus}).
26361 @item %*
26362 Substitute the variable part of a matched option.  See below.
26363 Note that each comma in the substituted string is replaced by
26364 a single space.
26366 @item %<S
26367 Remove all occurrences of @code{-S} from the command line.  Note---this
26368 command is position dependent.  @samp{%} commands in the spec string
26369 before this one see @code{-S}, @samp{%} commands in the spec string
26370 after this one do not.
26372 @item %:@var{function}(@var{args})
26373 Call the named function @var{function}, passing it @var{args}.
26374 @var{args} is first processed as a nested spec string, then split
26375 into an argument vector in the usual fashion.  The function returns
26376 a string which is processed as if it had appeared literally as part
26377 of the current spec.
26379 The following built-in spec functions are provided:
26381 @table @code
26382 @item @code{getenv}
26383 The @code{getenv} spec function takes two arguments: an environment
26384 variable name and a string.  If the environment variable is not
26385 defined, a fatal error is issued.  Otherwise, the return value is the
26386 value of the environment variable concatenated with the string.  For
26387 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
26389 @smallexample
26390 %:getenv(TOPDIR /include)
26391 @end smallexample
26393 expands to @file{/path/to/top/include}.
26395 @item @code{if-exists}
26396 The @code{if-exists} spec function takes one argument, an absolute
26397 pathname to a file.  If the file exists, @code{if-exists} returns the
26398 pathname.  Here is a small example of its usage:
26400 @smallexample
26401 *startfile:
26402 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
26403 @end smallexample
26405 @item @code{if-exists-else}
26406 The @code{if-exists-else} spec function is similar to the @code{if-exists}
26407 spec function, except that it takes two arguments.  The first argument is
26408 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
26409 returns the pathname.  If it does not exist, it returns the second argument.
26410 This way, @code{if-exists-else} can be used to select one file or another,
26411 based on the existence of the first.  Here is a small example of its usage:
26413 @smallexample
26414 *startfile:
26415 crt0%O%s %:if-exists(crti%O%s) \
26416 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
26417 @end smallexample
26419 @item @code{replace-outfile}
26420 The @code{replace-outfile} spec function takes two arguments.  It looks for the
26421 first argument in the outfiles array and replaces it with the second argument.  Here
26422 is a small example of its usage:
26424 @smallexample
26425 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
26426 @end smallexample
26428 @item @code{remove-outfile}
26429 The @code{remove-outfile} spec function takes one argument.  It looks for the
26430 first argument in the outfiles array and removes it.  Here is a small example
26431 its usage:
26433 @smallexample
26434 %:remove-outfile(-lm)
26435 @end smallexample
26437 @item @code{pass-through-libs}
26438 The @code{pass-through-libs} spec function takes any number of arguments.  It
26439 finds any @option{-l} options and any non-options ending in @file{.a} (which it
26440 assumes are the names of linker input library archive files) and returns a
26441 result containing all the found arguments each prepended by
26442 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
26443 intended to be passed to the LTO linker plugin.
26445 @smallexample
26446 %:pass-through-libs(%G %L %G)
26447 @end smallexample
26449 @item @code{print-asm-header}
26450 The @code{print-asm-header} function takes no arguments and simply
26451 prints a banner like:
26453 @smallexample
26454 Assembler options
26455 =================
26457 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
26458 @end smallexample
26460 It is used to separate compiler options from assembler options
26461 in the @option{--target-help} output.
26462 @end table
26464 @item %@{S@}
26465 Substitutes the @code{-S} switch, if that switch is given to GCC@.
26466 If that switch is not specified, this substitutes nothing.  Note that
26467 the leading dash is omitted when specifying this option, and it is
26468 automatically inserted if the substitution is performed.  Thus the spec
26469 string @samp{%@{foo@}} matches the command-line option @option{-foo}
26470 and outputs the command-line option @option{-foo}.
26472 @item %W@{S@}
26473 Like %@{@code{S}@} but mark last argument supplied within as a file to be
26474 deleted on failure.
26476 @item %@{S*@}
26477 Substitutes all the switches specified to GCC whose names start
26478 with @code{-S}, but which also take an argument.  This is used for
26479 switches like @option{-o}, @option{-D}, @option{-I}, etc.
26480 GCC considers @option{-o foo} as being
26481 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
26482 text, including the space.  Thus two arguments are generated.
26484 @item %@{S*&T*@}
26485 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
26486 (the order of @code{S} and @code{T} in the spec is not significant).
26487 There can be any number of ampersand-separated variables; for each the
26488 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
26490 @item %@{S:X@}
26491 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
26493 @item %@{!S:X@}
26494 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
26496 @item %@{S*:X@}
26497 Substitutes @code{X} if one or more switches whose names start with
26498 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
26499 once, no matter how many such switches appeared.  However, if @code{%*}
26500 appears somewhere in @code{X}, then @code{X} is substituted once
26501 for each matching switch, with the @code{%*} replaced by the part of
26502 that switch matching the @code{*}.
26504 If @code{%*} appears as the last part of a spec sequence then a space
26505 is added after the end of the last substitution.  If there is more
26506 text in the sequence, however, then a space is not generated.  This
26507 allows the @code{%*} substitution to be used as part of a larger
26508 string.  For example, a spec string like this:
26510 @smallexample
26511 %@{mcu=*:--script=%*/memory.ld@}
26512 @end smallexample
26514 @noindent
26515 when matching an option like @option{-mcu=newchip} produces:
26517 @smallexample
26518 --script=newchip/memory.ld
26519 @end smallexample
26521 @item %@{.S:X@}
26522 Substitutes @code{X}, if processing a file with suffix @code{S}.
26524 @item %@{!.S:X@}
26525 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
26527 @item %@{,S:X@}
26528 Substitutes @code{X}, if processing a file for language @code{S}.
26530 @item %@{!,S:X@}
26531 Substitutes @code{X}, if not processing a file for language @code{S}.
26533 @item %@{S|P:X@}
26534 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
26535 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
26536 @code{*} sequences as well, although they have a stronger binding than
26537 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
26538 alternatives must be starred, and only the first matching alternative
26539 is substituted.
26541 For example, a spec string like this:
26543 @smallexample
26544 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
26545 @end smallexample
26547 @noindent
26548 outputs the following command-line options from the following input
26549 command-line options:
26551 @smallexample
26552 fred.c        -foo -baz
26553 jim.d         -bar -boggle
26554 -d fred.c     -foo -baz -boggle
26555 -d jim.d      -bar -baz -boggle
26556 @end smallexample
26558 @item %@{S:X; T:Y; :D@}
26560 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
26561 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
26562 be as many clauses as you need.  This may be combined with @code{.},
26563 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
26566 @end table
26568 The switch matching text @code{S} in a @samp{%@{S@}}, @samp{%@{S:X@}}
26569 or similar construct can use a backslash to ignore the special meaning
26570 of the character following it, thus allowing literal matching of a
26571 character that is otherwise specially treated.  For example,
26572 @samp{%@{std=iso9899\:1999:X@}} substitutes @code{X} if the
26573 @option{-std=iso9899:1999} option is given.
26575 The conditional text @code{X} in a @samp{%@{S:X@}} or similar
26576 construct may contain other nested @samp{%} constructs or spaces, or
26577 even newlines.  They are processed as usual, as described above.
26578 Trailing white space in @code{X} is ignored.  White space may also
26579 appear anywhere on the left side of the colon in these constructs,
26580 except between @code{.} or @code{*} and the corresponding word.
26582 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
26583 handled specifically in these constructs.  If another value of
26584 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
26585 @option{-W} switch is found later in the command line, the earlier
26586 switch value is ignored, except with @{@code{S}*@} where @code{S} is
26587 just one letter, which passes all matching options.
26589 The character @samp{|} at the beginning of the predicate text is used to
26590 indicate that a command should be piped to the following command, but
26591 only if @option{-pipe} is specified.
26593 It is built into GCC which switches take arguments and which do not.
26594 (You might think it would be useful to generalize this to allow each
26595 compiler's spec to say which switches take arguments.  But this cannot
26596 be done in a consistent fashion.  GCC cannot even decide which input
26597 files have been specified without knowing which switches take arguments,
26598 and it must know which input files to compile in order to tell which
26599 compilers to run).
26601 GCC also knows implicitly that arguments starting in @option{-l} are to be
26602 treated as compiler output files, and passed to the linker in their
26603 proper position among the other output files.
26605 @node Environment Variables
26606 @section Environment Variables Affecting GCC
26607 @cindex environment variables
26609 @c man begin ENVIRONMENT
26610 This section describes several environment variables that affect how GCC
26611 operates.  Some of them work by specifying directories or prefixes to use
26612 when searching for various kinds of files.  Some are used to specify other
26613 aspects of the compilation environment.
26615 Note that you can also specify places to search using options such as
26616 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
26617 take precedence over places specified using environment variables, which
26618 in turn take precedence over those specified by the configuration of GCC@.
26619 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
26620 GNU Compiler Collection (GCC) Internals}.
26622 @table @env
26623 @item LANG
26624 @itemx LC_CTYPE
26625 @c @itemx LC_COLLATE
26626 @itemx LC_MESSAGES
26627 @c @itemx LC_MONETARY
26628 @c @itemx LC_NUMERIC
26629 @c @itemx LC_TIME
26630 @itemx LC_ALL
26631 @findex LANG
26632 @findex LC_CTYPE
26633 @c @findex LC_COLLATE
26634 @findex LC_MESSAGES
26635 @c @findex LC_MONETARY
26636 @c @findex LC_NUMERIC
26637 @c @findex LC_TIME
26638 @findex LC_ALL
26639 @cindex locale
26640 These environment variables control the way that GCC uses
26641 localization information which allows GCC to work with different
26642 national conventions.  GCC inspects the locale categories
26643 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
26644 so.  These locale categories can be set to any value supported by your
26645 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
26646 Kingdom encoded in UTF-8.
26648 The @env{LC_CTYPE} environment variable specifies character
26649 classification.  GCC uses it to determine the character boundaries in
26650 a string; this is needed for some multibyte encodings that contain quote
26651 and escape characters that are otherwise interpreted as a string
26652 end or escape.
26654 The @env{LC_MESSAGES} environment variable specifies the language to
26655 use in diagnostic messages.
26657 If the @env{LC_ALL} environment variable is set, it overrides the value
26658 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
26659 and @env{LC_MESSAGES} default to the value of the @env{LANG}
26660 environment variable.  If none of these variables are set, GCC
26661 defaults to traditional C English behavior.
26663 @item TMPDIR
26664 @findex TMPDIR
26665 If @env{TMPDIR} is set, it specifies the directory to use for temporary
26666 files.  GCC uses temporary files to hold the output of one stage of
26667 compilation which is to be used as input to the next stage: for example,
26668 the output of the preprocessor, which is the input to the compiler
26669 proper.
26671 @item GCC_COMPARE_DEBUG
26672 @findex GCC_COMPARE_DEBUG
26673 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
26674 @option{-fcompare-debug} to the compiler driver.  See the documentation
26675 of this option for more details.
26677 @item GCC_EXEC_PREFIX
26678 @findex GCC_EXEC_PREFIX
26679 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
26680 names of the subprograms executed by the compiler.  No slash is added
26681 when this prefix is combined with the name of a subprogram, but you can
26682 specify a prefix that ends with a slash if you wish.
26684 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
26685 an appropriate prefix to use based on the pathname it is invoked with.
26687 If GCC cannot find the subprogram using the specified prefix, it
26688 tries looking in the usual places for the subprogram.
26690 The default value of @env{GCC_EXEC_PREFIX} is
26691 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
26692 the installed compiler. In many cases @var{prefix} is the value
26693 of @code{prefix} when you ran the @file{configure} script.
26695 Other prefixes specified with @option{-B} take precedence over this prefix.
26697 This prefix is also used for finding files such as @file{crt0.o} that are
26698 used for linking.
26700 In addition, the prefix is used in an unusual way in finding the
26701 directories to search for header files.  For each of the standard
26702 directories whose name normally begins with @samp{/usr/local/lib/gcc}
26703 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
26704 replacing that beginning with the specified prefix to produce an
26705 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
26706 @file{foo/bar} just before it searches the standard directory 
26707 @file{/usr/local/lib/bar}.
26708 If a standard directory begins with the configured
26709 @var{prefix} then the value of @var{prefix} is replaced by
26710 @env{GCC_EXEC_PREFIX} when looking for header files.
26712 @item COMPILER_PATH
26713 @findex COMPILER_PATH
26714 The value of @env{COMPILER_PATH} is a colon-separated list of
26715 directories, much like @env{PATH}.  GCC tries the directories thus
26716 specified when searching for subprograms, if it cannot find the
26717 subprograms using @env{GCC_EXEC_PREFIX}.
26719 @item LIBRARY_PATH
26720 @findex LIBRARY_PATH
26721 The value of @env{LIBRARY_PATH} is a colon-separated list of
26722 directories, much like @env{PATH}.  When configured as a native compiler,
26723 GCC tries the directories thus specified when searching for special
26724 linker files, if it cannot find them using @env{GCC_EXEC_PREFIX}.  Linking
26725 using GCC also uses these directories when searching for ordinary
26726 libraries for the @option{-l} option (but directories specified with
26727 @option{-L} come first).
26729 @item LANG
26730 @findex LANG
26731 @cindex locale definition
26732 This variable is used to pass locale information to the compiler.  One way in
26733 which this information is used is to determine the character set to be used
26734 when character literals, string literals and comments are parsed in C and C++.
26735 When the compiler is configured to allow multibyte characters,
26736 the following values for @env{LANG} are recognized:
26738 @table @samp
26739 @item C-JIS
26740 Recognize JIS characters.
26741 @item C-SJIS
26742 Recognize SJIS characters.
26743 @item C-EUCJP
26744 Recognize EUCJP characters.
26745 @end table
26747 If @env{LANG} is not defined, or if it has some other value, then the
26748 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
26749 recognize and translate multibyte characters.
26750 @end table
26752 @noindent
26753 Some additional environment variables affect the behavior of the
26754 preprocessor.
26756 @include cppenv.texi
26758 @c man end
26760 @node Precompiled Headers
26761 @section Using Precompiled Headers
26762 @cindex precompiled headers
26763 @cindex speed of compilation
26765 Often large projects have many header files that are included in every
26766 source file.  The time the compiler takes to process these header files
26767 over and over again can account for nearly all of the time required to
26768 build the project.  To make builds faster, GCC allows you to
26769 @dfn{precompile} a header file.
26771 To create a precompiled header file, simply compile it as you would any
26772 other file, if necessary using the @option{-x} option to make the driver
26773 treat it as a C or C++ header file.  You may want to use a
26774 tool like @command{make} to keep the precompiled header up-to-date when
26775 the headers it contains change.
26777 A precompiled header file is searched for when @code{#include} is
26778 seen in the compilation.  As it searches for the included file
26779 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
26780 compiler looks for a precompiled header in each directory just before it
26781 looks for the include file in that directory.  The name searched for is
26782 the name specified in the @code{#include} with @samp{.gch} appended.  If
26783 the precompiled header file cannot be used, it is ignored.
26785 For instance, if you have @code{#include "all.h"}, and you have
26786 @file{all.h.gch} in the same directory as @file{all.h}, then the
26787 precompiled header file is used if possible, and the original
26788 header is used otherwise.
26790 Alternatively, you might decide to put the precompiled header file in a
26791 directory and use @option{-I} to ensure that directory is searched
26792 before (or instead of) the directory containing the original header.
26793 Then, if you want to check that the precompiled header file is always
26794 used, you can put a file of the same name as the original header in this
26795 directory containing an @code{#error} command.
26797 This also works with @option{-include}.  So yet another way to use
26798 precompiled headers, good for projects not designed with precompiled
26799 header files in mind, is to simply take most of the header files used by
26800 a project, include them from another header file, precompile that header
26801 file, and @option{-include} the precompiled header.  If the header files
26802 have guards against multiple inclusion, they are skipped because
26803 they've already been included (in the precompiled header).
26805 If you need to precompile the same header file for different
26806 languages, targets, or compiler options, you can instead make a
26807 @emph{directory} named like @file{all.h.gch}, and put each precompiled
26808 header in the directory, perhaps using @option{-o}.  It doesn't matter
26809 what you call the files in the directory; every precompiled header in
26810 the directory is considered.  The first precompiled header
26811 encountered in the directory that is valid for this compilation is
26812 used; they're searched in no particular order.
26814 There are many other possibilities, limited only by your imagination,
26815 good sense, and the constraints of your build system.
26817 A precompiled header file can be used only when these conditions apply:
26819 @itemize
26820 @item
26821 Only one precompiled header can be used in a particular compilation.
26823 @item
26824 A precompiled header cannot be used once the first C token is seen.  You
26825 can have preprocessor directives before a precompiled header; you cannot
26826 include a precompiled header from inside another header.
26828 @item
26829 The precompiled header file must be produced for the same language as
26830 the current compilation.  You cannot use a C precompiled header for a C++
26831 compilation.
26833 @item
26834 The precompiled header file must have been produced by the same compiler
26835 binary as the current compilation is using.
26837 @item
26838 Any macros defined before the precompiled header is included must
26839 either be defined in the same way as when the precompiled header was
26840 generated, or must not affect the precompiled header, which usually
26841 means that they don't appear in the precompiled header at all.
26843 The @option{-D} option is one way to define a macro before a
26844 precompiled header is included; using a @code{#define} can also do it.
26845 There are also some options that define macros implicitly, like
26846 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
26847 defined this way.
26849 @item If debugging information is output when using the precompiled
26850 header, using @option{-g} or similar, the same kind of debugging information
26851 must have been output when building the precompiled header.  However,
26852 a precompiled header built using @option{-g} can be used in a compilation
26853 when no debugging information is being output.
26855 @item The same @option{-m} options must generally be used when building
26856 and using the precompiled header.  @xref{Submodel Options},
26857 for any cases where this rule is relaxed.
26859 @item Each of the following options must be the same when building and using
26860 the precompiled header:
26862 @gccoptlist{-fexceptions}
26864 @item
26865 Some other command-line options starting with @option{-f},
26866 @option{-p}, or @option{-O} must be defined in the same way as when
26867 the precompiled header was generated.  At present, it's not clear
26868 which options are safe to change and which are not; the safest choice
26869 is to use exactly the same options when generating and using the
26870 precompiled header.  The following are known to be safe:
26872 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
26873 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
26874 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
26875 -pedantic-errors}
26877 @end itemize
26879 For all of these except the last, the compiler automatically
26880 ignores the precompiled header if the conditions aren't met.  If you
26881 find an option combination that doesn't work and doesn't cause the
26882 precompiled header to be ignored, please consider filing a bug report,
26883 see @ref{Bugs}.
26885 If you do use differing options when generating and using the
26886 precompiled header, the actual behavior is a mixture of the
26887 behavior for the options.  For instance, if you use @option{-g} to
26888 generate the precompiled header but not when using it, you may or may
26889 not get debugging information for routines in the precompiled header.